=================================================================== RCS file: /cvs/mandoc/mdoc_validate.c,v retrieving revision 1.40 retrieving revision 1.91 diff -u -p -r1.40 -r1.91 --- mandoc/mdoc_validate.c 2009/07/24 12:09:37 1.40 +++ mandoc/mdoc_validate.c 2010/06/03 13:44:36 1.91 @@ -1,6 +1,6 @@ -/* $Id: mdoc_validate.c,v 1.40 2009/07/24 12:09:37 kristaps Exp $ */ +/* $Id: mdoc_validate.c,v 1.91 2010/06/03 13:44:36 kristaps Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -14,23 +14,27 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + #include #include #include -#include #include -#include +#include #include #include +#include "mandoc.h" #include "libmdoc.h" #include "libmandoc.h" /* FIXME: .Bl -diag can't have non-text children in HEAD. */ /* TODO: ignoring Pp (it's superfluous in some invocations). */ -#define PRE_ARGS struct mdoc *mdoc, const struct mdoc_node *n +#define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n #define POST_ARGS struct mdoc *mdoc typedef int (*v_pre)(PRE_ARGS); @@ -41,9 +45,7 @@ struct valids { v_post *post; }; -static int check_parent(PRE_ARGS, int, enum mdoc_type); -static int check_msec(PRE_ARGS, ...); -static int check_sec(PRE_ARGS, ...); +static int check_parent(PRE_ARGS, enum mdoct, enum mdoc_type); static int check_stdarg(PRE_ARGS); static int check_text(struct mdoc *, int, int, const char *); static int check_argv(struct mdoc *, @@ -57,56 +59,49 @@ static int err_child_gt(struct mdoc *, const char *, static int warn_child_gt(struct mdoc *, const char *, int); static int err_child_eq(struct mdoc *, const char *, int); static int warn_child_eq(struct mdoc *, const char *, int); -static int warn_print(struct mdoc *, int, int); static int warn_count(struct mdoc *, const char *, int, const char *, int); static int err_count(struct mdoc *, const char *, int, const char *, int); -#ifdef __linux__ -extern size_t strlcat(char *, const char *, size_t); -#endif - static int berr_ge1(POST_ARGS); static int bwarn_ge1(POST_ARGS); static int ebool(POST_ARGS); static int eerr_eq0(POST_ARGS); static int eerr_eq1(POST_ARGS); static int eerr_ge1(POST_ARGS); -static int eerr_le2(POST_ARGS); +static int eerr_le1(POST_ARGS); static int ewarn_ge1(POST_ARGS); static int herr_eq0(POST_ARGS); static int herr_ge1(POST_ARGS); static int hwarn_eq1(POST_ARGS); +static int hwarn_eq0(POST_ARGS); static int hwarn_le1(POST_ARGS); static int post_an(POST_ARGS); -static int post_args(POST_ARGS); static int post_at(POST_ARGS); static int post_bf(POST_ARGS); static int post_bl(POST_ARGS); static int post_bl_head(POST_ARGS); +static int post_dt(POST_ARGS); static int post_it(POST_ARGS); static int post_lb(POST_ARGS); static int post_nm(POST_ARGS); static int post_root(POST_ARGS); +static int post_rs(POST_ARGS); static int post_sh(POST_ARGS); static int post_sh_body(POST_ARGS); static int post_sh_head(POST_ARGS); -static int post_sp(POST_ARGS); static int post_st(POST_ARGS); +static int post_eoln(POST_ARGS); +static int post_vt(POST_ARGS); static int pre_an(PRE_ARGS); static int pre_bd(PRE_ARGS); static int pre_bl(PRE_ARGS); -static int pre_cd(PRE_ARGS); static int pre_dd(PRE_ARGS); static int pre_display(PRE_ARGS); static int pre_dt(PRE_ARGS); -static int pre_er(PRE_ARGS); -static int pre_ex(PRE_ARGS); -static int pre_fd(PRE_ARGS); static int pre_it(PRE_ARGS); -static int pre_lb(PRE_ARGS); static int pre_os(PRE_ARGS); static int pre_rv(PRE_ARGS); static int pre_sh(PRE_ARGS); @@ -114,40 +109,38 @@ static int pre_ss(PRE_ARGS); static v_post posts_an[] = { post_an, NULL }; static v_post posts_at[] = { post_at, NULL }; -static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL }; +static v_post posts_bd[] = { hwarn_eq0, bwarn_ge1, NULL }; static v_post posts_bf[] = { hwarn_le1, post_bf, NULL }; static v_post posts_bl[] = { bwarn_ge1, post_bl, NULL }; static v_post posts_bool[] = { eerr_eq1, ebool, NULL }; -static v_post posts_ex[] = { eerr_eq0, post_args, NULL }; +static v_post posts_eoln[] = { post_eoln, NULL }; +static v_post posts_dt[] = { post_dt, NULL }; static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL }; -static v_post posts_in[] = { eerr_eq1, NULL }; static v_post posts_it[] = { post_it, NULL }; static v_post posts_lb[] = { eerr_eq1, post_lb, NULL }; static v_post posts_nd[] = { berr_ge1, NULL }; static v_post posts_nm[] = { post_nm, NULL }; static v_post posts_notext[] = { eerr_eq0, NULL }; -static v_post posts_pf[] = { eerr_eq1, NULL }; -static v_post posts_rv[] = { eerr_eq0, post_args, NULL }; +static v_post posts_rs[] = { berr_ge1, herr_eq0, post_rs, NULL }; static v_post posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL }; -static v_post posts_sp[] = { post_sp, NULL }; +static v_post posts_sp[] = { eerr_le1, NULL }; static v_post posts_ss[] = { herr_ge1, NULL }; static v_post posts_st[] = { eerr_eq1, post_st, NULL }; static v_post posts_text[] = { eerr_ge1, NULL }; +static v_post posts_text1[] = { eerr_eq1, NULL }; +static v_post posts_vt[] = { post_vt, NULL }; static v_post posts_wline[] = { bwarn_ge1, herr_eq0, NULL }; static v_post posts_wtext[] = { ewarn_ge1, NULL }; -static v_post posts_xr[] = { eerr_ge1, eerr_le2, NULL }; static v_pre pres_an[] = { pre_an, NULL }; static v_pre pres_bd[] = { pre_display, pre_bd, NULL }; static v_pre pres_bl[] = { pre_bl, NULL }; -static v_pre pres_cd[] = { pre_cd, NULL }; static v_pre pres_d1[] = { pre_display, NULL }; static v_pre pres_dd[] = { pre_dd, NULL }; static v_pre pres_dt[] = { pre_dt, NULL }; -static v_pre pres_er[] = { pre_er, NULL }; -static v_pre pres_ex[] = { pre_ex, NULL }; -static v_pre pres_fd[] = { pre_fd, NULL }; +static v_pre pres_er[] = { NULL, NULL }; +static v_pre pres_ex[] = { NULL, NULL }; +static v_pre pres_fd[] = { NULL, NULL }; static v_pre pres_it[] = { pre_it, NULL }; -static v_pre pres_lb[] = { pre_lb, NULL }; static v_pre pres_os[] = { pre_os, NULL }; static v_pre pres_rv[] = { pre_rv, NULL }; static v_pre pres_sh[] = { pre_sh, NULL }; @@ -156,7 +149,7 @@ static v_pre pres_ss[] = { pre_ss, NULL }; const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Ap */ { pres_dd, posts_text }, /* Dd */ - { pres_dt, NULL }, /* Dt */ + { pres_dt, posts_dt }, /* Dt */ { pres_os, NULL }, /* Os */ { pres_sh, posts_sh }, /* Sh */ { pres_ss, posts_ss }, /* Ss */ @@ -171,40 +164,40 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, posts_text }, /* Ad */ { pres_an, posts_an }, /* An */ { NULL, NULL }, /* Ar */ - { pres_cd, posts_text }, /* Cd */ + { NULL, posts_text }, /* Cd */ { NULL, NULL }, /* Cm */ { NULL, NULL }, /* Dv */ { pres_er, posts_text }, /* Er */ { NULL, NULL }, /* Ev */ - { pres_ex, posts_ex }, /* Ex */ + { pres_ex, NULL }, /* Ex */ { NULL, NULL }, /* Fa */ { pres_fd, posts_wtext }, /* Fd */ { NULL, NULL }, /* Fl */ { NULL, posts_text }, /* Fn */ { NULL, posts_wtext }, /* Ft */ { NULL, posts_text }, /* Ic */ - { NULL, posts_in }, /* In */ + { NULL, posts_text1 }, /* In */ { NULL, NULL }, /* Li */ { NULL, posts_nd }, /* Nd */ { NULL, posts_nm }, /* Nm */ { NULL, posts_wline }, /* Op */ { NULL, NULL }, /* Ot */ { NULL, NULL }, /* Pa */ - { pres_rv, posts_rv }, /* Rv */ + { pres_rv, NULL }, /* Rv */ { NULL, posts_st }, /* St */ { NULL, NULL }, /* Va */ - { NULL, posts_text }, /* Vt */ - { NULL, posts_xr }, /* Xr */ + { NULL, posts_vt }, /* Vt */ + { NULL, posts_wtext }, /* Xr */ { NULL, posts_text }, /* %A */ - { NULL, posts_text }, /* %B */ - { NULL, posts_text }, /* %D */ + { NULL, posts_text }, /* %B */ /* FIXME: can be used outside Rs/Re. */ + { NULL, posts_text }, /* %D */ /* FIXME: check date with mandoc_a2time(). */ { 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 }, /* %T */ /* FIXME: can be used outside Rs/Re. */ { NULL, posts_text }, /* %V */ { NULL, NULL }, /* Ac */ { NULL, NULL }, /* Ao */ @@ -231,7 +224,7 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Nx */ { NULL, NULL }, /* Ox */ { NULL, NULL }, /* Pc */ - { NULL, posts_pf }, /* Pf */ + { NULL, posts_text1 }, /* Pf */ { NULL, NULL }, /* Po */ { NULL, posts_wline }, /* Pq */ { NULL, NULL }, /* Qc */ @@ -239,7 +232,7 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Qo */ { NULL, posts_wline }, /* Qq */ { NULL, NULL }, /* Re */ - { NULL, posts_wline }, /* Rs */ + { NULL, posts_rs }, /* Rs */ { NULL, NULL }, /* Sc */ { NULL, NULL }, /* So */ { NULL, posts_wline }, /* Sq */ @@ -256,13 +249,13 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Oc */ { NULL, posts_wline }, /* Bk */ { NULL, NULL }, /* Ek */ - { NULL, posts_notext }, /* Bt */ + { NULL, posts_eoln }, /* Bt */ { NULL, NULL }, /* Hf */ { NULL, NULL }, /* Fr */ - { NULL, posts_notext }, /* Ud */ - { pres_lb, posts_lb }, /* Lb */ + { NULL, posts_eoln }, /* Ud */ + { NULL, posts_lb }, /* Lb */ { NULL, posts_notext }, /* Lp */ - { NULL, NULL }, /* Lk */ + { NULL, posts_text }, /* Lk */ { NULL, posts_text }, /* Mt */ { NULL, posts_wline }, /* Brq */ { NULL, NULL }, /* Bro */ @@ -274,11 +267,13 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, posts_text }, /* %Q */ { NULL, posts_notext }, /* br */ { NULL, posts_sp }, /* sp */ + { NULL, posts_text1 }, /* %U */ + { NULL, NULL }, /* Ta */ }; int -mdoc_valid_pre(struct mdoc *mdoc, const struct mdoc_node *n) +mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n) { v_pre *p; int line, pos; @@ -326,23 +321,14 @@ mdoc_valid_post(struct mdoc *mdoc) } -static int -warn_print(struct mdoc *m, int ln, int pos) -{ - - if (MDOC_IGN_CHARS & m->pflags) - return(mdoc_pwarn(m, ln, pos, EPRINT)); - return(mdoc_perr(m, ln, pos, EPRINT)); -} - - static inline int warn_count(struct mdoc *m, const char *k, int want, const char *v, int has) { - return(mdoc_vwarn(m, m->last->line, m->last->pos, - "suggests %s %s %d (has %d)", v, k, want, has)); + return(mdoc_vmsg(m, MANDOCERR_ARGCOUNT, + m->last->line, m->last->pos, + "%s %s %d (have %d)", v, k, want, has)); } @@ -351,8 +337,11 @@ err_count(struct mdoc *m, const char *k, int want, const char *v, int has) { - return(mdoc_verr(m, m->last->line, m->last->pos, - "requires %s %s %d (has %d)", v, k, want, has)); + mdoc_vmsg(m, MANDOCERR_SYNTARGCOUNT, + m->last->line, m->last->pos, + "%s %s %d (have %d)", + v, k, want, has); + return(0); } @@ -406,15 +395,16 @@ CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */ CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */ CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */ CHECK_BODY_DEFN(ge1, err, err_child_gt, 0) /* berr_ge1() */ -CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_gt1() */ +CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_ge1() */ 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, warn, warn_child_lt, 2) /* hwarn_le1() */ CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0) /* herr_ge1() */ CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1) /* hwarn_eq1() */ +CHECK_HEAD_DEFN(eq0, warn, warn_child_eq, 0) /* hwarn_eq0() */ static int @@ -424,57 +414,11 @@ check_stdarg(PRE_ARGS) if (n->args && 1 == n->args->argc) if (MDOC_Std == n->args->argv[0].arg) return(1); - return(mdoc_nwarn(mdoc, n, EARGVAL)); + return(mdoc_nmsg(mdoc, n, MANDOCERR_NOARGV)); } static int -check_sec(PRE_ARGS, ...) -{ - enum mdoc_sec sec; - va_list ap; - - va_start(ap, n); - - for (;;) { - /* LINTED */ - sec = (enum mdoc_sec)va_arg(ap, int); - if (SEC_CUSTOM == sec) - break; - if (sec != mdoc->lastsec) - continue; - va_end(ap); - return(1); - } - - va_end(ap); - return(mdoc_nwarn(mdoc, n, EBADSEC)); -} - - -static int -check_msec(PRE_ARGS, ...) -{ - va_list ap; - int msec; - - va_start(ap, n); - for (;;) { - /* LINTED */ - if (0 == (msec = va_arg(ap, int))) - break; - if (msec != mdoc->meta.msec) - continue; - va_end(ap); - return(1); - } - - va_end(ap); - return(mdoc_nwarn(mdoc, n, EBADMSEC)); -} - - -static int check_args(struct mdoc *m, const struct mdoc_node *n) { int i; @@ -502,10 +446,10 @@ check_argv(struct mdoc *m, const struct mdoc_node *n, return(0); if (MDOC_Std == v->arg) { - /* `Nm' name must be set. */ if (v->sz || m->meta.name) return(1); - return(mdoc_nerr(m, n, ENAME)); + if ( ! mdoc_nmsg(m, n, MANDOCERR_NONAME)) + return(0); } return(1); @@ -520,10 +464,10 @@ check_text(struct mdoc *mdoc, int line, int pos, const for ( ; *p; p++, pos++) { if ('\t' == *p) { if ( ! (MDOC_LITERAL & mdoc->flags)) - if ( ! warn_print(mdoc, line, pos)) + if ( ! mdoc_pmsg(mdoc, line, pos, MANDOCERR_BADCHAR)) return(0); - } else if ( ! isprint((u_char)*p)) - if ( ! warn_print(mdoc, line, pos)) + } else if ( ! isprint((u_char)*p) && ASCII_HYPH != *p) + if ( ! mdoc_pmsg(mdoc, line, pos, MANDOCERR_BADCHAR)) return(0); if ('\\' != *p) @@ -535,10 +479,10 @@ check_text(struct mdoc *mdoc, int line, int pos, const pos += c - 1; continue; } - if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags)) - return(mdoc_perr(mdoc, line, pos, EESCAPE)); - if ( ! mdoc_pwarn(mdoc, line, pos, EESCAPE)) - return(0); + + c = mdoc_pmsg(mdoc, line, pos, MANDOCERR_BADESCAPE); + if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags) && ! c) + return(c); } return(1); @@ -548,7 +492,7 @@ check_text(struct mdoc *mdoc, int line, int pos, const static int -check_parent(PRE_ARGS, int tok, enum mdoc_type t) +check_parent(PRE_ARGS, enum mdoct tok, enum mdoc_type t) { assert(n->parent); @@ -556,8 +500,11 @@ check_parent(PRE_ARGS, int tok, enum mdoc_type t) (t == n->parent->type)) return(1); - return(mdoc_verr(mdoc, n->line, n->pos, "require parent %s", - MDOC_ROOT == t ? "" : mdoc_macronames[tok])); + mdoc_vmsg(mdoc, MANDOCERR_SYNTCHILD, + n->line, n->pos, "want parent %s", + MDOC_ROOT == t ? "" : + mdoc_macronames[tok]); + return(0); } @@ -580,90 +527,154 @@ pre_display(PRE_ARGS) if (NULL == node) return(1); - return(mdoc_nerr(mdoc, n, ENESTDISP)); + mdoc_nmsg(mdoc, n, MANDOCERR_NESTEDDISP); + return(0); } static int pre_bl(PRE_ARGS) { - int pos, type, width, offset; + int i, width, offs, cmpt, dupl; + enum mdoc_list lt; - if (MDOC_BLOCK != n->type) + if (MDOC_BLOCK != n->type) { + assert(n->parent); + assert(MDOC_BLOCK == n->parent->type); + assert(MDOC_Bl == n->parent->tok); + assert(LIST__NONE != n->parent->data.list); + n->data.list = n->parent->data.list; return(1); - if (NULL == n->args) - return(mdoc_nerr(mdoc, n, ELISTTYPE)); + } - /* Make sure that only one type of list is specified. */ + /* + * First figure out which kind of list to use: bind ourselves to + * the first mentioned list type and warn about any remaining + * ones. If we find no list type, we default to LIST_item. + */ - type = offset = width = -1; + assert(LIST__NONE == n->data.list); + offs = width = cmpt = -1; /* LINTED */ - for (pos = 0; pos < (int)n->args->argc; pos++) - switch (n->args->argv[pos].arg) { + for (i = 0; n->args && i < (int)n->args->argc; i++) { + lt = LIST__NONE; + dupl = 0; + switch (n->args->argv[i].arg) { + /* Set list types. */ case (MDOC_Bullet): - /* FALLTHROUGH */ + lt = LIST_bullet; + break; case (MDOC_Dash): - /* FALLTHROUGH */ + lt = LIST_dash; + break; case (MDOC_Enum): - /* FALLTHROUGH */ + lt = LIST_enum; + break; case (MDOC_Hyphen): - /* FALLTHROUGH */ + lt = LIST_hyphen; + break; case (MDOC_Item): - /* FALLTHROUGH */ + lt = LIST_item; + break; case (MDOC_Tag): - /* FALLTHROUGH */ + lt = LIST_tag; + break; case (MDOC_Diag): - /* FALLTHROUGH */ + lt = LIST_diag; + break; case (MDOC_Hang): - /* FALLTHROUGH */ + lt = LIST_hang; + break; case (MDOC_Ohang): - /* FALLTHROUGH */ + lt = LIST_ohang; + break; case (MDOC_Inset): - /* FALLTHROUGH */ + lt = LIST_inset; + break; case (MDOC_Column): - if (-1 != type) - return(mdoc_nerr(mdoc, n, EMULTILIST)); - type = n->args->argv[pos].arg; + lt = LIST_column; break; + /* Set list arguments. */ + case (MDOC_Compact): + if (cmpt >= 0) + dupl++; + cmpt = i; + break; case (MDOC_Width): - if (-1 != width) - return(mdoc_nerr(mdoc, n, EARGREP)); - width = n->args->argv[pos].arg; + if (width >= 0) + dupl++; + width = i; break; case (MDOC_Offset): - if (-1 != offset) - return(mdoc_nerr(mdoc, n, EARGREP)); - offset = n->args->argv[pos].arg; + if (offs >= 0) + dupl++; + offs = i; break; - default: - break; } - if (-1 == type) - return(mdoc_nerr(mdoc, n, ELISTTYPE)); + /* Check: duplicate auxiliary arguments. */ + if (dupl) + if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP)) + return(0); + + /* Check: multiple list types. */ + + if (LIST__NONE != lt && n->data.list != LIST__NONE) + if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP)) + return(0); + + /* Assign list type. */ + + if (LIST__NONE != lt && n->data.list == LIST__NONE) + n->data.list = lt; + + /* The list type should come first. */ + + if (n->data.list == LIST__NONE) + if (width >= 0 || offs >= 0 || cmpt >= 0) + if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST)) + return(0); + + continue; + } + + /* Allow lists to default to LIST_item. */ + + if (LIST__NONE == n->data.list) { + if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE)) + return(0); + n->data.list = LIST_item; + } + /* * Validate the width field. Some list types don't need width * types and should be warned about them. Others should have it * and must also be warned. */ - switch (type) { - case (MDOC_Tag): - if (-1 == width && ! mdoc_nwarn(mdoc, n, EMISSWIDTH)) - return(0); - break; - case (MDOC_Column): + switch (n->data.list) { + case (LIST_tag): + if (width >= 0) + break; + if (mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG)) + break; + return(0); + case (LIST_column): /* FALLTHROUGH */ - case (MDOC_Diag): + case (LIST_diag): /* FALLTHROUGH */ - case (MDOC_Inset): + case (LIST_ohang): /* FALLTHROUGH */ - case (MDOC_Item): - if (-1 != width && ! mdoc_nwarn(mdoc, n, ENOWIDTH)) - return(0); - break; + case (LIST_inset): + /* FALLTHROUGH */ + case (LIST_item): + if (width < 0) + break; + if (mdoc_nmsg(mdoc, n, MANDOCERR_WIDTHARG)) + break; + return(0); default: break; } @@ -679,8 +690,10 @@ pre_bd(PRE_ARGS) if (MDOC_BLOCK != n->type) return(1); - if (NULL == n->args) - return(mdoc_nerr(mdoc, n, EDISPTYPE)); + if (NULL == n->args) { + mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE); + return(0); + } /* Make sure that only one type of display is specified. */ @@ -688,6 +701,8 @@ pre_bd(PRE_ARGS) for (i = 0, err = type = 0; ! err && i < (int)n->args->argc; i++) switch (n->args->argv[i].arg) { + case (MDOC_Centred): + /* FALLTHROUGH */ case (MDOC_Ragged): /* FALLTHROUGH */ case (MDOC_Unfilled): @@ -695,18 +710,19 @@ pre_bd(PRE_ARGS) case (MDOC_Filled): /* FALLTHROUGH */ case (MDOC_Literal): - /* FALLTHROUGH */ - case (MDOC_File): if (0 == type++) break; - return(mdoc_nerr(mdoc, n, EMULTIDISP)); + if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_DISPREP)) + return(0); + break; default: break; } if (type) return(1); - return(mdoc_nerr(mdoc, n, EDISPTYPE)); + mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE); + return(0); } @@ -726,7 +742,7 @@ pre_sh(PRE_ARGS) if (MDOC_BLOCK != n->type) return(1); - return(check_parent(mdoc, n, -1, MDOC_ROOT)); + return(check_parent(mdoc, n, MDOC_MAX, MDOC_ROOT)); } @@ -736,6 +752,10 @@ pre_it(PRE_ARGS) if (MDOC_BLOCK != n->type) return(1); + /* + * FIXME: this can probably be lifted if we make the It into + * something else on-the-fly? + */ return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY)); } @@ -746,64 +766,50 @@ pre_an(PRE_ARGS) if (NULL == n->args || 1 == n->args->argc) return(1); - return(mdoc_verr(mdoc, n->line, n->pos, - "only one argument allowed")); + mdoc_vmsg(mdoc, MANDOCERR_SYNTARGCOUNT, + n->line, n->pos, + "line arguments == 1 (have %d)", + n->args->argc); + return(0); } static int -pre_lb(PRE_ARGS) -{ - - return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM)); -} - - -static int pre_rv(PRE_ARGS) { - if ( ! check_msec(mdoc, n, 2, 3, 0)) - return(0); return(check_stdarg(mdoc, n)); } static int -pre_ex(PRE_ARGS) +post_dt(POST_ARGS) { + const struct mdoc_node *nn; + const char *p; - if ( ! check_msec(mdoc, n, 1, 6, 8, 0)) - return(0); - return(check_stdarg(mdoc, n)); -} + if (NULL != (nn = mdoc->last->child)) + for (p = nn->string; *p; p++) { + if (toupper((u_char)*p) == *p) + continue; + if ( ! mdoc_nmsg(mdoc, nn, MANDOCERR_UPPERCASE)) + return(0); + break; + } - -static int -pre_er(PRE_ARGS) -{ - - return(check_msec(mdoc, n, 2, 3, 9, 0)); + return(1); } static int -pre_cd(PRE_ARGS) -{ - - return(check_msec(mdoc, n, 4, 0)); -} - - -static int pre_dt(PRE_ARGS) { if (0 == mdoc->meta.date || mdoc->meta.os) - if ( ! mdoc_nwarn(mdoc, n, EPROLOOO)) + if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO)) return(0); if (mdoc->meta.title) - if ( ! mdoc_nwarn(mdoc, n, EPROLREP)) + if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP)) return(0); return(1); } @@ -814,10 +820,10 @@ pre_os(PRE_ARGS) { if (NULL == mdoc->meta.title || 0 == mdoc->meta.date) - if ( ! mdoc_nwarn(mdoc, n, EPROLOOO)) + if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO)) return(0); if (mdoc->meta.os) - if ( ! mdoc_nwarn(mdoc, n, EPROLREP)) + if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP)) return(0); return(1); } @@ -828,10 +834,10 @@ pre_dd(PRE_ARGS) { if (mdoc->meta.title || mdoc->meta.os) - if ( ! mdoc_nwarn(mdoc, n, EPROLOOO)) + if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO)) return(0); if (mdoc->meta.date) - if ( ! mdoc_nwarn(mdoc, n, EPROLREP)) + if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP)) return(0); return(1); } @@ -848,13 +854,18 @@ post_bf(POST_ARGS) head = mdoc->last->head; - if (mdoc->last->args && head->child) - return(mdoc_nerr(mdoc, mdoc->last, ELINE)); - else if (mdoc->last->args) + if (mdoc->last->args && head->child) { + /* FIXME: this should provide a default. */ + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SYNTARGVCOUNT); + return(0); + } else if (mdoc->last->args) return(1); - if (NULL == head->child || MDOC_TEXT != head->child->type) - return(mdoc_nerr(mdoc, mdoc->last, ELINE)); + if (NULL == head->child || MDOC_TEXT != head->child->type) { + /* FIXME: this should provide a default. */ + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SYNTARGVCOUNT); + return(0); + } p = head->child->string; @@ -865,7 +876,8 @@ post_bf(POST_ARGS) else if (0 == strcmp(p, "Sy")) return(1); - return(mdoc_nerr(mdoc, head, EFONT)); + mdoc_nmsg(mdoc, head, MANDOCERR_FONTTYPE); + return(0); } @@ -875,11 +887,47 @@ post_lb(POST_ARGS) if (mdoc_a2lib(mdoc->last->child->string)) return(1); - return(mdoc_nwarn(mdoc, mdoc->last, ELIB)); + return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADLIB)); } static int +post_eoln(POST_ARGS) +{ + + if (NULL == mdoc->last->child) + return(1); + return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST)); +} + + +static int +post_vt(POST_ARGS) +{ + const struct mdoc_node *n; + + /* + * The Vt macro comes in both ELEM and BLOCK form, both of which + * have different syntaxes (yet more context-sensitive + * behaviour). ELEM types must have a child; BLOCK types, + * specifically the BODY, should only have TEXT children. + */ + + if (MDOC_ELEM == mdoc->last->type) + return(eerr_ge1(mdoc)); + if (MDOC_BODY != mdoc->last->type) + return(1); + + for (n = mdoc->last->child; n; n = n->next) + if (MDOC_TEXT != n->type) + if ( ! mdoc_nmsg(mdoc, n, MANDOCERR_CHILD)) + return(0); + + return(1); +} + + +static int post_nm(POST_ARGS) { @@ -887,7 +935,7 @@ post_nm(POST_ARGS) return(1); if (mdoc->meta.name) return(1); - return(mdoc_nerr(mdoc, mdoc->last, ENAME)); + return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NONAME)); } @@ -897,11 +945,10 @@ post_at(POST_ARGS) if (NULL == mdoc->last->child) return(1); - if (MDOC_TEXT != mdoc->last->child->type) - return(mdoc_nerr(mdoc, mdoc->last, EATT)); + assert(MDOC_TEXT == mdoc->last->child->type); if (mdoc_a2att(mdoc->last->child->string)) return(1); - return(mdoc_nerr(mdoc, mdoc->last, EATT)); + return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADATT)); } @@ -912,136 +959,102 @@ post_an(POST_ARGS) if (mdoc->last->args) { if (NULL == mdoc->last->child) return(1); - return(mdoc_nerr(mdoc, mdoc->last, ENOLINE)); + return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGCOUNT)); } if (mdoc->last->child) return(1); - return(mdoc_nerr(mdoc, mdoc->last, ELINE)); + return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS)); } static int -post_args(POST_ARGS) -{ - - if (mdoc->last->args) - return(1); - return(mdoc_nerr(mdoc, mdoc->last, ELINE)); -} - - -static int post_it(POST_ARGS) { - int type, i, cols; + int i, cols, rc; + enum mdoc_list lt; struct mdoc_node *n, *c; + enum mandocerr er; if (MDOC_BLOCK != mdoc->last->type) return(1); n = mdoc->last->parent->parent; - if (NULL == n->args) - return(mdoc_nerr(mdoc, mdoc->last, ELISTTYPE)); + lt = n->data.list; - /* Some types require block-head, some not. */ + if (LIST__NONE == lt) { + mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_LISTTYPE); + return(0); + } - /* LINTED */ - for (cols = type = -1, i = 0; -1 == type && - i < (int)n->args->argc; i++) - switch (n->args->argv[i].arg) { - case (MDOC_Tag): - /* FALLTHROUGH */ - case (MDOC_Diag): - /* FALLTHROUGH */ - case (MDOC_Hang): - /* FALLTHROUGH */ - case (MDOC_Ohang): - /* FALLTHROUGH */ - case (MDOC_Inset): - /* FALLTHROUGH */ - case (MDOC_Bullet): - /* FALLTHROUGH */ - case (MDOC_Dash): - /* FALLTHROUGH */ - case (MDOC_Enum): - /* FALLTHROUGH */ - case (MDOC_Hyphen): - /* FALLTHROUGH */ - case (MDOC_Item): - type = n->args->argv[i].arg; + switch (lt) { + case (LIST_tag): + if (mdoc->last->head->child) break; - case (MDOC_Column): - type = n->args->argv[i].arg; - cols = (int)n->args->argv[i].sz; - break; - default: - break; - } - - if (-1 == type) - return(mdoc_nerr(mdoc, mdoc->last, ELISTTYPE)); - - switch (type) { - case (MDOC_Tag): - if (NULL == mdoc->last->head->child) - if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE)) - return(0); + /* FIXME: give this a dummy value. */ + if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS)) + return(0); break; - case (MDOC_Hang): + case (LIST_hang): /* FALLTHROUGH */ - case (MDOC_Ohang): + case (LIST_ohang): /* FALLTHROUGH */ - case (MDOC_Inset): + case (LIST_inset): /* FALLTHROUGH */ - case (MDOC_Diag): + case (LIST_diag): if (NULL == mdoc->last->head->child) - if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE)) + if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS)) return(0); if (NULL == mdoc->last->body->child) - if ( ! mdoc_nwarn(mdoc, mdoc->last, EMULTILINE)) + if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY)) return(0); break; - case (MDOC_Bullet): + case (LIST_bullet): /* FALLTHROUGH */ - case (MDOC_Dash): + case (LIST_dash): /* FALLTHROUGH */ - case (MDOC_Enum): + case (LIST_enum): /* FALLTHROUGH */ - case (MDOC_Hyphen): + case (LIST_hyphen): /* FALLTHROUGH */ - case (MDOC_Item): + case (LIST_item): if (mdoc->last->head->child) - if ( ! mdoc_nwarn(mdoc, mdoc->last, ENOLINE)) + if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST)) return(0); if (NULL == mdoc->last->body->child) - if ( ! mdoc_nwarn(mdoc, mdoc->last, EMULTILINE)) + if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY)) return(0); break; - case (MDOC_Column): - if (NULL == mdoc->last->head->child) - if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE)) - return(0); - if (mdoc->last->body->child) - if ( ! mdoc_nwarn(mdoc, mdoc->last, ENOMULTILINE)) - return(0); - c = mdoc->last->child; - for (i = 0; c && MDOC_HEAD == c->type; c = c->next) - i++; + case (LIST_column): + cols = -1; + for (i = 0; i < (int)n->args->argc; i++) + if (MDOC_Column == n->args->argv[i].arg) { + cols = (int)n->args->argv[i].sz; + break; + } - if (i < cols || i == (cols + 1)) { - if ( ! mdoc_vwarn(mdoc, mdoc->last->line, - mdoc->last->pos, "column " - "mismatch: have %d, want %d", - i, cols)) + assert(-1 != cols); + assert(NULL == mdoc->last->head->child); + + if (NULL == mdoc->last->body->child) + if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY)) return(0); + + for (i = 0, c = mdoc->last->child; c; c = c->next) + if (MDOC_BODY == c->type) + i++; + + if (i < cols) + er = MANDOCERR_ARGCOUNT; + else if (i == cols || i == cols + 1) break; - } else if (i == cols) - break; + else + er = MANDOCERR_SYNTARGCOUNT; - return(mdoc_verr(mdoc, mdoc->last->line, - mdoc->last->pos, "column mismatch: " - "have %d, want %d", i, cols)); + rc = mdoc_vmsg(mdoc, er, + mdoc->last->line, mdoc->last->pos, + "columns == %d (have %d)", cols, i); + return(rc); default: break; } @@ -1053,23 +1066,28 @@ post_it(POST_ARGS) static int post_bl_head(POST_ARGS) { - int i; - const struct mdoc_node *n; + int i; + struct mdoc_node *n; + assert(mdoc->last->parent); n = mdoc->last->parent; - assert(n->args); - for (i = 0; i < (int)n->args->argc; i++) - if (n->args->argv[i].arg == MDOC_Column) - break; + if (LIST_column == n->data.list) { + for (i = 0; i < (int)n->args->argc; i++) + if (MDOC_Column == n->args->argv[i].arg) + break; + assert(i < (int)n->args->argc); - if (i == (int)n->args->argc) + if (n->args->argv[i].sz && mdoc->last->nchild) { + mdoc_nmsg(mdoc, n, MANDOCERR_COLUMNS); + return(0); + } return(1); + } - if (n->args->argv[i].sz && mdoc->last->child) - return(mdoc_nerr(mdoc, n, ECOLMIS)); - - return(1); + if (0 == (i = mdoc->last->nchild)) + return(1); + return(warn_count(mdoc, "==", 0, "line arguments", i)); } @@ -1085,14 +1103,20 @@ post_bl(POST_ARGS) if (NULL == mdoc->last->child) return(1); + /* + * We only allow certain children of `Bl'. This is usually on + * `It', but apparently `Sm' occurs here and there, so we let + * that one through, too. + */ + /* LINTED */ for (n = mdoc->last->child; n; n = n->next) { - if (MDOC_BLOCK == n->type) - if (MDOC_It == n->tok) - continue; - return(mdoc_verr(mdoc, n->line, n->pos, - "bad child of parent %s", - mdoc_macronames[mdoc->last->tok])); + if (MDOC_BLOCK == n->type && MDOC_It == n->tok) + continue; + if (MDOC_Sm == n->tok) + continue; + mdoc_nmsg(mdoc, n, MANDOCERR_SYNTCHILD); + return(0); } return(1); @@ -1117,7 +1141,7 @@ ebool(struct mdoc *mdoc) if (NULL == n) return(1); - return(mdoc_nerr(mdoc, n, EBOOL)); + return(mdoc_nmsg(mdoc, n, MANDOCERR_BADBOOL)); } @@ -1126,57 +1150,74 @@ post_root(POST_ARGS) { if (NULL == mdoc->first->child) - return(mdoc_nerr(mdoc, mdoc->first, ENODAT)); - if ( ! (MDOC_PBODY & mdoc->flags)) - return(mdoc_nerr(mdoc, mdoc->first, ENOPROLOGUE)); + mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY); + else if ( ! (MDOC_PBODY & mdoc->flags)) + mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCPROLOG); + else if (MDOC_BLOCK != mdoc->first->child->type) + mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY); + else if (MDOC_Sh != mdoc->first->child->tok) + mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCBODY); + else + return(1); - if (MDOC_BLOCK != mdoc->first->child->type) - return(mdoc_nerr(mdoc, mdoc->first, ENODAT)); - if (MDOC_Sh != mdoc->first->child->tok) - return(mdoc_nerr(mdoc, mdoc->first, ENODAT)); - - return(1); + return(0); } static int -post_sp(POST_ARGS) +post_st(POST_ARGS) { - long lval; - char *ep, *buf; - if (NULL == mdoc->last->child) + if (mdoc_a2st(mdoc->last->child->string)) return(1); - else if ( ! eerr_eq1(mdoc)) - return(0); - - assert(MDOC_TEXT == mdoc->last->child->type); - buf = mdoc->last->child->string; - assert(buf); - - /* From OpenBSD's strtol(3). */ - errno = 0; - lval = strtol(buf, &ep, 10); - if (buf[0] == '\0' || *ep != '\0') - return(mdoc_nerr(mdoc, mdoc->last->child, ENUMFMT)); - - if ((errno == ERANGE && (lval == LONG_MAX || lval == LONG_MIN)) || - (lval > INT_MAX || lval < 0)) - return(mdoc_nerr(mdoc, mdoc->last->child, ENUMFMT)); - - return(1); + return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADSTANDARD)); } - - static int -post_st(POST_ARGS) +post_rs(POST_ARGS) { + struct mdoc_node *nn; - if (mdoc_a2st(mdoc->last->child->string)) + if (MDOC_BODY != mdoc->last->type) return(1); - return(mdoc_nerr(mdoc, mdoc->last, EBADSTAND)); + + for (nn = mdoc->last->child; nn; nn = nn->next) + switch (nn->tok) { + case(MDOC__U): + /* FALLTHROUGH */ + case(MDOC__Q): + /* FALLTHROUGH */ + case(MDOC__C): + /* FALLTHROUGH */ + case(MDOC__A): + /* FALLTHROUGH */ + case(MDOC__B): + /* FALLTHROUGH */ + case(MDOC__D): + /* FALLTHROUGH */ + case(MDOC__I): + /* FALLTHROUGH */ + case(MDOC__J): + /* FALLTHROUGH */ + case(MDOC__N): + /* FALLTHROUGH */ + case(MDOC__O): + /* FALLTHROUGH */ + case(MDOC__P): + /* FALLTHROUGH */ + case(MDOC__R): + /* FALLTHROUGH */ + case(MDOC__T): + /* FALLTHROUGH */ + case(MDOC__V): + break; + default: + mdoc_nmsg(mdoc, nn, MANDOCERR_SYNTCHILD); + return(0); + } + + return(1); } @@ -1208,27 +1249,28 @@ post_sh_body(POST_ARGS) */ if (NULL == (n = mdoc->last->child)) - return(mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC)); + return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC)); 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, mdoc->last, ENAMESECINC)) + if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC)) return(0); } + assert(n); if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok) return(1); - return(mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC)); + return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC)); } static int post_sh_head(POST_ARGS) { - char buf[64]; + char buf[BUFSIZ]; enum mdoc_sec sec; const struct mdoc_node *n; @@ -1239,21 +1281,30 @@ post_sh_head(POST_ARGS) * certain manual sections. */ - buf[0] = 0; + buf[0] = '\0'; + /* + * FIXME: yes, these can use a dynamic buffer, but I don't do so + * in the interests of simplicity. + */ + for (n = mdoc->last->child; n; n = n->next) { /* XXX - copied from compact(). */ assert(MDOC_TEXT == n->type); - if (strlcat(buf, n->string, 64) >= 64) - return(mdoc_nerr(mdoc, n, ETOOLONG)); + if (strlcat(buf, n->string, BUFSIZ) >= BUFSIZ) { + mdoc_nmsg(mdoc, n, MANDOCERR_MEM); + return(0); + } if (NULL == n->next) continue; - if (strlcat(buf, " ", 64) >= 64) - return(mdoc_nerr(mdoc, n, ETOOLONG)); + if (strlcat(buf, " ", BUFSIZ) >= BUFSIZ) { + mdoc_nmsg(mdoc, n, MANDOCERR_MEM); + return(0); + } } - sec = mdoc_atosec(buf); + sec = mdoc_str2sec(buf); /* * Check: NAME should always be first, CUSTOM has no roles, @@ -1261,43 +1312,38 @@ post_sh_head(POST_ARGS) */ if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed) - return(mdoc_nerr(mdoc, mdoc->last, ESECNAME)); + if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NAMESECFIRST)) + return(0); + if (SEC_CUSTOM == sec) return(1); + if (sec == mdoc->lastnamed) - if ( ! mdoc_nwarn(mdoc, mdoc->last, ESECREP)) + if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECREP)) return(0); + if (sec < mdoc->lastnamed) - if ( ! mdoc_nwarn(mdoc, mdoc->last, ESECOOO)) + if ( ! mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECOOO)) return(0); /* * Check particular section/manual conventions. LIBRARY can - * only occur in msec 2, 3 (TODO: are there more of these?). + * only occur in manual section 2, 3, and 9. */ switch (sec) { case (SEC_LIBRARY): - switch (mdoc->meta.msec) { - case (2): - /* FALLTHROUGH */ - case (3): + assert(mdoc->meta.msec); + if (*mdoc->meta.msec == '2') break; - default: - return(mdoc_nwarn(mdoc, mdoc->last, EWRONGMSEC)); - } - break; + if (*mdoc->meta.msec == '3') + break; + if (*mdoc->meta.msec == '9') + break; + return(mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECMSEC)); default: break; } return(1); -} - - -static int -pre_fd(PRE_ARGS) -{ - - return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM)); }