-/* $Id: validate.c,v 1.60 2009/02/25 12:32:50 kristaps Exp $ */
+/* $Id: validate.c,v 1.70 2009/03/06 14:24:49 kristaps Exp $ */
/*
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
*
*/
#include <assert.h>
#include <ctype.h>
+#include <stdarg.h>
#include <stdlib.h>
#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. */
+/* TODO: ignoring Pp (it's superfluous in some invocations). */
struct valids {
v_pre *pre;
/* Utility checks. */
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_arg *);
static int err_child_lt(struct mdoc *, const char *, int);
static int warn_child_lt(struct mdoc *, 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_prologue(PRE_ARGS);
-static int pre_prologue(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 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 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 };
+static v_pre pres_sh[] = { pre_sh, NULL };
+static v_pre pres_ss[] = { pre_ss, NULL };
/* Collections of post-child-parse routines. */
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[] = { hwarn_le1, post_bf, NULL };
static v_post posts_rs[] = { herr_eq0, 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 };
+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 */
{ NULL, posts_text }, /* Ev */
{ pres_ex, posts_ex }, /* Ex */
{ NULL, posts_text }, /* Fa */
- { NULL, posts_fd }, /* Fd */
+ { pres_fd, posts_fd }, /* Fd */
{ NULL, NULL }, /* Fl */
{ NULL, posts_text }, /* Fn */
{ NULL, posts_wtext }, /* Ft */
{ 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 */
{ NULL, NULL }, /* Hf */
{ NULL, NULL }, /* Fr */
{ NULL, posts_notext }, /* Ud */
+ { pres_lb, posts_lb }, /* Lb */
};
{
v_pre *p;
struct mdoc_arg *argv;
- size_t argc, i, j, line, pos;
+ size_t argc;
+ int line, pos, i, j;
const char *tp;
if (MDOC_TEXT == 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++) {
+ 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);
}
}
static int
-check_msec(PRE_ARGS, 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);
+ va_start(ap, n);
+
+ for (;;) {
+ 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, WARN_COMPAT,
- "invalid manual section"));
+ "inappropriate document section for macro"));
+}
+
+
+static int
+check_msec(PRE_ARGS, ...)
+{
+ 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, 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((int)*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, 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 = 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));
static int
-pre_st(PRE_ARGS)
+pre_an(PRE_ARGS)
{
- if (1 == n->data.elem.argc)
+ if (1 >= n->data.elem.argc)
return(1);
- return(mdoc_nerr(mdoc, n, "one argument required"));
+ return(mdoc_nerr(mdoc, n, "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));
}
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));
}
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));
}
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 ( ! 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 (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 ( ! 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
+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_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_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"));
}
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);
}
}
+static int
+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)
{
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"));
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"));
if (sec < mdoc->lastnamed)
return(mdoc_warn(mdoc, WARN_SYNTAX,
- "section out of order"));
+ "section out of conventional order"));
+
+ /* 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;
+ }
return(1);
}
static int
-post_fd(POST_ARGS)
+pre_fd(PRE_ARGS)
{
- if (SEC_SYNOPSIS == mdoc->last->sec)
- return(1);
- return(mdoc_warn(mdoc, WARN_COMPAT,
- "suggested only in section SYNOPSIS"));
+ return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM));
}
git.ckatri.com / mandoc.git / blobdiff