=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.56 retrieving revision 1.81 diff -u -p -r1.56 -r1.81 --- mandoc/Attic/validate.c 2009/02/24 13:46:54 1.56 +++ mandoc/Attic/validate.c 2009/03/12 06:32:17 1.81 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.56 2009/02/24 13:46:54 kristaps Exp $ */ +/* $Id: validate.c,v 1.81 2009/03/12 06:32:17 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -16,12 +16,18 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ +#include + #include #include +#include #include #include "private.h" +/* FIXME: .Bl -diag can't have non-text children in HEAD. */ +/* TODO: ignoring Pp (it's superfluous in some invocations). */ + /* * Pre- and post-validate macros as they're parsed. Pre-validation * occurs when the macro has been detected and its arguments parsed. @@ -33,14 +39,41 @@ #define PRE_ARGS struct mdoc *mdoc, const struct mdoc_node *n #define POST_ARGS struct mdoc *mdoc +enum merr { + ENODATA, + ENOPROLOGUE, + ELINE, + EATT, + ENAME, + ELISTTYPE, + EDISPTYPE, + EMULTIDISP, + EMULTILIST, + EARGREP, + EBOOL, + ENESTDISP +}; + +enum mwarn { + WWRONGMSEC, + WSECOOO, + WSECREP, + WBADSTAND, + WNAMESECINC, + WNOMULTILINE, + WMULTILINE, + WLINE, + WNOLINE, + WPROLOOO, + WPROLREP, + WARGVAL, + WBADSEC, + WBADMSEC +}; + typedef int (*v_pre)(PRE_ARGS); typedef int (*v_post)(POST_ARGS); -/* FIXME: some sections should only occur in specific msecs. */ -/* FIXME: ignoring Pp. */ -/* FIXME: math symbols. */ -/* FIXME: .Fd only in synopsis section. */ - struct valids { v_pre *pre; v_post *post; @@ -48,92 +81,92 @@ struct valids { /* Utility checks. */ +static int nwarn(struct mdoc *, + const struct mdoc_node *, enum mwarn); +static int nerr(struct mdoc *, + const struct mdoc_node *, enum merr); static int check_parent(PRE_ARGS, int, enum mdoc_type); -static int check_msec(PRE_ARGS, int, enum mdoc_msec *); +static int check_msec(PRE_ARGS, ...); +static int check_sec(PRE_ARGS, ...); static int check_stdarg(PRE_ARGS); - static int check_text(struct mdoc *, - size_t, size_t, const char *); - + int, int, const char *); +static int check_argv(struct mdoc *, + const struct mdoc_node *, + const struct mdoc_argv *); +static int check_args(struct mdoc *, + const struct mdoc_node *); static int err_child_lt(struct mdoc *, const char *, int); +static int warn_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(PRE_ARGS); -static int pre_sh(PRE_ARGS); -static int pre_ss(PRE_ARGS); +static int pre_an(PRE_ARGS); static int pre_bd(PRE_ARGS); static int pre_bl(PRE_ARGS); -static int pre_it(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_rv(PRE_ARGS); -static int pre_an(PRE_ARGS); -static int pre_st(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_prologue(PRE_ARGS); -static int pre_prologue(PRE_ARGS); -static int pre_prologue(PRE_ARGS); - -/* Specific post-child-parse routines. */ - +static int pre_rv(PRE_ARGS); +static int pre_sh(PRE_ARGS); +static int pre_ss(PRE_ARGS); static int herr_ge1(POST_ARGS); -static int herr_le1(POST_ARGS); +static int hwarn_le1(POST_ARGS); static int herr_eq0(POST_ARGS); static int eerr_eq0(POST_ARGS); -static int eerr_le1(POST_ARGS); static int eerr_le2(POST_ARGS); static int eerr_eq1(POST_ARGS); static int eerr_ge1(POST_ARGS); static int ewarn_eq0(POST_ARGS); static int ewarn_eq1(POST_ARGS); static int bwarn_ge1(POST_ARGS); +static int hwarn_eq1(POST_ARGS); static int ewarn_ge1(POST_ARGS); static int ebool(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_bl(POST_ARGS); -static int post_it(POST_ARGS); -static int post_ex(POST_ARGS); static int post_an(POST_ARGS); static int post_at(POST_ARGS); -static int post_xr(POST_ARGS); -static int post_nm(POST_ARGS); static int post_bf(POST_ARGS); +static int post_bl(POST_ARGS); +static int post_ex(POST_ARGS); +static int post_it(POST_ARGS); +static int post_nm(POST_ARGS); static int post_root(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_st(POST_ARGS); -/* 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_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_it[] = { pre_it, NULL }; -static v_pre pres_ss[] = { pre_ss, NULL }; -static v_pre pres_sh[] = { pre_sh, NULL }; static v_pre pres_cd[] = { pre_cd, NULL }; +static v_pre pres_dd[] = { pre_prologue, pre_dd, NULL }; +static v_pre pres_d1[] = { pre_display, NULL }; +static v_pre pres_dt[] = { pre_prologue, 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_it[] = { pre_it, NULL }; +static v_pre pres_lb[] = { pre_lb, NULL }; +static v_pre pres_os[] = { pre_prologue, pre_os, 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 }; - -/* Collections of post-child-parse routines. */ - +static v_pre pres_sh[] = { pre_sh, NULL }; +static v_pre pres_ss[] = { pre_ss, NULL }; 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 }; @@ -146,24 +179,27 @@ 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_lb[] = { eerr_eq1, NULL }; +static v_post posts_mt[] = { eerr_ge1, NULL }; +static v_post posts_st[] = { eerr_eq1, post_st, NULL }; static v_post posts_pp[] = { ewarn_eq0, NULL }; -static v_post posts_ex[] = { eerr_le1, post_ex, NULL }; +static v_post posts_ex[] = { eerr_eq0, 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_xr[] = { eerr_ge1, eerr_le2, NULL }; +static v_post posts_lk[] = { eerr_ge1, NULL }; static v_post posts_nm[] = { post_nm, NULL }; -static v_post posts_bf[] = { herr_le1, post_bf, NULL }; +static v_post posts_bf[] = { hwarn_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_fo[] = { hwarn_eq1, bwarn_ge1, NULL }; static v_post posts_bk[] = { herr_eq0, bwarn_ge1, NULL }; +static v_post posts_fd[] = { ewarn_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 */ + { pres_dd, posts_text }, /* Dd */ + { pres_dt, NULL }, /* Dt */ + { pres_os, NULL }, /* Os */ { pres_sh, posts_sh }, /* Sh */ { pres_ss, posts_ss }, /* Ss */ { NULL, posts_pp }, /* Pp */ @@ -184,7 +220,7 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, posts_text }, /* Ev */ { pres_ex, posts_ex }, /* Ex */ { NULL, posts_text }, /* Fa */ - { NULL, posts_wtext }, /* Fd */ + { pres_fd, posts_fd }, /* Fd */ { NULL, NULL }, /* Fl */ { NULL, posts_text }, /* Fn */ { NULL, posts_wtext }, /* Ft */ @@ -197,7 +233,7 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Ot */ { NULL, NULL }, /* Pa */ { pres_rv, posts_notext }, /* Rv */ - { pres_st, posts_notext }, /* St */ + { NULL, posts_st }, /* St */ { NULL, posts_text }, /* Va */ { NULL, posts_text }, /* Vt */ { NULL, posts_xr }, /* Xr */ @@ -266,17 +302,200 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Hf */ { NULL, NULL }, /* Fr */ { NULL, posts_notext }, /* Ud */ + { pres_lb, posts_lb }, /* Lb */ + { NULL, NULL }, /* Lb */ + { NULL, posts_pp }, /* Pp */ + { NULL, posts_lk }, /* Lk */ + { NULL, posts_mt }, /* Mt */ + { NULL, posts_wline }, /* Brq */ + { NULL, NULL }, /* Bro */ + { NULL, NULL }, /* Brc */ }; +int +mdoc_valid_pre(struct mdoc *mdoc, + const struct mdoc_node *node) +{ + v_pre *p; + int line, pos; + const char *tp; + + if (MDOC_TEXT == node->type) { + tp = node->string; + line = node->line; + pos = node->pos; + return(check_text(mdoc, line, pos, tp)); + } + + if ( ! check_args(mdoc, node)) + return(0); + if (NULL == mdoc_valids[node->tok].pre) + return(1); + for (p = mdoc_valids[node->tok].pre; *p; p++) + if ( ! (*p)(mdoc, node)) + return(0); + return(1); +} + + +int +mdoc_valid_post(struct mdoc *mdoc) +{ + v_post *p; + + /* + * This check occurs after the macro's children have been filled + * in: postfix validation. Since this happens when we're + * rewinding the scope tree, it's possible to have multiple + * invocations (as by design, for now), we set bit MDOC_VALID to + * indicate that we've validated. + */ + + if (MDOC_VALID & mdoc->last->flags) + return(1); + mdoc->last->flags |= MDOC_VALID; + + if (MDOC_TEXT == mdoc->last->type) + return(1); + if (MDOC_ROOT == mdoc->last->type) + return(post_root(mdoc)); + + if (NULL == mdoc_valids[mdoc->last->tok].post) + return(1); + for (p = mdoc_valids[mdoc->last->tok].post; *p; p++) + if ( ! (*p)(mdoc)) + return(0); + + return(1); +} + + +#define merr(m, t) nerr((m), (m)->last, (t)) +static int +nerr(struct mdoc *m, const struct mdoc_node *n, enum merr type) +{ + char *p; + + p = NULL; + + switch (type) { + case (ENESTDISP): + p = "displays may not be nested"; + break; + case (EBOOL): + p = "expected boolean value"; + break; + case (EARGREP): + p = "argument repeated"; + break; + case (EMULTIDISP): + p = "multiple display types specified"; + break; + case (EMULTILIST): + p = "multiple list types specified"; + break; + case (ELISTTYPE): + p = "missing list type"; + break; + case (EDISPTYPE): + p = "missing display type"; + break; + case (ELINE): + p = "expected line arguments"; + break; + case (ENOPROLOGUE): + p = "document has no prologue"; + break; + case (ENODATA): + p = "document has no data"; + break; + case (EATT): + p = "expected valid AT&T symbol"; + break; + case (ENAME): + p = "default name not yet set"; + break; + } + + assert(p); + return(mdoc_nerr(m, n, p)); +} + + +#define mwarn(m, t) nwarn((m), (m)->last, (t)) +static int +nwarn(struct mdoc *m, const struct mdoc_node *n, enum mwarn type) +{ + char *p; + enum mdoc_warn c; + + c = WARN_SYNTAX; + p = NULL; + + switch (type) { + case (WBADMSEC): + p = "inappropriate manual section"; + c = WARN_COMPAT; + break; + case (WBADSEC): + p = "inappropriate document section"; + c = WARN_COMPAT; + break; + case (WARGVAL): + p = "argument value suggested"; + c = WARN_COMPAT; + break; + case (WPROLREP): + p = "prologue macros repeated"; + c = WARN_COMPAT; + break; + case (WPROLOOO): + p = "prologue macros out-of-order"; + c = WARN_COMPAT; + break; + case (WNOLINE): + p = "suggested no line arguments"; + break; + case (WLINE): + p = "suggested line arguments"; + break; + case (WMULTILINE): + p = "suggested multi-line arguments"; + break; + case (WNOMULTILINE): + p = "suggested no multi-line arguments"; + break; + case (WWRONGMSEC): + p = "document section in wrong manual section"; + c = WARN_COMPAT; + break; + case (WSECOOO): + p = "document section out of conventional order"; + break; + case (WSECREP): + p = "document section repeated"; + break; + case (WBADSTAND): + p = "unknown standard"; + break; + case (WNAMESECINC): + p = "NAME section contents incomplete/badly-ordered"; + break; + } + assert(p); + return(mdoc_nwarn(m, n, c, p)); +} + + + 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)); + "suggests %s %s %d (has %d)", v, k, want, has)); } @@ -285,8 +504,8 @@ 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)); + return(mdoc_err(m, + "requires %s %s %d (has %d)", v, k, want, has)); } @@ -325,7 +544,7 @@ b##lvl##_##name(POST_ARGS) \ { \ if (MDOC_BODY != mdoc->last->type) \ return(1); \ - return(func(mdoc, "multiline parameters", (num))); \ + return(func(mdoc, "multi-line arguments", (num))); \ } #define CHECK_ELEM_DEFN(name, lvl, func, num) \ @@ -333,7 +552,7 @@ static int \ e##lvl##_##name(POST_ARGS) \ { \ assert(MDOC_ELEM == mdoc->last->type); \ - return(func(mdoc, "line parameters", (num))); \ + return(func(mdoc, "line arguments", (num))); \ } #define CHECK_HEAD_DEFN(name, lvl, func, num) \ @@ -342,7 +561,7 @@ h##lvl##_##name(POST_ARGS) \ { \ if (MDOC_HEAD != mdoc->last->type) \ return(1); \ - return(func(mdoc, "multiline parameters", (num))); \ + return(func(mdoc, "line arguments", (num))); \ } @@ -351,63 +570,139 @@ 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_CHILD_DEFN(warn, lt, <) /* warn_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(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() */ static int check_stdarg(PRE_ARGS) { - if (MDOC_Std == n->data.elem.argv[0].arg && - 1 == n->data.elem.argc) + if (n->args && 1 == n->args->argc) + if (MDOC_Std == n->args->argv[0].arg) + return(1); + return(nwarn(mdoc, n, WARGVAL)); +} + + +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); + } - return(mdoc_nwarn(mdoc, n, WARN_COMPAT, - "one argument suggested")); + va_end(ap); + return(nwarn(mdoc, n, WBADSEC)); } static int -check_msec(PRE_ARGS, int sz, enum mdoc_msec *msecs) +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(nwarn(mdoc, n, WBADMSEC)); +} + + +static int +check_args(struct mdoc *m, const struct mdoc_node *n) +{ int i; - for (i = 0; i < sz; i++) - if (msecs[i] == mdoc->meta.msec) + if (NULL == n->args) + return(1); + + assert(n->args->argc); + for (i = 0; i < (int)n->args->argc; i++) + if ( ! check_argv(m, n, &n->args->argv[i])) + return(0); + + return(1); +} + + +static int +check_argv(struct mdoc *m, const struct mdoc_node *n, + const struct mdoc_argv *v) +{ + int i; + + for (i = 0; i < (int)v->sz; i++) + if ( ! check_text(m, v->line, v->pos, v->value[i])) + return(0); + + if (MDOC_Std == v->arg && MDOC_Ex == n->tok) { + /* `Nm' name must be set. */ + if (v->sz || m->meta.name) return(1); - return(mdoc_nwarn(mdoc, n, WARN_COMPAT, - "invalid manual section")); + return(nerr(m, n, ENAME)); + } + + return(1); } static int -check_text(struct mdoc *mdoc, size_t line, size_t pos, const char *p) +check_text(struct mdoc *mdoc, int line, int pos, const char *p) { size_t c; + /* XXX - indicate deprecated escapes \*(xx and \*x. */ + for ( ; *p; p++) { - if ( ! isprint(*p) && '\t' != *p) + if ( ! isprint((u_char)*p) && '\t' != *p) return(mdoc_perr(mdoc, line, pos, - "invalid characters")); + "invalid non-printing character")); if ('\\' != *p) continue; if ((c = mdoc_isescape(p))) { - p += (c - 1); + p += (int)c - 1; continue; } - return(mdoc_perr(mdoc, line, pos, + if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags)) + return(mdoc_perr(mdoc, line, pos, "invalid escape sequence")); + if ( ! mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, + "invalid escape sequence")) + return(0); } return(1); @@ -449,29 +744,27 @@ pre_display(PRE_ARGS) if (NULL == node) return(1); - return(mdoc_nerr(mdoc, n, "displays may not be nested")); + return(nerr(mdoc, n, ENESTDISP)); } static int pre_bl(PRE_ARGS) { - int type, err, i; - struct mdoc_arg *argv; - size_t argc; + int i, type, width, offset; if (MDOC_BLOCK != n->type) return(1); + if (NULL == n->args) + return(nerr(mdoc, n, ELISTTYPE)); - argc = n->data.block.argc; - /* Make sure that only one type of list is specified. */ - /* LINTED */ - for (i = 0, type = err = 0; i < (int)argc; i++) { - argv = &n->data.block.argv[i]; + type = offset = width = -1; - switch (argv->arg) { + /* LINTED */ + for (i = 0; i < (int)n->args->argc; i++) + switch (n->args->argv[i].arg) { case (MDOC_Bullet): /* FALLTHROUGH */ case (MDOC_Dash): @@ -493,40 +786,72 @@ pre_bl(PRE_ARGS) case (MDOC_Inset): /* FALLTHROUGH */ case (MDOC_Column): - if (0 == type++) + if (-1 == type) { + type = n->args->argv[i].arg; break; - return(mdoc_perr(mdoc, argv->line, argv->pos, - "multiple types specified")); + } + return(nerr(mdoc, n, EMULTILIST)); + case (MDOC_Width): + if (-1 == width) { + width = n->args->argv[i].arg; + break; + } + return(nerr(mdoc, n, EARGREP)); + case (MDOC_Offset): + if (-1 == offset) { + offset = n->args->argv[i].arg; + break; + } + return(nerr(mdoc, n, EARGREP)); default: break; } + + if (-1 == type) + return(nerr(mdoc, n, ELISTTYPE)); + + switch (type) { + case (MDOC_Column): + /* FALLTHROUGH */ + case (MDOC_Diag): + /* FALLTHROUGH */ + case (MDOC_Inset): + /* FALLTHROUGH */ + case (MDOC_Item): + if (-1 == width) + break; + return(mdoc_nwarn(mdoc, n, WARN_SYNTAX, + "superfluous %s argument", + mdoc_argnames[MDOC_Width])); + case (MDOC_Tag): + if (-1 != width) + break; + return(mdoc_nerr(mdoc, n, "missing %s argument", + mdoc_argnames[MDOC_Width])); + default: + break; } - if (type) - return(1); - return(mdoc_err(mdoc, "no type specified")); + return(1); } static int pre_bd(PRE_ARGS) { - int type, err, i; - struct mdoc_arg *argv; - size_t argc; + int i, type, err; if (MDOC_BLOCK != n->type) return(1); + if (NULL == n->args) + return(nerr(mdoc, n, EDISPTYPE)); - argc = n->data.block.argc; - /* Make sure that only one type of display is specified. */ /* LINTED */ - for (i = 0, err = type = 0; ! err && i < (int)argc; i++) { - argv = &n->data.block.argv[i]; - - switch (argv->arg) { + for (i = 0, err = type = 0; ! err && + i < (int)n->args->argc; i++) + switch (n->args->argv[i].arg) { case (MDOC_Ragged): /* FALLTHROUGH */ case (MDOC_Unfilled): @@ -538,16 +863,14 @@ pre_bd(PRE_ARGS) case (MDOC_File): if (0 == type++) break; - return(mdoc_perr(mdoc, argv->line, argv->pos, - "multiple types specified")); + return(nerr(mdoc, n, EMULTIDISP)); default: break; } - } if (type) return(1); - return(mdoc_err(mdoc, "no type specified")); + return(nerr(mdoc, n, EDISPTYPE)); } @@ -575,9 +898,6 @@ static int pre_it(PRE_ARGS) { - /* TODO: -width attribute must be specified for -tag. */ - /* TODO: children too big for -width? */ - if (MDOC_BLOCK != n->type) return(1); return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY)); @@ -585,31 +905,28 @@ pre_it(PRE_ARGS) static int -pre_st(PRE_ARGS) +pre_an(PRE_ARGS) { - if (1 == n->data.elem.argc) + if (NULL == n->args || 1 == n->args->argc) return(1); - return(mdoc_nerr(mdoc, n, "one argument required")); + return(mdoc_nerr(mdoc, n, "only one argument allowed")); } static int -pre_an(PRE_ARGS) +pre_lb(PRE_ARGS) { - if (1 >= n->data.elem.argc) - return(1); - return(mdoc_nerr(mdoc, n, "one argument allowed")); + return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM)); } static int pre_rv(PRE_ARGS) { - enum mdoc_msec msecs[] = { MSEC_2, MSEC_3 }; - if ( ! check_msec(mdoc, n, 2, msecs)) + if ( ! check_msec(mdoc, n, 2, 3, 0)) return(0); return(check_stdarg(mdoc, n)); } @@ -618,9 +935,8 @@ pre_rv(PRE_ARGS) static int pre_ex(PRE_ARGS) { - enum mdoc_msec msecs[] = { MSEC_1, MSEC_6, MSEC_8 }; - if ( ! check_msec(mdoc, n, 3, msecs)) + if ( ! check_msec(mdoc, n, 1, 6, 8, 0)) return(0); return(check_stdarg(mdoc, n)); } @@ -629,18 +945,16 @@ pre_ex(PRE_ARGS) static int pre_er(PRE_ARGS) { - enum mdoc_msec msecs[] = { MSEC_2 }; - return(check_msec(mdoc, n, 1, msecs)); + return(check_msec(mdoc, n, 2, 0)); } static int pre_cd(PRE_ARGS) { - enum mdoc_msec msecs[] = { MSEC_4 }; - return(check_msec(mdoc, n, 1, msecs)); + return(check_msec(mdoc, n, 4, 0)); } @@ -648,54 +962,53 @@ static int pre_prologue(PRE_ARGS) { - if (SEC_PROLOGUE != mdoc->lastnamed) - return(mdoc_nerr(mdoc, n, "prologue only")); + return(check_sec(mdoc, n, SEC_PROLOGUE, SEC_CUSTOM)); +} - /* Check for ordering. */ - switch (n->tok) { - case (MDOC_Os): - if (mdoc->meta.title && mdoc->meta.date) - break; - return(mdoc_nerr(mdoc, n, "prologue out-of-order")); - case (MDOC_Dt): - if (NULL == mdoc->meta.title && mdoc->meta.date) - break; - return(mdoc_nerr(mdoc, n, "prologue out-of-order")); - case (MDOC_Dd): - if (NULL == mdoc->meta.title && 0 == mdoc->meta.date) - break; - return(mdoc_nerr(mdoc, n, "prologue out-of-order")); - default: - abort(); - /* NOTREACHED */ - } +static int +pre_dt(PRE_ARGS) +{ - /* Check for repetition. */ + if (0 == mdoc->meta.date || mdoc->meta.os) + if ( ! nwarn(mdoc, n, WPROLOOO)) + return(0); + if (mdoc->meta.title) + if ( ! nwarn(mdoc, n, WPROLREP)) + return(0); + return(1); +} - switch (n->tok) { - case (MDOC_Os): - if (NULL == mdoc->meta.os) - return(1); - break; - case (MDOC_Dd): - if (0 == mdoc->meta.date) - return(1); - break; - case (MDOC_Dt): - if (NULL == mdoc->meta.title) - return(1); - break; - default: - abort(); - /* NOTREACHED */ - } - return(mdoc_nerr(mdoc, n, "prologue repetition")); +static int +pre_os(PRE_ARGS) +{ + + if (NULL == mdoc->meta.title || 0 == mdoc->meta.date) + if ( ! nwarn(mdoc, n, WPROLOOO)) + return(0); + if (mdoc->meta.os) + if ( ! nwarn(mdoc, n, WPROLREP)) + return(0); + return(1); } static int +pre_dd(PRE_ARGS) +{ + + if (mdoc->meta.title || mdoc->meta.os) + if ( ! nwarn(mdoc, n, WPROLOOO)) + return(0); + if (mdoc->meta.date) + if ( ! nwarn(mdoc, n, WPROLREP)) + return(0); + return(1); +} + + +static int post_bf(POST_ARGS) { char *p; @@ -704,13 +1017,14 @@ post_bf(POST_ARGS) if (MDOC_BLOCK != mdoc->last->type) return(1); - head = mdoc->last->data.block.head; + head = mdoc->last->head; - if (0 == mdoc->last->data.block.argc) { - if (NULL == head->child) - return(mdoc_err(mdoc, "argument expected")); + if (NULL == mdoc->last->args) { + if (NULL == head->child || + MDOC_TEXT != head->child->type) + return(mdoc_err(mdoc, "text argument expected")); - p = head->child->data.text.string; + p = head->child->string; if (xstrcmp(p, "Em")) return(1); else if (xstrcmp(p, "Li")) @@ -721,11 +1035,9 @@ post_bf(POST_ARGS) } if (head->child) - return(mdoc_err(mdoc, "argument expected")); + return(mdoc_err(mdoc, "one argument expected")); - if (1 == mdoc->last->data.block.argc) - return(1); - return(mdoc_err(mdoc, "argument expected")); + return(1); } @@ -737,32 +1049,21 @@ post_nm(POST_ARGS) return(1); if (mdoc->meta.name) return(1); - return(mdoc_err(mdoc, "not yet invoked with name")); + return(merr(mdoc, ENAME)); } static int -post_xr(POST_ARGS) -{ - struct mdoc_node *n; - - if (NULL == (n = mdoc->last->child->next)) - return(1); - if (MSEC_DEFAULT != mdoc_atomsec(n->data.text.string)) - return(1); - return(mdoc_nerr(mdoc, n, "invalid manual section")); -} - - -static int post_at(POST_ARGS) { if (NULL == mdoc->last->child) return(1); - if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string)) + if (MDOC_TEXT != mdoc->last->child->type) + return(merr(mdoc, EATT)); + if (mdoc_a2att(mdoc->last->child->string)) return(1); - return(mdoc_err(mdoc, "require valid symbol")); + return(merr(mdoc, EATT)); } @@ -770,15 +1071,15 @@ static int post_an(POST_ARGS) { - if (0 != mdoc->last->data.elem.argc) { + if (mdoc->last->args) { if (NULL == mdoc->last->child) return(1); - return(mdoc_err(mdoc, "argument(s) expected")); + return(merr(mdoc, ELINE)); } if (mdoc->last->child) return(1); - return(mdoc_err(mdoc, "argument(s) expected")); + return(merr(mdoc, ELINE)); } @@ -786,47 +1087,31 @@ static int post_ex(POST_ARGS) { - if (0 == mdoc->last->data.elem.argc) { - if (mdoc->last->child) - return(1); - return(mdoc_err(mdoc, "argument(s) expected")); - } - if (mdoc->last->child) - return(mdoc_err(mdoc, "argument(s) expected")); - if (1 != mdoc->last->data.elem.argc) - return(mdoc_err(mdoc, "argument(s) expected")); - if (MDOC_Std != mdoc->last->data.elem.argv[0].arg) - return(mdoc_err(mdoc, "argument(s) expected")); - - return(1); + if (mdoc->last->args) + return(1); + return(merr(mdoc, ELINE)); } static int post_it(POST_ARGS) { - int type, sv, i; -#define TYPE_NONE (0) -#define TYPE_BODY (1) -#define TYPE_HEAD (2) -#define TYPE_OHEAD (3) - size_t argc; - struct mdoc_node *n; + int type, i, cols; + struct mdoc_node *n, *c; if (MDOC_BLOCK != mdoc->last->type) return(1); n = mdoc->last->parent->parent; + if (NULL == n->args) + return(merr(mdoc, ELISTTYPE)); - 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 < (int)argc; i++) - switch (n->data.block.argv[i].arg) { + 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): @@ -836,9 +1121,7 @@ post_it(POST_ARGS) case (MDOC_Ohang): /* FALLTHROUGH */ case (MDOC_Inset): - type = TYPE_HEAD; - sv = n->data.block.argv[i].arg; - break; + /* FALLTHROUGH */ case (MDOC_Bullet): /* FALLTHROUGH */ case (MDOC_Dash): @@ -848,74 +1131,74 @@ post_it(POST_ARGS) case (MDOC_Hyphen): /* FALLTHROUGH */ case (MDOC_Item): - type = TYPE_BODY; - sv = n->data.block.argv[i].arg; + type = n->args->argv[i].arg; break; case (MDOC_Column): - type = TYPE_OHEAD; - sv = n->data.block.argv[i].arg; + type = n->args->argv[i].arg; + cols = (int)n->args->argv[i].sz; break; default: break; } - assert(TYPE_NONE != type); + if (-1 == type) + return(merr(mdoc, ELISTTYPE)); - n = mdoc->last->data.block.head; - - if (TYPE_HEAD == type) { - if (NULL == n->child) - if ( ! mdoc_warn(mdoc, WARN_SYNTAX, - "argument(s) suggested")) + switch (type) { + case (MDOC_Tag): + if (NULL == mdoc->last->head->child) + if ( ! mwarn(mdoc, WLINE)) return(0); - - n = mdoc->last->data.block.body; - if (NULL == n->child) - if ( ! mdoc_warn(mdoc, WARN_SYNTAX, - "multiline body suggested")) + break; + case (MDOC_Hang): + /* FALLTHROUGH */ + case (MDOC_Ohang): + /* FALLTHROUGH */ + case (MDOC_Inset): + /* FALLTHROUGH */ + case (MDOC_Diag): + if (NULL == mdoc->last->head->child) + if ( ! mwarn(mdoc, WLINE)) return(0); - - } else if (TYPE_BODY == type) { - if (n->child) - if ( ! mdoc_warn(mdoc, WARN_SYNTAX, - "no argument suggested")) + if (NULL == mdoc->last->body->child) + if ( ! mwarn(mdoc, WMULTILINE)) return(0); - - n = mdoc->last->data.block.body; - if (NULL == n->child) - if ( ! mdoc_warn(mdoc, WARN_SYNTAX, - "multiline body suggested")) + break; + case (MDOC_Bullet): + /* FALLTHROUGH */ + case (MDOC_Dash): + /* FALLTHROUGH */ + case (MDOC_Enum): + /* FALLTHROUGH */ + case (MDOC_Hyphen): + /* FALLTHROUGH */ + case (MDOC_Item): + if (mdoc->last->head->child) + if ( ! mwarn(mdoc, WNOLINE)) return(0); - } else { - if (NULL == n->child) - if ( ! mdoc_warn(mdoc, WARN_SYNTAX, - "argument(s) suggested")) + if (NULL == mdoc->last->body->child) + if ( ! mwarn(mdoc, WMULTILINE)) return(0); - - n = mdoc->last->data.block.body; - if (n->child) - if ( ! mdoc_warn(mdoc, WARN_SYNTAX, - "no multiline body suggested")) + break; + case (MDOC_Column): + if (NULL == mdoc->last->head->child) + if ( ! mwarn(mdoc, WLINE)) return(0); + if (mdoc->last->body->child) + if ( ! mwarn(mdoc, WNOMULTILINE)) + return(0); + c = mdoc->last->child; + for (i = 0; c && MDOC_HEAD == c->type; c = c->next) + i++; + if (i == cols) + break; + return(mdoc_err(mdoc, "column mismatch (have " + "%d, want %d)", i, cols)); + default: + break; } - if (MDOC_Column != sv) - return(1); - - 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 == (int)argc) - return(1); - - return(mdoc_err(mdoc, "need %zu columns (have %d)", argc, i)); -#undef TYPE_NONE -#undef TYPE_BODY -#undef TYPE_HEAD -#undef TYPE_OHEAD + return(1); } @@ -926,19 +1209,19 @@ post_bl(POST_ARGS) if (MDOC_BODY != mdoc->last->type) return(1); + if (NULL == mdoc->last->child) + return(1); /* LINTED */ for (n = mdoc->last->child; n; n = n->next) { if (MDOC_BLOCK == n->type) if (MDOC_It == n->tok) continue; - break; + return(mdoc_nerr(mdoc, n, "bad child of parent %s", + mdoc_macronames[mdoc->last->tok])); } - if (NULL == n) - return(1); - - return(mdoc_nerr(mdoc, n, "bad child of parent list")); + return(1); } @@ -951,16 +1234,16 @@ ebool(struct mdoc *mdoc) for (n = mdoc->last->child; n; n = n->next) { if (MDOC_TEXT != n->type) break; - if (xstrcmp(n->data.text.string, "on")) + if (xstrcmp(n->string, "on")) continue; - if (xstrcmp(n->data.text.string, "off")) + if (xstrcmp(n->string, "off")) continue; break; } if (NULL == n) return(1); - return(mdoc_nerr(mdoc, n, "expected boolean")); + return(nerr(mdoc, n, EBOOL)); } @@ -969,22 +1252,30 @@ post_root(POST_ARGS) { if (NULL == mdoc->first->child) - return(mdoc_err(mdoc, "document lacks data")); + return(merr(mdoc, ENODATA)); if (SEC_PROLOGUE == mdoc->lastnamed) - return(mdoc_err(mdoc, "document lacks prologue")); + return(merr(mdoc, ENOPROLOGUE)); if (MDOC_BLOCK != mdoc->first->child->type) - return(mdoc_err(mdoc, "lacking post-prologue %s", - mdoc_macronames[MDOC_Sh])); + return(merr(mdoc, ENODATA)); if (MDOC_Sh != mdoc->first->child->tok) - return(mdoc_err(mdoc, "lacking post-prologue %s", - mdoc_macronames[MDOC_Sh])); + return(merr(mdoc, ENODATA)); return(1); } static int +post_st(POST_ARGS) +{ + + if (mdoc_a2st(mdoc->last->child->string)) + return(1); + return(mwarn(mdoc, WBADSTAND)); +} + + +static int post_sh(POST_ARGS) { @@ -1012,28 +1303,20 @@ post_sh_body(POST_ARGS) */ if (NULL == (n = mdoc->last->child)) - return(mdoc_warn(mdoc, WARN_SYNTAX, - "section should have %s and %s", - mdoc_macronames[MDOC_Nm], - mdoc_macronames[MDOC_Nd])); + return(mwarn(mdoc, WNAMESECINC)); 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_SYNTAX, - "section should have %s first", - mdoc_macronames[MDOC_Nm]))) + if ( ! mwarn(mdoc, WNAMESECINC)) return(0); } if (MDOC_ELEM == n->type && MDOC_Nd == n->tok) return(1); - - return(mdoc_warn(mdoc, WARN_SYNTAX, - "section should have %s last", - mdoc_macronames[MDOC_Nd])); + return(mwarn(mdoc, WNAMESECINC)); } @@ -1043,103 +1326,57 @@ post_sh_head(POST_ARGS) char buf[64]; enum mdoc_sec sec; + /* + * Process a new section. Sections are either "named" or + * "custom"; custom sections are user-defined, while named ones + * usually follow a conventional order and may only appear in + * certain manual sections. + */ + assert(MDOC_Sh == mdoc->last->tok); - if ( ! xstrlcats(buf, mdoc->last->child, sizeof(buf))) - return(mdoc_err(mdoc, "argument too long")); + (void)xstrlcpys(buf, mdoc->last->child, sizeof(buf)); sec = mdoc_atosec(buf); + /* The NAME section should always be first. */ + if (SEC_BODY == mdoc->lastnamed && SEC_NAME != sec) - return(mdoc_warn(mdoc, WARN_SYNTAX, - "section NAME should be first")); + return(mwarn(mdoc, WSECOOO)); if (SEC_CUSTOM == sec) return(1); + + /* Check for repeated or out-of-order sections. */ + if (sec == mdoc->lastnamed) - return(mdoc_warn(mdoc, WARN_SYNTAX, - "section repeated")); + return(mwarn(mdoc, WSECREP)); if (sec < mdoc->lastnamed) - return(mdoc_warn(mdoc, WARN_SYNTAX, - "section out of order")); + return(mwarn(mdoc, WSECOOO)); - return(1); -} + /* Check particular section/manual section conventions. */ - -int -mdoc_valid_pre(struct mdoc *mdoc, - const struct mdoc_node *node) -{ - v_pre *p; - struct mdoc_arg *argv; - size_t argc, i, j, line, pos; - const char *tp; - - if (MDOC_TEXT == node->type) { - tp = node->data.text.string; - line = node->line; - pos = node->pos; - return(check_text(mdoc, line, pos, tp)); - } - - if (MDOC_BLOCK == node->type || MDOC_ELEM == node->type) { - argv = MDOC_BLOCK == node->type ? - node->data.block.argv : - node->data.elem.argv; - argc = MDOC_BLOCK == node->type ? - node->data.block.argc : - node->data.elem.argc; - - for (i = 0; i < argc; i++) { - if (0 == argv[i].sz) - continue; - for (j = 0; j < argv[i].sz; j++) { - tp = argv[i].value[j]; - line = argv[i].line; - pos = argv[i].pos; - if ( ! check_text(mdoc, line, pos, tp)) - return(0); - } + switch (sec) { + case (SEC_LIBRARY): + switch (mdoc->meta.msec) { + case (2): + /* FALLTHROUGH */ + case (3): + break; + default: + return(mwarn(mdoc, WWRONGMSEC)); } + break; + default: + break; } - if (NULL == mdoc_valids[node->tok].pre) - return(1); - for (p = mdoc_valids[node->tok].pre; *p; p++) - if ( ! (*p)(mdoc, node)) - return(0); return(1); } -int -mdoc_valid_post(struct mdoc *mdoc) +static int +pre_fd(PRE_ARGS) { - v_post *p; - /* - * This check occurs after the macro's children have been filled - * in: postfix validation. Since this happens when we're - * rewinding the scope tree, it's possible to have multiple - * invocations (as by design, for now), we set bit MDOC_VALID to - * indicate that we've validated. - */ - - if (MDOC_VALID & mdoc->last->flags) - return(1); - mdoc->last->flags |= MDOC_VALID; - - if (MDOC_TEXT == mdoc->last->type) - return(1); - if (MDOC_ROOT == mdoc->last->type) - return(post_root(mdoc)); - - if (NULL == mdoc_valids[mdoc->last->tok].post) - return(1); - for (p = mdoc_valids[mdoc->last->tok].post; *p; p++) - if ( ! (*p)(mdoc)) - return(0); - - return(1); + return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM)); } -