]>
git.cameronkatri.com Git - mandoc.git/blob - read.c
1 /* $Id: read.c,v 1.15 2011/05/26 20:36:21 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
23 # include <sys/stat.h>
24 # include <sys/mman.h>
37 #include "libmandoc.h"
45 #define REPARSE_LIMIT 1000
48 char *buf
; /* binary input buffer */
49 size_t sz
; /* size of binary buffer */
53 enum mandoclevel file_status
; /* status of current parse */
54 enum mandoclevel wlevel
; /* ignore messages below this */
55 int line
; /* line number in the file */
56 enum mparset inttype
; /* which parser to use */
57 struct man
*pman
; /* persistent man parser */
58 struct mdoc
*pmdoc
; /* persistent mdoc parser */
59 struct man
*man
; /* man parser */
60 struct mdoc
*mdoc
; /* mdoc parser */
61 struct roff
*roff
; /* roff parser (!NULL) */
62 struct regset regs
; /* roff registers */
63 int reparse_count
; /* finite interp. stack */
64 mandocmsg mmsg
; /* warning/error message handler */
65 void *arg
; /* argument to mmsg */
69 static void resize_buf(struct buf
*, size_t);
70 static void mparse_buf_r(struct mparse
*, struct buf
, int);
71 static void mparse_readfd_r(struct mparse
*, int, const char *, int);
72 static void pset(const char *, int, struct mparse
*);
73 static void pdesc(struct mparse
*, const char *, int);
74 static int read_whole_file(const char *, int, struct buf
*, int *);
75 static void mparse_end(struct mparse
*);
77 static const enum mandocerr mandoclimits
[MANDOCLEVEL_MAX
] = {
87 static const char * const mandocerrs
[MANDOCERR_MAX
] = {
92 /* related to the prologue */
93 "no title in document",
94 "document title should be all caps",
95 "unknown manual section",
96 "date missing, using today's date",
97 "cannot parse date, using it verbatim",
98 "prologue macros out of order",
99 "duplicate prologue macro",
100 "macro not allowed in prologue",
101 "macro not allowed in body",
103 /* related to document structure */
104 ".so is fragile, better use ln(1)",
105 "NAME section must come first",
106 "bad NAME section contents",
107 "manual name not yet set",
108 "sections out of conventional order",
109 "duplicate section name",
110 "section not in conventional manual section",
112 /* related to macros and nesting */
113 "skipping obsolete macro",
114 "skipping paragraph macro",
115 "skipping no-space macro",
116 "blocks badly nested",
117 "child violates parent syntax",
118 "nested displays are not portable",
119 "already in literal mode",
122 /* related to missing macro arguments */
123 "skipping empty macro",
124 "argument count wrong",
125 "missing display type",
126 "list type must come first",
127 "tag lists require a width argument",
129 "skipping end of block that is not open",
131 /* related to bad macro arguments */
133 "duplicate argument",
134 "duplicate display type",
135 "duplicate list type",
136 "unknown AT&T UNIX version",
139 "unknown standard specifier",
140 "bad width argument",
142 /* related to plain text */
143 "blank line in non-literal context",
144 "tab in non-literal context",
145 "end of line whitespace",
147 "bad escape sequence",
148 "unterminated quoted string",
152 /* related to tables */
156 "no table layout cells specified",
157 "no table data cells specified",
158 "ignore data in cell",
159 "data block still open",
160 "ignoring extra data cells",
162 "input stack limit exceeded, infinite loop?",
163 "skipping bad character",
164 "escaped character not allowed in a name",
165 "skipping text before the first section header",
166 "skipping unknown macro",
167 "NOT IMPLEMENTED, please use groff: skipping request",
168 "argument count wrong",
169 "skipping end of block that is not open",
170 "missing end of block",
171 "scope open on exit",
172 "uname(3) system call failed",
173 "macro requires line argument(s)",
174 "macro requires body argument(s)",
175 "macro requires argument(s)",
177 "line argument(s) will be lost",
178 "body argument(s) will be lost",
180 "generic fatal error",
183 "column syntax is inconsistent",
184 "NOT IMPLEMENTED: .Bd -file",
185 "line scope broken, syntax violated",
186 "argument count wrong, violates syntax",
187 "child violates parent syntax",
188 "argument count wrong, violates syntax",
189 "NOT IMPLEMENTED: .so with absolute path or \"..\"",
191 "no document prologue",
192 "static buffer exhausted",
195 static const char * const mandoclevels
[MANDOCLEVEL_MAX
] = {
206 resize_buf(struct buf
*buf
, size_t initial
)
209 buf
->sz
= buf
->sz
> initial
/2 ? 2 * buf
->sz
: initial
;
210 buf
->buf
= mandoc_realloc(buf
->buf
, buf
->sz
);
214 pset(const char *buf
, int pos
, struct mparse
*curp
)
219 * Try to intuit which kind of manual parser should be used. If
220 * passed in by command-line (-man, -mdoc), then use that
221 * explicitly. If passed as -mandoc, then try to guess from the
222 * line: either skip dot-lines, use -mdoc when finding `.Dt', or
223 * default to -man, which is more lenient.
225 * Separate out pmdoc/pman from mdoc/man: the first persists
226 * through all parsers, while the latter is used per-parse.
229 if ('.' == buf
[0] || '\'' == buf
[0]) {
230 for (i
= 1; buf
[i
]; i
++)
231 if (' ' != buf
[i
] && '\t' != buf
[i
])
237 switch (curp
->inttype
) {
239 if (NULL
== curp
->pmdoc
)
240 curp
->pmdoc
= mdoc_alloc(&curp
->regs
, curp
);
242 curp
->mdoc
= curp
->pmdoc
;
245 if (NULL
== curp
->pman
)
246 curp
->pman
= man_alloc(&curp
->regs
, curp
);
248 curp
->man
= curp
->pman
;
254 if (pos
>= 3 && 0 == memcmp(buf
, ".Dd", 3)) {
255 if (NULL
== curp
->pmdoc
)
256 curp
->pmdoc
= mdoc_alloc(&curp
->regs
, curp
);
258 curp
->mdoc
= curp
->pmdoc
;
262 if (NULL
== curp
->pman
)
263 curp
->pman
= man_alloc(&curp
->regs
, curp
);
265 curp
->man
= curp
->pman
;
269 * Main parse routine for an opened file. This is called for each
270 * opened file and simply loops around the full input file, possibly
271 * nesting (i.e., with `so').
274 mparse_buf_r(struct mparse
*curp
, struct buf blk
, int start
)
276 const struct tbl_span
*span
;
280 int pos
; /* byte number in the ln buffer */
281 int lnn
; /* line number in the real file */
284 memset(&ln
, 0, sizeof(struct buf
));
289 for (i
= 0; i
< (int)blk
.sz
; ) {
290 if (0 == pos
&& '\0' == blk
.buf
[i
])
295 curp
->reparse_count
= 0;
298 while (i
< (int)blk
.sz
&& (start
|| '\0' != blk
.buf
[i
])) {
301 * When finding an unescaped newline character,
302 * leave the character loop to process the line.
303 * Skip a preceding carriage return, if any.
306 if ('\r' == blk
.buf
[i
] && i
+ 1 < (int)blk
.sz
&&
307 '\n' == blk
.buf
[i
+ 1])
309 if ('\n' == blk
.buf
[i
]) {
316 * Warn about bogus characters. If you're using
317 * non-ASCII encoding, you're screwing your
318 * readers. Since I'd rather this not happen,
319 * I'll be helpful and drop these characters so
320 * we don't display gibberish. Note to manual
321 * writers: use special characters.
324 c
= (unsigned char) blk
.buf
[i
];
326 if ( ! (isascii(c
) &&
327 (isgraph(c
) || isblank(c
)))) {
328 mandoc_msg(MANDOCERR_BADCHAR
, curp
,
329 curp
->line
, pos
, "ignoring byte");
334 /* Trailing backslash = a plain char. */
336 if ('\\' != blk
.buf
[i
] || i
+ 1 == (int)blk
.sz
) {
337 if (pos
>= (int)ln
.sz
)
338 resize_buf(&ln
, 256);
339 ln
.buf
[pos
++] = blk
.buf
[i
++];
344 * Found escape and at least one other character.
345 * When it's a newline character, skip it.
346 * When there is a carriage return in between,
347 * skip that one as well.
350 if ('\r' == blk
.buf
[i
+ 1] && i
+ 2 < (int)blk
.sz
&&
351 '\n' == blk
.buf
[i
+ 2])
353 if ('\n' == blk
.buf
[i
+ 1]) {
359 if ('"' == blk
.buf
[i
+ 1] || '#' == blk
.buf
[i
+ 1]) {
361 /* Comment, skip to end of line */
362 for (; i
< (int)blk
.sz
; ++i
) {
363 if ('\n' == blk
.buf
[i
]) {
370 /* Backout trailing whitespaces */
371 for (; pos
> 0; --pos
) {
372 if (ln
.buf
[pos
- 1] != ' ')
374 if (pos
> 2 && ln
.buf
[pos
- 2] == '\\')
380 /* Some other escape sequence, copy & cont. */
382 if (pos
+ 1 >= (int)ln
.sz
)
383 resize_buf(&ln
, 256);
385 ln
.buf
[pos
++] = blk
.buf
[i
++];
386 ln
.buf
[pos
++] = blk
.buf
[i
++];
389 if (pos
>= (int)ln
.sz
)
390 resize_buf(&ln
, 256);
395 * A significant amount of complexity is contained by
396 * the roff preprocessor. It's line-oriented but can be
397 * expressed on one line, so we need at times to
398 * readjust our starting point and re-run it. The roff
399 * preprocessor can also readjust the buffers with new
400 * data, so we pass them in wholesale.
407 (curp
->roff
, curp
->line
,
408 &ln
.buf
, &ln
.sz
, of
, &of
);
412 if (REPARSE_LIMIT
>= ++curp
->reparse_count
)
413 mparse_buf_r(curp
, ln
, 0);
415 mandoc_msg(MANDOCERR_ROFFLOOP
, curp
,
416 curp
->line
, pos
, NULL
);
420 pos
= (int)strlen(ln
.buf
);
428 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
431 mparse_readfd_r(curp
, -1, ln
.buf
+ of
, 1);
432 if (MANDOCLEVEL_FATAL
<= curp
->file_status
)
441 * If we encounter errors in the recursive parse, make
442 * sure we don't continue parsing.
445 if (MANDOCLEVEL_FATAL
<= curp
->file_status
)
449 * If input parsers have not been allocated, do so now.
450 * We keep these instanced between parsers, but set them
451 * locally per parse routine since we can use different
452 * parsers with each one.
455 if ( ! (curp
->man
|| curp
->mdoc
))
456 pset(ln
.buf
+ of
, pos
- of
, curp
);
459 * Lastly, push down into the parsers themselves. One
460 * of these will have already been set in the pset()
462 * If libroff returns ROFF_TBL, then add it to the
463 * currently open parse. Since we only get here if
464 * there does exist data (see tbl_data.c), we're
465 * guaranteed that something's been allocated.
466 * Do the same for ROFF_EQN.
472 while (NULL
!= (span
= roff_span(curp
->roff
))) {
474 man_addspan(curp
->man
, span
) :
475 mdoc_addspan(curp
->mdoc
, span
);
479 else if (ROFF_EQN
== rr
)
481 mdoc_addeqn(curp
->mdoc
,
482 roff_eqn(curp
->roff
)) :
483 man_addeqn(curp
->man
,
484 roff_eqn(curp
->roff
));
485 else if (curp
->man
|| curp
->mdoc
)
487 man_parseln(curp
->man
,
488 curp
->line
, ln
.buf
, of
) :
489 mdoc_parseln(curp
->mdoc
,
490 curp
->line
, ln
.buf
, of
);
493 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
497 /* Temporary buffers typically are not full. */
499 if (0 == start
&& '\0' == blk
.buf
[i
])
502 /* Start the next input line. */
511 pdesc(struct mparse
*curp
, const char *file
, int fd
)
517 * Run for each opened file; may be called more than once for
518 * each full parse sequence if the opened file is nested (i.e.,
519 * from `so'). Simply sucks in the whole file and moves into
520 * the parse phase for the file.
523 if ( ! read_whole_file(file
, fd
, &blk
, &with_mmap
)) {
524 curp
->file_status
= MANDOCLEVEL_SYSERR
;
528 /* Line number is per-file. */
532 mparse_buf_r(curp
, blk
, 1);
536 munmap(blk
.buf
, blk
.sz
);
543 read_whole_file(const char *file
, int fd
, struct buf
*fb
, int *with_mmap
)
550 if (-1 == fstat(fd
, &st
)) {
556 * If we're a regular file, try just reading in the whole entry
557 * via mmap(). This is faster than reading it into blocks, and
558 * since each file is only a few bytes to begin with, I'm not
559 * concerned that this is going to tank any machines.
562 if (S_ISREG(st
.st_mode
)) {
563 if (st
.st_size
>= (1U << 31)) {
564 fprintf(stderr
, "%s: input too large\n", file
);
568 fb
->sz
= (size_t)st
.st_size
;
569 fb
->buf
= mmap(NULL
, fb
->sz
, PROT_READ
,
570 MAP_FILE
|MAP_SHARED
, fd
, 0);
571 if (fb
->buf
!= MAP_FAILED
)
577 * If this isn't a regular file (like, say, stdin), then we must
578 * go the old way and just read things in bit by bit.
587 if (fb
->sz
== (1U << 31)) {
588 fprintf(stderr
, "%s: input too large\n", file
);
591 resize_buf(fb
, 65536);
593 ssz
= read(fd
, fb
->buf
+ (int)off
, fb
->sz
- off
);
611 mparse_end(struct mparse
*curp
)
614 if (MANDOCLEVEL_FATAL
<= curp
->file_status
)
617 if (curp
->mdoc
&& ! mdoc_endparse(curp
->mdoc
)) {
618 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
622 if (curp
->man
&& ! man_endparse(curp
->man
)) {
623 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
627 if ( ! (curp
->man
|| curp
->mdoc
)) {
628 mandoc_msg(MANDOCERR_NOTMANUAL
, curp
, 1, 0, NULL
);
629 curp
->file_status
= MANDOCLEVEL_FATAL
;
633 roff_endparse(curp
->roff
);
637 mparse_readfd_r(struct mparse
*curp
, int fd
, const char *file
, int re
)
642 if (-1 == (fd
= open(file
, O_RDONLY
, 0))) {
644 curp
->file_status
= MANDOCLEVEL_SYSERR
;
651 pdesc(curp
, file
, fd
);
653 if (0 == re
&& MANDOCLEVEL_FATAL
> curp
->file_status
)
656 if (STDIN_FILENO
!= fd
&& -1 == close(fd
))
663 mparse_readfd(struct mparse
*curp
, int fd
, const char *file
)
666 mparse_readfd_r(curp
, fd
, file
, 0);
667 return(curp
->file_status
);
671 mparse_alloc(enum mparset inttype
, enum mandoclevel wlevel
, mandocmsg mmsg
, void *arg
)
675 assert(wlevel
<= MANDOCLEVEL_FATAL
);
677 curp
= mandoc_calloc(1, sizeof(struct mparse
));
679 curp
->wlevel
= wlevel
;
682 curp
->inttype
= inttype
;
684 curp
->roff
= roff_alloc(&curp
->regs
, curp
);
689 mparse_reset(struct mparse
*curp
)
692 memset(&curp
->regs
, 0, sizeof(struct regset
));
694 roff_reset(curp
->roff
);
697 mdoc_reset(curp
->mdoc
);
699 man_reset(curp
->man
);
701 curp
->file_status
= MANDOCLEVEL_OK
;
707 mparse_free(struct mparse
*curp
)
711 mdoc_free(curp
->pmdoc
);
713 man_free(curp
->pman
);
715 roff_free(curp
->roff
);
721 mparse_result(struct mparse
*curp
, struct mdoc
**mdoc
, struct man
**man
)
731 mandoc_vmsg(enum mandocerr t
, struct mparse
*m
,
732 int ln
, int pos
, const char *fmt
, ...)
738 vsnprintf(buf
, sizeof(buf
) - 1, fmt
, ap
);
741 mandoc_msg(t
, m
, ln
, pos
, buf
);
745 mandoc_msg(enum mandocerr er
, struct mparse
*m
,
746 int ln
, int col
, const char *msg
)
748 enum mandoclevel level
;
750 level
= MANDOCLEVEL_FATAL
;
751 while (er
< mandoclimits
[level
])
754 if (level
< m
->wlevel
)
758 (*m
->mmsg
)(er
, level
, m
->file
, ln
, col
, msg
);
760 if (m
->file_status
< level
)
761 m
->file_status
= level
;
765 mparse_strerror(enum mandocerr er
)
768 return(mandocerrs
[er
]);
772 mparse_strlevel(enum mandoclevel lvl
)
774 return(mandoclevels
[lvl
]);