Annotation of mandoc/read.c, Revision 1.146
1.146 ! schwarze 1: /* $Id: read.c,v 1.145 2015/10/30 19:04:16 schwarze Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.107 schwarze 4: * Copyright (c) 2010-2015 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",
146: "missing -width in -tag list, using 8n",
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.137 schwarze 294: if (curp->man == NULL) {
295: curp->man = roff_man_alloc(curp->roff, curp, curp->defos,
296: curp->options & MPARSE_QUICK ? 1 : 0);
297: curp->man->macroset = MACROSET_MAN;
1.138 schwarze 298: curp->man->first->tok = TOKEN_NONE;
1.137 schwarze 299: }
300:
1.83 schwarze 301: if (format == MPARSE_MDOC) {
1.136 schwarze 302: mdoc_hash_init();
1.137 schwarze 303: curp->man->macroset = MACROSET_MDOC;
1.138 schwarze 304: curp->man->first->tok = TOKEN_NONE;
1.137 schwarze 305: } else {
306: man_hash_init();
307: curp->man->macroset = MACROSET_MAN;
1.138 schwarze 308: curp->man->first->tok = TOKEN_NONE;
1.47 schwarze 309: }
1.1 kristaps 310: }
311:
312: /*
1.95 schwarze 313: * Main parse routine for a buffer.
314: * It assumes encoding and line numbering are already set up.
315: * It can recurse directly (for invocations of user-defined
316: * macros, inline equations, and input line traps)
317: * and indirectly (for .so file inclusion).
1.1 kristaps 318: */
319: static void
1.95 schwarze 320: mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
1.1 kristaps 321: {
322: const struct tbl_span *span;
323: struct buf ln;
1.113 schwarze 324: const char *save_file;
1.110 schwarze 325: char *cp;
1.95 schwarze 326: size_t pos; /* byte number in the ln buffer */
1.1 kristaps 327: enum rofferr rr;
1.100 schwarze 328: int of;
1.1 kristaps 329: int lnn; /* line number in the real file */
1.110 schwarze 330: int fd;
1.1 kristaps 331: unsigned char c;
332:
1.95 schwarze 333: memset(&ln, 0, sizeof(ln));
1.1 kristaps 334:
1.47 schwarze 335: lnn = curp->line;
336: pos = 0;
1.1 kristaps 337:
1.95 schwarze 338: while (i < blk.sz) {
1.1 kristaps 339: if (0 == pos && '\0' == blk.buf[i])
340: break;
341:
342: if (start) {
343: curp->line = lnn;
344: curp->reparse_count = 0;
1.93 schwarze 345:
346: if (lnn < 3 &&
347: curp->filenc & MPARSE_UTF8 &&
1.95 schwarze 348: curp->filenc & MPARSE_LATIN1)
349: curp->filenc = preconv_cue(&blk, i);
1.1 kristaps 350: }
351:
1.95 schwarze 352: while (i < blk.sz && (start || blk.buf[i] != '\0')) {
1.1 kristaps 353:
354: /*
355: * When finding an unescaped newline character,
356: * leave the character loop to process the line.
357: * Skip a preceding carriage return, if any.
358: */
359:
1.95 schwarze 360: if ('\r' == blk.buf[i] && i + 1 < blk.sz &&
1.1 kristaps 361: '\n' == blk.buf[i + 1])
362: ++i;
363: if ('\n' == blk.buf[i]) {
364: ++i;
365: ++lnn;
366: break;
367: }
368:
1.35 schwarze 369: /*
1.93 schwarze 370: * Make sure we have space for the worst
371: * case of 11 bytes: "\\[u10ffff]\0"
1.35 schwarze 372: */
373:
1.95 schwarze 374: if (pos + 11 > ln.sz)
1.35 schwarze 375: resize_buf(&ln, 256);
376:
1.47 schwarze 377: /*
1.93 schwarze 378: * Encode 8-bit input.
1.1 kristaps 379: */
380:
1.93 schwarze 381: c = blk.buf[i];
382: if (c & 0x80) {
1.95 schwarze 383: if ( ! (curp->filenc && preconv_encode(
384: &blk, &i, &ln, &pos, &curp->filenc))) {
1.114 schwarze 385: mandoc_vmsg(MANDOCERR_CHAR_BAD, curp,
386: curp->line, pos, "0x%x", c);
1.93 schwarze 387: ln.buf[pos++] = '?';
388: i++;
389: }
390: continue;
391: }
392:
393: /*
394: * Exclude control characters.
395: */
1.1 kristaps 396:
1.93 schwarze 397: if (c == 0x7f || (c < 0x20 && c != 0x09)) {
1.114 schwarze 398: mandoc_vmsg(c == 0x00 || c == 0x04 ||
399: c > 0x0a ? MANDOCERR_CHAR_BAD :
400: MANDOCERR_CHAR_UNSUPP,
401: curp, curp->line, pos, "0x%x", c);
1.1 kristaps 402: i++;
1.127 schwarze 403: if (c != '\r')
404: ln.buf[pos++] = '?';
1.1 kristaps 405: continue;
406: }
407:
408: /* Trailing backslash = a plain char. */
409:
1.95 schwarze 410: if (blk.buf[i] != '\\' || i + 1 == blk.sz) {
1.1 kristaps 411: ln.buf[pos++] = blk.buf[i++];
412: continue;
413: }
414:
415: /*
416: * Found escape and at least one other character.
417: * When it's a newline character, skip it.
418: * When there is a carriage return in between,
419: * skip that one as well.
420: */
421:
1.95 schwarze 422: if ('\r' == blk.buf[i + 1] && i + 2 < blk.sz &&
1.1 kristaps 423: '\n' == blk.buf[i + 2])
424: ++i;
425: if ('\n' == blk.buf[i + 1]) {
426: i += 2;
427: ++lnn;
428: continue;
429: }
430:
1.13 kristaps 431: if ('"' == blk.buf[i + 1] || '#' == blk.buf[i + 1]) {
1.1 kristaps 432: i += 2;
433: /* Comment, skip to end of line */
1.95 schwarze 434: for (; i < blk.sz; ++i) {
1.1 kristaps 435: if ('\n' == blk.buf[i]) {
436: ++i;
437: ++lnn;
438: break;
439: }
440: }
441:
442: /* Backout trailing whitespaces */
443: for (; pos > 0; --pos) {
444: if (ln.buf[pos - 1] != ' ')
445: break;
446: if (pos > 2 && ln.buf[pos - 2] == '\\')
447: break;
448: }
449: break;
450: }
451:
1.35 schwarze 452: /* Catch escaped bogus characters. */
453:
454: c = (unsigned char) blk.buf[i+1];
455:
1.47 schwarze 456: if ( ! (isascii(c) &&
457: (isgraph(c) || isblank(c)))) {
1.114 schwarze 458: mandoc_vmsg(MANDOCERR_CHAR_BAD, curp,
1.78 schwarze 459: curp->line, pos, "0x%x", c);
1.35 schwarze 460: i += 2;
461: ln.buf[pos++] = '?';
462: continue;
463: }
464:
1.1 kristaps 465: /* Some other escape sequence, copy & cont. */
466:
467: ln.buf[pos++] = blk.buf[i++];
468: ln.buf[pos++] = blk.buf[i++];
469: }
470:
1.95 schwarze 471: if (pos >= ln.sz)
1.1 kristaps 472: resize_buf(&ln, 256);
473:
474: ln.buf[pos] = '\0';
475:
476: /*
477: * A significant amount of complexity is contained by
478: * the roff preprocessor. It's line-oriented but can be
479: * expressed on one line, so we need at times to
480: * readjust our starting point and re-run it. The roff
481: * preprocessor can also readjust the buffers with new
482: * data, so we pass them in wholesale.
483: */
484:
485: of = 0;
486:
1.24 kristaps 487: /*
488: * Maintain a lookaside buffer of all parsed lines. We
489: * only do this if mparse_keep() has been invoked (the
490: * buffer may be accessed with mparse_getkeep()).
491: */
492:
493: if (curp->secondary) {
1.47 schwarze 494: curp->secondary->buf = mandoc_realloc(
495: curp->secondary->buf,
496: curp->secondary->sz + pos + 2);
497: memcpy(curp->secondary->buf +
498: curp->secondary->sz,
499: ln.buf, pos);
1.24 kristaps 500: curp->secondary->sz += pos;
501: curp->secondary->buf
502: [curp->secondary->sz] = '\n';
503: curp->secondary->sz++;
504: curp->secondary->buf
505: [curp->secondary->sz] = '\0';
506: }
1.1 kristaps 507: rerun:
1.96 schwarze 508: rr = roff_parseln(curp->roff, curp->line, &ln, &of);
1.1 kristaps 509:
510: switch (rr) {
1.47 schwarze 511: case ROFF_REPARSE:
1.1 kristaps 512: if (REPARSE_LIMIT >= ++curp->reparse_count)
1.95 schwarze 513: mparse_buf_r(curp, ln, of, 0);
1.1 kristaps 514: else
1.3 kristaps 515: mandoc_msg(MANDOCERR_ROFFLOOP, curp,
1.47 schwarze 516: curp->line, pos, NULL);
1.1 kristaps 517: pos = 0;
518: continue;
1.47 schwarze 519: case ROFF_APPEND:
1.95 schwarze 520: pos = strlen(ln.buf);
1.1 kristaps 521: continue;
1.47 schwarze 522: case ROFF_RERUN:
1.1 kristaps 523: goto rerun;
1.47 schwarze 524: case ROFF_IGN:
1.1 kristaps 525: pos = 0;
526: continue;
1.47 schwarze 527: case ROFF_SO:
1.95 schwarze 528: if ( ! (curp->options & MPARSE_SO) &&
529: (i >= blk.sz || blk.buf[i] == '\0')) {
1.45 schwarze 530: curp->sodest = mandoc_strdup(ln.buf + of);
531: free(ln.buf);
532: return;
533: }
1.24 kristaps 534: /*
535: * We remove `so' clauses from our lookaside
536: * buffer because we're going to descend into
537: * the file recursively.
538: */
1.47 schwarze 539: if (curp->secondary)
1.25 kristaps 540: curp->secondary->sz -= pos + 1;
1.113 schwarze 541: save_file = curp->file;
1.110 schwarze 542: if (mparse_open(curp, &fd, ln.buf + of) ==
1.113 schwarze 543: MANDOCLEVEL_OK) {
1.110 schwarze 544: mparse_readfd(curp, fd, ln.buf + of);
1.113 schwarze 545: curp->file = save_file;
546: } else {
547: curp->file = save_file;
1.52 schwarze 548: mandoc_vmsg(MANDOCERR_SO_FAIL,
549: curp, curp->line, pos,
550: ".so %s", ln.buf + of);
1.110 schwarze 551: ln.sz = mandoc_asprintf(&cp,
552: ".sp\nSee the file %s.\n.sp",
553: ln.buf + of);
554: free(ln.buf);
555: ln.buf = cp;
556: of = 0;
557: mparse_buf_r(curp, ln, of, 0);
1.52 schwarze 558: }
1.1 kristaps 559: pos = 0;
560: continue;
561: default:
562: break;
563: }
564:
565: /*
566: * If input parsers have not been allocated, do so now.
1.14 kristaps 567: * We keep these instanced between parsers, but set them
1.1 kristaps 568: * locally per parse routine since we can use different
569: * parsers with each one.
570: */
571:
1.135 schwarze 572: if (curp->man == NULL ||
573: curp->man->macroset == MACROSET_NONE)
1.84 schwarze 574: choose_parser(curp);
1.1 kristaps 575:
1.47 schwarze 576: /*
1.84 schwarze 577: * Lastly, push down into the parsers themselves.
1.1 kristaps 578: * If libroff returns ROFF_TBL, then add it to the
579: * currently open parse. Since we only get here if
580: * there does exist data (see tbl_data.c), we're
581: * guaranteed that something's been allocated.
582: * Do the same for ROFF_EQN.
583: */
584:
1.139 schwarze 585: if (rr == ROFF_TBL)
1.100 schwarze 586: while ((span = roff_span(curp->roff)) != NULL)
1.139 schwarze 587: roff_addtbl(curp->man, span);
588: else if (rr == ROFF_EQN)
589: roff_addeqn(curp->man, roff_eqn(curp->roff));
590: else if ((curp->man->macroset == MACROSET_MDOC ?
1.135 schwarze 591: mdoc_parseln(curp->man, curp->line, ln.buf, of) :
1.100 schwarze 592: man_parseln(curp->man, curp->line, ln.buf, of)) == 2)
593: break;
1.1 kristaps 594:
595: /* Temporary buffers typically are not full. */
596:
597: if (0 == start && '\0' == blk.buf[i])
598: break;
599:
600: /* Start the next input line. */
601:
602: pos = 0;
603: }
604:
605: free(ln.buf);
606: }
607:
608: static int
1.40 schwarze 609: read_whole_file(struct mparse *curp, const char *file, int fd,
610: struct buf *fb, int *with_mmap)
1.1 kristaps 611: {
1.140 schwarze 612: gzFile gz;
1.1 kristaps 613: size_t off;
614: ssize_t ssz;
615:
1.81 schwarze 616: #if HAVE_MMAP
1.15 kristaps 617: struct stat st;
1.143 schwarze 618:
619: if (fstat(fd, &st) == -1)
620: err((int)MANDOCLEVEL_SYSERR, "%s", file);
1.1 kristaps 621:
622: /*
623: * If we're a regular file, try just reading in the whole entry
624: * via mmap(). This is faster than reading it into blocks, and
625: * since each file is only a few bytes to begin with, I'm not
626: * concerned that this is going to tank any machines.
627: */
628:
1.140 schwarze 629: if (curp->gzip == 0 && S_ISREG(st.st_mode)) {
1.131 schwarze 630: if (st.st_size > 0x7fffffff) {
1.111 schwarze 631: mandoc_msg(MANDOCERR_TOOLARGE, curp, 0, 0, NULL);
1.142 schwarze 632: return 0;
1.1 kristaps 633: }
634: *with_mmap = 1;
635: fb->sz = (size_t)st.st_size;
1.37 schwarze 636: fb->buf = mmap(NULL, fb->sz, PROT_READ, MAP_SHARED, fd, 0);
1.1 kristaps 637: if (fb->buf != MAP_FAILED)
1.142 schwarze 638: return 1;
1.1 kristaps 639: }
1.15 kristaps 640: #endif
1.1 kristaps 641:
1.140 schwarze 642: if (curp->gzip) {
1.143 schwarze 643: if ((gz = gzdopen(fd, "rb")) == NULL)
644: err((int)MANDOCLEVEL_SYSERR, "%s", file);
1.140 schwarze 645: } else
646: gz = NULL;
647:
1.1 kristaps 648: /*
649: * If this isn't a regular file (like, say, stdin), then we must
650: * go the old way and just read things in bit by bit.
651: */
652:
653: *with_mmap = 0;
654: off = 0;
655: fb->sz = 0;
656: fb->buf = NULL;
657: for (;;) {
658: if (off == fb->sz) {
659: if (fb->sz == (1U << 31)) {
1.111 schwarze 660: mandoc_msg(MANDOCERR_TOOLARGE, curp,
661: 0, 0, NULL);
1.1 kristaps 662: break;
663: }
664: resize_buf(fb, 65536);
665: }
1.140 schwarze 666: ssz = curp->gzip ?
667: gzread(gz, fb->buf + (int)off, fb->sz - off) :
668: read(fd, fb->buf + (int)off, fb->sz - off);
1.1 kristaps 669: if (ssz == 0) {
670: fb->sz = off;
1.142 schwarze 671: return 1;
1.1 kristaps 672: }
1.143 schwarze 673: if (ssz == -1)
674: err((int)MANDOCLEVEL_SYSERR, "%s", file);
1.1 kristaps 675: off += (size_t)ssz;
676: }
677:
678: free(fb->buf);
679: fb->buf = NULL;
1.142 schwarze 680: return 0;
1.1 kristaps 681: }
682:
683: static void
684: mparse_end(struct mparse *curp)
685: {
686:
1.135 schwarze 687: if (curp->man == NULL && curp->sodest == NULL)
1.137 schwarze 688: curp->man = roff_man_alloc(curp->roff, curp, curp->defos,
1.135 schwarze 689: curp->options & MPARSE_QUICK ? 1 : 0);
690: if (curp->man->macroset == MACROSET_NONE)
691: curp->man->macroset = MACROSET_MAN;
692: if (curp->man->macroset == MACROSET_MDOC)
693: mdoc_endparse(curp->man);
694: else
1.111 schwarze 695: man_endparse(curp->man);
1.1 kristaps 696: roff_endparse(curp->roff);
697: }
698:
699: static void
1.36 schwarze 700: mparse_parse_buffer(struct mparse *curp, struct buf blk, const char *file)
1.28 joerg 701: {
1.85 schwarze 702: struct buf *svprimary;
1.28 joerg 703: const char *svfile;
1.95 schwarze 704: size_t offset;
1.36 schwarze 705: static int recursion_depth;
706:
707: if (64 < recursion_depth) {
708: mandoc_msg(MANDOCERR_ROFFLOOP, curp, curp->line, 0, NULL);
709: return;
710: }
1.28 joerg 711:
712: /* Line number is per-file. */
713: svfile = curp->file;
714: curp->file = file;
1.85 schwarze 715: svprimary = curp->primary;
1.83 schwarze 716: curp->primary = &blk;
1.28 joerg 717: curp->line = 1;
1.36 schwarze 718: recursion_depth++;
1.28 joerg 719:
1.93 schwarze 720: /* Skip an UTF-8 byte order mark. */
721: if (curp->filenc & MPARSE_UTF8 && blk.sz > 2 &&
722: (unsigned char)blk.buf[0] == 0xef &&
723: (unsigned char)blk.buf[1] == 0xbb &&
724: (unsigned char)blk.buf[2] == 0xbf) {
1.95 schwarze 725: offset = 3;
1.93 schwarze 726: curp->filenc &= ~MPARSE_LATIN1;
1.95 schwarze 727: } else
728: offset = 0;
1.93 schwarze 729:
1.95 schwarze 730: mparse_buf_r(curp, blk, offset, 1);
1.28 joerg 731:
1.111 schwarze 732: if (--recursion_depth == 0)
1.28 joerg 733: mparse_end(curp);
734:
1.85 schwarze 735: curp->primary = svprimary;
1.28 joerg 736: curp->file = svfile;
737: }
738:
739: enum mandoclevel
1.104 schwarze 740: mparse_readmem(struct mparse *curp, void *buf, size_t len,
1.28 joerg 741: const char *file)
742: {
743: struct buf blk;
744:
1.104 schwarze 745: blk.buf = buf;
1.28 joerg 746: blk.sz = len;
747:
1.36 schwarze 748: mparse_parse_buffer(curp, blk, file);
1.142 schwarze 749: return curp->file_status;
1.28 joerg 750: }
751:
1.98 schwarze 752: /*
753: * Read the whole file into memory and call the parsers.
754: * Called recursively when an .so request is encountered.
755: */
1.36 schwarze 756: enum mandoclevel
757: mparse_readfd(struct mparse *curp, int fd, const char *file)
1.1 kristaps 758: {
1.28 joerg 759: struct buf blk;
760: int with_mmap;
1.93 schwarze 761: int save_filenc;
1.1 kristaps 762:
1.91 schwarze 763: if (read_whole_file(curp, file, fd, &blk, &with_mmap)) {
1.93 schwarze 764: save_filenc = curp->filenc;
765: curp->filenc = curp->options &
766: (MPARSE_UTF8 | MPARSE_LATIN1);
1.91 schwarze 767: mparse_parse_buffer(curp, blk, file);
1.93 schwarze 768: curp->filenc = save_filenc;
1.81 schwarze 769: #if HAVE_MMAP
1.91 schwarze 770: if (with_mmap)
771: munmap(blk.buf, blk.sz);
772: else
1.28 joerg 773: #endif
1.91 schwarze 774: free(blk.buf);
775: }
1.1 kristaps 776:
1.98 schwarze 777: if (fd != STDIN_FILENO && close(fd) == -1)
1.1 kristaps 778: perror(file);
1.91 schwarze 779:
1.142 schwarze 780: return curp->file_status;
1.82 schwarze 781: }
782:
783: enum mandoclevel
1.97 schwarze 784: mparse_open(struct mparse *curp, int *fd, const char *file)
1.82 schwarze 785: {
786: char *cp;
787:
788: curp->file = file;
1.140 schwarze 789: cp = strrchr(file, '.');
790: curp->gzip = (cp != NULL && ! strcmp(cp + 1, "gz"));
1.98 schwarze 791:
1.140 schwarze 792: /* First try to use the filename as it is. */
1.98 schwarze 793:
1.140 schwarze 794: if ((*fd = open(file, O_RDONLY)) != -1)
1.142 schwarze 795: return MANDOCLEVEL_OK;
1.98 schwarze 796:
1.140 schwarze 797: /*
798: * If that doesn't work and the filename doesn't
799: * already end in .gz, try appending .gz.
800: */
1.98 schwarze 801:
1.140 schwarze 802: if ( ! curp->gzip) {
1.98 schwarze 803: mandoc_asprintf(&cp, "%s.gz", file);
1.140 schwarze 804: *fd = open(file, O_RDONLY);
1.108 schwarze 805: free(cp);
1.140 schwarze 806: if (*fd != -1) {
807: curp->gzip = 1;
1.142 schwarze 808: return MANDOCLEVEL_OK;
1.82 schwarze 809: }
810: }
811:
1.140 schwarze 812: /* Neither worked, give up. */
1.97 schwarze 813:
1.140 schwarze 814: mandoc_msg(MANDOCERR_FILE, curp, 0, 0, strerror(errno));
1.142 schwarze 815: return MANDOCLEVEL_ERROR;
1.1 kristaps 816: }
817:
818: struct mparse *
1.94 schwarze 819: mparse_alloc(int options, enum mandoclevel wlevel, mandocmsg mmsg,
1.144 schwarze 820: const char *defos)
1.1 kristaps 821: {
822: struct mparse *curp;
1.10 kristaps 823:
1.1 kristaps 824: curp = mandoc_calloc(1, sizeof(struct mparse));
825:
1.44 schwarze 826: curp->options = options;
1.3 kristaps 827: curp->wlevel = wlevel;
1.1 kristaps 828: curp->mmsg = mmsg;
1.29 schwarze 829: curp->defos = defos;
1.1 kristaps 830:
1.144 schwarze 831: curp->roff = roff_alloc(curp, options);
1.137 schwarze 832: curp->man = roff_man_alloc( curp->roff, curp, curp->defos,
833: curp->options & MPARSE_QUICK ? 1 : 0);
1.136 schwarze 834: if (curp->options & MPARSE_MDOC) {
835: mdoc_hash_init();
1.137 schwarze 836: curp->man->macroset = MACROSET_MDOC;
837: } else if (curp->options & MPARSE_MAN) {
1.136 schwarze 838: man_hash_init();
1.137 schwarze 839: curp->man->macroset = MACROSET_MAN;
1.136 schwarze 840: }
1.138 schwarze 841: curp->man->first->tok = TOKEN_NONE;
1.142 schwarze 842: return curp;
1.1 kristaps 843: }
844:
845: void
846: mparse_reset(struct mparse *curp)
847: {
848:
849: roff_reset(curp->roff);
850:
1.137 schwarze 851: if (curp->man != NULL)
852: roff_man_reset(curp->man);
1.24 kristaps 853: if (curp->secondary)
854: curp->secondary->sz = 0;
1.1 kristaps 855:
856: curp->file_status = MANDOCLEVEL_OK;
1.45 schwarze 857:
858: free(curp->sodest);
859: curp->sodest = NULL;
1.1 kristaps 860: }
861:
862: void
863: mparse_free(struct mparse *curp)
864: {
865:
1.137 schwarze 866: roff_man_free(curp->man);
1.1 kristaps 867: if (curp->roff)
868: roff_free(curp->roff);
1.24 kristaps 869: if (curp->secondary)
870: free(curp->secondary->buf);
1.1 kristaps 871:
1.24 kristaps 872: free(curp->secondary);
1.45 schwarze 873: free(curp->sodest);
1.1 kristaps 874: free(curp);
875: }
876:
877: void
1.135 schwarze 878: mparse_result(struct mparse *curp, struct roff_man **man,
879: char **sodest)
1.1 kristaps 880: {
881:
1.45 schwarze 882: if (sodest && NULL != (*sodest = curp->sodest)) {
883: *man = NULL;
884: return;
885: }
1.9 kristaps 886: if (man)
887: *man = curp->man;
1.3 kristaps 888: }
889:
890: void
891: mandoc_vmsg(enum mandocerr t, struct mparse *m,
892: int ln, int pos, const char *fmt, ...)
893: {
894: char buf[256];
895: va_list ap;
896:
897: va_start(ap, fmt);
1.48 schwarze 898: (void)vsnprintf(buf, sizeof(buf), fmt, ap);
1.3 kristaps 899: va_end(ap);
900:
901: mandoc_msg(t, m, ln, pos, buf);
902: }
903:
904: void
1.47 schwarze 905: mandoc_msg(enum mandocerr er, struct mparse *m,
1.3 kristaps 906: int ln, int col, const char *msg)
907: {
908: enum mandoclevel level;
909:
1.112 schwarze 910: level = MANDOCLEVEL_UNSUPP;
1.3 kristaps 911: while (er < mandoclimits[level])
912: level--;
913:
1.108 schwarze 914: if (level < m->wlevel && er != MANDOCERR_FILE)
1.3 kristaps 915: return;
916:
1.8 kristaps 917: if (m->mmsg)
918: (*m->mmsg)(er, level, m->file, ln, col, msg);
1.3 kristaps 919:
920: if (m->file_status < level)
921: m->file_status = level;
1.7 kristaps 922: }
923:
924: const char *
925: mparse_strerror(enum mandocerr er)
926: {
927:
1.142 schwarze 928: return mandocerrs[er];
1.7 kristaps 929: }
930:
931: const char *
932: mparse_strlevel(enum mandoclevel lvl)
933: {
1.142 schwarze 934: return mandoclevels[lvl];
1.24 kristaps 935: }
936:
937: void
938: mparse_keep(struct mparse *p)
939: {
940:
941: assert(NULL == p->secondary);
942: p->secondary = mandoc_calloc(1, sizeof(struct buf));
943: }
944:
945: const char *
946: mparse_getkeep(const struct mparse *p)
947: {
948:
949: assert(p->secondary);
1.142 schwarze 950: return p->secondary->sz ? p->secondary->buf : NULL;
1.1 kristaps 951: }
CVSweb