=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.25 retrieving revision 1.44 diff -u -p -r1.25 -r1.44 --- mandoc/Attic/validate.c 2009/01/12 12:52:21 1.25 +++ mandoc/Attic/validate.c 2009/01/20 13:44:05 1.44 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.25 2009/01/12 12:52:21 kristaps Exp $ */ +/* $Id: validate.c,v 1.44 2009/01/20 13:44:05 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -21,147 +21,221 @@ #include "private.h" +/* + * 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. + */ typedef int (*v_pre)(struct mdoc *, struct mdoc_node *); typedef int (*v_post)(struct mdoc *); +/* 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; }; +/* Utility checks. */ +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); + +/* Specific pre-child-parse routines. */ + 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 headchild_err_ge1(struct mdoc *); -static int headchild_err_eq0(struct mdoc *); -static int elemchild_err_ge1(struct mdoc *); -static int elemchild_warn_eq0(struct mdoc *); -static int bodychild_warn_ge1(struct mdoc *); +/* 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_post posts_bd[] = { headchild_err_eq0, - bodychild_warn_ge1, 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_sh[] = { headchild_err_ge1, - bodychild_warn_ge1, post_sh, NULL }; -static v_post posts_bl[] = { headchild_err_eq0, - bodychild_warn_ge1, post_bl, 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_ss[] = { headchild_err_ge1, NULL }; -static v_post posts_pp[] = { elemchild_warn_eq0, NULL }; -static v_post posts_dd[] = { elemchild_err_ge1, NULL }; -static v_post posts_d1[] = { headchild_err_ge1, 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 }; +/* Per-macro pre- and post-child-check routine collections. */ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* \" */ - { pres_prologue, posts_dd }, /* Dd */ + { pres_prologue, posts_text }, /* Dd */ { pres_prologue, NULL }, /* Dt */ { pres_prologue, NULL }, /* Os */ - { NULL, posts_sh }, /* Sh */ /* FIXME: preceding Pp. */ - { NULL, posts_ss }, /* Ss */ /* FIXME: preceding Pp. */ - { NULL, posts_pp }, /* Pp */ /* FIXME: proceeding... */ - { pres_d1, posts_d1 }, /* D1 */ - { pres_d1, posts_d1 }, /* Dl */ - { pres_bd, posts_bd }, /* Bd */ /* FIXME: preceding Pp. */ + /* 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 */ /* FIXME: preceding Pp. */ + { pres_bl, posts_bl }, /* Bl */ { NULL, NULL }, /* El */ { pres_it, posts_it }, /* It */ - { NULL, NULL }, /* Ad */ - { NULL, NULL }, /* An */ + { NULL, posts_text }, /* Ad */ + { pres_an, posts_an }, /* An */ { NULL, NULL }, /* Ar */ - { NULL, NULL }, /* Cd */ + { pres_cd, posts_text }, /* Cd */ { NULL, NULL }, /* Cm */ - { NULL, NULL }, /* Dv */ - { NULL, NULL }, /* Er */ - { NULL, NULL }, /* Ev */ - { NULL, NULL }, /* Ex */ - { NULL, NULL }, /* Fa */ - { NULL, NULL }, /* Fd */ + { 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, NULL }, /* Fn */ - { NULL, NULL }, /* Ft */ - { NULL, NULL }, /* Ic */ - { NULL, NULL }, /* In */ - { NULL, NULL }, /* Li */ - { NULL, NULL }, /* Nd */ - { NULL, NULL }, /* Nm */ - { NULL, NULL }, /* Op */ + { 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 */ - { NULL, NULL }, /* Rv */ - { NULL, NULL }, /* St */ - { NULL, NULL }, /* Va */ - { NULL, NULL }, /* Vt */ - { NULL, NULL }, /* Xr */ - { NULL, NULL }, /* %A */ - { NULL, NULL }, /* %B */ - { NULL, NULL }, /* %D */ - { NULL, NULL }, /* %I */ - { NULL, NULL }, /* %J */ - { NULL, NULL }, /* %N */ - { NULL, NULL }, /* %O */ - { NULL, NULL }, /* %P */ - { NULL, NULL }, /* %R */ - { NULL, NULL }, /* %T */ - { NULL, NULL }, /* %V */ + { 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, NULL }, /* Aq */ - { NULL, NULL }, /* At */ /* FIXME */ + { NULL, posts_wline }, /* Aq */ + { NULL, posts_at }, /* At */ { NULL, NULL }, /* Bc */ - { NULL, NULL }, /* Bf */ + { NULL, posts_bf }, /* Bf */ { NULL, NULL }, /* Bo */ - { NULL, NULL }, /* Bq */ + { NULL, posts_wline }, /* Bq */ { NULL, NULL }, /* Bsx */ { NULL, NULL }, /* Bx */ - { NULL, NULL }, /* Db */ + { NULL, posts_bool }, /* Db */ { NULL, NULL }, /* Dc */ { NULL, NULL }, /* Do */ - { NULL, NULL }, /* Dq */ + { NULL, posts_wline }, /* Dq */ { NULL, NULL }, /* Ec */ { NULL, NULL }, /* Ef */ /* -symbolic, etc. */ - { NULL, NULL }, /* Em */ + { NULL, posts_text }, /* Em */ { NULL, NULL }, /* Eo */ { NULL, NULL }, /* Fx */ - { NULL, NULL }, /* Ms */ - { NULL, NULL }, /* No */ - { NULL, NULL }, /* Ns */ + { NULL, posts_text }, /* Ms */ + { NULL, posts_notext }, /* No */ + { NULL, posts_notext }, /* Ns */ { NULL, NULL }, /* Nx */ { NULL, NULL }, /* Ox */ { NULL, NULL }, /* Pc */ - { NULL, NULL }, /* Pf */ /* 2 or more arguments */ + { NULL, NULL }, /* Pf */ { NULL, NULL }, /* Po */ - { NULL, NULL }, /* Pq */ /* FIXME: ignore following Sh/Ss */ + { NULL, posts_wline }, /* Pq */ { NULL, NULL }, /* Qc */ - { NULL, NULL }, /* Ql */ + { NULL, posts_wline }, /* Ql */ { NULL, NULL }, /* Qo */ - { NULL, NULL }, /* Qq */ + { NULL, posts_wline }, /* Qq */ { NULL, NULL }, /* Re */ { NULL, NULL }, /* Rs */ { NULL, NULL }, /* Sc */ { NULL, NULL }, /* So */ - { NULL, NULL }, /* Sq */ - { NULL, NULL }, /* Sm */ - { NULL, NULL }, /* Sx */ - { NULL, NULL }, /* Sy */ - { NULL, NULL }, /* Tn */ + { 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 */ @@ -171,74 +245,241 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Oc */ { NULL, NULL }, /* Bk */ { NULL, NULL }, /* Ek */ - { NULL, NULL }, /* Bt */ + { NULL, posts_notext }, /* Bt */ { NULL, NULL }, /* Hf */ { NULL, NULL }, /* Fr */ - { NULL, NULL }, /* Ud */ + { NULL, posts_notext }, /* Ud */ }; static int -bodychild_warn_ge1(struct mdoc *mdoc) +post_check_children_count(struct mdoc *mdoc) { + struct mdoc_node *n; + int i; - if (MDOC_BODY != mdoc->last->type) + for (i = 0, n = mdoc->last->child; n; n = n->next, i++) + /* Do nothing */ ; + return(i); +} + + +static int +post_check_children_wgt(struct mdoc *mdoc, const char *p, int sz) +{ + int i; + + if ((i = post_check_children_count(mdoc)) > sz) return(1); - if (mdoc->last->child) + return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests more " + "than %d %s (has %d)", sz, p, i)); +} + + +static int +post_check_children_gt(struct mdoc *mdoc, const char *p, int sz) +{ + int i; + + if ((i = post_check_children_count(mdoc)) > sz) return(1); - return(mdoc_warn(mdoc, WARN_ARGS_GE1)); + return(mdoc_err(mdoc, "macro requires more than %d " + "%s (has %d)", sz, p, i)); } static int -elemchild_warn_eq0(struct mdoc *mdoc) +post_check_children_weq(struct mdoc *mdoc, const char *p, int sz) { + int i; - assert(MDOC_ELEM == mdoc->last->type); - if (NULL == mdoc->last->child) + if ((i = post_check_children_count(mdoc)) == sz) return(1); - return(mdoc_pwarn(mdoc, mdoc->last->child->line, - mdoc->last->child->pos, WARN_ARGS_EQ0)); + return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests %d " + "%s (has %d)", sz, p, i)); } static int -elemchild_err_ge1(struct mdoc *mdoc) +post_check_children_eq(struct mdoc *mdoc, const char *p, int sz) { + int i; - assert(MDOC_ELEM == mdoc->last->type); - if (mdoc->last->child) + if ((i = post_check_children_count(mdoc)) == sz) return(1); - return(mdoc_err(mdoc, ERR_ARGS_GE1)); + return(mdoc_err(mdoc, "macro requires %d %s " + "(have %d)", sz, p, i)); } static int -headchild_err_eq0(struct mdoc *mdoc) +post_check_children_lt(struct mdoc *mdoc, const char *p, int sz) { + int i; - if (MDOC_HEAD != mdoc->last->type) + if ((i = post_check_children_count(mdoc)) < sz) return(1); - if (NULL == mdoc->last->child) + return(mdoc_err(mdoc, "macro requires less than %d " + "%s (have %d)", sz, p, i)); +} + + +static int +pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node *node) +{ + + if (1 == node->data.elem.argc && + MDOC_Std == node->data.elem.argv[0].arg) return(1); - return(mdoc_perr(mdoc, mdoc->last->child->line, - mdoc->last->child->pos, ERR_ARGS_EQ0)); + return(mdoc_nwarn(mdoc, node, WARN_COMPAT, + "macro suggests single `%s' argument", + mdoc_argnames[MDOC_Std])); } static int -headchild_err_ge1(struct mdoc *mdoc) +pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node, + int sz, enum mdoc_msec *msecs) { + int i; + 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 +pre_check_parent(struct mdoc *mdoc, struct mdoc_node *node, + int tok, enum mdoc_type type) +{ + + 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 +bwarn_ge1(struct mdoc *mdoc) +{ + + if (MDOC_BODY != mdoc->last->type) + return(1); + return(post_check_children_wgt(mdoc, "body children", 0)); +} + + +static int +ewarn_eq1(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_weq(mdoc, "parameters", 1)); +} + + +static int +ewarn_eq0(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_weq(mdoc, "parameters", 0)); +} + + +static int +ewarn_ge1(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_wgt(mdoc, "parameters", 0)); +} + + +static int +eerr_eq1(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_eq(mdoc, "parameters", 1)); +} + + +static int +eerr_le2(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_lt(mdoc, "parameters", 3)); +} + + +static int +eerr_le1(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_lt(mdoc, "parameters", 2)); +} + + +static int +eerr_eq0(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_eq(mdoc, "parameters", 0)); +} + + +static int +eerr_ge1(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + return(post_check_children_gt(mdoc, "parameters", 0)); +} + + +static int +herr_eq0(struct mdoc *mdoc) +{ + if (MDOC_HEAD != mdoc->last->type) return(1); - if (mdoc->last->child) + return(post_check_children_eq(mdoc, "parameters", 0)); +} + + +static int +herr_le1(struct mdoc *mdoc) +{ + if (MDOC_HEAD != mdoc->last->type) return(1); - return(mdoc_err(mdoc, ERR_ARGS_GE1)); + return(post_check_children_lt(mdoc, "parameters", 2)); } static int +herr_ge1(struct mdoc *mdoc) +{ + + if (MDOC_HEAD != mdoc->last->type) + return(1); + return(post_check_children_gt(mdoc, "parameters", 0)); +} + + +static int pre_display(struct mdoc *mdoc, struct mdoc_node *node) { struct mdoc_node *n; @@ -246,13 +487,15 @@ pre_display(struct mdoc *mdoc, struct mdoc_node *node) if (MDOC_BLOCK != node->type) return(1); - for (n = mdoc->last; n; n = n->parent) + 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_verr(mdoc, node, ERR_SCOPE_NONEST)); + return(mdoc_nerr(mdoc, node, "displays may not be nested")); } @@ -270,6 +513,7 @@ pre_bl(struct mdoc *mdoc, struct mdoc_node *node) 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); @@ -293,6 +537,8 @@ pre_bl(struct mdoc *mdoc, struct mdoc_node *node) case (MDOC_Ohang): /* FALLTHROUGH */ case (MDOC_Inset): + /* FALLTHROUGH */ + case (MDOC_Column): if (type) err++; type++; @@ -302,12 +548,12 @@ pre_bl(struct mdoc *mdoc, struct mdoc_node *node) } } if (0 == type) - return(mdoc_err(mdoc, ERR_SYNTAX_ARGMISS)); + return(mdoc_err(mdoc, "no list type specified")); if (0 == err) return(1); assert(argv); return(mdoc_perr(mdoc, argv->line, - argv->pos, ERR_SYNTAX_ARGBAD)); + argv->pos, "only one list type possible")); } @@ -325,6 +571,7 @@ pre_bd(struct mdoc *mdoc, struct mdoc_node *node) argv = NULL; argc = node->data.block.argc; + /* LINTED */ for (err = i = type = 0; 0 == err && i < argc; i++) { argv = &node->data.block.argv[(int)i]; assert(argv); @@ -333,6 +580,8 @@ pre_bd(struct mdoc *mdoc, struct mdoc_node *node) /* FALLTHROUGH */ case (MDOC_Unfilled): /* FALLTHROUGH */ + case (MDOC_Filled): + /* FALLTHROUGH */ case (MDOC_Literal): /* FALLTHROUGH */ case (MDOC_File): @@ -345,55 +594,145 @@ pre_bd(struct mdoc *mdoc, struct mdoc_node *node) } } if (0 == type) - return(mdoc_err(mdoc, ERR_SYNTAX_ARGMISS)); + return(mdoc_err(mdoc, "no display type specified")); if (0 == err) return(1); assert(argv); return(mdoc_perr(mdoc, argv->line, - argv->pos, ERR_SYNTAX_ARGBAD)); + argv->pos, "only one display type possible")); } static int -pre_it(struct mdoc *mdoc, struct mdoc_node *node) +pre_ss(struct mdoc *mdoc, struct mdoc_node *node) { - if (MDOC_BLOCK != mdoc->last->type) + if (MDOC_BLOCK != node->type) return(1); - assert(MDOC_It == mdoc->last->tok); + return(pre_check_parent(mdoc, node, MDOC_Sh, MDOC_BODY)); +} - if (MDOC_BODY != mdoc->last->parent->type) - return(mdoc_verr(mdoc, node, ERR_SYNTAX_PARENTBAD)); - if (MDOC_Bl != mdoc->last->parent->tok) - return(mdoc_verr(mdoc, node, ERR_SYNTAX_PARENTBAD)); - return(1); +static int +pre_sh(struct mdoc *mdoc, struct mdoc_node *node) +{ + + if (MDOC_BLOCK != node->type) + return(1); + return(pre_check_parent(mdoc, node, -1, MDOC_ROOT)); } 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 +pre_an(struct mdoc *mdoc, struct mdoc_node *node) +{ + + 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")); +} + + +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_verr(mdoc, node, ERR_SEC_NPROLOGUE)); + 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[0] && mdoc->meta.date) + if (mdoc->meta.title && mdoc->meta.date) break; - return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO)); + return(mdoc_nerr(mdoc, node, "prologue macro out-of-order")); case (MDOC_Dt): - if (0 == mdoc->meta.title[0] && mdoc->meta.date) + if (NULL == mdoc->meta.title && mdoc->meta.date) break; - return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO)); + return(mdoc_nerr(mdoc, node, "prologue macro out-of-order")); case (MDOC_Dd): - if (0 == mdoc->meta.title[0] && 0 == mdoc->meta.date) + if (NULL == mdoc->meta.title && 0 == mdoc->meta.date) break; - return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO)); + return(mdoc_nerr(mdoc, node, "prologue macro out-of-order")); default: abort(); /* NOTREACHED */ @@ -403,7 +742,7 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node switch (node->tok) { case (MDOC_Os): - if (0 == mdoc->meta.os[0]) + if (NULL == mdoc->meta.os) return(1); break; case (MDOC_Dd): @@ -411,7 +750,7 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node return(1); break; case (MDOC_Dt): - if (0 == mdoc->meta.title[0]) + if (NULL == mdoc->meta.title) return(1); break; default: @@ -419,10 +758,140 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node /* NOTREACHED */ } - return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_REP)); + return(mdoc_nerr(mdoc, node, "prologue macro repeated")); } +static int +post_bf(struct mdoc *mdoc) +{ + char *p; + struct mdoc_node *head; + + if (MDOC_BLOCK != mdoc->last->type) + return(1); + assert(MDOC_Bf == mdoc->last->tok); + head = mdoc->last->data.block.head; + assert(head); + + 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")); +} + + +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])); +} + + +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); + + if (NULL == mdoc->last->child) + return(1); + 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 post_it(struct mdoc *mdoc) @@ -449,7 +918,11 @@ post_it(struct mdoc *mdoc) argc = n->data.block.argc; type = TYPE_NONE; + sv = -1; + + /* Some types require block-head, some not. */ + /* LINTED */ for (i = 0; TYPE_NONE == type && i < argc; i++) switch (n->data.block.argv[(int)i].arg) { case (MDOC_Tag): @@ -485,46 +958,57 @@ post_it(struct mdoc *mdoc) assert(TYPE_NONE != type); if (TYPE_HEAD == type) { - if (NULL == (n = mdoc->last->data.block.head)) { - if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYHEAD)) + n = mdoc->last->data.block.head; + assert(n); + if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters")) return(0); - } else if (NULL == n->child) - if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYHEAD)) - return(0); - if (NULL == (n = mdoc->last->data.block.body)) { - if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYBODY)) + n = mdoc->last->data.block.body; + assert(n); + if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children")) return(0); - } else if (NULL == n->child) - if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYBODY)) - return(0); return(1); } - if (NULL == (n = mdoc->last->data.block.head)) { - if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYHEAD)) + 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); - } else if (NULL == n->child) - if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYHEAD)) - return(0); - if ((n = mdoc->last->data.block.body) && n->child) - if ( ! mdoc_warn(mdoc, WARN_SYNTAX_NOBODY)) + n = mdoc->last->data.block.body; + assert(n); + if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children")) return(0); - /* TODO: make sure columns are aligned. */ - assert(MDOC_Column != sv); + assert(-1 != sv); + if (MDOC_Column != sv) + return(1); - return(1); + /* Make sure the number of columns is sane. */ + argc = 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 == argc) + return(1); + return(mdoc_err(mdoc, "expected %zu list columns, have %zu", argc, 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) { @@ -534,6 +1018,7 @@ post_bl(struct mdoc *mdoc) return(1); assert(MDOC_Bl == mdoc->last->tok); + /* LINTED */ for (n = mdoc->last->child; n; n = n->next) { if (MDOC_BLOCK == n->type) if (MDOC_It == n->tok) @@ -542,43 +1027,69 @@ post_bl(struct mdoc *mdoc) } if (NULL == n) return(1); - return(mdoc_verr(mdoc, n, ERR_SYNTAX_CHILDBAD)); + return(mdoc_nerr(mdoc, n, "invalid child of parent macro `Bl'")); } +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; + } + if (NULL == n) + return(1); + return(mdoc_nerr(mdoc, n, "expected boolean value")); +} + + +static int +post_root(struct mdoc *mdoc) +{ + + 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); +} + + /* Warn if conventional sections are out of order. */ static int post_sh(struct mdoc *mdoc) { + char buf[64]; enum mdoc_sec sec; - int i; - struct mdoc_node *n; - char *args[MDOC_LINEARG_MAX]; if (MDOC_HEAD != mdoc->last->type) return(1); - assert(MDOC_Sh == mdoc->last->tok); - n = mdoc->last->child; - assert(n); + if ( ! xstrlcats(buf, mdoc->last->child, 64)) + return(mdoc_err(mdoc, "macro parameters too long")); - for (i = 0; n && i < MDOC_LINEARG_MAX; n = n->next, i++) { - assert(MDOC_TEXT == n->type); - assert(NULL == n->child); - assert(n->data.text.string); - args[i] = n->data.text.string; - } - - sec = mdoc_atosec((size_t)i, (const char **)args); - if (SEC_CUSTOM == sec) + 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_SEC_REP)); - return(mdoc_warn(mdoc, WARN_SEC_OO)); + return(mdoc_warn(mdoc, WARN_SYNTAX, "section repeated")); + return(mdoc_warn(mdoc, WARN_SYNTAX, "section out of conventional order")); } @@ -587,8 +1098,6 @@ mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *no { v_pre *p; - /* TODO: character-escape checks. */ - if (MDOC_TEXT == node->type) return(1); assert(MDOC_ROOT != node->type); @@ -607,10 +1116,14 @@ mdoc_valid_post(struct mdoc *mdoc) { v_post *p; + if (MDOC_VALID & mdoc->last->flags) + return(1); + mdoc->last->flags |= MDOC_VALID; + if (MDOC_TEXT == mdoc->last->type) return(1); if (MDOC_ROOT == mdoc->last->type) - return(1); + return(post_root(mdoc)); if (NULL == mdoc_valids[mdoc->last->tok].post) return(1);