-/* $Id: validate.c,v 1.3 2008/11/30 12:41:45 kristaps Exp $ */
+/* $Id: validate.c,v 1.52 2009/02/22 19:23:48 kristaps Exp $ */
/*
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
*
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
-#include <sys/param.h>
-
#include <assert.h>
-#include <ctype.h>
-#include <err.h>
-#include <stdio.h>
#include <stdlib.h>
-#include <string.h>
-#include "libmdocml.h"
#include "private.h"
-#define INDENT 4
+/*
+ * Pre- and post-validate macros as they're parsed. Pre-validation
+ * occurs when the macro has been detected and its arguments parsed.
+ * Post-validation occurs when all child macros have also been parsed.
+ * In the ELEMENT case, this is simply the parameters of the macro; in
+ * the BLOCK case, this is the HEAD, BODY, TAIL and so on.
+ */
-#ifdef __linux__ /* FIXME */
-#define strlcat strncat
-#endif
+typedef int (*v_pre)(struct mdoc *, struct mdoc_node *);
+typedef int (*v_post)(struct mdoc *);
-struct md_valid {
- const struct md_args *args;
- const struct md_rbuf *rbuf;
- struct md_mbuf *mbuf;
- struct rofftree *tree;
+/* FIXME: some sections should only occur in specific msecs. */
+/* FIXME: ignoring Pp. */
+/* FIXME: .Ef arguments */
+/* FIXME: math symbols. */
+/* FIXME: valid character-escape checks. */
+/* FIXME: .Fd only in synopsis section. */
- size_t indent;
- size_t pos;
+struct valids {
+ v_pre *pre;
+ v_post *post;
+};
- int flags;
-#define MD_LITERAL (1 << 0)
+/* 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 err_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(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 *);
+
+/* 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 *);
+
+/* 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_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_er[] = { pre_er, NULL };
+static v_pre pres_ex[] = { pre_ex, 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_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 };
+static v_post posts_wtext[] = { ewarn_ge1, NULL };
+static v_post posts_notext[] = { eerr_eq0, NULL };
+static v_post posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
+static v_post posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
+static v_post posts_bl[] = { herr_eq0, bwarn_ge1, post_bl, NULL };
+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_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_nm[] = { post_nm, NULL };
+static v_post posts_bf[] = { herr_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_bk[] = { herr_eq0, bwarn_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_sh, posts_sh }, /* Sh */
+ { pres_ss, posts_ss }, /* Ss */
+ { NULL, posts_pp }, /* Pp */
+ { pres_d1, posts_wline }, /* D1 */
+ { pres_d1, posts_wline }, /* Dl */
+ { pres_bd, posts_bd }, /* Bd */
+ { NULL, NULL }, /* Ed */
+ { pres_bl, posts_bl }, /* Bl */
+ { NULL, NULL }, /* El */
+ { pres_it, posts_it }, /* It */
+ { NULL, posts_text }, /* Ad */
+ { pres_an, posts_an }, /* An */
+ { NULL, NULL }, /* Ar */
+ { pres_cd, posts_text }, /* Cd */
+ { NULL, NULL }, /* Cm */
+ { NULL, posts_text }, /* Dv */
+ { pres_er, posts_text }, /* Er */
+ { NULL, posts_text }, /* Ev */
+ { pres_ex, posts_ex }, /* Ex */
+ { NULL, posts_text }, /* Fa */
+ { NULL, posts_wtext }, /* Fd */
+ { NULL, NULL }, /* Fl */
+ { NULL, posts_text }, /* Fn */
+ { NULL, posts_wtext }, /* Ft */
+ { NULL, posts_text }, /* Ic */
+ { NULL, posts_in }, /* In */
+ { NULL, posts_text }, /* Li */
+ { NULL, posts_wtext }, /* Nd */
+ { NULL, posts_nm }, /* Nm */
+ { NULL, posts_wline }, /* Op */
+ { NULL, NULL }, /* Ot */
+ { NULL, NULL }, /* Pa */
+ { pres_rv, posts_notext }, /* Rv */
+ { pres_st, posts_notext }, /* St */
+ { NULL, posts_text }, /* Va */
+ { NULL, posts_text }, /* Vt */
+ { NULL, posts_xr }, /* Xr */
+ { NULL, posts_text }, /* %A */
+ { NULL, posts_text }, /* %B */
+ { NULL, posts_text }, /* %D */
+ { NULL, posts_text }, /* %I */
+ { NULL, posts_text }, /* %J */
+ { NULL, posts_text }, /* %N */
+ { NULL, posts_text }, /* %O */
+ { NULL, posts_text }, /* %P */
+ { NULL, posts_text }, /* %R */
+ { NULL, posts_text }, /* %T */
+ { NULL, posts_text }, /* %V */
+ { NULL, NULL }, /* Ac */
+ { NULL, NULL }, /* Ao */
+ { NULL, posts_wline }, /* Aq */
+ { NULL, posts_at }, /* At */
+ { NULL, NULL }, /* Bc */
+ { NULL, posts_bf }, /* Bf */
+ { NULL, NULL }, /* Bo */
+ { NULL, posts_wline }, /* Bq */
+ { NULL, NULL }, /* Bsx */
+ { NULL, NULL }, /* Bx */
+ { NULL, posts_bool }, /* Db */
+ { NULL, NULL }, /* Dc */
+ { NULL, NULL }, /* Do */
+ { NULL, posts_wline }, /* Dq */
+ { NULL, NULL }, /* Ec */
+ { NULL, NULL }, /* Ef */
+ { NULL, posts_text }, /* Em */
+ { NULL, NULL }, /* Eo */
+ { NULL, NULL }, /* Fx */
+ { NULL, posts_text }, /* Ms */
+ { NULL, posts_notext }, /* No */
+ { NULL, posts_notext }, /* Ns */
+ { NULL, NULL }, /* Nx */
+ { NULL, NULL }, /* Ox */
+ { NULL, NULL }, /* Pc */
+ { NULL, posts_pf }, /* Pf */
+ { NULL, NULL }, /* Po */
+ { NULL, posts_wline }, /* Pq */
+ { NULL, NULL }, /* Qc */
+ { NULL, posts_wline }, /* Ql */
+ { NULL, NULL }, /* Qo */
+ { NULL, posts_wline }, /* Qq */
+ { NULL, NULL }, /* Re */
+ { NULL, posts_rs }, /* Rs */
+ { NULL, NULL }, /* Sc */
+ { NULL, NULL }, /* So */
+ { NULL, posts_wline }, /* Sq */
+ { NULL, posts_bool }, /* Sm */
+ { NULL, posts_text }, /* Sx */
+ { NULL, posts_text }, /* Sy */
+ { NULL, posts_text }, /* Tn */
+ { NULL, NULL }, /* Ux */
+ { NULL, NULL }, /* Xc */
+ { NULL, NULL }, /* Xo */
+ { NULL, posts_fo }, /* Fo */
+ { NULL, NULL }, /* Fc */
+ { NULL, NULL }, /* Oo */
+ { NULL, NULL }, /* Oc */
+ { NULL, posts_bk }, /* Bk */
+ { NULL, NULL }, /* Ek */
+ { NULL, posts_notext }, /* Bt */
+ { NULL, NULL }, /* Hf */
+ { NULL, NULL }, /* Fr */
+ { NULL, posts_notext }, /* Ud */
};
-static void roffmsg(void *arg, enum roffmsg,
- const char *, const char *, char *);
-static int roffhead(void *);
-static int rofftail(void *);
-static int roffin(void *, int, int *, char **);
-static int roffdata(void *, char *);
-static int roffout(void *, int);
-static int roffblkin(void *, int, int *, char **);
-static int roffblkout(void *, int);
-static int roffspecial(void *, int);
-static int mbuf_newline(struct md_valid *);
-static int mbuf_indent(struct md_valid *);
-static int mbuf_data(struct md_valid *, char *);
+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));
+}
+
+
+static inline int
+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));
+}
+
+
+static inline int
+count_child(struct mdoc *mdoc)
+{
+ int i;
+ struct mdoc_node *n;
+
+ for (i = 0, n = mdoc->last->child; n; n = n->next, i++)
+ /* Do nothing */ ;
+ return(i);
+}
static int
-mbuf_indent(struct md_valid *p)
+warn_child_gt(struct mdoc *mdoc, const char *p, int sz)
{
- size_t i;
+ int i;
- assert(p->pos == 0);
+ if ((i = count_child(mdoc)) > sz)
+ return(1);
+ return(warn_count(mdoc, ">", sz, p, i));
+}
- for (i = 0; i < MIN(p->indent, INDENT); i++)
- if ( ! md_buf_putstring(p->mbuf, " "))
- return(0);
- p->pos += i * INDENT;
- return(1);
+static int
+err_child_gt(struct mdoc *mdoc, const char *p, int sz)
+{
+ int i;
+
+ if ((i = count_child(mdoc)) > sz)
+ return(1);
+ return(err_count(mdoc, ">", sz, p, i));
}
static int
-mbuf_newline(struct md_valid *p)
+warn_child_eq(struct mdoc *mdoc, const char *p, int sz)
{
+ int i;
- if ( ! md_buf_putchar(p->mbuf, '\n'))
- return(0);
+ if ((i = count_child(mdoc)) == sz)
+ return(1);
+ return(warn_count(mdoc, "==", sz, p, i));
+}
- p->pos = 0;
- return(1);
+
+static int
+err_child_eq(struct mdoc *mdoc, const char *p, int sz)
+{
+ int i;
+
+ if ((i = count_child(mdoc)) == sz)
+ return(1);
+ return(err_count(mdoc, "==", sz, p, i));
}
static int
-mbuf_data(struct md_valid *p, char *buf)
+err_child_lt(struct mdoc *mdoc, const char *p, int sz)
{
- int space;
- size_t sz;
- char *bufp;
+ int i;
- space = 1; /* FIXME */
+ if ((i = count_child(mdoc)) < sz)
+ return(1);
+ return(err_count(mdoc, "<", sz, p, i));
+}
- assert(p->mbuf);
- assert(0 != p->indent);
- if (MD_LITERAL & p->flags)
- return(md_buf_putstring(p->mbuf, buf));
+static int
+check_stdarg(struct mdoc *mdoc, struct mdoc_node *node)
+{
- while (*buf) {
- while (*buf && isspace(*buf))
- buf++;
+ if (MDOC_Std == node->data.elem.argv[0].arg &&
+ 1 == node->data.elem.argc)
+ return(1);
- if (0 == *buf)
- break;
+ return(mdoc_nwarn(mdoc, node, WARN_COMPAT,
+ "macro suggests single `%s' argument",
+ mdoc_argnames[MDOC_Std]));
+}
- bufp = buf;
- while (*buf && ! isspace(*buf))
- buf++;
- if (0 != *buf)
- *buf++ = 0;
+static int
+check_msec(struct mdoc *mdoc, struct mdoc_node *node,
+ int sz, enum mdoc_msec *msecs)
+{
+ int i;
- /* Process word. */
+ for (i = 0; i < sz; i++)
+ if (msecs[i] == mdoc->meta.msec)
+ return(1);
+ return(mdoc_nwarn(mdoc, node, WARN_COMPAT, "macro not "
+ "appropriate for manual section"));
+}
- sz = strlen(bufp);
- if (0 == p->pos) {
- if ( ! mbuf_indent(p))
- return(0);
- if ( ! md_buf_putstring(p->mbuf, bufp))
- return(0);
+static int
+check_parent(struct mdoc *mdoc, struct mdoc_node *n,
+ int tok, enum mdoc_type t)
+{
- if (p->indent * INDENT + sz >= 72) {
- if ( ! mbuf_newline(p))
- return(0);
- continue;
- }
+ assert(n->parent);
+ if ((MDOC_ROOT == t || tok == n->parent->tok) &&
+ (t == n->parent->type))
+ return(1);
- p->pos += sz;
- continue;
- }
+ return(mdoc_nerr(mdoc, n, "require parent %s (have %s)",
+ MDOC_ROOT == t ? "<root>" :
+ mdoc_macronames[tok],
+ MDOC_ROOT == n->parent->type ? "<root>" :
+ mdoc_macronames[n->parent->type]));
+}
- if (sz + p->pos >= 72) {
- if ( ! mbuf_newline(p))
- return(0);
- if ( ! mbuf_indent(p))
- return(0);
- } else if (space)
- if ( ! md_buf_putchar(p->mbuf, ' '))
- return(0);
- if ( ! md_buf_putstring(p->mbuf, bufp))
- return(0);
+static int
+bwarn_ge1(struct mdoc *mdoc)
+{
- p->pos += sz + (space ? 1 : 0);
- }
+ if (MDOC_BODY != mdoc->last->type)
+ return(1);
+ return(warn_child_gt(mdoc, "multi-line parameters", 0));
+}
- return(1);
+
+static int
+ewarn_eq1(struct mdoc *mdoc)
+{
+
+ assert(MDOC_ELEM == mdoc->last->type);
+ return(warn_child_eq(mdoc, "line parameters", 1));
}
-int
-md_line_valid(void *arg, char *buf)
+static int
+ewarn_eq0(struct mdoc *mdoc)
{
- struct md_valid *p;
- p = (struct md_valid *)arg;
- return(roff_engine(p->tree, buf));
+ assert(MDOC_ELEM == mdoc->last->type);
+ return(warn_child_eq(mdoc, "line parameters", 0));
}
-int
-md_exit_valid(void *data, int flush)
+static int
+ewarn_ge1(struct mdoc *mdoc)
+{
+
+ assert(MDOC_ELEM == mdoc->last->type);
+ return(warn_child_gt(mdoc, "line parameters", 0));
+}
+
+
+static int
+eerr_eq1(struct mdoc *mdoc)
+{
+
+ assert(MDOC_ELEM == mdoc->last->type);
+ return(err_child_eq(mdoc, "line parameters", 1));
+}
+
+
+static int
+eerr_le2(struct mdoc *mdoc)
+{
+
+ assert(MDOC_ELEM == mdoc->last->type);
+ return(err_child_lt(mdoc, "line parameters", 3));
+}
+
+
+static int
+eerr_le1(struct mdoc *mdoc)
+{
+
+ assert(MDOC_ELEM == mdoc->last->type);
+ return(err_child_lt(mdoc, "line parameters", 2));
+}
+
+
+static int
+eerr_eq0(struct mdoc *mdoc)
{
- int c;
- struct md_valid *p;
- p = (struct md_valid *)data;
- c = roff_free(p->tree, flush);
- free(p);
+ assert(MDOC_ELEM == mdoc->last->type);
+ return(err_child_eq(mdoc, "line parameters", 0));
+}
+
+
+static int
+eerr_ge1(struct mdoc *mdoc)
+{
- return(c);
+ assert(MDOC_ELEM == mdoc->last->type);
+ return(err_child_gt(mdoc, "line parameters", 0));
}
-void *
-md_init_valid(const struct md_args *args,
- struct md_mbuf *mbuf, const struct md_rbuf *rbuf)
+static int
+herr_eq0(struct mdoc *mdoc)
{
- struct roffcb cb;
- struct md_valid *p;
- cb.roffhead = roffhead;
- cb.rofftail = rofftail;
- cb.roffin = roffin;
- cb.roffout = roffout;
- cb.roffblkin = roffblkin;
- cb.roffblkout = roffblkout;
- cb.roffspecial = roffspecial;
- cb.roffmsg = roffmsg;
- cb.roffdata = roffdata;
+ if (MDOC_HEAD != mdoc->last->type)
+ return(1);
+ return(err_child_eq(mdoc, "line parameters", 0));
+}
- if (NULL == (p = calloc(1, sizeof(struct md_valid))))
- err(1, "malloc");
- p->args = args;
- p->mbuf = mbuf;
- p->rbuf = rbuf;
+static int
+herr_le1(struct mdoc *mdoc)
+{
+ if (MDOC_HEAD != mdoc->last->type)
+ return(1);
+ return(err_child_lt(mdoc, "line parameters", 2));
+}
- assert(mbuf);
- if (NULL == (p->tree = roff_alloc(&cb, p))) {
- free(p);
- return(NULL);
+static int
+herr_ge1(struct mdoc *mdoc)
+{
+
+ if (MDOC_HEAD != mdoc->last->type)
+ return(1);
+ return(err_child_gt(mdoc, "line parameters", 0));
+}
+
+
+static int
+pre_display(struct mdoc *mdoc, struct mdoc_node *node)
+{
+ struct mdoc_node *n;
+
+ if (MDOC_BLOCK != node->type)
+ return(1);
+
+ assert(mdoc->last);
+ /* LINTED */
+ for (n = mdoc->last->parent; n; n = n->parent)
+ if (MDOC_BLOCK == n->type)
+ if (MDOC_Bd == n->tok)
+ break;
+ if (NULL == n)
+ return(1);
+ return(mdoc_nerr(mdoc, node, "displays may not be nested"));
+}
+
+
+static int
+pre_bl(struct mdoc *mdoc, struct mdoc_node *node)
+{
+ int type, err;
+ struct mdoc_arg *argv;
+ size_t i, argc;
+
+ if (MDOC_BLOCK != node->type)
+ return(1);
+ assert(MDOC_Bl == node->tok);
+
+ argv = NULL;
+ argc = node->data.block.argc;
+
+ /* LINTED */
+ for (i = type = err = 0; i < argc; i++) {
+ argv = &node->data.block.argv[(int)i];
+ assert(argv);
+ switch (argv->arg) {
+ case (MDOC_Bullet):
+ /* FALLTHROUGH */
+ case (MDOC_Dash):
+ /* FALLTHROUGH */
+ case (MDOC_Enum):
+ /* FALLTHROUGH */
+ case (MDOC_Hyphen):
+ /* FALLTHROUGH */
+ case (MDOC_Item):
+ /* FALLTHROUGH */
+ case (MDOC_Tag):
+ /* FALLTHROUGH */
+ case (MDOC_Diag):
+ /* FALLTHROUGH */
+ case (MDOC_Hang):
+ /* FALLTHROUGH */
+ case (MDOC_Ohang):
+ /* FALLTHROUGH */
+ case (MDOC_Inset):
+ /* FALLTHROUGH */
+ case (MDOC_Column):
+ if (type)
+ err++;
+ type++;
+ break;
+ default:
+ break;
+ }
}
+ if (0 == type)
+ return(mdoc_err(mdoc, "no list type specified"));
+ if (0 == err)
+ return(1);
+ assert(argv);
+ return(mdoc_perr(mdoc, argv->line,
+ argv->pos, "only one list type possible"));
+}
- return(p);
+
+static int
+pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
+{
+ int type, err;
+ struct mdoc_arg *argv;
+ size_t i, argc;
+
+ if (MDOC_BLOCK != node->type)
+ return(1);
+ assert(MDOC_Bd == node->tok);
+
+ argv = NULL;
+ argc = node->data.block.argc;
+
+ /* LINTED */
+ for (err = i = type = 0; 0 == err && i < argc; i++) {
+ argv = &node->data.block.argv[(int)i];
+ assert(argv);
+ switch (argv->arg) {
+ case (MDOC_Ragged):
+ /* FALLTHROUGH */
+ case (MDOC_Unfilled):
+ /* FALLTHROUGH */
+ case (MDOC_Filled):
+ /* FALLTHROUGH */
+ case (MDOC_Literal):
+ /* FALLTHROUGH */
+ case (MDOC_File):
+ if (type)
+ err++;
+ type++;
+ break;
+ default:
+ break;
+ }
+ }
+ if (0 == type)
+ return(mdoc_err(mdoc, "no display type specified"));
+ if (0 == err)
+ return(1);
+ assert(argv);
+ return(mdoc_perr(mdoc, argv->line,
+ argv->pos, "only one display type possible"));
}
-/* ARGSUSED */
static int
-roffhead(void *arg)
+pre_ss(struct mdoc *mdoc, struct mdoc_node *node)
{
- struct md_valid *p;
- assert(arg);
- p = (struct md_valid *)arg;
+ if (MDOC_BLOCK != node->type)
+ return(1);
+ return(check_parent(mdoc, node, MDOC_Sh, MDOC_BODY));
+}
- if ( ! md_buf_putstring(p->mbuf, "BEGIN"))
- return(0);
- p->indent++;
- if ( ! mbuf_newline(p))
- return(0);
- return(1);
+static int
+pre_sh(struct mdoc *mdoc, struct mdoc_node *node)
+{
+
+ if (MDOC_BLOCK != node->type)
+ return(1);
+ return(check_parent(mdoc, node, -1, MDOC_ROOT));
+}
+
+
+static int
+pre_st(struct mdoc *mdoc, struct mdoc_node *node)
+{
+
+ assert(MDOC_ELEM == node->type);
+ assert(MDOC_St == node->tok);
+ if (1 == node->data.elem.argc)
+ return(1);
+ return(mdoc_nerr(mdoc, node, "macro must have one argument"));
+}
+
+
+static int
+pre_an(struct mdoc *mdoc, struct mdoc_node *node)
+{
+
+ assert(MDOC_ELEM == node->type);
+ assert(MDOC_An == node->tok);
+ if (1 >= node->data.elem.argc)
+ return(1);
+ return(mdoc_nerr(mdoc, node, "macro may only have one argument"));
}
static int
-rofftail(void *arg)
+pre_rv(struct mdoc *mdoc, struct mdoc_node *node)
{
- struct md_valid *p;
+ enum mdoc_msec msecs[2];
- assert(arg);
- p = (struct md_valid *)arg;
+ assert(MDOC_ELEM == node->type);
+ assert(MDOC_Rv == node->tok);
- if (0 != p->pos && ! mbuf_newline(p))
+ msecs[0] = MSEC_2;
+ msecs[1] = MSEC_3;
+ if ( ! check_msec(mdoc, node, 2, msecs))
return(0);
+ return(check_stdarg(mdoc, node));
+}
+
+
+static int
+pre_ex(struct mdoc *mdoc, struct mdoc_node *node)
+{
+ enum mdoc_msec msecs[3];
- if ( ! md_buf_putstring(p->mbuf, "END\n"))
+ assert(MDOC_ELEM == node->type);
+ assert(MDOC_Ex == node->tok);
+
+ msecs[0] = MSEC_1;
+ msecs[1] = MSEC_6;
+ msecs[2] = MSEC_8;
+ if ( ! check_msec(mdoc, node, 3, msecs))
return(0);
- return(1);
+ return(check_stdarg(mdoc, node));
}
static int
-roffspecial(void *arg, int tok)
+pre_er(struct mdoc *mdoc, struct mdoc_node *node)
{
+ enum mdoc_msec msecs[1];
- return(1);
+ msecs[0] = MSEC_2;
+ return(check_msec(mdoc, node, 1, msecs));
}
static int
-roffblkin(void *arg, int tok, int *argc, char **argv)
+pre_cd(struct mdoc *mdoc, struct mdoc_node *node)
{
- struct md_valid *p;
+ enum mdoc_msec msecs[1];
- assert(arg);
- p = (struct md_valid *)arg;
+ msecs[0] = MSEC_4;
+ return(check_msec(mdoc, node, 1, msecs));
+}
- if (0 != p->pos) {
- if ( ! mbuf_newline(p))
- return(0);
- if ( ! mbuf_indent(p))
- return(0);
- } else if ( ! mbuf_indent(p))
- return(0);
- if ( ! md_buf_putchar(p->mbuf, '<'))
- return(0);
- if ( ! md_buf_putstring(p->mbuf, toknames[tok]))
- return(0);
- if ( ! md_buf_putchar(p->mbuf, '>'))
- return(0);
- if ( ! mbuf_newline(p))
- return(0);
+static int
+pre_it(struct mdoc *mdoc, struct mdoc_node *node)
+{
- p->indent++;
- return(1);
+ /* TODO: -width attribute must be specified for -tag. */
+ /* TODO: children too big for -width? */
+
+ if (MDOC_BLOCK != node->type)
+ return(1);
+ return(check_parent(mdoc, node, MDOC_Bl, MDOC_BODY));
}
static int
-roffblkout(void *arg, int tok)
+pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)
{
- struct md_valid *p;
- assert(arg);
- p = (struct md_valid *)arg;
+ if (SEC_PROLOGUE != mdoc->lastnamed)
+ return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue"));
+ assert(MDOC_ELEM == node->type);
- p->indent--;
+ /* Check for ordering. */
- if (0 != p->pos) {
- if ( ! mbuf_newline(p))
- return(0);
- if ( ! mbuf_indent(p))
- return(0);
- } else if ( ! mbuf_indent(p))
- return(0);
+ switch (node->tok) {
+ case (MDOC_Os):
+ if (mdoc->meta.title && mdoc->meta.date)
+ break;
+ return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
+ case (MDOC_Dt):
+ if (NULL == mdoc->meta.title && mdoc->meta.date)
+ break;
+ return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
+ case (MDOC_Dd):
+ if (NULL == mdoc->meta.title && 0 == mdoc->meta.date)
+ break;
+ return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
+ default:
+ abort();
+ /* NOTREACHED */
+ }
- if ( ! md_buf_putstring(p->mbuf, "</"))
- return(0);
- if ( ! md_buf_putstring(p->mbuf, toknames[tok]))
- return(0);
- if ( ! md_buf_putstring(p->mbuf, ">"))
- return(0);
- if ( ! mbuf_newline(p))
- return(0);
+ /* Check for repetition. */
- 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 macro repeated"));
}
static int
-roffin(void *arg, int tok, int *argcp, char **argvp)
+post_bf(struct mdoc *mdoc)
{
- struct md_valid *p;
+ char *p;
+ struct mdoc_node *head;
+
+ if (MDOC_BLOCK != mdoc->last->type)
+ return(1);
+ assert(MDOC_Bf == mdoc->last->tok);
+ head = mdoc->last->data.block.head;
+ assert(head);
+
+ if (0 == mdoc->last->data.block.argc) {
+ if (head->child) {
+ assert(MDOC_TEXT == head->child->type);
+ p = head->child->data.text.string;
+ if (xstrcmp(p, "Em"))
+ return(1);
+ else if (xstrcmp(p, "Li"))
+ return(1);
+ else if (xstrcmp(p, "Sm"))
+ return(1);
+ return(mdoc_nerr(mdoc, head->child, "invalid font mode"));
+ }
+ return(mdoc_err(mdoc, "macro expects an argument or parameter"));
+ }
+ if (head->child)
+ return(mdoc_err(mdoc, "macro expects an argument or parameter"));
+ if (1 == mdoc->last->data.block.argc)
+ return(1);
+ return(mdoc_err(mdoc, "macro expects an argument or parameter"));
+}
- assert(arg);
- p = (struct md_valid *)arg;
- if (0 == p->pos && ! mbuf_indent(p))
- return(0);
+static int
+post_nm(struct mdoc *mdoc)
+{
- if ( ! md_buf_putstring(p->mbuf, " <"))
- return(0);
- if ( ! md_buf_putstring(p->mbuf, toknames[tok]))
- return(0);
- if ( ! md_buf_putstring(p->mbuf, ">"))
- return(0);
+ assert(MDOC_ELEM == mdoc->last->type);
+ assert(MDOC_Nm == mdoc->last->tok);
+ if (mdoc->last->child)
+ return(1);
+ if (mdoc->meta.name)
+ return(1);
+ return(mdoc_err(mdoc, "macro `%s' has not been invoked with a name",
+ mdoc_macronames[MDOC_Nm]));
+}
- p->pos += strlen(toknames[tok]) + 3;
- return(1);
+static int
+post_xr(struct mdoc *mdoc)
+{
+ struct mdoc_node *n;
+
+ assert(MDOC_ELEM == mdoc->last->type);
+ assert(MDOC_Xr == mdoc->last->tok);
+ assert(mdoc->last->child);
+ assert(MDOC_TEXT == mdoc->last->child->type);
+
+ if (NULL == (n = mdoc->last->child->next))
+ return(1);
+ assert(MDOC_TEXT == n->type);
+ if (MSEC_DEFAULT != mdoc_atomsec(n->data.text.string))
+ return(1);
+ return(mdoc_nerr(mdoc, n, "invalid manual section"));
}
static int
-roffout(void *arg, int tok)
+post_at(struct mdoc *mdoc)
{
- struct md_valid *p;
- assert(arg);
- p = (struct md_valid *)arg;
+ assert(MDOC_ELEM == mdoc->last->type);
+ assert(MDOC_At == mdoc->last->tok);
- if (0 == p->pos && ! mbuf_indent(p))
- return(0);
+ if (NULL == mdoc->last->child)
+ return(1);
+ assert(MDOC_TEXT == mdoc->last->child->type);
- if ( ! md_buf_putstring(p->mbuf, "</"))
- return(0);
- if ( ! md_buf_putstring(p->mbuf, toknames[tok]))
- return(0);
- if ( ! md_buf_putstring(p->mbuf, ">"))
- return(0);
+ if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string))
+ return(1);
+ return(mdoc_err(mdoc, "macro expects a valid AT&T version symbol"));
+}
+
+
+static int
+post_an(struct mdoc *mdoc)
+{
+
+ assert(MDOC_ELEM == mdoc->last->type);
+ assert(MDOC_An == mdoc->last->tok);
+
+ if (0 != mdoc->last->data.elem.argc) {
+ if (NULL == mdoc->last->child)
+ return(1);
+ return(mdoc_err(mdoc, "macro expects either argument or parameters"));
+ }
+
+ if (mdoc->last->child)
+ return(1);
+ return(mdoc_err(mdoc, "macro expects either argument or parameters"));
+}
+
+
+static int
+post_ex(struct mdoc *mdoc)
+{
- p->pos += strlen(toknames[tok]) + 2;
+ assert(MDOC_ELEM == mdoc->last->type);
+ assert(MDOC_Ex == mdoc->last->tok);
+ if (0 == mdoc->last->data.elem.argc) {
+ if (mdoc->last->child)
+ return(1);
+ return(mdoc_err(mdoc, "macro expects `%s' or a single child",
+ mdoc_argnames[MDOC_Std]));
+ }
+ if (mdoc->last->child)
+ return(mdoc_err(mdoc, "macro expects `%s' or a single child",
+ mdoc_argnames[MDOC_Std]));
+ if (1 != mdoc->last->data.elem.argc)
+ return(mdoc_err(mdoc, "macro expects `%s' or a single child",
+ mdoc_argnames[MDOC_Std]));
+ if (MDOC_Std != mdoc->last->data.elem.argv[0].arg)
+ return(mdoc_err(mdoc, "macro expects `%s' or a single child",
+ mdoc_argnames[MDOC_Std]));
return(1);
}
+/* Warn if `Bl' type-specific syntax isn't reflected in items. */
+static int
+post_it(struct mdoc *mdoc)
+{
+ int type, sv;
+#define TYPE_NONE (0)
+#define TYPE_BODY (1)
+#define TYPE_HEAD (2)
+#define TYPE_OHEAD (3)
+ size_t i, argc;
+ struct mdoc_node *n;
+
+ if (MDOC_BLOCK != mdoc->last->type)
+ return(1);
+
+ assert(MDOC_It == mdoc->last->tok);
+
+ n = mdoc->last->parent;
+ assert(n);
+ assert(MDOC_Bl == n->tok);
+
+ n = n->parent;
+ assert(MDOC_BLOCK == n->type);
+ assert(MDOC_Bl == n->tok);
+
+ 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 < argc; i++)
+ switch (n->data.block.argv[(int)i].arg) {
+ case (MDOC_Tag):
+ /* FALLTHROUGH */
+ case (MDOC_Diag):
+ /* FALLTHROUGH */
+ case (MDOC_Hang):
+ /* FALLTHROUGH */
+ case (MDOC_Ohang):
+ /* FALLTHROUGH */
+ case (MDOC_Inset):
+ type = TYPE_HEAD;
+ sv = n->data.block.argv[(int)i].arg;
+ break;
+ case (MDOC_Bullet):
+ /* FALLTHROUGH */
+ case (MDOC_Dash):
+ /* FALLTHROUGH */
+ case (MDOC_Enum):
+ /* FALLTHROUGH */
+ case (MDOC_Hyphen):
+ /* FALLTHROUGH */
+ case (MDOC_Item):
+ type = TYPE_BODY;
+ sv = n->data.block.argv[(int)i].arg;
+ break;
+ case (MDOC_Column):
+ type = TYPE_OHEAD;
+ sv = n->data.block.argv[(int)i].arg;
+ break;
+ default:
+ break;
+ }
+
+ assert(TYPE_NONE != type);
-static void
-roffmsg(void *arg, enum roffmsg lvl,
- const char *buf, const char *pos, char *msg)
+ n = mdoc->last->data.block.head;
+ assert(n);
+
+ if (TYPE_HEAD == type) {
+ if (NULL == n->child)
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters"))
+ return(0);
+
+ n = mdoc->last->data.block.body;
+ assert(n);
+ if (NULL == n->child)
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))
+ return(0);
+
+ } else if (TYPE_BODY == type) {
+ if (n->child)
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no line parameters"))
+ return(0);
+
+ n = mdoc->last->data.block.body;
+ assert(n);
+ if (NULL == n->child)
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))
+ return(0);
+ } else {
+ if (NULL == n->child)
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters"))
+ return(0);
+
+ n = mdoc->last->data.block.body;
+ assert(n);
+ if (n->child)
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children"))
+ return(0);
+ }
+
+ if (MDOC_Column != sv)
+ return(1);
+
+ /* Make sure the number of columns is sane. */
+
+ 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 == argc)
+ return(1);
+ return(mdoc_err(mdoc, "expected %zu list columns, have %zu", argc, i));
+#undef TYPE_NONE
+#undef TYPE_BODY
+#undef TYPE_HEAD
+#undef TYPE_OHEAD
+}
+
+
+static int
+post_bl(struct mdoc *mdoc)
{
- char *level;
- struct md_valid *p;
+ struct mdoc_node *n;
- assert(arg);
- p = (struct md_valid *)arg;
+ if (MDOC_BODY != mdoc->last->type)
+ return(1);
+ assert(MDOC_Bl == mdoc->last->tok);
- switch (lvl) {
- case (ROFF_WARN):
- if ( ! (MD_WARN_ALL & p->args->warnings))
- return;
- level = "warning";
+ /* LINTED */
+ for (n = mdoc->last->child; n; n = n->next) {
+ if (MDOC_BLOCK == n->type)
+ if (MDOC_It == n->tok)
+ continue;
break;
- case (ROFF_ERROR):
- level = "error";
+ }
+ if (NULL == n)
+ return(1);
+ return(mdoc_nerr(mdoc, n, "invalid child of parent macro `Bl'"));
+}
+
+
+static int
+ebool(struct mdoc *mdoc)
+{
+ struct mdoc_node *n;
+
+ assert(MDOC_ELEM == mdoc->last->type);
+ /* LINTED */
+ for (n = mdoc->last->child; n; n = n->next) {
+ if (MDOC_TEXT != n->type)
+ break;
+ if (xstrcmp(n->data.text.string, "on"))
+ continue;
+ if (xstrcmp(n->data.text.string, "off"))
+ continue;
break;
- default:
- abort();
}
-
- if (pos)
- (void)fprintf(stderr, "%s:%zu: %s: %s\n",
- p->rbuf->name, p->rbuf->line, level, msg);
- else
- (void)fprintf(stderr, "%s: %s: %s\n",
- p->rbuf->name, level, msg);
+ if (NULL == n)
+ return(1);
+ return(mdoc_nerr(mdoc, n, "expected boolean value"));
+}
+
+
+static int
+post_root(struct mdoc *mdoc)
+{
+
+ if (NULL == mdoc->first->child)
+ return(mdoc_err(mdoc, "document has no data"));
+ if (SEC_PROLOGUE == mdoc->lastnamed)
+ return(mdoc_err(mdoc, "document has incomplete prologue"));
+ if (MDOC_BLOCK != mdoc->first->child->type)
+ return(mdoc_err(mdoc, "document expects `%s' macro after prologue", mdoc_macronames[MDOC_Sh]));
+ if (MDOC_Sh != mdoc->first->child->tok)
+ return(mdoc_err(mdoc, "document expects `%s' macro after prologue", mdoc_macronames[MDOC_Sh]));
+ return(1);
+}
+
+
+static int
+post_sh(struct mdoc *mdoc)
+{
+ if (MDOC_HEAD == mdoc->last->type)
+ return(post_sh_head(mdoc));
+ if (MDOC_BODY == mdoc->last->type)
+ return(post_sh_body(mdoc));
+ return(1);
}
static int
-roffdata(void *arg, char *buf)
+post_sh_body(struct mdoc *mdoc)
+{
+ struct mdoc_node *n;
+
+ assert(MDOC_Sh == mdoc->last->tok);
+ assert(MDOC_BODY == mdoc->last->type);
+ if (SEC_NAME != mdoc->lastnamed)
+ return(1);
+
+ /*
+ * Warn if the NAME section doesn't contain the `Nm' and `Nd'
+ * macros (can have multiple `Nm' and one `Nd'). Note that the
+ * children of the BODY declaration can also be "text".
+ */
+
+ if (NULL == (n = mdoc->last->child))
+ return(mdoc_warn(mdoc, WARN_COMPAT, "section NAME "
+ "should contain %s and %s",
+ mdoc_macronames[MDOC_Nm],
+ mdoc_macronames[MDOC_Nd]));
+
+ 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_COMPAT, "section "
+ "NAME should contain %s as "
+ "initial body child",
+ mdoc_macronames[MDOC_Nm])))
+ return(0);
+ }
+
+ 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",
+ mdoc_macronames[MDOC_Nd]));
+}
+
+
+static int
+post_sh_head(struct mdoc *mdoc)
+{
+ char buf[64];
+ enum mdoc_sec sec;
+
+ assert(MDOC_Sh == mdoc->last->tok);
+
+ if ( ! xstrlcats(buf, mdoc->last->child, 64))
+ return(mdoc_err(mdoc, "macro parameters too long"));
+
+ sec = mdoc_atosec(buf);
+
+ if (SEC_BODY == mdoc->lastnamed && SEC_NAME != sec)
+ return(mdoc_err(mdoc, "section NAME must be first"));
+ if (SEC_CUSTOM == sec)
+ return(1);
+ 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 conventional order"));
+
+ return(1);
+}
+
+
+int
+mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node)
{
- struct md_valid *p;
+ v_pre *p;
+
+ if (MDOC_TEXT == node->type)
+ return(1);
+ assert(MDOC_ROOT != node->type);
- assert(arg);
- p = (struct md_valid *)arg;
- return(mbuf_data(p, buf));
+ 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;
+
+ 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);
+}
+
git.ckatri.com / mandoc.git / blobdiff