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