Annotation of mandoc/read.c, Revision 1.162
1.162 ! schwarze 1: /* $Id: read.c,v 1.161 2017/02/18 17:29:28 schwarze Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.156 schwarze 4: * Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org>
1.42 schwarze 5: * Copyright (c) 2010, 2012 Joerg Sonnenberger <joerg@netbsd.org>
1.1 kristaps 6: *
7: * Permission to use, copy, modify, and distribute this software for any
8: * purpose with or without fee is hereby granted, provided that the above
9: * copyright notice and this permission notice appear in all copies.
10: *
1.133 schwarze 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1 kristaps 12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.133 schwarze 13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1 kristaps 14: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18: */
1.11 kristaps 19: #include "config.h"
20:
1.80 schwarze 21: #include <sys/types.h>
1.82 schwarze 22: #include <sys/mman.h>
1.80 schwarze 23: #include <sys/stat.h>
1.1 kristaps 24:
25: #include <assert.h>
26: #include <ctype.h>
1.146 schwarze 27: #if HAVE_ERR
1.143 schwarze 28: #include <err.h>
1.146 schwarze 29: #endif
1.40 schwarze 30: #include <errno.h>
1.1 kristaps 31: #include <fcntl.h>
1.3 kristaps 32: #include <stdarg.h>
1.1 kristaps 33: #include <stdio.h>
34: #include <stdlib.h>
35: #include <string.h>
36: #include <unistd.h>
1.140 schwarze 37: #include <zlib.h>
1.1 kristaps 38:
1.133 schwarze 39: #include "mandoc_aux.h"
1.1 kristaps 40: #include "mandoc.h"
1.133 schwarze 41: #include "roff.h"
1.1 kristaps 42: #include "mdoc.h"
43: #include "man.h"
1.133 schwarze 44: #include "libmandoc.h"
1.139 schwarze 45: #include "roff_int.h"
1.1 kristaps 46:
47: #define REPARSE_LIMIT 1000
48:
49: struct mparse {
1.160 schwarze 50: struct roff *roff; /* roff parser (!NULL) */
1.134 schwarze 51: struct roff_man *man; /* man parser */
1.45 schwarze 52: char *sodest; /* filename pointed to by .so */
1.83 schwarze 53: const char *file; /* filename of current input file */
54: struct buf *primary; /* buffer currently being parsed */
55: struct buf *secondary; /* preprocessed copy of input */
56: const char *defos; /* default operating system */
57: mandocmsg mmsg; /* warning/error message handler */
58: enum mandoclevel file_status; /* status of current parse */
59: enum mandoclevel wlevel; /* ignore messages below this */
60: int options; /* parser options */
1.140 schwarze 61: int gzip; /* current input file is gzipped */
1.93 schwarze 62: int filenc; /* encoding of the current file */
1.1 kristaps 63: int reparse_count; /* finite interp. stack */
1.83 schwarze 64: int line; /* line number in the file */
1.1 kristaps 65: };
66:
1.84 schwarze 67: static void choose_parser(struct mparse *);
1.1 kristaps 68: static void resize_buf(struct buf *, size_t);
1.95 schwarze 69: static void mparse_buf_r(struct mparse *, struct buf, size_t, int);
1.40 schwarze 70: static int read_whole_file(struct mparse *, const char *, int,
71: struct buf *, int *);
1.1 kristaps 72: static void mparse_end(struct mparse *);
1.37 schwarze 73: static void mparse_parse_buffer(struct mparse *, struct buf,
74: const char *);
1.1 kristaps 75:
1.3 kristaps 76: static const enum mandocerr mandoclimits[MANDOCLEVEL_MAX] = {
77: MANDOCERR_OK,
78: MANDOCERR_WARNING,
79: MANDOCERR_WARNING,
80: MANDOCERR_ERROR,
1.112 schwarze 81: MANDOCERR_UNSUPP,
1.3 kristaps 82: MANDOCERR_MAX,
83: MANDOCERR_MAX
84: };
85:
1.7 kristaps 86: static const char * const mandocerrs[MANDOCERR_MAX] = {
87: "ok",
88:
89: "generic warning",
90:
91: /* related to the prologue */
1.79 schwarze 92: "missing manual title, using UNTITLED",
93: "missing manual title, using \"\"",
1.54 schwarze 94: "lower case character in document title",
1.79 schwarze 95: "missing manual section, using \"\"",
1.7 kristaps 96: "unknown manual section",
1.54 schwarze 97: "missing date, using today's date",
1.7 kristaps 98: "cannot parse date, using it verbatim",
1.79 schwarze 99: "missing Os macro, using \"\"",
100: "duplicate prologue macro",
101: "late prologue macro",
102: "skipping late title macro",
1.7 kristaps 103: "prologue macros out of order",
104:
105: /* related to document structure */
106: ".so is fragile, better use ln(1)",
1.50 schwarze 107: "no document body",
1.54 schwarze 108: "content before first section header",
109: "first section is not \"NAME\"",
1.156 schwarze 110: "NAME section without Nm before Nd",
1.128 schwarze 111: "NAME section without description",
112: "description not at the end of NAME",
113: "bad NAME section content",
1.156 schwarze 114: "missing comma before name",
1.121 schwarze 115: "missing description line, using \"\"",
1.162 ! schwarze 116: "description line outside NAME section",
1.7 kristaps 117: "sections out of conventional order",
1.54 schwarze 118: "duplicate section title",
119: "unexpected section",
1.87 schwarze 120: "unusual Xr order",
121: "unusual Xr punctuation",
1.86 schwarze 122: "AUTHORS section without An macro",
1.7 kristaps 123:
124: /* related to macros and nesting */
1.55 schwarze 125: "obsolete macro",
1.102 schwarze 126: "macro neither callable nor escaped",
1.7 kristaps 127: "skipping paragraph macro",
1.31 schwarze 128: "moving paragraph macro out of list",
1.7 kristaps 129: "skipping no-space macro",
130: "blocks badly nested",
131: "nested displays are not portable",
1.57 schwarze 132: "moving content out of list",
1.78 schwarze 133: "fill mode already enabled, skipping",
134: "fill mode already disabled, skipping",
1.7 kristaps 135: "line scope broken",
136:
137: /* related to missing macro arguments */
1.58 schwarze 138: "skipping empty request",
139: "conditional request controls empty scope",
1.7 kristaps 140: "skipping empty macro",
1.124 schwarze 141: "empty block",
1.62 schwarze 142: "empty argument, using 0n",
1.60 schwarze 143: "missing display type, using -ragged",
144: "list type is not the first argument",
1.152 schwarze 145: "missing -width in -tag list, using 6n",
1.78 schwarze 146: "missing utility name, using \"\"",
1.123 schwarze 147: "missing function name, using \"\"",
1.60 schwarze 148: "empty head in list item",
149: "empty list item",
1.61 schwarze 150: "missing font type, using \\fR",
151: "unknown font type, using \\fR",
1.103 schwarze 152: "nothing follows prefix",
1.122 schwarze 153: "empty reference block",
1.155 schwarze 154: "missing section argument",
1.60 schwarze 155: "missing -std argument, adding it",
1.125 schwarze 156: "missing option string, using \"\"",
157: "missing resource identifier, using \"\"",
1.90 schwarze 158: "missing eqn box, using \"\"",
1.7 kristaps 159:
160: /* related to bad macro arguments */
1.64 schwarze 161: "unterminated quoted argument",
1.7 kristaps 162: "duplicate argument",
1.76 schwarze 163: "skipping duplicate argument",
1.63 schwarze 164: "skipping duplicate display type",
165: "skipping duplicate list type",
1.76 schwarze 166: "skipping -width argument",
1.126 schwarze 167: "wrong number of cells",
1.7 kristaps 168: "unknown AT&T UNIX version",
1.88 schwarze 169: "comma in function argument",
1.89 schwarze 170: "parenthesis in function name",
1.67 schwarze 171: "invalid content in Rs block",
1.63 schwarze 172: "invalid Boolean argument",
173: "unknown font, skipping request",
1.126 schwarze 174: "odd number of characters in request",
1.7 kristaps 175:
176: /* related to plain text */
1.64 schwarze 177: "blank line in fill mode, using .sp",
178: "tab in filled text",
179: "whitespace at end of input line",
1.158 schwarze 180: "new sentence, new line",
1.7 kristaps 181: "bad comment style",
1.64 schwarze 182: "invalid escape sequence",
183: "undefined string, using \"\"",
1.16 kristaps 184:
1.118 schwarze 185: /* related to tables */
186: "tbl line starts with span",
187: "tbl column starts with span",
188: "skipping vertical bar in tbl layout",
189:
1.7 kristaps 190: "generic error",
191:
192: /* related to tables */
1.116 schwarze 193: "non-alphabetic character in tbl options",
194: "skipping unknown tbl option",
195: "missing tbl option argument",
196: "wrong tbl option argument size",
1.118 schwarze 197: "empty tbl layout",
198: "invalid character in tbl layout",
199: "unmatched parenthesis in tbl layout",
1.119 schwarze 200: "tbl without any data cells",
201: "ignoring data in spanned tbl cell",
202: "ignoring extra tbl data cells",
203: "data block open at end of tbl",
1.7 kristaps 204:
1.68 schwarze 205: /* related to document structure and macros */
1.108 schwarze 206: NULL,
1.7 kristaps 207: "input stack limit exceeded, infinite loop?",
208: "skipping bad character",
1.68 schwarze 209: "skipping unknown macro",
1.112 schwarze 210: "skipping insecure request",
1.73 schwarze 211: "skipping item outside list",
1.68 schwarze 212: "skipping column outside column list",
213: "skipping end of block that is not open",
1.115 schwarze 214: "fewer RS blocks open, skipping",
1.68 schwarze 215: "inserting missing end of block",
216: "appending missing end of block",
217:
218: /* related to request and macro arguments */
1.7 kristaps 219: "escaped character not allowed in a name",
1.99 schwarze 220: "NOT IMPLEMENTED: Bd -file",
1.145 schwarze 221: "skipping display without arguments",
1.71 schwarze 222: "missing list type, using -item",
1.70 schwarze 223: "missing manual name, using \"\"",
1.71 schwarze 224: "uname(3) system call failed, using UNKNOWN",
1.63 schwarze 225: "unknown standard specifier",
1.71 schwarze 226: "skipping request without numeric argument",
1.109 schwarze 227: "NOT IMPLEMENTED: .so with absolute path or \"..\"",
1.110 schwarze 228: ".so request failed",
1.61 schwarze 229: "skipping all arguments",
230: "skipping excess arguments",
1.92 kristaps 231: "divide by zero",
1.112 schwarze 232:
233: "unsupported feature",
234: "input too large",
1.114 schwarze 235: "unsupported control character",
1.112 schwarze 236: "unsupported roff request",
1.119 schwarze 237: "eqn delim option in tbl",
1.118 schwarze 238: "unsupported tbl layout modifier",
1.112 schwarze 239: "ignoring macro in table",
1.7 kristaps 240: };
241:
242: static const char * const mandoclevels[MANDOCLEVEL_MAX] = {
243: "SUCCESS",
244: "RESERVED",
245: "WARNING",
246: "ERROR",
1.112 schwarze 247: "UNSUPP",
1.7 kristaps 248: "BADARG",
249: "SYSERR"
250: };
251:
1.47 schwarze 252:
1.1 kristaps 253: static void
254: resize_buf(struct buf *buf, size_t initial)
255: {
256:
257: buf->sz = buf->sz > initial/2 ? 2 * buf->sz : initial;
258: buf->buf = mandoc_realloc(buf->buf, buf->sz);
259: }
260:
261: static void
1.84 schwarze 262: choose_parser(struct mparse *curp)
1.1 kristaps 263: {
1.83 schwarze 264: char *cp, *ep;
265: int format;
1.1 kristaps 266:
1.83 schwarze 267: /*
268: * If neither command line arguments -mdoc or -man select
269: * a parser nor the roff parser found a .Dd or .TH macro
270: * yet, look ahead in the main input buffer.
271: */
272:
273: if ((format = roff_getformat(curp->roff)) == 0) {
274: cp = curp->primary->buf;
275: ep = cp + curp->primary->sz;
276: while (cp < ep) {
1.85 schwarze 277: if (*cp == '.' || *cp == '\'') {
1.83 schwarze 278: cp++;
279: if (cp[0] == 'D' && cp[1] == 'd') {
280: format = MPARSE_MDOC;
281: break;
282: }
283: if (cp[0] == 'T' && cp[1] == 'H') {
284: format = MPARSE_MAN;
285: break;
286: }
287: }
288: cp = memchr(cp, '\n', ep - cp);
289: if (cp == NULL)
290: break;
291: cp++;
292: }
1.1 kristaps 293: }
294:
1.83 schwarze 295: if (format == MPARSE_MDOC) {
1.136 schwarze 296: mdoc_hash_init();
1.137 schwarze 297: curp->man->macroset = MACROSET_MDOC;
1.138 schwarze 298: curp->man->first->tok = TOKEN_NONE;
1.137 schwarze 299: } else {
300: man_hash_init();
301: curp->man->macroset = MACROSET_MAN;
1.138 schwarze 302: curp->man->first->tok = TOKEN_NONE;
1.47 schwarze 303: }
1.1 kristaps 304: }
305:
306: /*
1.95 schwarze 307: * Main parse routine for a buffer.
308: * It assumes encoding and line numbering are already set up.
309: * It can recurse directly (for invocations of user-defined
310: * macros, inline equations, and input line traps)
311: * and indirectly (for .so file inclusion).
1.1 kristaps 312: */
313: static void
1.95 schwarze 314: mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
1.1 kristaps 315: {
316: const struct tbl_span *span;
317: struct buf ln;
1.113 schwarze 318: const char *save_file;
1.110 schwarze 319: char *cp;
1.95 schwarze 320: size_t pos; /* byte number in the ln buffer */
1.154 schwarze 321: size_t j; /* auxiliary byte number in the blk buffer */
1.1 kristaps 322: enum rofferr rr;
1.100 schwarze 323: int of;
1.1 kristaps 324: int lnn; /* line number in the real file */
1.110 schwarze 325: int fd;
1.1 kristaps 326: unsigned char c;
327:
1.95 schwarze 328: memset(&ln, 0, sizeof(ln));
1.1 kristaps 329:
1.47 schwarze 330: lnn = curp->line;
331: pos = 0;
1.1 kristaps 332:
1.95 schwarze 333: while (i < blk.sz) {
1.1 kristaps 334: if (0 == pos && '\0' == blk.buf[i])
335: break;
336:
337: if (start) {
338: curp->line = lnn;
339: curp->reparse_count = 0;
1.93 schwarze 340:
341: if (lnn < 3 &&
342: curp->filenc & MPARSE_UTF8 &&
1.95 schwarze 343: curp->filenc & MPARSE_LATIN1)
344: curp->filenc = preconv_cue(&blk, i);
1.1 kristaps 345: }
346:
1.95 schwarze 347: while (i < blk.sz && (start || blk.buf[i] != '\0')) {
1.1 kristaps 348:
349: /*
350: * When finding an unescaped newline character,
351: * leave the character loop to process the line.
352: * Skip a preceding carriage return, if any.
353: */
354:
1.95 schwarze 355: if ('\r' == blk.buf[i] && i + 1 < blk.sz &&
1.1 kristaps 356: '\n' == blk.buf[i + 1])
357: ++i;
358: if ('\n' == blk.buf[i]) {
359: ++i;
360: ++lnn;
361: break;
362: }
363:
1.35 schwarze 364: /*
1.93 schwarze 365: * Make sure we have space for the worst
366: * case of 11 bytes: "\\[u10ffff]\0"
1.35 schwarze 367: */
368:
1.95 schwarze 369: if (pos + 11 > ln.sz)
1.35 schwarze 370: resize_buf(&ln, 256);
371:
1.47 schwarze 372: /*
1.93 schwarze 373: * Encode 8-bit input.
1.1 kristaps 374: */
375:
1.93 schwarze 376: c = blk.buf[i];
377: if (c & 0x80) {
1.95 schwarze 378: if ( ! (curp->filenc && preconv_encode(
379: &blk, &i, &ln, &pos, &curp->filenc))) {
1.114 schwarze 380: mandoc_vmsg(MANDOCERR_CHAR_BAD, curp,
381: curp->line, pos, "0x%x", c);
1.93 schwarze 382: ln.buf[pos++] = '?';
383: i++;
384: }
385: continue;
386: }
387:
388: /*
389: * Exclude control characters.
390: */
1.1 kristaps 391:
1.93 schwarze 392: if (c == 0x7f || (c < 0x20 && c != 0x09)) {
1.114 schwarze 393: mandoc_vmsg(c == 0x00 || c == 0x04 ||
394: c > 0x0a ? MANDOCERR_CHAR_BAD :
395: MANDOCERR_CHAR_UNSUPP,
396: curp, curp->line, pos, "0x%x", c);
1.1 kristaps 397: i++;
1.127 schwarze 398: if (c != '\r')
399: ln.buf[pos++] = '?';
1.1 kristaps 400: continue;
401: }
402:
403: /* Trailing backslash = a plain char. */
404:
1.95 schwarze 405: if (blk.buf[i] != '\\' || i + 1 == blk.sz) {
1.1 kristaps 406: ln.buf[pos++] = blk.buf[i++];
407: continue;
408: }
409:
410: /*
411: * Found escape and at least one other character.
412: * When it's a newline character, skip it.
413: * When there is a carriage return in between,
414: * skip that one as well.
415: */
416:
1.95 schwarze 417: if ('\r' == blk.buf[i + 1] && i + 2 < blk.sz &&
1.1 kristaps 418: '\n' == blk.buf[i + 2])
419: ++i;
420: if ('\n' == blk.buf[i + 1]) {
421: i += 2;
422: ++lnn;
423: continue;
424: }
425:
1.13 kristaps 426: if ('"' == blk.buf[i + 1] || '#' == blk.buf[i + 1]) {
1.154 schwarze 427: j = i;
1.1 kristaps 428: i += 2;
429: /* Comment, skip to end of line */
1.95 schwarze 430: for (; i < blk.sz; ++i) {
1.153 schwarze 431: if (blk.buf[i] != '\n')
432: continue;
433: if (blk.buf[i - 1] == ' ' ||
434: blk.buf[i - 1] == '\t')
435: mandoc_msg(
436: MANDOCERR_SPACE_EOL,
437: curp, curp->line,
1.154 schwarze 438: pos + i-1 - j, NULL);
1.153 schwarze 439: ++i;
440: ++lnn;
441: break;
1.1 kristaps 442: }
443:
444: /* Backout trailing whitespaces */
445: for (; pos > 0; --pos) {
446: if (ln.buf[pos - 1] != ' ')
447: break;
448: if (pos > 2 && ln.buf[pos - 2] == '\\')
449: break;
450: }
451: break;
452: }
453:
1.35 schwarze 454: /* Catch escaped bogus characters. */
455:
456: c = (unsigned char) blk.buf[i+1];
457:
1.47 schwarze 458: if ( ! (isascii(c) &&
459: (isgraph(c) || isblank(c)))) {
1.114 schwarze 460: mandoc_vmsg(MANDOCERR_CHAR_BAD, curp,
1.78 schwarze 461: curp->line, pos, "0x%x", c);
1.35 schwarze 462: i += 2;
463: ln.buf[pos++] = '?';
464: continue;
465: }
466:
1.1 kristaps 467: /* Some other escape sequence, copy & cont. */
468:
469: ln.buf[pos++] = blk.buf[i++];
470: ln.buf[pos++] = blk.buf[i++];
471: }
472:
1.95 schwarze 473: if (pos >= ln.sz)
1.1 kristaps 474: resize_buf(&ln, 256);
475:
476: ln.buf[pos] = '\0';
477:
478: /*
479: * A significant amount of complexity is contained by
480: * the roff preprocessor. It's line-oriented but can be
481: * expressed on one line, so we need at times to
482: * readjust our starting point and re-run it. The roff
483: * preprocessor can also readjust the buffers with new
484: * data, so we pass them in wholesale.
485: */
486:
487: of = 0;
488:
1.24 kristaps 489: /*
490: * Maintain a lookaside buffer of all parsed lines. We
491: * only do this if mparse_keep() has been invoked (the
492: * buffer may be accessed with mparse_getkeep()).
493: */
494:
495: if (curp->secondary) {
1.47 schwarze 496: curp->secondary->buf = mandoc_realloc(
497: curp->secondary->buf,
498: curp->secondary->sz + pos + 2);
499: memcpy(curp->secondary->buf +
500: curp->secondary->sz,
501: ln.buf, pos);
1.24 kristaps 502: curp->secondary->sz += pos;
503: curp->secondary->buf
504: [curp->secondary->sz] = '\n';
505: curp->secondary->sz++;
506: curp->secondary->buf
507: [curp->secondary->sz] = '\0';
508: }
1.1 kristaps 509: rerun:
1.96 schwarze 510: rr = roff_parseln(curp->roff, curp->line, &ln, &of);
1.1 kristaps 511:
512: switch (rr) {
1.47 schwarze 513: case ROFF_REPARSE:
1.1 kristaps 514: if (REPARSE_LIMIT >= ++curp->reparse_count)
1.95 schwarze 515: mparse_buf_r(curp, ln, of, 0);
1.1 kristaps 516: else
1.3 kristaps 517: mandoc_msg(MANDOCERR_ROFFLOOP, curp,
1.47 schwarze 518: curp->line, pos, NULL);
1.1 kristaps 519: pos = 0;
520: continue;
1.47 schwarze 521: case ROFF_APPEND:
1.95 schwarze 522: pos = strlen(ln.buf);
1.1 kristaps 523: continue;
1.47 schwarze 524: case ROFF_RERUN:
1.1 kristaps 525: goto rerun;
1.47 schwarze 526: case ROFF_IGN:
1.1 kristaps 527: pos = 0;
528: continue;
1.47 schwarze 529: case ROFF_SO:
1.95 schwarze 530: if ( ! (curp->options & MPARSE_SO) &&
531: (i >= blk.sz || blk.buf[i] == '\0')) {
1.45 schwarze 532: curp->sodest = mandoc_strdup(ln.buf + of);
533: free(ln.buf);
534: return;
535: }
1.24 kristaps 536: /*
537: * We remove `so' clauses from our lookaside
538: * buffer because we're going to descend into
539: * the file recursively.
540: */
1.47 schwarze 541: if (curp->secondary)
1.25 kristaps 542: curp->secondary->sz -= pos + 1;
1.113 schwarze 543: save_file = curp->file;
1.148 schwarze 544: if ((fd = mparse_open(curp, ln.buf + of)) != -1) {
1.110 schwarze 545: mparse_readfd(curp, fd, ln.buf + of);
1.147 schwarze 546: close(fd);
1.113 schwarze 547: curp->file = save_file;
548: } else {
549: curp->file = save_file;
1.52 schwarze 550: mandoc_vmsg(MANDOCERR_SO_FAIL,
551: curp, curp->line, pos,
552: ".so %s", ln.buf + of);
1.110 schwarze 553: ln.sz = mandoc_asprintf(&cp,
554: ".sp\nSee the file %s.\n.sp",
555: ln.buf + of);
556: free(ln.buf);
557: ln.buf = cp;
558: of = 0;
559: mparse_buf_r(curp, ln, of, 0);
1.52 schwarze 560: }
1.1 kristaps 561: pos = 0;
562: continue;
563: default:
564: break;
565: }
566:
1.150 schwarze 567: if (curp->man->macroset == MACROSET_NONE)
1.84 schwarze 568: choose_parser(curp);
1.1 kristaps 569:
1.47 schwarze 570: /*
1.84 schwarze 571: * Lastly, push down into the parsers themselves.
1.1 kristaps 572: * If libroff returns ROFF_TBL, then add it to the
573: * currently open parse. Since we only get here if
574: * there does exist data (see tbl_data.c), we're
575: * guaranteed that something's been allocated.
576: * Do the same for ROFF_EQN.
577: */
578:
1.139 schwarze 579: if (rr == ROFF_TBL)
1.100 schwarze 580: while ((span = roff_span(curp->roff)) != NULL)
1.139 schwarze 581: roff_addtbl(curp->man, span);
582: else if (rr == ROFF_EQN)
583: roff_addeqn(curp->man, roff_eqn(curp->roff));
584: else if ((curp->man->macroset == MACROSET_MDOC ?
1.135 schwarze 585: mdoc_parseln(curp->man, curp->line, ln.buf, of) :
1.100 schwarze 586: man_parseln(curp->man, curp->line, ln.buf, of)) == 2)
587: break;
1.1 kristaps 588:
589: /* Temporary buffers typically are not full. */
590:
591: if (0 == start && '\0' == blk.buf[i])
592: break;
593:
594: /* Start the next input line. */
595:
596: pos = 0;
597: }
598:
599: free(ln.buf);
600: }
601:
602: static int
1.40 schwarze 603: read_whole_file(struct mparse *curp, const char *file, int fd,
604: struct buf *fb, int *with_mmap)
1.1 kristaps 605: {
1.161 schwarze 606: struct stat st;
1.140 schwarze 607: gzFile gz;
1.1 kristaps 608: size_t off;
609: ssize_t ssz;
1.143 schwarze 610:
611: if (fstat(fd, &st) == -1)
612: err((int)MANDOCLEVEL_SYSERR, "%s", file);
1.1 kristaps 613:
614: /*
615: * If we're a regular file, try just reading in the whole entry
616: * via mmap(). This is faster than reading it into blocks, and
617: * since each file is only a few bytes to begin with, I'm not
618: * concerned that this is going to tank any machines.
619: */
620:
1.140 schwarze 621: if (curp->gzip == 0 && S_ISREG(st.st_mode)) {
1.131 schwarze 622: if (st.st_size > 0x7fffffff) {
1.111 schwarze 623: mandoc_msg(MANDOCERR_TOOLARGE, curp, 0, 0, NULL);
1.142 schwarze 624: return 0;
1.1 kristaps 625: }
626: *with_mmap = 1;
627: fb->sz = (size_t)st.st_size;
1.37 schwarze 628: fb->buf = mmap(NULL, fb->sz, PROT_READ, MAP_SHARED, fd, 0);
1.1 kristaps 629: if (fb->buf != MAP_FAILED)
1.142 schwarze 630: return 1;
1.1 kristaps 631: }
632:
1.140 schwarze 633: if (curp->gzip) {
1.143 schwarze 634: if ((gz = gzdopen(fd, "rb")) == NULL)
635: err((int)MANDOCLEVEL_SYSERR, "%s", file);
1.140 schwarze 636: } else
637: gz = NULL;
638:
1.1 kristaps 639: /*
640: * If this isn't a regular file (like, say, stdin), then we must
641: * go the old way and just read things in bit by bit.
642: */
643:
644: *with_mmap = 0;
645: off = 0;
646: fb->sz = 0;
647: fb->buf = NULL;
648: for (;;) {
649: if (off == fb->sz) {
650: if (fb->sz == (1U << 31)) {
1.111 schwarze 651: mandoc_msg(MANDOCERR_TOOLARGE, curp,
652: 0, 0, NULL);
1.1 kristaps 653: break;
654: }
655: resize_buf(fb, 65536);
656: }
1.140 schwarze 657: ssz = curp->gzip ?
658: gzread(gz, fb->buf + (int)off, fb->sz - off) :
659: read(fd, fb->buf + (int)off, fb->sz - off);
1.1 kristaps 660: if (ssz == 0) {
661: fb->sz = off;
1.142 schwarze 662: return 1;
1.1 kristaps 663: }
1.143 schwarze 664: if (ssz == -1)
665: err((int)MANDOCLEVEL_SYSERR, "%s", file);
1.1 kristaps 666: off += (size_t)ssz;
667: }
668:
669: free(fb->buf);
670: fb->buf = NULL;
1.142 schwarze 671: return 0;
1.1 kristaps 672: }
673:
674: static void
675: mparse_end(struct mparse *curp)
676: {
1.135 schwarze 677: if (curp->man->macroset == MACROSET_NONE)
678: curp->man->macroset = MACROSET_MAN;
679: if (curp->man->macroset == MACROSET_MDOC)
680: mdoc_endparse(curp->man);
681: else
1.111 schwarze 682: man_endparse(curp->man);
1.1 kristaps 683: roff_endparse(curp->roff);
684: }
685:
686: static void
1.36 schwarze 687: mparse_parse_buffer(struct mparse *curp, struct buf blk, const char *file)
1.28 joerg 688: {
1.85 schwarze 689: struct buf *svprimary;
1.28 joerg 690: const char *svfile;
1.95 schwarze 691: size_t offset;
1.36 schwarze 692: static int recursion_depth;
693:
694: if (64 < recursion_depth) {
695: mandoc_msg(MANDOCERR_ROFFLOOP, curp, curp->line, 0, NULL);
696: return;
697: }
1.28 joerg 698:
699: /* Line number is per-file. */
700: svfile = curp->file;
701: curp->file = file;
1.85 schwarze 702: svprimary = curp->primary;
1.83 schwarze 703: curp->primary = &blk;
1.28 joerg 704: curp->line = 1;
1.36 schwarze 705: recursion_depth++;
1.28 joerg 706:
1.93 schwarze 707: /* Skip an UTF-8 byte order mark. */
708: if (curp->filenc & MPARSE_UTF8 && blk.sz > 2 &&
709: (unsigned char)blk.buf[0] == 0xef &&
710: (unsigned char)blk.buf[1] == 0xbb &&
711: (unsigned char)blk.buf[2] == 0xbf) {
1.95 schwarze 712: offset = 3;
1.93 schwarze 713: curp->filenc &= ~MPARSE_LATIN1;
1.95 schwarze 714: } else
715: offset = 0;
1.93 schwarze 716:
1.95 schwarze 717: mparse_buf_r(curp, blk, offset, 1);
1.28 joerg 718:
1.111 schwarze 719: if (--recursion_depth == 0)
1.28 joerg 720: mparse_end(curp);
721:
1.85 schwarze 722: curp->primary = svprimary;
1.28 joerg 723: curp->file = svfile;
724: }
725:
726: enum mandoclevel
1.104 schwarze 727: mparse_readmem(struct mparse *curp, void *buf, size_t len,
1.28 joerg 728: const char *file)
729: {
730: struct buf blk;
731:
1.104 schwarze 732: blk.buf = buf;
1.28 joerg 733: blk.sz = len;
734:
1.36 schwarze 735: mparse_parse_buffer(curp, blk, file);
1.142 schwarze 736: return curp->file_status;
1.28 joerg 737: }
738:
1.98 schwarze 739: /*
740: * Read the whole file into memory and call the parsers.
741: * Called recursively when an .so request is encountered.
742: */
1.36 schwarze 743: enum mandoclevel
744: mparse_readfd(struct mparse *curp, int fd, const char *file)
1.1 kristaps 745: {
1.28 joerg 746: struct buf blk;
747: int with_mmap;
1.93 schwarze 748: int save_filenc;
1.1 kristaps 749:
1.91 schwarze 750: if (read_whole_file(curp, file, fd, &blk, &with_mmap)) {
1.93 schwarze 751: save_filenc = curp->filenc;
752: curp->filenc = curp->options &
753: (MPARSE_UTF8 | MPARSE_LATIN1);
1.91 schwarze 754: mparse_parse_buffer(curp, blk, file);
1.93 schwarze 755: curp->filenc = save_filenc;
1.91 schwarze 756: if (with_mmap)
757: munmap(blk.buf, blk.sz);
758: else
759: free(blk.buf);
760: }
1.142 schwarze 761: return curp->file_status;
1.82 schwarze 762: }
763:
1.148 schwarze 764: int
765: mparse_open(struct mparse *curp, const char *file)
1.82 schwarze 766: {
767: char *cp;
1.148 schwarze 768: int fd;
1.82 schwarze 769:
770: curp->file = file;
1.140 schwarze 771: cp = strrchr(file, '.');
772: curp->gzip = (cp != NULL && ! strcmp(cp + 1, "gz"));
1.98 schwarze 773:
1.140 schwarze 774: /* First try to use the filename as it is. */
1.98 schwarze 775:
1.148 schwarze 776: if ((fd = open(file, O_RDONLY)) != -1)
777: return fd;
1.98 schwarze 778:
1.140 schwarze 779: /*
780: * If that doesn't work and the filename doesn't
781: * already end in .gz, try appending .gz.
782: */
1.98 schwarze 783:
1.140 schwarze 784: if ( ! curp->gzip) {
1.98 schwarze 785: mandoc_asprintf(&cp, "%s.gz", file);
1.149 schwarze 786: fd = open(cp, O_RDONLY);
1.108 schwarze 787: free(cp);
1.148 schwarze 788: if (fd != -1) {
1.140 schwarze 789: curp->gzip = 1;
1.148 schwarze 790: return fd;
1.82 schwarze 791: }
792: }
793:
1.140 schwarze 794: /* Neither worked, give up. */
1.97 schwarze 795:
1.140 schwarze 796: mandoc_msg(MANDOCERR_FILE, curp, 0, 0, strerror(errno));
1.148 schwarze 797: return -1;
1.1 kristaps 798: }
799:
800: struct mparse *
1.94 schwarze 801: mparse_alloc(int options, enum mandoclevel wlevel, mandocmsg mmsg,
1.144 schwarze 802: const char *defos)
1.1 kristaps 803: {
804: struct mparse *curp;
1.10 kristaps 805:
1.1 kristaps 806: curp = mandoc_calloc(1, sizeof(struct mparse));
807:
1.44 schwarze 808: curp->options = options;
1.3 kristaps 809: curp->wlevel = wlevel;
1.1 kristaps 810: curp->mmsg = mmsg;
1.29 schwarze 811: curp->defos = defos;
1.1 kristaps 812:
1.144 schwarze 813: curp->roff = roff_alloc(curp, options);
1.137 schwarze 814: curp->man = roff_man_alloc( curp->roff, curp, curp->defos,
815: curp->options & MPARSE_QUICK ? 1 : 0);
1.136 schwarze 816: if (curp->options & MPARSE_MDOC) {
817: mdoc_hash_init();
1.137 schwarze 818: curp->man->macroset = MACROSET_MDOC;
819: } else if (curp->options & MPARSE_MAN) {
1.136 schwarze 820: man_hash_init();
1.137 schwarze 821: curp->man->macroset = MACROSET_MAN;
1.136 schwarze 822: }
1.138 schwarze 823: curp->man->first->tok = TOKEN_NONE;
1.142 schwarze 824: return curp;
1.1 kristaps 825: }
826:
827: void
828: mparse_reset(struct mparse *curp)
829: {
830: roff_reset(curp->roff);
1.150 schwarze 831: roff_man_reset(curp->man);
1.160 schwarze 832:
833: free(curp->sodest);
834: curp->sodest = NULL;
835:
1.24 kristaps 836: if (curp->secondary)
837: curp->secondary->sz = 0;
1.1 kristaps 838:
839: curp->file_status = MANDOCLEVEL_OK;
1.159 schwarze 840: curp->gzip = 0;
1.1 kristaps 841: }
842:
843: void
844: mparse_free(struct mparse *curp)
845: {
846:
1.137 schwarze 847: roff_man_free(curp->man);
1.160 schwarze 848: roff_free(curp->roff);
1.24 kristaps 849: if (curp->secondary)
850: free(curp->secondary->buf);
1.1 kristaps 851:
1.24 kristaps 852: free(curp->secondary);
1.45 schwarze 853: free(curp->sodest);
1.1 kristaps 854: free(curp);
855: }
856:
857: void
1.135 schwarze 858: mparse_result(struct mparse *curp, struct roff_man **man,
859: char **sodest)
1.1 kristaps 860: {
861:
1.45 schwarze 862: if (sodest && NULL != (*sodest = curp->sodest)) {
863: *man = NULL;
864: return;
865: }
1.9 kristaps 866: if (man)
867: *man = curp->man;
1.157 schwarze 868: }
869:
870: void
871: mparse_updaterc(struct mparse *curp, enum mandoclevel *rc)
872: {
873: if (curp->file_status > *rc)
874: *rc = curp->file_status;
1.3 kristaps 875: }
876:
877: void
878: mandoc_vmsg(enum mandocerr t, struct mparse *m,
879: int ln, int pos, const char *fmt, ...)
880: {
881: char buf[256];
882: va_list ap;
883:
884: va_start(ap, fmt);
1.48 schwarze 885: (void)vsnprintf(buf, sizeof(buf), fmt, ap);
1.3 kristaps 886: va_end(ap);
887:
888: mandoc_msg(t, m, ln, pos, buf);
889: }
890:
891: void
1.47 schwarze 892: mandoc_msg(enum mandocerr er, struct mparse *m,
1.3 kristaps 893: int ln, int col, const char *msg)
894: {
895: enum mandoclevel level;
896:
1.112 schwarze 897: level = MANDOCLEVEL_UNSUPP;
1.3 kristaps 898: while (er < mandoclimits[level])
899: level--;
900:
1.108 schwarze 901: if (level < m->wlevel && er != MANDOCERR_FILE)
1.3 kristaps 902: return;
903:
1.8 kristaps 904: if (m->mmsg)
905: (*m->mmsg)(er, level, m->file, ln, col, msg);
1.3 kristaps 906:
907: if (m->file_status < level)
908: m->file_status = level;
1.7 kristaps 909: }
910:
911: const char *
912: mparse_strerror(enum mandocerr er)
913: {
914:
1.142 schwarze 915: return mandocerrs[er];
1.7 kristaps 916: }
917:
918: const char *
919: mparse_strlevel(enum mandoclevel lvl)
920: {
1.142 schwarze 921: return mandoclevels[lvl];
1.24 kristaps 922: }
923:
924: void
925: mparse_keep(struct mparse *p)
926: {
927:
928: assert(NULL == p->secondary);
929: p->secondary = mandoc_calloc(1, sizeof(struct buf));
930: }
931:
932: const char *
933: mparse_getkeep(const struct mparse *p)
934: {
935:
936: assert(p->secondary);
1.142 schwarze 937: return p->secondary->sz ? p->secondary->buf : NULL;
1.1 kristaps 938: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to read.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc