=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.34 retrieving revision 1.51 diff -u -p -r1.34 -r1.51 --- mandoc/Attic/validate.c 2009/01/16 14:15:12 1.34 +++ mandoc/Attic/validate.c 2009/02/22 14:31:08 1.51 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.34 2009/01/16 14:15:12 kristaps Exp $ */ +/* $Id: validate.c,v 1.51 2009/02/22 14:31:08 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -21,21 +21,52 @@ #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: .Ef arguments */ +/* FIXME: math symbols. */ +/* FIXME: valid character-escape checks. */ +/* FIXME: .Fd only in synopsis section. */ struct valids { v_pre *pre; v_post *post; }; -static int pre_check_parent(struct mdoc *, struct mdoc_node *, +/* Utility checks. */ + +static int check_parent(struct mdoc *, struct mdoc_node *, int, enum mdoc_type); -static int pre_check_msecs(struct mdoc *, struct mdoc_node *, +static int check_msec(struct mdoc *, struct mdoc_node *, int, enum mdoc_msec *); +static int check_stdarg(struct mdoc *, struct mdoc_node *); +static int err_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); +/* Utility auxiliaries. */ + +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); + +/* 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 *); @@ -45,25 +76,43 @@ 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_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 *); +/* 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_sh_body(struct mdoc *); +static int post_sh_head(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 }; @@ -74,142 +123,249 @@ 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 }; +/* 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[] = { 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_in[] = { ewarn_eq1, NULL }; +static v_post posts_ss[] = { herr_ge1, NULL }; +static v_post posts_pp[] = { ewarn_eq0, NULL }; +static v_post posts_ex[] = { eerr_le1, post_ex, NULL }; +static v_post posts_an[] = { post_an, NULL }; +static v_post posts_at[] = { post_at, NULL }; +static v_post posts_xr[] = { eerr_ge1, eerr_le2, post_xr, NULL }; +static v_post posts_nm[] = { post_nm, NULL }; +static v_post posts_bf[] = { herr_le1, post_bf, NULL }; +static v_post posts_rs[] = { herr_eq0, bwarn_ge1, NULL }; +static v_post posts_fo[] = { bwarn_ge1, NULL }; +static v_post posts_bk[] = { herr_eq0, bwarn_ge1, NULL }; +/* Per-macro pre- and post-child-check routine collections. */ const struct valids mdoc_valids[MDOC_MAX] = { - { NULL, NULL }, /* \" */ - { pres_prologue, posts_text }, /* Dd */ - { pres_prologue, NULL }, /* Dt */ - { pres_prologue, NULL }, /* Os */ - /* FIXME: preceding Pp. */ - /* FIXME: NAME section internal ordering. */ - { pres_sh, posts_sh }, /* Sh */ - /* FIXME: preceding Pp. */ - { pres_ss, posts_ss }, /* Ss */ - /* FIXME: proceeding... */ - { NULL, posts_pp }, /* Pp */ - { pres_d1, posts_d1 }, /* D1 */ - { pres_d1, posts_d1 }, /* Dl */ - /* FIXME: preceding Pp. */ - { pres_bd, posts_bd }, /* Bd */ - { NULL, NULL }, /* Ed */ - /* FIXME: preceding Pp. */ - { pres_bl, posts_bl }, /* Bl */ - { NULL, NULL }, /* El */ - { pres_it, posts_it }, /* It */ - { NULL, posts_text }, /* Ad */ - /* FIXME: argument OR parameters. */ - { NULL, NULL }, /* 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_notext }, /* Ex */ /* FIXME: -std required */ - { NULL, posts_text }, /* Fa */ - { NULL, NULL }, /* Fd */ /* FIXME: SYNOPSIS section. */ - { 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 */ - { NULL, NULL }, /* Nm */ /* FIXME: If name not set? */ - { NULL, posts_wline }, /* Op */ - { NULL, NULL }, /* Ot */ - { NULL, NULL }, /* Pa */ - { NULL, posts_notext }, /* Rv */ /* -std required */ - { NULL, posts_notext }, /* St */ /* arg required */ - { NULL, posts_text }, /* Va */ - { NULL, posts_text }, /* Vt */ - { NULL, NULL }, /* Xr */ /* FIXME */ - { 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, NULL }, /* At */ /* FIXME */ - { 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 */ /* FIXME: which symbols? */ - { NULL, posts_notext }, /* No */ - { NULL, posts_notext }, /* Ns */ - { NULL, NULL }, /* Nx */ - { NULL, NULL }, /* Ox */ - { NULL, NULL }, /* Pc */ - { NULL, NULL }, /* Pf */ /* FIXME: 2 or more arguments */ /* First should be text. */ - { NULL, NULL }, /* Po */ - { NULL, posts_wline }, /* Pq */ /* FIXME: ignore following Sh/Ss */ - { 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 */ + { NULL, NULL }, /* \" */ + { pres_prologue, posts_text }, /* Dd */ + { pres_prologue, NULL }, /* Dt */ + { pres_prologue, 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 */ + { NULL, posts_wtext }, /* Fd */ + { NULL, NULL }, /* Fl */ + { NULL, posts_text }, /* Fn */ + { NULL, posts_wtext }, /* Ft */ + { NULL, posts_text }, /* Ic */ + { NULL, posts_in }, /* In */ + { NULL, posts_text }, /* Li */ + { NULL, posts_wtext }, /* Nd */ + { NULL, posts_nm }, /* Nm */ + { NULL, posts_wline }, /* Op */ + { NULL, NULL }, /* Ot */ + { NULL, NULL }, /* Pa */ + { pres_rv, posts_notext }, /* Rv */ + { pres_st, posts_notext }, /* St */ + { NULL, posts_text }, /* Va */ + { NULL, posts_text }, /* Vt */ + { NULL, posts_xr }, /* Xr */ + { NULL, posts_text }, /* %A */ + { NULL, posts_text }, /* %B */ + { NULL, posts_text }, /* %D */ + { NULL, posts_text }, /* %I */ + { NULL, posts_text }, /* %J */ + { NULL, posts_text }, /* %N */ + { NULL, posts_text }, /* %O */ + { NULL, posts_text }, /* %P */ + { NULL, posts_text }, /* %R */ + { NULL, posts_text }, /* %T */ + { NULL, posts_text }, /* %V */ + { NULL, NULL }, /* Ac */ + { NULL, NULL }, /* Ao */ + { NULL, posts_wline }, /* Aq */ + { NULL, posts_at }, /* At */ + { NULL, NULL }, /* Bc */ + { NULL, posts_bf }, /* Bf */ + { NULL, NULL }, /* Bo */ + { NULL, posts_wline }, /* Bq */ + { NULL, NULL }, /* Bsx */ + { NULL, NULL }, /* Bx */ + { NULL, posts_bool }, /* Db */ + { NULL, NULL }, /* Dc */ + { NULL, NULL }, /* Do */ + { NULL, posts_wline }, /* Dq */ + { NULL, NULL }, /* Ec */ + { NULL, NULL }, /* Ef */ + { NULL, posts_text }, /* Em */ + { NULL, NULL }, /* Eo */ + { NULL, NULL }, /* Fx */ + { NULL, posts_text }, /* Ms */ + { NULL, posts_notext }, /* No */ + { NULL, posts_notext }, /* Ns */ + { NULL, NULL }, /* Nx */ + { NULL, NULL }, /* Ox */ + { NULL, NULL }, /* Pc */ + { NULL, NULL }, /* Pf */ + { NULL, NULL }, /* Po */ + { NULL, posts_wline }, /* Pq */ + { NULL, NULL }, /* Qc */ + { NULL, posts_wline }, /* Ql */ + { NULL, NULL }, /* Qo */ + { NULL, posts_wline }, /* Qq */ + { NULL, NULL }, /* Re */ + { NULL, posts_rs }, /* Rs */ + { NULL, NULL }, /* Sc */ + { NULL, NULL }, /* So */ + { NULL, posts_wline }, /* Sq */ + { NULL, posts_bool }, /* Sm */ + { NULL, posts_text }, /* Sx */ + { NULL, posts_text }, /* Sy */ + { NULL, posts_text }, /* Tn */ + { NULL, NULL }, /* Ux */ + { NULL, NULL }, /* Xc */ + { NULL, NULL }, /* Xo */ + { NULL, posts_fo }, /* Fo */ + { NULL, NULL }, /* Fc */ + { NULL, NULL }, /* Oo */ + { NULL, NULL }, /* Oc */ + { NULL, posts_bk }, /* Bk */ + { NULL, NULL }, /* Ek */ + { NULL, posts_notext }, /* Bt */ + { NULL, NULL }, /* Hf */ + { NULL, NULL }, /* Fr */ + { NULL, posts_notext }, /* Ud */ }; +static 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 %d %s " + "(has %d)", v, want, k, 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 %d %s (has %d)", + v, want, k, 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); +} + + static int -pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node, +warn_child_gt(struct mdoc *mdoc, const char *p, int sz) +{ + int i; + + if ((i = count_child(mdoc)) > sz) + return(1); + return(warn_count(mdoc, ">", sz, p, i)); +} + + +static int +err_child_gt(struct mdoc *mdoc, const char *p, int sz) +{ + int i; + + if ((i = count_child(mdoc)) > sz) + return(1); + return(err_count(mdoc, ">", sz, p, i)); +} + + +static int +warn_child_eq(struct mdoc *mdoc, const char *p, int sz) +{ + int i; + + if ((i = count_child(mdoc)) == sz) + return(1); + return(warn_count(mdoc, "==", sz, p, i)); +} + + +static int +err_child_eq(struct mdoc *mdoc, const char *p, int sz) +{ + int i; + + if ((i = count_child(mdoc)) == sz) + return(1); + return(err_count(mdoc, "==", sz, p, i)); +} + + +static int +err_child_lt(struct mdoc *mdoc, const char *p, int sz) +{ + int i; + + if ((i = count_child(mdoc)) < sz) + return(1); + return(err_count(mdoc, "<", sz, p, i)); +} + + +static int +check_stdarg(struct mdoc *mdoc, struct mdoc_node *node) +{ + + if (MDOC_Std == node->data.elem.argv[0].arg && + 1 == node->data.elem.argc) + return(1); + + return(mdoc_nwarn(mdoc, node, WARN_COMPAT, + "macro suggests single `%s' argument", + mdoc_argnames[MDOC_Std])); +} + + +static int +check_msec(struct mdoc *mdoc, struct mdoc_node *node, int sz, enum mdoc_msec *msecs) { int i; @@ -217,144 +373,137 @@ pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *n 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")); + 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) +check_parent(struct mdoc *mdoc, struct mdoc_node *n, + int tok, enum mdoc_type t) { - if (type != mdoc->last->parent->type) - return(mdoc_nerr(mdoc, node, "invalid macro parent class %s, expected %s", - mdoc_type2a(mdoc->last->parent->type), - mdoc_type2a(type))); - if (MDOC_ROOT != type && tok == mdoc->last->parent->tok) - return(mdoc_nerr(mdoc, node, "invalid macro parent `%s', expected `%s'", - mdoc_macronames[mdoc->last->parent->tok], - mdoc_macronames[tok])); - return(1); + 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 (have %s)", + MDOC_ROOT == t ? "" : + mdoc_macronames[tok], + MDOC_ROOT == n->parent->type ? "" : + mdoc_macronames[n->parent->type])); } static int -body_err_eq0(struct mdoc *mdoc) +bwarn_ge1(struct mdoc *mdoc) { if (MDOC_BODY != mdoc->last->type) return(1); - if (NULL == mdoc->last->child) - return(1); - return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children")); + return(warn_child_gt(mdoc, "multi-line parameters", 0)); } static int -body_warn_ge1(struct mdoc *mdoc) +ewarn_eq1(struct mdoc *mdoc) { - if (MDOC_BODY != mdoc->last->type) - return(1); - if (mdoc->last->child) - return(1); - return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more body children")); + assert(MDOC_ELEM == mdoc->last->type); + return(warn_child_eq(mdoc, "line parameters", 1)); } static int -elem_warn_eq0(struct mdoc *mdoc) +ewarn_eq0(struct mdoc *mdoc) { 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")); + return(warn_child_eq(mdoc, "line parameters", 0)); } static int -elem_warn_ge1(struct mdoc *mdoc) +ewarn_ge1(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); - if (mdoc->last->child) - return(1); - return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters")); + return(warn_child_gt(mdoc, "line parameters", 0)); } static int -elem_err_eq1(struct mdoc *mdoc) +eerr_eq1(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); - if (NULL == mdoc->last->child) - return(mdoc_err(mdoc, "macro expects one parameter")); - if (mdoc->last->child->next) - return(mdoc_err(mdoc, "macro expects one parameter")); - return(1); + return(err_child_eq(mdoc, "line parameters", 1)); } static int -elem_err_eq0(struct mdoc *mdoc) +eerr_le2(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); - if (NULL == mdoc->last->child) - return(1); - return(mdoc_err(mdoc, "macro expects no parameters")); + return(err_child_lt(mdoc, "line parameters", 3)); } static int -elem_err_ge1(struct mdoc *mdoc) +eerr_le1(struct mdoc *mdoc) { assert(MDOC_ELEM == mdoc->last->type); - if (mdoc->last->child) - return(1); - return(mdoc_err(mdoc, "macro expects one or more parameters")); + return(err_child_lt(mdoc, "line parameters", 2)); } static int -head_err_eq0(struct mdoc *mdoc) +eerr_eq0(struct mdoc *mdoc) { + assert(MDOC_ELEM == mdoc->last->type); + return(err_child_eq(mdoc, "line parameters", 0)); +} + + +static int +eerr_ge1(struct mdoc *mdoc) +{ + + assert(MDOC_ELEM == mdoc->last->type); + return(err_child_gt(mdoc, "line parameters", 0)); +} + + +static int +herr_eq0(struct mdoc *mdoc) +{ + if (MDOC_HEAD != mdoc->last->type) return(1); - if (NULL == mdoc->last->child) - return(1); - return(mdoc_perr(mdoc, mdoc->last->child->line, - mdoc->last->child->pos, "macro expects no parameters")); + return(err_child_eq(mdoc, "line parameters", 0)); } static int -head_warn_ge1(struct mdoc *mdoc) +herr_le1(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")); + return(err_child_lt(mdoc, "line parameters", 2)); } static int -head_err_ge1(struct mdoc *mdoc) +herr_ge1(struct mdoc *mdoc) { if (MDOC_HEAD != mdoc->last->type) return(1); - if (mdoc->last->child) - return(1); - return(mdoc_err(mdoc, "macro expects one or more parameters")); + return(err_child_gt(mdoc, "line parameters", 0)); } @@ -367,6 +516,7 @@ pre_display(struct mdoc *mdoc, struct mdoc_node *node) return(1); assert(mdoc->last); + /* LINTED */ for (n = mdoc->last->parent; n; n = n->parent) if (MDOC_BLOCK == n->type) if (MDOC_Bd == n->tok) @@ -391,6 +541,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); @@ -448,6 +599,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); @@ -483,10 +635,9 @@ static int pre_ss(struct mdoc *mdoc, struct mdoc_node *node) { - if (MDOC_BLOCK != mdoc->last->type) + if (MDOC_BLOCK != node->type) return(1); - assert(MDOC_Sh == mdoc->last->tok); - return(pre_check_parent(mdoc, node, MDOC_Sh, MDOC_BODY)); + return(check_parent(mdoc, node, MDOC_Sh, MDOC_BODY)); } @@ -494,22 +645,66 @@ static int pre_sh(struct mdoc *mdoc, struct mdoc_node *node) { - if (MDOC_BLOCK != mdoc->last->type) + if (MDOC_BLOCK != node->type) return(1); - assert(MDOC_Sh == mdoc->last->tok); - return(pre_check_parent(mdoc, node, -1, MDOC_ROOT)); + return(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 ( ! check_msec(mdoc, node, 2, msecs)) + return(0); + return(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; - return(pre_check_msecs(mdoc, node, 3, msecs)); + if ( ! check_msec(mdoc, node, 3, msecs)) + return(0); + return(check_stdarg(mdoc, node)); } @@ -519,7 +714,7 @@ 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)); + return(check_msec(mdoc, node, 1, msecs)); } @@ -529,7 +724,7 @@ 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)); + return(check_msec(mdoc, node, 1, msecs)); } @@ -537,10 +732,12 @@ static int pre_it(struct mdoc *mdoc, struct mdoc_node *node) { - if (MDOC_BLOCK != mdoc->last->type) + /* TODO: -width attribute must be specified for -tag. */ + /* TODO: children too big for -width? */ + + if (MDOC_BLOCK != node->type) return(1); - assert(MDOC_It == mdoc->last->tok); - return(pre_check_parent(mdoc, node, MDOC_Bl, MDOC_BODY)); + return(check_parent(mdoc, node, MDOC_Bl, MDOC_BODY)); } @@ -548,7 +745,7 @@ static int pre_prologue(struct mdoc *mdoc, struct mdoc_node *node) { - if (SEC_PROLOGUE != mdoc->sec_lastn) + if (SEC_PROLOGUE != mdoc->lastnamed) return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue")); assert(MDOC_ELEM == node->type); @@ -556,15 +753,15 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node switch (node->tok) { case (MDOC_Os): - if (mdoc->meta.title[0] && mdoc->meta.date) + if (mdoc->meta.title && mdoc->meta.date) break; 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_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_nerr(mdoc, node, "prologue macro out-of-order")); default: @@ -576,7 +773,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): @@ -584,7 +781,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: @@ -596,6 +793,136 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node } +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) @@ -604,6 +931,7 @@ post_it(struct mdoc *mdoc) #define TYPE_NONE (0) #define TYPE_BODY (1) #define TYPE_HEAD (2) +#define TYPE_OHEAD (3) size_t i, argc; struct mdoc_node *n; @@ -622,9 +950,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): @@ -648,20 +978,23 @@ post_it(struct mdoc *mdoc) case (MDOC_Hyphen): /* FALLTHROUGH */ case (MDOC_Item): - /* FALLTHROUGH */ - case (MDOC_Column): type = TYPE_BODY; sv = n->data.block.argv[(int)i].arg; break; + case (MDOC_Column): + type = TYPE_OHEAD; + sv = n->data.block.argv[(int)i].arg; + break; default: break; } assert(TYPE_NONE != type); + n = mdoc->last->data.block.head; + assert(n); + 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); @@ -672,46 +1005,49 @@ post_it(struct mdoc *mdoc) if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children")) return(0); - return(1); + } else if (TYPE_BODY == type) { + 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); + } else { + 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 (n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children")) + return(0); } - 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) + if (MDOC_Column != sv) return(1); /* Make sure the number of columns is sane. */ - sv = mdoc->last->parent->parent->data.block.argv->sz; + 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 == (size_t)sv) + if (i == argc) return(1); - return(mdoc_err(mdoc, "expected %d list columns, have %d", sv, (int)i)); - + return(mdoc_err(mdoc, "expected %zu list columns, have %zu", argc, i)); #undef TYPE_NONE #undef TYPE_BODY #undef TYPE_HEAD +#undef TYPE_OHEAD } -/* Make sure that only `It' macros are our body-children. */ static int post_bl(struct mdoc *mdoc) { @@ -721,6 +1057,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) @@ -734,11 +1071,12 @@ post_bl(struct mdoc *mdoc) static int -elem_bool(struct mdoc *mdoc) +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; @@ -750,43 +1088,104 @@ elem_bool(struct mdoc *mdoc) } if (NULL == n) return(1); - return(mdoc_nerr(mdoc, n, "expected boolean value [on/off]")); + return(mdoc_nerr(mdoc, n, "expected boolean value")); } -/* Warn if conventional sections are out of order. */ static int +post_root(struct mdoc *mdoc) +{ + + if (NULL == mdoc->first->child) + return(mdoc_err(mdoc, "document has no data")); + if (SEC_PROLOGUE == mdoc->lastnamed) + return(mdoc_err(mdoc, "document has incomplete prologue")); + if (MDOC_BLOCK != mdoc->first->child->type) + return(mdoc_err(mdoc, "document expects `%s' macro after prologue", mdoc_macronames[MDOC_Sh])); + if (MDOC_Sh != mdoc->first->child->tok) + return(mdoc_err(mdoc, "document expects `%s' macro after prologue", mdoc_macronames[MDOC_Sh])); + return(1); +} + + +static int post_sh(struct mdoc *mdoc) { - enum mdoc_sec sec; - int i; + + if (MDOC_HEAD == mdoc->last->type) + return(post_sh_head(mdoc)); + if (MDOC_BODY == mdoc->last->type) + return(post_sh_body(mdoc)); + return(1); +} + + +static int +post_sh_body(struct mdoc *mdoc) +{ struct mdoc_node *n; - char *args[MDOC_LINEARG_MAX]; - if (MDOC_HEAD != mdoc->last->type) - return(1); - assert(MDOC_Sh == mdoc->last->tok); + assert(MDOC_BODY == mdoc->last->type); + if (SEC_NAME != mdoc->lastnamed) + return(1); - n = mdoc->last->child; - assert(n); + /* + * 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". + */ - 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; + if (NULL == (n = mdoc->last->child)) + return(mdoc_warn(mdoc, WARN_COMPAT, "section NAME " + "should contain %s and %s", + mdoc_macronames[MDOC_Nm], + mdoc_macronames[MDOC_Nd])); + + for ( ; n && n->next; n = n->next) { + if (MDOC_ELEM == n->type && MDOC_Nm == n->tok) + continue; + if (MDOC_TEXT == n->type) + continue; + if ( ! (mdoc_nwarn(mdoc, n, WARN_COMPAT, "section " + "NAME should contain %s as " + "initial body child", + mdoc_macronames[MDOC_Nm]))) + return(0); } - sec = mdoc_atosec((size_t)i, (const char **)args); - if (SEC_CUSTOM == sec) + if (MDOC_ELEM == n->type && MDOC_Nd == n->tok) return(1); - if (sec > mdoc->sec_lastn) - return(1); - if (sec == mdoc->sec_lastn) + return(mdoc_warn(mdoc, WARN_COMPAT, "section NAME should " + "contain %s as the last child", + mdoc_macronames[MDOC_Nd])); +} + + +static int +post_sh_head(struct mdoc *mdoc) +{ + char buf[64]; + enum mdoc_sec sec; + + assert(MDOC_Sh == mdoc->last->tok); + + if ( ! xstrlcats(buf, mdoc->last->child, 64)) + return(mdoc_err(mdoc, "macro parameters too long")); + + sec = mdoc_atosec(buf); + + if (SEC_BODY == mdoc->lastnamed && SEC_NAME != sec) + return(mdoc_err(mdoc, "section NAME must be first")); + if (SEC_CUSTOM == sec) + return(1); + if (sec == mdoc->lastnamed) return(mdoc_warn(mdoc, WARN_SYNTAX, "section repeated")); - return(mdoc_warn(mdoc, WARN_SYNTAX, "section out of conventional order")); + if (sec < mdoc->lastnamed) + return(mdoc_warn(mdoc, WARN_SYNTAX, "section out of conventional order")); + + return(1); } @@ -795,8 +1194,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); @@ -815,12 +1212,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) { - /* TODO: make sure prologue is complete. */ - return(1); - } + if (MDOC_ROOT == mdoc->last->type) + return(post_root(mdoc)); if (NULL == mdoc_valids[mdoc->last->tok].post) return(1);