=================================================================== RCS file: /cvs/mandoc/Attic/validate.c,v retrieving revision 1.53 retrieving revision 1.69 diff -u -p -r1.53 -r1.69 --- mandoc/Attic/validate.c 2009/02/23 22:51:10 1.53 +++ mandoc/Attic/validate.c 2009/03/06 14:13:47 1.69 @@ -1,4 +1,4 @@ -/* $Id: validate.c,v 1.53 2009/02/23 22:51:10 kristaps Exp $ */ +/* $Id: validate.c,v 1.69 2009/03/06 14:13:47 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -17,10 +17,14 @@ * PERFORMANCE OF THIS SOFTWARE. */ #include +#include +#include #include #include "private.h" +/* FIXME: .Bl -diag can't have non-text children in HEAD. */ + /* * Pre- and post-validate macros as they're parsed. Pre-validation * occurs when the macro has been detected and its arguments parsed. @@ -29,15 +33,14 @@ * 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 *); +#define PRE_ARGS struct mdoc *mdoc, const struct mdoc_node *n +#define POST_ARGS struct mdoc *mdoc -/* FIXME: some sections should only occur in specific msecs. */ -/* FIXME: ignoring Pp. */ -/* FIXME: math symbols. */ -/* FIXME: valid character-escape checks. */ -/* FIXME: .Fd only in synopsis section. */ +typedef int (*v_pre)(PRE_ARGS); +typedef int (*v_post)(POST_ARGS); +/* TODO: ignoring Pp (it's superfluous in some invocations). */ + struct valids { v_pre *pre; v_post *post; @@ -45,12 +48,19 @@ struct valids { /* Utility checks. */ -static int check_parent(struct mdoc *, struct mdoc_node *, - int, enum mdoc_type); -static int check_msec(struct mdoc *, struct mdoc_node *, - int, enum mdoc_msec *); -static int check_stdarg(struct mdoc *, struct mdoc_node *); +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_stdarg(PRE_ARGS); + +static int check_text(struct mdoc *, + int, int, const char *); +static int check_argv(struct mdoc *, + const struct mdoc_node *, + const struct mdoc_arg *); + 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); @@ -66,65 +76,72 @@ static inline int err_count(struct mdoc *, const char /* Specific pre-child-parse routines. */ -static int pre_display(struct mdoc *, struct mdoc_node *); -static int pre_sh(struct mdoc *, struct mdoc_node *); -static int pre_ss(struct mdoc *, struct mdoc_node *); -static int pre_bd(struct mdoc *, struct mdoc_node *); -static int pre_bl(struct mdoc *, struct mdoc_node *); -static int pre_it(struct mdoc *, struct mdoc_node *); -static int pre_cd(struct mdoc *, struct mdoc_node *); -static int pre_er(struct mdoc *, struct mdoc_node *); -static int pre_ex(struct mdoc *, struct mdoc_node *); -static int pre_rv(struct mdoc *, struct mdoc_node *); -static int pre_an(struct mdoc *, struct mdoc_node *); -static int pre_st(struct mdoc *, struct mdoc_node *); -static int pre_prologue(struct mdoc *, struct mdoc_node *); -static int pre_prologue(struct mdoc *, struct mdoc_node *); -static int pre_prologue(struct mdoc *, struct mdoc_node *); +static int 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_prologue(PRE_ARGS); +static int pre_rv(PRE_ARGS); +static int pre_sh(PRE_ARGS); +static int pre_ss(PRE_ARGS); /* Specific post-child-parse routines. */ -static int herr_ge1(struct mdoc *); -static int herr_le1(struct mdoc *); -static int herr_eq0(struct mdoc *); -static int eerr_eq0(struct mdoc *); -static int eerr_le1(struct mdoc *); -static int eerr_le2(struct mdoc *); -static int eerr_eq1(struct mdoc *); -static int eerr_ge1(struct mdoc *); -static int ewarn_eq0(struct mdoc *); -static int ewarn_eq1(struct mdoc *); -static int bwarn_ge1(struct mdoc *); -static int ewarn_ge1(struct mdoc *); -static int ebool(struct mdoc *); -static int post_sh(struct mdoc *); -static int post_sh_body(struct mdoc *); -static int post_sh_head(struct mdoc *); -static int post_bl(struct mdoc *); -static int post_it(struct mdoc *); -static int post_ex(struct mdoc *); -static int post_an(struct mdoc *); -static int post_at(struct mdoc *); -static int post_xr(struct mdoc *); -static int post_nm(struct mdoc *); -static int post_bf(struct mdoc *); -static int post_root(struct mdoc *); +static int herr_ge1(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_an(POST_ARGS); +static int post_at(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 }; +static v_pre pres_sh[] = { pre_sh, NULL }; +static v_pre pres_ss[] = { pre_ss, NULL }; /* Collections of post-child-parse routines. */ @@ -140,24 +157,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_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_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_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 */ @@ -178,7 +198,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 */ @@ -191,7 +211,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 */ @@ -260,16 +280,98 @@ const struct valids mdoc_valids[MDOC_MAX] = { { NULL, NULL }, /* Hf */ { NULL, NULL }, /* Fr */ { NULL, posts_notext }, /* Ud */ + { pres_lb, posts_lb }, /* Lb */ }; +int +mdoc_valid_pre(struct mdoc *mdoc, + const struct mdoc_node *node) +{ + v_pre *p; + struct mdoc_arg *argv; + size_t argc; + int line, pos, i, j; + 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 < (int)argc; i++) { + for (j = 0; j < (int)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); + } + if ( ! check_argv(mdoc, node, &argv[i])) + 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); +} + + + 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)); + return(mdoc_warn(m, WARN_SYNTAX, + "suggests %s %s %d (has %d)", + v, k, want, has)); } @@ -278,8 +380,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)); } @@ -314,7 +416,7 @@ lvl##_child_##name(struct mdoc *mdoc, const char *p, i #define CHECK_BODY_DEFN(name, lvl, func, num) \ static int \ -b##lvl##_##name(struct mdoc *mdoc) \ +b##lvl##_##name(POST_ARGS) \ { \ if (MDOC_BODY != mdoc->last->type) \ return(1); \ @@ -323,7 +425,7 @@ b##lvl##_##name(struct mdoc *mdoc) \ #define CHECK_ELEM_DEFN(name, lvl, func, num) \ static int \ -e##lvl##_##name(struct mdoc *mdoc) \ +e##lvl##_##name(POST_ARGS) \ { \ assert(MDOC_ELEM == mdoc->last->type); \ return(func(mdoc, "line parameters", (num))); \ @@ -331,11 +433,11 @@ e##lvl##_##name(struct mdoc *mdoc) \ #define CHECK_HEAD_DEFN(name, lvl, func, num) \ static int \ -h##lvl##_##name(struct mdoc *mdoc) \ +h##lvl##_##name(POST_ARGS) \ { \ if (MDOC_HEAD != mdoc->last->type) \ return(1); \ - return(func(mdoc, "multiline parameters", (num))); \ + return(func(mdoc, "line parameters", (num))); \ } @@ -344,6 +446,7 @@ 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() */ @@ -354,76 +457,191 @@ 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(struct mdoc *mdoc, struct mdoc_node *node) +check_stdarg(PRE_ARGS) { - if (MDOC_Std == node->data.elem.argv[0].arg && - 1 == node->data.elem.argc) + if (MDOC_Std == n->data.elem.argv[0].arg && + 1 == n->data.elem.argc) return(1); - return(mdoc_nwarn(mdoc, node, WARN_COMPAT, + return(mdoc_nwarn(mdoc, n, WARN_COMPAT, "one argument suggested")); } static int -check_msec(struct mdoc *mdoc, struct mdoc_node *node, - int sz, enum mdoc_msec *msecs) +check_sec(PRE_ARGS, ...) { - int i; + enum mdoc_sec sec; + va_list ap; - for (i = 0; i < sz; i++) - if (msecs[i] == mdoc->meta.msec) - return(1); - return(mdoc_nwarn(mdoc, node, WARN_COMPAT, - "wrong manual section")); + va_start(ap, n); + + for (;;) { + if (SEC_CUSTOM == (sec = va_arg(ap, enum mdoc_sed))) + break; + if (sec != mdoc->lastsec) + continue; + va_end(ap); + return(1); + } + + va_end(ap); + return(mdoc_nwarn(mdoc, n, WARN_COMPAT, + "inappropriate document section for macro")); } static int -pre_display(struct mdoc *mdoc, struct mdoc_node *node) +check_msec(PRE_ARGS, ...) { - struct mdoc_node *n; + va_list ap; + int msec; + va_start(ap, n); + for (;;) { + 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, WARN_COMPAT, + "inappropriate manual section for macro")); +} + + +/* + * Check over an argument. When this has more stuff in it, make this + * into a table-driven function; until then, a switch is fine. + */ +static int +check_argv(struct mdoc *mdoc, + const struct mdoc_node *node, + const struct mdoc_arg *argv) +{ + + + switch (argv->arg) { + case (MDOC_Std): + switch (node->tok) { + case (MDOC_Ex): + /* + * If the -std does not have an argument, then + * set it with the default name (if set). This + * only happens with MDOC_Ex. + */ + if (1 == argv->sz) + return(1); + assert(0 == argv->sz); + if (mdoc->meta.name) + return(1); + return(mdoc_nerr(mdoc, node, + "default name not yet set")); + default: + break; + } + break; + default: + break; + } + + return(1); +} + + +static int +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((u_char)*p) && '\t' != *p) + return(mdoc_perr(mdoc, line, pos, + "invalid non-printing characters")); + if ('\\' != *p) + continue; + if ((c = mdoc_isescape(p))) { + p += (int)c - 1; + continue; + } + return(mdoc_perr(mdoc, line, pos, + "invalid escape sequence")); + } + + return(1); +} + + + + +static int +check_parent(PRE_ARGS, int tok, enum mdoc_type t) +{ + + assert(n->parent); + if ((MDOC_ROOT == t || tok == n->parent->tok) && + (t == n->parent->type)) + return(1); + + return(mdoc_nerr(mdoc, n, "require parent %s", + MDOC_ROOT == t ? "" : mdoc_macronames[tok])); +} + + + +static int +pre_display(PRE_ARGS) +{ + struct mdoc_node *node; + /* Display elements (`Bd', `D1'...) cannot be nested. */ - if (MDOC_BLOCK != node->type) + if (MDOC_BLOCK != n->type) return(1); /* LINTED */ - for (n = mdoc->last->parent; n; n = n->parent) - if (MDOC_BLOCK == n->type) - if (MDOC_Bd == n->tok) + for (node = mdoc->last->parent; node; node = node->parent) + if (MDOC_BLOCK == node->type) + if (MDOC_Bd == node->tok) break; - if (NULL == n) + if (NULL == node) return(1); - return(mdoc_nerr(mdoc, node, "displays may not be nested")); + return(mdoc_nerr(mdoc, n, "displays may not be nested")); } static int -pre_bl(struct mdoc *mdoc, struct mdoc_node *node) +pre_bl(PRE_ARGS) { - int type, err, i; + int type, i, width, offset; struct mdoc_arg *argv; size_t argc; - if (MDOC_BLOCK != node->type) + if (MDOC_BLOCK != n->type) return(1); - argc = node->data.block.argc; + argc = n->data.block.argc; /* Make sure that only one type of list is specified. */ + type = offset = width = -1; + /* LINTED */ - for (i = 0, type = err = 0; i < (int)argc; i++) { - argv = &node->data.block.argv[i]; + for (i = 0; i < (int)argc; i++) { + argv = &n->data.block.argv[i]; switch (argv->arg) { case (MDOC_Bullet): @@ -447,38 +665,80 @@ pre_bl(struct mdoc *mdoc, struct mdoc_node *node) case (MDOC_Inset): /* FALLTHROUGH */ case (MDOC_Column): - if (0 == type++) + if (-1 == type) { + type = argv->arg; break; + } return(mdoc_perr(mdoc, argv->line, argv->pos, "multiple types specified")); + case (MDOC_Width): + if (-1 == width) { + width = argv->arg; + break; + } + return(mdoc_perr(mdoc, argv->line, argv->pos, + "multiple -%s arguments", + mdoc_argnames[MDOC_Width])); + case (MDOC_Offset): + if (-1 == offset) { + offset = argv->arg; + break; + } + return(mdoc_perr(mdoc, argv->line, argv->pos, + "multiple -%s arguments", + mdoc_argnames[MDOC_Offset])); default: break; } } - if (type) - return(1); - return(mdoc_err(mdoc, "no type specified")); + if (-1 == type) + return(mdoc_err(mdoc, "no type specified")); + + 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 && ! mdoc_nwarn(mdoc, n, WARN_SYNTAX, + "suggest -%s argument", + mdoc_argnames[MDOC_Width])) + return(0); + break; + default: + break; + } + + return(1); } static int -pre_bd(struct mdoc *mdoc, struct mdoc_node *node) +pre_bd(PRE_ARGS) { int type, err, i; struct mdoc_arg *argv; size_t argc; - if (MDOC_BLOCK != node->type) + if (MDOC_BLOCK != n->type) return(1); - argc = node->data.block.argc; + 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 = &node->data.block.argv[i]; + argv = &n->data.block.argv[i]; switch (argv->arg) { case (MDOC_Ragged): @@ -506,155 +766,148 @@ pre_bd(struct mdoc *mdoc, struct mdoc_node *node) static int -pre_ss(struct mdoc *mdoc, struct mdoc_node *node) +pre_ss(PRE_ARGS) { - if (MDOC_BLOCK != node->type) + if (MDOC_BLOCK != n->type) return(1); - return(check_parent(mdoc, node, MDOC_Sh, MDOC_BODY)); + return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY)); } static int -pre_sh(struct mdoc *mdoc, struct mdoc_node *node) +pre_sh(PRE_ARGS) { - if (MDOC_BLOCK != node->type) + if (MDOC_BLOCK != n->type) return(1); - return(check_parent(mdoc, node, -1, MDOC_ROOT)); + return(check_parent(mdoc, n, -1, MDOC_ROOT)); } static int -pre_it(struct mdoc *mdoc, struct mdoc_node *node) +pre_it(PRE_ARGS) { - /* TODO: -width attribute must be specified for -tag. */ - /* TODO: children too big for -width? */ - - if (MDOC_BLOCK != node->type) + if (MDOC_BLOCK != n->type) return(1); - return(check_parent(mdoc, node, MDOC_Bl, MDOC_BODY)); + return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY)); } static int -pre_st(struct mdoc *mdoc, struct mdoc_node *node) +pre_an(PRE_ARGS) { - if (1 == node->data.elem.argc) + if (1 >= n->data.elem.argc) return(1); - return(mdoc_nerr(mdoc, node, "one argument required")); + return(mdoc_nerr(mdoc, n, "one argument allowed")); } static int -pre_an(struct mdoc *mdoc, struct mdoc_node *node) +pre_lb(PRE_ARGS) { - if (1 >= node->data.elem.argc) - return(1); - return(mdoc_nerr(mdoc, node, "one argument allowed")); + return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM)); } static int -pre_rv(struct mdoc *mdoc, struct mdoc_node *node) +pre_rv(PRE_ARGS) { - enum mdoc_msec msecs[] = { MSEC_2, MSEC_3 }; - if ( ! check_msec(mdoc, node, 2, msecs)) + if ( ! check_msec(mdoc, n, 2, 3, 0)) return(0); - return(check_stdarg(mdoc, node)); + return(check_stdarg(mdoc, n)); } static int -pre_ex(struct mdoc *mdoc, struct mdoc_node *node) +pre_ex(PRE_ARGS) { - enum mdoc_msec msecs[] = { MSEC_1, MSEC_6, MSEC_8 }; - if ( ! check_msec(mdoc, node, 3, msecs)) + if ( ! check_msec(mdoc, n, 1, 6, 8, 0)) return(0); - return(check_stdarg(mdoc, node)); + return(check_stdarg(mdoc, n)); } static int -pre_er(struct mdoc *mdoc, struct mdoc_node *node) +pre_er(PRE_ARGS) { - enum mdoc_msec msecs[] = { MSEC_2 }; - return(check_msec(mdoc, node, 1, msecs)); + return(check_msec(mdoc, n, 2, 0)); } static int -pre_cd(struct mdoc *mdoc, struct mdoc_node *node) +pre_cd(PRE_ARGS) { - enum mdoc_msec msecs[] = { MSEC_4 }; - return(check_msec(mdoc, node, 1, msecs)); + return(check_msec(mdoc, n, 4, 0)); } static int -pre_prologue(struct mdoc *mdoc, struct mdoc_node *node) +pre_prologue(PRE_ARGS) { - if (SEC_PROLOGUE != mdoc->lastnamed) - return(mdoc_nerr(mdoc, node, "prologue only")); + return(check_sec(mdoc, n, SEC_PROLOGUE, SEC_CUSTOM)); +} - /* Check for ordering. */ - switch (node->tok) { - case (MDOC_Os): - if (mdoc->meta.title && mdoc->meta.date) - break; - 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 out-of-order")); - case (MDOC_Dd): - if (NULL == mdoc->meta.title && 0 == mdoc->meta.date) - break; - return(mdoc_nerr(mdoc, node, - "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 ( ! mdoc_nwarn(mdoc, n, WARN_COMPAT, + "out-of-order prologue")) + return(0); + if (mdoc->meta.title) + if ( ! mdoc_nwarn(mdoc, n, WARN_COMPAT, + "prologue re-invoked")) + return(0); + return(1); +} - switch (node->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, node, "prologue repetition")); +static int +pre_os(PRE_ARGS) +{ + + if (NULL == mdoc->meta.title || 0 == mdoc->meta.date) + if ( ! mdoc_nwarn(mdoc, n, WARN_COMPAT, + "out-of-order prologue")) + return(0); + if (mdoc->meta.os) + if ( ! mdoc_nwarn(mdoc, n, WARN_COMPAT, + "prologue re-invoked")) + return(0); + return(1); } static int -post_bf(struct mdoc *mdoc) +pre_dd(PRE_ARGS) { + + if (mdoc->meta.title || mdoc->meta.os) + if ( ! mdoc_nwarn(mdoc, n, WARN_COMPAT, + "out-of-order prologue")) + return(0); + if (mdoc->meta.date) + if ( ! mdoc_nwarn(mdoc, n, WARN_COMPAT, + "prologue re-invoked")) + return(0); + return(1); +} + + +static int +post_bf(POST_ARGS) +{ char *p; struct mdoc_node *head; @@ -687,7 +940,7 @@ post_bf(struct mdoc *mdoc) static int -post_nm(struct mdoc *mdoc) +post_nm(POST_ARGS) { if (mdoc->last->child) @@ -699,32 +952,19 @@ post_nm(struct mdoc *mdoc) static int -post_xr(struct mdoc *mdoc) +post_at(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(struct mdoc *mdoc) -{ - if (NULL == mdoc->last->child) return(1); - if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string)) + if (mdoc_a2att(mdoc->last->child->data.text.string)) return(1); - return(mdoc_err(mdoc, "require valid symbol")); + return(mdoc_err(mdoc, "require valid AT&T symbol")); } static int -post_an(struct mdoc *mdoc) +post_an(POST_ARGS) { if (0 != mdoc->last->data.elem.argc) { @@ -740,7 +980,7 @@ post_an(struct mdoc *mdoc) static int -post_ex(struct mdoc *mdoc) +post_ex(POST_ARGS) { if (0 == mdoc->last->data.elem.argc) { @@ -760,7 +1000,7 @@ post_ex(struct mdoc *mdoc) static int -post_it(struct mdoc *mdoc) +post_it(POST_ARGS) { int type, sv, i; #define TYPE_NONE (0) @@ -877,25 +1117,31 @@ post_it(struct mdoc *mdoc) static int -post_bl(struct mdoc *mdoc) +post_bl(POST_ARGS) { struct mdoc_node *n; if (MDOC_BODY != mdoc->last->type) return(1); + if (NULL == (mdoc->last->child)) + return(1); + /* + * Only allow `It' macros to be the immediate descendants of the + * `Bl' list. + */ + /* 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); } @@ -922,7 +1168,7 @@ ebool(struct mdoc *mdoc) static int -post_root(struct mdoc *mdoc) +post_root(POST_ARGS) { if (NULL == mdoc->first->child) @@ -931,10 +1177,10 @@ post_root(struct mdoc *mdoc) return(mdoc_err(mdoc, "document lacks prologue")); if (MDOC_BLOCK != mdoc->first->child->type) - return(mdoc_err(mdoc, "lacking post-prologue `%s'", + 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'", + return(mdoc_err(mdoc, "lacking post-prologue %s", mdoc_macronames[MDOC_Sh])); return(1); @@ -942,9 +1188,20 @@ post_root(struct mdoc *mdoc) static int -post_sh(struct mdoc *mdoc) +post_st(POST_ARGS) { + if (mdoc_a2st(mdoc->last->child->data.text.string)) + return(1); + + return(mdoc_warn(mdoc, WARN_SYNTAX, "invalid standard")); +} + + +static int +post_sh(POST_ARGS) +{ + if (MDOC_HEAD == mdoc->last->type) return(post_sh_head(mdoc)); if (MDOC_BODY == mdoc->last->type) @@ -955,7 +1212,7 @@ post_sh(struct mdoc *mdoc) static int -post_sh_body(struct mdoc *mdoc) +post_sh_body(POST_ARGS) { struct mdoc_node *n; @@ -969,8 +1226,8 @@ post_sh_body(struct mdoc *mdoc) */ if (NULL == (n = mdoc->last->child)) - return(mdoc_warn(mdoc, WARN_COMPAT, "section NAME " - "should contain %s and %s", + return(mdoc_warn(mdoc, WARN_SYNTAX, + "section should have %s and %s", mdoc_macronames[MDOC_Nm], mdoc_macronames[MDOC_Nd])); @@ -979,9 +1236,8 @@ post_sh_body(struct mdoc *mdoc) continue; if (MDOC_TEXT == n->type) continue; - if ( ! (mdoc_nwarn(mdoc, n, WARN_COMPAT, "section " - "NAME should contain %s as " - "initial body child", + if ( ! (mdoc_nwarn(mdoc, n, WARN_SYNTAX, + "section should have %s first", mdoc_macronames[MDOC_Nm]))) return(0); } @@ -989,76 +1245,73 @@ post_sh_body(struct mdoc *mdoc) 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", + return(mdoc_warn(mdoc, WARN_SYNTAX, + "section should have %s last", mdoc_macronames[MDOC_Nd])); } static int -post_sh_head(struct mdoc *mdoc) +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, 64)) - return(mdoc_err(mdoc, "macro parameters 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_err(mdoc, "section NAME must be first")); + return(mdoc_warn(mdoc, WARN_SYNTAX, + "section NAME should be first")); 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(mdoc_warn(mdoc, WARN_SYNTAX, + "section repeated")); if (sec < mdoc->lastnamed) - return(mdoc_warn(mdoc, WARN_SYNTAX, "section out of conventional order")); + return(mdoc_warn(mdoc, WARN_SYNTAX, + "section out of conventional order")); - return(1); -} + /* Check particular section/manual section conventions. */ + switch (sec) { + case (SEC_LIBRARY): + switch (mdoc->meta.msec) { + case (2): + /* FALLTHROUGH */ + case (3): + break; + default: + return(mdoc_warn(mdoc, WARN_COMPAT, + "section in wrong manual section")); + } + break; + default: + break; + } -int -mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node) -{ - v_pre *p; - - if (MDOC_TEXT == node->type) - return(1); - assert(MDOC_ROOT != node->type); - - 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; - 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)); } -