]>
git.cameronkatri.com Git - mandoc.git/blob - read.c
1 /* $Id: read.c,v 1.16 2011/07/17 12:52:54 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",
150 /* related to equations */
151 "unexpected literal in equation",
155 /* related to tables */
159 "no table layout cells specified",
160 "no table data cells specified",
161 "ignore data in cell",
162 "data block still open",
163 "ignoring extra data cells",
165 "input stack limit exceeded, infinite loop?",
166 "skipping bad character",
167 "escaped character not allowed in a name",
168 "skipping text before the first section header",
169 "skipping unknown macro",
170 "NOT IMPLEMENTED, please use groff: skipping request",
171 "argument count wrong",
172 "skipping end of block that is not open",
173 "missing end of block",
174 "scope open on exit",
175 "uname(3) system call failed",
176 "macro requires line argument(s)",
177 "macro requires body argument(s)",
178 "macro requires argument(s)",
180 "line argument(s) will be lost",
181 "body argument(s) will be lost",
183 "generic fatal error",
186 "column syntax is inconsistent",
187 "NOT IMPLEMENTED: .Bd -file",
188 "line scope broken, syntax violated",
189 "argument count wrong, violates syntax",
190 "child violates parent syntax",
191 "argument count wrong, violates syntax",
192 "NOT IMPLEMENTED: .so with absolute path or \"..\"",
194 "no document prologue",
195 "static buffer exhausted",
198 static const char * const mandoclevels
[MANDOCLEVEL_MAX
] = {
209 resize_buf(struct buf
*buf
, size_t initial
)
212 buf
->sz
= buf
->sz
> initial
/2 ? 2 * buf
->sz
: initial
;
213 buf
->buf
= mandoc_realloc(buf
->buf
, buf
->sz
);
217 pset(const char *buf
, int pos
, struct mparse
*curp
)
222 * Try to intuit which kind of manual parser should be used. If
223 * passed in by command-line (-man, -mdoc), then use that
224 * explicitly. If passed as -mandoc, then try to guess from the
225 * line: either skip dot-lines, use -mdoc when finding `.Dt', or
226 * default to -man, which is more lenient.
228 * Separate out pmdoc/pman from mdoc/man: the first persists
229 * through all parsers, while the latter is used per-parse.
232 if ('.' == buf
[0] || '\'' == buf
[0]) {
233 for (i
= 1; buf
[i
]; i
++)
234 if (' ' != buf
[i
] && '\t' != buf
[i
])
240 switch (curp
->inttype
) {
242 if (NULL
== curp
->pmdoc
)
243 curp
->pmdoc
= mdoc_alloc(&curp
->regs
, curp
);
245 curp
->mdoc
= curp
->pmdoc
;
248 if (NULL
== curp
->pman
)
249 curp
->pman
= man_alloc(&curp
->regs
, curp
);
251 curp
->man
= curp
->pman
;
257 if (pos
>= 3 && 0 == memcmp(buf
, ".Dd", 3)) {
258 if (NULL
== curp
->pmdoc
)
259 curp
->pmdoc
= mdoc_alloc(&curp
->regs
, curp
);
261 curp
->mdoc
= curp
->pmdoc
;
265 if (NULL
== curp
->pman
)
266 curp
->pman
= man_alloc(&curp
->regs
, curp
);
268 curp
->man
= curp
->pman
;
272 * Main parse routine for an opened file. This is called for each
273 * opened file and simply loops around the full input file, possibly
274 * nesting (i.e., with `so').
277 mparse_buf_r(struct mparse
*curp
, struct buf blk
, int start
)
279 const struct tbl_span
*span
;
283 int pos
; /* byte number in the ln buffer */
284 int lnn
; /* line number in the real file */
287 memset(&ln
, 0, sizeof(struct buf
));
292 for (i
= 0; i
< (int)blk
.sz
; ) {
293 if (0 == pos
&& '\0' == blk
.buf
[i
])
298 curp
->reparse_count
= 0;
301 while (i
< (int)blk
.sz
&& (start
|| '\0' != blk
.buf
[i
])) {
304 * When finding an unescaped newline character,
305 * leave the character loop to process the line.
306 * Skip a preceding carriage return, if any.
309 if ('\r' == blk
.buf
[i
] && i
+ 1 < (int)blk
.sz
&&
310 '\n' == blk
.buf
[i
+ 1])
312 if ('\n' == blk
.buf
[i
]) {
319 * Warn about bogus characters. If you're using
320 * non-ASCII encoding, you're screwing your
321 * readers. Since I'd rather this not happen,
322 * I'll be helpful and drop these characters so
323 * we don't display gibberish. Note to manual
324 * writers: use special characters.
327 c
= (unsigned char) blk
.buf
[i
];
329 if ( ! (isascii(c
) &&
330 (isgraph(c
) || isblank(c
)))) {
331 mandoc_msg(MANDOCERR_BADCHAR
, curp
,
332 curp
->line
, pos
, "ignoring byte");
337 /* Trailing backslash = a plain char. */
339 if ('\\' != blk
.buf
[i
] || i
+ 1 == (int)blk
.sz
) {
340 if (pos
>= (int)ln
.sz
)
341 resize_buf(&ln
, 256);
342 ln
.buf
[pos
++] = blk
.buf
[i
++];
347 * Found escape and at least one other character.
348 * When it's a newline character, skip it.
349 * When there is a carriage return in between,
350 * skip that one as well.
353 if ('\r' == blk
.buf
[i
+ 1] && i
+ 2 < (int)blk
.sz
&&
354 '\n' == blk
.buf
[i
+ 2])
356 if ('\n' == blk
.buf
[i
+ 1]) {
362 if ('"' == blk
.buf
[i
+ 1] || '#' == blk
.buf
[i
+ 1]) {
364 /* Comment, skip to end of line */
365 for (; i
< (int)blk
.sz
; ++i
) {
366 if ('\n' == blk
.buf
[i
]) {
373 /* Backout trailing whitespaces */
374 for (; pos
> 0; --pos
) {
375 if (ln
.buf
[pos
- 1] != ' ')
377 if (pos
> 2 && ln
.buf
[pos
- 2] == '\\')
383 /* Some other escape sequence, copy & cont. */
385 if (pos
+ 1 >= (int)ln
.sz
)
386 resize_buf(&ln
, 256);
388 ln
.buf
[pos
++] = blk
.buf
[i
++];
389 ln
.buf
[pos
++] = blk
.buf
[i
++];
392 if (pos
>= (int)ln
.sz
)
393 resize_buf(&ln
, 256);
398 * A significant amount of complexity is contained by
399 * the roff preprocessor. It's line-oriented but can be
400 * expressed on one line, so we need at times to
401 * readjust our starting point and re-run it. The roff
402 * preprocessor can also readjust the buffers with new
403 * data, so we pass them in wholesale.
410 (curp
->roff
, curp
->line
,
411 &ln
.buf
, &ln
.sz
, of
, &of
);
415 if (REPARSE_LIMIT
>= ++curp
->reparse_count
)
416 mparse_buf_r(curp
, ln
, 0);
418 mandoc_msg(MANDOCERR_ROFFLOOP
, curp
,
419 curp
->line
, pos
, NULL
);
423 pos
= (int)strlen(ln
.buf
);
431 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
434 mparse_readfd_r(curp
, -1, ln
.buf
+ of
, 1);
435 if (MANDOCLEVEL_FATAL
<= curp
->file_status
)
444 * If we encounter errors in the recursive parse, make
445 * sure we don't continue parsing.
448 if (MANDOCLEVEL_FATAL
<= curp
->file_status
)
452 * If input parsers have not been allocated, do so now.
453 * We keep these instanced between parsers, but set them
454 * locally per parse routine since we can use different
455 * parsers with each one.
458 if ( ! (curp
->man
|| curp
->mdoc
))
459 pset(ln
.buf
+ of
, pos
- of
, curp
);
462 * Lastly, push down into the parsers themselves. One
463 * of these will have already been set in the pset()
465 * If libroff returns ROFF_TBL, then add it to the
466 * currently open parse. Since we only get here if
467 * there does exist data (see tbl_data.c), we're
468 * guaranteed that something's been allocated.
469 * Do the same for ROFF_EQN.
475 while (NULL
!= (span
= roff_span(curp
->roff
))) {
477 man_addspan(curp
->man
, span
) :
478 mdoc_addspan(curp
->mdoc
, span
);
482 else if (ROFF_EQN
== rr
)
484 mdoc_addeqn(curp
->mdoc
,
485 roff_eqn(curp
->roff
)) :
486 man_addeqn(curp
->man
,
487 roff_eqn(curp
->roff
));
488 else if (curp
->man
|| curp
->mdoc
)
490 man_parseln(curp
->man
,
491 curp
->line
, ln
.buf
, of
) :
492 mdoc_parseln(curp
->mdoc
,
493 curp
->line
, ln
.buf
, of
);
496 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
500 /* Temporary buffers typically are not full. */
502 if (0 == start
&& '\0' == blk
.buf
[i
])
505 /* Start the next input line. */
514 pdesc(struct mparse
*curp
, const char *file
, int fd
)
520 * Run for each opened file; may be called more than once for
521 * each full parse sequence if the opened file is nested (i.e.,
522 * from `so'). Simply sucks in the whole file and moves into
523 * the parse phase for the file.
526 if ( ! read_whole_file(file
, fd
, &blk
, &with_mmap
)) {
527 curp
->file_status
= MANDOCLEVEL_SYSERR
;
531 /* Line number is per-file. */
535 mparse_buf_r(curp
, blk
, 1);
539 munmap(blk
.buf
, blk
.sz
);
546 read_whole_file(const char *file
, int fd
, struct buf
*fb
, int *with_mmap
)
553 if (-1 == fstat(fd
, &st
)) {
559 * If we're a regular file, try just reading in the whole entry
560 * via mmap(). This is faster than reading it into blocks, and
561 * since each file is only a few bytes to begin with, I'm not
562 * concerned that this is going to tank any machines.
565 if (S_ISREG(st
.st_mode
)) {
566 if (st
.st_size
>= (1U << 31)) {
567 fprintf(stderr
, "%s: input too large\n", file
);
571 fb
->sz
= (size_t)st
.st_size
;
572 fb
->buf
= mmap(NULL
, fb
->sz
, PROT_READ
,
573 MAP_FILE
|MAP_SHARED
, fd
, 0);
574 if (fb
->buf
!= MAP_FAILED
)
580 * If this isn't a regular file (like, say, stdin), then we must
581 * go the old way and just read things in bit by bit.
590 if (fb
->sz
== (1U << 31)) {
591 fprintf(stderr
, "%s: input too large\n", file
);
594 resize_buf(fb
, 65536);
596 ssz
= read(fd
, fb
->buf
+ (int)off
, fb
->sz
- off
);
614 mparse_end(struct mparse
*curp
)
617 if (MANDOCLEVEL_FATAL
<= curp
->file_status
)
620 if (curp
->mdoc
&& ! mdoc_endparse(curp
->mdoc
)) {
621 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
625 if (curp
->man
&& ! man_endparse(curp
->man
)) {
626 assert(MANDOCLEVEL_FATAL
<= curp
->file_status
);
630 if ( ! (curp
->man
|| curp
->mdoc
)) {
631 mandoc_msg(MANDOCERR_NOTMANUAL
, curp
, 1, 0, NULL
);
632 curp
->file_status
= MANDOCLEVEL_FATAL
;
636 roff_endparse(curp
->roff
);
640 mparse_readfd_r(struct mparse
*curp
, int fd
, const char *file
, int re
)
645 if (-1 == (fd
= open(file
, O_RDONLY
, 0))) {
647 curp
->file_status
= MANDOCLEVEL_SYSERR
;
654 pdesc(curp
, file
, fd
);
656 if (0 == re
&& MANDOCLEVEL_FATAL
> curp
->file_status
)
659 if (STDIN_FILENO
!= fd
&& -1 == close(fd
))
666 mparse_readfd(struct mparse
*curp
, int fd
, const char *file
)
669 mparse_readfd_r(curp
, fd
, file
, 0);
670 return(curp
->file_status
);
674 mparse_alloc(enum mparset inttype
, enum mandoclevel wlevel
, mandocmsg mmsg
, void *arg
)
678 assert(wlevel
<= MANDOCLEVEL_FATAL
);
680 curp
= mandoc_calloc(1, sizeof(struct mparse
));
682 curp
->wlevel
= wlevel
;
685 curp
->inttype
= inttype
;
687 curp
->roff
= roff_alloc(&curp
->regs
, curp
);
692 mparse_reset(struct mparse
*curp
)
695 memset(&curp
->regs
, 0, sizeof(struct regset
));
697 roff_reset(curp
->roff
);
700 mdoc_reset(curp
->mdoc
);
702 man_reset(curp
->man
);
704 curp
->file_status
= MANDOCLEVEL_OK
;
710 mparse_free(struct mparse
*curp
)
714 mdoc_free(curp
->pmdoc
);
716 man_free(curp
->pman
);
718 roff_free(curp
->roff
);
724 mparse_result(struct mparse
*curp
, struct mdoc
**mdoc
, struct man
**man
)
734 mandoc_vmsg(enum mandocerr t
, struct mparse
*m
,
735 int ln
, int pos
, const char *fmt
, ...)
741 vsnprintf(buf
, sizeof(buf
) - 1, fmt
, ap
);
744 mandoc_msg(t
, m
, ln
, pos
, buf
);
748 mandoc_msg(enum mandocerr er
, struct mparse
*m
,
749 int ln
, int col
, const char *msg
)
751 enum mandoclevel level
;
753 level
= MANDOCLEVEL_FATAL
;
754 while (er
< mandoclimits
[level
])
757 if (level
< m
->wlevel
)
761 (*m
->mmsg
)(er
, level
, m
->file
, ln
, col
, msg
);
763 if (m
->file_status
< level
)
764 m
->file_status
= level
;
768 mparse_strerror(enum mandocerr er
)
771 return(mandocerrs
[er
]);
775 mparse_strlevel(enum mandoclevel lvl
)
777 return(mandoclevels
[lvl
]);