=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.8 retrieving revision 1.45 diff -u -p -r1.8 -r1.45 --- mandoc/Attic/validate.c 2008/12/30 13:43:53 1.8 +++ mandoc/Attic/validate.c 2009/01/20 20:56:21 1.45 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.8 2008/12/30 13:43:53 kristaps Exp $ */ +/* $Id: validate.c,v 1.45 2009/01/20 20:56:21 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -17,1143 +17,1123 @@ * PERFORMANCE OF THIS SOFTWARE. */ #include -#include #include -#include -#include -#ifdef __linux__ -#include -#endif #include "private.h" -/* FIXME: maxlineargs should be per LINE, no per TOKEN. */ -/* FIXME: prologue check should be in macro_call. */ +/* + * Pre- and post-validate macros as they're parsed. Pre-validation + * occurs when the macro has been detected and its arguments parsed. + * Post-validation occurs when all child macros have also been parsed. + * In the ELEMENT case, this is simply the parameters of the macro; in + * the BLOCK case, this is the HEAD, BODY, TAIL and so on. + */ -#define _CC(p) ((const char **)p) +typedef int (*v_pre)(struct mdoc *, struct mdoc_node *); +typedef int (*v_post)(struct mdoc *); -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 *); +/* FIXME: some sections should only occur in specific msecs. */ +/* FIXME: ignoring Pp. */ +/* FIXME: math symbols. */ +/* FIXME: valid character-escape checks. */ +/* FIXME: make sure required sections are included (NAME, ...). */ +struct valids { + v_pre *pre; + v_post *post; +}; -static int -append_delims(struct mdoc *mdoc, int tok, int *pos, char *buf) -{ - int c, lastarg; - char *p; +/* Utility checks. */ - if (0 == buf[*pos]) - return(1); +static int pre_check_parent(struct mdoc *, struct mdoc_node *, + int, enum mdoc_type); +static int pre_check_msecs(struct mdoc *, struct mdoc_node *, + int, enum mdoc_msec *); +static int pre_check_stdarg(struct mdoc *, struct mdoc_node *); +static int post_check_children_count(struct mdoc *); +static int post_check_children_lt(struct mdoc *, const char *, int); +static int post_check_children_gt(struct mdoc *, const char *, int); +static int post_check_children_wgt(struct mdoc *, const char *, int); +static int post_check_children_eq(struct mdoc *, const char *, int); +static int post_check_children_weq(struct mdoc *, const char *, int); - mdoc_msg(mdoc, *pos, "`%s' flushing punctuation", - mdoc_macronames[tok]); +/* Specific pre-child-parse routines. */ - 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); - } +static int pre_display(struct mdoc *, struct mdoc_node *); +static int pre_sh(struct mdoc *, struct mdoc_node *); +static int pre_ss(struct mdoc *, struct mdoc_node *); +static int pre_bd(struct mdoc *, struct mdoc_node *); +static int pre_bl(struct mdoc *, struct mdoc_node *); +static int pre_it(struct mdoc *, struct mdoc_node *); +static int pre_cd(struct mdoc *, struct mdoc_node *); +static int pre_er(struct mdoc *, struct mdoc_node *); +static int pre_ex(struct mdoc *, struct mdoc_node *); +static int pre_rv(struct mdoc *, struct mdoc_node *); +static int pre_an(struct mdoc *, struct mdoc_node *); +static int pre_st(struct mdoc *, struct mdoc_node *); +static int pre_prologue(struct mdoc *, struct mdoc_node *); +static int pre_prologue(struct mdoc *, struct mdoc_node *); +static int pre_prologue(struct mdoc *, struct mdoc_node *); - return(1); -} +/* Specific post-child-parse routines. */ +static int herr_ge1(struct mdoc *); +static int herr_le1(struct mdoc *); +static int herr_eq0(struct mdoc *); +static int eerr_eq0(struct mdoc *); +static int eerr_le1(struct mdoc *); +static int eerr_le2(struct mdoc *); +static int eerr_eq1(struct mdoc *); +static int eerr_ge1(struct mdoc *); +static int ewarn_eq0(struct mdoc *); +static int ewarn_eq1(struct mdoc *); +static int bwarn_ge1(struct mdoc *); +static int ewarn_ge1(struct mdoc *); +static int ebool(struct mdoc *); +static int post_sh(struct mdoc *); +static int post_bl(struct mdoc *); +static int post_it(struct mdoc *); +static int post_ex(struct mdoc *); +static int post_an(struct mdoc *); +static int post_at(struct mdoc *); +static int post_xr(struct mdoc *); +static int post_nm(struct mdoc *); +static int post_bf(struct mdoc *); +static int post_root(struct mdoc *); +/* Collections of pre-child-parse routines. */ + +static v_pre pres_prologue[] = { pre_prologue, NULL }; +static v_pre pres_d1[] = { pre_display, NULL }; +static v_pre pres_bd[] = { pre_display, pre_bd, NULL }; +static v_pre pres_bl[] = { pre_bl, NULL }; +static v_pre pres_it[] = { pre_it, NULL }; +static v_pre pres_ss[] = { pre_ss, NULL }; +static v_pre pres_sh[] = { pre_sh, NULL }; +static v_pre pres_cd[] = { pre_cd, NULL }; +static v_pre pres_er[] = { pre_er, NULL }; +static v_pre pres_ex[] = { pre_ex, NULL }; +static v_pre pres_rv[] = { pre_rv, NULL }; +static v_pre pres_an[] = { pre_an, NULL }; +static v_pre pres_st[] = { pre_st, NULL }; + +/* Collections of post-child-parse routines. */ + +static v_post posts_bool[] = { eerr_eq1, ebool, NULL }; +static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL }; +static v_post posts_text[] = { eerr_ge1, NULL }; +static v_post posts_wtext[] = { ewarn_ge1, NULL }; +static v_post posts_notext[] = { eerr_eq0, NULL }; +static v_post posts_wline[] = { bwarn_ge1, herr_eq0, NULL }; +static v_post posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL }; +static v_post posts_bl[] = { herr_eq0, bwarn_ge1, post_bl, NULL }; +static v_post posts_it[] = { post_it, NULL }; +static v_post posts_in[] = { ewarn_eq1, NULL }; +static v_post posts_ss[] = { herr_ge1, NULL }; +static v_post posts_pp[] = { ewarn_eq0, NULL }; +static v_post posts_ex[] = { eerr_le1, post_ex, NULL }; +static v_post posts_an[] = { post_an, NULL }; +static v_post posts_at[] = { post_at, NULL }; +static v_post posts_xr[] = { eerr_ge1, eerr_le2, post_xr, NULL }; +static v_post posts_nm[] = { post_nm, NULL }; +static v_post posts_bf[] = { herr_le1, post_bf, NULL }; +static v_post posts_rs[] = { herr_eq0, bwarn_ge1, NULL }; +static v_post posts_fo[] = { bwarn_ge1, NULL }; +static v_post posts_bk[] = { herr_eq0, bwarn_ge1, NULL }; + +/* Per-macro pre- and post-child-check routine collections. */ + +const struct valids mdoc_valids[MDOC_MAX] = { + { NULL, NULL }, /* \" */ + { pres_prologue, posts_text }, /* Dd */ + { pres_prologue, NULL }, /* Dt */ + { pres_prologue, NULL }, /* Os */ + /* FIXME: NAME section internal ordering. */ + { pres_sh, posts_sh }, /* Sh */ + { pres_ss, posts_ss }, /* Ss */ + { NULL, posts_pp }, /* Pp */ + { pres_d1, posts_wline }, /* D1 */ + { pres_d1, posts_wline }, /* Dl */ + { pres_bd, posts_bd }, /* Bd */ + { NULL, NULL }, /* Ed */ + { pres_bl, posts_bl }, /* Bl */ + { NULL, NULL }, /* El */ + { pres_it, posts_it }, /* It */ + { NULL, posts_text }, /* Ad */ + { pres_an, posts_an }, /* An */ + { NULL, NULL }, /* Ar */ + { pres_cd, posts_text }, /* Cd */ + { NULL, NULL }, /* Cm */ + { NULL, posts_text }, /* Dv */ + { pres_er, posts_text }, /* Er */ + { NULL, posts_text }, /* Ev */ + { pres_ex, posts_ex }, /* Ex */ + { NULL, posts_text }, /* Fa */ + /* FIXME: only in SYNOPSIS section. */ + { NULL, posts_wtext }, /* Fd */ + { NULL, NULL }, /* Fl */ + { NULL, posts_text }, /* Fn */ + { NULL, posts_wtext }, /* Ft */ + { NULL, posts_text }, /* Ic */ + { NULL, posts_in }, /* In */ + { NULL, posts_text }, /* Li */ + { NULL, posts_wtext }, /* Nd */ + { NULL, posts_nm }, /* Nm */ + { NULL, posts_wline }, /* Op */ + { NULL, NULL }, /* Ot */ + { NULL, NULL }, /* Pa */ + { pres_rv, posts_notext }, /* Rv */ + { pres_st, posts_notext }, /* St */ + { NULL, posts_text }, /* Va */ + { NULL, posts_text }, /* Vt */ + { NULL, posts_xr }, /* Xr */ + { NULL, posts_text }, /* %A */ + { NULL, posts_text }, /* %B */ + { NULL, posts_text }, /* %D */ + { NULL, posts_text }, /* %I */ + { NULL, posts_text }, /* %J */ + { NULL, posts_text }, /* %N */ + { NULL, posts_text }, /* %O */ + { NULL, posts_text }, /* %P */ + { NULL, posts_text }, /* %R */ + { NULL, posts_text }, /* %T */ + { NULL, posts_text }, /* %V */ + { NULL, NULL }, /* Ac */ + { NULL, NULL }, /* Ao */ + { NULL, posts_wline }, /* Aq */ + { NULL, posts_at }, /* At */ + { NULL, NULL }, /* Bc */ + { NULL, posts_bf }, /* Bf */ + { NULL, NULL }, /* Bo */ + { NULL, posts_wline }, /* Bq */ + { NULL, NULL }, /* Bsx */ + { NULL, NULL }, /* Bx */ + { NULL, posts_bool }, /* Db */ + { NULL, NULL }, /* Dc */ + { NULL, NULL }, /* Do */ + { NULL, posts_wline }, /* Dq */ + { NULL, NULL }, /* Ec */ + { NULL, NULL }, /* Ef */ /* -symbolic, etc. */ + { NULL, posts_text }, /* Em */ + { NULL, NULL }, /* Eo */ + { NULL, NULL }, /* Fx */ + { NULL, posts_text }, /* Ms */ + { NULL, posts_notext }, /* No */ + { NULL, posts_notext }, /* Ns */ + { NULL, NULL }, /* Nx */ + { NULL, NULL }, /* Ox */ + { NULL, NULL }, /* Pc */ + { NULL, NULL }, /* Pf */ + { NULL, NULL }, /* Po */ + { NULL, posts_wline }, /* Pq */ + { NULL, NULL }, /* Qc */ + { NULL, posts_wline }, /* Ql */ + { NULL, NULL }, /* Qo */ + { NULL, posts_wline }, /* Qq */ + { NULL, NULL }, /* Re */ + { NULL, posts_rs }, /* Rs */ + { NULL, NULL }, /* Sc */ + { NULL, NULL }, /* So */ + { NULL, posts_wline }, /* Sq */ + { NULL, posts_bool }, /* Sm */ + { NULL, posts_text }, /* Sx */ + { NULL, posts_text }, /* Sy */ + { NULL, posts_text }, /* Tn */ + { NULL, NULL }, /* Ux */ + { NULL, NULL }, /* Xc */ + { NULL, NULL }, /* Xo */ + { NULL, posts_fo }, /* Fo */ + { NULL, NULL }, /* Fc */ + { NULL, NULL }, /* Oo */ + { NULL, NULL }, /* Oc */ + { NULL, posts_bk }, /* Bk */ + { NULL, NULL }, /* Ek */ + { NULL, posts_notext }, /* Bt */ + { NULL, NULL }, /* Hf */ + { NULL, NULL }, /* Fr */ + { NULL, posts_notext }, /* Ud */ +}; + + static int -scope_rewind_imp(struct mdoc *mdoc, int ppos, int tok) +post_check_children_count(struct mdoc *mdoc) { struct mdoc_node *n; - int t; + int i; - n = mdoc->last ? mdoc->last->parent : NULL; + for (i = 0, n = mdoc->last->child; n; n = n->next, i++) + /* Do nothing */ ; + return(i); +} - /* 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)); - } - if (n) { - mdoc->last = n; - mdoc_msg(mdoc, ppos, "scope: rewound implicit `%s'", - mdoc_macronames[tok]); - return(1); - } +static int +post_check_children_wgt(struct mdoc *mdoc, const char *p, int sz) +{ + int i; - mdoc_msg(mdoc, ppos, "scope: new implicit `%s'", - mdoc_macronames[tok]); - return(1); + if ((i = post_check_children_count(mdoc)) > sz) + return(1); + return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests more " + "than %d %s (has %d)", sz, p, i)); } static int -scope_rewind_exp(struct mdoc *mdoc, int ppos, int tok, int dst) +post_check_children_gt(struct mdoc *mdoc, const char *p, int sz) { - struct mdoc_node *n; + int i; - assert(mdoc->last); + if ((i = post_check_children_count(mdoc)) > sz) + return(1); + return(mdoc_err(mdoc, "macro requires more than %d " + "%s (has %d)", sz, p, i)); +} - /* 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)); +static int +post_check_children_weq(struct mdoc *mdoc, const char *p, int sz) +{ + int i; - mdoc_msg(mdoc, ppos, "scope: rewound explicit `%s' to `%s'", - mdoc_macronames[tok], mdoc_macronames[dst]); - - return(1); + if ((i = post_check_children_count(mdoc)) == sz) + return(1); + return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests %d " + "%s (has %d)", sz, p, i)); } static int -append_constarg(struct mdoc *mdoc, int tok, int pos, - int argc, const struct mdoc_arg *argv) +post_check_children_eq(struct mdoc *mdoc, const char *p, int sz) { + int i; - switch (tok) { - default: - break; - } - - mdoc_elem_alloc(mdoc, pos, tok, argc, argv, 0, NULL); - return(1); + if ((i = post_check_children_count(mdoc)) == sz) + return(1); + return(mdoc_err(mdoc, "macro requires %d %s " + "(have %d)", sz, p, i)); } -/* - * 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) +post_check_children_lt(struct mdoc *mdoc, const char *p, int sz) { - enum mdoc_sec sec; - struct mdoc_node *node; + int i; - switch (tok) { - /* ======= ADD MORE MACRO CHECKS BELOW. ======= */ + if ((i = post_check_children_count(mdoc)) < sz) + return(1); + return(mdoc_err(mdoc, "macro requires less than %d " + "%s (have %d)", sz, p, i)); +} - 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); +static int +pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node *node) +{ - 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; + if (1 == node->data.elem.argc && + MDOC_Std == node->data.elem.argv[0].arg) + return(1); + return(mdoc_nwarn(mdoc, node, WARN_COMPAT, + "macro suggests single `%s' argument", + mdoc_argnames[MDOC_Std])); +} - 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)); - case (MDOC_Bl): - break; +static int +pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node, + int sz, enum mdoc_msec *msecs) +{ + int i; - /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */ - default: - abort(); - /* NOTREACHED */ - } - - 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); + for (i = 0; i < sz; i++) + if (msecs[i] == mdoc->meta.msec) + return(1); + return(mdoc_nwarn(mdoc, node, WARN_COMPAT, "macro not " + "appropriate for manual section")); } static int -append_const(struct mdoc *mdoc, int tok, - int pos, int sz, char *args[]) +pre_check_parent(struct mdoc *mdoc, struct mdoc_node *node, + int tok, enum mdoc_type type) { - switch (tok) { - /* ======= ADD MORE MACRO CHECKS BELOW. ======= */ + if (type != node->parent->type) + return(mdoc_nerr(mdoc, node, "invalid macro parent class %s, expected %s", + mdoc_type2a(node->parent->type), + mdoc_type2a(type))); + if (MDOC_ROOT != type && tok != node->parent->tok) + return(mdoc_nerr(mdoc, node, "invalid macro parent `%s', expected `%s'", + mdoc_macronames[node->parent->tok], + mdoc_macronames[tok])); + return(1); +} - /* 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]); - } +static int +bwarn_ge1(struct mdoc *mdoc) +{ - 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]); + if (MDOC_BODY != mdoc->last->type) return(1); + return(post_check_children_wgt(mdoc, "body children", 0)); +} - 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)); - case (MDOC_Bx): - /* FALLTHROUGH */ - case (MDOC_Bsx): - /* FALLTHROUGH */ - case (MDOC_Os): - /* FALLTHROUGH */ - case (MDOC_Fx): - /* FALLTHROUGH */ - case (MDOC_Nx): - assert(sz <= 1); - break; +static int +ewarn_eq1(struct mdoc *mdoc) +{ - case (MDOC_Ux): - assert(0 == sz); - break; + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_weq(mdoc, "parameters", 1)); +} - 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 */ - } +static int +ewarn_eq0(struct mdoc *mdoc) +{ - mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, (size_t)sz, _CC(args)); - return(1); + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_weq(mdoc, "parameters", 0)); } static int -append_text(struct mdoc *mdoc, int tok, - int pos, int sz, char *args[]) +ewarn_ge1(struct mdoc *mdoc) { - 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; + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_wgt(mdoc, "parameters", 0)); +} - 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; +static int +eerr_eq1(struct mdoc *mdoc) +{ - 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); + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_eq(mdoc, "parameters", 1)); } -int -macro_text(MACRO_PROT_ARGS) +static int +eerr_le2(struct mdoc *mdoc) { - int lastarg, lastpunct, c, j; - char *args[MDOC_LINEARG_MAX]; - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_lt(mdoc, "parameters", 3)); +} - /* 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; - } +static int +eerr_le1(struct mdoc *mdoc) +{ - /* Process line parameters. */ + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_lt(mdoc, "parameters", 2)); +} - j = 0; - lastarg = ppos; - lastpunct = 0; -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); +static int +eerr_eq0(struct mdoc *mdoc) +{ - /* - * 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(MDOC_ELEM == mdoc->last->type); + return(post_check_children_eq(mdoc, "parameters", 0)); +} - lastarg = *pos; - 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 */ - } +static int +eerr_ge1(struct mdoc *mdoc) +{ - /* - * Command found. First flush out arguments, then call the - * command. If we're the line macro when it exits, flush - * terminal punctuation. - */ + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_gt(mdoc, "parameters", 0)); +} - 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. */ +static int +herr_eq0(struct mdoc *mdoc) +{ - if ( ! mdoc_isdelim(args[j])) { - /* Words are appended to the array of arguments. */ - j++; - lastpunct = 0; - goto again; - } + if (MDOC_HEAD != mdoc->last->type) + return(1); + return(post_check_children_eq(mdoc, "parameters", 0)); +} - /* - * 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); +static int +herr_le1(struct mdoc *mdoc) +{ + if (MDOC_HEAD != mdoc->last->type) + return(1); + return(post_check_children_lt(mdoc, "parameters", 2)); +} - mdoc_word_alloc(mdoc, lastarg, args[j]); - j = 0; - lastpunct = 1; - goto again; - /* NOTREACHED */ +static int +herr_ge1(struct mdoc *mdoc) +{ + + if (MDOC_HEAD != mdoc->last->type) + return(1); + return(post_check_children_gt(mdoc, "parameters", 0)); } -int -macro_prologue_dtitle(MACRO_PROT_ARGS) +static int +pre_display(struct mdoc *mdoc, struct mdoc_node *node) { - int lastarg, j; - char *args[MDOC_LINEARG_MAX]; + struct mdoc_node *n; - 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 (MDOC_BLOCK != node->type) + return(1); - j = -1; - lastarg = ppos; + assert(mdoc->last); + /* LINTED */ + for (n = mdoc->last->parent; n; n = n->parent) + if (MDOC_BLOCK == n->type) + if (MDOC_Bd == n->tok) + break; + if (NULL == n) + return(1); + return(mdoc_nerr(mdoc, node, "displays may not be nested")); +} -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); - lastarg = *pos; +static int +pre_bl(struct mdoc *mdoc, struct mdoc_node *node) +{ + int type, err; + struct mdoc_arg *argv; + size_t i, argc; - 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); + if (MDOC_BLOCK != node->type) return(1); - case (ARGS_ERROR): - return(0); - default: - break; + assert(MDOC_Bl == node->tok); + + argv = NULL; + argc = node->data.block.argc; + + /* LINTED */ + for (i = type = err = 0; i < argc; i++) { + argv = &node->data.block.argv[(int)i]; + assert(argv); + switch (argv->arg) { + case (MDOC_Bullet): + /* FALLTHROUGH */ + case (MDOC_Dash): + /* FALLTHROUGH */ + case (MDOC_Enum): + /* FALLTHROUGH */ + case (MDOC_Hyphen): + /* FALLTHROUGH */ + case (MDOC_Item): + /* FALLTHROUGH */ + case (MDOC_Tag): + /* FALLTHROUGH */ + case (MDOC_Diag): + /* FALLTHROUGH */ + case (MDOC_Hang): + /* FALLTHROUGH */ + case (MDOC_Ohang): + /* FALLTHROUGH */ + case (MDOC_Inset): + /* FALLTHROUGH */ + case (MDOC_Column): + if (type) + err++; + type++; + break; + default: + break; + } } + if (0 == type) + return(mdoc_err(mdoc, "no list type specified")); + if (0 == err) + return(1); + assert(argv); + return(mdoc_perr(mdoc, argv->line, + argv->pos, "only one list type possible")); +} - if (MDOC_MAX != mdoc_find(mdoc, args[j]) && ! mdoc_warn - (mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE)) - return(0); - if (0 == j) { - if (xstrlcpy(mdoc->meta.title, args[0], META_TITLE_SZ)) - goto again; - return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM)); +static int +pre_bd(struct mdoc *mdoc, struct mdoc_node *node) +{ + int type, err; + struct mdoc_arg *argv; + size_t i, argc; - } 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)); + if (MDOC_BLOCK != node->type) + return(1); + assert(MDOC_Bd == node->tok); - } 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)); - } + argv = NULL; + argc = node->data.block.argc; - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + /* LINTED */ + for (err = i = type = 0; 0 == err && i < argc; i++) { + argv = &node->data.block.argv[(int)i]; + assert(argv); + switch (argv->arg) { + case (MDOC_Ragged): + /* FALLTHROUGH */ + case (MDOC_Unfilled): + /* FALLTHROUGH */ + case (MDOC_Filled): + /* FALLTHROUGH */ + case (MDOC_Literal): + /* FALLTHROUGH */ + case (MDOC_File): + if (type) + err++; + type++; + break; + default: + break; + } + } + if (0 == type) + return(mdoc_err(mdoc, "no display type specified")); + if (0 == err) + return(1); + assert(argv); + return(mdoc_perr(mdoc, argv->line, + argv->pos, "only one display type possible")); } -int -macro_prologue_os(MACRO_PROT_ARGS) +static int +pre_ss(struct mdoc *mdoc, struct mdoc_node *node) { - int lastarg, j; - char *args[MDOC_LINEARG_MAX]; - 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 (MDOC_BLOCK != node->type) + return(1); + return(pre_check_parent(mdoc, node, MDOC_Sh, MDOC_BODY)); +} - j = -1; - lastarg = ppos; -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); +static int +pre_sh(struct mdoc *mdoc, struct mdoc_node *node) +{ - lastarg = *pos; - - switch (mdoc_args(mdoc, tok, pos, buf, - ARGS_QUOTED, &args[++j])) { - case (ARGS_EOLN): - mdoc->sec_lastn = mdoc->sec_last = SEC_BODY; + if (MDOC_BLOCK != node->type) return(1); - case (ARGS_ERROR): - return(0); - 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 */ + return(pre_check_parent(mdoc, node, -1, MDOC_ROOT)); } -int -macro_prologue_ddate(MACRO_PROT_ARGS) +static int +pre_st(struct mdoc *mdoc, struct mdoc_node *node) { - int lastarg, j; - char *args[MDOC_LINEARG_MAX], date[64]; - 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)); + assert(MDOC_ELEM == node->type); + assert(MDOC_St == node->tok); + if (1 == node->data.elem.argc) + return(1); + return(mdoc_nerr(mdoc, node, "macro must have one argument")); +} - j = -1; - date[0] = 0; - lastarg = ppos; -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); +static int +pre_an(struct mdoc *mdoc, struct mdoc_node *node) +{ - 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; + assert(MDOC_ELEM == node->type); + assert(MDOC_An == node->tok); + if (1 >= node->data.elem.argc) + return(1); + return(mdoc_nerr(mdoc, node, "macro may only have one argument")); +} - 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 +pre_rv(struct mdoc *mdoc, struct mdoc_node *node) +{ + enum mdoc_msec msecs[2]; + + assert(MDOC_ELEM == node->type); + assert(MDOC_Rv == node->tok); + + msecs[0] = MSEC_2; + msecs[1] = MSEC_3; + if ( ! pre_check_msecs(mdoc, node, 2, msecs)) + return(0); + return(pre_check_stdarg(mdoc, node)); } -int -macro_scoped_explicit(MACRO_PROT_ARGS) +static int +pre_ex(struct mdoc *mdoc, struct mdoc_node *node) { - int c, lastarg, j; - struct mdoc_arg argv[MDOC_LINEARG_MAX]; - struct mdoc_node *n; + enum mdoc_msec msecs[3]; - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + assert(MDOC_ELEM == node->type); + assert(MDOC_Ex == node->tok); - /* - * 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. - */ + msecs[0] = MSEC_1; + msecs[1] = MSEC_6; + msecs[2] = MSEC_8; + if ( ! pre_check_msecs(mdoc, node, 3, msecs)) + return(0); + return(pre_check_stdarg(mdoc, node)); +} - 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); +static int +pre_er(struct mdoc *mdoc, struct mdoc_node *node) +{ + enum mdoc_msec msecs[1]; - /* Token pre-processing. */ + msecs[0] = MSEC_2; + return(pre_check_msecs(mdoc, node, 1, msecs)); +} - 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); - assert(mdoc->last->prev); - n = mdoc->last; - mdoc->last = mdoc->last->prev; - mdoc->last->next = NULL; - mdoc_node_free(n); - break; - default: - break; - } - lastarg = *pos; +static int +pre_cd(struct mdoc *mdoc, struct mdoc_node *node) +{ + enum mdoc_msec msecs[1]; - 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; + msecs[0] = MSEC_4; + return(pre_check_msecs(mdoc, node, 1, msecs)); +} - 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)); - } +static int +pre_it(struct mdoc *mdoc, struct mdoc_node *node) +{ - c = append_scoped(mdoc, tok, ppos, 0, NULL, j, argv); - mdoc_argv_free(j, argv); - return(c); + if (MDOC_BLOCK != node->type) + return(1); + return(pre_check_parent(mdoc, node, MDOC_Bl, MDOC_BODY)); } -/* - * 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) +static int +pre_prologue(struct mdoc *mdoc, struct mdoc_node *node) { - int lastarg, j; - char *args[MDOC_LINEARG_MAX]; - struct mdoc_node *n; - assert( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)); + if (SEC_PROLOGUE != mdoc->sec_lastn) + return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue")); + assert(MDOC_ELEM == node->type); - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + /* Check for ordering. */ - /* Token pre-processing. */ - - switch (tok) { - case (MDOC_Ss): - /* FALLTHROUGH */ - case (MDOC_Sh): - /* `.Pp' ignored when preceding `.Ss' or `.Sh'. */ - if (NULL == mdoc->last) + switch (node->tok) { + case (MDOC_Os): + if (mdoc->meta.title && mdoc->meta.date) break; - if (MDOC_ELEM != mdoc->last->type) + return(mdoc_nerr(mdoc, node, "prologue macro out-of-order")); + case (MDOC_Dt): + if (NULL == mdoc->meta.title && mdoc->meta.date) break; - if (MDOC_Pp != mdoc->last->data.elem.tok) + return(mdoc_nerr(mdoc, node, "prologue macro out-of-order")); + case (MDOC_Dd): + if (NULL == mdoc->meta.title && 0 == mdoc->meta.date) break; - if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_BEFORE_BLK)) - return(0); - 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; + return(mdoc_nerr(mdoc, node, "prologue macro out-of-order")); default: - break; + abort(); + /* NOTREACHED */ } - /* Rewind our scope. */ + /* Check for repetition. */ - if ( ! scope_rewind_imp(mdoc, ppos, tok)) - return(0); + switch (node->tok) { + case (MDOC_Os): + if (NULL == mdoc->meta.os) + return(1); + break; + case (MDOC_Dd): + if (0 == mdoc->meta.date) + return(1); + break; + case (MDOC_Dt): + if (NULL == mdoc->meta.title) + return(1); + break; + default: + abort(); + /* NOTREACHED */ + } - j = 0; - lastarg = ppos; + return(mdoc_nerr(mdoc, node, "prologue macro repeated")); +} - /* - * Process until we hit a line. Note that current implicit - * macros don't have any arguments, so we don't need to do any - * argument processing. - */ -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); +static int +post_bf(struct mdoc *mdoc) +{ + char *p; + struct mdoc_node *head; - lastarg = *pos; + if (MDOC_BLOCK != mdoc->last->type) + return(1); + assert(MDOC_Bf == mdoc->last->tok); + head = mdoc->last->data.block.head; + assert(head); - switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[j])) { - case (ARGS_ERROR): - return(0); - case (ARGS_EOLN): - return(append_scoped(mdoc, tok, ppos, j, _CC(args), 0, NULL)); - default: - break; + if (0 == mdoc->last->data.block.argc) { + if (head->child) { + assert(MDOC_TEXT == head->child->type); + p = head->child->data.text.string; + if (xstrcmp(p, "Em")) + return(1); + else if (xstrcmp(p, "Li")) + return(1); + else if (xstrcmp(p, "Sm")) + return(1); + return(mdoc_nerr(mdoc, head->child, "invalid font mode")); + } + return(mdoc_err(mdoc, "macro expects an argument or parameter")); } + if (head->child) + return(mdoc_err(mdoc, "macro expects an argument or parameter")); + if (1 == mdoc->last->data.block.argc) + return(1); + return(mdoc_err(mdoc, "macro expects an argument or parameter")); +} - 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 +post_nm(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + assert(MDOC_Nm == mdoc->last->tok); + if (mdoc->last->child) + return(1); + if (mdoc->meta.name) + return(1); + return(mdoc_err(mdoc, "macro `%s' has not been invoked with a name", + mdoc_macronames[MDOC_Nm])); } -/* - * 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) +static int +post_xr(struct mdoc *mdoc) { - int lastarg, c, j; - char *p; - struct mdoc_node *n; + struct mdoc_node *n; - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + assert(MDOC_ELEM == mdoc->last->type); + assert(MDOC_Xr == mdoc->last->tok); + assert(mdoc->last->child); + assert(MDOC_TEXT == mdoc->last->child->type); - assert(1 == ppos); - - /* Token pre-processing. */ + if (NULL == (n = mdoc->last->child->next)) + return(1); + assert(MDOC_TEXT == n->type); + if (MSEC_DEFAULT != mdoc_atomsec(n->data.text.string)) + return(1); + return(mdoc_nerr(mdoc, n, "invalid manual section")); +} - 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. - */ +static int +post_at(struct mdoc *mdoc) +{ - mdoc_block_alloc(mdoc, ppos, tok, 0, NULL); - mdoc_head_alloc(mdoc, ppos, tok, 0, NULL); + assert(MDOC_ELEM == mdoc->last->type); + assert(MDOC_At == mdoc->last->tok); - /* Process line parameters. */ + if (NULL == mdoc->last->child) + return(1); + assert(MDOC_TEXT == mdoc->last->child->type); - j = 0; - lastarg = ppos; + if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string)) + return(1); + return(mdoc_err(mdoc, "macro expects a valid AT&T version symbol")); +} -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); +static int +post_an(struct mdoc *mdoc) +{ - switch (c) { - case (ARGS_ERROR): - 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 */ - } + assert(MDOC_ELEM == mdoc->last->type); + assert(MDOC_An == mdoc->last->tok); - 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)); + if (0 != mdoc->last->data.elem.argc) { + if (NULL == mdoc->last->child) + return(1); + return(mdoc_err(mdoc, "macro expects either argument or parameters")); } - if (mdoc_isdelim(p)) - j = 0; + if (mdoc->last->child) + return(1); + return(mdoc_err(mdoc, "macro expects either argument or parameters")); +} - mdoc_word_alloc(mdoc, lastarg, p); - goto again; - /* NOTREACHED */ + +static int +post_ex(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + assert(MDOC_Ex == mdoc->last->tok); + + if (0 == mdoc->last->data.elem.argc) { + if (mdoc->last->child) + return(1); + return(mdoc_err(mdoc, "macro expects `%s' or a single child", + mdoc_argnames[MDOC_Std])); + } + if (mdoc->last->child) + return(mdoc_err(mdoc, "macro expects `%s' or a single child", + mdoc_argnames[MDOC_Std])); + if (1 != mdoc->last->data.elem.argc) + return(mdoc_err(mdoc, "macro expects `%s' or a single child", + mdoc_argnames[MDOC_Std])); + if (MDOC_Std != mdoc->last->data.elem.argv[0].arg) + return(mdoc_err(mdoc, "macro expects `%s' or a single child", + mdoc_argnames[MDOC_Std])); + return(1); } -/* - * 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) +/* Warn if `Bl' type-specific syntax isn't reflected in items. */ +static int +post_it(struct mdoc *mdoc) { - int lastarg, c, j; - char *p; + int type, sv; +#define TYPE_NONE (0) +#define TYPE_BODY (1) +#define TYPE_HEAD (2) + size_t i, argc; + struct mdoc_node *n; - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + if (MDOC_BLOCK != mdoc->last->type) + return(1); - /* Token pre-processing. */ + assert(MDOC_It == mdoc->last->tok); - switch (tok) { - case (MDOC_Ql): - if ( ! mdoc_warn(mdoc, tok, ppos, WARN_COMPAT_TROFF)) - return(0); - break; - default: - break; - } + n = mdoc->last->parent; + assert(n); + assert(MDOC_Bl == n->tok); - mdoc_block_alloc(mdoc, ppos, tok, 0, NULL); - mdoc_head_alloc(mdoc, ppos, tok, 0, NULL); + n = n->parent; + assert(MDOC_BLOCK == n->type); + assert(MDOC_Bl == n->tok); - /* Process line parameters. */ + argc = n->data.block.argc; + type = TYPE_NONE; + sv = -1; + + /* Some types require block-head, some not. */ - j = 0; - lastarg = ppos; + /* LINTED */ + for (i = 0; TYPE_NONE == type && i < argc; i++) + switch (n->data.block.argv[(int)i].arg) { + case (MDOC_Tag): + /* FALLTHROUGH */ + case (MDOC_Diag): + /* FALLTHROUGH */ + case (MDOC_Hang): + /* FALLTHROUGH */ + case (MDOC_Ohang): + /* FALLTHROUGH */ + case (MDOC_Inset): + type = TYPE_HEAD; + sv = n->data.block.argv[(int)i].arg; + break; + case (MDOC_Bullet): + /* FALLTHROUGH */ + case (MDOC_Dash): + /* FALLTHROUGH */ + case (MDOC_Enum): + /* FALLTHROUGH */ + case (MDOC_Hyphen): + /* FALLTHROUGH */ + case (MDOC_Item): + /* FALLTHROUGH */ + case (MDOC_Column): + type = TYPE_BODY; + sv = n->data.block.argv[(int)i].arg; + break; + default: + break; + } -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + assert(TYPE_NONE != type); - lastarg = *pos; - c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p); + if (TYPE_HEAD == type) { + n = mdoc->last->data.block.head; + assert(n); + if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters")) + return(0); - switch (c) { - case (ARGS_ERROR): - 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 */ + n = mdoc->last->data.block.body; + assert(n); + if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children")) + return(0); + + return(1); } - if (MDOC_MAX != (c = mdoc_find(mdoc, p))) { - if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + assert(TYPE_BODY == type); + assert(mdoc->last->data.block.head); + + n = mdoc->last->data.block.head; + assert(n); + if (n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no line parameters")) return(0); - if ( ! scope_rewind_imp(mdoc, ppos, tok)) + + n = mdoc->last->data.block.body; + assert(n); + if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children")) return(0); - if (ppos > 1) - return(1); - return(append_delims(mdoc, tok, pos, buf)); - } - if (mdoc_isdelim(p)) - j = 0; + assert(-1 != sv); + if (MDOC_Column != sv) + return(1); - mdoc_word_alloc(mdoc, lastarg, p); - goto again; - /* NOTREACHED */ -} + /* Make sure the number of columns is sane. */ + argc = mdoc->last->parent->parent->data.block.argv->sz; + n = mdoc->last->data.block.head->child; -/* - * 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) -{ - int lastarg, flushed, c, maxargs; - char *p; + for (i = 0; n; n = n->next) + i++; - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + if (i == argc) + return(1); + return(mdoc_err(mdoc, "expected %zu list columns, have %zu", argc, i)); +#undef TYPE_NONE +#undef TYPE_BODY +#undef TYPE_HEAD +} - /* Process line parameters. */ - lastarg = ppos; - flushed = 0; +static int +post_bl(struct mdoc *mdoc) +{ + struct mdoc_node *n; - /* Token pre-processing. */ + if (MDOC_BODY != mdoc->last->type) + return(1); + assert(MDOC_Bl == mdoc->last->tok); - switch (tok) { - case (MDOC_Ux): - maxargs = 0; + /* LINTED */ + for (n = mdoc->last->child; n; n = n->next) { + if (MDOC_BLOCK == n->type) + if (MDOC_It == n->tok) + continue; break; - default: - maxargs = 1; - break; } + if (NULL == n) + return(1); + return(mdoc_nerr(mdoc, n, "invalid child of parent macro `Bl'")); +} -again: - lastarg = *pos; - switch (mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p)) { - case (ARGS_ERROR): - return(0); - case (ARGS_WORD): +static int +ebool(struct mdoc *mdoc) +{ + struct mdoc_node *n; + + assert(MDOC_ELEM == mdoc->last->type); + /* LINTED */ + for (n = mdoc->last->child; n; n = n->next) { + if (MDOC_TEXT != n->type) + break; + if (xstrcmp(n->data.text.string, "on")) + continue; + if (xstrcmp(n->data.text.string, "off")) + continue; 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 (NULL == n) + return(1); + return(mdoc_nerr(mdoc, n, "expected boolean value")); +} - /* Accepts no arguments: flush out symbol and continue. */ - if (0 == maxargs) { - if ( ! append_const(mdoc, tok, ppos, 0, &p)) - return(0); - flushed = 1; - } +static int +post_root(struct mdoc *mdoc) +{ - 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 */ + if (NULL == mdoc->last->child) + return(mdoc_err(mdoc, "document has no data")); + if (NULL == mdoc->meta.title) + return(mdoc_err(mdoc, "document has incomplete prologue")); + if (NULL == mdoc->meta.os) + return(mdoc_err(mdoc, "document has incomplete prologue")); + if (0 == mdoc->meta.date) + return(mdoc_err(mdoc, "document has incomplete prologue")); + return(1); } -int -macro_constant(MACRO_PROT_ARGS) +/* Warn if conventional sections are out of order. */ +static int +post_sh(struct mdoc *mdoc) { - int lastarg, j; - char *args[MDOC_LINEARG_MAX]; + char buf[64]; + enum mdoc_sec sec; - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + if (MDOC_HEAD != mdoc->last->type) + return(1); + assert(MDOC_Sh == mdoc->last->tok); - j = 0; - lastarg = ppos; + if ( ! xstrlcats(buf, mdoc->last->child, 64)) + return(mdoc_err(mdoc, "macro parameters too long")); -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + if (SEC_CUSTOM == (sec = mdoc_atosec(buf))) + return(1); + if (sec > mdoc->sec_lastn) + return(1); + if (sec == mdoc->sec_lastn) + return(mdoc_warn(mdoc, WARN_SYNTAX, "section repeated")); + return(mdoc_warn(mdoc, WARN_SYNTAX, "section out of conventional order")); +} - 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 */ - } +int +mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node) +{ + v_pre *p; - if (MDOC_MAX != mdoc_find(mdoc, args[j])) - if ( ! mdoc_warn(mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE)) - return(0); + if (MDOC_TEXT == node->type) + return(1); + assert(MDOC_ROOT != node->type); - j++; - goto again; - /* NOTREACHED */ + if (NULL == mdoc_valids[node->tok].pre) + return(1); + for (p = mdoc_valids[node->tok].pre; *p; p++) + if ( ! (*p)(mdoc, node)) + return(0); + return(1); } int -macro_constant_argv(MACRO_PROT_ARGS) +mdoc_valid_post(struct mdoc *mdoc) { - int c, lastarg, j; - struct mdoc_arg argv[MDOC_LINEARG_MAX]; + v_post *p; - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + if (MDOC_VALID & mdoc->last->flags) + return(1); + mdoc->last->flags |= MDOC_VALID; - lastarg = *pos; + if (MDOC_TEXT == mdoc->last->type) + return(1); + if (MDOC_ROOT == mdoc->last->type) + return(post_root(mdoc)); - 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; + if (NULL == mdoc_valids[mdoc->last->tok].post) + return(1); + for (p = mdoc_valids[mdoc->last->tok].post; *p; p++) + if ( ! (*p)(mdoc)) + return(0); - 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); + return(1); } +