=================================================================== RCS file: /cvs/mandoc/mdoc.c,v retrieving revision 1.21 retrieving revision 1.111 diff -u -p -r1.21 -r1.111 --- mandoc/mdoc.c 2009/01/07 15:57:14 1.21 +++ mandoc/mdoc.c 2009/10/26 07:11:07 1.111 @@ -1,33 +1,88 @@ -/* $Id: mdoc.c,v 1.21 2009/01/07 15:57:14 kristaps Exp $ */ +/* $Id: mdoc.c,v 1.111 2009/10/26 07:11:07 kristaps Exp $ */ /* - * Copyright (c) 2008 Kristaps Dzonsons + * Copyright (c) 2008, 2009 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any - * purpose with or without fee is hereby granted, provided that the - * above copyright notice and this permission notice appear in all - * copies. + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL - * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED - * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE - * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL - * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR - * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER - * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - * PERFORMANCE OF THIS SOFTWARE. + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +#include + #include #include -#include #include -#include #include +#include #include -#include "private.h" +#include "libmdoc.h" +const char *const __mdoc_merrnames[MERRMAX] = { + "trailing whitespace", /* ETAILWS */ + "unexpected quoted parameter", /* EQUOTPARM */ + "unterminated quoted parameter", /* EQUOTTERM */ + "system: malloc error", /* EMALLOC */ + "argument parameter suggested", /* EARGVAL */ + "macro disallowed in prologue", /* EBODYPROL */ + "macro disallowed in body", /* EPROLBODY */ + "text disallowed in prologue", /* ETEXTPROL */ + "blank line disallowed", /* ENOBLANK */ + "text parameter too long", /* ETOOLONG */ + "invalid escape sequence", /* EESCAPE */ + "invalid character", /* EPRINT */ + "document has no body", /* ENODAT */ + "document has no prologue", /* ENOPROLOGUE */ + "expected line arguments", /* ELINE */ + "invalid AT&T argument", /* EATT */ + "default name not yet set", /* ENAME */ + "missing list type", /* ELISTTYPE */ + "missing display type", /* EDISPTYPE */ + "too many display types", /* EMULTIDISP */ + "too many list types", /* EMULTILIST */ + "NAME section must be first", /* ESECNAME */ + "badly-formed NAME section", /* ENAMESECINC */ + "argument repeated", /* EARGREP */ + "expected boolean parameter", /* EBOOL */ + "inconsistent column syntax", /* ECOLMIS */ + "nested display invalid", /* ENESTDISP */ + "width argument missing", /* EMISSWIDTH */ + "invalid section for this manual section", /* EWRONGMSEC */ + "section out of conventional order", /* ESECOOO */ + "section repeated", /* ESECREP */ + "invalid standard argument", /* EBADSTAND */ + "multi-line arguments discouraged", /* ENOMULTILINE */ + "multi-line arguments suggested", /* EMULTILINE */ + "line arguments discouraged", /* ENOLINE */ + "prologue macro out of conventional order", /* EPROLOOO */ + "prologue macro repeated", /* EPROLREP */ + "invalid manual section", /* EBADMSEC */ + "invalid section", /* EBADSEC */ + "invalid font mode", /* EFONT */ + "invalid date syntax", /* EBADDATE */ + "invalid number format", /* ENUMFMT */ + "superfluous width argument", /* ENOWIDTH */ + "system: utsname error", /* EUTSNAME */ + "obsolete macro", /* EOBS */ + "end-of-line scope violation", /* EIMPBRK */ + "empty macro ignored", /* EIGNE */ + "unclosed explicit scope", /* EOPEN */ + "unterminated quoted phrase", /* EQUOTPHR */ + "closure macro without prior context", /* ENOCTX */ + "no description found for library", /* ELIB */ + "bad child for parent context", /* EBADCHILD */ + "list arguments preceding type", /* ENOTYPE */ +}; + const char *const __mdoc_macronames[MDOC_MAX] = { - "\\\"", "Dd", "Dt", "Os", + "Ap", "Dd", "Dt", "Os", "Sh", "Ss", "Pp", "D1", "Dl", "Bd", "Ed", "Bl", "El", "It", "Ad", "An", @@ -56,7 +111,14 @@ const char *const __mdoc_macronames[MDOC_MAX] = { "Tn", "Ux", "Xc", "Xo", "Fo", "Fc", "Oo", "Oc", "Bk", "Ek", "Bt", "Hf", - "Fr", "Ud", + "Fr", "Ud", "Lb", "Lp", + "Lk", "Mt", "Brq", "Bro", + /* LINTED */ + "Brc", "\%C", "Es", "En", + /* LINTED */ + "Dx", "\%Q", "br", "sp", + /* LINTED */ + "\%U" }; const char *const __mdoc_argnames[MDOC_ARG_MAX] = { @@ -67,583 +129,468 @@ const char *const __mdoc_argnames[MDOC_ARG_MAX] = { "tag", "diag", "hang", "ohang", "inset", "column", "width", "compact", "std", - "p1003.1-88", "p1003.1-90", "p1003.1-96", - "p1003.1-2001", "p1003.1-2004", "p1003.1", - "p1003.1b", "p1003.1b-93", "p1003.1c-95", - "p1003.1g-2000", "p1003.2-92", "p1387.2-95", - "p1003.2", "p1387.2", "isoC-90", - "isoC-amd1", "isoC-tcor1", "isoC-tcor2", - "isoC-99", "ansiC", "ansiC-89", - "ansiC-99", "ieee754", "iso8802-3", - "xpg3", "xpg4", "xpg4.2", - "xpg4.3", "xbd5", "xcu5", - "xsh5", "xns5", "xns5.2d2.0", - "xcurses4.2", "susv2", "susv3", - "svid4", "filled", "words", - "emphasis", "symbolic", + "filled", "words", "emphasis", + "symbolic", "nested", "centered" }; -const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { - { NULL, 0 }, /* \" */ - { macro_prologue, MDOC_PROLOGUE }, /* Dd */ - { macro_prologue, MDOC_PROLOGUE }, /* Dt */ - { macro_prologue, MDOC_PROLOGUE }, /* Os */ - { macro_scoped, 0 }, /* Sh */ - { macro_scoped, 0 }, /* Ss */ - { macro_text, 0 }, /* Pp */ - { macro_scoped_line, MDOC_PARSED }, /* D1 */ - { macro_scoped_line, MDOC_PARSED }, /* Dl */ - { macro_scoped, MDOC_EXPLICIT }, /* Bd */ - { macro_close_explicit, 0 }, /* Ed */ - { macro_scoped, MDOC_EXPLICIT }, /* Bl */ - { macro_close_explicit, 0 }, /* El */ - { macro_scoped, MDOC_NESTED | MDOC_PARSED }, /* It */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */ - { macro_constant, MDOC_PARSED }, /* An */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */ - { macro_constant, MDOC_QUOTABLE }, /* Cd */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Er */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */ - { macro_constant, 0 }, /* Ex */ - { macro_text, MDOC_CALLABLE | MDOC_QUOTABLE | MDOC_PARSED }, /* Fa */ - { macro_constant, 0 }, /* Fd */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */ - { macro_text, MDOC_CALLABLE | MDOC_QUOTABLE | MDOC_PARSED }, /* Fn */ - { macro_text, MDOC_PARSED }, /* Ft */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */ - { macro_constant, 0 }, /* In */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Li */ - { macro_constant, 0 }, /* Nd */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */ - { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Op */ - { macro_obsolete, 0 }, /* Ot */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */ - { macro_constant, 0 }, /* Rv */ - /* XXX - supposed to be (but isn't) callable. */ - { macro_constant_delimited, MDOC_PARSED }, /* St */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Va */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */ - { macro_constant, MDOC_QUOTABLE | MDOC_PARSED }, /* %A */ - { macro_constant, MDOC_QUOTABLE | MDOC_PARSED }, /* %B */ - { macro_constant, MDOC_QUOTABLE }, /* %D */ - { macro_constant, MDOC_QUOTABLE | MDOC_PARSED }, /* %I */ - { macro_constant, MDOC_QUOTABLE | MDOC_PARSED }, /* %J */ - { macro_constant, MDOC_QUOTABLE }, /* %N */ - { macro_constant, MDOC_QUOTABLE }, /* %O */ - { macro_constant, MDOC_QUOTABLE }, /* %P */ - { macro_constant, MDOC_QUOTABLE }, /* %R */ - { macro_constant, MDOC_QUOTABLE | MDOC_PARSED }, /* %T */ - { macro_constant, MDOC_QUOTABLE }, /* %V */ - { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Ac */ - { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Ao */ - { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */ - { macro_constant, 0 }, /* At */ - { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Bc */ - { macro_scoped, MDOC_EXPLICIT }, /* Bf */ - { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Bo */ - { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Bq */ - { macro_constant_delimited, MDOC_PARSED }, /* Bsx */ - { macro_constant_delimited, MDOC_PARSED }, /* Bx */ - { macro_constant, 0 }, /* Db */ - { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Dc */ - { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Do */ - { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dq */ - { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Ec */ - { macro_close_explicit, 0 }, /* Ef */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Em */ - { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Eo */ - { macro_constant_delimited, MDOC_PARSED }, /* Fx */ - { macro_text, MDOC_PARSED }, /* Ms */ - { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* No */ - { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */ - { macro_constant_delimited, MDOC_PARSED }, /* Nx */ - { macro_constant_delimited, MDOC_PARSED }, /* Ox */ - { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Pc */ - { macro_constant, MDOC_PARSED }, /* Pf */ - { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Po */ - { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */ - { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Qc */ - { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ql */ - { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Qo */ - { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Qq */ - { macro_close_explicit, 0 }, /* Re */ - { macro_scoped, MDOC_EXPLICIT }, /* Rs */ - { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Sc */ - { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* So */ - { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sq */ - { macro_constant, 0 }, /* Sm */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sx */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sy */ - { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */ - { macro_constant_delimited, MDOC_PARSED }, /* Ux */ - { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Xc */ - { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Xo */ - /* XXX - .Fo supposed to be (but isn't) callable. */ - { macro_scoped, MDOC_EXPLICIT | MDOC_PARSED }, /* Fo */ - /* XXX - .Fc supposed to be (but isn't) callable. */ - { macro_close_explicit, MDOC_PARSED }, /* Fc */ - { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Oo */ - { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Oc */ - { macro_scoped, MDOC_EXPLICIT }, /* Bk */ - { macro_close_explicit, 0 }, /* Ek */ - { macro_constant, 0 }, /* Bt */ - { macro_constant, 0 }, /* Hf */ - { macro_obsolete, 0 }, /* Fr */ - { macro_constant, 0 }, /* Ud */ -}; - const char * const *mdoc_macronames = __mdoc_macronames; const char * const *mdoc_argnames = __mdoc_argnames; -const struct mdoc_macro * const mdoc_macros = __mdoc_macros; - -static struct mdoc_arg *argdup(size_t, const struct mdoc_arg *); -static void argfree(size_t, struct mdoc_arg *); -static void argcpy(struct mdoc_arg *, - const struct mdoc_arg *); - -static void mdoc_node_freelist(struct mdoc_node *); -static void mdoc_node_append(struct mdoc *, int, +static void mdoc_free1(struct mdoc *); +static int mdoc_alloc1(struct mdoc *); +static struct mdoc_node *node_alloc(struct mdoc *, int, int, + int, enum mdoc_type); +static int node_append(struct mdoc *, struct mdoc_node *); -static void mdoc_elem_free(struct mdoc_elem *); -static void mdoc_text_free(struct mdoc_text *); +static int parsetext(struct mdoc *, int, char *); +static int parsemacro(struct mdoc *, int, char *); +static int macrowarn(struct mdoc *, int, const char *); +static int pstring(struct mdoc *, int, int, + const char *, size_t); +#ifdef __linux__ +extern size_t strlcpy(char *, const char *, size_t); +#endif + const struct mdoc_node * -mdoc_result(struct mdoc *mdoc) +mdoc_node(const struct mdoc *m) { - return(mdoc->first); + return(MDOC_HALT & m->flags ? NULL : m->first); } -void -mdoc_free(struct mdoc *mdoc) +const struct mdoc_meta * +mdoc_meta(const struct mdoc *m) { - if (mdoc->first) - mdoc_node_freelist(mdoc->first); - if (mdoc->htab) - mdoc_tokhash_free(mdoc->htab); - - free(mdoc); + return(MDOC_HALT & m->flags ? NULL : &m->meta); } -struct mdoc * -mdoc_alloc(void *data, const struct mdoc_cb *cb) +/* + * Frees volatile resources (parse tree, meta-data, fields). + */ +static void +mdoc_free1(struct mdoc *mdoc) { - struct mdoc *p; - p = xcalloc(1, sizeof(struct mdoc)); - - p->data = data; - (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb)); - - p->htab = mdoc_tokhash_alloc(); - return(p); + if (mdoc->first) + mdoc_node_freelist(mdoc->first); + if (mdoc->meta.title) + free(mdoc->meta.title); + if (mdoc->meta.os) + free(mdoc->meta.os); + if (mdoc->meta.name) + free(mdoc->meta.name); + if (mdoc->meta.arch) + free(mdoc->meta.arch); + if (mdoc->meta.vol) + free(mdoc->meta.vol); } -int -mdoc_endparse(struct mdoc *mdoc) +/* + * Allocate all volatile resources (parse tree, meta-data, fields). + */ +static int +mdoc_alloc1(struct mdoc *mdoc) { - if (MDOC_HALT & mdoc->flags) + bzero(&mdoc->meta, sizeof(struct mdoc_meta)); + mdoc->flags = 0; + mdoc->lastnamed = mdoc->lastsec = SEC_NONE; + mdoc->last = calloc(1, sizeof(struct mdoc_node)); + if (NULL == mdoc->last) return(0); - if (NULL == mdoc->first) - return(1); - assert(mdoc->last); - if ( ! macro_end(mdoc)) { - mdoc->flags |= MDOC_HALT; - return(0); - } + mdoc->first = mdoc->last; + mdoc->last->type = MDOC_ROOT; + mdoc->next = MDOC_NEXT_CHILD; return(1); } +/* + * Free up volatile resources (see mdoc_free1()) then re-initialises the + * data with mdoc_alloc1(). After invocation, parse data has been reset + * and the parser is ready for re-invocation on a new tree; however, + * cross-parse non-volatile data is kept intact. + */ int -mdoc_parseln(struct mdoc *mdoc, int line, char *buf) +mdoc_reset(struct mdoc *mdoc) { - int c, i; - char tmp[5]; - if (MDOC_HALT & mdoc->flags) - return(0); + mdoc_free1(mdoc); + return(mdoc_alloc1(mdoc)); +} - if ('.' != *buf) { - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, -1, 0, ERR_SYNTAX_NOTEXT)); - mdoc_word_alloc(mdoc, 0, buf); - mdoc->next = MDOC_NEXT_SIBLING; - return(1); - } - if (buf[1] && '\\' == buf[1]) - if (buf[2] && '\"' == buf[2]) - return(1); +/* + * Completely free up all volatile and non-volatile parse resources. + * After invocation, the pointer is no longer usable. + */ +void +mdoc_free(struct mdoc *mdoc) +{ - i = 1; - while (buf[i] && ! isspace(buf[i]) && i < (int)sizeof(tmp)) - i++; + mdoc_free1(mdoc); + free(mdoc); +} - if (i == (int)sizeof(tmp)) { - mdoc->flags |= MDOC_HALT; - return(mdoc_err(mdoc, -1, 1, ERR_MACRO_NOTSUP)); - } else if (i <= 2) { - mdoc->flags |= MDOC_HALT; - return(mdoc_err(mdoc, -1, 1, ERR_MACRO_NOTSUP)); - } - i--; +/* + * Allocate volatile and non-volatile parse resources. + */ +struct mdoc * +mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb) +{ + struct mdoc *p; - (void)memcpy(tmp, buf + 1, (size_t)i); - tmp[i++] = 0; + if (NULL == (p = calloc(1, sizeof(struct mdoc)))) + return(NULL); + if (cb) + (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb)); - if (MDOC_MAX == (c = mdoc_find(mdoc, tmp))) { - mdoc->flags |= MDOC_HALT; - return(mdoc_err(mdoc, c, 1, ERR_MACRO_NOTSUP)); - } + mdoc_hash_init(); - while (buf[i] && isspace(buf[i])) - i++; + p->data = data; + p->pflags = pflags; - if ( ! mdoc_macro(mdoc, c, line, 1, &i, buf)) { - mdoc->flags |= MDOC_HALT; - return(0); - } - return(1); + if (mdoc_alloc1(p)) + return(p); + + free(p); + return(NULL); } -void -mdoc_msg(struct mdoc *mdoc, int pos, const char *fmt, ...) +/* + * Climb back up the parse tree, validating open scopes. Mostly calls + * through to macro_end() in macro.c. + */ +int +mdoc_endparse(struct mdoc *m) { - va_list ap; - char buf[256]; - if (NULL == mdoc->cb.mdoc_msg) - return; + if (MDOC_HALT & m->flags) + return(0); + else if (mdoc_macroend(m)) + return(1); + m->flags |= MDOC_HALT; + return(0); +} - va_start(ap, fmt); - (void)vsnprintf(buf, sizeof(buf), fmt, ap); - va_end(ap); - (*mdoc->cb.mdoc_msg)(mdoc->data, pos, buf); +/* + * Main parse routine. Parses a single line -- really just hands off to + * the macro (parsemacro()) or text parser (parsetext()). + */ +int +mdoc_parseln(struct mdoc *m, int ln, char *buf) +{ + + if (MDOC_HALT & m->flags) + return(0); + + return('.' == *buf ? parsemacro(m, ln, buf) : + parsetext(m, ln, buf)); } int -mdoc_err(struct mdoc *mdoc, int tok, int pos, enum mdoc_err type) +mdoc_verr(struct mdoc *mdoc, int ln, int pos, + const char *fmt, ...) { + char buf[256]; + va_list ap; if (NULL == mdoc->cb.mdoc_err) return(0); - return((*mdoc->cb.mdoc_err)(mdoc->data, tok, pos, type)); + + va_start(ap, fmt); + (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); + va_end(ap); + + return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf)); } int -mdoc_warn(struct mdoc *mdoc, int tok, int pos, enum mdoc_warn type) +mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...) { + char buf[256]; + va_list ap; if (NULL == mdoc->cb.mdoc_warn) return(0); - return((*mdoc->cb.mdoc_warn)(mdoc->data, tok, pos, type)); + + va_start(ap, fmt); + (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap); + va_end(ap); + + return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf)); } int -mdoc_macro(struct mdoc *mdoc, int tok, - int line, int ppos, int *pos, char *buf) +mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type) { + const char *p; - if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && - SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + p = __mdoc_merrnames[(int)type]; + assert(p); - if (NULL == (mdoc_macros[tok].fp)) { - (void)mdoc_err(mdoc, tok, ppos, ERR_MACRO_NOTSUP); - return(0); - } + if (iserr) + return(mdoc_verr(m, line, pos, p)); - if (1 != ppos && ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) { - (void)mdoc_err(mdoc, tok, ppos, ERR_MACRO_NOTCALL); - return(0); - } + return(mdoc_vwarn(m, line, pos, p)); +} - return((*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf)); + +int +mdoc_macro(struct mdoc *m, int tok, + int ln, int pp, int *pos, char *buf) +{ + /* + * If we're in the prologue, deny "body" macros. Similarly, if + * we're in the body, deny prologue calls. + */ + if (MDOC_PROLOGUE & mdoc_macros[tok].flags && + MDOC_PBODY & m->flags) + return(mdoc_perr(m, ln, pp, EPROLBODY)); + if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && + ! (MDOC_PBODY & m->flags)) + return(mdoc_perr(m, ln, pp, EBODYPROL)); + + return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf)); } -static void -mdoc_node_append(struct mdoc *mdoc, int pos, struct mdoc_node *p) +static int +node_append(struct mdoc *mdoc, struct mdoc_node *p) { - const char *nn, *on, *nt, *ot, *act; - switch (p->type) { - case (MDOC_TEXT): - nn = p->data.text.string; - nt = "text"; + assert(mdoc->last); + assert(mdoc->first); + assert(MDOC_ROOT != p->type); + + switch (mdoc->next) { + case (MDOC_NEXT_SIBLING): + mdoc->last->next = p; + p->prev = mdoc->last; + p->parent = mdoc->last->parent; break; - case (MDOC_BODY): - nn = mdoc_macronames[p->data.body.tok]; - nt = "body"; + case (MDOC_NEXT_CHILD): + mdoc->last->child = p; + p->parent = mdoc->last; break; - case (MDOC_ELEM): - nn = mdoc_macronames[p->data.elem.tok]; - nt = "elem"; - break; - case (MDOC_HEAD): - nn = mdoc_macronames[p->data.head.tok]; - nt = "head"; - break; - case (MDOC_TAIL): - nn = mdoc_macronames[p->data.tail.tok]; - nt = "tail"; - break; - case (MDOC_BLOCK): - nn = mdoc_macronames[p->data.block.tok]; - nt = "block"; - break; default: abort(); /* NOTREACHED */ } - if (NULL == mdoc->first) { - assert(NULL == mdoc->last); - mdoc->first = p; - mdoc->last = p; - mdoc_msg(mdoc, pos, "parse: root %s `%s'", nt, nn); - return; - } + p->parent->nchild++; - switch (mdoc->last->type) { - case (MDOC_TEXT): - on = ""; - ot = "text"; - break; - case (MDOC_BODY): - on = mdoc_macronames[mdoc->last->data.body.tok]; - ot = "body"; - break; - case (MDOC_ELEM): - on = mdoc_macronames[mdoc->last->data.elem.tok]; - ot = "elem"; - break; + if ( ! mdoc_valid_pre(mdoc, p)) + return(0); + if ( ! mdoc_action_pre(mdoc, p)) + return(0); + + switch (p->type) { case (MDOC_HEAD): - on = mdoc_macronames[mdoc->last->data.head.tok]; - ot = "head"; + assert(MDOC_BLOCK == p->parent->type); + p->parent->head = p; break; case (MDOC_TAIL): - on = mdoc_macronames[mdoc->last->data.tail.tok]; - ot = "tail"; + assert(MDOC_BLOCK == p->parent->type); + p->parent->tail = p; break; - case (MDOC_BLOCK): - on = mdoc_macronames[mdoc->last->data.block.tok]; - ot = "block"; + case (MDOC_BODY): + assert(MDOC_BLOCK == p->parent->type); + p->parent->body = p; break; default: - abort(); - /* NOTREACHED */ + break; } - switch (mdoc->next) { - case (MDOC_NEXT_SIBLING): - mdoc->last->next = p; - p->prev = mdoc->last; - p->parent = mdoc->last->parent; - act = "sibling"; + mdoc->last = p; + + switch (p->type) { + case (MDOC_TEXT): + if ( ! mdoc_valid_post(mdoc)) + return(0); + if ( ! mdoc_action_post(mdoc)) + return(0); break; - case (MDOC_NEXT_CHILD): - mdoc->last->child = p; - p->parent = mdoc->last; - act = "child"; - break; default: - abort(); - /* NOTREACHED */ + break; } - mdoc_msg(mdoc, pos, "parse: %s `%s' %s of %s `%s'", - nt, nn, act, ot, on); - - mdoc->last = p; + return(1); } -void -mdoc_tail_alloc(struct mdoc *mdoc, int pos, int tok) +static struct mdoc_node * +node_alloc(struct mdoc *m, int line, + int pos, int tok, enum mdoc_type type) { struct mdoc_node *p; - assert(mdoc->first); - assert(mdoc->last); + if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) { + (void)mdoc_nerr(m, m->last, EMALLOC); + return(NULL); + } - p = xcalloc(1, sizeof(struct mdoc_node)); + p->sec = m->lastsec; + p->line = line; + p->pos = pos; + p->tok = tok; + if (MDOC_TEXT != (p->type = type)) + assert(p->tok >= 0); - p->type = MDOC_TAIL; - p->data.tail.tok = tok; - - mdoc_node_append(mdoc, pos, p); + return(p); } -void -mdoc_head_alloc(struct mdoc *mdoc, int pos, int tok) +int +mdoc_tail_alloc(struct mdoc *m, int line, int pos, int tok) { struct mdoc_node *p; - assert(mdoc->first); - assert(mdoc->last); - - p = xcalloc(1, sizeof(struct mdoc_node)); - - p->type = MDOC_HEAD; - p->data.head.tok = tok; - - mdoc_node_append(mdoc, pos, p); + p = node_alloc(m, line, pos, tok, MDOC_TAIL); + if (NULL == p) + return(0); + if ( ! node_append(m, p)) + return(0); + m->next = MDOC_NEXT_CHILD; + return(1); } -void -mdoc_body_alloc(struct mdoc *mdoc, int pos, int tok) +int +mdoc_head_alloc(struct mdoc *m, int line, int pos, int tok) { struct mdoc_node *p; - assert(mdoc->first); - assert(mdoc->last); + assert(m->first); + assert(m->last); - p = xcalloc(1, sizeof(struct mdoc_node)); - - p->type = MDOC_BODY; - p->data.body.tok = tok; - - mdoc_node_append(mdoc, pos, p); + p = node_alloc(m, line, pos, tok, MDOC_HEAD); + if (NULL == p) + return(0); + if ( ! node_append(m, p)) + return(0); + m->next = MDOC_NEXT_CHILD; + return(1); } -void -mdoc_block_alloc(struct mdoc *mdoc, int pos, int tok, - size_t argsz, const struct mdoc_arg *args) +int +mdoc_body_alloc(struct mdoc *m, int line, int pos, int tok) { struct mdoc_node *p; - p = xcalloc(1, sizeof(struct mdoc_node)); - - p->type = MDOC_BLOCK; - p->data.block.tok = tok; - p->data.block.argc = argsz; - p->data.block.argv = argdup(argsz, args); - - mdoc_node_append(mdoc, pos, p); + p = node_alloc(m, line, pos, tok, MDOC_BODY); + if (NULL == p) + return(0); + if ( ! node_append(m, p)) + return(0); + m->next = MDOC_NEXT_CHILD; + return(1); } -void -mdoc_elem_alloc(struct mdoc *mdoc, int pos, int tok, - size_t argsz, const struct mdoc_arg *args) +int +mdoc_block_alloc(struct mdoc *m, int line, int pos, + int tok, struct mdoc_arg *args) { struct mdoc_node *p; - p = xcalloc(1, sizeof(struct mdoc_node)); - p->type = MDOC_ELEM; - p->data.elem.tok = tok; - p->data.elem.argc = argsz; - p->data.elem.argv = argdup(argsz, args); - - mdoc_node_append(mdoc, pos, p); + p = node_alloc(m, line, pos, tok, MDOC_BLOCK); + if (NULL == p) + return(0); + p->args = args; + if (p->args) + (args->refcnt)++; + if ( ! node_append(m, p)) + return(0); + m->next = MDOC_NEXT_CHILD; + return(1); } -void -mdoc_word_alloc(struct mdoc *mdoc, int pos, const char *word) +int +mdoc_elem_alloc(struct mdoc *m, int line, int pos, + int tok, struct mdoc_arg *args) { struct mdoc_node *p; - p = xcalloc(1, sizeof(struct mdoc_node)); - p->type = MDOC_TEXT; - p->data.text.string = xstrdup(word); - - mdoc_node_append(mdoc, pos, p); + p = node_alloc(m, line, pos, tok, MDOC_ELEM); + if (NULL == p) + return(0); + p->args = args; + if (p->args) + (args->refcnt)++; + if ( ! node_append(m, p)) + return(0); + m->next = MDOC_NEXT_CHILD; + return(1); } -static void -argfree(size_t sz, struct mdoc_arg *p) +static int +pstring(struct mdoc *m, int line, int pos, const char *p, size_t len) { - int i, j; + struct mdoc_node *n; + size_t sv; - if (0 == sz) - return; + n = node_alloc(m, line, pos, -1, MDOC_TEXT); + if (NULL == n) + return(mdoc_nerr(m, m->last, EMALLOC)); - assert(p); - /* LINTED */ - for (i = 0; i < (int)sz; i++) - if (p[i].sz > 0) { - assert(p[i].value); - /* LINTED */ - for (j = 0; j < (int)p[i].sz; j++) - free(p[i].value[j]); - free(p[i].value); - } - free(p); -} + n->string = malloc(len + 1); + if (NULL == n->string) { + free(n); + return(mdoc_nerr(m, m->last, EMALLOC)); + } + sv = strlcpy(n->string, p, len + 1); -static void -mdoc_elem_free(struct mdoc_elem *p) -{ + /* Prohibit truncation. */ + assert(sv < len + 1); - argfree(p->argc, p->argv); + if ( ! node_append(m, n)) + return(0); + m->next = MDOC_NEXT_SIBLING; + return(1); } -static void -mdoc_block_free(struct mdoc_block *p) +int +mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p) { - argfree(p->argc, p->argv); + return(pstring(m, line, pos, p, strlen(p))); } -static void -mdoc_text_free(struct mdoc_text *p) -{ - - if (p->string) - free(p->string); -} - - void mdoc_node_free(struct mdoc_node *p) { - switch (p->type) { - case (MDOC_TEXT): - mdoc_text_free(&p->data.text); - break; - case (MDOC_ELEM): - mdoc_elem_free(&p->data.elem); - break; - case (MDOC_BLOCK): - mdoc_block_free(&p->data.block); - break; - default: - break; - } - + if (p->parent) + p->parent->nchild--; + if (p->string) + free(p->string); + if (p->args) + mdoc_argv_free(p->args); free(p); } -static void +void mdoc_node_freelist(struct mdoc_node *p) { @@ -652,45 +599,158 @@ mdoc_node_freelist(struct mdoc_node *p) if (p->next) mdoc_node_freelist(p->next); + assert(0 == p->nchild); mdoc_node_free(p); } -int -mdoc_find(const struct mdoc *mdoc, const char *key) +/* + * Parse free-form text, that is, a line that does not begin with the + * control character. + */ +static int +parsetext(struct mdoc *m, int line, char *buf) { + int i, j; - return(mdoc_tokhash_find(mdoc->htab, key)); + if (SEC_NONE == m->lastnamed) + return(mdoc_perr(m, line, 0, ETEXTPROL)); + + /* + * If in literal mode, then pass the buffer directly to the + * back-end, as it should be preserved as a single term. + */ + + if (MDOC_LITERAL & m->flags) + return(mdoc_word_alloc(m, line, 0, buf)); + + /* Disallow blank/white-space lines in non-literal mode. */ + + for (i = 0; ' ' == buf[i]; i++) + /* Skip leading whitespace. */ ; + if (0 == buf[i]) + return(mdoc_perr(m, line, 0, ENOBLANK)); + + /* + * Break apart a free-form line into tokens. Spaces are + * stripped out of the input. + */ + + for (j = i; buf[i]; i++) { + if (' ' != buf[i]) + continue; + + /* Escaped whitespace. */ + if (i && ' ' == buf[i] && '\\' == buf[i - 1]) + continue; + + buf[i++] = 0; + if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j))) + return(0); + + for ( ; ' ' == buf[i]; i++) + /* Skip trailing whitespace. */ ; + + j = i; + if (0 == buf[i]) + break; + } + + if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j))) + return(0); + + m->next = MDOC_NEXT_SIBLING; + return(1); } -static void -argcpy(struct mdoc_arg *dst, const struct mdoc_arg *src) -{ - int i; - dst->arg = src->arg; - if (0 == (dst->sz = src->sz)) - return; - dst->value = xcalloc(dst->sz, sizeof(char *)); - for (i = 0; i < (int)dst->sz; i++) - dst->value[i] = xstrdup(src->value[i]); +static int +macrowarn(struct mdoc *m, int ln, const char *buf) +{ + if ( ! (MDOC_IGN_MACRO & m->pflags)) + return(mdoc_verr(m, ln, 0, + "unknown macro: %s%s", + buf, strlen(buf) > 3 ? "..." : "")); + return(mdoc_vwarn(m, ln, 0, "unknown macro: %s%s", + buf, strlen(buf) > 3 ? "..." : "")); } -static struct mdoc_arg * -argdup(size_t argsz, const struct mdoc_arg *args) +/* + * Parse a macro line, that is, a line beginning with the control + * character. + */ +int +parsemacro(struct mdoc *m, int ln, char *buf) { - struct mdoc_arg *pp; - int i; + int i, j, c; + char mac[5]; - if (0 == argsz) - return(NULL); + /* Empty lines are ignored. */ - pp = xcalloc((size_t)argsz, sizeof(struct mdoc_arg)); - for (i = 0; i < (int)argsz; i++) - argcpy(&pp[i], &args[i]); + if (0 == buf[1]) + return(1); - return(pp); + i = 1; + + /* Accept whitespace after the initial control char. */ + + if (' ' == buf[i]) { + i++; + while (buf[i] && ' ' == buf[i]) + i++; + if (0 == buf[i]) + return(1); + } + + /* Copy the first word into a nil-terminated buffer. */ + + for (j = 0; j < 4; j++, i++) { + if (0 == (mac[j] = buf[i])) + break; + else if (' ' == buf[i]) + break; + + /* Check for invalid characters. */ + + if (isgraph((u_char)buf[i])) + continue; + return(mdoc_perr(m, ln, i, EPRINT)); + } + + mac[j] = 0; + + if (j == 4 || j < 2) { + if ( ! macrowarn(m, ln, mac)) + goto err; + return(1); + } + + if (MDOC_MAX == (c = mdoc_hash_find(mac))) { + if ( ! macrowarn(m, ln, mac)) + goto err; + return(1); + } + + /* The macro is sane. Jump to the next word. */ + + while (buf[i] && ' ' == buf[i]) + i++; + + /* + * Begin recursive parse sequence. Since we're at the start of + * the line, we don't need to do callable/parseable checks. + */ + if ( ! mdoc_macro(m, c, ln, 1, &i, buf)) + goto err; + + return(1); + +err: /* Error out. */ + + m->flags |= MDOC_HALT; + return(0); } +