-/* $Id: validate.c,v 1.46 2009/01/21 11:35:26 kristaps Exp $ */
+/* $Id: validate.c,v 1.72 2009/03/08 11:48:44 kristaps Exp $ */
/*
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
*
* PERFORMANCE OF THIS SOFTWARE.
*/
#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. */
+/* TODO: ignoring Pp (it's superfluous in some invocations). */
+
/*
* Pre- and post-validate macros as they're parsed. Pre-validation
* occurs when the macro has been detected and its arguments parsed.
* 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
+
+enum merr {
+ ENODATA,
+ ENOPROLOGUE,
+ ELINE,
+ EATT,
+ ENAME,
+ ELISTTYPE,
+ EDISPTYPE,
+ EMULTIDISP,
+ EMULTILIST,
+ EARGREP,
+ EBOOL,
+ ENESTDISP
+};
+
+enum mwarn {
+ WWRONGMSEC,
+ WSECOOO,
+ WSECREP,
+ WBADSTAND,
+ WNAMESECINC,
+ WNOMULTILINE,
+ WMULTILINE,
+ WLINE,
+ WNOLINE,
+ WPROLOOO,
+ WPROLREP,
+ WARGVAL,
+ WBADSEC,
+ WBADMSEC
+};
-/* FIXME: some sections should only occur in specific msecs. */
-/* FIXME: ignoring Pp. */
-/* FIXME: math symbols. */
-/* FIXME: valid character-escape checks. */
-/* FIXME: make sure required sections are included (NAME, ...). */
+typedef int (*v_pre)(PRE_ARGS);
+typedef int (*v_post)(POST_ARGS);
struct valids {
v_pre *pre;
/* Utility checks. */
-static int pre_check_parent(struct mdoc *, struct mdoc_node *,
- int, enum mdoc_type);
-static int pre_check_msecs(struct mdoc *, struct mdoc_node *,
- int, enum mdoc_msec *);
-static int pre_check_stdarg(struct mdoc *, struct mdoc_node *);
-static int post_check_children_count(struct mdoc *);
-static int post_check_children_lt(struct mdoc *, const char *, int);
-static int post_check_children_gt(struct mdoc *, const char *, int);
-static int post_check_children_wgt(struct mdoc *, const char *, int);
-static int post_check_children_eq(struct mdoc *, const char *, int);
-static int post_check_children_weq(struct mdoc *, 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 int nwarn(struct mdoc *,
+ const struct mdoc_node *, enum mwarn);
+static int nerr(struct mdoc *,
+ const struct mdoc_node *, enum merr);
+static int check_parent(PRE_ARGS, int, enum mdoc_type);
+static int check_msec(PRE_ARGS, ...);
+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_argv *);
+static int check_args(struct mdoc *,
+ const struct mdoc_node *);
+static int err_child_lt(struct mdoc *, const char *, int);
+static int warn_child_lt(struct mdoc *, const char *, int);
+static int err_child_gt(struct mdoc *, const char *, int);
+static int warn_child_gt(struct mdoc *, const char *, int);
+static int err_child_eq(struct mdoc *, const char *, int);
+static int warn_child_eq(struct mdoc *, const char *, int);
+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);
+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);
+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_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);
+
+static v_pre pres_an[] = { pre_an, NULL };
static v_pre pres_bd[] = { pre_display, pre_bd, NULL };
static v_pre pres_bl[] = { pre_bl, NULL };
-static v_pre pres_it[] = { pre_it, NULL };
-static v_pre pres_ss[] = { pre_ss, NULL };
-static v_pre pres_sh[] = { pre_sh, NULL };
static v_pre pres_cd[] = { pre_cd, NULL };
+static v_pre pres_dd[] = { pre_prologue, pre_dd, NULL };
+static v_pre pres_d1[] = { pre_display, NULL };
+static v_pre pres_dt[] = { pre_prologue, pre_dt, NULL };
static v_pre pres_er[] = { pre_er, NULL };
static v_pre pres_ex[] = { pre_ex, NULL };
+static v_pre pres_fd[] = { pre_fd, NULL };
+static v_pre pres_it[] = { pre_it, NULL };
+static v_pre pres_lb[] = { pre_lb, NULL };
+static v_pre pres_os[] = { pre_prologue, pre_os, NULL };
static v_pre pres_rv[] = { pre_rv, NULL };
-static v_pre pres_an[] = { pre_an, NULL };
-static v_pre pres_st[] = { pre_st, NULL };
-
-/* Collections of post-child-parse routines. */
-
+static v_pre pres_sh[] = { pre_sh, NULL };
+static v_pre pres_ss[] = { pre_ss, NULL };
static v_post posts_bool[] = { eerr_eq1, ebool, NULL };
static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL };
static v_post posts_text[] = { eerr_ge1, NULL };
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_ex[] = { eerr_eq0, post_ex, NULL };
static v_post posts_an[] = { post_an, NULL };
static v_post posts_at[] = { post_at, NULL };
-static v_post posts_xr[] = { eerr_ge1, eerr_le2, post_xr, NULL };
+static v_post posts_xr[] = { eerr_ge1, eerr_le2, NULL };
static v_post posts_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 };
-
-/* Per-macro pre- and post-child-check routine collections. */
+static v_post posts_fd[] = { ewarn_ge1, NULL };
const struct valids mdoc_valids[MDOC_MAX] = {
- { NULL, NULL }, /* \" */
- { pres_prologue, posts_text }, /* Dd */
- { pres_prologue, NULL }, /* Dt */
- { pres_prologue, NULL }, /* Os */
- /* FIXME: NAME section internal ordering. */
- { 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 */
- /* FIXME: only in SYNOPSIS section. */
- { 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 */ /* -symbolic, etc. */
- { 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, NULL }, /* 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 */
+ { NULL, NULL }, /* \" */
+ { 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 */
+ { 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 */
+ { pres_fd, posts_fd }, /* 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 */
+ { NULL, posts_st }, /* 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 */
+ { pres_lb, posts_lb }, /* Lb */
};
-static int
-post_check_children_count(struct mdoc *mdoc)
+int
+mdoc_valid_pre(struct mdoc *mdoc,
+ const struct mdoc_node *node)
{
- struct mdoc_node *n;
- int i;
+ v_pre *p;
+ int line, pos;
+ const char *tp;
+
+ if (MDOC_TEXT == node->type) {
+ tp = node->string;
+ line = node->line;
+ pos = node->pos;
+ return(check_text(mdoc, line, pos, tp));
+ }
- for (i = 0, n = mdoc->last->child; n; n = n->next, i++)
- /* Do nothing */ ;
- return(i);
+ if ( ! check_args(mdoc, node))
+ return(0);
+ if (NULL == mdoc_valids[node->tok].pre)
+ return(1);
+ for (p = mdoc_valids[node->tok].pre; *p; p++)
+ if ( ! (*p)(mdoc, node))
+ return(0);
+ return(1);
}
-static int
-post_check_children_wgt(struct mdoc *mdoc, const char *p, int sz)
+int
+mdoc_valid_post(struct mdoc *mdoc)
{
- int i;
+ v_post *p;
- if ((i = post_check_children_count(mdoc)) > sz)
- return(1);
- return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests more "
- "than %d %s (has %d)", sz, p, i));
-}
+ /*
+ * 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;
-static int
-post_check_children_gt(struct mdoc *mdoc, const char *p, int sz)
-{
- int i;
+ if (MDOC_TEXT == mdoc->last->type)
+ return(1);
+ if (MDOC_ROOT == mdoc->last->type)
+ return(post_root(mdoc));
- if ((i = post_check_children_count(mdoc)) > sz)
+ if (NULL == mdoc_valids[mdoc->last->tok].post)
return(1);
- return(mdoc_err(mdoc, "macro requires more than %d "
- "%s (has %d)", sz, p, i));
+ for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
+ if ( ! (*p)(mdoc))
+ return(0);
+
+ return(1);
}
+#define merr(m, t) nerr((m), (m)->last, (t))
static int
-post_check_children_weq(struct mdoc *mdoc, const char *p, int sz)
+nerr(struct mdoc *m, const struct mdoc_node *n, enum merr type)
{
- int i;
+ char *p;
+
+ p = NULL;
- if ((i = post_check_children_count(mdoc)) == sz)
- return(1);
- return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests %d "
- "%s (has %d)", sz, p, i));
+ switch (type) {
+ case (ENESTDISP):
+ p = "displays may not be nested";
+ break;
+ case (EBOOL):
+ p = "expected boolean value";
+ break;
+ case (EARGREP):
+ p = "argument repeated";
+ break;
+ case (EMULTIDISP):
+ p = "multiple display types specified";
+ break;
+ case (EMULTILIST):
+ p = "multiple list types specified";
+ break;
+ case (ELISTTYPE):
+ p = "missing list type";
+ break;
+ case (EDISPTYPE):
+ p = "missing display type";
+ break;
+ case (ELINE):
+ p = "expected line arguments";
+ break;
+ case (ENOPROLOGUE):
+ p = "document has no prologue";
+ break;
+ case (ENODATA):
+ p = "document has no data";
+ break;
+ case (EATT):
+ p = "expected valid AT&T symbol";
+ break;
+ case (ENAME):
+ p = "default name not yet set";
+ break;
+ }
+
+ assert(p);
+ return(mdoc_nerr(m, n, p));
}
+#define mwarn(m, t) nwarn((m), (m)->last, (t))
static int
-post_check_children_eq(struct mdoc *mdoc, const char *p, int sz)
+nwarn(struct mdoc *m, const struct mdoc_node *n, enum mwarn type)
{
- int i;
+ char *p;
+ enum mdoc_warn c;
- if ((i = post_check_children_count(mdoc)) == sz)
- return(1);
- return(mdoc_err(mdoc, "macro requires %d %s "
- "(have %d)", sz, p, i));
+ c = WARN_SYNTAX;
+ p = NULL;
+
+ switch (type) {
+ case (WBADMSEC):
+ p = "inappropriate manual section";
+ c = WARN_COMPAT;
+ break;
+ case (WBADSEC):
+ p = "inappropriate document section";
+ c = WARN_COMPAT;
+ break;
+ case (WARGVAL):
+ p = "argument value suggested";
+ c = WARN_COMPAT;
+ break;
+ case (WPROLREP):
+ p = "prologue macros repeated";
+ c = WARN_COMPAT;
+ break;
+ case (WPROLOOO):
+ p = "prologue macros out-of-order";
+ c = WARN_COMPAT;
+ break;
+ case (WNOLINE):
+ p = "suggested no line arguments";
+ break;
+ case (WLINE):
+ p = "suggested line arguments";
+ break;
+ case (WMULTILINE):
+ p = "suggested multi-line arguments";
+ break;
+ case (WNOMULTILINE):
+ p = "suggested no multi-line arguments";
+ break;
+ case (WWRONGMSEC):
+ p = "document section in wrong manual section";
+ c = WARN_COMPAT;
+ break;
+ case (WSECOOO):
+ p = "document section out of conventional order";
+ break;
+ case (WSECREP):
+ p = "document section repeated";
+ break;
+ case (WBADSTAND):
+ p = "unknown standard";
+ break;
+ case (WNAMESECINC):
+ p = "NAME section contents incomplete/badly-ordered";
+ break;
+ }
+ assert(p);
+ return(mdoc_nwarn(m, n, c, p));
}
-static int
-post_check_children_lt(struct mdoc *mdoc, const char *p, int sz)
+
+static inline int
+warn_count(struct mdoc *m, const char *k,
+ int want, const char *v, int has)
{
- int i;
- if ((i = post_check_children_count(mdoc)) < sz)
- return(1);
- return(mdoc_err(mdoc, "macro requires less than %d "
- "%s (have %d)", sz, p, i));
+ return(mdoc_warn(m, WARN_SYNTAX,
+ "suggests %s %s %d (has %d)", v, k, want, has));
}
-static int
-pre_check_stdarg(struct mdoc *mdoc, struct mdoc_node *node)
+static inline int
+err_count(struct mdoc *m, const char *k,
+ int want, const char *v, int has)
{
- if (1 == node->data.elem.argc &&
- MDOC_Std == node->data.elem.argv[0].arg)
- return(1);
- return(mdoc_nwarn(mdoc, node, WARN_COMPAT,
- "macro suggests single `%s' argument",
- mdoc_argnames[MDOC_Std]));
+ return(mdoc_err(m,
+ "requires %s %s %d (has %d)", v, k, want, has));
}
-static int
-pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node,
- int sz, enum mdoc_msec *msecs)
+static inline int
+count_child(struct mdoc *mdoc)
{
- int i;
+ int i;
+ struct mdoc_node *n;
- 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"));
+ for (i = 0, n = mdoc->last->child; n; n = n->next, i++)
+ /* Do nothing */ ;
+
+ return(i);
}
-static int
-pre_check_parent(struct mdoc *mdoc, struct mdoc_node *node,
- int tok, enum mdoc_type type)
-{
+/*
+ * Build these up with macros because they're basically the same check
+ * for different inequalities. Yes, this could be done with functions,
+ * but this is reasonable for now.
+ */
- if (type != node->parent->type)
- return(mdoc_nerr(mdoc, node, "invalid macro parent class %s, expected %s",
- mdoc_type2a(node->parent->type),
- mdoc_type2a(type)));
- if (MDOC_ROOT != type && tok != node->parent->tok)
- return(mdoc_nerr(mdoc, node, "invalid macro parent `%s', expected `%s'",
- mdoc_macronames[node->parent->tok],
- mdoc_macronames[tok]));
- return(1);
+#define CHECK_CHILD_DEFN(lvl, name, ineq) \
+static int \
+lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \
+{ \
+ int i; \
+ if ((i = count_child(mdoc)) ineq sz) \
+ return(1); \
+ return(lvl##_count(mdoc, #ineq, sz, p, i)); \
}
+#define CHECK_BODY_DEFN(name, lvl, func, num) \
+static int \
+b##lvl##_##name(POST_ARGS) \
+{ \
+ if (MDOC_BODY != mdoc->last->type) \
+ return(1); \
+ return(func(mdoc, "multi-line arguments", (num))); \
+}
-static int
-bwarn_ge1(struct mdoc *mdoc)
-{
-
- if (MDOC_BODY != mdoc->last->type)
- return(1);
- return(post_check_children_wgt(mdoc, "body children", 0));
+#define CHECK_ELEM_DEFN(name, lvl, func, num) \
+static int \
+e##lvl##_##name(POST_ARGS) \
+{ \
+ assert(MDOC_ELEM == mdoc->last->type); \
+ return(func(mdoc, "line arguments", (num))); \
}
+#define CHECK_HEAD_DEFN(name, lvl, func, num) \
+static int \
+h##lvl##_##name(POST_ARGS) \
+{ \
+ if (MDOC_HEAD != mdoc->last->type) \
+ return(1); \
+ return(func(mdoc, "line arguments", (num))); \
+}
-static int
-ewarn_eq1(struct mdoc *mdoc)
-{
- assert(MDOC_ELEM == mdoc->last->type);
- return(post_check_children_weq(mdoc, "parameters", 1));
-}
+CHECK_CHILD_DEFN(warn, gt, >) /* warn_child_gt() */
+CHECK_CHILD_DEFN(err, gt, >) /* err_child_gt() */
+CHECK_CHILD_DEFN(warn, eq, ==) /* warn_child_eq() */
+CHECK_CHILD_DEFN(err, eq, ==) /* err_child_eq() */
+CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */
+CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */
+CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */
+CHECK_ELEM_DEFN(eq1, warn, warn_child_eq, 1) /* ewarn_eq1() */
+CHECK_ELEM_DEFN(eq0, warn, warn_child_eq, 0) /* ewarn_eq0() */
+CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_gt1() */
+CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */
+CHECK_ELEM_DEFN(le2, err, err_child_lt, 3) /* eerr_le2() */
+CHECK_ELEM_DEFN(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, 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
-ewarn_eq0(struct mdoc *mdoc)
+check_stdarg(PRE_ARGS)
{
- assert(MDOC_ELEM == mdoc->last->type);
- return(post_check_children_weq(mdoc, "parameters", 0));
+ if (n->args && 1 == n->args->argc)
+ if (MDOC_Std == n->args->argv[0].arg)
+ return(1);
+ return(nwarn(mdoc, n, WARGVAL));
}
static int
-ewarn_ge1(struct mdoc *mdoc)
+check_sec(PRE_ARGS, ...)
{
+ enum mdoc_sec sec;
+ va_list ap;
- assert(MDOC_ELEM == mdoc->last->type);
- return(post_check_children_wgt(mdoc, "parameters", 0));
-}
+ va_start(ap, n);
+ for (;;) {
+ /* LINTED */
+ sec = (enum mdoc_sec)va_arg(ap, int);
+ if (SEC_CUSTOM == sec)
+ break;
+ if (sec != mdoc->lastsec)
+ continue;
+ va_end(ap);
+ return(1);
+ }
-static int
-eerr_eq1(struct mdoc *mdoc)
-{
-
- assert(MDOC_ELEM == mdoc->last->type);
- return(post_check_children_eq(mdoc, "parameters", 1));
+ va_end(ap);
+ return(nwarn(mdoc, n, WBADSEC));
}
static int
-eerr_le2(struct mdoc *mdoc)
+check_msec(PRE_ARGS, ...)
{
+ va_list ap;
+ int msec;
- assert(MDOC_ELEM == mdoc->last->type);
- return(post_check_children_lt(mdoc, "parameters", 3));
+ va_start(ap, n);
+ for (;;) {
+ /* LINTED */
+ if (0 == (msec = va_arg(ap, int)))
+ break;
+ if (msec != mdoc->meta.msec)
+ continue;
+ va_end(ap);
+ return(1);
+ }
+
+ va_end(ap);
+ return(nwarn(mdoc, n, WBADMSEC));
}
static int
-eerr_le1(struct mdoc *mdoc)
+check_args(struct mdoc *m, const struct mdoc_node *n)
{
+ int i;
- assert(MDOC_ELEM == mdoc->last->type);
- return(post_check_children_lt(mdoc, "parameters", 2));
-}
-
+ if (NULL == n->args)
+ return(1);
-static int
-eerr_eq0(struct mdoc *mdoc)
-{
+ for (i = 0; i < (int)n->args->argc; i++)
+ if ( ! check_argv(m, n, &n->args->argv[i]))
+ return(0);
- assert(MDOC_ELEM == mdoc->last->type);
- return(post_check_children_eq(mdoc, "parameters", 0));
+ return(1);
}
static int
-eerr_ge1(struct mdoc *mdoc)
+check_argv(struct mdoc *m, const struct mdoc_node *n,
+ const struct mdoc_argv *v)
{
+ int i;
+
+ for (i = 0; i < (int)v->sz; i++)
+ if ( ! check_text(m, v->line, v->pos, v->value[i]))
+ return(0);
- assert(MDOC_ELEM == mdoc->last->type);
- return(post_check_children_gt(mdoc, "parameters", 0));
+ if (MDOC_Std == v->arg && MDOC_Ex == n->tok) {
+ /* `Nm' name must be set. */
+ if (v->sz || m->meta.name)
+ return(1);
+ return(nerr(m, n, ENAME));
+ }
+
+ return(1);
}
static int
-herr_eq0(struct mdoc *mdoc)
+check_text(struct mdoc *mdoc, int line, int pos, const char *p)
{
+ size_t c;
- if (MDOC_HEAD != mdoc->last->type)
- return(1);
- return(post_check_children_eq(mdoc, "parameters", 0));
-}
+ /* 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 character"));
+ if ('\\' != *p)
+ continue;
+ if ((c = mdoc_isescape(p))) {
+ p += (int)c - 1;
+ continue;
+ }
+ return(mdoc_perr(mdoc, line, pos,
+ "invalid escape sequence: %s", p));
+ }
-static int
-herr_le1(struct mdoc *mdoc)
-{
- if (MDOC_HEAD != mdoc->last->type)
- return(1);
- return(post_check_children_lt(mdoc, "parameters", 2));
+ return(1);
}
+
+
static int
-herr_ge1(struct mdoc *mdoc)
+check_parent(PRE_ARGS, int tok, enum mdoc_type t)
{
- if (MDOC_HEAD != mdoc->last->type)
+ assert(n->parent);
+ if ((MDOC_ROOT == t || tok == n->parent->tok) &&
+ (t == n->parent->type))
return(1);
- return(post_check_children_gt(mdoc, "parameters", 0));
+
+ return(mdoc_nerr(mdoc, n, "require parent %s",
+ MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]));
}
+
static int
-pre_display(struct mdoc *mdoc, struct mdoc_node *node)
+pre_display(PRE_ARGS)
{
- struct mdoc_node *n;
+ struct mdoc_node *node;
+
+ /* Display elements (`Bd', `D1'...) cannot be nested. */
- if (MDOC_BLOCK != node->type)
+ if (MDOC_BLOCK != n->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)
+ 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(nerr(mdoc, n, ENESTDISP));
}
static int
-pre_bl(struct mdoc *mdoc, struct mdoc_node *node)
+pre_bl(PRE_ARGS)
{
- int type, err;
- struct mdoc_arg *argv;
- size_t i, argc;
+ int i, type, width, offset;
- if (MDOC_BLOCK != node->type)
+ if (MDOC_BLOCK != n->type)
return(1);
- assert(MDOC_Bl == node->tok);
+ if (NULL == n->args)
+ return(nerr(mdoc, n, ELISTTYPE));
- argv = NULL;
- argc = node->data.block.argc;
+ /* Make sure that only one type of list is specified. */
+
+ type = offset = width = -1;
/* LINTED */
- for (i = type = err = 0; i < argc; i++) {
- argv = &node->data.block.argv[(int)i];
- assert(argv);
- switch (argv->arg) {
+ for (i = 0; i < (int)n->args->argc; i++)
+ switch (n->args->argv[i].arg) {
case (MDOC_Bullet):
/* FALLTHROUGH */
case (MDOC_Dash):
case (MDOC_Inset):
/* FALLTHROUGH */
case (MDOC_Column):
- if (type)
- err++;
- type++;
- break;
+ if (-1 == type) {
+ type = n->args->argv[i].arg;
+ break;
+ }
+ return(nerr(mdoc, n, EMULTILIST));
+ case (MDOC_Width):
+ if (-1 == width) {
+ width = n->args->argv[i].arg;
+ break;
+ }
+ return(nerr(mdoc, n, EARGREP));
+ case (MDOC_Offset):
+ if (-1 == offset) {
+ offset = n->args->argv[i].arg;
+ break;
+ }
+ return(nerr(mdoc, n, EARGREP));
default:
break;
}
+
+ if (-1 == type)
+ return(nerr(mdoc, n, ELISTTYPE));
+
+ switch (type) {
+ case (MDOC_Column):
+ /* FALLTHROUGH */
+ case (MDOC_Diag):
+ /* FALLTHROUGH */
+ case (MDOC_Inset):
+ /* FALLTHROUGH */
+ case (MDOC_Item):
+ if (-1 == width)
+ break;
+ return(mdoc_nwarn(mdoc, n, WARN_SYNTAX,
+ "superfluous %s argument",
+ mdoc_argnames[MDOC_Width]));
+ case (MDOC_Tag):
+ if (-1 != width)
+ break;
+ return(mdoc_nerr(mdoc, n, "missing %s argument",
+ mdoc_argnames[MDOC_Width]));
+ default:
+ break;
}
- if (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(1);
}
static int
-pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
+pre_bd(PRE_ARGS)
{
- int type, err;
- struct mdoc_arg *argv;
- size_t i, argc;
+ int i, type, err;
- if (MDOC_BLOCK != node->type)
+ if (MDOC_BLOCK != n->type)
return(1);
- assert(MDOC_Bd == node->tok);
+ if (NULL == n->args)
+ return(nerr(mdoc, n, EDISPTYPE));
- argv = NULL;
- argc = node->data.block.argc;
+ /* Make sure that only one type of display is specified. */
/* LINTED */
- for (err = i = type = 0; 0 == err && i < argc; i++) {
- argv = &node->data.block.argv[(int)i];
- assert(argv);
- switch (argv->arg) {
+ for (i = 0, err = type = 0; ! err &&
+ i < (int)n->args->argc; i++)
+ switch (n->args->argv[i].arg) {
case (MDOC_Ragged):
/* FALLTHROUGH */
case (MDOC_Unfilled):
case (MDOC_Literal):
/* FALLTHROUGH */
case (MDOC_File):
- if (type)
- err++;
- type++;
- break;
+ if (0 == type++)
+ break;
+ return(nerr(mdoc, n, EMULTIDISP));
default:
break;
}
- }
- if (0 == type)
- return(mdoc_err(mdoc, "no display type specified"));
- if (0 == err)
+
+ if (type)
return(1);
- assert(argv);
- return(mdoc_perr(mdoc, argv->line,
- argv->pos, "only one display type possible"));
+ return(nerr(mdoc, n, EDISPTYPE));
}
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(pre_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(pre_check_parent(mdoc, node, -1, MDOC_ROOT));
+ return(check_parent(mdoc, n, -1, MDOC_ROOT));
}
static int
-pre_st(struct mdoc *mdoc, struct mdoc_node *node)
+pre_it(PRE_ARGS)
{
- assert(MDOC_ELEM == node->type);
- assert(MDOC_St == node->tok);
- if (1 == node->data.elem.argc)
+ if (MDOC_BLOCK != n->type)
return(1);
- return(mdoc_nerr(mdoc, node, "macro must have one argument"));
+ return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
}
static int
-pre_an(struct mdoc *mdoc, struct mdoc_node *node)
+pre_an(PRE_ARGS)
{
- assert(MDOC_ELEM == node->type);
- assert(MDOC_An == node->tok);
- if (1 >= node->data.elem.argc)
+ if (n->args && 1 >= n->args->argc)
return(1);
- return(mdoc_nerr(mdoc, node, "macro may only have one argument"));
+ return(mdoc_nerr(mdoc, n, "only one argument allowed"));
}
static int
-pre_rv(struct mdoc *mdoc, struct mdoc_node *node)
+pre_lb(PRE_ARGS)
{
- enum mdoc_msec msecs[2];
- assert(MDOC_ELEM == node->type);
- assert(MDOC_Rv == node->tok);
+ return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM));
+}
+
+
+static int
+pre_rv(PRE_ARGS)
+{
- msecs[0] = MSEC_2;
- msecs[1] = MSEC_3;
- if ( ! pre_check_msecs(mdoc, node, 2, msecs))
+ if ( ! check_msec(mdoc, n, 2, 3, 0))
return(0);
- return(pre_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[3];
-
- assert(MDOC_ELEM == node->type);
- assert(MDOC_Ex == node->tok);
- msecs[0] = MSEC_1;
- msecs[1] = MSEC_6;
- msecs[2] = MSEC_8;
- if ( ! pre_check_msecs(mdoc, node, 3, msecs))
+ if ( ! check_msec(mdoc, n, 1, 6, 8, 0))
return(0);
- return(pre_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[1];
- msecs[0] = MSEC_2;
- return(pre_check_msecs(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[1];
- msecs[0] = MSEC_4;
- return(pre_check_msecs(mdoc, node, 1, msecs));
+ return(check_msec(mdoc, n, 4, 0));
}
static int
-pre_it(struct mdoc *mdoc, struct mdoc_node *node)
+pre_prologue(PRE_ARGS)
{
- if (MDOC_BLOCK != node->type)
- return(1);
- return(pre_check_parent(mdoc, node, MDOC_Bl, MDOC_BODY));
+ return(check_sec(mdoc, n, SEC_PROLOGUE, SEC_CUSTOM));
}
static int
-pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)
+pre_dt(PRE_ARGS)
{
- if (SEC_PROLOGUE != mdoc->lastnamed)
- return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue"));
- assert(MDOC_ELEM == node->type);
+ if (0 == mdoc->meta.date || mdoc->meta.os)
+ if ( ! nwarn(mdoc, n, WPROLOOO))
+ return(0);
+ if (mdoc->meta.title)
+ if ( ! nwarn(mdoc, n, WPROLREP))
+ return(0);
+ return(1);
+}
- /* Check for ordering. */
- 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 */
- }
+static int
+pre_os(PRE_ARGS)
+{
- /* Check for repetition. */
+ if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
+ if ( ! nwarn(mdoc, n, WPROLOOO))
+ return(0);
+ if (mdoc->meta.os)
+ if ( ! nwarn(mdoc, n, WPROLREP))
+ return(0);
+ return(1);
+}
- 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
+pre_dd(PRE_ARGS)
+{
+
+ if (mdoc->meta.title || mdoc->meta.os)
+ if ( ! nwarn(mdoc, n, WPROLOOO))
+ return(0);
+ if (mdoc->meta.date)
+ if ( ! nwarn(mdoc, n, WPROLREP))
+ return(0);
+ return(1);
}
static int
-post_bf(struct mdoc *mdoc)
+post_bf(POST_ARGS)
{
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"));
+
+ head = mdoc->last->head;
+
+ if (NULL == mdoc->last->args) {
+ if (NULL == head->child ||
+ MDOC_TEXT != head->child->type)
+ return(mdoc_err(mdoc, "text argument expected"));
+
+ p = head->child->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"));
}
+
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"));
+ return(mdoc_err(mdoc, "one argument expected"));
+
+ return(1);
}
static int
-post_nm(struct mdoc *mdoc)
+post_nm(POST_ARGS)
{
- 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]));
+ return(merr(mdoc, ENAME));
}
static int
-post_xr(struct mdoc *mdoc)
+post_at(POST_ARGS)
{
- 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
-post_at(struct mdoc *mdoc)
-{
-
- assert(MDOC_ELEM == mdoc->last->type);
- assert(MDOC_At == mdoc->last->tok);
if (NULL == mdoc->last->child)
return(1);
- assert(MDOC_TEXT == mdoc->last->child->type);
-
- if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string))
+ if (MDOC_TEXT != mdoc->last->child->type)
+ return(merr(mdoc, EATT));
+ if (mdoc_a2att(mdoc->last->child->string))
return(1);
- return(mdoc_err(mdoc, "macro expects a valid AT&T version symbol"));
+ return(merr(mdoc, EATT));
}
static int
-post_an(struct mdoc *mdoc)
+post_an(POST_ARGS)
{
- assert(MDOC_ELEM == mdoc->last->type);
- assert(MDOC_An == mdoc->last->tok);
-
- if (0 != mdoc->last->data.elem.argc) {
+ if (mdoc->last->args) {
if (NULL == mdoc->last->child)
return(1);
- return(mdoc_err(mdoc, "macro expects either argument or parameters"));
+ return(merr(mdoc, ELINE));
}
if (mdoc->last->child)
return(1);
- return(mdoc_err(mdoc, "macro expects either argument or parameters"));
+ return(merr(mdoc, ELINE));
}
static int
-post_ex(struct mdoc *mdoc)
+post_ex(POST_ARGS)
{
- 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);
+ if (mdoc->last->args)
+ return(1);
+ return(merr(mdoc, ELINE));
}
-/* Warn if `Bl' type-specific syntax isn't reflected in items. */
static int
-post_it(struct mdoc *mdoc)
+post_it(POST_ARGS)
{
- int type, sv;
-#define TYPE_NONE (0)
-#define TYPE_BODY (1)
-#define TYPE_HEAD (2)
- size_t i, argc;
- struct mdoc_node *n;
+ int type, i, cols;
+ struct mdoc_node *n, *c;
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);
+ n = mdoc->last->parent->parent;
+ if (NULL == n->args)
+ return(merr(mdoc, ELISTTYPE));
- argc = n->data.block.argc;
- type = TYPE_NONE;
- sv = -1;
-
/* Some types require block-head, some not. */
/* LINTED */
- for (i = 0; TYPE_NONE == type && i < argc; i++)
- switch (n->data.block.argv[(int)i].arg) {
+ for (cols = type = -1, i = 0; -1 == type &&
+ i < (int)n->args->argc; i++)
+ switch (n->args->argv[i].arg) {
case (MDOC_Tag):
/* FALLTHROUGH */
case (MDOC_Diag):
case (MDOC_Ohang):
/* FALLTHROUGH */
case (MDOC_Inset):
- type = TYPE_HEAD;
- sv = n->data.block.argv[(int)i].arg;
- break;
+ /* FALLTHROUGH */
case (MDOC_Bullet):
/* FALLTHROUGH */
case (MDOC_Dash):
case (MDOC_Hyphen):
/* FALLTHROUGH */
case (MDOC_Item):
- /* FALLTHROUGH */
+ type = n->args->argv[i].arg;
+ break;
case (MDOC_Column):
- type = TYPE_BODY;
- sv = n->data.block.argv[(int)i].arg;
+ type = n->args->argv[i].arg;
+ cols = (int)n->args->argv[i].sz;
break;
default:
break;
}
- assert(TYPE_NONE != type);
+ if (-1 == type)
+ return(merr(mdoc, ELISTTYPE));
- if (TYPE_HEAD == type) {
- n = mdoc->last->data.block.head;
- assert(n);
- if (NULL == n->child)
- if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters"))
+ switch (type) {
+ case (MDOC_Tag):
+ if (NULL == mdoc->last->head->child)
+ if ( ! mwarn(mdoc, WLINE))
return(0);
-
- n = mdoc->last->data.block.body;
- assert(n);
- if (NULL == n->child)
- if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))
+ break;
+ case (MDOC_Hang):
+ /* FALLTHROUGH */
+ case (MDOC_Ohang):
+ /* FALLTHROUGH */
+ case (MDOC_Inset):
+ /* FALLTHROUGH */
+ case (MDOC_Diag):
+ if (NULL == mdoc->last->head->child)
+ if ( ! mwarn(mdoc, WLINE))
return(0);
-
- return(1);
- }
-
- assert(TYPE_BODY == type);
- assert(mdoc->last->data.block.head);
-
- n = mdoc->last->data.block.head;
- assert(n);
- 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"))
+ if (NULL == mdoc->last->body->child)
+ if ( ! mwarn(mdoc, WMULTILINE))
+ return(0);
+ break;
+ case (MDOC_Bullet):
+ /* FALLTHROUGH */
+ case (MDOC_Dash):
+ /* FALLTHROUGH */
+ case (MDOC_Enum):
+ /* FALLTHROUGH */
+ case (MDOC_Hyphen):
+ /* FALLTHROUGH */
+ case (MDOC_Item):
+ if (mdoc->last->head->child)
+ if ( ! mwarn(mdoc, WNOLINE))
+ return(0);
+ if (NULL == mdoc->last->body->child)
+ if ( ! mwarn(mdoc, WMULTILINE))
+ return(0);
+ break;
+ case (MDOC_Column):
+ if (NULL == mdoc->last->head->child)
+ if ( ! mwarn(mdoc, WLINE))
+ return(0);
+ if (mdoc->last->body->child)
+ if ( ! mwarn(mdoc, WNOMULTILINE))
+ return(0);
+ c = mdoc->last->head->child;
+ for (i = 0; c; c = c->next)
+ i++;
+ if (i == cols)
+ break;
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
+ "column mismatch (have %d, want %d)", i, cols))
return(0);
+ break;
+ default:
+ break;
+ }
- assert(-1 != sv);
- 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
+ return(1);
}
static int
-post_bl(struct mdoc *mdoc)
+post_bl(POST_ARGS)
{
- struct mdoc_node *n;
+ struct mdoc_node *n;
if (MDOC_BODY != mdoc->last->type)
return(1);
- assert(MDOC_Bl == mdoc->last->tok);
+ if (NULL == mdoc->last->child)
+ return(1);
/* LINTED */
for (n = mdoc->last->child; n; n = n->next) {
if (MDOC_BLOCK == n->type)
if (MDOC_It == n->tok)
continue;
- break;
+ return(mdoc_nerr(mdoc, n, "bad child of parent %s",
+ mdoc_macronames[mdoc->last->tok]));
}
- if (NULL == n)
- return(1);
- return(mdoc_nerr(mdoc, n, "invalid child of parent macro `Bl'"));
+
+ return(1);
}
{
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"))
+ if (xstrcmp(n->string, "on"))
continue;
- if (xstrcmp(n->data.text.string, "off"))
+ if (xstrcmp(n->string, "off"))
continue;
break;
}
+
if (NULL == n)
return(1);
- return(mdoc_nerr(mdoc, n, "expected boolean value"));
+ return(nerr(mdoc, n, EBOOL));
}
static int
-post_root(struct mdoc *mdoc)
+post_root(POST_ARGS)
{
if (NULL == mdoc->first->child)
- return(mdoc_err(mdoc, "document has no data"));
+ return(merr(mdoc, ENODATA));
if (SEC_PROLOGUE == mdoc->lastnamed)
- return(mdoc_err(mdoc, "document has incomplete prologue"));
+ return(merr(mdoc, ENOPROLOGUE));
+
if (MDOC_BLOCK != mdoc->first->child->type)
- return(mdoc_err(mdoc, "document expects `%s' macro after prologue", mdoc_macronames[MDOC_Sh]));
+ return(merr(mdoc, ENODATA));
if (MDOC_Sh != mdoc->first->child->tok)
- return(mdoc_err(mdoc, "document expects `%s' macro after prologue", mdoc_macronames[MDOC_Sh]));
+ return(merr(mdoc, ENODATA));
+
return(1);
}
static int
-post_sh(struct mdoc *mdoc)
+post_st(POST_ARGS)
+{
+
+ if (mdoc_a2st(mdoc->last->child->string))
+ return(1);
+ return(mwarn(mdoc, WBADSTAND));
+}
+
+
+static int
+post_sh(POST_ARGS)
{
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
-post_sh_body(struct mdoc *mdoc)
+post_sh_body(POST_ARGS)
{
struct mdoc_node *n;
- assert(MDOC_Sh == mdoc->last->tok);
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_err(mdoc, "section NAME must contain %s as the first body child", mdoc_macronames[MDOC_Nm]));
- if (MDOC_ELEM != n->type || MDOC_Nm != n->tok)
- return(mdoc_err(mdoc, "section NAME must contain %s as the first body child", mdoc_macronames[MDOC_Nm]));
- if (NULL == (n = n->next))
- return(mdoc_err(mdoc, "section NAME must contain %s as the second body child", mdoc_macronames[MDOC_Nd]));
- if (MDOC_ELEM != n->type || MDOC_Nd != n->tok)
- return(mdoc_err(mdoc, "section NAME must contain %s as the second body child", mdoc_macronames[MDOC_Nd]));
- if (NULL == (n = n->next))
- return(1);
+ return(mwarn(mdoc, WNAMESECINC));
- return(mdoc_warn(mdoc, WARN_SYNTAX, "section NAME usually limited to %s and %s body children",
- 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 ( ! mwarn(mdoc, WNAMESECINC))
+ return(0);
+ }
+
+ if (MDOC_ELEM == n->type && MDOC_Nd == n->tok)
+ return(1);
+ return(mwarn(mdoc, WNAMESECINC));
}
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(mwarn(mdoc, WSECOOO));
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);
-}
+ /* Check for repeated or out-of-order sections. */
+ if (sec == mdoc->lastnamed)
+ return(mwarn(mdoc, WSECREP));
+ if (sec < mdoc->lastnamed)
+ return(mwarn(mdoc, WSECOOO));
-int
-mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *node)
-{
- v_pre *p;
+ /* Check particular section/manual section conventions. */
- if (MDOC_TEXT == node->type)
- return(1);
- assert(MDOC_ROOT != node->type);
+ switch (sec) {
+ case (SEC_LIBRARY):
+ switch (mdoc->meta.msec) {
+ case (2):
+ /* FALLTHROUGH */
+ case (3):
+ break;
+ default:
+ return(mwarn(mdoc, WWRONGMSEC));
+ }
+ break;
+ default:
+ break;
+ }
- if (NULL == mdoc_valids[node->tok].pre)
- return(1);
- for (p = mdoc_valids[node->tok].pre; *p; p++)
- if ( ! (*p)(mdoc, node))
- return(0);
return(1);
}
-int
-mdoc_valid_post(struct mdoc *mdoc)
+static int
+pre_fd(PRE_ARGS)
{
- v_post *p;
-
- 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));
}
-
git.ckatri.com / mandoc.git / blobdiff