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