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