]>
git.cameronkatri.com Git - mandoc.git/blob - read.c
1 /* $Id: read.c,v 1.34 2012/11/19 22:30:58 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010, 2011, 2012 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 column outside column list",
184 "skipping end of block that is not open",
185 "missing end of block",
186 "scope open on exit",
187 "uname(3) system call failed",
188 "macro requires line argument(s)",
189 "macro requires body argument(s)",
190 "macro requires argument(s)",
192 "line argument(s) will be lost",
193 "body argument(s) will be lost",
195 "generic fatal error",
198 "column syntax is inconsistent",
199 "NOT IMPLEMENTED: .Bd -file",
200 "argument count wrong, violates syntax",
201 "child violates parent syntax",
202 "argument count wrong, violates syntax",
203 "NOT IMPLEMENTED: .so with absolute path or \"..\"",
205 "no document prologue",
206 "static buffer exhausted",
209 static const char * const mandoclevels
[MANDOCLEVEL_MAX
] = {
220 resize_buf(struct buf
*buf
, size_t initial
)
223 buf
->sz
= buf
->sz
> initial
/2 ? 2 * buf
->sz
: initial
;
224 buf
->buf
= mandoc_realloc(buf
->buf
, buf
->sz
);
228 pset(const char *buf
, int pos
, struct mparse
*curp
)
233 * Try to intuit which kind of manual parser should be used. If
234 * passed in by command-line (-man, -mdoc), then use that
235 * explicitly. If passed as -mandoc, then try to guess from the
236 * line: either skip dot-lines, use -mdoc when finding `.Dt', or
237 * default to -man, which is more lenient.
239 * Separate out pmdoc/pman from mdoc/man: the first persists
240 * through all parsers, while the latter is used per-parse.
243 if ('.' == buf
[0] || '\'' == buf
[0]) {
244 for (i
= 1; buf
[i
]; i
++)
245 if (' ' != buf
[i
] && '\t' != buf
[i
])
251 switch (curp
->inttype
) {
253 if (NULL
== curp
->pmdoc
)
254 curp
->pmdoc
= mdoc_alloc(curp
->roff
, curp
,
257 curp
->mdoc
= curp
->pmdoc
;
260 if (NULL
== curp
->pman
)
261 curp
->pman
= man_alloc(curp
->roff
, curp
);
263 curp
->man
= curp
->pman
;
269 if (pos
>= 3 && 0 == memcmp(buf
, ".Dd", 3)) {
270 if (NULL
== curp
->pmdoc
)
271 curp
->pmdoc
= mdoc_alloc(curp
->roff
, curp
,
274 curp
->mdoc
= curp
->pmdoc
;
278 if (NULL
== curp
->pman
)
279 curp
->pman
= man_alloc(curp
->roff
, curp
);
281 curp
->man
= curp
->pman
;
285 * Main parse routine for an opened file. This is called for each
286 * opened file and simply loops around the full input file, possibly
287 * nesting (i.e., with `so').
290 mparse_buf_r(struct mparse
*curp
, struct buf blk
, int start
)
292 const struct tbl_span
*span
;
296 int pos
; /* byte number in the ln buffer */
297 int lnn
; /* line number in the real file */
300 memset(&ln
, 0, sizeof(struct buf
));
305 for (i
= 0; i
< (int)blk
.sz
; ) {
306 if (0 == pos
&& '\0' == blk
.buf
[i
])
311 curp
->reparse_count
= 0;
314 while (i
< (int)blk
.sz
&& (start
|| '\0' != blk
.buf
[i
])) {
317 * When finding an unescaped newline character,
318 * leave the character loop to process the line.
319 * Skip a preceding carriage return, if any.
322 if ('\r' == blk
.buf
[i
] && i
+ 1 < (int)blk
.sz
&&
323 '\n' == blk
.buf
[i
+ 1])
325 if ('\n' == blk
.buf
[i
]) {
332 * Warn about bogus characters. If you're using
333 * non-ASCII encoding, you're screwing your
334 * readers. Since I'd rather this not happen,
335 * I'll be helpful and replace these characters
336 * with "?", so we don't display gibberish.
337 * Note to manual writers: use special characters.
340 c
= (unsigned char) blk
.buf
[i
];
342 if ( ! (isascii(c
) &&
343 (isgraph(c
) || isblank(c
)))) {
344 mandoc_msg(MANDOCERR_BADCHAR
, curp
,
345 curp
->line
, pos
, NULL
);
347 if (pos
>= (int)ln
.sz
)
348 resize_buf(&ln
, 256);
353 /* Trailing backslash = a plain char. */
355 if ('\\' != blk
.buf
[i
] || i
+ 1 == (int)blk
.sz
) {
356 if (pos
>= (int)ln
.sz
)
357 resize_buf(&ln
, 256);
358 ln
.buf
[pos
++] = blk
.buf
[i
++];
363 * Found escape and at least one other character.
364 * When it's a newline character, skip it.
365 * When there is a carriage return in between,
366 * skip that one as well.
369 if ('\r' == blk
.buf
[i
+ 1] && i
+ 2 < (int)blk
.sz
&&
370 '\n' == blk
.buf
[i
+ 2])
372 if ('\n' == blk
.buf
[i
+ 1]) {
378 if ('"' == blk
.buf
[i
+ 1] || '#' == blk
.buf
[i
+ 1]) {
380 /* Comment, skip to end of line */
381 for (; i
< (int)blk
.sz
; ++i
) {
382 if ('\n' == blk
.buf
[i
]) {
389 /* Backout trailing whitespaces */
390 for (; pos
> 0; --pos
) {
391 if (ln
.buf
[pos
- 1] != ' ')
393 if (pos
> 2 && ln
.buf
[pos
- 2] == '\\')
399 /* Some other escape sequence, copy & cont. */
401 if (pos
+ 1 >= (int)ln
.sz
)
402 resize_buf(&ln
, 256);
404 ln
.buf
[pos
++] = blk
.buf
[i
++];
405 ln
.buf
[pos
++] = blk
.buf
[i
++];
408 if (pos
>= (int)ln
.sz
)
409 resize_buf(&ln
, 256);
414 * A significant amount of complexity is contained by
415 * the roff preprocessor. It's line-oriented but can be
416 * expressed on one line, so we need at times to
417 * readjust our starting point and re-run it. The roff
418 * preprocessor can also readjust the buffers with new
419 * data, so we pass them in wholesale.
425 * Maintain a lookaside buffer of all parsed lines. We
426 * only do this if mparse_keep() has been invoked (the
427 * buffer may be accessed with mparse_getkeep()).
430 if (curp
->secondary
) {
431 curp
->secondary
->buf
=
433 (curp
->secondary
->buf
,
434 curp
->secondary
->sz
+ pos
+ 2);
435 memcpy(curp
->secondary
->buf
+
438 curp
->secondary
->sz
+= pos
;
440 [curp
->secondary
->sz
] = '\n';
441 curp
->secondary
->sz
++;
443 [curp
->secondary
->sz
] = '\0';
447 (curp
->roff
, curp
->line
,
448 &ln
.buf
, &ln
.sz
, of
, &of
);
452 if (REPARSE_LIMIT
>= ++curp
->reparse_count
)
453 mparse_buf_r(curp
, ln
, 0);
455 mandoc_msg(MANDOCERR_ROFFLOOP
, curp
,
456 curp
->line
, pos
, NULL
);
460 pos
= (int)strlen(ln
.buf
);
468 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
472 * We remove `so' clauses from our lookaside
473 * buffer because we're going to descend into
474 * the file recursively.
477 curp
->secondary
->sz
-= pos
+ 1;
478 mparse_readfd_r(curp
, -1, ln
.buf
+ of
, 1);
479 if (MANDOCLEVEL_FATAL
<= curp
->file_status
)
488 * If we encounter errors in the recursive parse, make
489 * sure we don't continue parsing.
492 if (MANDOCLEVEL_FATAL
<= curp
->file_status
)
496 * If input parsers have not been allocated, do so now.
497 * We keep these instanced between parsers, but set them
498 * locally per parse routine since we can use different
499 * parsers with each one.
502 if ( ! (curp
->man
|| curp
->mdoc
))
503 pset(ln
.buf
+ of
, pos
- of
, curp
);
506 * Lastly, push down into the parsers themselves. One
507 * of these will have already been set in the pset()
509 * If libroff returns ROFF_TBL, then add it to the
510 * currently open parse. Since we only get here if
511 * there does exist data (see tbl_data.c), we're
512 * guaranteed that something's been allocated.
513 * Do the same for ROFF_EQN.
519 while (NULL
!= (span
= roff_span(curp
->roff
))) {
521 man_addspan(curp
->man
, span
) :
522 mdoc_addspan(curp
->mdoc
, span
);
526 else if (ROFF_EQN
== rr
)
528 mdoc_addeqn(curp
->mdoc
,
529 roff_eqn(curp
->roff
)) :
530 man_addeqn(curp
->man
,
531 roff_eqn(curp
->roff
));
532 else if (curp
->man
|| curp
->mdoc
)
534 man_parseln(curp
->man
,
535 curp
->line
, ln
.buf
, of
) :
536 mdoc_parseln(curp
->mdoc
,
537 curp
->line
, ln
.buf
, of
);
540 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
544 /* Temporary buffers typically are not full. */
546 if (0 == start
&& '\0' == blk
.buf
[i
])
549 /* Start the next input line. */
558 read_whole_file(const char *file
, int fd
, struct buf
*fb
, int *with_mmap
)
565 if (-1 == fstat(fd
, &st
)) {
571 * If we're a regular file, try just reading in the whole entry
572 * via mmap(). This is faster than reading it into blocks, and
573 * since each file is only a few bytes to begin with, I'm not
574 * concerned that this is going to tank any machines.
577 if (S_ISREG(st
.st_mode
)) {
578 if (st
.st_size
>= (1U << 31)) {
579 fprintf(stderr
, "%s: input too large\n", file
);
583 fb
->sz
= (size_t)st
.st_size
;
584 fb
->buf
= mmap(NULL
, fb
->sz
, PROT_READ
,
585 MAP_FILE
|MAP_SHARED
, fd
, 0);
586 if (fb
->buf
!= MAP_FAILED
)
592 * If this isn't a regular file (like, say, stdin), then we must
593 * go the old way and just read things in bit by bit.
602 if (fb
->sz
== (1U << 31)) {
603 fprintf(stderr
, "%s: input too large\n", file
);
606 resize_buf(fb
, 65536);
608 ssz
= read(fd
, fb
->buf
+ (int)off
, fb
->sz
- off
);
626 mparse_end(struct mparse
*curp
)
629 if (MANDOCLEVEL_FATAL
<= curp
->file_status
)
632 if (curp
->mdoc
&& ! mdoc_endparse(curp
->mdoc
)) {
633 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
637 if (curp
->man
&& ! man_endparse(curp
->man
)) {
638 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
642 if ( ! (curp
->man
|| curp
->mdoc
)) {
643 mandoc_msg(MANDOCERR_NOTMANUAL
, curp
, 1, 0, NULL
);
644 curp
->file_status
= MANDOCLEVEL_FATAL
;
648 roff_endparse(curp
->roff
);
652 mparse_parse_buffer(struct mparse
*curp
, struct buf blk
, const char *file
,
657 /* Line number is per-file. */
662 mparse_buf_r(curp
, blk
, 1);
664 if (0 == re
&& MANDOCLEVEL_FATAL
> curp
->file_status
)
671 mparse_readmem(struct mparse
*curp
, const void *buf
, size_t len
,
676 blk
.buf
= UNCONST(buf
);
679 mparse_parse_buffer(curp
, blk
, file
, 0);
680 return(curp
->file_status
);
684 mparse_readfd_r(struct mparse
*curp
, int fd
, const char *file
, int re
)
690 if (-1 == (fd
= open(file
, O_RDONLY
, 0))) {
692 curp
->file_status
= MANDOCLEVEL_SYSERR
;
696 * Run for each opened file; may be called more than once for
697 * each full parse sequence if the opened file is nested (i.e.,
698 * from `so'). Simply sucks in the whole file and moves into
699 * the parse phase for the file.
702 if ( ! read_whole_file(file
, fd
, &blk
, &with_mmap
)) {
703 curp
->file_status
= MANDOCLEVEL_SYSERR
;
707 mparse_parse_buffer(curp
, blk
, file
, re
);
711 munmap(blk
.buf
, blk
.sz
);
716 if (STDIN_FILENO
!= fd
&& -1 == close(fd
))
721 mparse_readfd(struct mparse
*curp
, int fd
, const char *file
)
724 mparse_readfd_r(curp
, fd
, file
, 0);
725 return(curp
->file_status
);
729 mparse_alloc(enum mparset inttype
, enum mandoclevel wlevel
,
730 mandocmsg mmsg
, void *arg
, char *defos
)
734 assert(wlevel
<= MANDOCLEVEL_FATAL
);
736 curp
= mandoc_calloc(1, sizeof(struct mparse
));
738 curp
->wlevel
= wlevel
;
741 curp
->inttype
= inttype
;
744 curp
->roff
= roff_alloc(inttype
, curp
);
749 mparse_reset(struct mparse
*curp
)
752 roff_reset(curp
->roff
);
755 mdoc_reset(curp
->mdoc
);
757 man_reset(curp
->man
);
759 curp
->secondary
->sz
= 0;
761 curp
->file_status
= MANDOCLEVEL_OK
;
767 mparse_free(struct mparse
*curp
)
771 mdoc_free(curp
->pmdoc
);
773 man_free(curp
->pman
);
775 roff_free(curp
->roff
);
777 free(curp
->secondary
->buf
);
779 free(curp
->secondary
);
784 mparse_result(struct mparse
*curp
, struct mdoc
**mdoc
, struct man
**man
)
794 mandoc_vmsg(enum mandocerr t
, struct mparse
*m
,
795 int ln
, int pos
, const char *fmt
, ...)
801 vsnprintf(buf
, sizeof(buf
) - 1, fmt
, ap
);
804 mandoc_msg(t
, m
, ln
, pos
, buf
);
808 mandoc_msg(enum mandocerr er
, struct mparse
*m
,
809 int ln
, int col
, const char *msg
)
811 enum mandoclevel level
;
813 level
= MANDOCLEVEL_FATAL
;
814 while (er
< mandoclimits
[level
])
817 if (level
< m
->wlevel
)
821 (*m
->mmsg
)(er
, level
, m
->file
, ln
, col
, msg
);
823 if (m
->file_status
< level
)
824 m
->file_status
= level
;
828 mparse_strerror(enum mandocerr er
)
831 return(mandocerrs
[er
]);
835 mparse_strlevel(enum mandoclevel lvl
)
837 return(mandoclevels
[lvl
]);
841 mparse_keep(struct mparse
*p
)
844 assert(NULL
== p
->secondary
);
845 p
->secondary
= mandoc_calloc(1, sizeof(struct buf
));
849 mparse_getkeep(const struct mparse
*p
)
852 assert(p
->secondary
);
853 return(p
->secondary
->sz
? p
->secondary
->buf
: NULL
);