=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.12 retrieving revision 1.36 diff -u -p -r1.12 -r1.36 --- mandoc/Attic/validate.c 2009/01/02 09:29:06 1.12 +++ mandoc/Attic/validate.c 2009/01/17 16:15:27 1.36 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.12 2009/01/02 09:29:06 kristaps Exp $ */ +/* $Id: validate.c,v 1.36 2009/01/17 16:15:27 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -21,406 +21,1009 @@ #include "private.h" -/* FIXME: `.St' can only have one argument set. */ -typedef int (*v_args_sz)(struct mdoc *, int, int, int); -typedef int (*v_args)(struct mdoc *, int, int, int, - const char *[], int, const struct mdoc_arg *); -typedef int (*v_post)(struct mdoc *, int, int); +typedef int (*v_pre)(struct mdoc *, struct mdoc_node *); +typedef int (*v_post)(struct mdoc *); -static int need_head_child(struct mdoc *, int, int); -static int no_head_child(struct mdoc *, int, int); -static int assert_eq0(struct mdoc *, int, int, int); -static int assert_le1(struct mdoc *, int, int, int); -static int need_eq0(struct mdoc *, int, int, int); -static int need_eq1(struct mdoc *, int, int, int); -static int need_ge1(struct mdoc *, int, int, int); -static int need_le2(struct mdoc *, int, int, int); -static int want_eq0(struct mdoc *, int, int, int); -static int want_ge1(struct mdoc *, int, int, int); +/* FIXME: some sections should only occur in specific msecs. */ +/* FIXME: ignoring Pp. */ +/* FIXME: math symbols. */ -static int args_ref(struct mdoc *, int, int, int, - const char *[], int, const struct mdoc_arg *); -static int args_bool(struct mdoc *, int, int, int, - const char *[], int, const struct mdoc_arg *); -static int args_Sh(struct mdoc *, int, int, int, - const char *[], int, const struct mdoc_arg *); -static int args_blocknest(struct mdoc *, int, int, int, - const char *[], int, const struct mdoc_arg *); -static int args_At(struct mdoc *, int, int, int, - const char *[], int, const struct mdoc_arg *); -static int args_Xr(struct mdoc *, int, int, int, - const char *[], int, const struct mdoc_arg *); - struct valids { - v_args_sz sz; - v_args args; - v_post post; + v_pre *pre; + v_post *post; }; +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 *, int); +static int post_check_children_gt(struct mdoc *, int); +static int post_check_children_eq(struct mdoc *, int); -/* - * FIXME: have arrays of function pointers in case we want multiple - * check callbacks per macro. - */ +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 *); +static int head_err_ge1(struct mdoc *); +static int head_warn_ge1(struct mdoc *); +static int head_err_eq0(struct mdoc *); +static int elem_err_eq0(struct mdoc *); +static int elem_err_le1(struct mdoc *); +static int elem_err_le2(struct mdoc *); +static int elem_err_eq1(struct mdoc *); +static int elem_err_ge1(struct mdoc *); +static int elem_warn_eq0(struct mdoc *); +static int body_warn_ge1(struct mdoc *); +static int body_err_eq0(struct mdoc *); +static int elem_warn_ge1(struct mdoc *); +static int elem_bool(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 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 }; + +static v_post posts_bool[] = { elem_err_eq1, elem_bool, NULL }; +static v_post posts_bd[] = { head_err_eq0, body_warn_ge1, NULL }; +static v_post posts_text[] = { elem_err_ge1, NULL }; +static v_post posts_wtext[] = { elem_warn_ge1, NULL }; +static v_post posts_notext[] = { elem_err_eq0, NULL }; +static v_post posts_wline[] = { head_warn_ge1, body_err_eq0, NULL }; +static v_post posts_sh[] = { head_err_ge1, + body_warn_ge1, post_sh, NULL }; +static v_post posts_bl[] = { head_err_eq0, + body_warn_ge1, post_bl, NULL }; +static v_post posts_it[] = { post_it, NULL }; +static v_post posts_ss[] = { head_err_ge1, NULL }; +static v_post posts_pp[] = { elem_warn_eq0, NULL }; +static v_post posts_d1[] = { head_err_ge1, NULL }; +static v_post posts_ex[] = { elem_err_le1, post_ex, NULL }; +static v_post posts_an[] = { post_an, NULL }; +static v_post posts_at[] = { elem_err_eq1, post_at, NULL }; +static v_post posts_xr[] = { elem_err_ge1, elem_err_le2, + post_xr, NULL }; + + const struct valids mdoc_valids[MDOC_MAX] = { - { NULL, NULL, NULL }, /* \" */ - { NULL, NULL, NULL }, /* Dd */ /* TODO */ - { NULL, NULL, NULL }, /* Dt */ /* TODO */ - { NULL, NULL, NULL }, /* Os */ /* TODO */ - { NULL, args_Sh, NULL }, /* Sh */ - { NULL, NULL, NULL }, /* Ss */ - { want_eq0, NULL, NULL }, /* Pp */ - { NULL, args_blocknest, need_head_child }, /* D1 */ - { NULL, args_blocknest, need_head_child }, /* Dl */ - { NULL, args_blocknest, NULL }, /* Bd */ - { NULL, NULL, no_head_child }, /* Ed */ - { NULL, NULL, NULL }, /* Bl */ - { NULL, NULL, no_head_child }, /* El */ - { NULL, NULL, NULL }, /* It */ - { need_ge1, NULL, NULL }, /* Ad */ - { NULL, NULL, NULL }, /* An */ - { NULL, NULL, NULL }, /* Ar */ - { need_ge1, NULL, NULL }, /* Cd */ - { NULL, NULL, NULL }, /* Cm */ - { need_ge1, NULL, NULL }, /* Dv */ - { need_ge1, NULL, NULL }, /* Er */ - { need_ge1, NULL, NULL }, /* Ev */ - { NULL, NULL, NULL }, /* Ex */ - { need_ge1, NULL, NULL }, /* Fa */ - { NULL, NULL, NULL }, /* Fd */ - { NULL, NULL, NULL }, /* Fl */ - { need_ge1, NULL, NULL }, /* Fn */ - { want_ge1, NULL, NULL }, /* Ft */ - { need_ge1, NULL, NULL }, /* Ic */ - { need_eq1, NULL, NULL }, /* In */ - { want_ge1, NULL, NULL }, /* Li */ - { want_ge1, NULL, NULL }, /* Nd */ - { NULL, NULL, NULL }, /* Nm */ - { NULL, NULL, NULL }, /* Op */ - { NULL, NULL, NULL }, /* Ot */ - { want_ge1, NULL, NULL }, /* Pa */ - { NULL, NULL, NULL }, /* Rv */ - { NULL, NULL, NULL }, /* St */ - { need_ge1, NULL, NULL }, /* Va */ - { need_ge1, NULL, NULL }, /* Vt */ - { need_le2, args_Xr, NULL }, /* Xr */ - { need_ge1, args_ref, NULL }, /* %A */ - { need_ge1, args_ref, NULL }, /* %B */ - { need_ge1, args_ref, NULL }, /* %D */ - { need_ge1, args_ref, NULL }, /* %I */ - { need_ge1, args_ref, NULL }, /* %J */ - { need_ge1, args_ref, NULL }, /* %N */ - { need_ge1, args_ref, NULL }, /* %O */ - { need_ge1, args_ref, NULL }, /* %P */ - { need_ge1, args_ref, NULL }, /* %R */ - { need_ge1, args_ref, NULL }, /* %T */ - { need_ge1, args_ref, NULL }, /* %V */ - { NULL, NULL, NULL }, /* Ac */ - { NULL, NULL, NULL }, /* Ao */ - { NULL, NULL, NULL }, /* Aq */ - { need_le2, args_At, NULL }, /* At */ - { NULL, NULL, NULL }, /* Bc */ - { NULL, NULL, NULL }, /* Bf */ - { NULL, NULL, NULL }, /* Bo */ - { NULL, NULL, NULL }, /* Bq */ - { assert_le1, NULL, NULL }, /* Bsx */ - { assert_le1, NULL, NULL }, /* Bx */ - { need_eq1, args_bool, NULL }, /* Db */ - { NULL, NULL, NULL }, /* Dc */ - { NULL, NULL, NULL }, /* Do */ - { NULL, NULL, NULL }, /* Dq */ - { NULL, NULL, NULL }, /* Ec */ - { NULL, NULL, NULL }, /* Ef */ - { need_ge1, NULL, NULL }, /* Em */ - { NULL, NULL, NULL }, /* Eo */ - { assert_le1, NULL, NULL }, /* Fx */ - { want_ge1, NULL, NULL }, /* Ms */ - { NULL, NULL, NULL }, /* No */ - { NULL, NULL, NULL }, /* Ns */ - { assert_le1, NULL, NULL }, /* Nx */ - { assert_le1, NULL, NULL }, /* Ox */ - { NULL, NULL, NULL }, /* Pc */ - { NULL, NULL, NULL }, /* Pf */ - { NULL, NULL, NULL }, /* Po */ - { NULL, NULL, NULL }, /* Pq */ - { NULL, NULL, NULL }, /* Qc */ - { NULL, NULL, NULL }, /* Ql */ - { NULL, NULL, NULL }, /* Qo */ - { NULL, NULL, NULL }, /* Qq */ - { NULL, NULL, NULL }, /* Re */ - { NULL, NULL, NULL }, /* Rs */ - { NULL, NULL, NULL }, /* Sc */ - { NULL, NULL, NULL }, /* So */ - { NULL, NULL, NULL }, /* Sq */ - { need_eq1, args_bool, NULL }, /* Sm */ - { need_ge1, NULL, NULL }, /* Sx */ - { need_ge1, NULL, NULL }, /* Sy */ - { want_ge1, NULL, NULL }, /* Tn */ - { assert_eq0, NULL, NULL }, /* Ux */ - { NULL, NULL, NULL }, /* Xc */ - { NULL, NULL, NULL }, /* Xo */ - { NULL, NULL, NULL }, /* Fo */ - { NULL, NULL, NULL }, /* Fc */ - { NULL, NULL, NULL }, /* Oo */ - { NULL, NULL, NULL }, /* Oc */ - { NULL, NULL, NULL }, /* Bk */ - { NULL, NULL, NULL }, /* Ek */ - { need_eq0, NULL, NULL }, /* Bt */ - { need_eq1, NULL, NULL }, /* Hf */ - { NULL, NULL, NULL }, /* Fr */ - { need_eq0, NULL, NULL }, /* Ud */ + { 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_d1 }, /* D1 */ + { pres_d1, posts_d1 }, /* 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, NULL }, /* Fd */ + { NULL, NULL }, /* Fl */ + { NULL, posts_text }, /* Fn */ + { NULL, NULL }, /* Ft */ + { NULL, posts_text }, /* Ic */ + { NULL, posts_wtext }, /* In */ + { NULL, posts_text }, /* Li */ + { NULL, posts_wtext }, /* Nd */ + /* FIXME: check that name must be set/provided. */ + { NULL, NULL }, /* 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, NULL }, /* 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, NULL }, /* 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, NULL }, /* Fo */ + { NULL, NULL }, /* Fc */ + { NULL, NULL }, /* Oo */ + { NULL, NULL }, /* Oc */ + { NULL, NULL }, /* Bk */ + { NULL, NULL }, /* Ek */ + { NULL, posts_notext }, /* Bt */ + { NULL, NULL }, /* Hf */ + { NULL, NULL }, /* Fr */ + { NULL, posts_notext }, /* Ud */ }; static int -need_le2(struct mdoc *mdoc, int tok, int pos, int sz) +post_check_children_count(struct mdoc *mdoc) { - if (sz <= 2) + struct mdoc_node *n; + int i; + + for (i = 0, n = mdoc->last->child; n; n = n->next, i++) + /* Do nothing */ ; + return(i); +} + + +static int +post_check_children_gt(struct mdoc *mdoc, int sz) +{ + int i; + + if ((i = post_check_children_count(mdoc)) > sz) return(1); - return(mdoc_err(mdoc, tok, pos, ERR_ARGS_LE2)); + return(mdoc_err(mdoc, "macro requires more than %d " + "parameters (have %d)", sz, i)); } static int -want_ge1(struct mdoc *mdoc, int tok, int pos, int sz) +post_check_children_eq(struct mdoc *mdoc, int sz) { - if (sz > 0) + int i; + + if ((i = post_check_children_count(mdoc)) == sz) return(1); - return(mdoc_warn(mdoc, tok, pos, WARN_ARGS_GE1)); + return(mdoc_err(mdoc, "macro requires %d parameters " + "(have %d)", sz, i)); } static int -want_eq0(struct mdoc *mdoc, int tok, int pos, int sz) +post_check_children_lt(struct mdoc *mdoc, int sz) { - if (sz == 0) + int i; + + if ((i = post_check_children_count(mdoc)) < sz) return(1); - return(mdoc_warn(mdoc, tok, pos, WARN_ARGS_EQ0)); + return(mdoc_err(mdoc, "macro requires less than %d " + "parameters (have %d)", sz, i)); } static int -need_eq0(struct mdoc *mdoc, int tok, int pos, int sz) +pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node *node) { - if (sz == 0) + + if (1 == node->data.elem.argc && + MDOC_Std == node->data.elem.argv[0].arg) return(1); - return(mdoc_err(mdoc, tok, pos, ERR_ARGS_EQ0)); + return(mdoc_nwarn(mdoc, node, WARN_COMPAT, + "macro suggests single `%s' argument", + mdoc_argnames[MDOC_Std])); } static int -assert_le1(struct mdoc *mdoc, int tok, int pos, int sz) +pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node, + int sz, enum mdoc_msec *msecs) { + int i; - assert(sz <= 1); - return(1); + for (i = 0; i < sz; i++) + if (msecs[i] == mdoc->meta.msec) + return(1); + return(mdoc_nwarn(mdoc, node, WARN_COMPAT, + "macro is not appropriate for this manual section")); } static int -assert_eq0(struct mdoc *mdoc, int tok, int pos, int sz) +pre_check_parent(struct mdoc *mdoc, struct mdoc_node *node, + int tok, enum mdoc_type type) { - assert(sz == 0); + 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); } static int -need_eq1(struct mdoc *mdoc, int tok, int pos, int sz) +body_err_eq0(struct mdoc *mdoc) { - if (sz == 1) + + if (MDOC_BODY != mdoc->last->type) return(1); - return(mdoc_err(mdoc, tok, pos, ERR_ARGS_EQ1)); + if (NULL == mdoc->last->child) + return(1); + return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children")); } static int -need_ge1(struct mdoc *mdoc, int tok, int pos, int sz) +body_warn_ge1(struct mdoc *mdoc) { - if (sz > 0) + + if (MDOC_BODY != mdoc->last->type) return(1); - return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1)); + if (mdoc->last->child) + return(1); + return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more body children")); } static int -no_head_child(struct mdoc *mdoc, int tok, int pos) +elem_warn_eq0(struct mdoc *mdoc) { - /* TODO */ - return(1); + assert(MDOC_ELEM == mdoc->last->type); + if (NULL == mdoc->last->child) + return(1); + return(mdoc_pwarn(mdoc, mdoc->last->child->line, + mdoc->last->child->pos, WARN_SYNTAX, "macro suggests no parameters")); } static int -need_head_child(struct mdoc *mdoc, int tok, int pos) +elem_warn_ge1(struct mdoc *mdoc) { - struct mdoc_node *n; - assert(mdoc->last); - n = mdoc->last; + assert(MDOC_ELEM == mdoc->last->type); + if (mdoc->last->child) + return(1); + return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters")); +} - assert(MDOC_BLOCK == n->type); - assert(n->child); - n = n->child; +static int +elem_err_eq1(struct mdoc *mdoc) +{ - if (MDOC_HEAD != n->type) - return(mdoc_err(mdoc, tok, pos, ERR_CHILD_HEAD)); - if (n->child) - return(1); - return(mdoc_err(mdoc, tok, pos, ERR_CHILD_HEAD)); + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_eq(mdoc, 1)); } static int -args_Sh(struct mdoc *mdoc, int tok, int pos, - int sz, const char *args[], - int argc, const struct mdoc_arg *argv) +elem_err_le2(struct mdoc *mdoc) { - enum mdoc_sec sec; - sec = mdoc_atosec((size_t)sz, args); - if (SEC_CUSTOM != sec && sec < mdoc->sec_lastn) - if ( ! mdoc_warn(mdoc, tok, pos, WARN_SEC_OO)) - return(0); - if (SEC_BODY == mdoc->sec_last && SEC_NAME != sec) - return(mdoc_err(mdoc, tok, pos, ERR_SEC_NAME)); + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_lt(mdoc, 3)); +} - return(1); + +static int +elem_err_le1(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_lt(mdoc, 2)); } static int -args_bool(struct mdoc *mdoc, int tok, int pos, - int sz, const char *args[], - int argc, const struct mdoc_arg *argv) +elem_err_eq0(struct mdoc *mdoc) { - assert(1 == sz); - if (xstrcmp(args[0], "on")) - return(1); - if (xstrcmp(args[0], "off")) + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_eq(mdoc, 0)); +} + + +static int +elem_err_ge1(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_gt(mdoc, 0)); +} + + +static int +head_err_eq0(struct mdoc *mdoc) +{ + + if (MDOC_HEAD != mdoc->last->type) return(1); - return(mdoc_err(mdoc, tok, pos, ERR_SYNTAX_ARGBAD)); + return(post_check_children_eq(mdoc, 0)); } static int -args_ref(struct mdoc *mdoc, int tok, int pos, - int sz, const char *args[], - int argc, const struct mdoc_arg *argv) +head_warn_ge1(struct mdoc *mdoc) { + + if (MDOC_HEAD != mdoc->last->type) + return(1); + if (mdoc->last->child) + return(1); + return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters")); +} + + +static int +head_err_ge1(struct mdoc *mdoc) +{ + + if (MDOC_HEAD != mdoc->last->type) + return(1); + return(post_check_children_gt(mdoc, 0)); +} + + +static int +pre_display(struct mdoc *mdoc, struct mdoc_node *node) +{ struct mdoc_node *n; + if (MDOC_BLOCK != node->type) + return(1); + assert(mdoc->last); - for (n = mdoc->last ; n; n = n->parent) { - if (MDOC_BLOCK != n->type) - continue; - if (MDOC_Rs != n->data.block.tok) + 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")); +} + + +static int +pre_bl(struct mdoc *mdoc, struct mdoc_node *node) +{ + int type, err; + struct mdoc_arg *argv; + size_t i, argc; + + if (MDOC_BLOCK != node->type) + return(1); + assert(MDOC_Bl == node->tok); + + argv = NULL; + argc = node->data.block.argc; + + 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")); +} + + +static int +pre_bd(struct mdoc *mdoc, struct mdoc_node *node) +{ + int type, err; + struct mdoc_arg *argv; + size_t i, argc; + + if (MDOC_BLOCK != node->type) + return(1); + assert(MDOC_Bd == node->tok); + + argv = NULL; + argc = node->data.block.argc; + + 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")); +} - return(mdoc_err(mdoc, tok, pos, ERR_SCOPE_NOCTX)); + +static int +pre_ss(struct mdoc *mdoc, struct mdoc_node *node) +{ + + if (MDOC_BLOCK != node->type) + return(1); + return(pre_check_parent(mdoc, node, MDOC_Sh, MDOC_BODY)); } static int -args_Xr(struct mdoc *mdoc, int tok, int pos, - int sz, const char *args[], - int argc, const struct mdoc_arg *argv) +pre_sh(struct mdoc *mdoc, struct mdoc_node *node) { - if (1 == sz) + if (MDOC_BLOCK != node->type) return(1); - if (0 == sz) - return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1)); + return(pre_check_parent(mdoc, node, -1, MDOC_ROOT)); +} - if (MSEC_DEFAULT == mdoc_atomsec(args[1])) - return(mdoc_err(mdoc, tok, pos, ERR_SYNTAX_ARGFORM)); - return(1); + +static int +pre_st(struct mdoc *mdoc, struct mdoc_node *node) +{ + + 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")); } static int -args_At(struct mdoc *mdoc, int tok, int pos, - int sz, const char *args[], - int argc, const struct mdoc_arg *argv) +pre_an(struct mdoc *mdoc, struct mdoc_node *node) { - int i; - if (0 == sz) + 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")); +} - i = 0; - if (ATT_DEFAULT == mdoc_atoatt(args[i])) - i++; - for ( ; i < sz; i++) { - if ( ! mdoc_isdelim(args[i])) - continue; - return(mdoc_err(mdoc, tok, pos, ERR_SYNTAX_NOPUNCT)); +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)); +} + + +static int +pre_ex(struct mdoc *mdoc, struct mdoc_node *node) +{ + enum mdoc_msec msecs[3]; + + assert(MDOC_ELEM == node->type); + assert(MDOC_Ex == node->tok); + + 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)); +} + + +static int +pre_er(struct mdoc *mdoc, struct mdoc_node *node) +{ + enum mdoc_msec msecs[1]; + + msecs[0] = MSEC_2; + return(pre_check_msecs(mdoc, node, 1, msecs)); +} + + +static int +pre_cd(struct mdoc *mdoc, struct mdoc_node *node) +{ + enum mdoc_msec msecs[1]; + + msecs[0] = MSEC_4; + return(pre_check_msecs(mdoc, node, 1, msecs)); +} + + +static int +pre_it(struct mdoc *mdoc, struct mdoc_node *node) +{ + + if (MDOC_BLOCK != node->type) + return(1); + return(pre_check_parent(mdoc, node, MDOC_Bl, MDOC_BODY)); +} + + +static int +pre_prologue(struct mdoc *mdoc, struct mdoc_node *node) +{ + + if (SEC_PROLOGUE != mdoc->sec_lastn) + return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue")); + assert(MDOC_ELEM == node->type); + + /* Check for ordering. */ + + switch (node->tok) { + case (MDOC_Os): + if (mdoc->meta.title && mdoc->meta.date) + break; + return(mdoc_nerr(mdoc, node, "prologue macro out-of-order")); + case (MDOC_Dt): + if (NULL == mdoc->meta.title && mdoc->meta.date) + break; + return(mdoc_nerr(mdoc, node, "prologue macro out-of-order")); + case (MDOC_Dd): + if (NULL == mdoc->meta.title && 0 == mdoc->meta.date) + break; + return(mdoc_nerr(mdoc, node, "prologue macro out-of-order")); + default: + abort(); + /* NOTREACHED */ } + + /* Check for repetition. */ + + 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 */ + } + + return(mdoc_nerr(mdoc, node, "prologue macro repeated")); +} + + +static int +post_xr(struct mdoc *mdoc) +{ + struct mdoc_node *n; + + assert(MDOC_ELEM == mdoc->last->type); + assert(MDOC_Xr == mdoc->last->tok); + assert(mdoc->last->child); + assert(MDOC_TEXT == mdoc->last->child->type); + + 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")); +} + + +static int +post_at(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + assert(MDOC_At == mdoc->last->tok); + assert(mdoc->last->child); + assert(MDOC_TEXT == mdoc->last->child->type); + + 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")); +} + + +static int +post_an(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + assert(MDOC_An == mdoc->last->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->last->child) + return(1); + return(mdoc_err(mdoc, "macro expects either argument or parameters")); +} + + +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); } +/* Warn if `Bl' type-specific syntax isn't reflected in items. */ static int -args_blocknest(struct mdoc *mdoc, int tok, int pos, - int sz, const char *args[], - int argc, const struct mdoc_arg *argv) +post_it(struct mdoc *mdoc) { - struct mdoc_node *node; + int type, sv; +#define TYPE_NONE (0) +#define TYPE_BODY (1) +#define TYPE_HEAD (2) + size_t i, argc; + struct mdoc_node *n; - /* - * 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); + if (MDOC_BLOCK != mdoc->last->type) + return(1); - /* LINTED */ - for (node = mdoc->last; node; node = node->parent) { - if (node->type != MDOC_BLOCK) + assert(MDOC_It == mdoc->last->tok); + + n = mdoc->last->parent; + assert(n); + assert(MDOC_Bl == n->tok); + + n = n->parent; + assert(MDOC_BLOCK == n->type); + assert(MDOC_Bl == n->tok); + + argc = n->data.block.argc; + type = TYPE_NONE; + + /* Some types require block-head, some not. */ + + 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; + } + + assert(TYPE_NONE != type); + + 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); + + 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); + } + + 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); + + 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 (MDOC_Column != sv) + return(1); + + /* Make sure the number of columns is sane. */ + + sv = mdoc->last->parent->parent->data.block.argv->sz; + n = mdoc->last->data.block.head->child; + + for (i = 0; n; n = n->next) + i++; + + if (i == (size_t)sv) + return(1); + return(mdoc_err(mdoc, "expected %d list columns, have %d", sv, (int)i)); +#undef TYPE_NONE +#undef TYPE_BODY +#undef TYPE_HEAD +} + + +/* Make sure that only `It' macros are our body-children. */ +static int +post_bl(struct mdoc *mdoc) +{ + struct mdoc_node *n; + + if (MDOC_BODY != mdoc->last->type) + return(1); + assert(MDOC_Bl == mdoc->last->tok); + + for (n = mdoc->last->child; n; n = n->next) { + if (MDOC_BLOCK == n->type) + if (MDOC_It == n->tok) + continue; + break; + } + if (NULL == n) + return(1); + return(mdoc_nerr(mdoc, n, "invalid child of parent macro `Bl'")); +} + + +static int +elem_bool(struct mdoc *mdoc) +{ + struct mdoc_node *n; + + assert(MDOC_ELEM == mdoc->last->type); + for (n = mdoc->last->child; n; n = n->next) { + if (MDOC_TEXT != n->type) + break; + if (xstrcmp(n->data.text.string, "on")) continue; - if (node->data.block.tok != MDOC_Bd) + if (xstrcmp(n->data.text.string, "off")) continue; break; } - if (NULL == node) + if (NULL == n) return(1); - return(mdoc_err(mdoc, tok, pos, ERR_SCOPE_NONEST)); + return(mdoc_nerr(mdoc, n, "expected boolean value [on/off]")); } +/* Warn if conventional sections are out of order. */ +static int +post_sh(struct mdoc *mdoc) +{ + char buf[64]; + enum mdoc_sec sec; + + if (MDOC_HEAD != mdoc->last->type) + return(1); + assert(MDOC_Sh == mdoc->last->tok); + + if ( ! xstrlcats(buf, mdoc->last->child, 64)) + return(mdoc_err(mdoc, "macro parameters too long")); + + 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")); +} + + int -mdoc_valid_pre(struct mdoc *mdoc, int tok, int pos, - int sz, const char *args[], - int argc, const struct mdoc_arg *argv) +mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node) { + v_pre *p; - assert(tok < MDOC_MAX); - if (mdoc_valids[tok].sz) - if ( ! (*mdoc_valids[tok].sz)(mdoc, tok, pos, sz)) - return(0); + /* TODO: character-escape checks. */ - if (NULL == mdoc_valids[tok].args) + if (MDOC_TEXT == node->type) return(1); - return((*mdoc_valids[tok].args)(mdoc, - tok, pos, sz, args, argc, argv)); + assert(MDOC_ROOT != node->type); + + 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 -mdoc_valid_post(struct mdoc *mdoc, int tok, int pos) +mdoc_valid_post(struct mdoc *mdoc) { + v_post *p; - if (NULL == mdoc_valids[tok].post) + if (MDOC_TEXT == mdoc->last->type) return(1); - return((*mdoc_valids[tok].post)(mdoc, tok, pos)); + if (MDOC_ROOT == mdoc->last->type) { + /* TODO: make sure prologue is complete. */ + return(1); + } + + 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); } +