=================================================================== RCS file: /cvs/mandoc/mdoc.c,v retrieving revision 1.117 retrieving revision 1.256 diff -u -p -r1.117 -r1.256 --- mandoc/mdoc.c 2010/03/31 07:13:53 1.117 +++ mandoc/mdoc.c 2015/10/30 19:04:16 1.256 @@ -1,22 +1,21 @@ -/* $Id: mdoc.c,v 1.117 2010/03/31 07:13:53 kristaps Exp $ */ +/* $Id: mdoc.c,v 1.256 2015/10/30 19:04:16 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2010, 2012-2015 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 @@ -26,66 +25,18 @@ #include #include #include +#include -#include "libmdoc.h" +#include "mandoc_aux.h" +#include "mandoc.h" +#include "roff.h" +#include "mdoc.h" #include "libmandoc.h" +#include "roff_int.h" +#include "libmdoc.h" -const char *const __mdoc_merrnames[MERRMAX] = { - "trailing whitespace", /* ETAILWS */ - "unexpected quoted parameter", /* EQUOTPARM */ - "unterminated quoted parameter", /* EQUOTTERM */ - "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] = { +const char *const __mdoc_macronames[MDOC_MAX + 1] = { + "text", "Ap", "Dd", "Dt", "Os", "Sh", "Ss", "Pp", "D1", "Dl", "Bd", "Ed", "Bl", @@ -96,11 +47,8 @@ const char *const __mdoc_macronames[MDOC_MAX] = { "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", @@ -117,632 +65,425 @@ const char *const __mdoc_macronames[MDOC_MAX] = { "Bk", "Ek", "Bt", "Hf", "Fr", "Ud", "Lb", "Lp", "Lk", "Mt", "Brq", "Bro", - /* LINTED */ "Brc", "%C", "Es", "En", - /* LINTED */ "Dx", "%Q", "br", "sp", - /* LINTED */ - "%U" - }; + "%U", "Ta", "ll", +}; -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_macronames = __mdoc_macronames + 1; const char * const *mdoc_argnames = __mdoc_argnames; -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 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); +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). + * Main parse routine. Parses a single line -- really just hands off to + * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()). */ -static void -mdoc_free1(struct mdoc *mdoc) +int +mdoc_parseln(struct roff_man *mdoc, int ln, char *buf, int offs) { - 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); -} + if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line) + mdoc->flags |= MDOC_NEWLINE; + /* + * 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; -/* - * 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; + return roff_getcontrol(mdoc->roff, buf, &offs) ? + mdoc_pmacro(mdoc, ln, buf, offs) : + mdoc_ptext(mdoc, ln, buf, offs); } - -/* - * 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_macro(MACRO_PROT_ARGS) { + assert(tok > TOKEN_NONE && tok < MDOC_MAX); - mdoc_free1(mdoc); - mdoc_alloc1(mdoc); + (*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf); } - -/* - * 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_tail_alloc(struct roff_man *mdoc, int line, int pos, int tok) { + struct roff_node *p; - mdoc_free1(mdoc); - free(mdoc); + p = roff_node_alloc(mdoc, line, pos, ROFFT_TAIL, tok); + roff_node_append(mdoc, p); + mdoc->next = ROFF_NEXT_CHILD; } - -/* - * Allocate volatile and non-volatile parse resources. - */ -struct mdoc * -mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb) +struct roff_node * +mdoc_endbody_alloc(struct roff_man *mdoc, int line, int pos, int tok, + struct roff_node *body, enum mdoc_endbody end) { - struct mdoc *p; + struct roff_node *p; - p = mandoc_calloc(1, sizeof(struct mdoc)); - - if (cb) - memcpy(&p->cb, cb, sizeof(struct mdoc_cb)); - - p->data = data; - p->pflags = pflags; - - mdoc_hash_init(); - mdoc_alloc1(p); - return(p); + body->flags |= MDOC_ENDED; + body->parent->flags |= MDOC_ENDED; + p = roff_node_alloc(mdoc, line, pos, ROFFT_BODY, tok); + p->body = body; + p->norm = body->norm; + p->end = end; + roff_node_append(mdoc, p); + mdoc->next = ROFF_NEXT_SIBLING; + 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) +struct roff_node * +mdoc_block_alloc(struct roff_man *mdoc, int line, int pos, + int tok, struct mdoc_arg *args) { + struct roff_node *p; - if (MDOC_HALT & m->flags) - return(0); - else if (mdoc_macroend(m)) - return(1); - m->flags |= MDOC_HALT; - return(0); -} + p = roff_node_alloc(mdoc, line, pos, ROFFT_BLOCK, tok); + p->args = args; + if (p->args) + (args->refcnt)++; - -/* - * 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_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); - - 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_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); - - 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_err(struct mdoc *m, int line, int pos, int iserr, enum merr type) -{ - const char *p; - - p = __mdoc_merrnames[(int)type]; - assert(p); - - if (iserr) - return(mdoc_verr(m, line, pos, p)); - - return(mdoc_vwarn(m, line, pos, p)); -} - - -int -mdoc_macro(struct mdoc *m, enum mdoct tok, - int ln, int pp, int *pos, char *buf) -{ - - assert(tok < MDOC_MAX); - /* - * 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 int -node_append(struct mdoc *mdoc, struct mdoc_node *p) -{ - - 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; + 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, + int 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; - - 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); + switch (tok) { + case MDOC_An: + p->norm = mandoc_calloc(1, sizeof(union mdoc_data)); + break; + default: + break; + } + roff_node_append(mdoc, p); + mdoc->next = ROFF_NEXT_CHILD; } - -static int -pstring(struct mdoc *m, int line, int pos, const char *p, size_t len) -{ - struct mdoc_node *n; - size_t sv; - - n = node_alloc(m, line, pos, -1, 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); -} - - -int -mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p) -{ - - return(pstring(m, line, pos, p, strlen(p))); -} - - void -mdoc_node_free(struct mdoc_node *p) +mdoc_node_relink(struct roff_man *mdoc, struct roff_node *p) { - if (p->parent) - p->parent->nchild--; - if (p->string) - free(p->string); - if (p->args) - mdoc_argv_free(p->args); - free(p); + roff_node_unlink(mdoc, p); + p->prev = p->next = NULL; + roff_node_append(mdoc, p); } - -void -mdoc_node_freelist(struct mdoc_node *p) -{ - - if (p->child) - mdoc_node_freelist(p->child); - if (p->next) - mdoc_node_freelist(p->next); - - assert(0 == p->nchild); - mdoc_node_free(p); -} - - /* * 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) +mdoc_ptext(struct roff_man *mdoc, int line, char *buf, int offs) { - int i, j; - char sv; + struct roff_node *n; + char *c, *ws, *end; - if (SEC_NONE == m->lastnamed) - return(mdoc_perr(m, line, 0, ETEXTPROL)); - + assert(mdoc->last); + n = mdoc->last; + /* - * If in literal mode, then pass the buffer directly to the - * back-end, as it should be preserved as a single term. + * Divert directly to list processing if we're encountering a + * columnar ROFFT_BLOCK with or without a prior ROFFT_BLOCK entry + * (a ROFFT_BODY means it's already open, in which case we should + * process within its context in the normal way). */ - if (MDOC_LITERAL & m->flags) - return(mdoc_word_alloc(m, line, 0, buf)); + if (n->tok == MDOC_Bl && n->type == ROFFT_BODY && + n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) { + /* `Bl' is open without any children. */ + mdoc->flags |= MDOC_FREECOL; + mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf); + return 1; + } - /* Disallow blank/white-space lines in non-literal mode. */ + if (n->tok == MDOC_It && n->type == ROFFT_BLOCK && + NULL != n->parent && + MDOC_Bl == n->parent->tok && + LIST_column == n->parent->norm->Bl.type) { + /* `Bl' has block-level `It' children. */ + mdoc->flags |= MDOC_FREECOL; + mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf); + return 1; + } - 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. + * Search for the beginning of unescaped trailing whitespace (ws) + * and for the first character not to be output (end). */ - for (j = i; buf[i]; i++) { - if (' ' != buf[i]) + /* FIXME: replace with strcspn(). */ + ws = NULL; + for (c = end = buf + offs; *c; c++) { + switch (*c) { + case ' ': + if (NULL == ws) + ws = c; continue; + case '\t': + /* + * Always warn about trailing tabs, + * even outside literal context, + * where they should be put on the next line. + */ + if (NULL == ws) + ws = c; + /* + * Strip trailing tabs in literal context only; + * outside, they affect the next line. + */ + if (MDOC_LITERAL & mdoc->flags) + continue; + break; + case '\\': + /* Skip the escaped character, too, if any. */ + if (c[1]) + c++; + /* FALLTHROUGH */ + default: + ws = NULL; + break; + } + end = c + 1; + } + *end = '\0'; - /* Escaped whitespace. */ - if (i && ' ' == buf[i] && '\\' == buf[i - 1]) - continue; + if (ws) + mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse, + line, (int)(ws-buf), NULL); - sv = buf[i]; - buf[i++] = '\0'; + if (buf[offs] == '\0' && ! (mdoc->flags & MDOC_LITERAL)) { + mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse, + line, (int)(c - buf), NULL); - if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j))) - return(0); - - /* Trailing whitespace? Check at overwritten byte. */ - - if (' ' == sv && '\0' == buf[i]) - if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS)) - return(0); - - for ( ; ' ' == buf[i]; i++) - /* Skip trailing whitespace. */ ; - - j = i; - - /* Trailing whitespace? */ - - if (' ' == buf[i - 1] && '\0' == buf[i]) - if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS)) - return(0); - - if ('\0' == buf[i]) - break; + /* + * Insert a `sp' 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. + */ + roff_elem_alloc(mdoc, line, offs, MDOC_sp); + mdoc->last->flags |= MDOC_VALID | MDOC_ENDED; + mdoc->next = ROFF_NEXT_SIBLING; + return 1; } - if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j))) - return(0); + roff_word_alloc(mdoc, line, offs, buf+offs); - m->next = MDOC_NEXT_SIBLING; - return(1); -} + if (mdoc->flags & MDOC_LITERAL) + return 1; + /* + * End-of-sentence check. If the last character is an unescaped + * EOS character, then flag the node as being the end of a + * sentence. The front-end will know how to interpret this. + */ + assert(buf < end); -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 ? "..." : "")); + if (mandoc_eos(buf+offs, (size_t)(end-buf-offs))) + mdoc->last->flags |= MDOC_EOS; + return 1; } - /* * Parse a macro line, that is, a line beginning with the control * character. */ -int -parsemacro(struct mdoc *m, int ln, char *buf) +static int +mdoc_pmacro(struct roff_man *mdoc, int ln, char *buf, int offs) { - int i, j, c; + struct roff_node *n; + const char *cp; + int tok; + int i, sv; char mac[5]; - /* Empty lines are ignored. */ + sv = offs; - if ('\0' == buf[1]) - return(1); + /* + * Copy the first word into a nil-terminated buffer. + * Stop when a space, tab, escape, or eoln is encountered. + */ - i = 1; + i = 0; + while (i < 4 && strchr(" \t\\", buf[offs]) == NULL) + mac[i++] = buf[offs++]; - /* Accept whitespace after the initial control char. */ + mac[i] = '\0'; - if (' ' == buf[i]) { - i++; - while (buf[i] && ' ' == buf[i]) - i++; - if ('\0' == buf[i]) - return(1); + tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : TOKEN_NONE; + + if (tok == TOKEN_NONE) { + mandoc_msg(MANDOCERR_MACRO, mdoc->parse, + ln, sv, buf + sv - 1); + return 1; } - /* Copy the first word into a nil-terminated buffer. */ + /* Skip a leading escape sequence or tab. */ - for (j = 0; j < 4; j++, i++) { - if ('\0' == (mac[j] = buf[i])) - break; - else if (' ' == buf[i]) - break; + switch (buf[offs]) { + case '\\': + cp = buf + offs + 1; + mandoc_escape(&cp, NULL, NULL); + offs = cp - buf; + break; + case '\t': + offs++; + break; + default: + break; + } - /* Check for invalid characters. */ + /* Jump to the next non-whitespace word. */ - if (isgraph((u_char)buf[i])) - continue; - return(mdoc_perr(m, ln, i, EPRINT)); + while (buf[offs] && ' ' == buf[offs]) + offs++; + + /* + * 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[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 == mdoc->last || MDOC_It == tok || MDOC_El == tok) { + mdoc_macro(mdoc, tok, ln, sv, &offs, buf); + return 1; } - mac[j] = 0; + n = mdoc->last; + assert(mdoc->last); - 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); + /* + * If the first macro of a `Bl -column', open an `It' block + * context around the parsed macro. + */ + + if (n->tok == MDOC_Bl && n->type == ROFFT_BODY && + n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) { + mdoc->flags |= MDOC_FREECOL; + mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf); + return 1; } - /* The macro is sane. Jump to the next word. */ + /* + * 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. + */ - while (buf[i] && ' ' == buf[i]) - i++; + if (n->tok == MDOC_It && n->type == ROFFT_BLOCK && + NULL != n->parent && + MDOC_Bl == n->parent->tok && + LIST_column == n->parent->norm->Bl.type) { + mdoc->flags |= MDOC_FREECOL; + mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf); + return 1; + } - /* Trailing whitespace? */ + /* Normal processing of a macro. */ - if ('\0' == buf[i] && ' ' == buf[i - 1]) - if ( ! mdoc_pwarn(m, ln, i - 1, ETAILWS)) - goto err; + mdoc_macro(mdoc, tok, ln, sv, &offs, buf); - /* - * 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; + /* In quick mode (for mandocdb), abort after the NAME section. */ - return(1); + if (mdoc->quick && MDOC_Sh == tok && + SEC_NAME != mdoc->last->sec) + return 2; -err: /* Error out. */ + return 1; +} - m->flags |= MDOC_HALT; - return(0); +enum mdelim +mdoc_isdelim(const char *p) +{ + + 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); +}