-/* $Id: validate.c,v 1.56 2009/02/24 13:46:54 kristaps Exp $ */
+/* $Id: validate.c,v 1.68 2009/03/05 13:12:12 kristaps Exp $ */
/*
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
*
#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.
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. */
+/* TODO: ignoring Pp (it's superfluous in some invocations). */
struct valids {
v_pre *pre;
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_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);
/* Specific post-child-parse routines. */
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 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_fd(POST_ARGS);
static int post_bl(POST_ARGS);
static int post_it(POST_ARGS);
static int post_ex(POST_ARGS);
static v_post posts_at[] = { post_at, NULL };
static v_post posts_xr[] = { eerr_ge1, eerr_le2, post_xr, NULL };
static v_post posts_nm[] = { post_nm, NULL };
-static v_post posts_bf[] = { herr_le1, post_bf, NULL };
+static v_post posts_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, post_fd, NULL };
/* Per-macro pre- and post-child-check routine collections. */
{ NULL, posts_text }, /* Ev */
{ pres_ex, posts_ex }, /* Ex */
{ NULL, posts_text }, /* Fa */
- { NULL, posts_wtext }, /* Fd */
+ { NULL, posts_fd }, /* Fd */
{ NULL, NULL }, /* Fl */
{ NULL, posts_text }, /* Fn */
{ NULL, posts_wtext }, /* Ft */
};
+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));
+ "suggests %s %s %d (has %d)",
+ v, k, want, has));
}
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));
}
{ \
if (MDOC_HEAD != mdoc->last->type) \
return(1); \
- return(func(mdoc, "multiline parameters", (num))); \
+ return(func(mdoc, "line parameters", (num))); \
}
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(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 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, 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 characters"));
if ('\\' != *p)
continue;
if ((c = mdoc_isescape(p))) {
- p += (c - 1);
+ p += (int)c - 1;
continue;
}
- return(mdoc_perr(mdoc, line, pos,
- "invalid escape sequence"));
+ return(mdoc_perr(mdoc, line, pos,
+ "invalid escape sequence"));
}
return(1);
static int
pre_bl(PRE_ARGS)
{
- int type, err, i;
+ int type, i, width, offset;
struct mdoc_arg *argv;
size_t 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++) {
+ for (i = 0; i < (int)argc; i++) {
argv = &n->data.block.argv[i];
switch (argv->arg) {
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);
}
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));
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;
- }
- if (NULL == n)
- return(1);
+ return(mdoc_nerr(mdoc, n, "bad child of parent %s",
+ mdoc_macronames[mdoc->last->tok]));
+ }
- return(mdoc_nerr(mdoc, n, "bad child of parent list"));
+ return(1);
}
}
-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);
- }
- }
- }
-
- 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
+post_fd(POST_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)
+ if (SEC_SYNOPSIS == mdoc->last->sec)
return(1);
- for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
- if ( ! (*p)(mdoc))
- return(0);
-
- return(1);
+ return(mdoc_warn(mdoc, WARN_COMPAT,
+ "suggested only in section SYNOPSIS"));
}
-
git.ckatri.com / mandoc.git / blobdiff