=================================================================== RCS file: /cvs/mandoc/mdoc.c,v retrieving revision 1.144 retrieving revision 1.270 diff -u -p -r1.144 -r1.270 --- mandoc/mdoc.c 2010/05/31 20:14:10 1.144 +++ mandoc/mdoc.c 2018/12/04 02:53:51 1.270 @@ -1,22 +1,21 @@ -/* $Id: mdoc.c,v 1.144 2010/05/31 20:14:10 kristaps Exp $ */ +/* $Id: mdoc.c,v 1.270 2018/12/04 02:53:51 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2010, 2012-2018 Ingo Schwarze * * 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. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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. */ -#ifdef HAVE_CONFIG_H #include "config.h" -#endif #include @@ -28,561 +27,164 @@ #include #include +#include "mandoc_aux.h" #include "mandoc.h" -#include "libmdoc.h" +#include "roff.h" +#include "mdoc.h" #include "libmandoc.h" +#include "roff_int.h" +#include "libmdoc.h" -const char *const __mdoc_macronames[MDOC_MAX] = { - "Ap", "Dd", "Dt", "Os", - "Sh", "Ss", "Pp", "D1", - "Dl", "Bd", "Ed", "Bl", - "El", "It", "Ad", "An", - "Ar", "Cd", "Cm", "Dv", - "Er", "Ev", "Ex", "Fa", - "Fd", "Fl", "Fn", "Ft", - "Ic", "In", "Li", "Nd", - "Nm", "Op", "Ot", "Pa", - "Rv", "St", "Va", "Vt", - /* LINTED */ - "Xr", "%A", "%B", "%D", - /* LINTED */ - "%I", "%J", "%N", "%O", - /* LINTED */ - "%P", "%R", "%T", "%V", - "Ac", "Ao", "Aq", "At", - "Bc", "Bf", "Bo", "Bq", - "Bsx", "Bx", "Db", "Dc", - "Do", "Dq", "Ec", "Ef", - "Em", "Eo", "Fx", "Ms", - "No", "Ns", "Nx", "Ox", - "Pc", "Pf", "Po", "Pq", - "Qc", "Ql", "Qo", "Qq", - "Re", "Rs", "Sc", "So", - "Sq", "Sm", "Sx", "Sy", - "Tn", "Ux", "Xc", "Xo", - "Fo", "Fc", "Oo", "Oc", - "Bk", "Ek", "Bt", "Hf", - "Fr", "Ud", "Lb", "Lp", - "Lk", "Mt", "Brq", "Bro", - /* LINTED */ - "Brc", "%C", "Es", "En", - /* LINTED */ - "Dx", "%Q", "br", "sp", - /* LINTED */ - "%U", "Ta" - }; - -const char *const __mdoc_argnames[MDOC_ARG_MAX] = { +const char *const __mdoc_argnames[MDOC_ARG_MAX] = { "split", "nosplit", "ragged", - "unfilled", "literal", "file", - "offset", "bullet", "dash", - "hyphen", "item", "enum", - "tag", "diag", "hang", - "ohang", "inset", "column", - "width", "compact", "std", + "unfilled", "literal", "file", + "offset", "bullet", "dash", + "hyphen", "item", "enum", + "tag", "diag", "hang", + "ohang", "inset", "column", + "width", "compact", "std", "filled", "words", "emphasis", "symbolic", "nested", "centered" - }; - -const char * const *mdoc_macronames = __mdoc_macronames; +}; const char * const *mdoc_argnames = __mdoc_argnames; -static void mdoc_node_free(struct mdoc_node *); -static void mdoc_node_unlink(struct mdoc *, - struct mdoc_node *); -static void mdoc_free1(struct mdoc *); -static void mdoc_alloc1(struct mdoc *); -static struct mdoc_node *node_alloc(struct mdoc *, int, int, - enum mdoct, enum mdoc_type); -static int node_append(struct mdoc *, - struct mdoc_node *); -static int mdoc_ptext(struct mdoc *, int, char *, int); -static int mdoc_pmacro(struct mdoc *, int, char *, int); -static int macrowarn(struct mdoc *, int, - const char *, int); +static int mdoc_ptext(struct roff_man *, int, char *, int); +static int mdoc_pmacro(struct roff_man *, int, char *, int); -const struct mdoc_node * -mdoc_node(const struct mdoc *m) -{ - - return(MDOC_HALT & m->flags ? NULL : m->first); -} - - -const struct mdoc_meta * -mdoc_meta(const struct mdoc *m) -{ - - return(MDOC_HALT & m->flags ? NULL : &m->meta); -} - - /* - * Frees volatile resources (parse tree, meta-data, fields). - */ -static void -mdoc_free1(struct mdoc *mdoc) -{ - - if (mdoc->first) - mdoc_node_delete(mdoc, 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); - if (mdoc->meta.msec) - free(mdoc->meta.msec); -} - - -/* - * Allocate all volatile resources (parse tree, meta-data, fields). - */ -static void -mdoc_alloc1(struct mdoc *mdoc) -{ - - memset(&mdoc->meta, 0, sizeof(struct mdoc_meta)); - mdoc->flags = 0; - mdoc->lastnamed = mdoc->lastsec = SEC_NONE; - mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node)); - mdoc->first = mdoc->last; - mdoc->last->type = MDOC_ROOT; - mdoc->next = MDOC_NEXT_CHILD; -} - - -/* - * 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. - */ -void -mdoc_reset(struct mdoc *mdoc) -{ - - mdoc_free1(mdoc); - mdoc_alloc1(mdoc); -} - - -/* - * Completely free up all volatile and non-volatile parse resources. - * After invocation, the pointer is no longer usable. - */ -void -mdoc_free(struct mdoc *mdoc) -{ - - mdoc_free1(mdoc); - free(mdoc); -} - - -/* - * Allocate volatile and non-volatile parse resources. - */ -struct mdoc * -mdoc_alloc(void *data, int pflags, mandocmsg msg) -{ - struct mdoc *p; - - p = mandoc_calloc(1, sizeof(struct mdoc)); - - p->msg = msg; - p->data = data; - p->pflags = pflags; - - mdoc_hash_init(); - mdoc_alloc1(p); - return(p); -} - - -/* - * Climb back up the parse tree, validating open scopes. Mostly calls - * through to macro_end() in macro.c. - */ -int -mdoc_endparse(struct mdoc *m) -{ - - if (MDOC_HALT & m->flags) - return(0); - else if (mdoc_macroend(m)) - return(1); - m->flags |= MDOC_HALT; - return(0); -} - - -/* * Main parse routine. Parses a single line -- really just hands off to * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()). */ int -mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs) +mdoc_parseln(struct roff_man *mdoc, int ln, char *buf, int offs) { - if (MDOC_HALT & m->flags) - return(0); + if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line) + mdoc->flags |= MDOC_NEWLINE; - m->flags |= MDOC_NEWLINE; - return(('.' == buf[offs] || '\'' == buf[offs]) ? - mdoc_pmacro(m, ln, buf, offs) : - mdoc_ptext(m, ln, buf, offs)); + /* + * Let the roff nS register switch SYNOPSIS mode early, + * such that the parser knows at all times + * whether this mode is on or off. + * Note that this mode is also switched by the Sh macro. + */ + if (roff_getreg(mdoc->roff, "nS")) + mdoc->flags |= MDOC_SYNOPSIS; + else + mdoc->flags &= ~MDOC_SYNOPSIS; + + return roff_getcontrol(mdoc->roff, buf, &offs) ? + mdoc_pmacro(mdoc, ln, buf, offs) : + mdoc_ptext(mdoc, ln, buf, offs); } - -int -mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t, - int ln, int pos, const char *fmt, ...) +void +mdoc_tail_alloc(struct roff_man *mdoc, int line, int pos, enum roff_tok tok) { - char buf[256]; - va_list ap; + struct roff_node *p; - va_start(ap, fmt); - vsnprintf(buf, sizeof(buf) - 1, fmt, ap); - va_end(ap); - - return((*mdoc->msg)(t, mdoc->data, ln, pos, buf)); + p = roff_node_alloc(mdoc, line, pos, ROFFT_TAIL, tok); + roff_node_append(mdoc, p); + mdoc->next = ROFF_NEXT_CHILD; } - -int -mdoc_macro(struct mdoc *m, enum mdoct tok, - int ln, int pp, int *pos, char *buf) +struct roff_node * +mdoc_endbody_alloc(struct roff_man *mdoc, int line, int pos, + enum roff_tok tok, struct roff_node *body) { - assert(tok < MDOC_MAX); + struct roff_node *p; - /* If we're in the body, deny prologue calls. */ - - if (MDOC_PROLOGUE & mdoc_macros[tok].flags && - MDOC_PBODY & m->flags) - return(mdoc_pmsg(m, ln, pp, MANDOCERR_BADBODY)); - - /* If we're in the prologue, deny "body" macros. */ - - if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && - ! (MDOC_PBODY & m->flags)) { - if ( ! mdoc_pmsg(m, ln, pp, MANDOCERR_BADPROLOG)) - return(0); - if (NULL == m->meta.title) - m->meta.title = mandoc_strdup("UNKNOWN"); - if (NULL == m->meta.vol) - m->meta.vol = mandoc_strdup("LOCAL"); - if (NULL == m->meta.os) - m->meta.os = mandoc_strdup("LOCAL"); - if (0 == m->meta.date) - m->meta.date = time(NULL); - m->flags |= MDOC_PBODY; - } - - return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf)); + body->flags |= NODE_ENDED; + body->parent->flags |= NODE_ENDED; + p = roff_node_alloc(mdoc, line, pos, ROFFT_BODY, tok); + p->body = body; + p->norm = body->norm; + p->end = ENDBODY_SPACE; + roff_node_append(mdoc, p); + mdoc->next = ROFF_NEXT_SIBLING; + return p; } - -static int -node_append(struct mdoc *mdoc, struct mdoc_node *p) +struct roff_node * +mdoc_block_alloc(struct roff_man *mdoc, int line, int pos, + enum roff_tok tok, struct mdoc_arg *args) { + struct roff_node *p; - assert(mdoc->last); - assert(mdoc->first); - assert(MDOC_ROOT != p->type); + p = roff_node_alloc(mdoc, line, pos, ROFFT_BLOCK, tok); + p->args = args; + if (p->args) + (args->refcnt)++; - switch (mdoc->next) { - case (MDOC_NEXT_SIBLING): - mdoc->last->next = p; - p->prev = mdoc->last; - p->parent = mdoc->last->parent; + switch (tok) { + case MDOC_Bd: + case MDOC_Bf: + case MDOC_Bl: + case MDOC_En: + case MDOC_Rs: + p->norm = mandoc_calloc(1, sizeof(union mdoc_data)); break; - case (MDOC_NEXT_CHILD): - mdoc->last->child = p; - p->parent = mdoc->last; - break; default: - abort(); - /* NOTREACHED */ - } - - p->parent->nchild++; - - if ( ! mdoc_valid_pre(mdoc, p)) - return(0); - if ( ! mdoc_action_pre(mdoc, p)) - return(0); - - switch (p->type) { - case (MDOC_HEAD): - assert(MDOC_BLOCK == p->parent->type); - p->parent->head = p; break; - case (MDOC_TAIL): - assert(MDOC_BLOCK == p->parent->type); - p->parent->tail = p; - break; - case (MDOC_BODY): - assert(MDOC_BLOCK == p->parent->type); - p->parent->body = p; - break; - default: - break; } - - mdoc->last = p; - - switch (p->type) { - case (MDOC_TEXT): - if ( ! mdoc_valid_post(mdoc)) - return(0); - if ( ! mdoc_action_post(mdoc)) - return(0); - break; - default: - break; - } - - return(1); + roff_node_append(mdoc, p); + mdoc->next = ROFF_NEXT_CHILD; + return p; } - -static struct mdoc_node * -node_alloc(struct mdoc *m, int line, int pos, - enum mdoct tok, enum mdoc_type type) +void +mdoc_elem_alloc(struct roff_man *mdoc, int line, int pos, + enum roff_tok tok, struct mdoc_arg *args) { - struct mdoc_node *p; + struct roff_node *p; - p = mandoc_calloc(1, sizeof(struct mdoc_node)); - p->sec = m->lastsec; - p->line = line; - p->pos = pos; - p->tok = tok; - p->type = type; - if (MDOC_NEWLINE & m->flags) - p->flags |= MDOC_LINE; - m->flags &= ~MDOC_NEWLINE; - return(p); -} - - -int -mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) -{ - struct mdoc_node *p; - - p = node_alloc(m, line, pos, tok, MDOC_TAIL); - if ( ! node_append(m, p)) - return(0); - m->next = MDOC_NEXT_CHILD; - return(1); -} - - -int -mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) -{ - struct mdoc_node *p; - - assert(m->first); - assert(m->last); - - p = node_alloc(m, line, pos, tok, MDOC_HEAD); - if ( ! node_append(m, p)) - return(0); - m->next = MDOC_NEXT_CHILD; - return(1); -} - - -int -mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok) -{ - struct mdoc_node *p; - - p = node_alloc(m, line, pos, tok, MDOC_BODY); - if ( ! node_append(m, p)) - return(0); - m->next = MDOC_NEXT_CHILD; - return(1); -} - - -int -mdoc_block_alloc(struct mdoc *m, int line, int pos, - enum mdoct tok, struct mdoc_arg *args) -{ - struct mdoc_node *p; - - p = node_alloc(m, line, pos, tok, MDOC_BLOCK); + p = roff_node_alloc(mdoc, line, pos, ROFFT_ELEM, tok); p->args = args; if (p->args) (args->refcnt)++; - if ( ! node_append(m, p)) - return(0); - m->next = MDOC_NEXT_CHILD; - return(1); -} - -int -mdoc_elem_alloc(struct mdoc *m, int line, int pos, - enum mdoct tok, struct mdoc_arg *args) -{ - struct mdoc_node *p; - - p = node_alloc(m, line, pos, tok, MDOC_ELEM); - p->args = args; - if (p->args) - (args->refcnt)++; - if ( ! node_append(m, p)) - return(0); - m->next = MDOC_NEXT_CHILD; - return(1); -} - - -int -mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p) -{ - struct mdoc_node *n; - size_t sv, len; - - len = strlen(p); - - n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT); - n->string = mandoc_malloc(len + 1); - sv = strlcpy(n->string, p, len + 1); - - /* Prohibit truncation. */ - assert(sv < len + 1); - - if ( ! node_append(m, n)) - return(0); - - m->next = MDOC_NEXT_SIBLING; - return(1); -} - - -void -mdoc_node_free(struct mdoc_node *p) -{ - - if (p->string) - free(p->string); - if (p->args) - mdoc_argv_free(p->args); - free(p); -} - - -static void -mdoc_node_unlink(struct mdoc *m, struct mdoc_node *n) -{ - - /* Adjust siblings. */ - - if (n->prev) - n->prev->next = n->next; - if (n->next) - n->next->prev = n->prev; - - /* Adjust parent. */ - - if (n->parent) { - n->parent->nchild--; - if (n->parent->child == n) - n->parent->child = n->prev ? n->prev : n->next; + switch (tok) { + case MDOC_An: + p->norm = mandoc_calloc(1, sizeof(union mdoc_data)); + break; + default: + break; } - - /* Adjust parse point, if applicable. */ - - if (m && m->last == n) { - if (n->prev) { - m->last = n->prev; - m->next = MDOC_NEXT_SIBLING; - } else { - m->last = n->parent; - m->next = MDOC_NEXT_CHILD; - } - } - - if (m && m->first == n) - m->first = NULL; + roff_node_append(mdoc, p); + mdoc->next = ROFF_NEXT_CHILD; } - -void -mdoc_node_delete(struct mdoc *m, struct mdoc_node *p) -{ - - while (p->child) { - assert(p->nchild); - mdoc_node_delete(m, p->child); - } - assert(0 == p->nchild); - - mdoc_node_unlink(m, p); - mdoc_node_free(p); -} - - /* * Parse free-form text, that is, a line that does not begin with the * control character. */ static int -mdoc_ptext(struct mdoc *m, int line, char *buf, int offs) +mdoc_ptext(struct roff_man *mdoc, int line, char *buf, int offs) { + struct roff_node *n; + const char *cp, *sp; char *c, *ws, *end; - struct mdoc_node *n; - /* Ignore bogus comments. */ + n = mdoc->last; - if ('\\' == buf[offs] && - '.' == buf[offs + 1] && - '"' == buf[offs + 2]) - return(mdoc_pmsg(m, line, offs, MANDOCERR_BADCOMMENT)); - - /* No text before an initial macro. */ - - if (SEC_NONE == m->lastnamed) - return(mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT)); - - assert(m->last); - n = m->last; - /* - * Divert directly to list processing if we're encountering a - * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry - * (a MDOC_BODY means it's already open, in which case we should - * process within its context in the normal way). + * If a column list contains plain text, assume an implicit item + * macro. This can happen one or more times at the beginning + * of such a list, intermixed with non-It mdoc macros and with + * nodes generated on the roff level, for example by tbl. */ - if (MDOC_Bl == n->tok && MDOC_BODY == n->type && - LIST_column == n->data.list) { - /* `Bl' is open without any children. */ - m->flags |= MDOC_FREECOL; - return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf)); + if ((n->tok == MDOC_Bl && n->type == ROFFT_BODY && + n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) || + (n->parent != NULL && n->parent->tok == MDOC_Bl && + n->parent->norm->Bl.type == LIST_column)) { + mdoc->flags |= MDOC_FREECOL; + (*mdoc_macro(MDOC_It)->fp)(mdoc, MDOC_It, + line, offs, &offs, buf); + return 1; } - if (MDOC_It == n->tok && MDOC_BLOCK == n->type && - NULL != n->parent && - MDOC_Bl == n->parent->tok && - LIST_column == n->parent->data.list) { - /* `Bl' has block-level `It' children. */ - m->flags |= MDOC_FREECOL; - return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf)); - } - /* * Search for the beginning of unescaped trailing whitespace (ws) * and for the first character not to be output (end). @@ -592,10 +194,6 @@ mdoc_ptext(struct mdoc *m, int line, char *buf, int of ws = NULL; for (c = end = buf + offs; *c; c++) { switch (*c) { - case '-': - if (mandoc_hyph(buf + offs, c)) - *c = ASCII_HYPH; - break; case ' ': if (NULL == ws) ws = c; @@ -612,7 +210,7 @@ mdoc_ptext(struct mdoc *m, int line, char *buf, int of * Strip trailing tabs in literal context only; * outside, they affect the next line. */ - if (MDOC_LITERAL & m->flags) + if (MDOC_LITERAL & mdoc->flags) continue; break; case '\\': @@ -629,30 +227,43 @@ mdoc_ptext(struct mdoc *m, int line, char *buf, int of *end = '\0'; if (ws) - if ( ! mdoc_pmsg(m, line, (int)(ws-buf), MANDOCERR_EOLNSPACE)) - return(0); + mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse, + line, (int)(ws-buf), NULL); - if ('\0' == buf[offs] && ! (MDOC_LITERAL & m->flags)) { - if ( ! mdoc_pmsg(m, line, (int)(c-buf), MANDOCERR_NOBLANKLN)) - return(0); + /* + * Blank lines are allowed in no-fill mode + * and cancel preceding \c, + * but add a single vertical space elsewhere. + */ - /* - * Insert a `Pp' in the case of a blank line. Technically, - * blank lines aren't allowed, but enough manuals assume this - * behaviour that we want to work around it. - */ - if ( ! mdoc_elem_alloc(m, line, offs, MDOC_Pp, NULL)) - return(0); - - m->next = MDOC_NEXT_SIBLING; - return(1); + if (buf[offs] == '\0' && ! (mdoc->flags & MDOC_LITERAL)) { + switch (mdoc->last->type) { + case ROFFT_TEXT: + sp = mdoc->last->string; + cp = end = strchr(sp, '\0') - 2; + if (cp < sp || cp[0] != '\\' || cp[1] != 'c') + break; + while (cp > sp && cp[-1] == '\\') + cp--; + if ((end - cp) % 2) + break; + *end = '\0'; + return 1; + default: + break; + } + mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse, + line, (int)(c - buf), NULL); + roff_elem_alloc(mdoc, line, offs, ROFF_sp); + mdoc->last->flags |= NODE_VALID | NODE_ENDED; + mdoc->next = ROFF_NEXT_SIBLING; + return 1; } - if ( ! mdoc_word_alloc(m, line, offs, buf+offs)) - return(0); + roff_word_alloc(mdoc, line, offs, buf+offs); - if (MDOC_LITERAL & m->flags) - return(1); + if (mdoc->flags & MDOC_LITERAL) + return 1; /* * End-of-sentence check. If the last character is an unescaped @@ -663,159 +274,171 @@ mdoc_ptext(struct mdoc *m, int line, char *buf, int of assert(buf < end); if (mandoc_eos(buf+offs, (size_t)(end-buf-offs))) - m->last->flags |= MDOC_EOS; + mdoc->last->flags |= NODE_EOS; - return(1); -} + for (c = buf + offs; c != NULL; c = strchr(c + 1, '.')) { + if (c - buf < offs + 2) + continue; + if (end - c < 3) + break; + if (c[1] != ' ' || + isalnum((unsigned char)c[-2]) == 0 || + isalnum((unsigned char)c[-1]) == 0 || + (c[-2] == 'n' && c[-1] == 'c') || + (c[-2] == 'v' && c[-1] == 's')) + continue; + c += 2; + if (*c == ' ') + c++; + if (*c == ' ') + c++; + if (isupper((unsigned char)(*c))) + mandoc_msg(MANDOCERR_EOS, mdoc->parse, + line, (int)(c - buf), NULL); + } - -static int -macrowarn(struct mdoc *m, int ln, const char *buf, int offs) -{ - int rc; - - rc = mdoc_vmsg(m, MANDOCERR_MACRO, ln, offs, - "unknown macro: %s%s", - buf, strlen(buf) > 3 ? "..." : ""); - - /* FIXME: logic should be in driver. */ - /* FIXME: broken, will error out and not omit a message. */ - return(MDOC_IGN_MACRO & m->pflags ? rc : 0); + return 1; } - /* * Parse a macro line, that is, a line beginning with the control * character. */ -int -mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs) +static int +mdoc_pmacro(struct roff_man *mdoc, int ln, char *buf, int offs) { - enum mdoct tok; - int i, j, sv; - char mac[5]; - struct mdoc_node *n; + struct roff_node *n; + const char *cp; + size_t sz; + enum roff_tok tok; + int sv; - /* Empty lines are ignored. */ + /* Determine the line macro. */ - offs++; - - if ('\0' == buf[offs]) - return(1); - - i = offs; - - /* Accept whitespace after the initial control char. */ - - if (' ' == buf[i]) { - i++; - while (buf[i] && ' ' == buf[i]) - i++; - if ('\0' == buf[i]) - return(1); + sv = offs; + tok = TOKEN_NONE; + for (sz = 0; sz < 4 && strchr(" \t\\", buf[offs]) == NULL; sz++) + offs++; + if (sz == 2 || sz == 3) + tok = roffhash_find(mdoc->mdocmac, buf + sv, sz); + if (tok == TOKEN_NONE) { + mandoc_msg(MANDOCERR_MACRO, mdoc->parse, + ln, sv, buf + sv - 1); + return 1; } - sv = i; + /* Skip a leading escape sequence or tab. */ - /* 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; - if ( ! mdoc_pmsg(m, ln, i, MANDOCERR_BADCHAR)) - return(0); - i--; + switch (buf[offs]) { + case '\\': + cp = buf + offs + 1; + mandoc_escape(&cp, NULL, NULL); + offs = cp - buf; + break; + case '\t': + offs++; + break; + default: + break; } - mac[j] = '\0'; + /* Jump to the next non-whitespace word. */ - if (j == 4 || j < 2) { - if ( ! macrowarn(m, ln, mac, sv)) - goto err; - return(1); - } - - if (MDOC_MAX == (tok = mdoc_hash_find(mac))) { - if ( ! macrowarn(m, ln, mac, sv)) - goto err; - return(1); - } + while (buf[offs] == ' ') + offs++; - /* The macro is sane. Jump to the next word. */ - - while (buf[i] && ' ' == buf[i]) - i++; - - /* + /* * Trailing whitespace. Note that tabs are allowed to be passed * into the parser as "text", so we only warn about spaces here. */ - if ('\0' == buf[i] && ' ' == buf[i - 1]) - if ( ! mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE)) - goto err; + if ('\0' == buf[offs] && ' ' == buf[offs - 1]) + mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse, + ln, offs - 1, NULL); /* * If an initial macro or a list invocation, divert directly * into macro processing. */ - if (NULL == m->last || MDOC_It == tok || MDOC_El == tok) { - if ( ! mdoc_macro(m, tok, ln, sv, &i, buf)) - goto err; - return(1); + n = mdoc->last; + if (n == NULL || tok == MDOC_It || tok == MDOC_El) { + (*mdoc_macro(tok)->fp)(mdoc, tok, ln, sv, &offs, buf); + return 1; } - n = m->last; - assert(m->last); - /* - * If the first macro of a `Bl -column', open an `It' block - * context around the parsed macro. + * If a column list contains a non-It macro, assume an implicit + * item macro. This can happen one or more times at the + * beginning of such a list, intermixed with text lines and + * with nodes generated on the roff level, for example by tbl. */ - if (MDOC_Bl == n->tok && MDOC_BODY == n->type && - LIST_column == n->data.list) { - m->flags |= MDOC_FREECOL; - if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf)) - goto err; - return(1); + if ((n->tok == MDOC_Bl && n->type == ROFFT_BODY && + n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) || + (n->parent != NULL && n->parent->tok == MDOC_Bl && + n->parent->norm->Bl.type == LIST_column)) { + mdoc->flags |= MDOC_FREECOL; + (*mdoc_macro(MDOC_It)->fp)(mdoc, MDOC_It, ln, sv, &sv, buf); + return 1; } - /* - * If we're following a block-level `It' within a `Bl -column' - * context (perhaps opened in the above block or in ptext()), - * then open an `It' block context around the parsed macro. - */ + /* Normal processing of a macro. */ - if (MDOC_It == n->tok && MDOC_BLOCK == n->type && - NULL != n->parent && - MDOC_Bl == n->parent->tok && - LIST_column == n->parent->data.list) { - m->flags |= MDOC_FREECOL; - if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf)) - goto err; - return(1); - } + (*mdoc_macro(tok)->fp)(mdoc, tok, ln, sv, &offs, buf); - /* Normal processing of a macro. */ + /* In quick mode (for mandocdb), abort after the NAME section. */ - if ( ! mdoc_macro(m, tok, ln, sv, &i, buf)) - goto err; + if (mdoc->quick && MDOC_Sh == tok && + SEC_NAME != mdoc->last->sec) + return 2; - return(1); + return 1; +} -err: /* Error out. */ +enum mdelim +mdoc_isdelim(const char *p) +{ - m->flags |= MDOC_HALT; - return(0); + if ('\0' == p[0]) + return DELIM_NONE; + + if ('\0' == p[1]) + switch (p[0]) { + case '(': + case '[': + return DELIM_OPEN; + case '|': + return DELIM_MIDDLE; + case '.': + case ',': + case ';': + case ':': + case '?': + case '!': + case ')': + case ']': + return DELIM_CLOSE; + default: + return DELIM_NONE; + } + + if ('\\' != p[0]) + return DELIM_NONE; + + if (0 == strcmp(p + 1, ".")) + return DELIM_CLOSE; + if (0 == strcmp(p + 1, "fR|\\fP")) + return DELIM_MIDDLE; + + return DELIM_NONE; } +void +mdoc_validate(struct roff_man *mdoc) +{ + mdoc->last = mdoc->first; + mdoc_node_validate(mdoc); + mdoc_state_reset(mdoc); +}