Annotation of mandoc/read.c, Revision 1.127
1.127 ! schwarze 1: /* $Id: read.c,v 1.126 2015/02/06 16:06:25 schwarze Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.107 schwarze 4: * Copyright (c) 2010-2015 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: *
11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
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.81 schwarze 22: #if HAVE_MMAP
1.82 schwarze 23: #include <sys/mman.h>
1.80 schwarze 24: #include <sys/stat.h>
1.15 kristaps 25: #endif
1.82 schwarze 26: #include <sys/wait.h>
1.1 kristaps 27:
28: #include <assert.h>
29: #include <ctype.h>
1.40 schwarze 30: #include <errno.h>
1.1 kristaps 31: #include <fcntl.h>
1.3 kristaps 32: #include <stdarg.h>
1.28 joerg 33: #include <stdint.h>
1.1 kristaps 34: #include <stdio.h>
35: #include <stdlib.h>
36: #include <string.h>
37: #include <unistd.h>
38:
39: #include "mandoc.h"
1.46 schwarze 40: #include "mandoc_aux.h"
1.3 kristaps 41: #include "libmandoc.h"
1.1 kristaps 42: #include "mdoc.h"
43: #include "man.h"
44:
45: #define REPARSE_LIMIT 1000
46:
47: struct mparse {
48: struct man *pman; /* persistent man parser */
49: struct mdoc *pmdoc; /* persistent mdoc parser */
50: struct man *man; /* man parser */
51: struct mdoc *mdoc; /* mdoc parser */
52: struct roff *roff; /* roff parser (!NULL) */
1.94 schwarze 53: const struct mchars *mchars; /* character table */
1.45 schwarze 54: char *sodest; /* filename pointed to by .so */
1.83 schwarze 55: const char *file; /* filename of current input file */
56: struct buf *primary; /* buffer currently being parsed */
57: struct buf *secondary; /* preprocessed copy of input */
58: const char *defos; /* default operating system */
59: mandocmsg mmsg; /* warning/error message handler */
60: enum mandoclevel file_status; /* status of current parse */
61: enum mandoclevel wlevel; /* ignore messages below this */
62: int options; /* parser options */
1.93 schwarze 63: int filenc; /* encoding of the current file */
1.1 kristaps 64: int reparse_count; /* finite interp. stack */
1.83 schwarze 65: int line; /* line number in the file */
1.97 schwarze 66: pid_t child; /* the gunzip(1) process */
1.1 kristaps 67: };
68:
1.84 schwarze 69: static void choose_parser(struct mparse *);
1.1 kristaps 70: static void resize_buf(struct buf *, size_t);
1.95 schwarze 71: static void mparse_buf_r(struct mparse *, struct buf, size_t, int);
1.40 schwarze 72: static int read_whole_file(struct mparse *, const char *, int,
73: struct buf *, int *);
1.1 kristaps 74: static void mparse_end(struct mparse *);
1.37 schwarze 75: static void mparse_parse_buffer(struct mparse *, struct buf,
76: const char *);
1.1 kristaps 77:
1.3 kristaps 78: static const enum mandocerr mandoclimits[MANDOCLEVEL_MAX] = {
79: MANDOCERR_OK,
80: MANDOCERR_WARNING,
81: MANDOCERR_WARNING,
82: MANDOCERR_ERROR,
1.112 schwarze 83: MANDOCERR_UNSUPP,
1.3 kristaps 84: MANDOCERR_MAX,
85: MANDOCERR_MAX
86: };
87:
1.7 kristaps 88: static const char * const mandocerrs[MANDOCERR_MAX] = {
89: "ok",
90:
91: "generic warning",
92:
93: /* related to the prologue */
1.79 schwarze 94: "missing manual title, using UNTITLED",
95: "missing manual title, using \"\"",
1.54 schwarze 96: "lower case character in document title",
1.79 schwarze 97: "missing manual section, using \"\"",
1.7 kristaps 98: "unknown manual section",
1.54 schwarze 99: "missing date, using today's date",
1.7 kristaps 100: "cannot parse date, using it verbatim",
1.79 schwarze 101: "missing Os macro, using \"\"",
102: "duplicate prologue macro",
103: "late prologue macro",
104: "skipping late title macro",
1.7 kristaps 105: "prologue macros out of order",
106:
107: /* related to document structure */
108: ".so is fragile, better use ln(1)",
1.50 schwarze 109: "no document body",
1.54 schwarze 110: "content before first section header",
111: "first section is not \"NAME\"",
1.7 kristaps 112: "bad NAME section contents",
1.121 schwarze 113: "missing description line, using \"\"",
1.7 kristaps 114: "sections out of conventional order",
1.54 schwarze 115: "duplicate section title",
116: "unexpected section",
1.87 schwarze 117: "unusual Xr order",
118: "unusual Xr punctuation",
1.86 schwarze 119: "AUTHORS section without An macro",
1.7 kristaps 120:
121: /* related to macros and nesting */
1.55 schwarze 122: "obsolete macro",
1.102 schwarze 123: "macro neither callable nor escaped",
1.7 kristaps 124: "skipping paragraph macro",
1.31 schwarze 125: "moving paragraph macro out of list",
1.7 kristaps 126: "skipping no-space macro",
127: "blocks badly nested",
128: "nested displays are not portable",
1.57 schwarze 129: "moving content out of list",
130: ".Vt block has child macro",
1.78 schwarze 131: "fill mode already enabled, skipping",
132: "fill mode already disabled, skipping",
1.7 kristaps 133: "line scope broken",
134:
135: /* related to missing macro arguments */
1.58 schwarze 136: "skipping empty request",
137: "conditional request controls empty scope",
1.7 kristaps 138: "skipping empty macro",
1.124 schwarze 139: "empty block",
1.62 schwarze 140: "empty argument, using 0n",
1.60 schwarze 141: "missing display type, using -ragged",
142: "list type is not the first argument",
143: "missing -width in -tag list, using 8n",
1.78 schwarze 144: "missing utility name, using \"\"",
1.123 schwarze 145: "missing function name, using \"\"",
1.60 schwarze 146: "empty head in list item",
147: "empty list item",
1.61 schwarze 148: "missing font type, using \\fR",
149: "unknown font type, using \\fR",
1.103 schwarze 150: "nothing follows prefix",
1.122 schwarze 151: "empty reference block",
1.60 schwarze 152: "missing -std argument, adding it",
1.125 schwarze 153: "missing option string, using \"\"",
154: "missing resource identifier, using \"\"",
1.90 schwarze 155: "missing eqn box, using \"\"",
1.7 kristaps 156:
157: /* related to bad macro arguments */
1.64 schwarze 158: "unterminated quoted argument",
1.7 kristaps 159: "duplicate argument",
1.76 schwarze 160: "skipping duplicate argument",
1.63 schwarze 161: "skipping duplicate display type",
162: "skipping duplicate list type",
1.76 schwarze 163: "skipping -width argument",
1.126 schwarze 164: "wrong number of cells",
1.7 kristaps 165: "unknown AT&T UNIX version",
1.88 schwarze 166: "comma in function argument",
1.89 schwarze 167: "parenthesis in function name",
1.67 schwarze 168: "invalid content in Rs block",
1.63 schwarze 169: "invalid Boolean argument",
170: "unknown font, skipping request",
1.126 schwarze 171: "odd number of characters in request",
1.7 kristaps 172:
173: /* related to plain text */
1.64 schwarze 174: "blank line in fill mode, using .sp",
175: "tab in filled text",
176: "whitespace at end of input line",
1.7 kristaps 177: "bad comment style",
1.64 schwarze 178: "invalid escape sequence",
179: "undefined string, using \"\"",
1.16 kristaps 180:
1.118 schwarze 181: /* related to tables */
182: "tbl line starts with span",
183: "tbl column starts with span",
184: "skipping vertical bar in tbl layout",
185:
1.7 kristaps 186: "generic error",
187:
188: /* related to tables */
1.116 schwarze 189: "non-alphabetic character in tbl options",
190: "skipping unknown tbl option",
191: "missing tbl option argument",
192: "wrong tbl option argument size",
1.118 schwarze 193: "empty tbl layout",
194: "invalid character in tbl layout",
195: "unmatched parenthesis in tbl layout",
1.119 schwarze 196: "tbl without any data cells",
197: "ignoring data in spanned tbl cell",
198: "ignoring extra tbl data cells",
199: "data block open at end of tbl",
1.7 kristaps 200:
1.68 schwarze 201: /* related to document structure and macros */
1.108 schwarze 202: NULL,
1.7 kristaps 203: "input stack limit exceeded, infinite loop?",
204: "skipping bad character",
1.68 schwarze 205: "skipping unknown macro",
1.112 schwarze 206: "skipping insecure request",
1.73 schwarze 207: "skipping item outside list",
1.68 schwarze 208: "skipping column outside column list",
209: "skipping end of block that is not open",
1.115 schwarze 210: "fewer RS blocks open, skipping",
1.68 schwarze 211: "inserting missing end of block",
212: "appending missing end of block",
213:
214: /* related to request and macro arguments */
1.7 kristaps 215: "escaped character not allowed in a name",
1.99 schwarze 216: "NOT IMPLEMENTED: Bd -file",
1.71 schwarze 217: "missing list type, using -item",
1.70 schwarze 218: "missing manual name, using \"\"",
1.71 schwarze 219: "uname(3) system call failed, using UNKNOWN",
1.63 schwarze 220: "unknown standard specifier",
1.71 schwarze 221: "skipping request without numeric argument",
1.109 schwarze 222: "NOT IMPLEMENTED: .so with absolute path or \"..\"",
1.110 schwarze 223: ".so request failed",
1.61 schwarze 224: "skipping all arguments",
225: "skipping excess arguments",
1.92 kristaps 226: "divide by zero",
1.112 schwarze 227:
228: "unsupported feature",
229: "input too large",
1.114 schwarze 230: "unsupported control character",
1.112 schwarze 231: "unsupported roff request",
1.119 schwarze 232: "eqn delim option in tbl",
1.118 schwarze 233: "unsupported tbl layout modifier",
1.112 schwarze 234: "ignoring macro in table",
1.7 kristaps 235: };
236:
237: static const char * const mandoclevels[MANDOCLEVEL_MAX] = {
238: "SUCCESS",
239: "RESERVED",
240: "WARNING",
241: "ERROR",
1.112 schwarze 242: "UNSUPP",
1.7 kristaps 243: "BADARG",
244: "SYSERR"
245: };
246:
1.47 schwarze 247:
1.1 kristaps 248: static void
249: resize_buf(struct buf *buf, size_t initial)
250: {
251:
252: buf->sz = buf->sz > initial/2 ? 2 * buf->sz : initial;
253: buf->buf = mandoc_realloc(buf->buf, buf->sz);
254: }
255:
256: static void
1.84 schwarze 257: choose_parser(struct mparse *curp)
1.1 kristaps 258: {
1.83 schwarze 259: char *cp, *ep;
260: int format;
1.1 kristaps 261:
1.83 schwarze 262: /*
263: * If neither command line arguments -mdoc or -man select
264: * a parser nor the roff parser found a .Dd or .TH macro
265: * yet, look ahead in the main input buffer.
266: */
267:
268: if ((format = roff_getformat(curp->roff)) == 0) {
269: cp = curp->primary->buf;
270: ep = cp + curp->primary->sz;
271: while (cp < ep) {
1.85 schwarze 272: if (*cp == '.' || *cp == '\'') {
1.83 schwarze 273: cp++;
274: if (cp[0] == 'D' && cp[1] == 'd') {
275: format = MPARSE_MDOC;
276: break;
277: }
278: if (cp[0] == 'T' && cp[1] == 'H') {
279: format = MPARSE_MAN;
280: break;
281: }
282: }
283: cp = memchr(cp, '\n', ep - cp);
284: if (cp == NULL)
285: break;
286: cp++;
287: }
1.1 kristaps 288: }
289:
1.83 schwarze 290: if (format == MPARSE_MDOC) {
1.47 schwarze 291: if (NULL == curp->pmdoc)
1.44 schwarze 292: curp->pmdoc = mdoc_alloc(
293: curp->roff, curp, curp->defos,
294: MPARSE_QUICK & curp->options ? 1 : 0);
1.1 kristaps 295: assert(curp->pmdoc);
296: curp->mdoc = curp->pmdoc;
297: return;
1.47 schwarze 298: }
1.1 kristaps 299:
1.83 schwarze 300: /* Fall back to man(7) as a last resort. */
301:
1.47 schwarze 302: if (NULL == curp->pman)
1.106 schwarze 303: curp->pman = man_alloc(
304: curp->roff, curp, curp->defos,
1.44 schwarze 305: MPARSE_QUICK & curp->options ? 1 : 0);
1.1 kristaps 306: assert(curp->pman);
307: curp->man = curp->pman;
308: }
309:
310: /*
1.95 schwarze 311: * Main parse routine for a buffer.
312: * It assumes encoding and line numbering are already set up.
313: * It can recurse directly (for invocations of user-defined
314: * macros, inline equations, and input line traps)
315: * and indirectly (for .so file inclusion).
1.1 kristaps 316: */
317: static void
1.95 schwarze 318: mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start)
1.1 kristaps 319: {
320: const struct tbl_span *span;
321: struct buf ln;
1.113 schwarze 322: const char *save_file;
1.110 schwarze 323: char *cp;
1.95 schwarze 324: size_t pos; /* byte number in the ln buffer */
1.1 kristaps 325: enum rofferr rr;
1.100 schwarze 326: int of;
1.1 kristaps 327: int lnn; /* line number in the real file */
1.110 schwarze 328: int fd;
329: pid_t save_child;
1.1 kristaps 330: unsigned char c;
331:
1.95 schwarze 332: memset(&ln, 0, sizeof(ln));
1.1 kristaps 333:
1.47 schwarze 334: lnn = curp->line;
335: pos = 0;
1.1 kristaps 336:
1.95 schwarze 337: while (i < blk.sz) {
1.1 kristaps 338: if (0 == pos && '\0' == blk.buf[i])
339: break;
340:
341: if (start) {
342: curp->line = lnn;
343: curp->reparse_count = 0;
1.93 schwarze 344:
345: if (lnn < 3 &&
346: curp->filenc & MPARSE_UTF8 &&
1.95 schwarze 347: curp->filenc & MPARSE_LATIN1)
348: curp->filenc = preconv_cue(&blk, i);
1.1 kristaps 349: }
350:
1.95 schwarze 351: while (i < blk.sz && (start || blk.buf[i] != '\0')) {
1.1 kristaps 352:
353: /*
354: * When finding an unescaped newline character,
355: * leave the character loop to process the line.
356: * Skip a preceding carriage return, if any.
357: */
358:
1.95 schwarze 359: if ('\r' == blk.buf[i] && i + 1 < blk.sz &&
1.1 kristaps 360: '\n' == blk.buf[i + 1])
361: ++i;
362: if ('\n' == blk.buf[i]) {
363: ++i;
364: ++lnn;
365: break;
366: }
367:
1.35 schwarze 368: /*
1.93 schwarze 369: * Make sure we have space for the worst
370: * case of 11 bytes: "\\[u10ffff]\0"
1.35 schwarze 371: */
372:
1.95 schwarze 373: if (pos + 11 > ln.sz)
1.35 schwarze 374: resize_buf(&ln, 256);
375:
1.47 schwarze 376: /*
1.93 schwarze 377: * Encode 8-bit input.
1.1 kristaps 378: */
379:
1.93 schwarze 380: c = blk.buf[i];
381: if (c & 0x80) {
1.95 schwarze 382: if ( ! (curp->filenc && preconv_encode(
383: &blk, &i, &ln, &pos, &curp->filenc))) {
1.114 schwarze 384: mandoc_vmsg(MANDOCERR_CHAR_BAD, curp,
385: curp->line, pos, "0x%x", c);
1.93 schwarze 386: ln.buf[pos++] = '?';
387: i++;
388: }
389: continue;
390: }
391:
392: /*
393: * Exclude control characters.
394: */
1.1 kristaps 395:
1.93 schwarze 396: if (c == 0x7f || (c < 0x20 && c != 0x09)) {
1.114 schwarze 397: mandoc_vmsg(c == 0x00 || c == 0x04 ||
398: c > 0x0a ? MANDOCERR_CHAR_BAD :
399: MANDOCERR_CHAR_UNSUPP,
400: curp, curp->line, pos, "0x%x", c);
1.1 kristaps 401: i++;
1.127 ! schwarze 402: if (c != '\r')
! 403: ln.buf[pos++] = '?';
1.1 kristaps 404: continue;
405: }
406:
407: /* Trailing backslash = a plain char. */
408:
1.95 schwarze 409: if (blk.buf[i] != '\\' || i + 1 == blk.sz) {
1.1 kristaps 410: ln.buf[pos++] = blk.buf[i++];
411: continue;
412: }
413:
414: /*
415: * Found escape and at least one other character.
416: * When it's a newline character, skip it.
417: * When there is a carriage return in between,
418: * skip that one as well.
419: */
420:
1.95 schwarze 421: if ('\r' == blk.buf[i + 1] && i + 2 < blk.sz &&
1.1 kristaps 422: '\n' == blk.buf[i + 2])
423: ++i;
424: if ('\n' == blk.buf[i + 1]) {
425: i += 2;
426: ++lnn;
427: continue;
428: }
429:
1.13 kristaps 430: if ('"' == blk.buf[i + 1] || '#' == blk.buf[i + 1]) {
1.1 kristaps 431: i += 2;
432: /* Comment, skip to end of line */
1.95 schwarze 433: for (; i < blk.sz; ++i) {
1.1 kristaps 434: if ('\n' == blk.buf[i]) {
435: ++i;
436: ++lnn;
437: break;
438: }
439: }
440:
441: /* Backout trailing whitespaces */
442: for (; pos > 0; --pos) {
443: if (ln.buf[pos - 1] != ' ')
444: break;
445: if (pos > 2 && ln.buf[pos - 2] == '\\')
446: break;
447: }
448: break;
449: }
450:
1.35 schwarze 451: /* Catch escaped bogus characters. */
452:
453: c = (unsigned char) blk.buf[i+1];
454:
1.47 schwarze 455: if ( ! (isascii(c) &&
456: (isgraph(c) || isblank(c)))) {
1.114 schwarze 457: mandoc_vmsg(MANDOCERR_CHAR_BAD, curp,
1.78 schwarze 458: curp->line, pos, "0x%x", c);
1.35 schwarze 459: i += 2;
460: ln.buf[pos++] = '?';
461: continue;
462: }
463:
1.1 kristaps 464: /* Some other escape sequence, copy & cont. */
465:
466: ln.buf[pos++] = blk.buf[i++];
467: ln.buf[pos++] = blk.buf[i++];
468: }
469:
1.95 schwarze 470: if (pos >= ln.sz)
1.1 kristaps 471: resize_buf(&ln, 256);
472:
473: ln.buf[pos] = '\0';
474:
475: /*
476: * A significant amount of complexity is contained by
477: * the roff preprocessor. It's line-oriented but can be
478: * expressed on one line, so we need at times to
479: * readjust our starting point and re-run it. The roff
480: * preprocessor can also readjust the buffers with new
481: * data, so we pass them in wholesale.
482: */
483:
484: of = 0;
485:
1.24 kristaps 486: /*
487: * Maintain a lookaside buffer of all parsed lines. We
488: * only do this if mparse_keep() has been invoked (the
489: * buffer may be accessed with mparse_getkeep()).
490: */
491:
492: if (curp->secondary) {
1.47 schwarze 493: curp->secondary->buf = mandoc_realloc(
494: curp->secondary->buf,
495: curp->secondary->sz + pos + 2);
496: memcpy(curp->secondary->buf +
497: curp->secondary->sz,
498: ln.buf, pos);
1.24 kristaps 499: curp->secondary->sz += pos;
500: curp->secondary->buf
501: [curp->secondary->sz] = '\n';
502: curp->secondary->sz++;
503: curp->secondary->buf
504: [curp->secondary->sz] = '\0';
505: }
1.1 kristaps 506: rerun:
1.96 schwarze 507: rr = roff_parseln(curp->roff, curp->line, &ln, &of);
1.1 kristaps 508:
509: switch (rr) {
1.47 schwarze 510: case ROFF_REPARSE:
1.1 kristaps 511: if (REPARSE_LIMIT >= ++curp->reparse_count)
1.95 schwarze 512: mparse_buf_r(curp, ln, of, 0);
1.1 kristaps 513: else
1.3 kristaps 514: mandoc_msg(MANDOCERR_ROFFLOOP, curp,
1.47 schwarze 515: curp->line, pos, NULL);
1.1 kristaps 516: pos = 0;
517: continue;
1.47 schwarze 518: case ROFF_APPEND:
1.95 schwarze 519: pos = strlen(ln.buf);
1.1 kristaps 520: continue;
1.47 schwarze 521: case ROFF_RERUN:
1.1 kristaps 522: goto rerun;
1.47 schwarze 523: case ROFF_IGN:
1.1 kristaps 524: pos = 0;
525: continue;
1.47 schwarze 526: case ROFF_SO:
1.95 schwarze 527: if ( ! (curp->options & MPARSE_SO) &&
528: (i >= blk.sz || blk.buf[i] == '\0')) {
1.45 schwarze 529: curp->sodest = mandoc_strdup(ln.buf + of);
530: free(ln.buf);
531: return;
532: }
1.24 kristaps 533: /*
534: * We remove `so' clauses from our lookaside
535: * buffer because we're going to descend into
536: * the file recursively.
537: */
1.47 schwarze 538: if (curp->secondary)
1.25 kristaps 539: curp->secondary->sz -= pos + 1;
1.113 schwarze 540: save_file = curp->file;
1.110 schwarze 541: save_child = curp->child;
542: if (mparse_open(curp, &fd, ln.buf + of) ==
1.113 schwarze 543: MANDOCLEVEL_OK) {
1.110 schwarze 544: mparse_readfd(curp, fd, ln.buf + of);
1.113 schwarze 545: curp->file = save_file;
546: } else {
547: curp->file = save_file;
1.52 schwarze 548: mandoc_vmsg(MANDOCERR_SO_FAIL,
549: curp, curp->line, pos,
550: ".so %s", ln.buf + of);
1.110 schwarze 551: ln.sz = mandoc_asprintf(&cp,
552: ".sp\nSee the file %s.\n.sp",
553: ln.buf + of);
554: free(ln.buf);
555: ln.buf = cp;
556: of = 0;
557: mparse_buf_r(curp, ln, of, 0);
1.52 schwarze 558: }
1.110 schwarze 559: curp->child = save_child;
1.1 kristaps 560: pos = 0;
561: continue;
562: default:
563: break;
564: }
565:
566: /*
567: * If input parsers have not been allocated, do so now.
1.14 kristaps 568: * We keep these instanced between parsers, but set them
1.1 kristaps 569: * locally per parse routine since we can use different
570: * parsers with each one.
571: */
572:
573: if ( ! (curp->man || curp->mdoc))
1.84 schwarze 574: choose_parser(curp);
1.1 kristaps 575:
1.47 schwarze 576: /*
1.84 schwarze 577: * Lastly, push down into the parsers themselves.
1.1 kristaps 578: * If libroff returns ROFF_TBL, then add it to the
579: * currently open parse. Since we only get here if
580: * there does exist data (see tbl_data.c), we're
581: * guaranteed that something's been allocated.
582: * Do the same for ROFF_EQN.
583: */
584:
1.100 schwarze 585: if (rr == ROFF_TBL) {
586: while ((span = roff_span(curp->roff)) != NULL)
587: if (curp->man == NULL)
588: mdoc_addspan(curp->mdoc, span);
589: else
590: man_addspan(curp->man, span);
591: } else if (rr == ROFF_EQN) {
592: if (curp->man == NULL)
593: mdoc_addeqn(curp->mdoc, roff_eqn(curp->roff));
594: else
595: man_addeqn(curp->man, roff_eqn(curp->roff));
596: } else if ((curp->man == NULL ?
597: mdoc_parseln(curp->mdoc, curp->line, ln.buf, of) :
598: man_parseln(curp->man, curp->line, ln.buf, of)) == 2)
599: break;
1.1 kristaps 600:
601: /* Temporary buffers typically are not full. */
602:
603: if (0 == start && '\0' == blk.buf[i])
604: break;
605:
606: /* Start the next input line. */
607:
608: pos = 0;
609: }
610:
611: free(ln.buf);
612: }
613:
614: static int
1.40 schwarze 615: read_whole_file(struct mparse *curp, const char *file, int fd,
616: struct buf *fb, int *with_mmap)
1.1 kristaps 617: {
618: size_t off;
619: ssize_t ssz;
620:
1.81 schwarze 621: #if HAVE_MMAP
1.15 kristaps 622: struct stat st;
1.1 kristaps 623: if (-1 == fstat(fd, &st)) {
1.107 schwarze 624: perror(file);
625: exit((int)MANDOCLEVEL_SYSERR);
1.1 kristaps 626: }
627:
628: /*
629: * If we're a regular file, try just reading in the whole entry
630: * via mmap(). This is faster than reading it into blocks, and
631: * since each file is only a few bytes to begin with, I'm not
632: * concerned that this is going to tank any machines.
633: */
634:
635: if (S_ISREG(st.st_mode)) {
636: if (st.st_size >= (1U << 31)) {
1.111 schwarze 637: mandoc_msg(MANDOCERR_TOOLARGE, curp, 0, 0, NULL);
1.1 kristaps 638: return(0);
639: }
640: *with_mmap = 1;
641: fb->sz = (size_t)st.st_size;
1.37 schwarze 642: fb->buf = mmap(NULL, fb->sz, PROT_READ, MAP_SHARED, fd, 0);
1.1 kristaps 643: if (fb->buf != MAP_FAILED)
644: return(1);
645: }
1.15 kristaps 646: #endif
1.1 kristaps 647:
648: /*
649: * If this isn't a regular file (like, say, stdin), then we must
650: * go the old way and just read things in bit by bit.
651: */
652:
653: *with_mmap = 0;
654: off = 0;
655: fb->sz = 0;
656: fb->buf = NULL;
657: for (;;) {
658: if (off == fb->sz) {
659: if (fb->sz == (1U << 31)) {
1.111 schwarze 660: mandoc_msg(MANDOCERR_TOOLARGE, curp,
661: 0, 0, NULL);
1.1 kristaps 662: break;
663: }
664: resize_buf(fb, 65536);
665: }
666: ssz = read(fd, fb->buf + (int)off, fb->sz - off);
667: if (ssz == 0) {
668: fb->sz = off;
669: return(1);
670: }
671: if (ssz == -1) {
1.107 schwarze 672: perror(file);
673: exit((int)MANDOCLEVEL_SYSERR);
1.1 kristaps 674: }
675: off += (size_t)ssz;
676: }
677:
678: free(fb->buf);
679: fb->buf = NULL;
680: return(0);
681: }
682:
683: static void
684: mparse_end(struct mparse *curp)
685: {
686:
1.72 schwarze 687: if (curp->mdoc == NULL &&
688: curp->man == NULL &&
689: curp->sodest == NULL) {
690: if (curp->options & MPARSE_MDOC)
691: curp->mdoc = curp->pmdoc;
692: else {
693: if (curp->pman == NULL)
1.106 schwarze 694: curp->pman = man_alloc(
695: curp->roff, curp, curp->defos,
1.72 schwarze 696: curp->options & MPARSE_QUICK ? 1 : 0);
697: curp->man = curp->pman;
698: }
699: }
1.111 schwarze 700: if (curp->mdoc)
701: mdoc_endparse(curp->mdoc);
702: if (curp->man)
703: man_endparse(curp->man);
1.1 kristaps 704: roff_endparse(curp->roff);
705: }
706:
707: static void
1.36 schwarze 708: mparse_parse_buffer(struct mparse *curp, struct buf blk, const char *file)
1.28 joerg 709: {
1.85 schwarze 710: struct buf *svprimary;
1.28 joerg 711: const char *svfile;
1.95 schwarze 712: size_t offset;
1.36 schwarze 713: static int recursion_depth;
714:
715: if (64 < recursion_depth) {
716: mandoc_msg(MANDOCERR_ROFFLOOP, curp, curp->line, 0, NULL);
717: return;
718: }
1.28 joerg 719:
720: /* Line number is per-file. */
721: svfile = curp->file;
722: curp->file = file;
1.85 schwarze 723: svprimary = curp->primary;
1.83 schwarze 724: curp->primary = &blk;
1.28 joerg 725: curp->line = 1;
1.36 schwarze 726: recursion_depth++;
1.28 joerg 727:
1.93 schwarze 728: /* Skip an UTF-8 byte order mark. */
729: if (curp->filenc & MPARSE_UTF8 && blk.sz > 2 &&
730: (unsigned char)blk.buf[0] == 0xef &&
731: (unsigned char)blk.buf[1] == 0xbb &&
732: (unsigned char)blk.buf[2] == 0xbf) {
1.95 schwarze 733: offset = 3;
1.93 schwarze 734: curp->filenc &= ~MPARSE_LATIN1;
1.95 schwarze 735: } else
736: offset = 0;
1.93 schwarze 737:
1.95 schwarze 738: mparse_buf_r(curp, blk, offset, 1);
1.28 joerg 739:
1.111 schwarze 740: if (--recursion_depth == 0)
1.28 joerg 741: mparse_end(curp);
742:
1.85 schwarze 743: curp->primary = svprimary;
1.28 joerg 744: curp->file = svfile;
745: }
746:
747: enum mandoclevel
1.104 schwarze 748: mparse_readmem(struct mparse *curp, void *buf, size_t len,
1.28 joerg 749: const char *file)
750: {
751: struct buf blk;
752:
1.104 schwarze 753: blk.buf = buf;
1.28 joerg 754: blk.sz = len;
755:
1.36 schwarze 756: mparse_parse_buffer(curp, blk, file);
1.28 joerg 757: return(curp->file_status);
758: }
759:
1.98 schwarze 760: /*
761: * Read the whole file into memory and call the parsers.
762: * Called recursively when an .so request is encountered.
763: */
1.36 schwarze 764: enum mandoclevel
765: mparse_readfd(struct mparse *curp, int fd, const char *file)
1.1 kristaps 766: {
1.28 joerg 767: struct buf blk;
768: int with_mmap;
1.93 schwarze 769: int save_filenc;
1.1 kristaps 770:
1.91 schwarze 771: if (read_whole_file(curp, file, fd, &blk, &with_mmap)) {
1.93 schwarze 772: save_filenc = curp->filenc;
773: curp->filenc = curp->options &
774: (MPARSE_UTF8 | MPARSE_LATIN1);
1.91 schwarze 775: mparse_parse_buffer(curp, blk, file);
1.93 schwarze 776: curp->filenc = save_filenc;
1.81 schwarze 777: #if HAVE_MMAP
1.91 schwarze 778: if (with_mmap)
779: munmap(blk.buf, blk.sz);
780: else
1.28 joerg 781: #endif
1.91 schwarze 782: free(blk.buf);
783: }
1.1 kristaps 784:
1.98 schwarze 785: if (fd != STDIN_FILENO && close(fd) == -1)
1.1 kristaps 786: perror(file);
1.91 schwarze 787:
1.98 schwarze 788: mparse_wait(curp);
1.1 kristaps 789: return(curp->file_status);
1.82 schwarze 790: }
791:
792: enum mandoclevel
1.97 schwarze 793: mparse_open(struct mparse *curp, int *fd, const char *file)
1.82 schwarze 794: {
795: int pfd[2];
1.98 schwarze 796: int save_errno;
1.82 schwarze 797: char *cp;
798:
799: curp->file = file;
1.98 schwarze 800:
801: /* Unless zipped, try to just open the file. */
802:
1.82 schwarze 803: if ((cp = strrchr(file, '.')) == NULL ||
804: strcmp(cp + 1, "gz")) {
1.97 schwarze 805: curp->child = 0;
1.98 schwarze 806: if ((*fd = open(file, O_RDONLY)) != -1)
807: return(MANDOCLEVEL_OK);
808:
809: /* Open failed; try to append ".gz". */
810:
811: mandoc_asprintf(&cp, "%s.gz", file);
812: file = cp;
813: } else
814: cp = NULL;
815:
816: /* Before forking, make sure the file can be read. */
817:
818: save_errno = errno;
819: if (access(file, R_OK) == -1) {
820: if (cp != NULL)
821: errno = save_errno;
1.108 schwarze 822: free(cp);
823: *fd = -1;
824: curp->child = 0;
825: mandoc_msg(MANDOCERR_FILE, curp, 0, 0, strerror(errno));
826: return(MANDOCLEVEL_ERROR);
1.82 schwarze 827: }
828:
1.98 schwarze 829: /* Run gunzip(1). */
830:
1.82 schwarze 831: if (pipe(pfd) == -1) {
1.107 schwarze 832: perror("pipe");
833: exit((int)MANDOCLEVEL_SYSERR);
1.82 schwarze 834: }
835:
1.97 schwarze 836: switch (curp->child = fork()) {
1.82 schwarze 837: case -1:
1.107 schwarze 838: perror("fork");
839: exit((int)MANDOCLEVEL_SYSERR);
1.82 schwarze 840: case 0:
841: close(pfd[0]);
842: if (dup2(pfd[1], STDOUT_FILENO) == -1) {
1.107 schwarze 843: perror("dup");
844: exit((int)MANDOCLEVEL_SYSERR);
1.82 schwarze 845: }
846: execlp("gunzip", "gunzip", "-c", file, NULL);
1.107 schwarze 847: perror("exec");
848: exit((int)MANDOCLEVEL_SYSERR);
1.82 schwarze 849: default:
850: close(pfd[1]);
851: *fd = pfd[0];
852: return(MANDOCLEVEL_OK);
853: }
854: }
855:
856: enum mandoclevel
1.97 schwarze 857: mparse_wait(struct mparse *curp)
1.82 schwarze 858: {
859: int status;
860:
1.97 schwarze 861: if (curp->child == 0)
862: return(MANDOCLEVEL_OK);
863:
864: if (waitpid(curp->child, &status, 0) == -1) {
1.107 schwarze 865: perror("wait");
866: exit((int)MANDOCLEVEL_SYSERR);
1.82 schwarze 867: }
868: if (WIFSIGNALED(status)) {
1.108 schwarze 869: mandoc_vmsg(MANDOCERR_FILE, curp, 0, 0,
870: "gunzip died from signal %d", WTERMSIG(status));
871: return(MANDOCLEVEL_ERROR);
1.82 schwarze 872: }
873: if (WEXITSTATUS(status)) {
1.108 schwarze 874: mandoc_vmsg(MANDOCERR_FILE, curp, 0, 0,
875: "gunzip failed with code %d", WEXITSTATUS(status));
876: return(MANDOCLEVEL_ERROR);
1.82 schwarze 877: }
878: return(MANDOCLEVEL_OK);
1.1 kristaps 879: }
880:
881: struct mparse *
1.94 schwarze 882: mparse_alloc(int options, enum mandoclevel wlevel, mandocmsg mmsg,
883: const struct mchars *mchars, const char *defos)
1.1 kristaps 884: {
885: struct mparse *curp;
1.10 kristaps 886:
1.1 kristaps 887: curp = mandoc_calloc(1, sizeof(struct mparse));
888:
1.44 schwarze 889: curp->options = options;
1.3 kristaps 890: curp->wlevel = wlevel;
1.1 kristaps 891: curp->mmsg = mmsg;
1.29 schwarze 892: curp->defos = defos;
1.1 kristaps 893:
1.94 schwarze 894: curp->mchars = mchars;
895: curp->roff = roff_alloc(curp, curp->mchars, options);
1.72 schwarze 896: if (curp->options & MPARSE_MDOC)
897: curp->pmdoc = mdoc_alloc(
898: curp->roff, curp, curp->defos,
899: curp->options & MPARSE_QUICK ? 1 : 0);
900: if (curp->options & MPARSE_MAN)
1.106 schwarze 901: curp->pman = man_alloc(
902: curp->roff, curp, curp->defos,
1.72 schwarze 903: curp->options & MPARSE_QUICK ? 1 : 0);
904:
1.1 kristaps 905: return(curp);
906: }
907:
908: void
909: mparse_reset(struct mparse *curp)
910: {
911:
912: roff_reset(curp->roff);
913:
914: if (curp->mdoc)
915: mdoc_reset(curp->mdoc);
916: if (curp->man)
917: man_reset(curp->man);
1.24 kristaps 918: if (curp->secondary)
919: curp->secondary->sz = 0;
1.1 kristaps 920:
921: curp->file_status = MANDOCLEVEL_OK;
922: curp->mdoc = NULL;
923: curp->man = NULL;
1.45 schwarze 924:
925: free(curp->sodest);
926: curp->sodest = NULL;
1.1 kristaps 927: }
928:
929: void
930: mparse_free(struct mparse *curp)
931: {
932:
933: if (curp->pmdoc)
934: mdoc_free(curp->pmdoc);
935: if (curp->pman)
936: man_free(curp->pman);
937: if (curp->roff)
938: roff_free(curp->roff);
1.24 kristaps 939: if (curp->secondary)
940: free(curp->secondary->buf);
1.1 kristaps 941:
1.24 kristaps 942: free(curp->secondary);
1.45 schwarze 943: free(curp->sodest);
1.1 kristaps 944: free(curp);
945: }
946:
947: void
1.45 schwarze 948: mparse_result(struct mparse *curp,
949: struct mdoc **mdoc, struct man **man, char **sodest)
1.1 kristaps 950: {
951:
1.45 schwarze 952: if (sodest && NULL != (*sodest = curp->sodest)) {
953: *mdoc = NULL;
954: *man = NULL;
955: return;
956: }
1.9 kristaps 957: if (mdoc)
958: *mdoc = curp->mdoc;
959: if (man)
960: *man = curp->man;
1.3 kristaps 961: }
962:
963: void
964: mandoc_vmsg(enum mandocerr t, struct mparse *m,
965: int ln, int pos, const char *fmt, ...)
966: {
967: char buf[256];
968: va_list ap;
969:
970: va_start(ap, fmt);
1.48 schwarze 971: (void)vsnprintf(buf, sizeof(buf), fmt, ap);
1.3 kristaps 972: va_end(ap);
973:
974: mandoc_msg(t, m, ln, pos, buf);
975: }
976:
977: void
1.47 schwarze 978: mandoc_msg(enum mandocerr er, struct mparse *m,
1.3 kristaps 979: int ln, int col, const char *msg)
980: {
981: enum mandoclevel level;
982:
1.112 schwarze 983: level = MANDOCLEVEL_UNSUPP;
1.3 kristaps 984: while (er < mandoclimits[level])
985: level--;
986:
1.108 schwarze 987: if (level < m->wlevel && er != MANDOCERR_FILE)
1.3 kristaps 988: return;
989:
1.8 kristaps 990: if (m->mmsg)
991: (*m->mmsg)(er, level, m->file, ln, col, msg);
1.3 kristaps 992:
993: if (m->file_status < level)
994: m->file_status = level;
1.7 kristaps 995: }
996:
997: const char *
998: mparse_strerror(enum mandocerr er)
999: {
1000:
1001: return(mandocerrs[er]);
1002: }
1003:
1004: const char *
1005: mparse_strlevel(enum mandoclevel lvl)
1006: {
1007: return(mandoclevels[lvl]);
1.24 kristaps 1008: }
1009:
1010: void
1011: mparse_keep(struct mparse *p)
1012: {
1013:
1014: assert(NULL == p->secondary);
1015: p->secondary = mandoc_calloc(1, sizeof(struct buf));
1016: }
1017:
1018: const char *
1019: mparse_getkeep(const struct mparse *p)
1020: {
1021:
1022: assert(p->secondary);
1023: return(p->secondary->sz ? p->secondary->buf : NULL);
1.1 kristaps 1024: }
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