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