version 1.85, 2014/09/07 02:17:40 |
version 1.125, 2015/02/06 11:54:36 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2010-2015 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2010, 2012 Joerg Sonnenberger <joerg@netbsd.org> |
* Copyright (c) 2010, 2012 Joerg Sonnenberger <joerg@netbsd.org> |
* |
* |
* Permission to use, copy, modify, and distribute this software for any |
* Permission to use, copy, modify, and distribute this software for any |
|
|
#include "libmandoc.h" |
#include "libmandoc.h" |
#include "mdoc.h" |
#include "mdoc.h" |
#include "man.h" |
#include "man.h" |
#include "main.h" |
|
|
|
#define REPARSE_LIMIT 1000 |
#define REPARSE_LIMIT 1000 |
|
|
struct buf { |
|
char *buf; /* binary input buffer */ |
|
size_t sz; /* size of binary buffer */ |
|
}; |
|
|
|
struct mparse { |
struct mparse { |
struct man *pman; /* persistent man parser */ |
struct man *pman; /* persistent man parser */ |
struct mdoc *pmdoc; /* persistent mdoc parser */ |
struct mdoc *pmdoc; /* persistent mdoc parser */ |
struct man *man; /* man parser */ |
struct man *man; /* man parser */ |
struct mdoc *mdoc; /* mdoc parser */ |
struct mdoc *mdoc; /* mdoc parser */ |
struct roff *roff; /* roff parser (!NULL) */ |
struct roff *roff; /* roff parser (!NULL) */ |
|
const struct mchars *mchars; /* character table */ |
char *sodest; /* filename pointed to by .so */ |
char *sodest; /* filename pointed to by .so */ |
const char *file; /* filename of current input file */ |
const char *file; /* filename of current input file */ |
struct buf *primary; /* buffer currently being parsed */ |
struct buf *primary; /* buffer currently being parsed */ |
|
|
enum mandoclevel file_status; /* status of current parse */ |
enum mandoclevel file_status; /* status of current parse */ |
enum mandoclevel wlevel; /* ignore messages below this */ |
enum mandoclevel wlevel; /* ignore messages below this */ |
int options; /* parser options */ |
int options; /* parser options */ |
|
int filenc; /* encoding of the current file */ |
int reparse_count; /* finite interp. stack */ |
int reparse_count; /* finite interp. stack */ |
int line; /* line number in the file */ |
int line; /* line number in the file */ |
|
pid_t child; /* the gunzip(1) process */ |
}; |
}; |
|
|
static void choose_parser(struct mparse *); |
static void choose_parser(struct mparse *); |
static void resize_buf(struct buf *, size_t); |
static void resize_buf(struct buf *, size_t); |
static void mparse_buf_r(struct mparse *, struct buf, int); |
static void mparse_buf_r(struct mparse *, struct buf, size_t, int); |
static int read_whole_file(struct mparse *, const char *, int, |
static int read_whole_file(struct mparse *, const char *, int, |
struct buf *, int *); |
struct buf *, int *); |
static void mparse_end(struct mparse *); |
static void mparse_end(struct mparse *); |
Line 83 static const enum mandocerr mandoclimits[MANDOCLEVEL_M |
|
Line 80 static const enum mandocerr mandoclimits[MANDOCLEVEL_M |
|
MANDOCERR_WARNING, |
MANDOCERR_WARNING, |
MANDOCERR_WARNING, |
MANDOCERR_WARNING, |
MANDOCERR_ERROR, |
MANDOCERR_ERROR, |
MANDOCERR_FATAL, |
MANDOCERR_UNSUPP, |
MANDOCERR_MAX, |
MANDOCERR_MAX, |
MANDOCERR_MAX |
MANDOCERR_MAX |
}; |
}; |
Line 99 static const char * const mandocerrs[MANDOCERR_MAX] = |
|
Line 96 static const char * const mandocerrs[MANDOCERR_MAX] = |
|
"lower case character in document title", |
"lower case character in document title", |
"missing manual section, using \"\"", |
"missing manual section, using \"\"", |
"unknown manual section", |
"unknown manual section", |
"unknown manual volume or arch", |
|
"missing date, using today's date", |
"missing date, using today's date", |
"cannot parse date, using it verbatim", |
"cannot parse date, using it verbatim", |
"missing Os macro, using \"\"", |
"missing Os macro, using \"\"", |
Line 114 static const char * const mandocerrs[MANDOCERR_MAX] = |
|
Line 110 static const char * const mandocerrs[MANDOCERR_MAX] = |
|
"content before first section header", |
"content before first section header", |
"first section is not \"NAME\"", |
"first section is not \"NAME\"", |
"bad NAME section contents", |
"bad NAME section contents", |
|
"missing description line, using \"\"", |
"sections out of conventional order", |
"sections out of conventional order", |
"duplicate section title", |
"duplicate section title", |
"unexpected section", |
"unexpected section", |
|
"unusual Xr order", |
|
"unusual Xr punctuation", |
|
"AUTHORS section without An macro", |
|
|
/* related to macros and nesting */ |
/* related to macros and nesting */ |
"obsolete macro", |
"obsolete macro", |
|
"macro neither callable nor escaped", |
"skipping paragraph macro", |
"skipping paragraph macro", |
"moving paragraph macro out of list", |
"moving paragraph macro out of list", |
"skipping no-space macro", |
"skipping no-space macro", |
Line 135 static const char * const mandocerrs[MANDOCERR_MAX] = |
|
Line 136 static const char * const mandocerrs[MANDOCERR_MAX] = |
|
"skipping empty request", |
"skipping empty request", |
"conditional request controls empty scope", |
"conditional request controls empty scope", |
"skipping empty macro", |
"skipping empty macro", |
|
"empty block", |
"empty argument, using 0n", |
"empty argument, using 0n", |
"argument count wrong", |
|
"missing display type, using -ragged", |
"missing display type, using -ragged", |
"list type is not the first argument", |
"list type is not the first argument", |
"missing -width in -tag list, using 8n", |
"missing -width in -tag list, using 8n", |
"missing utility name, using \"\"", |
"missing utility name, using \"\"", |
|
"missing function name, using \"\"", |
"empty head in list item", |
"empty head in list item", |
"empty list item", |
"empty list item", |
"missing font type, using \\fR", |
"missing font type, using \\fR", |
"unknown font type, using \\fR", |
"unknown font type, using \\fR", |
|
"nothing follows prefix", |
|
"empty reference block", |
"missing -std argument, adding it", |
"missing -std argument, adding it", |
|
"missing option string, using \"\"", |
|
"missing resource identifier, using \"\"", |
|
"missing eqn box, using \"\"", |
|
|
/* related to bad macro arguments */ |
/* related to bad macro arguments */ |
"unterminated quoted argument", |
"unterminated quoted argument", |
Line 155 static const char * const mandocerrs[MANDOCERR_MAX] = |
|
Line 162 static const char * const mandocerrs[MANDOCERR_MAX] = |
|
"skipping duplicate list type", |
"skipping duplicate list type", |
"skipping -width argument", |
"skipping -width argument", |
"unknown AT&T UNIX version", |
"unknown AT&T UNIX version", |
|
"comma in function argument", |
|
"parenthesis in function name", |
"invalid content in Rs block", |
"invalid content in Rs block", |
"invalid Boolean argument", |
"invalid Boolean argument", |
"unknown font, skipping request", |
"unknown font, skipping request", |
Line 167 static const char * const mandocerrs[MANDOCERR_MAX] = |
|
Line 176 static const char * const mandocerrs[MANDOCERR_MAX] = |
|
"invalid escape sequence", |
"invalid escape sequence", |
"undefined string, using \"\"", |
"undefined string, using \"\"", |
|
|
|
/* related to tables */ |
|
"tbl line starts with span", |
|
"tbl column starts with span", |
|
"skipping vertical bar in tbl layout", |
|
|
"generic error", |
"generic error", |
|
|
/* related to equations */ |
|
"unexpected equation scope closure", |
|
"equation scope open on exit", |
|
"overlapping equation scopes", |
|
"unexpected end of equation", |
|
"equation syntax error", |
|
|
|
/* related to tables */ |
/* related to tables */ |
"bad table syntax", |
"non-alphabetic character in tbl options", |
"bad table option", |
"skipping unknown tbl option", |
"bad table layout", |
"missing tbl option argument", |
"no table layout cells specified", |
"wrong tbl option argument size", |
"no table data cells specified", |
"empty tbl layout", |
"ignore data in cell", |
"invalid character in tbl layout", |
"data block still open", |
"unmatched parenthesis in tbl layout", |
"ignoring extra data cells", |
"tbl without any data cells", |
|
"ignoring data in spanned tbl cell", |
|
"ignoring extra tbl data cells", |
|
"data block open at end of tbl", |
|
|
/* related to document structure and macros */ |
/* related to document structure and macros */ |
|
NULL, |
"input stack limit exceeded, infinite loop?", |
"input stack limit exceeded, infinite loop?", |
"skipping bad character", |
"skipping bad character", |
"skipping unknown macro", |
"skipping unknown macro", |
|
"skipping insecure request", |
"skipping item outside list", |
"skipping item outside list", |
"skipping column outside column list", |
"skipping column outside column list", |
"skipping end of block that is not open", |
"skipping end of block that is not open", |
|
"fewer RS blocks open, skipping", |
"inserting missing end of block", |
"inserting missing end of block", |
"appending missing end of block", |
"appending missing end of block", |
|
|
/* related to request and macro arguments */ |
/* related to request and macro arguments */ |
"escaped character not allowed in a name", |
"escaped character not allowed in a name", |
"argument count wrong", |
"argument count wrong", |
|
"NOT IMPLEMENTED: Bd -file", |
"missing list type, using -item", |
"missing list type, using -item", |
"missing manual name, using \"\"", |
"missing manual name, using \"\"", |
"uname(3) system call failed, using UNKNOWN", |
"uname(3) system call failed, using UNKNOWN", |
"unknown standard specifier", |
"unknown standard specifier", |
"skipping request without numeric argument", |
"skipping request without numeric argument", |
|
"NOT IMPLEMENTED: .so with absolute path or \"..\"", |
|
".so request failed", |
"skipping all arguments", |
"skipping all arguments", |
"skipping excess arguments", |
"skipping excess arguments", |
|
"divide by zero", |
|
|
"generic fatal error", |
"unsupported feature", |
|
|
"input too large", |
"input too large", |
"NOT IMPLEMENTED: Bd -file", |
"unsupported control character", |
"NOT IMPLEMENTED: .so with absolute path or \"..\"", |
"unsupported roff request", |
".so request failed", |
"eqn delim option in tbl", |
|
"unsupported tbl layout modifier", |
/* system errors */ |
"ignoring macro in table", |
"cannot dup file descriptor", |
|
"cannot exec", |
|
"gunzip failed with code", |
|
"cannot fork", |
|
NULL, |
|
"cannot open pipe", |
|
"cannot read file", |
|
"gunzip died from signal", |
|
"cannot stat file", |
|
"wait failed", |
|
}; |
}; |
|
|
static const char * const mandoclevels[MANDOCLEVEL_MAX] = { |
static const char * const mandoclevels[MANDOCLEVEL_MAX] = { |
Line 232 static const char * const mandoclevels[MANDOCLEVEL_MAX |
|
Line 238 static const char * const mandoclevels[MANDOCLEVEL_MAX |
|
"RESERVED", |
"RESERVED", |
"WARNING", |
"WARNING", |
"ERROR", |
"ERROR", |
"FATAL", |
"UNSUPP", |
"BADARG", |
"BADARG", |
"SYSERR" |
"SYSERR" |
}; |
}; |
Line 293 choose_parser(struct mparse *curp) |
|
Line 299 choose_parser(struct mparse *curp) |
|
/* Fall back to man(7) as a last resort. */ |
/* Fall back to man(7) as a last resort. */ |
|
|
if (NULL == curp->pman) |
if (NULL == curp->pman) |
curp->pman = man_alloc(curp->roff, curp, |
curp->pman = man_alloc( |
|
curp->roff, curp, curp->defos, |
MPARSE_QUICK & curp->options ? 1 : 0); |
MPARSE_QUICK & curp->options ? 1 : 0); |
assert(curp->pman); |
assert(curp->pman); |
curp->man = curp->pman; |
curp->man = curp->pman; |
} |
} |
|
|
/* |
/* |
* Main parse routine for an opened file. This is called for each |
* Main parse routine for a buffer. |
* opened file and simply loops around the full input file, possibly |
* It assumes encoding and line numbering are already set up. |
* nesting (i.e., with `so'). |
* It can recurse directly (for invocations of user-defined |
|
* macros, inline equations, and input line traps) |
|
* and indirectly (for .so file inclusion). |
*/ |
*/ |
static void |
static void |
mparse_buf_r(struct mparse *curp, struct buf blk, int start) |
mparse_buf_r(struct mparse *curp, struct buf blk, size_t i, int start) |
{ |
{ |
const struct tbl_span *span; |
const struct tbl_span *span; |
struct buf ln; |
struct buf ln; |
|
const char *save_file; |
|
char *cp; |
|
size_t pos; /* byte number in the ln buffer */ |
enum rofferr rr; |
enum rofferr rr; |
int i, of, rc; |
int of; |
int pos; /* byte number in the ln buffer */ |
|
int lnn; /* line number in the real file */ |
int lnn; /* line number in the real file */ |
|
int fd; |
|
pid_t save_child; |
unsigned char c; |
unsigned char c; |
|
|
memset(&ln, 0, sizeof(struct buf)); |
memset(&ln, 0, sizeof(ln)); |
|
|
lnn = curp->line; |
lnn = curp->line; |
pos = 0; |
pos = 0; |
|
|
for (i = 0; i < (int)blk.sz; ) { |
while (i < blk.sz) { |
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; |
curp->reparse_count = 0; |
|
|
|
if (lnn < 3 && |
|
curp->filenc & MPARSE_UTF8 && |
|
curp->filenc & MPARSE_LATIN1) |
|
curp->filenc = preconv_cue(&blk, i); |
} |
} |
|
|
while (i < (int)blk.sz && (start || '\0' != blk.buf[i])) { |
while (i < blk.sz && (start || blk.buf[i] != '\0')) { |
|
|
/* |
/* |
* When finding an unescaped newline character, |
* When finding an unescaped newline character, |
Line 337 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
Line 355 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
* Skip a preceding carriage return, if any. |
* Skip a preceding carriage return, if any. |
*/ |
*/ |
|
|
if ('\r' == blk.buf[i] && i + 1 < (int)blk.sz && |
if ('\r' == blk.buf[i] && i + 1 < blk.sz && |
'\n' == blk.buf[i + 1]) |
'\n' == blk.buf[i + 1]) |
++i; |
++i; |
if ('\n' == blk.buf[i]) { |
if ('\n' == blk.buf[i]) { |
Line 347 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
Line 365 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
} |
} |
|
|
/* |
/* |
* Make sure we have space for at least |
* Make sure we have space for the worst |
* one backslash and one other character |
* case of 11 bytes: "\\[u10ffff]\0" |
* and the trailing NUL byte. |
|
*/ |
*/ |
|
|
if (pos + 2 >= (int)ln.sz) |
if (pos + 11 > ln.sz) |
resize_buf(&ln, 256); |
resize_buf(&ln, 256); |
|
|
/* |
/* |
* Warn about bogus characters. If you're using |
* Encode 8-bit input. |
* non-ASCII encoding, you're screwing your |
|
* readers. Since I'd rather this not happen, |
|
* I'll be helpful and replace these characters |
|
* with "?", so we don't display gibberish. |
|
* Note to manual writers: use special characters. |
|
*/ |
*/ |
|
|
c = (unsigned char) blk.buf[i]; |
c = blk.buf[i]; |
|
if (c & 0x80) { |
|
if ( ! (curp->filenc && preconv_encode( |
|
&blk, &i, &ln, &pos, &curp->filenc))) { |
|
mandoc_vmsg(MANDOCERR_CHAR_BAD, curp, |
|
curp->line, pos, "0x%x", c); |
|
ln.buf[pos++] = '?'; |
|
i++; |
|
} |
|
continue; |
|
} |
|
|
if ( ! (isascii(c) && |
/* |
(isgraph(c) || isblank(c)))) { |
* Exclude control characters. |
mandoc_vmsg(MANDOCERR_BADCHAR, curp, |
*/ |
curp->line, pos, "0x%x", c); |
|
|
if (c == 0x7f || (c < 0x20 && c != 0x09)) { |
|
mandoc_vmsg(c == 0x00 || c == 0x04 || |
|
c > 0x0a ? MANDOCERR_CHAR_BAD : |
|
MANDOCERR_CHAR_UNSUPP, |
|
curp, curp->line, pos, "0x%x", c); |
i++; |
i++; |
ln.buf[pos++] = '?'; |
ln.buf[pos++] = '?'; |
continue; |
continue; |
Line 377 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
Line 404 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
|
|
/* Trailing backslash = a plain char. */ |
/* Trailing backslash = a plain char. */ |
|
|
if ('\\' != blk.buf[i] || i + 1 == (int)blk.sz) { |
if (blk.buf[i] != '\\' || i + 1 == blk.sz) { |
ln.buf[pos++] = blk.buf[i++]; |
ln.buf[pos++] = blk.buf[i++]; |
continue; |
continue; |
} |
} |
Line 389 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
Line 416 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
* skip that one as well. |
* skip that one as well. |
*/ |
*/ |
|
|
if ('\r' == blk.buf[i + 1] && i + 2 < (int)blk.sz && |
if ('\r' == blk.buf[i + 1] && i + 2 < blk.sz && |
'\n' == blk.buf[i + 2]) |
'\n' == blk.buf[i + 2]) |
++i; |
++i; |
if ('\n' == blk.buf[i + 1]) { |
if ('\n' == blk.buf[i + 1]) { |
Line 401 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
Line 428 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
if ('"' == blk.buf[i + 1] || '#' == blk.buf[i + 1]) { |
if ('"' == blk.buf[i + 1] || '#' == blk.buf[i + 1]) { |
i += 2; |
i += 2; |
/* Comment, skip to end of line */ |
/* Comment, skip to end of line */ |
for (; i < (int)blk.sz; ++i) { |
for (; i < blk.sz; ++i) { |
if ('\n' == blk.buf[i]) { |
if ('\n' == blk.buf[i]) { |
++i; |
++i; |
++lnn; |
++lnn; |
Line 425 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
Line 452 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
|
|
if ( ! (isascii(c) && |
if ( ! (isascii(c) && |
(isgraph(c) || isblank(c)))) { |
(isgraph(c) || isblank(c)))) { |
mandoc_vmsg(MANDOCERR_BADCHAR, curp, |
mandoc_vmsg(MANDOCERR_CHAR_BAD, curp, |
curp->line, pos, "0x%x", c); |
curp->line, pos, "0x%x", c); |
i += 2; |
i += 2; |
ln.buf[pos++] = '?'; |
ln.buf[pos++] = '?'; |
Line 438 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
Line 465 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
ln.buf[pos++] = blk.buf[i++]; |
ln.buf[pos++] = blk.buf[i++]; |
} |
} |
|
|
if (pos >= (int)ln.sz) |
if (pos >= ln.sz) |
resize_buf(&ln, 256); |
resize_buf(&ln, 256); |
|
|
ln.buf[pos] = '\0'; |
ln.buf[pos] = '\0'; |
Line 475 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
Line 502 mparse_buf_r(struct mparse *curp, struct buf blk, int |
|
[curp->secondary->sz] = '\0'; |
[curp->secondary->sz] = '\0'; |
} |
} |
rerun: |
rerun: |
rr = roff_parseln(curp->roff, curp->line, |
rr = roff_parseln(curp->roff, curp->line, &ln, &of); |
&ln.buf, &ln.sz, of, &of); |
|
|
|
switch (rr) { |
switch (rr) { |
case ROFF_REPARSE: |
case ROFF_REPARSE: |
if (REPARSE_LIMIT >= ++curp->reparse_count) |
if (REPARSE_LIMIT >= ++curp->reparse_count) |
mparse_buf_r(curp, ln, 0); |
mparse_buf_r(curp, ln, of, 0); |
else |
else |
mandoc_msg(MANDOCERR_ROFFLOOP, curp, |
mandoc_msg(MANDOCERR_ROFFLOOP, curp, |
curp->line, pos, NULL); |
curp->line, pos, NULL); |
pos = 0; |
pos = 0; |
continue; |
continue; |
case ROFF_APPEND: |
case ROFF_APPEND: |
pos = (int)strlen(ln.buf); |
pos = strlen(ln.buf); |
continue; |
continue; |
case ROFF_RERUN: |
case ROFF_RERUN: |
goto rerun; |
goto rerun; |
case ROFF_IGN: |
case ROFF_IGN: |
pos = 0; |
pos = 0; |
continue; |
continue; |
case ROFF_ERR: |
|
assert(MANDOCLEVEL_FATAL <= curp->file_status); |
|
break; |
|
case ROFF_SO: |
case ROFF_SO: |
if (0 == (MPARSE_SO & curp->options) && |
if ( ! (curp->options & MPARSE_SO) && |
(i >= (int)blk.sz || '\0' == blk.buf[i])) { |
(i >= blk.sz || blk.buf[i] == '\0')) { |
curp->sodest = mandoc_strdup(ln.buf + of); |
curp->sodest = mandoc_strdup(ln.buf + of); |
free(ln.buf); |
free(ln.buf); |
return; |
return; |
|
|
*/ |
*/ |
if (curp->secondary) |
if (curp->secondary) |
curp->secondary->sz -= pos + 1; |
curp->secondary->sz -= pos + 1; |
mparse_readfd(curp, -1, ln.buf + of); |
save_file = curp->file; |
if (MANDOCLEVEL_FATAL <= curp->file_status) { |
save_child = curp->child; |
|
if (mparse_open(curp, &fd, ln.buf + of) == |
|
MANDOCLEVEL_OK) { |
|
mparse_readfd(curp, fd, ln.buf + of); |
|
curp->file = save_file; |
|
} else { |
|
curp->file = save_file; |
mandoc_vmsg(MANDOCERR_SO_FAIL, |
mandoc_vmsg(MANDOCERR_SO_FAIL, |
curp, curp->line, pos, |
curp, curp->line, pos, |
".so %s", ln.buf + of); |
".so %s", ln.buf + of); |
break; |
ln.sz = mandoc_asprintf(&cp, |
|
".sp\nSee the file %s.\n.sp", |
|
ln.buf + of); |
|
free(ln.buf); |
|
ln.buf = cp; |
|
of = 0; |
|
mparse_buf_r(curp, ln, of, 0); |
} |
} |
|
curp->child = save_child; |
pos = 0; |
pos = 0; |
continue; |
continue; |
default: |
default: |
|
|
} |
} |
|
|
/* |
/* |
* If we encounter errors in the recursive parse, make |
|
* sure we don't continue parsing. |
|
*/ |
|
|
|
if (MANDOCLEVEL_FATAL <= curp->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 between parsers, but set them |
* We keep these instanced between parsers, but set them |
* locally per parse routine since we can use different |
* locally per parse routine since we can use different |
|
|
* Do the same for ROFF_EQN. |
* Do the same for ROFF_EQN. |
*/ |
*/ |
|
|
rc = -1; |
if (rr == ROFF_TBL) { |
|
while ((span = roff_span(curp->roff)) != NULL) |
|
if (curp->man == NULL) |
|
mdoc_addspan(curp->mdoc, span); |
|
else |
|
man_addspan(curp->man, span); |
|
} else if (rr == ROFF_EQN) { |
|
if (curp->man == NULL) |
|
mdoc_addeqn(curp->mdoc, roff_eqn(curp->roff)); |
|
else |
|
man_addeqn(curp->man, roff_eqn(curp->roff)); |
|
} else if ((curp->man == NULL ? |
|
mdoc_parseln(curp->mdoc, curp->line, ln.buf, of) : |
|
man_parseln(curp->man, curp->line, ln.buf, of)) == 2) |
|
break; |
|
|
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 ? |
|
man_parseln(curp->man, |
|
curp->line, ln.buf, of) : |
|
mdoc_parseln(curp->mdoc, |
|
curp->line, ln.buf, of); |
|
|
|
if (0 == rc) { |
|
assert(MANDOCLEVEL_FATAL <= curp->file_status); |
|
break; |
|
} else if (2 == rc) |
|
break; |
|
|
|
/* Temporary buffers typically are not full. */ |
/* Temporary buffers typically are not full. */ |
|
|
if (0 == start && '\0' == blk.buf[i]) |
if (0 == start && '\0' == blk.buf[i]) |
Line 604 read_whole_file(struct mparse *curp, const char *file, |
|
Line 619 read_whole_file(struct mparse *curp, const char *file, |
|
#if HAVE_MMAP |
#if HAVE_MMAP |
struct stat st; |
struct stat st; |
if (-1 == fstat(fd, &st)) { |
if (-1 == fstat(fd, &st)) { |
curp->file_status = MANDOCLEVEL_SYSERR; |
perror(file); |
if (curp->mmsg) |
exit((int)MANDOCLEVEL_SYSERR); |
(*curp->mmsg)(MANDOCERR_SYSSTAT, curp->file_status, |
|
file, 0, 0, strerror(errno)); |
|
return(0); |
|
} |
} |
|
|
/* |
/* |
Line 620 read_whole_file(struct mparse *curp, const char *file, |
|
Line 632 read_whole_file(struct mparse *curp, const char *file, |
|
|
|
if (S_ISREG(st.st_mode)) { |
if (S_ISREG(st.st_mode)) { |
if (st.st_size >= (1U << 31)) { |
if (st.st_size >= (1U << 31)) { |
curp->file_status = MANDOCLEVEL_FATAL; |
mandoc_msg(MANDOCERR_TOOLARGE, curp, 0, 0, NULL); |
if (curp->mmsg) |
|
(*curp->mmsg)(MANDOCERR_TOOLARGE, |
|
curp->file_status, file, 0, 0, NULL); |
|
return(0); |
return(0); |
} |
} |
*with_mmap = 1; |
*with_mmap = 1; |
Line 646 read_whole_file(struct mparse *curp, const char *file, |
|
Line 655 read_whole_file(struct mparse *curp, const char *file, |
|
for (;;) { |
for (;;) { |
if (off == fb->sz) { |
if (off == fb->sz) { |
if (fb->sz == (1U << 31)) { |
if (fb->sz == (1U << 31)) { |
curp->file_status = MANDOCLEVEL_FATAL; |
mandoc_msg(MANDOCERR_TOOLARGE, curp, |
if (curp->mmsg) |
0, 0, NULL); |
(*curp->mmsg)(MANDOCERR_TOOLARGE, |
|
curp->file_status, |
|
file, 0, 0, NULL); |
|
break; |
break; |
} |
} |
resize_buf(fb, 65536); |
resize_buf(fb, 65536); |
Line 661 read_whole_file(struct mparse *curp, const char *file, |
|
Line 667 read_whole_file(struct mparse *curp, const char *file, |
|
return(1); |
return(1); |
} |
} |
if (ssz == -1) { |
if (ssz == -1) { |
curp->file_status = MANDOCLEVEL_SYSERR; |
perror(file); |
if (curp->mmsg) |
exit((int)MANDOCLEVEL_SYSERR); |
(*curp->mmsg)(MANDOCERR_SYSREAD, |
|
curp->file_status, file, 0, 0, |
|
strerror(errno)); |
|
break; |
|
} |
} |
off += (size_t)ssz; |
off += (size_t)ssz; |
} |
} |
|
|
mparse_end(struct mparse *curp) |
mparse_end(struct mparse *curp) |
{ |
{ |
|
|
if (MANDOCLEVEL_FATAL <= curp->file_status) |
|
return; |
|
|
|
if (curp->mdoc == NULL && |
if (curp->mdoc == NULL && |
curp->man == NULL && |
curp->man == NULL && |
curp->sodest == NULL) { |
curp->sodest == NULL) { |
Line 690 mparse_end(struct mparse *curp) |
|
Line 689 mparse_end(struct mparse *curp) |
|
curp->mdoc = curp->pmdoc; |
curp->mdoc = curp->pmdoc; |
else { |
else { |
if (curp->pman == NULL) |
if (curp->pman == NULL) |
curp->pman = man_alloc(curp->roff, curp, |
curp->pman = man_alloc( |
|
curp->roff, curp, curp->defos, |
curp->options & MPARSE_QUICK ? 1 : 0); |
curp->options & MPARSE_QUICK ? 1 : 0); |
curp->man = curp->pman; |
curp->man = curp->pman; |
} |
} |
} |
} |
|
if (curp->mdoc) |
if (curp->mdoc && ! mdoc_endparse(curp->mdoc)) { |
mdoc_endparse(curp->mdoc); |
assert(MANDOCLEVEL_FATAL <= curp->file_status); |
if (curp->man) |
return; |
man_endparse(curp->man); |
} |
|
|
|
if (curp->man && ! man_endparse(curp->man)) { |
|
assert(MANDOCLEVEL_FATAL <= curp->file_status); |
|
return; |
|
} |
|
|
|
roff_endparse(curp->roff); |
roff_endparse(curp->roff); |
} |
} |
|
|
Line 714 mparse_parse_buffer(struct mparse *curp, struct buf bl |
|
Line 707 mparse_parse_buffer(struct mparse *curp, struct buf bl |
|
{ |
{ |
struct buf *svprimary; |
struct buf *svprimary; |
const char *svfile; |
const char *svfile; |
|
size_t offset; |
static int recursion_depth; |
static int recursion_depth; |
|
|
if (64 < recursion_depth) { |
if (64 < recursion_depth) { |
Line 729 mparse_parse_buffer(struct mparse *curp, struct buf bl |
|
Line 723 mparse_parse_buffer(struct mparse *curp, struct buf bl |
|
curp->line = 1; |
curp->line = 1; |
recursion_depth++; |
recursion_depth++; |
|
|
mparse_buf_r(curp, blk, 1); |
/* Skip an UTF-8 byte order mark. */ |
|
if (curp->filenc & MPARSE_UTF8 && blk.sz > 2 && |
|
(unsigned char)blk.buf[0] == 0xef && |
|
(unsigned char)blk.buf[1] == 0xbb && |
|
(unsigned char)blk.buf[2] == 0xbf) { |
|
offset = 3; |
|
curp->filenc &= ~MPARSE_LATIN1; |
|
} else |
|
offset = 0; |
|
|
if (0 == --recursion_depth && MANDOCLEVEL_FATAL > curp->file_status) |
mparse_buf_r(curp, blk, offset, 1); |
|
|
|
if (--recursion_depth == 0) |
mparse_end(curp); |
mparse_end(curp); |
|
|
curp->primary = svprimary; |
curp->primary = svprimary; |
Line 739 mparse_parse_buffer(struct mparse *curp, struct buf bl |
|
Line 743 mparse_parse_buffer(struct mparse *curp, struct buf bl |
|
} |
} |
|
|
enum mandoclevel |
enum mandoclevel |
mparse_readmem(struct mparse *curp, const void *buf, size_t len, |
mparse_readmem(struct mparse *curp, void *buf, size_t len, |
const char *file) |
const char *file) |
{ |
{ |
struct buf blk; |
struct buf blk; |
|
|
blk.buf = UNCONST(buf); |
blk.buf = buf; |
blk.sz = len; |
blk.sz = len; |
|
|
mparse_parse_buffer(curp, blk, file); |
mparse_parse_buffer(curp, blk, file); |
return(curp->file_status); |
return(curp->file_status); |
} |
} |
|
|
|
/* |
|
* Read the whole file into memory and call the parsers. |
|
* Called recursively when an .so request is encountered. |
|
*/ |
enum mandoclevel |
enum mandoclevel |
mparse_readfd(struct mparse *curp, int fd, const char *file) |
mparse_readfd(struct mparse *curp, int fd, const char *file) |
{ |
{ |
struct buf blk; |
struct buf blk; |
int with_mmap; |
int with_mmap; |
|
int save_filenc; |
|
|
if (-1 == fd && -1 == (fd = open(file, O_RDONLY, 0))) { |
if (read_whole_file(curp, file, fd, &blk, &with_mmap)) { |
curp->file_status = MANDOCLEVEL_SYSERR; |
save_filenc = curp->filenc; |
if (curp->mmsg) |
curp->filenc = curp->options & |
(*curp->mmsg)(MANDOCERR_SYSOPEN, |
(MPARSE_UTF8 | MPARSE_LATIN1); |
curp->file_status, |
mparse_parse_buffer(curp, blk, file); |
file, 0, 0, strerror(errno)); |
curp->filenc = save_filenc; |
goto out; |
|
} |
|
|
|
/* |
|
* Run for each opened file; may be called more than once for |
|
* each full parse sequence if the opened file is nested (i.e., |
|
* from `so'). Simply sucks in the whole file and moves into |
|
* the parse phase for the file. |
|
*/ |
|
|
|
if ( ! read_whole_file(curp, file, fd, &blk, &with_mmap)) |
|
goto out; |
|
|
|
mparse_parse_buffer(curp, blk, file); |
|
|
|
#if HAVE_MMAP |
#if HAVE_MMAP |
if (with_mmap) |
if (with_mmap) |
munmap(blk.buf, blk.sz); |
munmap(blk.buf, blk.sz); |
else |
else |
#endif |
#endif |
free(blk.buf); |
free(blk.buf); |
|
} |
|
|
if (STDIN_FILENO != fd && -1 == close(fd)) |
if (fd != STDIN_FILENO && close(fd) == -1) |
perror(file); |
perror(file); |
out: |
|
|
mparse_wait(curp); |
return(curp->file_status); |
return(curp->file_status); |
} |
} |
|
|
enum mandoclevel |
enum mandoclevel |
mparse_open(struct mparse *curp, int *fd, const char *file, |
mparse_open(struct mparse *curp, int *fd, const char *file) |
pid_t *child_pid) |
|
{ |
{ |
int pfd[2]; |
int pfd[2]; |
|
int save_errno; |
char *cp; |
char *cp; |
enum mandocerr err; |
|
|
|
pfd[1] = -1; |
|
curp->file = file; |
curp->file = file; |
|
|
|
/* Unless zipped, try to just open the file. */ |
|
|
if ((cp = strrchr(file, '.')) == NULL || |
if ((cp = strrchr(file, '.')) == NULL || |
strcmp(cp + 1, "gz")) { |
strcmp(cp + 1, "gz")) { |
*child_pid = 0; |
curp->child = 0; |
if ((*fd = open(file, O_RDONLY)) == -1) { |
if ((*fd = open(file, O_RDONLY)) != -1) |
err = MANDOCERR_SYSOPEN; |
return(MANDOCLEVEL_OK); |
goto out; |
|
} |
/* Open failed; try to append ".gz". */ |
return(MANDOCLEVEL_OK); |
|
|
mandoc_asprintf(&cp, "%s.gz", file); |
|
file = cp; |
|
} else |
|
cp = NULL; |
|
|
|
/* Before forking, make sure the file can be read. */ |
|
|
|
save_errno = errno; |
|
if (access(file, R_OK) == -1) { |
|
if (cp != NULL) |
|
errno = save_errno; |
|
free(cp); |
|
*fd = -1; |
|
curp->child = 0; |
|
mandoc_msg(MANDOCERR_FILE, curp, 0, 0, strerror(errno)); |
|
return(MANDOCLEVEL_ERROR); |
} |
} |
|
|
|
/* Run gunzip(1). */ |
|
|
if (pipe(pfd) == -1) { |
if (pipe(pfd) == -1) { |
err = MANDOCERR_SYSPIPE; |
perror("pipe"); |
goto out; |
exit((int)MANDOCLEVEL_SYSERR); |
} |
} |
|
|
switch (*child_pid = fork()) { |
switch (curp->child = fork()) { |
case -1: |
case -1: |
err = MANDOCERR_SYSFORK; |
perror("fork"); |
close(pfd[0]); |
exit((int)MANDOCLEVEL_SYSERR); |
close(pfd[1]); |
|
pfd[1] = -1; |
|
break; |
|
case 0: |
case 0: |
close(pfd[0]); |
close(pfd[0]); |
if (dup2(pfd[1], STDOUT_FILENO) == -1) { |
if (dup2(pfd[1], STDOUT_FILENO) == -1) { |
err = MANDOCERR_SYSDUP; |
perror("dup"); |
break; |
exit((int)MANDOCLEVEL_SYSERR); |
} |
} |
execlp("gunzip", "gunzip", "-c", file, NULL); |
execlp("gunzip", "gunzip", "-c", file, NULL); |
err = MANDOCERR_SYSEXEC; |
perror("exec"); |
break; |
exit((int)MANDOCLEVEL_SYSERR); |
default: |
default: |
close(pfd[1]); |
close(pfd[1]); |
*fd = pfd[0]; |
*fd = pfd[0]; |
return(MANDOCLEVEL_OK); |
return(MANDOCLEVEL_OK); |
} |
} |
|
|
out: |
|
*fd = -1; |
|
*child_pid = 0; |
|
curp->file_status = MANDOCLEVEL_SYSERR; |
|
if (curp->mmsg) |
|
(*curp->mmsg)(err, curp->file_status, file, |
|
0, 0, strerror(errno)); |
|
if (pfd[1] != -1) |
|
exit(1); |
|
return(curp->file_status); |
|
} |
} |
|
|
enum mandoclevel |
enum mandoclevel |
mparse_wait(struct mparse *curp, pid_t child_pid) |
mparse_wait(struct mparse *curp) |
{ |
{ |
int status; |
int status; |
|
|
if (waitpid(child_pid, &status, 0) == -1) { |
if (curp->child == 0) |
mandoc_msg(MANDOCERR_SYSWAIT, curp, 0, 0, |
return(MANDOCLEVEL_OK); |
strerror(errno)); |
|
curp->file_status = MANDOCLEVEL_SYSERR; |
if (waitpid(curp->child, &status, 0) == -1) { |
return(curp->file_status); |
perror("wait"); |
|
exit((int)MANDOCLEVEL_SYSERR); |
} |
} |
if (WIFSIGNALED(status)) { |
if (WIFSIGNALED(status)) { |
mandoc_vmsg(MANDOCERR_SYSSIG, curp, 0, 0, |
mandoc_vmsg(MANDOCERR_FILE, curp, 0, 0, |
"%d", WTERMSIG(status)); |
"gunzip died from signal %d", WTERMSIG(status)); |
curp->file_status = MANDOCLEVEL_SYSERR; |
return(MANDOCLEVEL_ERROR); |
return(curp->file_status); |
|
} |
} |
if (WEXITSTATUS(status)) { |
if (WEXITSTATUS(status)) { |
mandoc_vmsg(MANDOCERR_SYSEXIT, curp, 0, 0, |
mandoc_vmsg(MANDOCERR_FILE, curp, 0, 0, |
"%d", WEXITSTATUS(status)); |
"gunzip failed with code %d", WEXITSTATUS(status)); |
curp->file_status = MANDOCLEVEL_SYSERR; |
return(MANDOCLEVEL_ERROR); |
return(curp->file_status); |
|
} |
} |
return(MANDOCLEVEL_OK); |
return(MANDOCLEVEL_OK); |
} |
} |
|
|
struct mparse * |
struct mparse * |
mparse_alloc(int options, enum mandoclevel wlevel, |
mparse_alloc(int options, enum mandoclevel wlevel, mandocmsg mmsg, |
mandocmsg mmsg, const char *defos) |
const struct mchars *mchars, const char *defos) |
{ |
{ |
struct mparse *curp; |
struct mparse *curp; |
|
|
assert(wlevel <= MANDOCLEVEL_FATAL); |
|
|
|
curp = mandoc_calloc(1, sizeof(struct mparse)); |
curp = mandoc_calloc(1, sizeof(struct mparse)); |
|
|
curp->options = options; |
curp->options = options; |
Line 891 mparse_alloc(int options, enum mandoclevel wlevel, |
|
Line 889 mparse_alloc(int options, enum mandoclevel wlevel, |
|
curp->mmsg = mmsg; |
curp->mmsg = mmsg; |
curp->defos = defos; |
curp->defos = defos; |
|
|
curp->roff = roff_alloc(curp, options); |
curp->mchars = mchars; |
|
curp->roff = roff_alloc(curp, curp->mchars, options); |
if (curp->options & MPARSE_MDOC) |
if (curp->options & MPARSE_MDOC) |
curp->pmdoc = mdoc_alloc( |
curp->pmdoc = mdoc_alloc( |
curp->roff, curp, curp->defos, |
curp->roff, curp, curp->defos, |
curp->options & MPARSE_QUICK ? 1 : 0); |
curp->options & MPARSE_QUICK ? 1 : 0); |
if (curp->options & MPARSE_MAN) |
if (curp->options & MPARSE_MAN) |
curp->pman = man_alloc(curp->roff, curp, |
curp->pman = man_alloc( |
|
curp->roff, curp, curp->defos, |
curp->options & MPARSE_QUICK ? 1 : 0); |
curp->options & MPARSE_QUICK ? 1 : 0); |
|
|
return(curp); |
return(curp); |
Line 978 mandoc_msg(enum mandocerr er, struct mparse *m, |
|
Line 978 mandoc_msg(enum mandocerr er, struct mparse *m, |
|
{ |
{ |
enum mandoclevel level; |
enum mandoclevel level; |
|
|
level = MANDOCLEVEL_FATAL; |
level = MANDOCLEVEL_UNSUPP; |
while (er < mandoclimits[level]) |
while (er < mandoclimits[level]) |
level--; |
level--; |
|
|
if (level < m->wlevel) |
if (level < m->wlevel && er != MANDOCERR_FILE) |
return; |
return; |
|
|
if (m->mmsg) |
if (m->mmsg) |