]>
git.cameronkatri.com Git - mandoc.git/blob - read.c
1 /* $Id: read.c,v 1.33 2012/11/19 17:57:23 schwarze 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>
38 #include "libmandoc.h"
47 #define REPARSE_LIMIT 1000
50 char *buf
; /* binary input buffer */
51 size_t sz
; /* size of binary buffer */
55 enum mandoclevel file_status
; /* status of current parse */
56 enum mandoclevel wlevel
; /* ignore messages below this */
57 int line
; /* line number in the file */
58 enum mparset inttype
; /* which parser to use */
59 struct man
*pman
; /* persistent man parser */
60 struct mdoc
*pmdoc
; /* persistent mdoc parser */
61 struct man
*man
; /* man parser */
62 struct mdoc
*mdoc
; /* mdoc parser */
63 struct roff
*roff
; /* roff parser (!NULL) */
64 int reparse_count
; /* finite interp. stack */
65 mandocmsg mmsg
; /* warning/error message handler */
66 void *arg
; /* argument to mmsg */
68 struct buf
*secondary
;
69 char *defos
; /* default operating system */
72 static void resize_buf(struct buf
*, size_t);
73 static void mparse_buf_r(struct mparse
*, struct buf
, int);
74 static void mparse_readfd_r(struct mparse
*, int, const char *, int);
75 static void pset(const char *, int, struct mparse
*);
76 static int read_whole_file(const char *, int, struct buf
*, int *);
77 static void mparse_end(struct mparse
*);
79 static const enum mandocerr mandoclimits
[MANDOCLEVEL_MAX
] = {
89 static const char * const mandocerrs
[MANDOCERR_MAX
] = {
94 /* related to the prologue */
95 "no title in document",
96 "document title should be all caps",
97 "unknown manual section",
98 "unknown manual volume or arch",
99 "date missing, using today's date",
100 "cannot parse date, using it verbatim",
101 "prologue macros out of order",
102 "duplicate prologue macro",
103 "macro not allowed in prologue",
104 "macro not allowed in body",
106 /* related to document structure */
107 ".so is fragile, better use ln(1)",
108 "NAME section must come first",
109 "bad NAME section contents",
110 "sections out of conventional order",
111 "duplicate section name",
112 "section not in conventional manual section",
114 /* related to macros and nesting */
115 "skipping obsolete macro",
116 "skipping paragraph macro",
117 "moving paragraph macro out of list",
118 "skipping no-space macro",
119 "blocks badly nested",
120 "child violates parent syntax",
121 "nested displays are not portable",
122 "already in literal mode",
125 /* related to missing macro arguments */
126 "skipping empty macro",
127 "argument count wrong",
128 "missing display type",
129 "list type must come first",
130 "tag lists require a width argument",
132 "skipping end of block that is not open",
134 /* related to bad macro arguments */
136 "duplicate argument",
137 "duplicate display type",
138 "duplicate list type",
139 "unknown AT&T UNIX version",
142 "unknown standard specifier",
143 "bad width argument",
145 /* related to plain text */
146 "blank line in non-literal context",
147 "tab in non-literal context",
148 "end of line whitespace",
150 "bad escape sequence",
151 "unterminated quoted string",
153 /* related to equations */
154 "unexpected literal in equation",
158 /* related to equations */
159 "unexpected equation scope closure",
160 "equation scope open on exit",
161 "overlapping equation scopes",
162 "unexpected end of equation",
163 "equation syntax error",
165 /* related to tables */
169 "no table layout cells specified",
170 "no table data cells specified",
171 "ignore data in cell",
172 "data block still open",
173 "ignoring extra data cells",
175 "input stack limit exceeded, infinite loop?",
176 "skipping bad character",
177 "escaped character not allowed in a name",
178 "manual name not yet set",
179 "skipping text before the first section header",
180 "skipping unknown macro",
181 "NOT IMPLEMENTED, please use groff: skipping request",
182 "argument count wrong",
183 "skipping end of block that is not open",
184 "missing end of block",
185 "scope open on exit",
186 "uname(3) system call failed",
187 "macro requires line argument(s)",
188 "macro requires body argument(s)",
189 "macro requires argument(s)",
191 "line argument(s) will be lost",
192 "body argument(s) will be lost",
194 "generic fatal error",
197 "column syntax is inconsistent",
198 "NOT IMPLEMENTED: .Bd -file",
199 "argument count wrong, violates syntax",
200 "child violates parent syntax",
201 "argument count wrong, violates syntax",
202 "NOT IMPLEMENTED: .so with absolute path or \"..\"",
204 "no document prologue",
205 "static buffer exhausted",
208 static const char * const mandoclevels
[MANDOCLEVEL_MAX
] = {
219 resize_buf(struct buf
*buf
, size_t initial
)
222 buf
->sz
= buf
->sz
> initial
/2 ? 2 * buf
->sz
: initial
;
223 buf
->buf
= mandoc_realloc(buf
->buf
, buf
->sz
);
227 pset(const char *buf
, int pos
, struct mparse
*curp
)
232 * Try to intuit which kind of manual parser should be used. If
233 * passed in by command-line (-man, -mdoc), then use that
234 * explicitly. If passed as -mandoc, then try to guess from the
235 * line: either skip dot-lines, use -mdoc when finding `.Dt', or
236 * default to -man, which is more lenient.
238 * Separate out pmdoc/pman from mdoc/man: the first persists
239 * through all parsers, while the latter is used per-parse.
242 if ('.' == buf
[0] || '\'' == buf
[0]) {
243 for (i
= 1; buf
[i
]; i
++)
244 if (' ' != buf
[i
] && '\t' != buf
[i
])
250 switch (curp
->inttype
) {
252 if (NULL
== curp
->pmdoc
)
253 curp
->pmdoc
= mdoc_alloc(curp
->roff
, curp
,
256 curp
->mdoc
= curp
->pmdoc
;
259 if (NULL
== curp
->pman
)
260 curp
->pman
= man_alloc(curp
->roff
, curp
);
262 curp
->man
= curp
->pman
;
268 if (pos
>= 3 && 0 == memcmp(buf
, ".Dd", 3)) {
269 if (NULL
== curp
->pmdoc
)
270 curp
->pmdoc
= mdoc_alloc(curp
->roff
, curp
,
273 curp
->mdoc
= curp
->pmdoc
;
277 if (NULL
== curp
->pman
)
278 curp
->pman
= man_alloc(curp
->roff
, curp
);
280 curp
->man
= curp
->pman
;
284 * Main parse routine for an opened file. This is called for each
285 * opened file and simply loops around the full input file, possibly
286 * nesting (i.e., with `so').
289 mparse_buf_r(struct mparse
*curp
, struct buf blk
, int start
)
291 const struct tbl_span
*span
;
295 int pos
; /* byte number in the ln buffer */
296 int lnn
; /* line number in the real file */
299 memset(&ln
, 0, sizeof(struct buf
));
304 for (i
= 0; i
< (int)blk
.sz
; ) {
305 if (0 == pos
&& '\0' == blk
.buf
[i
])
310 curp
->reparse_count
= 0;
313 while (i
< (int)blk
.sz
&& (start
|| '\0' != blk
.buf
[i
])) {
316 * When finding an unescaped newline character,
317 * leave the character loop to process the line.
318 * Skip a preceding carriage return, if any.
321 if ('\r' == blk
.buf
[i
] && i
+ 1 < (int)blk
.sz
&&
322 '\n' == blk
.buf
[i
+ 1])
324 if ('\n' == blk
.buf
[i
]) {
331 * Warn about bogus characters. If you're using
332 * non-ASCII encoding, you're screwing your
333 * readers. Since I'd rather this not happen,
334 * I'll be helpful and replace these characters
335 * with "?", so we don't display gibberish.
336 * Note to manual writers: use special characters.
339 c
= (unsigned char) blk
.buf
[i
];
341 if ( ! (isascii(c
) &&
342 (isgraph(c
) || isblank(c
)))) {
343 mandoc_msg(MANDOCERR_BADCHAR
, curp
,
344 curp
->line
, pos
, NULL
);
346 if (pos
>= (int)ln
.sz
)
347 resize_buf(&ln
, 256);
352 /* Trailing backslash = a plain char. */
354 if ('\\' != blk
.buf
[i
] || i
+ 1 == (int)blk
.sz
) {
355 if (pos
>= (int)ln
.sz
)
356 resize_buf(&ln
, 256);
357 ln
.buf
[pos
++] = blk
.buf
[i
++];
362 * Found escape and at least one other character.
363 * When it's a newline character, skip it.
364 * When there is a carriage return in between,
365 * skip that one as well.
368 if ('\r' == blk
.buf
[i
+ 1] && i
+ 2 < (int)blk
.sz
&&
369 '\n' == blk
.buf
[i
+ 2])
371 if ('\n' == blk
.buf
[i
+ 1]) {
377 if ('"' == blk
.buf
[i
+ 1] || '#' == blk
.buf
[i
+ 1]) {
379 /* Comment, skip to end of line */
380 for (; i
< (int)blk
.sz
; ++i
) {
381 if ('\n' == blk
.buf
[i
]) {
388 /* Backout trailing whitespaces */
389 for (; pos
> 0; --pos
) {
390 if (ln
.buf
[pos
- 1] != ' ')
392 if (pos
> 2 && ln
.buf
[pos
- 2] == '\\')
398 /* Some other escape sequence, copy & cont. */
400 if (pos
+ 1 >= (int)ln
.sz
)
401 resize_buf(&ln
, 256);
403 ln
.buf
[pos
++] = blk
.buf
[i
++];
404 ln
.buf
[pos
++] = blk
.buf
[i
++];
407 if (pos
>= (int)ln
.sz
)
408 resize_buf(&ln
, 256);
413 * A significant amount of complexity is contained by
414 * the roff preprocessor. It's line-oriented but can be
415 * expressed on one line, so we need at times to
416 * readjust our starting point and re-run it. The roff
417 * preprocessor can also readjust the buffers with new
418 * data, so we pass them in wholesale.
424 * Maintain a lookaside buffer of all parsed lines. We
425 * only do this if mparse_keep() has been invoked (the
426 * buffer may be accessed with mparse_getkeep()).
429 if (curp
->secondary
) {
430 curp
->secondary
->buf
=
432 (curp
->secondary
->buf
,
433 curp
->secondary
->sz
+ pos
+ 2);
434 memcpy(curp
->secondary
->buf
+
437 curp
->secondary
->sz
+= pos
;
439 [curp
->secondary
->sz
] = '\n';
440 curp
->secondary
->sz
++;
442 [curp
->secondary
->sz
] = '\0';
446 (curp
->roff
, curp
->line
,
447 &ln
.buf
, &ln
.sz
, of
, &of
);
451 if (REPARSE_LIMIT
>= ++curp
->reparse_count
)
452 mparse_buf_r(curp
, ln
, 0);
454 mandoc_msg(MANDOCERR_ROFFLOOP
, curp
,
455 curp
->line
, pos
, NULL
);
459 pos
= (int)strlen(ln
.buf
);
467 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
471 * We remove `so' clauses from our lookaside
472 * buffer because we're going to descend into
473 * the file recursively.
476 curp
->secondary
->sz
-= pos
+ 1;
477 mparse_readfd_r(curp
, -1, ln
.buf
+ of
, 1);
478 if (MANDOCLEVEL_FATAL
<= curp
->file_status
)
487 * If we encounter errors in the recursive parse, make
488 * sure we don't continue parsing.
491 if (MANDOCLEVEL_FATAL
<= curp
->file_status
)
495 * If input parsers have not been allocated, do so now.
496 * We keep these instanced between parsers, but set them
497 * locally per parse routine since we can use different
498 * parsers with each one.
501 if ( ! (curp
->man
|| curp
->mdoc
))
502 pset(ln
.buf
+ of
, pos
- of
, curp
);
505 * Lastly, push down into the parsers themselves. One
506 * of these will have already been set in the pset()
508 * If libroff returns ROFF_TBL, then add it to the
509 * currently open parse. Since we only get here if
510 * there does exist data (see tbl_data.c), we're
511 * guaranteed that something's been allocated.
512 * Do the same for ROFF_EQN.
518 while (NULL
!= (span
= roff_span(curp
->roff
))) {
520 man_addspan(curp
->man
, span
) :
521 mdoc_addspan(curp
->mdoc
, span
);
525 else if (ROFF_EQN
== rr
)
527 mdoc_addeqn(curp
->mdoc
,
528 roff_eqn(curp
->roff
)) :
529 man_addeqn(curp
->man
,
530 roff_eqn(curp
->roff
));
531 else if (curp
->man
|| curp
->mdoc
)
533 man_parseln(curp
->man
,
534 curp
->line
, ln
.buf
, of
) :
535 mdoc_parseln(curp
->mdoc
,
536 curp
->line
, ln
.buf
, of
);
539 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
543 /* Temporary buffers typically are not full. */
545 if (0 == start
&& '\0' == blk
.buf
[i
])
548 /* Start the next input line. */
557 read_whole_file(const char *file
, int fd
, struct buf
*fb
, int *with_mmap
)
564 if (-1 == fstat(fd
, &st
)) {
570 * If we're a regular file, try just reading in the whole entry
571 * via mmap(). This is faster than reading it into blocks, and
572 * since each file is only a few bytes to begin with, I'm not
573 * concerned that this is going to tank any machines.
576 if (S_ISREG(st
.st_mode
)) {
577 if (st
.st_size
>= (1U << 31)) {
578 fprintf(stderr
, "%s: input too large\n", file
);
582 fb
->sz
= (size_t)st
.st_size
;
583 fb
->buf
= mmap(NULL
, fb
->sz
, PROT_READ
,
584 MAP_FILE
|MAP_SHARED
, fd
, 0);
585 if (fb
->buf
!= MAP_FAILED
)
591 * If this isn't a regular file (like, say, stdin), then we must
592 * go the old way and just read things in bit by bit.
601 if (fb
->sz
== (1U << 31)) {
602 fprintf(stderr
, "%s: input too large\n", file
);
605 resize_buf(fb
, 65536);
607 ssz
= read(fd
, fb
->buf
+ (int)off
, fb
->sz
- off
);
625 mparse_end(struct mparse
*curp
)
628 if (MANDOCLEVEL_FATAL
<= curp
->file_status
)
631 if (curp
->mdoc
&& ! mdoc_endparse(curp
->mdoc
)) {
632 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
636 if (curp
->man
&& ! man_endparse(curp
->man
)) {
637 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
641 if ( ! (curp
->man
|| curp
->mdoc
)) {
642 mandoc_msg(MANDOCERR_NOTMANUAL
, curp
, 1, 0, NULL
);
643 curp
->file_status
= MANDOCLEVEL_FATAL
;
647 roff_endparse(curp
->roff
);
651 mparse_parse_buffer(struct mparse
*curp
, struct buf blk
, const char *file
,
656 /* Line number is per-file. */
661 mparse_buf_r(curp
, blk
, 1);
663 if (0 == re
&& MANDOCLEVEL_FATAL
> curp
->file_status
)
670 mparse_readmem(struct mparse
*curp
, const void *buf
, size_t len
,
675 blk
.buf
= UNCONST(buf
);
678 mparse_parse_buffer(curp
, blk
, file
, 0);
679 return(curp
->file_status
);
683 mparse_readfd_r(struct mparse
*curp
, int fd
, const char *file
, int re
)
689 if (-1 == (fd
= open(file
, O_RDONLY
, 0))) {
691 curp
->file_status
= MANDOCLEVEL_SYSERR
;
695 * Run for each opened file; may be called more than once for
696 * each full parse sequence if the opened file is nested (i.e.,
697 * from `so'). Simply sucks in the whole file and moves into
698 * the parse phase for the file.
701 if ( ! read_whole_file(file
, fd
, &blk
, &with_mmap
)) {
702 curp
->file_status
= MANDOCLEVEL_SYSERR
;
706 mparse_parse_buffer(curp
, blk
, file
, re
);
710 munmap(blk
.buf
, blk
.sz
);
715 if (STDIN_FILENO
!= fd
&& -1 == close(fd
))
720 mparse_readfd(struct mparse
*curp
, int fd
, const char *file
)
723 mparse_readfd_r(curp
, fd
, file
, 0);
724 return(curp
->file_status
);
728 mparse_alloc(enum mparset inttype
, enum mandoclevel wlevel
,
729 mandocmsg mmsg
, void *arg
, char *defos
)
733 assert(wlevel
<= MANDOCLEVEL_FATAL
);
735 curp
= mandoc_calloc(1, sizeof(struct mparse
));
737 curp
->wlevel
= wlevel
;
740 curp
->inttype
= inttype
;
743 curp
->roff
= roff_alloc(inttype
, curp
);
748 mparse_reset(struct mparse
*curp
)
751 roff_reset(curp
->roff
);
754 mdoc_reset(curp
->mdoc
);
756 man_reset(curp
->man
);
758 curp
->secondary
->sz
= 0;
760 curp
->file_status
= MANDOCLEVEL_OK
;
766 mparse_free(struct mparse
*curp
)
770 mdoc_free(curp
->pmdoc
);
772 man_free(curp
->pman
);
774 roff_free(curp
->roff
);
776 free(curp
->secondary
->buf
);
778 free(curp
->secondary
);
783 mparse_result(struct mparse
*curp
, struct mdoc
**mdoc
, struct man
**man
)
793 mandoc_vmsg(enum mandocerr t
, struct mparse
*m
,
794 int ln
, int pos
, const char *fmt
, ...)
800 vsnprintf(buf
, sizeof(buf
) - 1, fmt
, ap
);
803 mandoc_msg(t
, m
, ln
, pos
, buf
);
807 mandoc_msg(enum mandocerr er
, struct mparse
*m
,
808 int ln
, int col
, const char *msg
)
810 enum mandoclevel level
;
812 level
= MANDOCLEVEL_FATAL
;
813 while (er
< mandoclimits
[level
])
816 if (level
< m
->wlevel
)
820 (*m
->mmsg
)(er
, level
, m
->file
, ln
, col
, msg
);
822 if (m
->file_status
< level
)
823 m
->file_status
= level
;
827 mparse_strerror(enum mandocerr er
)
830 return(mandocerrs
[er
]);
834 mparse_strlevel(enum mandoclevel lvl
)
836 return(mandoclevels
[lvl
]);
840 mparse_keep(struct mparse
*p
)
843 assert(NULL
== p
->secondary
);
844 p
->secondary
= mandoc_calloc(1, sizeof(struct buf
));
848 mparse_getkeep(const struct mparse
*p
)
851 assert(p
->secondary
);
852 return(p
->secondary
->sz
? p
->secondary
->buf
: NULL
);