-/* $Id: validate.c,v 1.8 2008/12/30 13:43:53 kristaps Exp $ */
+/* $Id: validate.c,v 1.60 2009/02/25 12:32:50 kristaps Exp $ */
/*
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
*
#include <assert.h>
#include <ctype.h>
#include <stdlib.h>
-#include <stdio.h>
-#include <string.h>
-#ifdef __linux__
-#include <time.h>
-#endif
#include "private.h"
-/* FIXME: maxlineargs should be per LINE, no per TOKEN. */
-/* FIXME: prologue check should be in macro_call. */
+/*
+ * 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.
+ */
-#define _CC(p) ((const char **)p)
+#define PRE_ARGS struct mdoc *mdoc, const struct mdoc_node *n
+#define POST_ARGS struct mdoc *mdoc
+
+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. */
+
+struct valids {
+ v_pre *pre;
+ v_post *post;
+};
+
+/* 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_stdarg(PRE_ARGS);
+
+static int check_text(struct mdoc *,
+ size_t, size_t, const char *);
+
+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);
+
+/* 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(PRE_ARGS);
+static int pre_sh(PRE_ARGS);
+static int pre_ss(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_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_prologue(PRE_ARGS);
+
+/* Specific post-child-parse routines. */
+
+static int herr_ge1(POST_ARGS);
+static int hwarn_le1(POST_ARGS);
+static int herr_eq0(POST_ARGS);
+static int eerr_eq0(POST_ARGS);
+static int eerr_le1(POST_ARGS);
+static int eerr_le2(POST_ARGS);
+static int eerr_eq1(POST_ARGS);
+static int eerr_ge1(POST_ARGS);
+static int ewarn_eq0(POST_ARGS);
+static int ewarn_eq1(POST_ARGS);
+static int bwarn_ge1(POST_ARGS);
+static int hwarn_eq1(POST_ARGS);
+static int ewarn_ge1(POST_ARGS);
+static int ebool(POST_ARGS);
+
+static int post_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_root(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_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[] = { 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 };
+
+/* 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_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 */
+ { 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 int scope_rewind_exp(struct mdoc *, int, int, int);
-static int scope_rewind_imp(struct mdoc *, int, int);
-static int append_text(struct mdoc *, int,
- int, int, char *[]);
-static int append_const(struct mdoc *, int, int, int, char *[]);
-static int append_constarg(struct mdoc *, int, int,
- int, const struct mdoc_arg *);
-static int append_scoped(struct mdoc *, int, int, int,
- const char *[], int, const struct mdoc_arg *);
-static int append_delims(struct mdoc *, int, int *, char *);
+int
+mdoc_valid_pre(struct mdoc *mdoc,
+ const struct mdoc_node *node)
+{
+ v_pre *p;
+ struct mdoc_arg *argv;
+ size_t argc, i, j, line, pos;
+ const char *tp;
+
+ if (MDOC_TEXT == node->type) {
+ tp = node->data.text.string;
+ line = node->line;
+ pos = node->pos;
+ return(check_text(mdoc, line, pos, tp));
+ }
+
+ if (MDOC_BLOCK == node->type || MDOC_ELEM == node->type) {
+ argv = MDOC_BLOCK == node->type ?
+ node->data.block.argv :
+ node->data.elem.argv;
+ argc = MDOC_BLOCK == node->type ?
+ node->data.block.argc :
+ node->data.elem.argc;
-static int
-append_delims(struct mdoc *mdoc, int tok, int *pos, char *buf)
+ for (i = 0; i < argc; i++) {
+ if (0 == argv[i].sz)
+ continue;
+ for (j = 0; j < argv[i].sz; j++) {
+ tp = argv[i].value[j];
+ line = argv[i].line;
+ pos = argv[i].pos;
+ if ( ! check_text(mdoc, line, pos, tp))
+ return(0);
+ }
+ }
+ }
+
+ if (NULL == mdoc_valids[node->tok].pre)
+ return(1);
+ for (p = mdoc_valids[node->tok].pre; *p; p++)
+ if ( ! (*p)(mdoc, node))
+ return(0);
+ return(1);
+}
+
+
+int
+mdoc_valid_post(struct mdoc *mdoc)
{
- int c, lastarg;
- char *p;
+ v_post *p;
+
+ /*
+ * This check occurs after the macro's children have been filled
+ * in: postfix validation. Since this happens when we're
+ * rewinding the scope tree, it's possible to have multiple
+ * invocations (as by design, for now), we set bit MDOC_VALID to
+ * indicate that we've validated.
+ */
- if (0 == buf[*pos])
+ if (MDOC_VALID & mdoc->last->flags)
return(1);
+ mdoc->last->flags |= MDOC_VALID;
- mdoc_msg(mdoc, *pos, "`%s' flushing punctuation",
- mdoc_macronames[tok]);
+ if (MDOC_TEXT == mdoc->last->type)
+ return(1);
+ if (MDOC_ROOT == mdoc->last->type)
+ return(post_root(mdoc));
- for (;;) {
- lastarg = *pos;
- c = mdoc_args(mdoc, tok, pos, buf, 0, &p);
- if (ARGS_ERROR == c)
+ 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);
- else if (ARGS_EOLN == c)
- break;
- assert(mdoc_isdelim(p));
- mdoc_word_alloc(mdoc, lastarg, p);
- }
return(1);
}
-static int
-scope_rewind_imp(struct mdoc *mdoc, int ppos, int tok)
+
+static inline int
+warn_count(struct mdoc *m, const char *k,
+ int want, const char *v, int has)
{
- struct mdoc_node *n;
- int t;
- n = mdoc->last ? mdoc->last->parent : NULL;
+ return(mdoc_warn(m, WARN_SYNTAX,
+ "suggests %s %s %d (has %d)",
+ v, k, want, has));
+}
- /* LINTED */
- for ( ; n; n = n->parent) {
- if (MDOC_BLOCK != n->type)
- continue;
- if (tok == (t = n->data.block.tok))
- break;
- if ( ! (MDOC_EXPLICIT & mdoc_macros[t].flags))
- continue;
- return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK));
- }
- if (n) {
- mdoc->last = n;
- mdoc_msg(mdoc, ppos, "scope: rewound implicit `%s'",
- mdoc_macronames[tok]);
- return(1);
- }
+static inline int
+err_count(struct mdoc *m, const char *k,
+ int want, const char *v, int has)
+{
- mdoc_msg(mdoc, ppos, "scope: new implicit `%s'",
- mdoc_macronames[tok]);
- return(1);
+ return(mdoc_err(m, "requires %s %s %d (has %d)",
+ v, k, want, has));
}
-static int
-scope_rewind_exp(struct mdoc *mdoc, int ppos, int tok, int dst)
+static inline int
+count_child(struct mdoc *mdoc)
{
+ int i;
struct mdoc_node *n;
- assert(mdoc->last);
+ for (i = 0, n = mdoc->last->child; n; n = n->next, i++)
+ /* Do nothing */ ;
- /* LINTED */
- for (n = mdoc->last->parent; n; n = n->parent) {
- if (MDOC_BLOCK != n->type)
- continue;
- if (dst == n->data.block.tok)
- break;
- return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK));
- }
+ return(i);
+}
- if (NULL == (mdoc->last = n))
- return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_NOCTX));
- mdoc_msg(mdoc, ppos, "scope: rewound explicit `%s' to `%s'",
- mdoc_macronames[tok], mdoc_macronames[dst]);
+/*
+ * 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.
+ */
- 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, "multiline parameters", (num))); \
+}
+
+#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 parameters", (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 parameters", (num))); \
}
+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(le1, err, err_child_lt, 2) /* eerr_le1() */
+CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */
+CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */
+CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */
+CHECK_HEAD_DEFN(le1, 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
-append_constarg(struct mdoc *mdoc, int tok, int pos,
- int argc, const struct mdoc_arg *argv)
+check_stdarg(PRE_ARGS)
{
- switch (tok) {
- default:
- break;
- }
+ if (MDOC_Std == n->data.elem.argv[0].arg &&
+ 1 == n->data.elem.argc)
+ return(1);
- mdoc_elem_alloc(mdoc, pos, tok, argc, argv, 0, NULL);
- return(1);
+ return(mdoc_nwarn(mdoc, n, WARN_COMPAT,
+ "one argument suggested"));
}
-/*
- * Append a node with implicit or explicit scoping ONLY. ALL macros
- * with the implicit- or explicit-scope callback must be included here.
- */
static int
-append_scoped(struct mdoc *mdoc, int tok, int pos,
- int sz, const char *args[],
- int argc, const struct mdoc_arg *argv)
+check_msec(PRE_ARGS, int sz, enum mdoc_msec *msecs)
{
- enum mdoc_sec sec;
- struct mdoc_node *node;
+ int i;
- switch (tok) {
- /* ======= ADD MORE MACRO CHECKS BELOW. ======= */
-
- case (MDOC_Sh):
- /*
- * Check rules for section ordering. We can have
- * "known" sections (like NAME and so on) and "custom"
- * sections, which are unknown. If we have a known
- * section, we should fall within the conventional
- * section order.
- */
- if (0 == sz)
- return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1));
-
- sec = mdoc_atosec((size_t)sz, _CC(args));
- if (SEC_CUSTOM != sec && sec < mdoc->sec_lastn)
- if ( ! mdoc_warn(mdoc, tok, pos, WARN_SEC_OO))
- return(0);
-
- if (SEC_BODY == mdoc->sec_last && SEC_NAME != sec)
- return(mdoc_err(mdoc, tok, pos, ERR_SEC_NAME));
- if (SEC_CUSTOM != sec)
- mdoc->sec_lastn = sec;
- mdoc->sec_last = sec;
- break;
+ for (i = 0; i < sz; i++)
+ if (msecs[i] == mdoc->meta.msec)
+ return(1);
+ return(mdoc_nwarn(mdoc, n, WARN_COMPAT,
+ "invalid manual section"));
+}
- case (MDOC_Ss):
- if (0 != sz)
- break;
- return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1));
-
- case (MDOC_Bd):
- /*
- * We can't be nested within any other block displays
- * (or really any other kind of display, although Bd is
- * the only multi-line one that will show up).
- */
- assert(mdoc->last);
- node = mdoc->last->parent;
- /* LINTED */
- for ( ; node; node = node->parent) {
- if (node->type != MDOC_BLOCK)
- continue;
- if (node->data.block.tok != MDOC_Bd)
- continue;
- break;
- }
- if (NULL == node)
- break;
- return(mdoc_err(mdoc, tok, pos, ERR_SCOPE_NONEST));
- case (MDOC_Bl):
- break;
+static int
+check_text(struct mdoc *mdoc, size_t line, size_t pos, const char *p)
+{
+ size_t c;
- /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */
- default:
- abort();
- /* NOTREACHED */
+ for ( ; *p; p++) {
+ if ( ! isprint((int)*p) && '\t' != *p)
+ return(mdoc_perr(mdoc, line, pos,
+ "invalid characters"));
+ if ('\\' != *p)
+ continue;
+ if ((c = mdoc_isescape(p))) {
+ p += (c - 1);
+ continue;
+ }
+ return(mdoc_perr(mdoc, line, pos,
+ "invalid escape sequence"));
}
- mdoc_block_alloc(mdoc, pos, tok, (size_t)argc, argv);
- mdoc_head_alloc(mdoc, pos, tok, (size_t)sz, _CC(args));
- mdoc_body_alloc(mdoc, pos, tok);
return(1);
}
+
+
static int
-append_const(struct mdoc *mdoc, int tok,
- int pos, int sz, char *args[])
+check_parent(PRE_ARGS, int tok, enum mdoc_type t)
{
- switch (tok) {
- /* ======= ADD MORE MACRO CHECKS BELOW. ======= */
+ assert(n->parent);
+ if ((MDOC_ROOT == t || tok == n->parent->tok) &&
+ (t == n->parent->type))
+ return(1);
- /* FIXME: this is the ugliest part of this page. */
- case (MDOC_At):
- /* This needs special handling. */
- if (0 == sz)
- break;
- else if (sz > 2)
- return(mdoc_err(mdoc, tok, pos, ERR_ARGS_LE2));
-
- if (ATT_DEFAULT != mdoc_atoatt(args[0])) {
- mdoc_elem_alloc(mdoc, pos, tok, 0,
- NULL, 1, _CC(&args[0]));
- } else {
- mdoc_elem_alloc(mdoc, pos, tok,
- 0, NULL, 0, NULL);
- if (mdoc_isdelim(args[0]))
- return(mdoc_err(mdoc, tok, pos, ERR_SYNTAX_NOPUNCT));
- mdoc_word_alloc(mdoc, pos, args[0]);
- }
+ return(mdoc_nerr(mdoc, n, "require parent %s",
+ MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]));
+}
- if (1 == sz)
- return(1);
- if (mdoc_isdelim(args[1]))
- return(mdoc_err(mdoc, tok, pos, ERR_SYNTAX_NOPUNCT));
- mdoc_word_alloc(mdoc, pos, args[1]);
- return(1);
- case (MDOC_Nd):
- if (sz > 0)
- break;
- if ( ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_GE1))
- return(0);
- break;
-
- case (MDOC_Hf):
- if (1 == sz)
- break;
- return(mdoc_err(mdoc, tok, pos, ERR_ARGS_EQ1));
- case (MDOC_Bx):
- /* FALLTHROUGH */
- case (MDOC_Bsx):
- /* FALLTHROUGH */
- case (MDOC_Os):
- /* FALLTHROUGH */
- case (MDOC_Fx):
- /* FALLTHROUGH */
- case (MDOC_Nx):
- assert(sz <= 1);
- break;
+static int
+pre_display(PRE_ARGS)
+{
+ struct mdoc_node *node;
- case (MDOC_Ux):
- assert(0 == sz);
- break;
+ /* Display elements (`Bd', `D1'...) cannot be nested. */
- case (MDOC_Bt):
- /* FALLTHROUGH */
- case (MDOC_Ud):
- if (0 == sz)
- break;
- return(mdoc_err(mdoc, tok, pos, ERR_ARGS_EQ0));
+ if (MDOC_BLOCK != n->type)
+ return(1);
- /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */
- default:
- abort();
- /* NOTREACHED */
- }
+ /* LINTED */
+ for (node = mdoc->last->parent; node; node = node->parent)
+ if (MDOC_BLOCK == node->type)
+ if (MDOC_Bd == node->tok)
+ break;
+ if (NULL == node)
+ return(1);
- mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, (size_t)sz, _CC(args));
- return(1);
+ return(mdoc_nerr(mdoc, n, "displays may not be nested"));
}
static int
-append_text(struct mdoc *mdoc, int tok,
- int pos, int sz, char *args[])
+pre_bl(PRE_ARGS)
{
+ int type, i;
+ struct mdoc_arg *argv;
+ size_t argc;
- switch (tok) {
- /* ======= ADD MORE MACRO CHECKS BELOW. ======= */
- case (MDOC_Pp):
- if (0 == sz)
- break;
- if ( ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_EQ0))
- return(0);
- break;
+ if (MDOC_BLOCK != n->type)
+ return(1);
- case (MDOC_Ft):
- /* FALLTHROUGH */
- case (MDOC_Li):
- /* FALLTHROUGH */
- case (MDOC_Ms):
- /* FALLTHROUGH */
- case (MDOC_Pa):
- /* FALLTHROUGH */
- case (MDOC_Tn):
- if (0 < sz)
- break;
- if ( ! mdoc_warn(mdoc, tok, pos, WARN_ARGS_GE1))
- return(0);
- break;
+ argc = n->data.block.argc;
- case (MDOC_Ar):
- /* FALLTHROUGH */
- case (MDOC_Cm):
- /* FALLTHROUGH */
- case (MDOC_Fl):
- /* These can have no arguments. */
- break;
+ /* Make sure that only one type of list is specified. */
+
+ /* LINTED */
+ for (i = 0, type = 0; i < (int)argc; i++) {
+ argv = &n->data.block.argv[i];
- case (MDOC_Ad):
- /* FALLTHROUGH */
- case (MDOC_Em):
- /* FALLTHROUGH */
- case (MDOC_Er):
- /* FALLTHROUGH */
- case (MDOC_Ev):
- /* FALLTHROUGH */
- case (MDOC_Fa):
- /* FALLTHROUGH */
- case (MDOC_Dv):
- /* FALLTHROUGH */
- case (MDOC_Ic):
- /* FALLTHROUGH */
- case (MDOC_Sy):
- /* FALLTHROUGH */
- case (MDOC_Sx):
- /* FALLTHROUGH */
- case (MDOC_Va):
- /* FALLTHROUGH */
- case (MDOC_Vt):
- if (0 < sz)
+ 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 (0 == type++)
+ break;
+ return(mdoc_perr(mdoc, argv->line, argv->pos,
+ "multiple types specified"));
+ default:
break;
- return(mdoc_err(mdoc, tok, pos, ERR_ARGS_GE1));
- /* ======= ADD MORE MACRO CHECKS ABOVE. ======= */
- default:
- abort();
- /* NOTREACHED */
+ }
}
- mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, (size_t)sz, _CC(args));
- return(1);
+ if (type)
+ return(1);
+ return(mdoc_err(mdoc, "no type specified"));
}
-int
-macro_text(MACRO_PROT_ARGS)
+static int
+pre_bd(PRE_ARGS)
{
- int lastarg, lastpunct, c, j;
- char *args[MDOC_LINEARG_MAX];
+ int type, err, i;
+ struct mdoc_arg *argv;
+ size_t argc;
- if (SEC_PROLOGUE == mdoc->sec_lastn)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));
+ if (MDOC_BLOCK != n->type)
+ return(1);
- /* Token pre-processing. */
+ argc = n->data.block.argc;
- switch (tok) {
- case (MDOC_Pp):
- /* `.Pp' ignored when following `.Sh' or `.Ss'. */
- assert(mdoc->last);
- if (MDOC_BODY != mdoc->last->type)
- break;
- switch (mdoc->last->data.body.tok) {
- case (MDOC_Ss):
+ /* Make sure that only one type of display is specified. */
+
+ /* LINTED */
+ for (i = 0, err = type = 0; ! err && i < (int)argc; i++) {
+ argv = &n->data.block.argv[i];
+
+ switch (argv->arg) {
+ case (MDOC_Ragged):
/* FALLTHROUGH */
- case (MDOC_Sh):
- if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_AFTER_BLK))
- return(0);
- return(1);
+ case (MDOC_Unfilled):
+ /* FALLTHROUGH */
+ case (MDOC_Filled):
+ /* FALLTHROUGH */
+ case (MDOC_Literal):
+ /* FALLTHROUGH */
+ case (MDOC_File):
+ if (0 == type++)
+ break;
+ return(mdoc_perr(mdoc, argv->line, argv->pos,
+ "multiple types specified"));
default:
break;
}
- break;
- default:
- break;
}
- /* Process line parameters. */
+ if (type)
+ return(1);
+ return(mdoc_err(mdoc, "no type specified"));
+}
- j = 0;
- lastarg = ppos;
- lastpunct = 0;
-again:
- if (j == MDOC_LINEARG_MAX)
- return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));
+static int
+pre_ss(PRE_ARGS)
+{
- /*
- * Parse out the next argument, unquoted and unescaped. If
- * we're a word (which may be punctuation followed eventually by
- * a real word), then fall into checking for callables. If
- * only punctuation remains and we're the first, then flush
- * arguments, punctuation and exit; else, return to the caller.
- */
+ if (MDOC_BLOCK != n->type)
+ return(1);
+ return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
+}
- lastarg = *pos;
- switch (mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &args[j])) {
- case (ARGS_ERROR):
- return(0);
- case (ARGS_WORD):
- break;
- case (ARGS_PUNCT):
- if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args))
- return(0);
- if (ppos > 1)
- return(1);
- return(append_delims(mdoc, tok, pos, buf));
- case (ARGS_EOLN):
- if (lastpunct)
- return(1);
- return(append_text(mdoc, tok, ppos, j, args));
- default:
- abort();
- /* NOTREACHED */
- }
+static int
+pre_sh(PRE_ARGS)
+{
- /*
- * Command found. First flush out arguments, then call the
- * command. If we're the line macro when it exits, flush
- * terminal punctuation.
- */
+ if (MDOC_BLOCK != n->type)
+ return(1);
+ return(check_parent(mdoc, n, -1, MDOC_ROOT));
+}
- if (MDOC_MAX != (c = mdoc_find(mdoc, args[j]))) {
- if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args))
- return(0);
- if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf))
- return(0);
- if (ppos > 1)
- return(1);
- return(append_delims(mdoc, tok, pos, buf));
- }
- /* Word/non-term-punctuation found. */
+static int
+pre_it(PRE_ARGS)
+{
- if ( ! mdoc_isdelim(args[j])) {
- /* Words are appended to the array of arguments. */
- j++;
- lastpunct = 0;
- goto again;
- }
+ /* TODO: -width attribute must be specified for -tag. */
+ /* TODO: children too big for -width? */
- /*
- * For punctuation, flush all collected words, then flush
- * punctuation, then start collecting again. Of course, this
- * is non-terminal punctuation.
- */
+ if (MDOC_BLOCK != n->type)
+ return(1);
+ return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
+}
- if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args))
- return(0);
- mdoc_word_alloc(mdoc, lastarg, args[j]);
- j = 0;
- lastpunct = 1;
+static int
+pre_st(PRE_ARGS)
+{
- goto again;
- /* NOTREACHED */
+ if (1 == n->data.elem.argc)
+ return(1);
+ return(mdoc_nerr(mdoc, n, "one argument required"));
}
-int
-macro_prologue_dtitle(MACRO_PROT_ARGS)
+static int
+pre_an(PRE_ARGS)
{
- int lastarg, j;
- char *args[MDOC_LINEARG_MAX];
- if (SEC_PROLOGUE != mdoc->sec_lastn)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_NPROLOGUE));
- if (0 == mdoc->meta.date)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_OO));
- if (mdoc->meta.title[0])
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_REP));
-
- j = -1;
- lastarg = ppos;
+ if (1 >= n->data.elem.argc)
+ return(1);
+ return(mdoc_nerr(mdoc, n, "one argument allowed"));
+}
-again:
- if (j == MDOC_LINEARG_MAX)
- return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));
- lastarg = *pos;
+static int
+pre_rv(PRE_ARGS)
+{
+ enum mdoc_msec msecs[] = { MSEC_2, MSEC_3 };
- switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[++j])) {
- case (ARGS_EOLN):
- if (mdoc->meta.title)
- return(1);
- if ( ! mdoc_warn(mdoc, tok, ppos, WARN_ARGS_GE1))
- return(0);
- (void)xstrlcpy(mdoc->meta.title,
- "UNTITLED", META_TITLE_SZ);
- return(1);
- case (ARGS_ERROR):
+ if ( ! check_msec(mdoc, n, 2, msecs))
return(0);
- default:
- break;
- }
+ return(check_stdarg(mdoc, n));
+}
- if (MDOC_MAX != mdoc_find(mdoc, args[j]) && ! mdoc_warn
- (mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE))
+
+static int
+pre_ex(PRE_ARGS)
+{
+ enum mdoc_msec msecs[] = { MSEC_1, MSEC_6, MSEC_8 };
+
+ if ( ! check_msec(mdoc, n, 3, msecs))
return(0);
+ return(check_stdarg(mdoc, n));
+}
- if (0 == j) {
- if (xstrlcpy(mdoc->meta.title, args[0], META_TITLE_SZ))
- goto again;
- return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM));
-
- } else if (1 == j) {
- mdoc->meta.msec = mdoc_atomsec(args[1]);
- if (MSEC_DEFAULT != mdoc->meta.msec)
- goto again;
- return(mdoc_err(mdoc, tok, -1, ERR_SYNTAX_ARGFORM));
-
- } else if (2 == j) {
- mdoc->meta.vol = mdoc_atovol(args[2]);
- if (VOL_DEFAULT != mdoc->meta.vol)
- goto again;
- mdoc->meta.arch = mdoc_atoarch(args[2]);
- if (ARCH_DEFAULT != mdoc->meta.arch)
- goto again;
- return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM));
- }
- return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));
+static int
+pre_er(PRE_ARGS)
+{
+ enum mdoc_msec msecs[] = { MSEC_2 };
+
+ return(check_msec(mdoc, n, 1, msecs));
}
-int
-macro_prologue_os(MACRO_PROT_ARGS)
+static int
+pre_cd(PRE_ARGS)
{
- int lastarg, j;
- char *args[MDOC_LINEARG_MAX];
+ enum mdoc_msec msecs[] = { MSEC_4 };
- if (SEC_PROLOGUE != mdoc->sec_lastn)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_NPROLOGUE));
- if (0 == mdoc->meta.title[0])
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_OO));
- if (mdoc->meta.os[0])
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_REP));
+ return(check_msec(mdoc, n, 1, msecs));
+}
- j = -1;
- lastarg = ppos;
-again:
- if (j == MDOC_LINEARG_MAX)
- return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));
+static int
+pre_prologue(PRE_ARGS)
+{
- lastarg = *pos;
+ if (SEC_PROLOGUE != mdoc->lastnamed)
+ return(mdoc_nerr(mdoc, n, "prologue only"));
- switch (mdoc_args(mdoc, tok, pos, buf,
- ARGS_QUOTED, &args[++j])) {
- case (ARGS_EOLN):
- mdoc->sec_lastn = mdoc->sec_last = SEC_BODY;
- return(1);
- case (ARGS_ERROR):
- return(0);
+ /* 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:
- break;
+ abort();
+ /* NOTREACHED */
}
-
- if ( ! xstrlcat(mdoc->meta.os, args[j], sizeof(mdoc->meta.os)))
- return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM));
- if ( ! xstrlcat(mdoc->meta.os, " ", sizeof(mdoc->meta.os)))
- return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM));
- goto again;
- /* NOTREACHED */
-}
+ /* Check for repetition. */
-
-int
-macro_prologue_ddate(MACRO_PROT_ARGS)
-{
- int lastarg, j;
- char *args[MDOC_LINEARG_MAX], date[64];
-
- if (SEC_PROLOGUE != mdoc->sec_lastn)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_NPROLOGUE));
- if (mdoc->meta.title[0])
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_OO));
- if (mdoc->meta.date)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE_REP));
-
- j = -1;
- date[0] = 0;
- lastarg = ppos;
-
-again:
- if (j == MDOC_LINEARG_MAX)
- return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));
-
- lastarg = *pos;
- switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[++j])) {
- case (ARGS_EOLN):
- if (mdoc->meta.date)
+ switch (n->tok) {
+ case (MDOC_Os):
+ if (NULL == mdoc->meta.os)
return(1);
- mdoc->meta.date = mdoc_atotime(date);
- if (mdoc->meta.date)
+ break;
+ case (MDOC_Dd):
+ if (0 == mdoc->meta.date)
return(1);
- return(mdoc_err(mdoc, tok, ppos, ERR_SYNTAX_ARGFORM));
- case (ARGS_ERROR):
- return(0);
- default:
break;
+ case (MDOC_Dt):
+ if (NULL == mdoc->meta.title)
+ return(1);
+ break;
+ default:
+ abort();
+ /* NOTREACHED */
}
-
- if (MDOC_MAX != mdoc_find(mdoc, args[j]) && ! mdoc_warn
- (mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE))
- return(0);
-
- if (0 == j) {
- if (xstrcmp("$Mdocdate: December 30 2008 $", args[j])) {
- mdoc->meta.date = time(NULL);
- goto again;
- } else if (xstrcmp("$Mdocdate:", args[j]))
- goto again;
- } else if (4 == j)
- if ( ! xstrcmp("$", args[j]))
- goto again;
-
- if ( ! xstrlcat(date, args[j], sizeof(date)))
- return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM));
- if ( ! xstrlcat(date, " ", sizeof(date)))
- return(mdoc_err(mdoc, tok, lastarg, ERR_SYNTAX_ARGFORM));
-
- goto again;
- /* NOTREACHED */
+
+ return(mdoc_nerr(mdoc, n, "prologue repetition"));
}
-int
-macro_scoped_explicit(MACRO_PROT_ARGS)
+static int
+post_bf(POST_ARGS)
{
- int c, lastarg, j;
- struct mdoc_arg argv[MDOC_LINEARG_MAX];
- struct mdoc_node *n;
-
- if (SEC_PROLOGUE == mdoc->sec_lastn)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));
-
- /*
- * First close out the explicit scope. The `end' tags (such as
- * `.El' to `.Bl' don't cause anything to happen: we merely
- * readjust our last parse point.
- */
+ char *p;
+ struct mdoc_node *head;
- switch (tok) {
- case (MDOC_El):
- return(scope_rewind_exp(mdoc, ppos, tok, MDOC_Bl));
- case (MDOC_Ed):
- return(scope_rewind_exp(mdoc, ppos, tok, MDOC_Bd));
- default:
- break;
- }
+ if (MDOC_BLOCK != mdoc->last->type)
+ return(1);
- assert(MDOC_EXPLICIT & mdoc_macros[tok].flags);
+ head = mdoc->last->data.block.head;
- /* Token pre-processing. */
+ if (0 == mdoc->last->data.block.argc) {
+ if (NULL == head->child)
+ return(mdoc_err(mdoc, "argument expected"));
- switch (tok) {
- case (MDOC_Bl):
- /* FALLTHROUGH */
- case (MDOC_Bd):
- /* `.Pp' ignored when preceding `.Bl' or `.Bd'. */
- assert(mdoc->last);
- if (MDOC_ELEM != mdoc->last->type)
- break;
- if (MDOC_Pp != mdoc->last->data.elem.tok)
- break;
- if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_BEFORE_BLK))
- return(0);
- assert(mdoc->last->prev);
- n = mdoc->last;
- mdoc->last = mdoc->last->prev;
- mdoc->last->next = NULL;
- mdoc_node_free(n);
- break;
- default:
- break;
+ 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"));
}
- lastarg = *pos;
+ if (head->child)
+ return(mdoc_err(mdoc, "argument expected"));
- for (j = 0; j < MDOC_LINEARG_MAX; j++) {
- lastarg = *pos;
- c = mdoc_argv(mdoc, tok, &argv[j], pos, buf);
- if (0 == c)
- break;
- else if (1 == c)
- continue;
+ if (1 == mdoc->last->data.block.argc)
+ return(1);
+ return(mdoc_err(mdoc, "argument expected"));
+}
- mdoc_argv_free(j, argv);
- return(0);
- }
- if (MDOC_LINEARG_MAX == j) {
- mdoc_argv_free(j, argv);
- return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));
- }
+static int
+post_nm(POST_ARGS)
+{
- c = append_scoped(mdoc, tok, ppos, 0, NULL, j, argv);
- mdoc_argv_free(j, argv);
- return(c);
+ if (mdoc->last->child)
+ return(1);
+ if (mdoc->meta.name)
+ return(1);
+ return(mdoc_err(mdoc, "not yet invoked with name"));
}
-/*
- * Implicity-scoped macros, like `.Ss', have a scope that terminates
- * with a subsequent call to the same macro. Implicit macros cannot
- * break the scope of explicitly-scoped macros; however, they can break
- * the scope of other implicit macros (so `.Sh' can break `.Ss'). This
- * is ok with macros like `.It' because they exist only within an
- * explicit context.
- *
- * These macros put line arguments (which it's allowed to have) into the
- * HEAD section and open a BODY scope to be used until the macro scope
- * closes.
- */
-int
-macro_scoped_implicit(MACRO_PROT_ARGS)
+static int
+post_xr(POST_ARGS)
{
- int lastarg, j;
- char *args[MDOC_LINEARG_MAX];
struct mdoc_node *n;
- assert( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags));
+ 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"));
+}
- if (SEC_PROLOGUE == mdoc->sec_lastn)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));
- /* Token pre-processing. */
+static int
+post_at(POST_ARGS)
+{
- switch (tok) {
- case (MDOC_Ss):
- /* FALLTHROUGH */
- case (MDOC_Sh):
- /* `.Pp' ignored when preceding `.Ss' or `.Sh'. */
- if (NULL == mdoc->last)
- break;
- if (MDOC_ELEM != mdoc->last->type)
- break;
- if (MDOC_Pp != mdoc->last->data.elem.tok)
- break;
- if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_BEFORE_BLK))
- return(0);
- assert(mdoc->last->prev);
- n = mdoc->last;
- mdoc_msg(mdoc, ppos, "removing prior `Pp' macro");
- mdoc->last = mdoc->last->prev;
- mdoc->last->next = NULL;
- mdoc_node_free(n);
- break;
- default:
- break;
- }
+ if (NULL == mdoc->last->child)
+ return(1);
+ if (ATT_DEFAULT != mdoc_atoatt(mdoc->last->child->data.text.string))
+ return(1);
+ return(mdoc_err(mdoc, "require valid symbol"));
+}
- /* Rewind our scope. */
- if ( ! scope_rewind_imp(mdoc, ppos, tok))
- return(0);
+static int
+post_an(POST_ARGS)
+{
- j = 0;
- lastarg = ppos;
+ if (0 != mdoc->last->data.elem.argc) {
+ if (NULL == mdoc->last->child)
+ return(1);
+ return(mdoc_err(mdoc, "argument(s) expected"));
+ }
- /*
- * Process until we hit a line. Note that current implicit
- * macros don't have any arguments, so we don't need to do any
- * argument processing.
- */
+ if (mdoc->last->child)
+ return(1);
+ return(mdoc_err(mdoc, "argument(s) expected"));
+}
-again:
- if (j == MDOC_LINEARG_MAX)
- return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));
- lastarg = *pos;
+static int
+post_ex(POST_ARGS)
+{
- switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[j])) {
- case (ARGS_ERROR):
- return(0);
- case (ARGS_EOLN):
- return(append_scoped(mdoc, tok, ppos, j, _CC(args), 0, NULL));
- default:
- break;
+ if (0 == mdoc->last->data.elem.argc) {
+ if (mdoc->last->child)
+ return(1);
+ return(mdoc_err(mdoc, "argument(s) expected"));
}
+ if (mdoc->last->child)
+ return(mdoc_err(mdoc, "argument(s) expected"));
+ if (1 != mdoc->last->data.elem.argc)
+ return(mdoc_err(mdoc, "argument(s) expected"));
+ if (MDOC_Std != mdoc->last->data.elem.argv[0].arg)
+ return(mdoc_err(mdoc, "argument(s) expected"));
- if (MDOC_MAX != mdoc_find(mdoc, args[j]))
- if ( ! mdoc_warn(mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE))
- return(0);
-
- j++;
- goto again;
- /* NOTREACHED */
+ return(1);
}
-/*
- * A line-scoped macro opens a scope for the contents of its line, which
- * are placed under the HEAD node. Punctuation trailing the line is put
- * as a sibling to the HEAD node, under the BLOCK node.
- */
-int
-macro_scoped_line(MACRO_PROT_ARGS)
+static int
+post_it(POST_ARGS)
{
- int lastarg, c, j;
- char *p;
- struct mdoc_node *n;
+ int type, sv, i;
+#define TYPE_NONE (0)
+#define TYPE_BODY (1)
+#define TYPE_HEAD (2)
+#define TYPE_OHEAD (3)
+ size_t argc;
+ struct mdoc_node *n;
- if (SEC_PROLOGUE == mdoc->sec_lastn)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));
+ if (MDOC_BLOCK != mdoc->last->type)
+ return(1);
+
+ n = mdoc->last->parent->parent;
- assert(1 == ppos);
+ argc = n->data.block.argc;
+ type = TYPE_NONE;
+ sv = -1;
- /* Token pre-processing. */
-
- switch (tok) {
- case (MDOC_D1):
- /* FALLTHROUGH */
- case (MDOC_Dl):
- /* These can't be nested in a display block. */
- assert(mdoc->last);
- for (n = mdoc->last->parent ; n; n = n->parent)
- if (MDOC_BLOCK != n->type)
- continue;
- else if (MDOC_Bd == n->data.block.tok)
- break;
- if (NULL == n)
+ /* Some types require block-head, some not. */
+
+ /* LINTED */
+ for (i = 0; TYPE_NONE == type && i < (int)argc; i++)
+ switch (n->data.block.argv[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[i].arg;
break;
- return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_NONEST));
- default:
- 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[i].arg;
+ break;
+ case (MDOC_Column):
+ type = TYPE_OHEAD;
+ sv = n->data.block.argv[i].arg;
+ break;
+ default:
+ break;
+ }
- /*
- * All line-scoped macros have a HEAD and optionally a BODY
- * section. We open our scope here; when we exit this function,
- * we'll rewind our scope appropriately.
- */
+ assert(TYPE_NONE != type);
- mdoc_block_alloc(mdoc, ppos, tok, 0, NULL);
- mdoc_head_alloc(mdoc, ppos, tok, 0, NULL);
+ n = mdoc->last->data.block.head;
- /* Process line parameters. */
+ if (TYPE_HEAD == type) {
+ if (NULL == n->child)
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
+ "argument(s) suggested"))
+ return(0);
- j = 0;
- lastarg = ppos;
+ n = mdoc->last->data.block.body;
+ if (NULL == n->child)
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
+ "multiline body suggested"))
+ return(0);
-again:
- if (j == MDOC_LINEARG_MAX)
- return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));
+ } else if (TYPE_BODY == type) {
+ if (n->child)
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
+ "no argument suggested"))
+ return(0);
+
+ n = mdoc->last->data.block.body;
+ if (NULL == n->child)
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
+ "multiline body suggested"))
+ return(0);
+ } else {
+ if (NULL == n->child)
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
+ "argument(s) suggested"))
+ return(0);
+
+ n = mdoc->last->data.block.body;
+ if (n->child)
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
+ "no multiline body suggested"))
+ return(0);
+ }
- lastarg = *pos;
- c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p);
+ if (MDOC_Column != sv)
+ return(1);
- switch (c) {
- case (ARGS_ERROR):
- return(0);
- case (ARGS_WORD):
- break;
- case (ARGS_PUNCT):
- if ( ! append_delims(mdoc, tok, pos, buf))
- return(0);
- return(scope_rewind_imp(mdoc, ppos, tok));
- case (ARGS_EOLN):
- return(scope_rewind_imp(mdoc, ppos, tok));
- default:
- abort();
- /* NOTREACHED */
- }
+ argc = mdoc->last->parent->parent->data.block.argv->sz;
+ n = mdoc->last->data.block.head->child;
- if (MDOC_MAX != (c = mdoc_find(mdoc, p))) {
- if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf))
- return(0);
- if ( ! append_delims(mdoc, tok, pos, buf))
- return(0);
- return(scope_rewind_imp(mdoc, ppos, tok));
- }
+ for (i = 0; n; n = n->next)
+ i++;
- if (mdoc_isdelim(p))
- j = 0;
+ if (i == (int)argc)
+ return(1);
- mdoc_word_alloc(mdoc, lastarg, p);
- goto again;
- /* NOTREACHED */
+ return(mdoc_err(mdoc, "need %zu columns (have %d)", argc, i));
+#undef TYPE_NONE
+#undef TYPE_BODY
+#undef TYPE_HEAD
+#undef TYPE_OHEAD
}
-/*
- * Partial-line scope is identical to line scope (macro_scoped_line())
- * except that trailing punctuation is appended to the BLOCK, instead of
- * contained within the HEAD.
- */
-int
-macro_scoped_pline(MACRO_PROT_ARGS)
+static int
+post_bl(POST_ARGS)
{
- int lastarg, c, j;
- char *p;
+ struct mdoc_node *n;
- if (SEC_PROLOGUE == mdoc->sec_lastn)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));
-
- /* Token pre-processing. */
+ if (MDOC_BODY != mdoc->last->type)
+ return(1);
- switch (tok) {
- case (MDOC_Ql):
- if ( ! mdoc_warn(mdoc, tok, ppos, WARN_COMPAT_TROFF))
- return(0);
- break;
- default:
+ /* LINTED */
+ for (n = mdoc->last->child; n; n = n->next) {
+ if (MDOC_BLOCK == n->type)
+ if (MDOC_It == n->tok)
+ continue;
break;
}
- mdoc_block_alloc(mdoc, ppos, tok, 0, NULL);
- mdoc_head_alloc(mdoc, ppos, tok, 0, NULL);
-
- /* Process line parameters. */
+ if (NULL == n)
+ return(1);
- j = 0;
- lastarg = ppos;
+ return(mdoc_nerr(mdoc, n, "bad child of parent list"));
+}
-again:
- if (j == MDOC_LINEARG_MAX)
- return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));
- lastarg = *pos;
- c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p);
+static int
+ebool(struct mdoc *mdoc)
+{
+ struct mdoc_node *n;
- switch (c) {
- case (ARGS_ERROR):
- return(0);
- case (ARGS_WORD):
+ /* 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;
- case (ARGS_PUNCT):
- if ( ! scope_rewind_imp(mdoc, ppos, tok))
- return(0);
- if (ppos > 1)
- return(1);
- return(append_delims(mdoc, tok, pos, buf));
- case (ARGS_EOLN):
- return(scope_rewind_imp(mdoc, ppos, tok));
- default:
- abort();
- /* NOTREACHED */
}
- if (MDOC_MAX != (c = mdoc_find(mdoc, p))) {
- if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf))
- return(0);
- if ( ! scope_rewind_imp(mdoc, ppos, tok))
- return(0);
- if (ppos > 1)
- return(1);
- return(append_delims(mdoc, tok, pos, buf));
- }
-
- if (mdoc_isdelim(p))
- j = 0;
-
- mdoc_word_alloc(mdoc, lastarg, p);
- goto again;
- /* NOTREACHED */
+ if (NULL == n)
+ return(1);
+ return(mdoc_nerr(mdoc, n, "expected boolean"));
}
-/*
- * A delimited-constant macro is similar to a general text macro: the
- * macro is followed by a 0 or 1 arguments (possibly-unspecified) then
- * terminating punctuation, other words, or another callable macro.
- */
-int
-macro_constant_delimited(MACRO_PROT_ARGS)
+static int
+post_root(POST_ARGS)
{
- int lastarg, flushed, c, maxargs;
- char *p;
- if (SEC_PROLOGUE == mdoc->sec_lastn)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));
+ if (NULL == mdoc->first->child)
+ return(mdoc_err(mdoc, "document lacks data"));
+ if (SEC_PROLOGUE == mdoc->lastnamed)
+ return(mdoc_err(mdoc, "document lacks prologue"));
- /* Process line parameters. */
+ if (MDOC_BLOCK != mdoc->first->child->type)
+ return(mdoc_err(mdoc, "lacking post-prologue %s",
+ mdoc_macronames[MDOC_Sh]));
+ if (MDOC_Sh != mdoc->first->child->tok)
+ return(mdoc_err(mdoc, "lacking post-prologue %s",
+ mdoc_macronames[MDOC_Sh]));
- lastarg = ppos;
- flushed = 0;
+ return(1);
+}
- /* Token pre-processing. */
- switch (tok) {
- case (MDOC_Ux):
- maxargs = 0;
- break;
- default:
- maxargs = 1;
- break;
- }
+static int
+post_sh(POST_ARGS)
+{
-again:
- lastarg = *pos;
+ if (MDOC_HEAD == mdoc->last->type)
+ return(post_sh_head(mdoc));
+ if (MDOC_BODY == mdoc->last->type)
+ return(post_sh_body(mdoc));
- switch (mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p)) {
- case (ARGS_ERROR):
- return(0);
- case (ARGS_WORD):
- break;
- case (ARGS_PUNCT):
- if ( ! flushed && ! append_const(mdoc, tok, ppos, 0, &p))
- return(0);
- if (ppos > 1)
- return(1);
- return(append_delims(mdoc, tok, pos, buf));
- case (ARGS_EOLN):
- if (flushed)
- return(1);
- return(append_const(mdoc, tok, ppos, 0, &p));
- default:
- abort();
- /* NOTREACHED */
- }
+ return(1);
+}
- /* Accepts no arguments: flush out symbol and continue. */
- if (0 == maxargs) {
- if ( ! append_const(mdoc, tok, ppos, 0, &p))
- return(0);
- flushed = 1;
- }
+static int
+post_sh_body(POST_ARGS)
+{
+ struct mdoc_node *n;
- if (MDOC_MAX != (c = mdoc_find(mdoc, p))) {
- if ( ! flushed && ! append_const(mdoc, tok, ppos, 0, &p))
- return(0);
- if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf))
- return(0);
- if (ppos > 1)
- return(1);
- return(append_delims(mdoc, tok, pos, buf));
- }
+ if (SEC_NAME != mdoc->lastnamed)
+ return(1);
- /*
- * We only accept one argument; subsequent tokens are considered
- * as literal words (until a macro).
+ /*
+ * 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 ( ! flushed && ! mdoc_isdelim(p)) {
- if ( ! append_const(mdoc, tok, ppos, 1, &p))
- return(0);
- flushed = 1;
- goto again;
- } else if ( ! flushed) {
- if ( ! append_const(mdoc, tok, ppos, 0, &p))
+ if (NULL == (n = mdoc->last->child))
+ return(mdoc_warn(mdoc, WARN_SYNTAX,
+ "section should have %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_SYNTAX,
+ "section should have %s first",
+ mdoc_macronames[MDOC_Nm])))
return(0);
- flushed = 1;
}
- mdoc_word_alloc(mdoc, lastarg, p);
- goto again;
- /* NOTREACHED */
+ if (MDOC_ELEM == n->type && MDOC_Nd == n->tok)
+ return(1);
+
+ return(mdoc_warn(mdoc, WARN_SYNTAX,
+ "section should have %s last",
+ mdoc_macronames[MDOC_Nd]));
}
-int
-macro_constant(MACRO_PROT_ARGS)
+static int
+post_sh_head(POST_ARGS)
{
- int lastarg, j;
- char *args[MDOC_LINEARG_MAX];
-
- if (SEC_PROLOGUE == mdoc->sec_lastn)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));
+ char buf[64];
+ enum mdoc_sec sec;
- j = 0;
- lastarg = ppos;
+ assert(MDOC_Sh == mdoc->last->tok);
-again:
- if (j == MDOC_LINEARG_MAX)
- return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));
+ if ( ! xstrlcats(buf, mdoc->last->child, sizeof(buf)))
+ return(mdoc_err(mdoc, "argument too long"));
- lastarg = *pos;
+ sec = mdoc_atosec(buf);
- switch (mdoc_args(mdoc, tok, pos, buf, 0, &args[j])) {
- case (ARGS_ERROR):
- return(0);
- case (ARGS_WORD):
- break;
- case (ARGS_EOLN):
- return(append_const(mdoc, tok, ppos, j, args));
- default:
- abort();
- /* NOTREACHED */
- }
-
- if (MDOC_MAX != mdoc_find(mdoc, args[j]))
- if ( ! mdoc_warn(mdoc, tok, lastarg, WARN_SYNTAX_MACLIKE))
- return(0);
+ 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);
+ 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"));
- j++;
- goto again;
- /* NOTREACHED */
+ return(1);
}
-int
-macro_constant_argv(MACRO_PROT_ARGS)
+static int
+post_fd(POST_ARGS)
{
- int c, lastarg, j;
- struct mdoc_arg argv[MDOC_LINEARG_MAX];
-
- if (SEC_PROLOGUE == mdoc->sec_lastn)
- return(mdoc_err(mdoc, tok, ppos, ERR_SEC_PROLOGUE));
-
- lastarg = *pos;
-
- for (j = 0; j < MDOC_LINEARG_MAX; j++) {
- lastarg = *pos;
- c = mdoc_argv(mdoc, tok, &argv[j], pos, buf);
- if (0 == c)
- break;
- else if (1 == c)
- continue;
-
- mdoc_argv_free(j, argv);
- return(0);
- }
- if (MDOC_LINEARG_MAX == j) {
- mdoc_argv_free(j, argv);
- return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY));
- }
-
- c = append_constarg(mdoc, tok, ppos, j, argv);
- mdoc_argv_free(j, argv);
- return(c);
+ if (SEC_SYNOPSIS == mdoc->last->sec)
+ return(1);
+ return(mdoc_warn(mdoc, WARN_COMPAT,
+ "suggested only in section SYNOPSIS"));
}
git.ckatri.com / mandoc.git / blobdiff