-/* $Id: macro.c,v 1.42 2009/01/19 17:02:58 kristaps Exp $ */
+/* $Id: macro.c,v 1.57 2009/03/06 14:13:47 kristaps Exp $ */
/*
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
*
#include <time.h>
#endif
+/*
+ * This has scanning/parsing routines, each of which extract a macro and
+ * its arguments and parameters, then know how to progress to the next
+ * macro.
+ */
+
+/*
+ * FIXME: don't use static mdoc_argv values, as they require us to do a
+ * complicated copy-over when actually assigning them to dynamic memory.
+ */
+
#include "private.h"
-/* FIXME: maxlineargs should be per LINE, no per TOKEN. */
+static int macro_obsolete(MACRO_PROT_ARGS);
+static int macro_constant(MACRO_PROT_ARGS);
+static int macro_constant_scoped(MACRO_PROT_ARGS);
+static int macro_constant_delimited(MACRO_PROT_ARGS);
+static int macro_text(MACRO_PROT_ARGS);
+static int macro_scoped(MACRO_PROT_ARGS);
+static int macro_scoped_close(MACRO_PROT_ARGS);
+static int macro_scoped_line(MACRO_PROT_ARGS);
-static int rewind_alt(int);
-static int rewind_dohalt(int, enum mdoc_type,
- const struct mdoc_node *);
#define REWIND_REWIND (1 << 0)
#define REWIND_NOHALT (1 << 1)
#define REWIND_HALT (1 << 2)
-static int rewind_dobreak(int, const struct mdoc_node *);
-
+static int rewind_dohalt(int, enum mdoc_type,
+ const struct mdoc_node *);
+static int rewind_alt(int);
+static int rewind_dobreak(int, const struct mdoc_node *);
static int rewind_elem(struct mdoc *, int);
static int rewind_impblock(struct mdoc *, int, int, int);
static int rewind_expblock(struct mdoc *, int, int, int);
static int rewind_last(struct mdoc *, struct mdoc_node *);
static int append_delims(struct mdoc *, int, int *, char *);
static int lookup(struct mdoc *, int, int, int, const char *);
+static int pwarn(struct mdoc *, int, int, int);
+static int perr(struct mdoc *, int, int, int);
+
+#define WMACPARM (1)
+#define WOBS (2)
+
+#define ENOCTX (1)
+#define ENOPARMS (2)
+#define EARGVLIM (3)
+
+/* Central table of library: who gets parsed how. */
+
+const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
+ { NULL, 0 }, /* \" */
+ { macro_constant, MDOC_PROLOGUE }, /* Dd */
+ { macro_constant, MDOC_PROLOGUE }, /* Dt */
+ { macro_constant, MDOC_PROLOGUE }, /* Os */
+ { macro_scoped, 0 }, /* Sh */
+ { macro_scoped, 0 }, /* Ss */
+ { macro_text, 0 }, /* Pp */
+ { macro_scoped_line, MDOC_PARSED }, /* D1 */
+ { macro_scoped_line, MDOC_PARSED }, /* Dl */
+ { macro_scoped, MDOC_EXPLICIT }, /* Bd */
+ { macro_scoped_close, MDOC_EXPLICIT }, /* Ed */
+ { macro_scoped, MDOC_EXPLICIT }, /* Bl */
+ { macro_scoped_close, MDOC_EXPLICIT }, /* El */
+ { macro_scoped, MDOC_PARSED }, /* It */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */
+ { macro_text, MDOC_PARSED }, /* An */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
+ { macro_constant, 0 }, /* Cd */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Er */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */
+ { macro_constant, 0 }, /* Ex */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fa */
+ { macro_constant, 0 }, /* Fd */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */
+ { macro_text, MDOC_PARSED }, /* Ft */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */
+ { macro_constant, 0 }, /* In */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Li */
+ { macro_constant, 0 }, /* Nd */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */
+ { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Op */
+ { macro_obsolete, 0 }, /* Ot */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */
+ { macro_constant, 0 }, /* Rv */
+ /* XXX - .St supposed to be (but isn't) callable. */
+ { macro_constant_delimited, MDOC_PARSED }, /* St */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Va */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */
+ { macro_constant, 0 }, /* %A */
+ { macro_constant, 0 }, /* %B */
+ { macro_constant, 0 }, /* %D */
+ { macro_constant, 0 }, /* %I */
+ { macro_constant, 0 }, /* %J */
+ { macro_constant, 0 }, /* %N */
+ { macro_constant, 0 }, /* %O */
+ { macro_constant, 0 }, /* %P */
+ { macro_constant, 0 }, /* %R */
+ { macro_constant, 0 }, /* %T */
+ { macro_constant, 0 }, /* %V */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ac */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ao */
+ { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */
+ { macro_constant_delimited, 0 }, /* At */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Bc */
+ { macro_scoped, MDOC_EXPLICIT }, /* Bf */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bo */
+ { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Bq */
+ { macro_constant_delimited, MDOC_PARSED }, /* Bsx */
+ { macro_constant_delimited, MDOC_PARSED }, /* Bx */
+ { macro_constant, 0 }, /* Db */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Dc */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Do */
+ { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dq */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ec */
+ { macro_scoped_close, MDOC_EXPLICIT }, /* Ef */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Em */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */
+ { macro_constant_delimited, MDOC_PARSED }, /* Fx */
+ { macro_text, MDOC_PARSED }, /* Ms */
+ { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* No */
+ { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */
+ { macro_constant_delimited, MDOC_PARSED }, /* Nx */
+ { macro_constant_delimited, MDOC_PARSED }, /* Ox */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */
+ { macro_constant_delimited, MDOC_PARSED }, /* Pf */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Po */
+ { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Qc */
+ { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ql */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Qo */
+ { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Qq */
+ { macro_scoped_close, MDOC_EXPLICIT }, /* Re */
+ { macro_scoped, MDOC_EXPLICIT }, /* Rs */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Sc */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* So */
+ { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sq */
+ { macro_constant, 0 }, /* Sm */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sx */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sy */
+ { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */
+ { macro_constant_delimited, MDOC_PARSED }, /* Ux */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */
+ /* XXX - .Fo supposed to be (but isn't) callable. */
+ { macro_scoped, MDOC_EXPLICIT }, /* Fo */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Fc */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Oo */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Oc */
+ { macro_scoped, MDOC_EXPLICIT }, /* Bk */
+ { macro_scoped_close, MDOC_EXPLICIT }, /* Ek */
+ { macro_constant, 0 }, /* Bt */
+ { macro_constant, 0 }, /* Hf */
+ { macro_obsolete, 0 }, /* Fr */
+ { macro_constant, 0 }, /* Ud */
+ { macro_constant, 0 }, /* Lb */
+};
+
+const struct mdoc_macro * const mdoc_macros = __mdoc_macros;
+
+
+static int
+perr(struct mdoc *mdoc, int line, int pos, int type)
+{
+ int c;
+
+ switch (type) {
+ case (ENOCTX):
+ c = mdoc_perr(mdoc, line, pos,
+ "closing macro has prior context");
+ break;
+ case (ENOPARMS):
+ c = mdoc_perr(mdoc, line, pos,
+ "macro doesn't expect parameters");
+ break;
+ case (EARGVLIM):
+ c = mdoc_perr(mdoc, line, pos,
+ "argument hard-limit %d reached",
+ MDOC_LINEARG_MAX);
+ break;
+ default:
+ abort();
+ /* NOTREACHED */
+ }
+ return(c);
+}
+
+static int
+pwarn(struct mdoc *mdoc, int line, int pos, int type)
+{
+ int c;
+
+ switch (type) {
+ case (WMACPARM):
+ c = mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX,
+ "macro-like parameter");
+ break;
+ case (WOBS):
+ c = mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX,
+ "macro is marked obsolete");
+ break;
+ default:
+ abort();
+ /* NOTREACHED */
+ }
+ return(c);
+}
static int
return(res);
if (MDOC_MAX == res)
return(res);
- if ( ! mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, "macro-like parameter"))
+ if ( ! pwarn(mdoc, line, pos, WMACPARM))
return(-1);
return(MDOC_MAX);
}
assert(to);
mdoc->next = MDOC_NEXT_SIBLING;
+ /* LINTED */
while (mdoc->last != to) {
if ( ! mdoc_valid_post(mdoc))
return(0);
case (MDOC_Qq):
/* FALLTHROUGH */
case (MDOC_Sq):
- assert(MDOC_BODY != type);
+ assert(MDOC_HEAD != type);
assert(MDOC_TAIL != type);
if (type == p->type && tok == p->tok)
return(REWIND_REWIND);
break;
else if (rewind_dobreak(tok, n))
continue;
- return(mdoc_perr(mdoc, line, ppos, "scope breaks prior %s", mdoc_node2a(n)));
+ return(mdoc_perr(mdoc, line, ppos,
+ "scope breaks %s", MDOC_ROOT == n->type ?
+ "<root>" : mdoc_macronames[n->tok]));
}
assert(n);
for (n = mdoc->last; n; n = n->parent) {
c = rewind_dohalt(tok, MDOC_BLOCK, n);
if (REWIND_HALT == c)
- return(mdoc_perr(mdoc, line, ppos, "closing macro has no context"));
+ return(perr(mdoc, line, ppos, ENOCTX));
if (REWIND_REWIND == c)
break;
else if (rewind_dobreak(tok, n))
continue;
- return(mdoc_perr(mdoc, line, ppos, "scope breaks prior %s", mdoc_node2a(n)));
+ return(mdoc_perr(mdoc, line, ppos,
+ "scope breaks %s", MDOC_ROOT == n->type ?
+ "<root>" : mdoc_macronames[n->tok]));
}
assert(n);
break;
else if (rewind_dobreak(tok, n))
continue;
- return(mdoc_perr(mdoc, line, ppos, "scope breaks prior %s", mdoc_node2a(n)));
+ return(mdoc_perr(mdoc, line, ppos,
+ "scope breaks %s", MDOC_ROOT == n->type ?
+ "<root>" : mdoc_macronames[n->tok]));
}
assert(n);
for (;;) {
lastarg = *pos;
c = mdoc_args(mdoc, line, pos, buf, 0, &p);
+ assert(ARGS_PHRASE != c);
+
if (ARGS_ERROR == c)
return(0);
else if (ARGS_EOLN == c)
}
-int
+/*
+ * Close out an explicit scope. This optionally parses a TAIL type with
+ * a set number of TEXT children.
+ */
+static int
macro_scoped_close(MACRO_PROT_ARGS)
{
int tt, j, c, lastarg, maxargs, flushed;
if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {
if (0 == buf[*pos]) {
- if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
+ if ( ! rewind_subblock(MDOC_BODY, mdoc,
+ tok, line, ppos))
return(0);
return(rewind_expblock(mdoc, tok, line, ppos));
}
- return(mdoc_perr(mdoc, line, ppos, "macro expects no parameters"));
+ return(perr(mdoc, line, ppos, ENOPARMS));
}
if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
flushed = 1;
}
- c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p);
+ c = mdoc_args(mdoc, line, pos, buf, tok, &p);
+ assert(ARGS_PHRASE != c);
+
if (ARGS_ERROR == c)
return(0);
if (ARGS_PUNCT == c)
return(0);
else if (MDOC_MAX != c) {
if ( ! flushed) {
- if ( ! rewind_expblock(mdoc, tok, line, ppos))
+ if ( ! rewind_expblock(mdoc, tok,
+ line, ppos))
return(0);
flushed = 1;
}
}
-int
+/*
+ * A general text macro. This is a complex case because of punctuation.
+ * If a text macro is followed by words, then punctuation, the macro is
+ * "stopped" and "reopened" following the punctuation. Thus, the
+ * following arises:
+ *
+ * .Fl a ; b
+ *
+ * ELEMENT (.Fl)
+ * TEXT (`a')
+ * TEXT (`;')
+ * ELEMENT (.Fl)
+ * TEXT (`b')
+ *
+ * This must handle the following situations:
+ *
+ * .Fl Ar b ; ;
+ *
+ * ELEMENT (.Fl)
+ * ELEMENT (.Ar)
+ * TEXT (`b')
+ * TEXT (`;')
+ * TEXT (`;')
+ */
+static int
macro_text(MACRO_PROT_ARGS)
{
- int la, lastpunct, c, fl, argc;
+ int la, lastpunct, c, w, argc;
struct mdoc_arg argv[MDOC_LINEARG_MAX];
char *p;
if (MDOC_LINEARG_MAX == argc) {
mdoc_argv_free(argc - 1, argv);
- return(mdoc_perr(mdoc, line, ppos, "parameter hard-limit exceeded"));
+ return(perr(mdoc, line, ppos, EARGVLIM));
}
- c = mdoc_elem_alloc(mdoc, line, ppos, tok, argc, argv);
+ c = mdoc_elem_alloc(mdoc, line, ppos,
+ tok, (size_t)argc, argv);
if (0 == c) {
mdoc_argv_free(argc, argv);
mdoc->next = MDOC_NEXT_CHILD;
- fl = ARGS_DELIM;
- if (MDOC_QUOTABLE & mdoc_macros[tok].flags)
- fl |= ARGS_QUOTED;
-
lastpunct = 0;
for (;;) {
la = *pos;
- c = mdoc_args(mdoc, line, pos, buf, fl, &p);
- if (ARGS_ERROR == c) {
+ w = mdoc_args(mdoc, line, pos, buf, tok, &p);
+ assert(ARGS_PHRASE != c);
+
+ if (ARGS_ERROR == w) {
mdoc_argv_free(argc, argv);
return(0);
}
- if (ARGS_EOLN == c)
+ if (ARGS_EOLN == w)
break;
- if (ARGS_PUNCT == c)
+ if (ARGS_PUNCT == w)
break;
- if (-1 == (c = lookup(mdoc, line, la, tok, p)))
- return(0);
- else if (MDOC_MAX != c) {
+ c = ARGS_QWORD == w ? MDOC_MAX :
+ lookup(mdoc, line, la, tok, p);
+
+ if (MDOC_MAX != c && -1 != c) {
if (0 == lastpunct && ! rewind_elem(mdoc, tok)) {
mdoc_argv_free(argc, argv);
return(0);
}
mdoc_argv_free(argc, argv);
-
c = mdoc_macro(mdoc, c, line, la, pos, buf);
if (0 == c)
return(0);
if (ppos > 1)
return(1);
return(append_delims(mdoc, line, pos, buf));
+ } else if (-1 == c) {
+ mdoc_argv_free(argc, argv);
+ return(0);
}
- if (mdoc_isdelim(p)) {
+ /* FIXME: .Fl and .Ar handling of `|'. */
+
+ if (ARGS_QWORD != w && mdoc_isdelim(p)) {
if (0 == lastpunct && ! rewind_elem(mdoc, tok)) {
mdoc_argv_free(argc, argv);
return(0);
}
lastpunct = 1;
} else if (lastpunct) {
- c = mdoc_elem_alloc(mdoc, line,
- ppos, tok, argc, argv);
+ c = mdoc_elem_alloc(mdoc, line, ppos,
+ tok, (size_t)argc, argv);
if (0 == c) {
mdoc_argv_free(argc, argv);
return(0);
}
-int
+/*
+ * Handle explicit-scope (having a different closure token) and implicit
+ * scope (closing out prior scopes when re-invoked) macros. These
+ * constitute the BLOCK type and usually span multiple lines. These
+ * always have HEAD and sometimes have BODY types. In the multi-line
+ * case:
+ *
+ * .Bd -ragged
+ * Text.
+ * .Fl macro
+ * Another.
+ * .Ed
+ *
+ * BLOCK (.Bd)
+ * HEAD
+ * BODY
+ * TEXT (`Text.')
+ * ELEMENT (.Fl)
+ * TEXT (`macro')
+ * TEXT (`Another.')
+ *
+ * Note that the `.It' macro, possibly the most difficult (as it has
+ * embedded scope, etc.) is handled by this routine.
+ */
+static int
macro_scoped(MACRO_PROT_ARGS)
{
- int c, lastarg, argc, fl;
+ int c, lastarg, argc;
struct mdoc_arg argv[MDOC_LINEARG_MAX];
char *p;
assert ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags));
+ /* First rewind extant implicit scope. */
+
if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) {
if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
return(0);
return(0);
}
+ /* Parse arguments. */
+
for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {
lastarg = *pos;
c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
if (MDOC_LINEARG_MAX == argc) {
mdoc_argv_free(argc - 1, argv);
- return(mdoc_perr(mdoc, line, ppos, "parameter hard-limit exceeded"));
+ return(perr(mdoc, line, ppos, EARGVLIM));
}
c = mdoc_block_alloc(mdoc, line, ppos,
if (0 == buf[*pos]) {
if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
return(0);
- if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
+ if ( ! rewind_subblock(MDOC_HEAD, mdoc,
+ tok, line, ppos))
return(0);
if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
return(0);
return(0);
mdoc->next = MDOC_NEXT_CHILD;
- fl = ARGS_DELIM;
- if (MDOC_TABSEP & mdoc_macros[tok].flags)
- fl |= ARGS_TABSEP;
-
for (;;) {
lastarg = *pos;
- c = mdoc_args(mdoc, line, pos, buf, fl, &p);
-
+ c = mdoc_args(mdoc, line, pos, buf, tok, &p);
+
if (ARGS_ERROR == c)
return(0);
- if (ARGS_PUNCT == c)
- break;
if (ARGS_EOLN == c)
break;
+ if (ARGS_PHRASE == c) {
+ /*
+ if ( ! mdoc_phrase(mdoc, line, lastarg, buf))
+ return(0);
+ */
+ continue;
+ }
+
+ /* FIXME: if .It -column, the lookup must be for a
+ * sub-line component. BLAH. */
if (-1 == (c = lookup(mdoc, line, lastarg, tok, p)))
return(0);
- else if (MDOC_MAX == c) {
+
+ if (MDOC_MAX == c) {
if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
return(0);
mdoc->next = MDOC_NEXT_SIBLING;
return(0);
break;
}
-
- if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
- return(0);
+
if (1 == ppos && ! append_delims(mdoc, line, pos, buf))
return(0);
+ if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
+ return(0);
if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
return(0);
}
-int
+/*
+ * This handles a case of implicitly-scoped macro (BLOCK) limited to a
+ * single line. Instead of being closed out by a subsequent call to
+ * another macro, the scope is closed at the end of line. These don't
+ * have BODY or TAIL types. Notice that the punctuation falls outside
+ * of the HEAD type.
+ *
+ * .Qq a Fl b Ar d ; ;
+ *
+ * BLOCK (Qq)
+ * HEAD
+ * TEXT (`a')
+ * ELEMENT (.Fl)
+ * TEXT (`b')
+ * ELEMENT (.Ar)
+ * TEXT (`d')
+ * TEXT (`;')
+ * TEXT (`;')
+ */
+static int
macro_scoped_line(MACRO_PROT_ARGS)
{
int lastarg, c;
if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
return(0);
+ mdoc->next = MDOC_NEXT_SIBLING;
+ if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
+ return(0);
mdoc->next = MDOC_NEXT_CHILD;
/* XXX - no known argument macros. */
lastarg = ppos;
for (;;) {
lastarg = *pos;
- c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p);
+ c = mdoc_args(mdoc, line, pos, buf, tok, &p);
+ assert(ARGS_PHRASE != c);
if (ARGS_ERROR == c)
return(0);
}
if (1 == ppos) {
- if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
+ if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
return(0);
if ( ! append_delims(mdoc, line, pos, buf))
return(0);
- } else if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
+ } else if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
return(0);
return(rewind_impblock(mdoc, tok, line, ppos));
}
-int
+/*
+ * A constant-scoped macro is like a simple-scoped macro (mdoc_scoped)
+ * except that it doesn't handle implicit scopes and explicit ones have
+ * a fixed number of TEXT children to the BODY.
+ *
+ * .Fl a So b Sc ;
+ *
+ * ELEMENT (.Fl)
+ * TEXT (`a')
+ * BLOCK (.So)
+ * HEAD
+ * BODY
+ * TEXT (`b')
+ * TEXT (';')
+ */
+static int
macro_constant_scoped(MACRO_PROT_ARGS)
{
int lastarg, flushed, j, c, maxargs;
mdoc->next = MDOC_NEXT_CHILD;
}
- c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p);
+ c = mdoc_args(mdoc, line, pos, buf, tok, &p);
+ assert(ARGS_PHRASE != c);
+
if (ARGS_ERROR == c)
return(0);
if (ARGS_PUNCT == c)
return(0);
else if (MDOC_MAX != c) {
if ( ! flushed) {
- if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
+ if ( ! rewind_subblock(MDOC_HEAD, mdoc,
+ tok, line, ppos))
return(0);
flushed = 1;
- if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
+ if ( ! mdoc_body_alloc(mdoc, line,
+ ppos, tok))
return(0);
mdoc->next = MDOC_NEXT_CHILD;
}
- if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf))
+ if ( ! mdoc_macro(mdoc, c, line, lastarg,
+ pos, buf))
return(0);
break;
}
if ( ! flushed && mdoc_isdelim(p)) {
- if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
+ if ( ! rewind_subblock(MDOC_HEAD, mdoc,
+ tok, line, ppos))
return(0);
flushed = 1;
if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
}
-int
+/*
+ * A delimited constant is very similar to the macros parsed by
+ * macro_text except that, in the event of punctuation, the macro isn't
+ * "re-opened" as it is in macro_text. Also, these macros have a fixed
+ * number of parameters.
+ *
+ * .Fl a No b
+ *
+ * ELEMENT (.Fl)
+ * TEXT (`a')
+ * ELEMENT (.No)
+ * TEXT (`b')
+ */
+static int
macro_constant_delimited(MACRO_PROT_ARGS)
{
- int lastarg, flushed, j, c, maxargs, argc;
+ int lastarg, flushed, j, c, maxargs, argc,
+ igndelim, ignargs;
struct mdoc_arg argv[MDOC_LINEARG_MAX];
char *p;
lastarg = ppos;
flushed = 0;
+
+ /*
+ * Maximum arguments per macro. Some of these have none and
+ * exit as soon as they're parsed.
+ */
+
switch (tok) {
case (MDOC_No):
/* FALLTHROUGH */
case (MDOC_Ns):
/* FALLTHROUGH */
- case (MDOC_Pf):
- /* FALLTHROUGH */
case (MDOC_Ux):
- /* FALLTHROUGH */
- case (MDOC_St):
maxargs = 0;
break;
default:
break;
}
- for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {
- lastarg = *pos;
- c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
- if (ARGV_EOLN == c)
- break;
- if (ARGV_WORD == c) {
- *pos = lastarg;
- break;
- } else if (ARGV_ARG == c)
- continue;
- mdoc_argv_free(argc, argv);
- return(0);
+ /*
+ * Whether to ignore delimiter characters. `Pf' accepts its
+ * first token as a parameter no matter what it looks like (if
+ * it's text).
+ */
+
+ switch (tok) {
+ case (MDOC_Pf):
+ igndelim = 1;
+ break;
+ default:
+ igndelim = 0;
+ break;
}
+ /*
+ * Whether to ignore arguments: `St', for example, handles its
+ * argument-like parameters as regular parameters.
+ */
+
+ switch (tok) {
+ case (MDOC_St):
+ ignargs = 1;
+ break;
+ default:
+ ignargs = 0;
+ break;
+ }
+
+ argc = 0;
+
+ if ( ! ignargs)
+ for ( ; argc < MDOC_LINEARG_MAX; argc++) {
+ lastarg = *pos;
+ c = mdoc_argv(mdoc, line, tok,
+ &argv[argc], pos, buf);
+ if (ARGV_EOLN == c)
+ break;
+ if (ARGV_WORD == c) {
+ *pos = lastarg;
+ break;
+ } else if (ARGV_ARG == c)
+ continue;
+ mdoc_argv_free(argc, argv);
+ return(0);
+ }
+
if (MDOC_LINEARG_MAX == argc) {
mdoc_argv_free(argc - 1, argv);
- return(mdoc_perr(mdoc, line, ppos, "parameter hard-limit exceeded"));
+ return(perr(mdoc, line, ppos, EARGVLIM));
}
- c = mdoc_elem_alloc(mdoc, line, ppos, tok, argc, argv);
+ c = mdoc_elem_alloc(mdoc, line, ppos,
+ tok, (size_t)argc, argv);
+
mdoc_argv_free(argc, argv);
if (0 == c)
flushed = 1;
}
- c = mdoc_args(mdoc, line, pos, buf, ARGS_DELIM, &p);
+ c = mdoc_args(mdoc, line, pos, buf, tok, &p);
+ assert(ARGS_PHRASE != c);
+
if (ARGS_ERROR == c)
return(0);
if (ARGS_PUNCT == c)
break;
}
- if ( ! flushed && mdoc_isdelim(p)) {
+ if ( ! flushed && mdoc_isdelim(p) && ! igndelim) {
if ( ! rewind_elem(mdoc, tok))
return(0);
flushed = 1;
}
-int
+/*
+ * A constant macro is the simplest classification. It spans an entire
+ * line.
+ */
+static int
macro_constant(MACRO_PROT_ARGS)
{
- int c, lastarg, argc, fl;
- struct mdoc_arg argv[MDOC_LINEARG_MAX];
- char *p;
+ int c, w, la, argc;
+ struct mdoc_arg argv[MDOC_LINEARG_MAX];
+ char *p;
- fl = 0;
- if (MDOC_QUOTABLE & mdoc_macros[tok].flags)
- fl = ARGS_QUOTED;
+ assert( ! (MDOC_CALLABLE & mdoc_macros[tok].flags));
for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) {
- lastarg = *pos;
+ la = *pos;
c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf);
if (ARGV_EOLN == c)
break;
if (ARGV_WORD == c) {
- *pos = lastarg;
+ *pos = la;
break;
} else if (ARGV_ARG == c)
continue;
if (MDOC_LINEARG_MAX == argc) {
mdoc_argv_free(argc - 1, argv);
- return(mdoc_perr(mdoc, line, ppos, "parameter hard-limit exceeded"));
+ return(perr(mdoc, line, ppos, EARGVLIM));
}
- c = mdoc_elem_alloc(mdoc, line, ppos, tok, argc, argv);
+ c = mdoc_elem_alloc(mdoc, line, ppos,
+ tok, (size_t)argc, argv);
+
mdoc_argv_free(argc, argv);
if (0 == c)
mdoc->next = MDOC_NEXT_CHILD;
for (;;) {
- lastarg = *pos;
- c = mdoc_args(mdoc, line, pos, buf, fl, &p);
- if (ARGS_ERROR == c)
+ la = *pos;
+ w = mdoc_args(mdoc, line, pos, buf, tok, &p);
+ assert(ARGS_PHRASE != c);
+
+ if (ARGS_ERROR == w)
return(0);
- if (ARGS_EOLN == c)
+ if (ARGS_EOLN == w)
break;
- if (-1 == (c = lookup(mdoc, line, lastarg, tok, p)))
- return(0);
- else if (MDOC_MAX != c) {
+ c = ARGS_QWORD == w ? MDOC_MAX :
+ lookup(mdoc, line, la, tok, p);
+
+ if (MDOC_MAX != c && -1 != c) {
if ( ! rewind_elem(mdoc, tok))
return(0);
- return(mdoc_macro(mdoc, c, line,
- lastarg, pos, buf));
- }
+ return(mdoc_macro(mdoc, c, line, la, pos, buf));
+ } else if (-1 == c)
+ return(0);
- if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
+ if ( ! mdoc_word_alloc(mdoc, line, la, p))
return(0);
mdoc->next = MDOC_NEXT_SIBLING;
}
/* ARGSUSED */
-int
+static int
macro_obsolete(MACRO_PROT_ARGS)
{
- return(mdoc_pwarn(mdoc, line, ppos, WARN_SYNTAX, "macro is obsolete"));
+ return(pwarn(mdoc, line, ppos, WOBS));
}
+/*
+ * This is called at the end of parsing. It must traverse up the tree,
+ * closing out open [implicit] scopes. Obviously, open explicit scopes
+ * are errors.
+ */
int
macro_end(struct mdoc *mdoc)
{
continue;
if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags))
continue;
- mdoc_nerr(mdoc, n, "macro scope still open on exit");
- return(0);
+ return(mdoc_nerr(mdoc, n,
+ "macro scope still open on exit"));
}
return(rewind_last(mdoc, mdoc->first));
git.ckatri.com / mandoc.git / blobdiff