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