version 1.112, 2010/12/01 16:28:23 |
version 1.147, 2011/03/07 01:35:51 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org> |
* |
* |
* Permission to use, copy, modify, and distribute this software for any |
* Permission to use, copy, modify, and distribute this software for any |
* purpose with or without fee is hereby granted, provided that the above |
* purpose with or without fee is hereby granted, provided that the above |
|
|
#define MAP_FILE 0 |
#define MAP_FILE 0 |
#endif |
#endif |
|
|
|
#define REPARSE_LIMIT 1000 |
#define UNCONST(a) ((void *)(uintptr_t)(const void *)(a)) |
#define UNCONST(a) ((void *)(uintptr_t)(const void *)(a)) |
|
|
/* FIXME: Intel's compiler? LLVM? pcc? */ |
/* FIXME: Intel's compiler? LLVM? pcc? */ |
Line 89 struct curparse { |
|
Line 90 struct curparse { |
|
struct mdoc *mdoc; /* mdoc parser */ |
struct mdoc *mdoc; /* mdoc parser */ |
struct roff *roff; /* roff parser (!NULL) */ |
struct roff *roff; /* roff parser (!NULL) */ |
struct regset regs; /* roff registers */ |
struct regset regs; /* roff registers */ |
|
int reparse_count; /* finite interpolation stack */ |
enum outt outtype; /* which output to use */ |
enum outt outtype; /* which output to use */ |
out_mdoc outmdoc; /* mdoc output ptr */ |
out_mdoc outmdoc; /* mdoc output ptr */ |
out_man outman; /* man output ptr */ |
out_man outman; /* man output ptr */ |
Line 122 static const char * const mandocerrs[MANDOCERR_MAX] = |
|
Line 124 static const char * const mandocerrs[MANDOCERR_MAX] = |
|
|
|
"generic warning", |
"generic warning", |
|
|
"text should be uppercase", |
/* related to the prologue */ |
"sections out of conventional order", |
"no title in document", |
"section name repeats", |
"document title should be all caps", |
"out of order prologue", |
|
"repeated prologue entry", |
|
"list type must come first", |
|
"tab in non-literal context", |
|
"bad escape sequence", |
|
"unterminated quoted string", |
|
"argument requires the width argument", |
|
"superfluous width argument", |
|
"bad date argument", |
|
"bad width argument", |
|
"unknown manual section", |
"unknown manual section", |
|
"date missing, using today's date", |
|
"cannot parse date, using it verbatim", |
|
"prologue macros out of order", |
|
"duplicate prologue macro", |
|
"macro not allowed in prologue", |
|
"macro not allowed in body", |
|
|
|
/* related to document structure */ |
|
".so is fragile, better use ln(1)", |
|
"NAME section must come first", |
|
"bad NAME section contents", |
|
"manual name not yet set", |
|
"sections out of conventional order", |
|
"duplicate section name", |
"section not in conventional manual section", |
"section not in conventional manual section", |
"end of line whitespace", |
|
|
/* related to macros and nesting */ |
|
"skipping obsolete macro", |
|
"skipping paragraph macro", |
|
"skipping no-space macro", |
"blocks badly nested", |
"blocks badly nested", |
|
"child violates parent syntax", |
|
"nested displays are not portable", |
|
"already in literal mode", |
|
|
"generic error", |
/* related to missing macro arguments */ |
|
"skipping empty macro", |
|
"argument count wrong", |
|
"missing display type", |
|
"list type must come first", |
|
"tag lists require a width argument", |
|
"missing font type", |
|
"skipping end of block that is not open", |
|
|
"NAME section must come first", |
/* related to bad macro arguments */ |
|
"skipping argument", |
|
"duplicate argument", |
|
"duplicate display type", |
|
"duplicate list type", |
|
"unknown AT&T UNIX version", |
"bad Boolean value", |
"bad Boolean value", |
"child violates parent syntax", |
"unknown font", |
"bad AT&T symbol", |
"unknown standard specifier", |
"bad standard", |
"bad width argument", |
"list type repeated", |
|
"display type repeated", |
/* related to plain text */ |
"argument repeated", |
"blank line in non-literal context", |
"ignoring argument", |
"tab in non-literal context", |
"manual name not yet set", |
"end of line whitespace", |
"obsolete macro ignored", |
|
"empty macro ignored", |
|
"macro not allowed in body", |
|
"macro not allowed in prologue", |
|
"bad character", |
|
"bad NAME section contents", |
|
"no blank lines", |
|
"no text in this context", |
|
"bad comment style", |
"bad comment style", |
"unknown macro will be lost", |
"unknown escape sequence", |
"NOT IMPLEMENTED: skipping request", |
"unterminated quoted string", |
|
|
|
"generic error", |
|
|
|
/* related to tables */ |
|
"bad table syntax", |
|
"bad table option", |
|
"bad table layout", |
|
"no table layout cells specified", |
|
"no table data cells specified", |
|
"ignore data in cell", |
|
"data block still open", |
|
"ignoring extra data cells", |
|
|
|
"input stack limit exceeded, infinite loop?", |
|
"skipping bad character", |
|
"escaped character not allowed in a name", |
|
"skipping text before the first section header", |
|
"skipping unknown macro", |
|
"NOT IMPLEMENTED, please use groff: skipping request", |
"line scope broken", |
"line scope broken", |
"argument count wrong", |
"argument count wrong", |
"request scope close w/none open", |
"skipping end of block that is not open", |
"scope already open", |
"missing end of block", |
"scope open on exit", |
"scope open on exit", |
|
"uname(3) system call failed", |
"macro requires line argument(s)", |
"macro requires line argument(s)", |
"macro requires body argument(s)", |
"macro requires body argument(s)", |
"macro requires argument(s)", |
"macro requires argument(s)", |
"no title in document", |
|
"missing list type", |
"missing list type", |
"missing display type", |
|
"missing font type", |
|
"line argument(s) will be lost", |
"line argument(s) will be lost", |
"body argument(s) will be lost", |
"body argument(s) will be lost", |
"paragraph macro ignored", |
|
|
|
"generic fatal error", |
"generic fatal error", |
|
|
"column syntax is inconsistent", |
"column syntax is inconsistent", |
"displays may not be nested", |
"NOT IMPLEMENTED: .Bd -file", |
"unsupported display type", |
|
"blocks badly nested", |
|
"no such block is open", |
|
"line scope broken, syntax violated", |
"line scope broken, syntax violated", |
"argument count wrong, violates syntax", |
"argument count wrong, violates syntax", |
"child violates parent syntax", |
"child violates parent syntax", |
"argument count wrong, violates syntax", |
"argument count wrong, violates syntax", |
|
"NOT IMPLEMENTED: .so with absolute path or \"..\"", |
"no document body", |
"no document body", |
"no document prologue", |
"no document prologue", |
"utsname system call failed", |
|
"static buffer exhausted", |
"static buffer exhausted", |
}; |
}; |
|
|
Line 211 static void version(void) __attribute__((noreturn)) |
|
Line 241 static void version(void) __attribute__((noreturn)) |
|
static int woptions(struct curparse *, char *); |
static int woptions(struct curparse *, char *); |
|
|
static const char *progname; |
static const char *progname; |
|
static enum mandoclevel file_status = MANDOCLEVEL_OK; |
static enum mandoclevel exit_status = MANDOCLEVEL_OK; |
static enum mandoclevel exit_status = MANDOCLEVEL_OK; |
|
|
int |
int |
Line 347 pfile(const char *file, struct curparse *curp) |
|
Line 378 pfile(const char *file, struct curparse *curp) |
|
|
|
if (-1 == (fd = open(file, O_RDONLY, 0))) { |
if (-1 == (fd = open(file, O_RDONLY, 0))) { |
perror(file); |
perror(file); |
exit_status = MANDOCLEVEL_SYSERR; |
file_status = MANDOCLEVEL_SYSERR; |
return(0); |
return(0); |
} |
} |
|
|
Line 365 pfile(const char *file, struct curparse *curp) |
|
Line 396 pfile(const char *file, struct curparse *curp) |
|
if (-1 == close(fd)) |
if (-1 == close(fd)) |
perror(file); |
perror(file); |
|
|
return(MANDOCLEVEL_FATAL > exit_status ? 1 : 0); |
return(MANDOCLEVEL_FATAL > file_status ? 1 : 0); |
} |
} |
|
|
|
|
|
|
resize_buf(struct buf *buf, size_t initial) |
resize_buf(struct buf *buf, size_t initial) |
{ |
{ |
|
|
buf->sz = buf->sz ? 2 * buf->sz : initial; |
buf->sz = buf->sz > initial/2 ? 2 * buf->sz : initial; |
buf->buf = realloc(buf->buf, buf->sz); |
buf->buf = realloc(buf->buf, buf->sz); |
if (NULL == buf->buf) { |
if (NULL == buf->buf) { |
perror(NULL); |
perror(NULL); |
Line 469 fdesc(struct curparse *curp) |
|
Line 500 fdesc(struct curparse *curp) |
|
|
|
curp->mdoc = NULL; |
curp->mdoc = NULL; |
curp->man = NULL; |
curp->man = NULL; |
|
file_status = MANDOCLEVEL_OK; |
|
|
/* Make sure the mandotory roff parser is initialised. */ |
/* Make sure the mandotory roff parser is initialised. */ |
|
|
Line 481 fdesc(struct curparse *curp) |
|
Line 513 fdesc(struct curparse *curp) |
|
|
|
pdesc(curp); |
pdesc(curp); |
|
|
if (MANDOCLEVEL_FATAL <= exit_status) |
if (MANDOCLEVEL_FATAL <= file_status) |
goto cleanup; |
goto cleanup; |
|
|
/* NOTE a parser may not have been assigned, yet. */ |
/* NOTE a parser may not have been assigned, yet. */ |
|
|
if ( ! (curp->man || curp->mdoc)) { |
if ( ! (curp->man || curp->mdoc)) { |
fprintf(stderr, "%s: Not a manual\n", curp->file); |
fprintf(stderr, "%s: Not a manual\n", curp->file); |
exit_status = MANDOCLEVEL_FATAL; |
file_status = MANDOCLEVEL_FATAL; |
goto cleanup; |
goto cleanup; |
} |
} |
|
|
/* Clean up the parse routine ASTs. */ |
/* Clean up the parse routine ASTs. */ |
|
|
if (curp->mdoc && ! mdoc_endparse(curp->mdoc)) { |
if (curp->mdoc && ! mdoc_endparse(curp->mdoc)) { |
assert(MANDOCLEVEL_FATAL <= exit_status); |
assert(MANDOCLEVEL_FATAL <= file_status); |
goto cleanup; |
goto cleanup; |
} |
} |
|
|
if (curp->man && ! man_endparse(curp->man)) { |
if (curp->man && ! man_endparse(curp->man)) { |
assert(MANDOCLEVEL_FATAL <= exit_status); |
assert(MANDOCLEVEL_FATAL <= file_status); |
goto cleanup; |
goto cleanup; |
} |
} |
|
|
assert(curp->roff); |
assert(curp->roff); |
if ( ! roff_endparse(curp->roff)) { |
roff_endparse(curp->roff); |
assert(MANDOCLEVEL_FATAL <= exit_status); |
|
goto cleanup; |
|
} |
|
|
|
/* |
/* |
* With -Wstop and warnings or errors of at least |
* With -Wstop and warnings or errors of at least |
* the requested level, do not produce output. |
* the requested level, do not produce output. |
*/ |
*/ |
|
|
if (MANDOCLEVEL_OK != exit_status && curp->wstop) |
if (MANDOCLEVEL_OK != file_status && curp->wstop) |
goto cleanup; |
goto cleanup; |
|
|
/* If unset, allocate output dev now (if applicable). */ |
/* If unset, allocate output dev now (if applicable). */ |
Line 590 fdesc(struct curparse *curp) |
|
Line 619 fdesc(struct curparse *curp) |
|
assert(curp->roff); |
assert(curp->roff); |
roff_reset(curp->roff); |
roff_reset(curp->roff); |
|
|
|
if (exit_status < file_status) |
|
exit_status = file_status; |
|
|
return; |
return; |
} |
} |
|
|
Line 607 pdesc(struct curparse *curp) |
|
Line 639 pdesc(struct curparse *curp) |
|
*/ |
*/ |
|
|
if ( ! read_whole_file(curp, &blk, &with_mmap)) { |
if ( ! read_whole_file(curp, &blk, &with_mmap)) { |
exit_status = MANDOCLEVEL_SYSERR; |
file_status = MANDOCLEVEL_SYSERR; |
return; |
return; |
} |
} |
|
|
Line 626 pdesc(struct curparse *curp) |
|
Line 658 pdesc(struct curparse *curp) |
|
static void |
static void |
parsebuf(struct curparse *curp, struct buf blk, int start) |
parsebuf(struct curparse *curp, struct buf blk, int start) |
{ |
{ |
|
const struct tbl_span *span; |
struct buf ln; |
struct buf ln; |
|
enum rofferr rr; |
int i, of, rc; |
int i, of, rc; |
int pos; /* byte number in the ln buffer */ |
int pos; /* byte number in the ln buffer */ |
int lnn; /* line number in the real file */ |
int lnn; /* line number in the real file */ |
Line 647 parsebuf(struct curparse *curp, struct buf blk, int st |
|
Line 681 parsebuf(struct curparse *curp, struct buf blk, int st |
|
if (0 == pos && '\0' == blk.buf[i]) |
if (0 == pos && '\0' == blk.buf[i]) |
break; |
break; |
|
|
if (start) |
if (start) { |
curp->line = lnn; |
curp->line = lnn; |
|
curp->reparse_count = 0; |
|
} |
|
|
while (i < (int)blk.sz && (start || '\0' != blk.buf[i])) { |
while (i < (int)blk.sz && (start || '\0' != blk.buf[i])) { |
|
|
|
/* |
|
* When finding an unescaped newline character, |
|
* leave the character loop to process the line. |
|
* Skip a preceding carriage return, if any. |
|
*/ |
|
|
|
if ('\r' == blk.buf[i] && i + 1 < (int)blk.sz && |
|
'\n' == blk.buf[i + 1]) |
|
++i; |
if ('\n' == blk.buf[i]) { |
if ('\n' == blk.buf[i]) { |
++i; |
++i; |
++lnn; |
++lnn; |
Line 685 parsebuf(struct curparse *curp, struct buf blk, int st |
|
Line 731 parsebuf(struct curparse *curp, struct buf blk, int st |
|
continue; |
continue; |
} |
} |
|
|
/* Found escape & at least one other char. */ |
/* |
|
* Found escape and at least one other character. |
|
* When it's a newline character, skip it. |
|
* When there is a carriage return in between, |
|
* skip that one as well. |
|
*/ |
|
|
|
if ('\r' == blk.buf[i + 1] && i + 2 < (int)blk.sz && |
|
'\n' == blk.buf[i + 2]) |
|
++i; |
if ('\n' == blk.buf[i + 1]) { |
if ('\n' == blk.buf[i + 1]) { |
i += 2; |
i += 2; |
/* Escaped newlines are skipped over */ |
|
++lnn; |
++lnn; |
continue; |
continue; |
} |
} |
Line 741 parsebuf(struct curparse *curp, struct buf blk, int st |
|
Line 794 parsebuf(struct curparse *curp, struct buf blk, int st |
|
of = 0; |
of = 0; |
|
|
rerun: |
rerun: |
rc = roff_parseln |
rr = roff_parseln |
(curp->roff, curp->line, |
(curp->roff, curp->line, |
&ln.buf, &ln.sz, of, &of); |
&ln.buf, &ln.sz, of, &of); |
|
|
switch (rc) { |
switch (rr) { |
case (ROFF_REPARSE): |
case (ROFF_REPARSE): |
parsebuf(curp, ln, 0); |
if (REPARSE_LIMIT >= ++curp->reparse_count) |
|
parsebuf(curp, ln, 0); |
|
else |
|
mmsg(MANDOCERR_ROFFLOOP, curp, |
|
curp->line, pos, NULL); |
pos = 0; |
pos = 0; |
continue; |
continue; |
case (ROFF_APPEND): |
case (ROFF_APPEND): |
|
|
pos = 0; |
pos = 0; |
continue; |
continue; |
case (ROFF_ERR): |
case (ROFF_ERR): |
assert(MANDOCLEVEL_FATAL <= exit_status); |
assert(MANDOCLEVEL_FATAL <= file_status); |
break; |
break; |
case (ROFF_SO): |
case (ROFF_SO): |
if (pfile(ln.buf + of, curp)) { |
if (pfile(ln.buf + of, curp)) { |
|
|
continue; |
continue; |
} else |
} else |
break; |
break; |
case (ROFF_CONT): |
default: |
break; |
break; |
} |
} |
|
|
/* |
/* |
|
* If we encounter errors in the recursive parsebuf() |
|
* call, make sure we don't continue parsing. |
|
*/ |
|
|
|
if (MANDOCLEVEL_FATAL <= file_status) |
|
break; |
|
|
|
/* |
* If input parsers have not been allocated, do so now. |
* If input parsers have not been allocated, do so now. |
* We keep these instanced betwen parsers, but set them |
* We keep these instanced betwen parsers, but set them |
* locally per parse routine since we can use different |
* locally per parse routine since we can use different |
|
|
* Lastly, push down into the parsers themselves. One |
* Lastly, push down into the parsers themselves. One |
* of these will have already been set in the pset() |
* of these will have already been set in the pset() |
* routine. |
* routine. |
|
* If libroff returns ROFF_TBL, then add it to the |
|
* currently open parse. Since we only get here if |
|
* there does exist data (see tbl_data.c), we're |
|
* guaranteed that something's been allocated. |
|
* Do the same for ROFF_EQN. |
*/ |
*/ |
|
|
if (curp->man || curp->mdoc) { |
rc = -1; |
|
|
|
if (ROFF_TBL == rr) |
|
while (NULL != (span = roff_span(curp->roff))) { |
|
rc = curp->man ? |
|
man_addspan(curp->man, span) : |
|
mdoc_addspan(curp->mdoc, span); |
|
if (0 == rc) |
|
break; |
|
} |
|
else if (ROFF_EQN == rr) |
|
rc = curp->mdoc ? |
|
mdoc_addeqn(curp->mdoc, |
|
roff_eqn(curp->roff)) : |
|
man_addeqn(curp->man, |
|
roff_eqn(curp->roff)); |
|
else if (curp->man || curp->mdoc) |
rc = curp->man ? |
rc = curp->man ? |
man_parseln(curp->man, |
man_parseln(curp->man, |
curp->line, ln.buf, of) : |
curp->line, ln.buf, of) : |
mdoc_parseln(curp->mdoc, |
mdoc_parseln(curp->mdoc, |
curp->line, ln.buf, of); |
curp->line, ln.buf, of); |
|
|
if ( ! rc) { |
if (0 == rc) { |
assert(MANDOCLEVEL_FATAL <= exit_status); |
assert(MANDOCLEVEL_FATAL <= file_status); |
break; |
break; |
} |
|
} |
} |
|
|
/* Temporary buffers typically are not full. */ |
/* Temporary buffers typically are not full. */ |
Line 977 mmsg(enum mandocerr t, void *arg, int ln, int col, con |
|
Line 1062 mmsg(enum mandocerr t, void *arg, int ln, int col, con |
|
fprintf(stderr, ": %s", msg); |
fprintf(stderr, ": %s", msg); |
fputc('\n', stderr); |
fputc('\n', stderr); |
|
|
if (exit_status < level) |
if (file_status < level) |
exit_status = level; |
file_status = level; |
|
|
return(level < MANDOCLEVEL_FATAL); |
return(level < MANDOCLEVEL_FATAL); |
} |
} |