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