=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.40 retrieving revision 1.53 diff -u -p -r1.40 -r1.53 --- mandoc/Attic/validate.c 2009/01/19 17:51:33 1.40 +++ mandoc/Attic/validate.c 2009/02/23 22:51:10 1.53 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.40 2009/01/19 17:51:33 kristaps Exp $ */ +/* $Id: validate.c,v 1.53 2009/02/23 22:51:10 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -21,15 +21,22 @@ #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: make sure prologue is complete. */ /* FIXME: valid character-escape checks. */ -/* FIXME: make sure required sections are included (NAME, ...). */ +/* FIXME: .Fd only in synopsis section. */ struct valids { v_pre *pre; @@ -38,18 +45,25 @@ struct valids { /* Utility checks. */ -static int pre_check_parent(struct mdoc *, struct mdoc_node *, +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 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); +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 *); @@ -71,7 +85,7 @@ static int pre_prologue(struct mdoc *, struct mdoc_nod /* Specific post-child-parse routines. */ static int herr_ge1(struct mdoc *); -static int hwarn_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 *); @@ -81,10 +95,11 @@ 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 berr_eq0(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 *); @@ -92,6 +107,7 @@ 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. */ @@ -117,221 +133,246 @@ 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[] = { hwarn_ge1, berr_eq0, NULL }; +static v_post posts_wline[] = { bwarn_ge1, herr_eq0, NULL }; static v_post posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL }; static v_post posts_bl[] = { herr_eq0, bwarn_ge1, post_bl, NULL }; static v_post posts_it[] = { post_it, NULL }; static v_post posts_in[] = { ewarn_eq1, NULL }; static v_post posts_ss[] = { herr_ge1, NULL }; +static v_post posts_pf[] = { eerr_eq1, NULL }; static v_post posts_pp[] = { ewarn_eq0, NULL }; -static v_post posts_d1[] = { herr_ge1, NULL }; static v_post posts_ex[] = { eerr_le1, post_ex, NULL }; static v_post posts_an[] = { post_an, NULL }; static v_post posts_at[] = { post_at, NULL }; static v_post posts_xr[] = { eerr_ge1, eerr_le2, post_xr, NULL }; static v_post posts_nm[] = { post_nm, NULL }; +static v_post posts_bf[] = { herr_le1, post_bf, NULL }; +static v_post posts_rs[] = { herr_eq0, bwarn_ge1, NULL }; +static v_post posts_fo[] = { bwarn_ge1, NULL }; +static v_post posts_bk[] = { herr_eq0, bwarn_ge1, NULL }; /* Per-macro pre- and post-child-check routine collections. */ const struct valids mdoc_valids[MDOC_MAX] = { - { NULL, NULL }, /* \" */ - { pres_prologue, posts_text }, /* Dd */ - { pres_prologue, NULL }, /* Dt */ - { pres_prologue, NULL }, /* Os */ - /* FIXME: NAME section internal ordering. */ - { pres_sh, posts_sh }, /* Sh */ - { pres_ss, posts_ss }, /* Ss */ - { NULL, posts_pp }, /* Pp */ - { pres_d1, posts_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, 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, NULL }, /* Bf */ /* FIXME */ - { 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 */ + { 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, posts_pf }, /* Pf */ + { NULL, NULL }, /* Po */ + { NULL, posts_wline }, /* Pq */ + { NULL, NULL }, /* Qc */ + { NULL, posts_wline }, /* Ql */ + { NULL, NULL }, /* Qo */ + { NULL, posts_wline }, /* Qq */ + { NULL, NULL }, /* Re */ + { NULL, posts_rs }, /* Rs */ + { NULL, NULL }, /* Sc */ + { NULL, NULL }, /* So */ + { NULL, posts_wline }, /* Sq */ + { NULL, posts_bool }, /* Sm */ + { NULL, posts_text }, /* Sx */ + { NULL, posts_text }, /* Sy */ + { NULL, posts_text }, /* Tn */ + { NULL, NULL }, /* Ux */ + { NULL, NULL }, /* Xc */ + { NULL, NULL }, /* Xo */ + { NULL, posts_fo }, /* Fo */ + { NULL, NULL }, /* Fc */ + { NULL, NULL }, /* Oo */ + { NULL, NULL }, /* Oc */ + { NULL, posts_bk }, /* Bk */ + { NULL, NULL }, /* Ek */ + { NULL, posts_notext }, /* Bt */ + { NULL, NULL }, /* Hf */ + { NULL, NULL }, /* Fr */ + { NULL, posts_notext }, /* Ud */ }; -static int -post_check_children_count(struct mdoc *mdoc) +static inline int +warn_count(struct mdoc *m, const char *k, + int want, const char *v, int has) { - struct mdoc_node *n; - int i; - for (i = 0, n = mdoc->last->child; n; n = n->next, i++) - /* Do nothing */ ; - return(i); + return(mdoc_warn(m, WARN_SYNTAX, "suggests %s %d %s " + "(has %d)", v, want, k, has)); } -static int -post_check_children_wgt(struct mdoc *mdoc, const char *p, int sz) +static inline int +err_count(struct mdoc *m, const char *k, + int want, const char *v, int has) { - int i; - if ((i = post_check_children_count(mdoc)) > sz) - return(1); - return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests more " - "than %d %s (has %d)", sz, p, i)); + return(mdoc_err(m, "requires %s %d %s (has %d)", + v, want, k, has)); } -static int -post_check_children_gt(struct mdoc *mdoc, const char *p, int sz) +static inline int +count_child(struct mdoc *mdoc) { int i; + struct mdoc_node *n; - if ((i = post_check_children_count(mdoc)) > sz) - return(1); - return(mdoc_err(mdoc, "macro requires more than %d " - "%s (has %d)", sz, p, i)); + for (i = 0, n = mdoc->last->child; n; n = n->next, i++) + /* Do nothing */ ; + + return(i); } -static int -post_check_children_weq(struct mdoc *mdoc, const char *p, int sz) -{ - int i; +/* + * Build these up with macros because they're basically the same check + * for different inequalities. Yes, this could be done with functions, + * but this is reasonable for now. + */ - if ((i = post_check_children_count(mdoc)) == sz) - return(1); - return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests %d " - "%s (has %d)", sz, p, i)); +#define CHECK_CHILD_DEFN(lvl, name, ineq) \ +static int \ +lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \ +{ \ + int i; \ + if ((i = count_child(mdoc)) ineq sz) \ + return(1); \ + return(lvl##_count(mdoc, #ineq, sz, p, i)); \ } +#define CHECK_BODY_DEFN(name, lvl, func, num) \ +static int \ +b##lvl##_##name(struct mdoc *mdoc) \ +{ \ + if (MDOC_BODY != mdoc->last->type) \ + return(1); \ + return(func(mdoc, "multiline parameters", (num))); \ +} -static int -post_check_children_eq(struct mdoc *mdoc, const char *p, int sz) -{ - int i; +#define CHECK_ELEM_DEFN(name, lvl, func, num) \ +static int \ +e##lvl##_##name(struct mdoc *mdoc) \ +{ \ + assert(MDOC_ELEM == mdoc->last->type); \ + return(func(mdoc, "line parameters", (num))); \ +} - if ((i = post_check_children_count(mdoc)) == sz) - return(1); - return(mdoc_err(mdoc, "macro requires %d %s " - "(have %d)", sz, p, i)); +#define CHECK_HEAD_DEFN(name, lvl, func, num) \ +static int \ +h##lvl##_##name(struct mdoc *mdoc) \ +{ \ + if (MDOC_HEAD != mdoc->last->type) \ + return(1); \ + return(func(mdoc, "multiline parameters", (num))); \ } -static int -post_check_children_lt(struct mdoc *mdoc, const char *p, int sz) -{ - int i; +CHECK_CHILD_DEFN(warn, gt, >) /* warn_child_gt() */ +CHECK_CHILD_DEFN(err, gt, >) /* err_child_gt() */ +CHECK_CHILD_DEFN(warn, eq, ==) /* warn_child_eq() */ +CHECK_CHILD_DEFN(err, eq, ==) /* err_child_eq() */ +CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */ +CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */ +CHECK_ELEM_DEFN(eq1, warn, warn_child_eq, 1) /* ewarn_eq1() */ +CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0) /* ewarn_eq0() */ +CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_gt1() */ +CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */ +CHECK_ELEM_DEFN(le2, err, err_child_lt, 3) /* eerr_le2() */ +CHECK_ELEM_DEFN(le1, err, err_child_lt, 2) /* eerr_le1() */ +CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */ +CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */ +CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */ +CHECK_HEAD_DEFN(le1, err, err_child_lt, 2) /* herr_le1() */ +CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0) /* herr_ge1() */ - if ((i = post_check_children_count(mdoc)) < sz) - return(1); - return(mdoc_err(mdoc, "macro requires less than %d " - "%s (have %d)", sz, p, i)); -} - static int -pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node *node) +check_stdarg(struct mdoc *mdoc, struct mdoc_node *node) { - if (1 == node->data.elem.argc && - MDOC_Std == node->data.elem.argv[0].arg) + 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])); + "one argument suggested")); } static int -pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node, +check_msec(struct mdoc *mdoc, struct mdoc_node *node, int sz, enum mdoc_msec *msecs) { int i; @@ -339,159 +380,21 @@ 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 not " - "appropriate for manual section")); + return(mdoc_nwarn(mdoc, node, WARN_COMPAT, + "wrong 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 -berr_eq0(struct mdoc *mdoc) -{ - - if (MDOC_BODY != mdoc->last->type) - return(1); - return(post_check_children_eq(mdoc, "body children", 0)); -} - - -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); - return(post_check_children_eq(mdoc, "parameters", 0)); -} - - -static int -hwarn_ge1(struct mdoc *mdoc) -{ - - if (MDOC_HEAD != mdoc->last->type) - return(1); - return(post_check_children_wgt(mdoc, "parameters", 0)); -} - - -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; + /* Display elements (`Bd', `D1'...) cannot be nested. */ + if (MDOC_BLOCK != node->type) return(1); - assert(mdoc->last); /* LINTED */ for (n = mdoc->last->parent; n; n = n->parent) if (MDOC_BLOCK == n->type) @@ -499,6 +402,7 @@ pre_display(struct mdoc *mdoc, struct mdoc_node *node) break; if (NULL == n) return(1); + return(mdoc_nerr(mdoc, node, "displays may not be nested")); } @@ -506,21 +410,21 @@ pre_display(struct mdoc *mdoc, struct mdoc_node *node) static int pre_bl(struct mdoc *mdoc, struct mdoc_node *node) { - int type, err; + int type, err, i; struct mdoc_arg *argv; - size_t i, argc; + size_t argc; if (MDOC_BLOCK != node->type) return(1); - assert(MDOC_Bl == node->tok); - argv = NULL; argc = node->data.block.argc; + /* Make sure that only one type of list is specified. */ + /* LINTED */ - for (i = type = err = 0; i < argc; i++) { - argv = &node->data.block.argv[(int)i]; - assert(argv); + for (i = 0, type = err = 0; i < (int)argc; i++) { + argv = &node->data.block.argv[i]; + switch (argv->arg) { case (MDOC_Bullet): /* FALLTHROUGH */ @@ -543,42 +447,39 @@ pre_bl(struct mdoc *mdoc, struct mdoc_node *node) case (MDOC_Inset): /* FALLTHROUGH */ case (MDOC_Column): - if (type) - err++; - type++; - break; + if (0 == type++) + break; + return(mdoc_perr(mdoc, argv->line, argv->pos, + "multiple types specified")); default: break; } } - if (0 == type) - return(mdoc_err(mdoc, "no list type specified")); - if (0 == err) + + if (type) return(1); - assert(argv); - return(mdoc_perr(mdoc, argv->line, - argv->pos, "only one list type possible")); + return(mdoc_err(mdoc, "no type specified")); } static int pre_bd(struct mdoc *mdoc, struct mdoc_node *node) { - int type, err; + int type, err, i; struct mdoc_arg *argv; - size_t i, argc; + size_t argc; if (MDOC_BLOCK != node->type) return(1); - assert(MDOC_Bd == node->tok); - argv = NULL; argc = node->data.block.argc; + /* Make sure that only one type of display is specified. */ + /* LINTED */ - for (err = i = type = 0; 0 == err && i < argc; i++) { - argv = &node->data.block.argv[(int)i]; - assert(argv); + for (i = 0, err = type = 0; ! err && i < (int)argc; i++) { + argv = &node->data.block.argv[i]; + switch (argv->arg) { case (MDOC_Ragged): /* FALLTHROUGH */ @@ -589,21 +490,18 @@ pre_bd(struct mdoc *mdoc, struct mdoc_node *node) case (MDOC_Literal): /* FALLTHROUGH */ case (MDOC_File): - if (type) - err++; - type++; - break; + if (0 == type++) + break; + return(mdoc_perr(mdoc, argv->line, argv->pos, + "multiple types specified")); default: break; } } - if (0 == type) - return(mdoc_err(mdoc, "no display type specified")); - if (0 == err) + + if (type) return(1); - assert(argv); - return(mdoc_perr(mdoc, argv->line, - argv->pos, "only one display type possible")); + return(mdoc_err(mdoc, "no type specified")); } @@ -613,7 +511,7 @@ 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)); + return(check_parent(mdoc, node, MDOC_Sh, MDOC_BODY)); } @@ -623,19 +521,30 @@ 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)); + return(check_parent(mdoc, node, -1, MDOC_ROOT)); } static int +pre_it(struct mdoc *mdoc, struct mdoc_node *node) +{ + + /* TODO: -width attribute must be specified for -tag. */ + /* TODO: children too big for -width? */ + + if (MDOC_BLOCK != node->type) + return(1); + return(check_parent(mdoc, node, MDOC_Bl, MDOC_BODY)); +} + + +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")); + return(mdoc_nerr(mdoc, node, "one argument required")); } @@ -643,84 +552,58 @@ 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")); + return(mdoc_nerr(mdoc, node, "one argument allowed")); } static int pre_rv(struct mdoc *mdoc, struct mdoc_node *node) { - enum mdoc_msec msecs[2]; + enum mdoc_msec msecs[] = { MSEC_2, MSEC_3 }; - 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)) + if ( ! check_msec(mdoc, node, 2, msecs)) return(0); - return(pre_check_stdarg(mdoc, node)); + return(check_stdarg(mdoc, node)); } static int pre_ex(struct mdoc *mdoc, struct mdoc_node *node) { - enum mdoc_msec msecs[3]; + enum mdoc_msec msecs[] = { MSEC_1, MSEC_6, MSEC_8 }; - 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)) + if ( ! check_msec(mdoc, node, 3, msecs)) return(0); - return(pre_check_stdarg(mdoc, node)); + return(check_stdarg(mdoc, node)); } static int pre_er(struct mdoc *mdoc, struct mdoc_node *node) { - enum mdoc_msec msecs[1]; + enum mdoc_msec msecs[] = { MSEC_2 }; - msecs[0] = MSEC_2; - return(pre_check_msecs(mdoc, node, 1, msecs)); + return(check_msec(mdoc, node, 1, msecs)); } static int pre_cd(struct mdoc *mdoc, struct mdoc_node *node) { - enum mdoc_msec msecs[1]; + enum mdoc_msec msecs[] = { MSEC_4 }; - msecs[0] = MSEC_4; - return(pre_check_msecs(mdoc, node, 1, msecs)); + return(check_msec(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); + if (SEC_PROLOGUE != mdoc->lastnamed) + return(mdoc_nerr(mdoc, node, "prologue only")); /* Check for ordering. */ @@ -728,15 +611,18 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node case (MDOC_Os): if (mdoc->meta.title && mdoc->meta.date) break; - return(mdoc_nerr(mdoc, node, "prologue macro out-of-order")); + return(mdoc_nerr(mdoc, node, + "prologue 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")); + return(mdoc_nerr(mdoc, node, + "prologue 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")); + return(mdoc_nerr(mdoc, node, + "prologue out-of-order")); default: abort(); /* NOTREACHED */ @@ -762,22 +648,53 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node /* NOTREACHED */ } - return(mdoc_nerr(mdoc, node, "prologue macro repeated")); + return(mdoc_nerr(mdoc, node, "prologue repetition")); } static int +post_bf(struct mdoc *mdoc) +{ + char *p; + struct mdoc_node *head; + + if (MDOC_BLOCK != mdoc->last->type) + return(1); + + head = mdoc->last->data.block.head; + + if (0 == mdoc->last->data.block.argc) { + if (NULL == head->child) + return(mdoc_err(mdoc, "argument expected")); + + 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")); + } + + if (head->child) + return(mdoc_err(mdoc, "argument expected")); + + if (1 == mdoc->last->data.block.argc) + return(1); + return(mdoc_err(mdoc, "argument expected")); +} + + +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])); + return(mdoc_err(mdoc, "not yet invoked with name")); } @@ -786,14 +703,8 @@ 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")); @@ -804,16 +715,11 @@ 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")); + return(mdoc_err(mdoc, "require valid symbol")); } @@ -821,18 +727,15 @@ 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")); + return(mdoc_err(mdoc, "argument(s) expected")); } if (mdoc->last->child) return(1); - return(mdoc_err(mdoc, "macro expects either argument or parameters")); + return(mdoc_err(mdoc, "argument(s) expected")); } @@ -840,52 +743,38 @@ 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])); + return(mdoc_err(mdoc, "argument(s) expected")); } if (mdoc->last->child) - return(mdoc_err(mdoc, "macro expects `%s' or a single child", - mdoc_argnames[MDOC_Std])); + return(mdoc_err(mdoc, "argument(s) expected")); if (1 != mdoc->last->data.elem.argc) - return(mdoc_err(mdoc, "macro expects `%s' or a single child", - mdoc_argnames[MDOC_Std])); + return(mdoc_err(mdoc, "argument(s) expected")); 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(mdoc_err(mdoc, "argument(s) expected")); + return(1); } -/* Warn if `Bl' type-specific syntax isn't reflected in items. */ static int post_it(struct mdoc *mdoc) { - int type, sv; + int type, sv, i; #define TYPE_NONE (0) #define TYPE_BODY (1) #define TYPE_HEAD (2) - size_t i, argc; +#define TYPE_OHEAD (3) + size_t argc; struct mdoc_node *n; if (MDOC_BLOCK != mdoc->last->type) return(1); - assert(MDOC_It == mdoc->last->tok); + n = mdoc->last->parent->parent; - 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; sv = -1; @@ -893,8 +782,8 @@ post_it(struct mdoc *mdoc) /* 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) { + for (i = 0; TYPE_NONE == type && i < (int)argc; i++) + switch (n->data.block.argv[i].arg) { case (MDOC_Tag): /* FALLTHROUGH */ case (MDOC_Diag): @@ -905,7 +794,7 @@ post_it(struct mdoc *mdoc) /* FALLTHROUGH */ case (MDOC_Inset): type = TYPE_HEAD; - sv = n->data.block.argv[(int)i].arg; + sv = n->data.block.argv[i].arg; break; case (MDOC_Bullet): /* FALLTHROUGH */ @@ -916,77 +805,84 @@ 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; + sv = n->data.block.argv[i].arg; break; + case (MDOC_Column): + type = TYPE_OHEAD; + sv = n->data.block.argv[i].arg; + break; default: break; } assert(TYPE_NONE != type); + n = mdoc->last->data.block.head; + 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")) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, + "argument(s) suggested")) return(0); n = mdoc->last->data.block.body; - assert(n); if (NULL == n->child) - if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children")) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, + "multiline body suggested")) return(0); - return(1); + } else if (TYPE_BODY == type) { + if (n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, + "no argument suggested")) + return(0); + + n = mdoc->last->data.block.body; + if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, + "multiline body suggested")) + return(0); + } else { + if (NULL == n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, + "argument(s) suggested")) + return(0); + + n = mdoc->last->data.block.body; + if (n->child) + if ( ! mdoc_warn(mdoc, WARN_SYNTAX, + "no multiline body suggested")) + 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); - - assert(-1 != sv); - if (MDOC_Column != sv) + if (MDOC_Column != sv) 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) + if (i == (int)argc) return(1); - return(mdoc_err(mdoc, "expected %zu list columns, have %zu", argc, i)); + + return(mdoc_err(mdoc, "need %zu columns (have %d)", argc, i)); #undef TYPE_NONE #undef TYPE_BODY #undef TYPE_HEAD +#undef TYPE_OHEAD } static int post_bl(struct mdoc *mdoc) { - struct mdoc_node *n; + struct mdoc_node *n; if (MDOC_BODY != mdoc->last->type) return(1); - assert(MDOC_Bl == mdoc->last->tok); /* LINTED */ for (n = mdoc->last->child; n; n = n->next) { @@ -995,9 +891,11 @@ post_bl(struct mdoc *mdoc) continue; break; } + if (NULL == n) return(1); - return(mdoc_nerr(mdoc, n, "invalid child of parent macro `Bl'")); + + return(mdoc_nerr(mdoc, n, "bad child of parent list")); } @@ -1006,7 +904,6 @@ 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) @@ -1017,9 +914,10 @@ ebool(struct mdoc *mdoc) continue; break; } + if (NULL == n) return(1); - return(mdoc_nerr(mdoc, n, "expected boolean value")); + return(mdoc_nerr(mdoc, n, "expected boolean")); } @@ -1027,39 +925,99 @@ 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")); + if (NULL == mdoc->first->child) + return(mdoc_err(mdoc, "document lacks data")); + if (SEC_PROLOGUE == mdoc->lastnamed) + return(mdoc_err(mdoc, "document lacks prologue")); + + if (MDOC_BLOCK != mdoc->first->child->type) + return(mdoc_err(mdoc, "lacking post-prologue `%s'", + mdoc_macronames[MDOC_Sh])); + if (MDOC_Sh != mdoc->first->child->tok) + return(mdoc_err(mdoc, "lacking post-prologue `%s'", + mdoc_macronames[MDOC_Sh])); + return(1); } -/* Warn if conventional sections are out of order. */ static int post_sh(struct mdoc *mdoc) { + + 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; + + if (SEC_NAME != mdoc->lastnamed) + return(1); + + /* + * 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". + */ + + 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); + } + + if (MDOC_ELEM == n->type && MDOC_Nd == n->tok) + return(1); + + 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; - 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))) + 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->sec_lastn) - return(1); - if (sec == mdoc->sec_lastn) + 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); }