=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.8 retrieving revision 1.83 diff -u -p -r1.8 -r1.83 --- mandoc/Attic/validate.c 2008/12/30 13:43:53 1.8 +++ mandoc/Attic/validate.c 2009/03/13 13:56:13 1.83 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.8 2008/12/30 13:43:53 kristaps Exp $ */ +/* $Id: validate.c,v 1.83 2009/03/13 13:56:13 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -16,1144 +16,1367 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ +#include + #include #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. */ +/* FIXME: .Bl -diag can't have non-text children in HEAD. */ +/* TODO: ignoring Pp (it's superfluous in some invocations). */ -#define _CC(p) ((const char **)p) +/* + * 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. + */ -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 *); +#define PRE_ARGS struct mdoc *mdoc, const struct mdoc_node *n +#define POST_ARGS struct mdoc *mdoc +enum merr { + ENODATA, + ENOPROLOGUE, + ELINE, + EATT, + ENAME, + ELISTTYPE, + EDISPTYPE, + EMULTIDISP, + EMULTILIST, + EARGREP, + EBOOL, + ENESTDISP +}; -static int -append_delims(struct mdoc *mdoc, int tok, int *pos, char *buf) -{ - int c, lastarg; - char *p; +enum mwarn { + WWRONGMSEC, + WSECOOO, + WSECREP, + WBADSTAND, + WNAMESECINC, + WNOMULTILINE, + WMULTILINE, + WLINE, + WNOLINE, + WPROLOOO, + WPROLREP, + WARGVAL, + WBADSEC, + WBADMSEC +}; - if (0 == buf[*pos]) - return(1); +typedef int (*v_pre)(PRE_ARGS); +typedef int (*v_post)(POST_ARGS); - mdoc_msg(mdoc, *pos, "`%s' flushing punctuation", - mdoc_macronames[tok]); +struct valids { + v_pre *pre; + v_post *post; +}; - 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); +/* Utility checks. */ + +static int nwarn(struct mdoc *, + const struct mdoc_node *, enum mwarn); +static int nerr(struct mdoc *, + const struct mdoc_node *, enum merr); +static int check_parent(PRE_ARGS, int, enum mdoc_type); +static int check_msec(PRE_ARGS, ...); +static int check_sec(PRE_ARGS, ...); +static int check_stdarg(PRE_ARGS); +static int check_text(struct mdoc *, + int, int, const char *); +static int check_argv(struct mdoc *, + const struct mdoc_node *, + const struct mdoc_argv *); +static int check_args(struct mdoc *, + const struct mdoc_node *); +static int err_child_lt(struct mdoc *, const char *, int); +static int warn_child_lt(struct mdoc *, const char *, int); +static int err_child_gt(struct mdoc *, const char *, int); +static int warn_child_gt(struct mdoc *, const char *, int); +static int err_child_eq(struct mdoc *, const char *, int); +static int warn_child_eq(struct mdoc *, const char *, int); +static inline int count_child(struct mdoc *); +static inline int warn_count(struct mdoc *, const char *, + int, const char *, int); +static inline int err_count(struct mdoc *, const char *, + int, const char *, int); +static int pre_an(PRE_ARGS); +static int pre_bd(PRE_ARGS); +static int pre_bl(PRE_ARGS); +static int pre_cd(PRE_ARGS); +static int pre_dd(PRE_ARGS); +static int pre_display(PRE_ARGS); +static int pre_dt(PRE_ARGS); +static int pre_er(PRE_ARGS); +static int pre_ex(PRE_ARGS); +static int pre_fd(PRE_ARGS); +static int pre_it(PRE_ARGS); +static int pre_lb(PRE_ARGS); +static int pre_os(PRE_ARGS); +static int pre_prologue(PRE_ARGS); +static int pre_rv(PRE_ARGS); +static int pre_sh(PRE_ARGS); +static int pre_ss(PRE_ARGS); +static int herr_ge1(POST_ARGS); +static int hwarn_le1(POST_ARGS); +static int herr_eq0(POST_ARGS); +static int eerr_eq0(POST_ARGS); +static int eerr_le2(POST_ARGS); +static int eerr_eq1(POST_ARGS); +static int eerr_ge1(POST_ARGS); +static int ewarn_eq0(POST_ARGS); +static int ewarn_eq1(POST_ARGS); +static int bwarn_ge1(POST_ARGS); +static int hwarn_eq1(POST_ARGS); +static int ewarn_ge1(POST_ARGS); +static int ebool(POST_ARGS); + +static int post_an(POST_ARGS); +static int post_args(POST_ARGS); +static int post_at(POST_ARGS); +static int post_bf(POST_ARGS); +static int post_bl(POST_ARGS); +static int post_it(POST_ARGS); +static int post_nm(POST_ARGS); +static int post_root(POST_ARGS); +static int post_sh(POST_ARGS); +static int post_sh_body(POST_ARGS); +static int post_sh_head(POST_ARGS); +static int post_st(POST_ARGS); + +static v_pre pres_an[] = { pre_an, NULL }; +static v_pre pres_bd[] = { pre_display, pre_bd, NULL }; +static v_pre pres_bl[] = { pre_bl, NULL }; +static v_pre pres_cd[] = { pre_cd, NULL }; +static v_pre pres_dd[] = { pre_prologue, pre_dd, NULL }; +static v_pre pres_d1[] = { pre_display, NULL }; +static v_pre pres_dt[] = { pre_prologue, pre_dt, NULL }; +static v_pre pres_er[] = { pre_er, NULL }; +static v_pre pres_ex[] = { pre_ex, NULL }; +static v_pre pres_fd[] = { pre_fd, NULL }; +static v_pre pres_it[] = { pre_it, NULL }; +static v_pre pres_lb[] = { pre_lb, NULL }; +static v_pre pres_os[] = { pre_prologue, pre_os, NULL }; +static v_pre pres_rv[] = { pre_rv, NULL }; +static v_pre pres_sh[] = { pre_sh, NULL }; +static v_pre pres_ss[] = { pre_ss, NULL }; +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_pf[] = { eerr_eq1, NULL }; +static v_post posts_lb[] = { eerr_eq1, NULL }; +static v_post posts_st[] = { eerr_eq1, post_st, NULL }; +static v_post posts_pp[] = { ewarn_eq0, NULL }; +static v_post posts_ex[] = { eerr_eq0, post_args, NULL }; +static v_post posts_rv[] = { eerr_eq0, post_args, 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, NULL }; +static v_post posts_nm[] = { post_nm, NULL }; +static v_post posts_bf[] = { hwarn_le1, post_bf, NULL }; +static v_post posts_rs[] = { herr_eq0, bwarn_ge1, NULL }; +static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL }; +static v_post posts_bk[] = { herr_eq0, bwarn_ge1, NULL }; +static v_post posts_fd[] = { ewarn_ge1, NULL }; + +const struct valids mdoc_valids[MDOC_MAX] = { + { NULL, NULL }, /* \" */ + { pres_dd, posts_text }, /* Dd */ + { pres_dt, NULL }, /* Dt */ + { pres_os, NULL }, /* Os */ + { 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 */ + { pres_fd, posts_fd }, /* 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_rv }, /* Rv */ + { NULL, posts_st }, /* 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 */ + { 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, posts_pf }, /* 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 */ + { pres_lb, posts_lb }, /* Lb */ + { NULL, NULL }, /* Ap */ + { NULL, posts_pp }, /* Lp */ + { NULL, posts_text }, /* Lk */ + { NULL, posts_text }, /* Mt */ + { NULL, posts_wline }, /* Brq */ + { NULL, NULL }, /* Bro */ + { NULL, NULL }, /* Brc */ + { NULL, posts_text }, /* %C */ +}; + + +int +mdoc_valid_pre(struct mdoc *mdoc, + const struct mdoc_node *node) +{ + v_pre *p; + int line, pos; + const char *tp; + + if (MDOC_TEXT == node->type) { + tp = node->string; + line = node->line; + pos = node->pos; + return(check_text(mdoc, line, pos, tp)); } + if ( ! check_args(mdoc, node)) + return(0); + 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); } -static int -scope_rewind_imp(struct mdoc *mdoc, int ppos, int tok) +int +mdoc_valid_post(struct mdoc *mdoc) { - struct mdoc_node *n; - int t; + v_post *p; - n = mdoc->last ? mdoc->last->parent : NULL; + /* + * This check occurs after the macro's children have been filled + * in: postfix validation. Since this happens when we're + * rewinding the scope tree, it's possible to have multiple + * invocations (as by design, for now), we set bit MDOC_VALID to + * indicate that we've validated. + */ - /* 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 (MDOC_VALID & mdoc->last->flags) + return(1); + mdoc->last->flags |= MDOC_VALID; - if (n) { - mdoc->last = n; - mdoc_msg(mdoc, ppos, "scope: rewound implicit `%s'", - mdoc_macronames[tok]); + if (MDOC_TEXT == mdoc->last->type) return(1); - } + if (MDOC_ROOT == mdoc->last->type) + return(post_root(mdoc)); - mdoc_msg(mdoc, ppos, "scope: new implicit `%s'", - mdoc_macronames[tok]); + 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); + return(1); } +#define merr(m, t) nerr((m), (m)->last, (t)) static int -scope_rewind_exp(struct mdoc *mdoc, int ppos, int tok, int dst) +nerr(struct mdoc *m, const struct mdoc_node *n, enum merr type) { - struct mdoc_node *n; + char *p; + + p = NULL; - assert(mdoc->last); - - /* 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)); + switch (type) { + case (ENESTDISP): + p = "displays may not be nested"; + break; + case (EBOOL): + p = "expected boolean value"; + break; + case (EARGREP): + p = "argument repeated"; + break; + case (EMULTIDISP): + p = "multiple display types specified"; + break; + case (EMULTILIST): + p = "multiple list types specified"; + break; + case (ELISTTYPE): + p = "missing list type"; + break; + case (EDISPTYPE): + p = "missing display type"; + break; + case (ELINE): + p = "expected line arguments"; + break; + case (ENOPROLOGUE): + p = "document has no prologue"; + break; + case (ENODATA): + p = "document has no data"; + break; + case (EATT): + p = "expected valid AT&T symbol"; + break; + case (ENAME): + p = "default name not yet set"; + 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); + assert(p); + return(mdoc_nerr(m, n, p)); } +#define mwarn(m, t) nwarn((m), (m)->last, (t)) static int -append_constarg(struct mdoc *mdoc, int tok, int pos, - int argc, const struct mdoc_arg *argv) +nwarn(struct mdoc *m, const struct mdoc_node *n, enum mwarn type) { + char *p; + enum mdoc_warn c; - switch (tok) { - default: + c = WARN_SYNTAX; + p = NULL; + + switch (type) { + case (WBADMSEC): + p = "inappropriate manual section"; + c = WARN_COMPAT; break; + case (WBADSEC): + p = "inappropriate document section"; + c = WARN_COMPAT; + break; + case (WARGVAL): + p = "argument value suggested"; + c = WARN_COMPAT; + break; + case (WPROLREP): + p = "prologue macros repeated"; + c = WARN_COMPAT; + break; + case (WPROLOOO): + p = "prologue macros out-of-order"; + c = WARN_COMPAT; + break; + case (WNOLINE): + p = "suggested no line arguments"; + break; + case (WLINE): + p = "suggested line arguments"; + break; + case (WMULTILINE): + p = "suggested multi-line arguments"; + break; + case (WNOMULTILINE): + p = "suggested no multi-line arguments"; + break; + case (WWRONGMSEC): + p = "document section in wrong manual section"; + c = WARN_COMPAT; + break; + case (WSECOOO): + p = "document section out of conventional order"; + break; + case (WSECREP): + p = "document section repeated"; + break; + case (WBADSTAND): + p = "unknown standard"; + break; + case (WNAMESECINC): + p = "NAME section contents incomplete/badly-ordered"; + break; } + assert(p); + return(mdoc_nwarn(m, n, c, p)); +} - mdoc_elem_alloc(mdoc, pos, tok, argc, argv, 0, NULL); - return(1); + + +static inline int +warn_count(struct mdoc *m, const char *k, + int want, const char *v, int has) +{ + + return(mdoc_warn(m, WARN_SYNTAX, + "suggests %s %s %d (has %d)", v, k, want, has)); } +static inline int +err_count(struct mdoc *m, const char *k, + int want, const char *v, int has) +{ + + return(mdoc_err(m, + "requires %s %s %d (has %d)", v, k, want, has)); +} + + +static inline int +count_child(struct mdoc *mdoc) +{ + int i; + struct mdoc_node *n; + + for (i = 0, n = mdoc->last->child; n; n = n->next, i++) + /* Do nothing */ ; + + return(i); +} + + /* - * Append a node with implicit or explicit scoping ONLY. ALL macros - * with the implicit- or explicit-scope callback must be included here. + * Build these up with macros because they're basically the same check + * for different inequalities. Yes, this could be done with functions, + * but this is reasonable for now. */ + +#define CHECK_CHILD_DEFN(lvl, name, ineq) \ +static int \ +lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \ +{ \ + int i; \ + if ((i = count_child(mdoc)) ineq sz) \ + return(1); \ + return(lvl##_count(mdoc, #ineq, sz, p, i)); \ +} + +#define CHECK_BODY_DEFN(name, lvl, func, num) \ +static int \ +b##lvl##_##name(POST_ARGS) \ +{ \ + if (MDOC_BODY != mdoc->last->type) \ + return(1); \ + return(func(mdoc, "multi-line arguments", (num))); \ +} + +#define CHECK_ELEM_DEFN(name, lvl, func, num) \ +static int \ +e##lvl##_##name(POST_ARGS) \ +{ \ + assert(MDOC_ELEM == mdoc->last->type); \ + return(func(mdoc, "line arguments", (num))); \ +} + +#define CHECK_HEAD_DEFN(name, lvl, func, num) \ +static int \ +h##lvl##_##name(POST_ARGS) \ +{ \ + if (MDOC_HEAD != mdoc->last->type) \ + return(1); \ + return(func(mdoc, "line arguments", (num))); \ +} + + +CHECK_CHILD_DEFN(warn, gt, >) /* warn_child_gt() */ +CHECK_CHILD_DEFN(err, gt, >) /* err_child_gt() */ +CHECK_CHILD_DEFN(warn, eq, ==) /* warn_child_eq() */ +CHECK_CHILD_DEFN(err, eq, ==) /* err_child_eq() */ +CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */ +CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */ +CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */ +CHECK_ELEM_DEFN(eq1, warn, warn_child_eq, 1) /* ewarn_eq1() */ +CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0) /* ewarn_eq0() */ +CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_gt1() */ +CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */ +CHECK_ELEM_DEFN(le2, err, err_child_lt, 3) /* eerr_le2() */ +CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */ +CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */ +CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */ +CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2) /* hwarn_le1() */ +CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0) /* herr_ge1() */ +CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1) /* hwarn_eq1() */ + + static int -append_scoped(struct mdoc *mdoc, int tok, int pos, - int sz, const char *args[], - int argc, const struct mdoc_arg *argv) +check_stdarg(PRE_ARGS) { - enum mdoc_sec sec; - struct mdoc_node *node; - switch (tok) { - /* ======= ADD MORE MACRO CHECKS BELOW. ======= */ + if (n->args && 1 == n->args->argc) + if (MDOC_Std == n->args->argv[0].arg) + return(1); + return(nwarn(mdoc, n, WARGVAL)); +} - 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 +check_sec(PRE_ARGS, ...) +{ + enum mdoc_sec sec; + va_list ap; - 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; + va_start(ap, n); - 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; + for (;;) { /* LINTED */ - for ( ; node; node = node->parent) { - if (node->type != MDOC_BLOCK) - continue; - if (node->data.block.tok != MDOC_Bd) - continue; + sec = (enum mdoc_sec)va_arg(ap, int); + if (SEC_CUSTOM == sec) break; - } - if (NULL == node) - break; - return(mdoc_err(mdoc, tok, pos, ERR_SCOPE_NONEST)); - - case (MDOC_Bl): - break; - - /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */ - default: - abort(); - /* NOTREACHED */ + if (sec != mdoc->lastsec) + continue; + va_end(ap); + return(1); } - 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); + va_end(ap); + return(nwarn(mdoc, n, WBADSEC)); } static int -append_const(struct mdoc *mdoc, int tok, - int pos, int sz, char *args[]) +check_msec(PRE_ARGS, ...) { + va_list ap; + int msec; - switch (tok) { - /* ======= ADD MORE MACRO CHECKS BELOW. ======= */ - - /* FIXME: this is the ugliest part of this page. */ - case (MDOC_At): - /* This needs special handling. */ - if (0 == sz) + va_start(ap, n); + for (;;) { + /* LINTED */ + if (0 == (msec = va_arg(ap, int))) break; - else if (sz > 2) - return(mdoc_err(mdoc, tok, pos, ERR_ARGS_LE2)); + if (msec != mdoc->meta.msec) + continue; + va_end(ap); + return(1); + } - 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]); - } + va_end(ap); + return(nwarn(mdoc, n, WBADMSEC)); +} - 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]); + +static int +check_args(struct mdoc *m, const struct mdoc_node *n) +{ + int i; + + if (NULL == n->args) return(1); - case (MDOC_Nd): - if (sz > 0) - break; - if ( ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_GE1)) + assert(n->args->argc); + for (i = 0; i < (int)n->args->argc; i++) + if ( ! check_argv(m, n, &n->args->argv[i])) 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; + return(1); +} - 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)); +static int +check_argv(struct mdoc *m, const struct mdoc_node *n, + const struct mdoc_argv *v) +{ + int i; - /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */ - default: - abort(); - /* NOTREACHED */ + for (i = 0; i < (int)v->sz; i++) + if ( ! check_text(m, v->line, v->pos, v->value[i])) + return(0); + + if (MDOC_Std == v->arg) { + /* `Nm' name must be set. */ + if (v->sz || m->meta.name) + return(1); + return(nerr(m, n, ENAME)); } - mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, (size_t)sz, _CC(args)); return(1); } static int -append_text(struct mdoc *mdoc, int tok, - int pos, int sz, char *args[]) +check_text(struct mdoc *mdoc, int line, int pos, const char *p) { + size_t c; - switch (tok) { - /* ======= ADD MORE MACRO CHECKS BELOW. ======= */ - case (MDOC_Pp): - if (0 == sz) - break; - if ( ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_EQ0)) + /* XXX - indicate deprecated escapes \*(xx and \*x. */ + + for ( ; *p; p++) { + if ( ! isprint((u_char)*p) && '\t' != *p) + return(mdoc_perr(mdoc, line, pos, + "invalid non-printing character")); + if ('\\' != *p) + continue; + if ((c = mdoc_isescape(p))) { + p += (int)c - 1; + continue; + } + if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags)) + return(mdoc_perr(mdoc, line, pos, + "invalid escape sequence")); + if ( ! mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, + "invalid escape sequence")) 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) + return(1); +} + + + + +static int +check_parent(PRE_ARGS, int tok, enum mdoc_type t) +{ + + assert(n->parent); + if ((MDOC_ROOT == t || tok == n->parent->tok) && + (t == n->parent->type)) + return(1); + + return(mdoc_nerr(mdoc, n, "require parent %s", + MDOC_ROOT == t ? "" : mdoc_macronames[tok])); +} + + + +static int +pre_display(PRE_ARGS) +{ + struct mdoc_node *node; + + /* Display elements (`Bd', `D1'...) cannot be nested. */ + + if (MDOC_BLOCK != n->type) + return(1); + + /* LINTED */ + for (node = mdoc->last->parent; node; node = node->parent) + if (MDOC_BLOCK == node->type) + if (MDOC_Bd == node->tok) + break; + if (NULL == node) + return(1); + + return(nerr(mdoc, n, ENESTDISP)); +} + + +static int +pre_bl(PRE_ARGS) +{ + int i, type, width, offset; + + if (MDOC_BLOCK != n->type) + return(1); + if (NULL == n->args) + return(nerr(mdoc, n, ELISTTYPE)); + + /* Make sure that only one type of list is specified. */ + + type = offset = width = -1; + + /* LINTED */ + for (i = 0; i < (int)n->args->argc; i++) + switch (n->args->argv[i].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 (-1 == type) { + type = n->args->argv[i].arg; + break; + } + return(nerr(mdoc, n, EMULTILIST)); + case (MDOC_Width): + if (-1 == width) { + width = n->args->argv[i].arg; + break; + } + return(nerr(mdoc, n, EARGREP)); + case (MDOC_Offset): + if (-1 == offset) { + offset = n->args->argv[i].arg; + break; + } + return(nerr(mdoc, n, EARGREP)); + default: 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; + if (-1 == type) + return(nerr(mdoc, n, ELISTTYPE)); - case (MDOC_Ad): + switch (type) { + case (MDOC_Column): /* FALLTHROUGH */ - case (MDOC_Em): + case (MDOC_Diag): /* FALLTHROUGH */ - case (MDOC_Er): + case (MDOC_Inset): /* 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) + case (MDOC_Item): + if (-1 == width) break; - return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1)); - /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */ + return(mdoc_nwarn(mdoc, n, WARN_SYNTAX, + "superfluous %s argument", + mdoc_argnames[MDOC_Width])); + case (MDOC_Tag): + if (-1 != width) + break; + return(mdoc_nerr(mdoc, n, "missing %s argument", + mdoc_argnames[MDOC_Width])); default: - abort(); - /* NOTREACHED */ + break; } - mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, (size_t)sz, _CC(args)); return(1); } -int -macro_text(MACRO_PROT_ARGS) +static int +pre_bd(PRE_ARGS) { - int lastarg, lastpunct, c, j; - char *args[MDOC_LINEARG_MAX]; + int i, type, err; - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + if (MDOC_BLOCK != n->type) + return(1); + if (NULL == n->args) + return(nerr(mdoc, n, EDISPTYPE)); - /* Token pre-processing. */ + /* Make sure that only one type of display is specified. */ - 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): + /* LINTED */ + for (i = 0, err = type = 0; ! err && + i < (int)n->args->argc; i++) + switch (n->args->argv[i].arg) { + case (MDOC_Ragged): /* FALLTHROUGH */ - case (MDOC_Sh): - if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_AFTER_BLK)) - return(0); - return(1); + case (MDOC_Unfilled): + /* FALLTHROUGH */ + case (MDOC_Filled): + /* FALLTHROUGH */ + case (MDOC_Literal): + /* FALLTHROUGH */ + case (MDOC_File): + if (0 == type++) + break; + return(nerr(mdoc, n, EMULTIDISP)); default: break; } - break; - default: - break; - } - /* Process line parameters. */ + if (type) + return(1); + return(nerr(mdoc, n, EDISPTYPE)); +} - j = 0; - lastarg = ppos; - lastpunct = 0; -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); +static int +pre_ss(PRE_ARGS) +{ - /* - * 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. - */ + if (MDOC_BLOCK != n->type) + return(1); + return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY)); +} - 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 +pre_sh(PRE_ARGS) +{ - /* - * Command found. First flush out arguments, then call the - * command. If we're the line macro when it exits, flush - * terminal punctuation. - */ + if (MDOC_BLOCK != n->type) + return(1); + return(check_parent(mdoc, n, -1, MDOC_ROOT)); +} - 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 +pre_it(PRE_ARGS) +{ - if ( ! mdoc_isdelim(args[j])) { - /* Words are appended to the array of arguments. */ - j++; - lastpunct = 0; - goto again; - } + if (MDOC_BLOCK != n->type) + return(1); + return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY)); +} - /* - * 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 +pre_an(PRE_ARGS) +{ - mdoc_word_alloc(mdoc, lastarg, args[j]); - j = 0; - lastpunct = 1; - - goto again; - /* NOTREACHED */ + if (NULL == n->args || 1 == n->args->argc) + return(1); + return(mdoc_nerr(mdoc, n, "only one argument allowed")); } -int -macro_prologue_dtitle(MACRO_PROT_ARGS) +static int +pre_lb(PRE_ARGS) { - 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.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)); + return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM)); +} - j = -1; - lastarg = ppos; -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); +static int +pre_rv(PRE_ARGS) +{ - 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): + if ( ! check_msec(mdoc, n, 2, 3, 0)) return(0); - default: - break; - } + return(check_stdarg(mdoc, n)); +} - if (MDOC_MAX != mdoc_find(mdoc, args[j]) && ! mdoc_warn - (mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE)) + +static int +pre_ex(PRE_ARGS) +{ + + if ( ! check_msec(mdoc, n, 1, 6, 8, 0)) return(0); + return(check_stdarg(mdoc, n)); +} - 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)); +static int +pre_er(PRE_ARGS) +{ - } 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(check_msec(mdoc, n, 2, 0)); +} - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + +static int +pre_cd(PRE_ARGS) +{ + + return(check_msec(mdoc, n, 4, 0)); } -int -macro_prologue_os(MACRO_PROT_ARGS) +static int +pre_prologue(PRE_ARGS) { - 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)); + return(check_sec(mdoc, n, SEC_PROLOGUE, SEC_CUSTOM)); +} - j = -1; - lastarg = ppos; -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); +static int +pre_dt(PRE_ARGS) +{ - lastarg = *pos; + if (0 == mdoc->meta.date || mdoc->meta.os) + if ( ! nwarn(mdoc, n, WPROLOOO)) + return(0); + if (mdoc->meta.title) + if ( ! nwarn(mdoc, n, WPROLREP)) + return(0); + return(1); +} - 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); - 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 +pre_os(PRE_ARGS) +{ + + if (NULL == mdoc->meta.title || 0 == mdoc->meta.date) + if ( ! nwarn(mdoc, n, WPROLOOO)) + return(0); + if (mdoc->meta.os) + if ( ! nwarn(mdoc, n, WPROLREP)) + return(0); + return(1); } -int -macro_prologue_ddate(MACRO_PROT_ARGS) +static int +pre_dd(PRE_ARGS) { - 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.title || mdoc->meta.os) + if ( ! nwarn(mdoc, n, WPROLOOO)) + return(0); if (mdoc->meta.date) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_REP)); + if ( ! nwarn(mdoc, n, WPROLREP)) + return(0); + return(1); +} - j = -1; - date[0] = 0; - lastarg = ppos; -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); +static int +post_bf(POST_ARGS) +{ + char *p; + struct mdoc_node *head; - lastarg = *pos; - switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[++j])) { - case (ARGS_EOLN): - if (mdoc->meta.date) + if (MDOC_BLOCK != mdoc->last->type) + return(1); + + head = mdoc->last->head; + + if (NULL == mdoc->last->args) { + if (NULL == head->child || + MDOC_TEXT != head->child->type) + return(mdoc_err(mdoc, "text argument expected")); + + p = head->child->string; + if (xstrcmp(p, "Em")) return(1); - mdoc->meta.date = mdoc_atotime(date); - if (mdoc->meta.date) + else if (xstrcmp(p, "Li")) return(1); - return(mdoc_err(mdoc, tok, ppos, ERR_SYNTAX_ARGFORM)); - case (ARGS_ERROR): - return(0); - default: - break; + else if (xstrcmp(p, "Sm")) + return(1); + return(mdoc_nerr(mdoc, head->child, "invalid font")); } - - 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)); + if (head->child) + return(mdoc_err(mdoc, "one argument expected")); - goto again; - /* NOTREACHED */ + return(1); } -int -macro_scoped_explicit(MACRO_PROT_ARGS) +static int +post_nm(POST_ARGS) { - int c, lastarg, j; - struct mdoc_arg argv[MDOC_LINEARG_MAX]; - struct mdoc_node *n; - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + if (mdoc->last->child) + return(1); + if (mdoc->meta.name) + return(1); + return(merr(mdoc, ENAME)); +} - /* - * 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; - } +static int +post_at(POST_ARGS) +{ - assert(MDOC_EXPLICIT & mdoc_macros[tok].flags); + if (NULL == mdoc->last->child) + return(1); + if (MDOC_TEXT != mdoc->last->child->type) + return(merr(mdoc, EATT)); + if (mdoc_a2att(mdoc->last->child->string)) + return(1); + return(merr(mdoc, EATT)); +} - /* 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); - assert(mdoc->last->prev); - n = mdoc->last; - mdoc->last = mdoc->last->prev; - mdoc->last->next = NULL; - mdoc_node_free(n); - break; - default: - break; +static int +post_an(POST_ARGS) +{ + + if (mdoc->last->args) { + if (NULL == mdoc->last->child) + return(1); + return(merr(mdoc, ELINE)); } - lastarg = *pos; + if (mdoc->last->child) + return(1); + return(merr(mdoc, ELINE)); +} - 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); - } +static int +post_args(POST_ARGS) +{ - 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); + if (mdoc->last->args) + return(1); + return(merr(mdoc, ELINE)); } -/* - * 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 +post_it(POST_ARGS) { - int lastarg, j; - char *args[MDOC_LINEARG_MAX]; - struct mdoc_node *n; + int type, i, cols; + struct mdoc_node *n, *c; - assert( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)); + if (MDOC_BLOCK != mdoc->last->type) + return(1); - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + n = mdoc->last->parent->parent; + if (NULL == n->args) + return(merr(mdoc, ELISTTYPE)); - /* Token pre-processing. */ + /* Some types require block-head, some not. */ - switch (tok) { - case (MDOC_Ss): - /* FALLTHROUGH */ - case (MDOC_Sh): - /* `.Pp' ignored when preceding `.Ss' or `.Sh'. */ - if (NULL == mdoc->last) + /* LINTED */ + for (cols = type = -1, i = 0; -1 == type && + i < (int)n->args->argc; i++) + switch (n->args->argv[i].arg) { + case (MDOC_Tag): + /* FALLTHROUGH */ + case (MDOC_Diag): + /* FALLTHROUGH */ + case (MDOC_Hang): + /* FALLTHROUGH */ + case (MDOC_Ohang): + /* FALLTHROUGH */ + case (MDOC_Inset): + /* FALLTHROUGH */ + case (MDOC_Bullet): + /* FALLTHROUGH */ + case (MDOC_Dash): + /* FALLTHROUGH */ + case (MDOC_Enum): + /* FALLTHROUGH */ + case (MDOC_Hyphen): + /* FALLTHROUGH */ + case (MDOC_Item): + type = n->args->argv[i].arg; break; - if (MDOC_ELEM != mdoc->last->type) + case (MDOC_Column): + type = n->args->argv[i].arg; + cols = (int)n->args->argv[i].sz; break; - if (MDOC_Pp != mdoc->last->data.elem.tok) + default: 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; - default: - break; - } + } - /* Rewind our scope. */ + if (-1 == type) + return(merr(mdoc, ELISTTYPE)); - if ( ! scope_rewind_imp(mdoc, ppos, tok)) - return(0); - - j = 0; - lastarg = ppos; - - /* - * 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)); - - lastarg = *pos; - - 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)); + switch (type) { + case (MDOC_Tag): + if (NULL == mdoc->last->head->child) + if ( ! mwarn(mdoc, WLINE)) + return(0); + break; + case (MDOC_Hang): + /* FALLTHROUGH */ + case (MDOC_Ohang): + /* FALLTHROUGH */ + case (MDOC_Inset): + /* FALLTHROUGH */ + case (MDOC_Diag): + if (NULL == mdoc->last->head->child) + if ( ! mwarn(mdoc, WLINE)) + return(0); + if (NULL == mdoc->last->body->child) + if ( ! mwarn(mdoc, WMULTILINE)) + return(0); + break; + case (MDOC_Bullet): + /* FALLTHROUGH */ + case (MDOC_Dash): + /* FALLTHROUGH */ + case (MDOC_Enum): + /* FALLTHROUGH */ + case (MDOC_Hyphen): + /* FALLTHROUGH */ + case (MDOC_Item): + if (mdoc->last->head->child) + if ( ! mwarn(mdoc, WNOLINE)) + return(0); + if (NULL == mdoc->last->body->child) + if ( ! mwarn(mdoc, WMULTILINE)) + return(0); + break; + case (MDOC_Column): + if (NULL == mdoc->last->head->child) + if ( ! mwarn(mdoc, WLINE)) + return(0); + if (mdoc->last->body->child) + if ( ! mwarn(mdoc, WNOMULTILINE)) + return(0); + c = mdoc->last->child; + for (i = 0; c && MDOC_HEAD == c->type; c = c->next) + i++; + if (i == cols) + break; + return(mdoc_err(mdoc, "column mismatch (have " + "%d, want %d)", i, cols)); default: break; } - if (MDOC_MAX != mdoc_find(mdoc, args[j])) - if ( ! mdoc_warn(mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE)) - return(0); - - j++; - goto again; - /* NOTREACHED */ + return(1); } -/* - * 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_bl(POST_ARGS) { - 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)); + if (MDOC_BODY != mdoc->last->type) + return(1); + if (NULL == mdoc->last->child) + return(1); - assert(1 == ppos); - - /* Token pre-processing. */ - - 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) + /* LINTED */ + for (n = mdoc->last->child; n; n = n->next) { + if (MDOC_BLOCK == n->type) + if (MDOC_It == n->tok) 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; + return(mdoc_nerr(mdoc, n, "bad child of parent %s", + mdoc_macronames[mdoc->last->tok])); } - /* - * 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. - */ + return(1); +} - mdoc_block_alloc(mdoc, ppos, tok, 0, NULL); - mdoc_head_alloc(mdoc, ppos, tok, 0, NULL); - /* Process line parameters. */ +static int +ebool(struct mdoc *mdoc) +{ + struct mdoc_node *n; - 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); - case (ARGS_WORD): + /* LINTED */ + for (n = mdoc->last->child; n; n = n->next) { + if (MDOC_TEXT != n->type) + break; + if (xstrcmp(n->string, "on")) + continue; + if (xstrcmp(n->string, "off")) + continue; 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 */ } - 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 (mdoc_isdelim(p)) - j = 0; - - mdoc_word_alloc(mdoc, lastarg, p); - goto again; - /* NOTREACHED */ + if (NULL == n) + return(1); + return(nerr(mdoc, n, EBOOL)); } -/* - * 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) +static int +post_root(POST_ARGS) { - int lastarg, c, j; - char *p; - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + if (NULL == mdoc->first->child) + return(merr(mdoc, ENODATA)); + if (SEC_PROLOGUE == mdoc->lastnamed) + return(merr(mdoc, ENOPROLOGUE)); - /* Token pre-processing. */ + if (MDOC_BLOCK != mdoc->first->child->type) + return(merr(mdoc, ENODATA)); + if (MDOC_Sh != mdoc->first->child->tok) + return(merr(mdoc, ENODATA)); - switch (tok) { - case (MDOC_Ql): - if ( ! mdoc_warn(mdoc, tok, ppos, WARN_COMPAT_TROFF)) - return(0); - break; - default: - break; - } + return(1); +} - mdoc_block_alloc(mdoc, ppos, tok, 0, NULL); - mdoc_head_alloc(mdoc, ppos, tok, 0, NULL); - /* Process line parameters. */ +static int +post_st(POST_ARGS) +{ - j = 0; - lastarg = ppos; + if (mdoc_a2st(mdoc->last->child->string)) + return(1); + return(mwarn(mdoc, WBADSTAND)); +} -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_sh(POST_ARGS) +{ - 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 */ - } + if (MDOC_HEAD == mdoc->last->type) + return(post_sh_head(mdoc)); + if (MDOC_BODY == mdoc->last->type) + return(post_sh_body(mdoc)); - 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)); - } - - if (mdoc_isdelim(p)) - j = 0; - - mdoc_word_alloc(mdoc, lastarg, p); - goto again; - /* NOTREACHED */ + return(1); } -/* - * 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) +static int +post_sh_body(POST_ARGS) { - int lastarg, flushed, c, maxargs; - char *p; + struct mdoc_node *n; - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + if (SEC_NAME != mdoc->lastnamed) + return(1); - /* Process line parameters. */ + /* + * Warn if the NAME section doesn't contain the `Nm' and `Nd' + * macros (can have multiple `Nm' and one `Nd'). Note that the + * children of the BODY declaration can also be "text". + */ - lastarg = ppos; - flushed = 0; + if (NULL == (n = mdoc->last->child)) + return(mwarn(mdoc, WNAMESECINC)); - /* Token pre-processing. */ - - switch (tok) { - case (MDOC_Ux): - maxargs = 0; - break; - 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)) + for ( ; n && n->next; n = n->next) { + if (MDOC_ELEM == n->type && MDOC_Nm == n->tok) + continue; + if (MDOC_TEXT == n->type) + continue; + if ( ! mwarn(mdoc, WNAMESECINC)) 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 */ } - /* Accepts no arguments: flush out symbol and continue. */ + if (MDOC_ELEM == n->type && MDOC_Nd == n->tok) + return(1); + return(mwarn(mdoc, WNAMESECINC)); +} - 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)); - } +static int +post_sh_head(POST_ARGS) +{ + char buf[64]; + enum mdoc_sec sec; - /* - * We only accept one argument; subsequent tokens are considered - * as literal words (until a macro). + /* + * Process a new section. Sections are either "named" or + * "custom"; custom sections are user-defined, while named ones + * usually follow a conventional order and may only appear in + * certain manual sections. */ - 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; - } + assert(MDOC_Sh == mdoc->last->tok); - mdoc_word_alloc(mdoc, lastarg, p); - goto again; - /* NOTREACHED */ -} + (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf)); + sec = mdoc_atosec(buf); -int -macro_constant(MACRO_PROT_ARGS) -{ - int lastarg, j; - char *args[MDOC_LINEARG_MAX]; + /* The NAME section should always be first. */ - if (SEC_PROLOGUE == mdoc->sec_lastn) - return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE)); + if (SEC_BODY == mdoc->lastnamed && SEC_NAME != sec) + return(mwarn(mdoc, WSECOOO)); + if (SEC_CUSTOM == sec) + return(1); - j = 0; - lastarg = ppos; + /* Check for repeated or out-of-order sections. */ -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + if (sec == mdoc->lastnamed) + return(mwarn(mdoc, WSECREP)); + if (sec < mdoc->lastnamed) + return(mwarn(mdoc, WSECOOO)); - lastarg = *pos; + /* Check particular section/manual section conventions. */ - switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[j])) { - case (ARGS_ERROR): - return(0); - case (ARGS_WORD): + switch (sec) { + case (SEC_LIBRARY): + switch (mdoc->meta.msec) { + case (2): + /* FALLTHROUGH */ + case (3): + break; + default: + return(mwarn(mdoc, WWRONGMSEC)); + } break; - case (ARGS_EOLN): - return(append_const(mdoc, tok, ppos, j, args)); default: - abort(); - /* NOTREACHED */ + break; } - if (MDOC_MAX != mdoc_find(mdoc, args[j])) - if ( ! mdoc_warn(mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE)) - return(0); - - j++; - goto again; - /* NOTREACHED */ + return(1); } -int -macro_constant_argv(MACRO_PROT_ARGS) +static int +pre_fd(PRE_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); + return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM)); }