=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.4 retrieving revision 1.8 diff -u -p -r1.4 -r1.8 --- mandoc/Attic/validate.c 2008/11/30 18:50:44 1.4 +++ mandoc/Attic/validate.c 2008/12/30 13:43:53 1.8 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.4 2008/11/30 18:50:44 kristaps Exp $ */ +/* $Id: validate.c,v 1.8 2008/12/30 13:43:53 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -16,398 +16,1144 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ -#include - #include #include -#include -#include #include +#include #include +#ifdef __linux__ +#include +#endif -#include "libmdocml.h" #include "private.h" -#define INDENT 4 +/* FIXME: maxlineargs should be per LINE, no per TOKEN. */ +/* FIXME: prologue check should be in macro_call. */ -#ifdef __linux__ /* FIXME */ -#define strlcat strncat -#endif +#define _CC(p) ((const char **)p) -struct md_valid { - const struct md_args *args; - const struct md_rbuf *rbuf; - struct md_mbuf *mbuf; - struct rofftree *tree; +static int scope_rewind_exp(struct mdoc *, int, int, int); +static int scope_rewind_imp(struct mdoc *, int, int); +static int append_text(struct mdoc *, int, + int, int, char *[]); +static int append_const(struct mdoc *, int, int, int, char *[]); +static int append_constarg(struct mdoc *, int, int, + int, const struct mdoc_arg *); +static int append_scoped(struct mdoc *, int, int, int, + const char *[], int, const struct mdoc_arg *); +static int append_delims(struct mdoc *, int, int *, char *); - size_t indent; - size_t pos; - int flags; -#define MD_LITERAL (1 << 0) -}; +static int +append_delims(struct mdoc *mdoc, int tok, int *pos, char *buf) +{ + int c, lastarg; + char *p; -static void roffmsg(void *arg, enum roffmsg, - const char *, const char *, char *); -static int roffhead(void *); -static int rofftail(void *); -static int roffin(void *, int, int *, char **); -static int roffdata(void *, int, char *); -static int roffout(void *, int); -static int roffblkin(void *, int, int *, char **); -static int roffblkout(void *, int); -static int roffspecial(void *, int); + if (0 == buf[*pos]) + return(1); -static int mbuf_newline(struct md_valid *); -static int mbuf_indent(struct md_valid *); -static int mbuf_data(struct md_valid *, int, char *); + mdoc_msg(mdoc, *pos, "`%s' flushing punctuation", + mdoc_macronames[tok]); + for (;;) { + lastarg = *pos; + c = mdoc_args(mdoc, tok, pos, buf, 0, &p); + if (ARGS_ERROR == c) + return(0); + else if (ARGS_EOLN == c) + break; + assert(mdoc_isdelim(p)); + mdoc_word_alloc(mdoc, lastarg, p); + } + return(1); +} + + static int -mbuf_indent(struct md_valid *p) +scope_rewind_imp(struct mdoc *mdoc, int ppos, int tok) { - size_t i; + struct mdoc_node *n; + int t; - assert(p->pos == 0); + n = mdoc->last ? mdoc->last->parent : NULL; - for (i = 0; i < MIN(p->indent, INDENT); i++) - if ( ! md_buf_putstring(p->mbuf, " ")) - return(0); + /* LINTED */ + for ( ; n; n = n->parent) { + if (MDOC_BLOCK != n->type) + continue; + if (tok == (t = n->data.block.tok)) + break; + if ( ! (MDOC_EXPLICIT & mdoc_macros[t].flags)) + continue; + return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK)); + } - p->pos += i * INDENT; + if (n) { + mdoc->last = n; + mdoc_msg(mdoc, ppos, "scope: rewound implicit `%s'", + mdoc_macronames[tok]); + return(1); + } + + mdoc_msg(mdoc, ppos, "scope: new implicit `%s'", + mdoc_macronames[tok]); return(1); } static int -mbuf_newline(struct md_valid *p) +scope_rewind_exp(struct mdoc *mdoc, int ppos, int tok, int dst) { + struct mdoc_node *n; - if ( ! md_buf_putchar(p->mbuf, '\n')) - return(0); + assert(mdoc->last); - p->pos = 0; + /* LINTED */ + for (n = mdoc->last->parent; n; n = n->parent) { + if (MDOC_BLOCK != n->type) + continue; + if (dst == n->data.block.tok) + break; + return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK)); + } + + if (NULL == (mdoc->last = n)) + return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_NOCTX)); + + mdoc_msg(mdoc, ppos, "scope: rewound explicit `%s' to `%s'", + mdoc_macronames[tok], mdoc_macronames[dst]); + return(1); } static int -mbuf_data(struct md_valid *p, int space, char *buf) +append_constarg(struct mdoc *mdoc, int tok, int pos, + int argc, const struct mdoc_arg *argv) { - size_t sz; - char *bufp; - assert(p->mbuf); - assert(0 != p->indent); + switch (tok) { + default: + break; + } - if (MD_LITERAL & p->flags) - return(md_buf_putstring(p->mbuf, buf)); + mdoc_elem_alloc(mdoc, pos, tok, argc, argv, 0, NULL); + return(1); +} - while (*buf) { - while (*buf && isspace(*buf)) - buf++; - if (0 == *buf) +/* + * Append a node with implicit or explicit scoping ONLY. ALL macros + * with the implicit- or explicit-scope callback must be included here. + */ +static int +append_scoped(struct mdoc *mdoc, int tok, int pos, + int sz, const char *args[], + int argc, const struct mdoc_arg *argv) +{ + enum mdoc_sec sec; + struct mdoc_node *node; + + switch (tok) { + /* ======= ADD MORE MACRO CHECKS BELOW. ======= */ + + case (MDOC_Sh): + /* + * Check rules for section ordering. We can have + * "known" sections (like NAME and so on) and "custom" + * sections, which are unknown. If we have a known + * section, we should fall within the conventional + * section order. + */ + if (0 == sz) + return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1)); + + sec = mdoc_atosec((size_t)sz, _CC(args)); + if (SEC_CUSTOM != sec && sec < mdoc->sec_lastn) + if ( ! mdoc_warn(mdoc, tok, pos, WARN_SEC_OO)) + return(0); + + if (SEC_BODY == mdoc->sec_last && SEC_NAME != sec) + return(mdoc_err(mdoc, tok, pos, ERR_SEC_NAME)); + if (SEC_CUSTOM != sec) + mdoc->sec_lastn = sec; + mdoc->sec_last = sec; + break; + + case (MDOC_Ss): + if (0 != sz) break; + return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1)); + + case (MDOC_Bd): + /* + * We can't be nested within any other block displays + * (or really any other kind of display, although Bd is + * the only multi-line one that will show up). + */ + assert(mdoc->last); + node = mdoc->last->parent; + /* LINTED */ + for ( ; node; node = node->parent) { + if (node->type != MDOC_BLOCK) + continue; + if (node->data.block.tok != MDOC_Bd) + continue; + break; + } + if (NULL == node) + break; + return(mdoc_err(mdoc, tok, pos, ERR_SCOPE_NONEST)); - bufp = buf; - while (*buf && ! isspace(*buf)) - buf++; + case (MDOC_Bl): + break; - if (0 != *buf) - *buf++ = 0; + /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */ + default: + abort(); + /* NOTREACHED */ + } - /* Process word. */ + mdoc_block_alloc(mdoc, pos, tok, (size_t)argc, argv); + mdoc_head_alloc(mdoc, pos, tok, (size_t)sz, _CC(args)); + mdoc_body_alloc(mdoc, pos, tok); + return(1); +} - sz = strlen(bufp); - if (0 == p->pos) { - if ( ! mbuf_indent(p)) - return(0); - if ( ! md_buf_putstring(p->mbuf, bufp)) - return(0); +static int +append_const(struct mdoc *mdoc, int tok, + int pos, int sz, char *args[]) +{ - if (p->indent * INDENT + sz >= 72) { - if ( ! mbuf_newline(p)) - return(0); - continue; - } + switch (tok) { + /* ======= ADD MORE MACRO CHECKS BELOW. ======= */ - p->pos += sz; - continue; + /* FIXME: this is the ugliest part of this page. */ + case (MDOC_At): + /* This needs special handling. */ + if (0 == sz) + break; + else if (sz > 2) + return(mdoc_err(mdoc, tok, pos, ERR_ARGS_LE2)); + + if (ATT_DEFAULT != mdoc_atoatt(args[0])) { + mdoc_elem_alloc(mdoc, pos, tok, 0, + NULL, 1, _CC(&args[0])); + } else { + mdoc_elem_alloc(mdoc, pos, tok, + 0, NULL, 0, NULL); + if (mdoc_isdelim(args[0])) + return(mdoc_err(mdoc, tok, pos, ERR_SYNTAX_NOPUNCT)); + mdoc_word_alloc(mdoc, pos, args[0]); } - if (sz + p->pos >= 72) { - if ( ! mbuf_newline(p)) - return(0); - if ( ! mbuf_indent(p)) - return(0); - } else if (space) - if ( ! md_buf_putchar(p->mbuf, ' ')) - return(0); + if (1 == sz) + return(1); + if (mdoc_isdelim(args[1])) + return(mdoc_err(mdoc, tok, pos, ERR_SYNTAX_NOPUNCT)); + mdoc_word_alloc(mdoc, pos, args[1]); + return(1); - if ( ! md_buf_putstring(p->mbuf, bufp)) + case (MDOC_Nd): + if (sz > 0) + break; + if ( ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_GE1)) return(0); + break; + + case (MDOC_Hf): + if (1 == sz) + break; + return(mdoc_err(mdoc, tok, pos, ERR_ARGS_EQ1)); - p->pos += sz + (space ? 1 : 0); + case (MDOC_Bx): + /* FALLTHROUGH */ + case (MDOC_Bsx): + /* FALLTHROUGH */ + case (MDOC_Os): + /* FALLTHROUGH */ + case (MDOC_Fx): + /* FALLTHROUGH */ + case (MDOC_Nx): + assert(sz <= 1); + break; + + case (MDOC_Ux): + assert(0 == sz); + break; + + case (MDOC_Bt): + /* FALLTHROUGH */ + case (MDOC_Ud): + if (0 == sz) + break; + return(mdoc_err(mdoc, tok, pos, ERR_ARGS_EQ0)); + + /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */ + default: + abort(); + /* NOTREACHED */ } + mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, (size_t)sz, _CC(args)); return(1); } -int -md_line_valid(void *arg, char *buf) +static int +append_text(struct mdoc *mdoc, int tok, + int pos, int sz, char *args[]) { - struct md_valid *p; - p = (struct md_valid *)arg; - return(roff_engine(p->tree, buf)); + switch (tok) { + /* ======= ADD MORE MACRO CHECKS BELOW. ======= */ + case (MDOC_Pp): + if (0 == sz) + break; + if ( ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_EQ0)) + return(0); + break; + + case (MDOC_Ft): + /* FALLTHROUGH */ + case (MDOC_Li): + /* FALLTHROUGH */ + case (MDOC_Ms): + /* FALLTHROUGH */ + case (MDOC_Pa): + /* FALLTHROUGH */ + case (MDOC_Tn): + if (0 < sz) + break; + if ( ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_GE1)) + return(0); + break; + + case (MDOC_Ar): + /* FALLTHROUGH */ + case (MDOC_Cm): + /* FALLTHROUGH */ + case (MDOC_Fl): + /* These can have no arguments. */ + break; + + case (MDOC_Ad): + /* FALLTHROUGH */ + case (MDOC_Em): + /* FALLTHROUGH */ + case (MDOC_Er): + /* FALLTHROUGH */ + case (MDOC_Ev): + /* FALLTHROUGH */ + case (MDOC_Fa): + /* FALLTHROUGH */ + case (MDOC_Dv): + /* FALLTHROUGH */ + case (MDOC_Ic): + /* FALLTHROUGH */ + case (MDOC_Sy): + /* FALLTHROUGH */ + case (MDOC_Sx): + /* FALLTHROUGH */ + case (MDOC_Va): + /* FALLTHROUGH */ + case (MDOC_Vt): + if (0 < sz) + break; + return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1)); + /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */ + default: + abort(); + /* NOTREACHED */ + } + + mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, (size_t)sz, _CC(args)); + return(1); } int -md_exit_valid(void *data, int flush) +macro_text(MACRO_PROT_ARGS) { - int c; - struct md_valid *p; + int lastarg, lastpunct, c, j; + char *args[MDOC_LINEARG_MAX]; - p = (struct md_valid *)data; - c = roff_free(p->tree, flush); - free(p); + if (SEC_PROLOGUE == mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); - return(c); -} + /* Token pre-processing. */ + switch (tok) { + case (MDOC_Pp): + /* `.Pp' ignored when following `.Sh' or `.Ss'. */ + assert(mdoc->last); + if (MDOC_BODY != mdoc->last->type) + break; + switch (mdoc->last->data.body.tok) { + case (MDOC_Ss): + /* FALLTHROUGH */ + case (MDOC_Sh): + if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_AFTER_BLK)) + return(0); + return(1); + default: + break; + } + break; + default: + break; + } -void * -md_init_valid(const struct md_args *args, - struct md_mbuf *mbuf, const struct md_rbuf *rbuf) -{ - struct roffcb cb; - struct md_valid *p; + /* Process line parameters. */ - cb.roffhead = roffhead; - cb.rofftail = rofftail; - cb.roffin = roffin; - cb.roffout = roffout; - cb.roffblkin = roffblkin; - cb.roffblkout = roffblkout; - cb.roffspecial = roffspecial; - cb.roffmsg = roffmsg; - cb.roffdata = roffdata; + j = 0; + lastarg = ppos; + lastpunct = 0; - if (NULL == (p = calloc(1, sizeof(struct md_valid)))) - err(1, "malloc"); +again: + if (j == MDOC_LINEARG_MAX) + return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); - p->args = args; - p->mbuf = mbuf; - p->rbuf = rbuf; + /* + * Parse out the next argument, unquoted and unescaped. If + * we're a word (which may be punctuation followed eventually by + * a real word), then fall into checking for callables. If + * only punctuation remains and we're the first, then flush + * arguments, punctuation and exit; else, return to the caller. + */ - assert(mbuf); + lastarg = *pos; - if (NULL == (p->tree = roff_alloc(&cb, p))) { - free(p); - return(NULL); + switch (mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &args[j])) { + case (ARGS_ERROR): + return(0); + case (ARGS_WORD): + break; + case (ARGS_PUNCT): + if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args)) + return(0); + if (ppos > 1) + return(1); + return(append_delims(mdoc, tok, pos, buf)); + case (ARGS_EOLN): + if (lastpunct) + return(1); + return(append_text(mdoc, tok, ppos, j, args)); + default: + abort(); + /* NOTREACHED */ } - return(p); + /* + * Command found. First flush out arguments, then call the + * command. If we're the line macro when it exits, flush + * terminal punctuation. + */ + + if (MDOC_MAX != (c = mdoc_find(mdoc, args[j]))) { + if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args)) + return(0); + if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + return(0); + if (ppos > 1) + return(1); + return(append_delims(mdoc, tok, pos, buf)); + } + + /* Word/non-term-punctuation found. */ + + if ( ! mdoc_isdelim(args[j])) { + /* Words are appended to the array of arguments. */ + j++; + lastpunct = 0; + goto again; + } + + /* + * For punctuation, flush all collected words, then flush + * punctuation, then start collecting again. Of course, this + * is non-terminal punctuation. + */ + + if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args)) + return(0); + + mdoc_word_alloc(mdoc, lastarg, args[j]); + j = 0; + lastpunct = 1; + + goto again; + /* NOTREACHED */ } -/* ARGSUSED */ -static int -roffhead(void *arg) +int +macro_prologue_dtitle(MACRO_PROT_ARGS) { - struct md_valid *p; + int lastarg, j; + char *args[MDOC_LINEARG_MAX]; - assert(arg); - p = (struct md_valid *)arg; + if (SEC_PROLOGUE != mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_NPROLOGUE)); + if (0 == mdoc->meta.date) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_OO)); + if (mdoc->meta.title[0]) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_REP)); - if ( ! md_buf_putstring(p->mbuf, "\n")) + j = -1; + lastarg = ppos; + +again: + if (j == MDOC_LINEARG_MAX) + return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + + lastarg = *pos; + + switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[++j])) { + case (ARGS_EOLN): + if (mdoc->meta.title) + return(1); + if ( ! mdoc_warn(mdoc, tok, ppos, WARN_ARGS_GE1)) + return(0); + (void)xstrlcpy(mdoc->meta.title, + "UNTITLED", META_TITLE_SZ); + return(1); + case (ARGS_ERROR): return(0); + default: + break; + } - if ( ! md_buf_putstring(p->mbuf, "")) + if (MDOC_MAX != mdoc_find(mdoc, args[j]) && ! mdoc_warn + (mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE)) return(0); - p->indent++; - return(mbuf_newline(p)); + if (0 == j) { + if (xstrlcpy(mdoc->meta.title, args[0], META_TITLE_SZ)) + goto again; + return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM)); + + } else if (1 == j) { + mdoc->meta.msec = mdoc_atomsec(args[1]); + if (MSEC_DEFAULT != mdoc->meta.msec) + goto again; + return(mdoc_err(mdoc, tok, -1, ERR_SYNTAX_ARGFORM)); + + } else if (2 == j) { + mdoc->meta.vol = mdoc_atovol(args[2]); + if (VOL_DEFAULT != mdoc->meta.vol) + goto again; + mdoc->meta.arch = mdoc_atoarch(args[2]); + if (ARCH_DEFAULT != mdoc->meta.arch) + goto again; + return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM)); + } + + return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); } -static int -rofftail(void *arg) +int +macro_prologue_os(MACRO_PROT_ARGS) { - struct md_valid *p; + int lastarg, j; + char *args[MDOC_LINEARG_MAX]; - assert(arg); - p = (struct md_valid *)arg; + if (SEC_PROLOGUE != mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_NPROLOGUE)); + if (0 == mdoc->meta.title[0]) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_OO)); + if (mdoc->meta.os[0]) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_REP)); - if (0 != p->pos && ! mbuf_newline(p)) + j = -1; + lastarg = ppos; + +again: + if (j == MDOC_LINEARG_MAX) + return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + + lastarg = *pos; + + switch (mdoc_args(mdoc, tok, pos, buf, + ARGS_QUOTED, &args[++j])) { + case (ARGS_EOLN): + mdoc->sec_lastn = mdoc->sec_last = SEC_BODY; + return(1); + case (ARGS_ERROR): return(0); - return(md_buf_putstring(p->mbuf, "\n")); + default: + break; + } + + if ( ! xstrlcat(mdoc->meta.os, args[j], sizeof(mdoc->meta.os))) + return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM)); + if ( ! xstrlcat(mdoc->meta.os, " ", sizeof(mdoc->meta.os))) + return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM)); + + goto again; + /* NOTREACHED */ } -static int -roffspecial(void *arg, int tok) +int +macro_prologue_ddate(MACRO_PROT_ARGS) { + int lastarg, j; + char *args[MDOC_LINEARG_MAX], date[64]; - return(1); + if (SEC_PROLOGUE != mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_NPROLOGUE)); + if (mdoc->meta.title[0]) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_OO)); + if (mdoc->meta.date) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_REP)); + + j = -1; + date[0] = 0; + lastarg = ppos; + +again: + if (j == MDOC_LINEARG_MAX) + return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + + lastarg = *pos; + switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[++j])) { + case (ARGS_EOLN): + if (mdoc->meta.date) + return(1); + mdoc->meta.date = mdoc_atotime(date); + if (mdoc->meta.date) + return(1); + return(mdoc_err(mdoc, tok, ppos, ERR_SYNTAX_ARGFORM)); + case (ARGS_ERROR): + return(0); + default: + break; + } + + if (MDOC_MAX != mdoc_find(mdoc, args[j]) && ! mdoc_warn + (mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE)) + return(0); + + if (0 == j) { + if (xstrcmp("$Mdocdate: December 30 2008 $", args[j])) { + mdoc->meta.date = time(NULL); + goto again; + } else if (xstrcmp("$Mdocdate:", args[j])) + goto again; + } else if (4 == j) + if ( ! xstrcmp("$", args[j])) + goto again; + + if ( ! xstrlcat(date, args[j], sizeof(date))) + return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM)); + if ( ! xstrlcat(date, " ", sizeof(date))) + return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM)); + + goto again; + /* NOTREACHED */ } -static int -roffblkin(void *arg, int tok, int *argc, char **argv) +int +macro_scoped_explicit(MACRO_PROT_ARGS) { - struct md_valid *p; + int c, lastarg, j; + struct mdoc_arg argv[MDOC_LINEARG_MAX]; + struct mdoc_node *n; - assert(arg); - p = (struct md_valid *)arg; + if (SEC_PROLOGUE == mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); - if (0 != p->pos) { - if ( ! mbuf_newline(p)) + /* + * First close out the explicit scope. The `end' tags (such as + * `.El' to `.Bl' don't cause anything to happen: we merely + * readjust our last parse point. + */ + + switch (tok) { + case (MDOC_El): + return(scope_rewind_exp(mdoc, ppos, tok, MDOC_Bl)); + case (MDOC_Ed): + return(scope_rewind_exp(mdoc, ppos, tok, MDOC_Bd)); + default: + break; + } + + assert(MDOC_EXPLICIT & mdoc_macros[tok].flags); + + /* Token pre-processing. */ + + switch (tok) { + case (MDOC_Bl): + /* FALLTHROUGH */ + case (MDOC_Bd): + /* `.Pp' ignored when preceding `.Bl' or `.Bd'. */ + assert(mdoc->last); + if (MDOC_ELEM != mdoc->last->type) + break; + if (MDOC_Pp != mdoc->last->data.elem.tok) + break; + if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_BEFORE_BLK)) return(0); - if ( ! mbuf_indent(p)) - return(0); - } else if ( ! mbuf_indent(p)) - return(0); + assert(mdoc->last->prev); + n = mdoc->last; + mdoc->last = mdoc->last->prev; + mdoc->last->next = NULL; + mdoc_node_free(n); + break; + default: + break; + } - if ( ! md_buf_putchar(p->mbuf, '<')) + lastarg = *pos; + + for (j = 0; j < MDOC_LINEARG_MAX; j++) { + lastarg = *pos; + c = mdoc_argv(mdoc, tok, &argv[j], pos, buf); + if (0 == c) + break; + else if (1 == c) + continue; + + mdoc_argv_free(j, argv); return(0); - if ( ! md_buf_putstring(p->mbuf, toknames[tok])) - return(0); - if ( ! md_buf_putchar(p->mbuf, '>')) - return(0); - if ( ! mbuf_newline(p)) - return(0); + } - p->indent++; - return(1); + if (MDOC_LINEARG_MAX == j) { + mdoc_argv_free(j, argv); + return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + } + + c = append_scoped(mdoc, tok, ppos, 0, NULL, j, argv); + mdoc_argv_free(j, argv); + return(c); } -static int -roffblkout(void *arg, int tok) +/* + * Implicity-scoped macros, like `.Ss', have a scope that terminates + * with a subsequent call to the same macro. Implicit macros cannot + * break the scope of explicitly-scoped macros; however, they can break + * the scope of other implicit macros (so `.Sh' can break `.Ss'). This + * is ok with macros like `.It' because they exist only within an + * explicit context. + * + * These macros put line arguments (which it's allowed to have) into the + * HEAD section and open a BODY scope to be used until the macro scope + * closes. + */ +int +macro_scoped_implicit(MACRO_PROT_ARGS) { - struct md_valid *p; + int lastarg, j; + char *args[MDOC_LINEARG_MAX]; + struct mdoc_node *n; - assert(arg); - p = (struct md_valid *)arg; + assert( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)); - p->indent--; + if (SEC_PROLOGUE == mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); - if (0 != p->pos) { - if ( ! mbuf_newline(p)) + /* Token pre-processing. */ + + switch (tok) { + case (MDOC_Ss): + /* FALLTHROUGH */ + case (MDOC_Sh): + /* `.Pp' ignored when preceding `.Ss' or `.Sh'. */ + if (NULL == mdoc->last) + break; + if (MDOC_ELEM != mdoc->last->type) + break; + if (MDOC_Pp != mdoc->last->data.elem.tok) + break; + if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_BEFORE_BLK)) return(0); - if ( ! mbuf_indent(p)) - return(0); - } else if ( ! mbuf_indent(p)) + assert(mdoc->last->prev); + n = mdoc->last; + mdoc_msg(mdoc, ppos, "removing prior `Pp' macro"); + mdoc->last = mdoc->last->prev; + mdoc->last->next = NULL; + mdoc_node_free(n); + break; + default: + break; + } + + /* Rewind our scope. */ + + if ( ! scope_rewind_imp(mdoc, ppos, tok)) return(0); - if ( ! md_buf_putstring(p->mbuf, "mbuf, toknames[tok])) - return(0); - if ( ! md_buf_putstring(p->mbuf, ">")) - return(0); - if ( ! mbuf_newline(p)) - return(0); + case (ARGS_EOLN): + return(append_scoped(mdoc, tok, ppos, j, _CC(args), 0, NULL)); + default: + break; + } - return(1); + if (MDOC_MAX != mdoc_find(mdoc, args[j])) + if ( ! mdoc_warn(mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE)) + return(0); + + j++; + goto again; + /* NOTREACHED */ } -static int -roffin(void *arg, int tok, int *argcp, char **argvp) +/* + * A line-scoped macro opens a scope for the contents of its line, which + * are placed under the HEAD node. Punctuation trailing the line is put + * as a sibling to the HEAD node, under the BLOCK node. + */ +int +macro_scoped_line(MACRO_PROT_ARGS) { - struct md_valid *p; + int lastarg, c, j; + char *p; + struct mdoc_node *n; - assert(arg); - p = (struct md_valid *)arg; + if (SEC_PROLOGUE == mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); - if (0 == p->pos && ! mbuf_indent(p)) - return(0); + assert(1 == ppos); + + /* Token pre-processing. */ - /* FIXME: not always with a space... */ - if ( ! md_buf_putstring(p->mbuf, " <")) + switch (tok) { + case (MDOC_D1): + /* FALLTHROUGH */ + case (MDOC_Dl): + /* These can't be nested in a display block. */ + assert(mdoc->last); + for (n = mdoc->last->parent ; n; n = n->parent) + if (MDOC_BLOCK != n->type) + continue; + else if (MDOC_Bd == n->data.block.tok) + break; + if (NULL == n) + break; + return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_NONEST)); + default: + break; + } + + /* + * All line-scoped macros have a HEAD and optionally a BODY + * section. We open our scope here; when we exit this function, + * we'll rewind our scope appropriately. + */ + + mdoc_block_alloc(mdoc, ppos, tok, 0, NULL); + mdoc_head_alloc(mdoc, ppos, tok, 0, NULL); + + /* Process line parameters. */ + + j = 0; + lastarg = ppos; + +again: + if (j == MDOC_LINEARG_MAX) + return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + + lastarg = *pos; + c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p); + + switch (c) { + case (ARGS_ERROR): return(0); - if ( ! md_buf_putstring(p->mbuf, toknames[tok])) - return(0); - if ( ! md_buf_putstring(p->mbuf, ">")) - return(0); + case (ARGS_WORD): + break; + case (ARGS_PUNCT): + if ( ! append_delims(mdoc, tok, pos, buf)) + return(0); + return(scope_rewind_imp(mdoc, ppos, tok)); + case (ARGS_EOLN): + return(scope_rewind_imp(mdoc, ppos, tok)); + default: + abort(); + /* NOTREACHED */ + } - p->pos += strlen(toknames[tok]) + 3; + if (MDOC_MAX != (c = mdoc_find(mdoc, p))) { + if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + return(0); + if ( ! append_delims(mdoc, tok, pos, buf)) + return(0); + return(scope_rewind_imp(mdoc, ppos, tok)); + } - return(1); + if (mdoc_isdelim(p)) + j = 0; + + mdoc_word_alloc(mdoc, lastarg, p); + goto again; + /* NOTREACHED */ } -static int -roffout(void *arg, int tok) +/* + * Partial-line scope is identical to line scope (macro_scoped_line()) + * except that trailing punctuation is appended to the BLOCK, instead of + * contained within the HEAD. + */ +int +macro_scoped_pline(MACRO_PROT_ARGS) { - struct md_valid *p; + int lastarg, c, j; + char *p; - assert(arg); - p = (struct md_valid *)arg; + if (SEC_PROLOGUE == mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); - if (0 == p->pos && ! mbuf_indent(p)) - return(0); + /* Token pre-processing. */ - if ( ! md_buf_putstring(p->mbuf, "mbuf, toknames[tok])) - return(0); - if ( ! md_buf_putstring(p->mbuf, ">")) - return(0); + case (ARGS_WORD): + break; + case (ARGS_PUNCT): + if ( ! scope_rewind_imp(mdoc, ppos, tok)) + return(0); + if (ppos > 1) + return(1); + return(append_delims(mdoc, tok, pos, buf)); + case (ARGS_EOLN): + return(scope_rewind_imp(mdoc, ppos, tok)); + default: + abort(); + /* NOTREACHED */ + } - p->pos += strlen(toknames[tok]) + 2; + if (MDOC_MAX != (c = mdoc_find(mdoc, p))) { + if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + return(0); + if ( ! scope_rewind_imp(mdoc, ppos, tok)) + return(0); + if (ppos > 1) + return(1); + return(append_delims(mdoc, tok, pos, buf)); + } - return(1); + if (mdoc_isdelim(p)) + j = 0; + + mdoc_word_alloc(mdoc, lastarg, p); + goto again; + /* NOTREACHED */ } - -static void -roffmsg(void *arg, enum roffmsg lvl, - const char *buf, const char *pos, char *msg) +/* + * A delimited-constant macro is similar to a general text macro: the + * macro is followed by a 0 or 1 arguments (possibly-unspecified) then + * terminating punctuation, other words, or another callable macro. + */ +int +macro_constant_delimited(MACRO_PROT_ARGS) { - char *level; - struct md_valid *p; + int lastarg, flushed, c, maxargs; + char *p; - assert(arg); - p = (struct md_valid *)arg; + if (SEC_PROLOGUE == mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); - switch (lvl) { - case (ROFF_WARN): - if ( ! (MD_WARN_ALL & p->args->warnings)) - return; - level = "warning"; + /* Process line parameters. */ + + lastarg = ppos; + flushed = 0; + + /* Token pre-processing. */ + + switch (tok) { + case (MDOC_Ux): + maxargs = 0; break; - case (ROFF_ERROR): - level = "error"; + default: + maxargs = 1; break; + } + +again: + lastarg = *pos; + + switch (mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p)) { + case (ARGS_ERROR): + return(0); + case (ARGS_WORD): + break; + case (ARGS_PUNCT): + if ( ! flushed && ! append_const(mdoc, tok, ppos, 0, &p)) + return(0); + if (ppos > 1) + return(1); + return(append_delims(mdoc, tok, pos, buf)); + case (ARGS_EOLN): + if (flushed) + return(1); + return(append_const(mdoc, tok, ppos, 0, &p)); default: abort(); + /* NOTREACHED */ } - - if (pos) - (void)fprintf(stderr, "%s:%zu: %s: %s\n", - p->rbuf->name, p->rbuf->line, level, msg); - else - (void)fprintf(stderr, "%s: %s: %s\n", - p->rbuf->name, level, msg); + /* Accepts no arguments: flush out symbol and continue. */ + + if (0 == maxargs) { + if ( ! append_const(mdoc, tok, ppos, 0, &p)) + return(0); + flushed = 1; + } + + if (MDOC_MAX != (c = mdoc_find(mdoc, p))) { + if ( ! flushed && ! append_const(mdoc, tok, ppos, 0, &p)) + return(0); + if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + return(0); + if (ppos > 1) + return(1); + return(append_delims(mdoc, tok, pos, buf)); + } + + /* + * We only accept one argument; subsequent tokens are considered + * as literal words (until a macro). + */ + + if ( ! flushed && ! mdoc_isdelim(p)) { + if ( ! append_const(mdoc, tok, ppos, 1, &p)) + return(0); + flushed = 1; + goto again; + } else if ( ! flushed) { + if ( ! append_const(mdoc, tok, ppos, 0, &p)) + return(0); + flushed = 1; + } + + mdoc_word_alloc(mdoc, lastarg, p); + goto again; + /* NOTREACHED */ } -static int -roffdata(void *arg, int space, char *buf) +int +macro_constant(MACRO_PROT_ARGS) { - struct md_valid *p; + int lastarg, j; + char *args[MDOC_LINEARG_MAX]; - assert(arg); - p = (struct md_valid *)arg; - return(mbuf_data(p, space, buf)); + if (SEC_PROLOGUE == mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + + j = 0; + lastarg = ppos; + +again: + if (j == MDOC_LINEARG_MAX) + return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + + lastarg = *pos; + + switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[j])) { + case (ARGS_ERROR): + return(0); + case (ARGS_WORD): + break; + case (ARGS_EOLN): + return(append_const(mdoc, tok, ppos, j, args)); + default: + abort(); + /* NOTREACHED */ + } + + if (MDOC_MAX != mdoc_find(mdoc, args[j])) + if ( ! mdoc_warn(mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE)) + return(0); + + j++; + goto again; + /* NOTREACHED */ +} + + +int +macro_constant_argv(MACRO_PROT_ARGS) +{ + int c, lastarg, j; + struct mdoc_arg argv[MDOC_LINEARG_MAX]; + + if (SEC_PROLOGUE == mdoc->sec_lastn) + return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + + lastarg = *pos; + + for (j = 0; j < MDOC_LINEARG_MAX; j++) { + lastarg = *pos; + c = mdoc_argv(mdoc, tok, &argv[j], pos, buf); + if (0 == c) + break; + else if (1 == c) + continue; + + mdoc_argv_free(j, argv); + return(0); + } + + if (MDOC_LINEARG_MAX == j) { + mdoc_argv_free(j, argv); + return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + } + + c = append_constarg(mdoc, tok, ppos, j, argv); + mdoc_argv_free(j, argv); + return(c); }