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