-/* $Id: macro.c,v 1.1 2008/12/12 10:11:10 kristaps Exp $ */
+/* $Id: macro.c,v 1.58 2009/03/08 11:41:22 kristaps Exp $ */
/*
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
*
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
+#include <assert.h>
+#include <ctype.h>
#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#ifdef __linux__
+#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.
+ */
+
+#include "private.h"
+
+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);
+
+#define REWIND_REWIND (1 << 0)
+#define REWIND_NOHALT (1 << 1)
+#define REWIND_HALT (1 << 2)
+
+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_subblock(enum mdoc_type,
+ 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)
+
+/* 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;
-#include "roff.h"
static int
-macro_args_next(struct rofftree *tree, int *pos, char *buf, char **v)
+perr(struct mdoc *mdoc, int line, int pos, int type)
{
- int i;
+ int c;
- if (0 == buf[*pos])
- return(0);
+ 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;
+ default:
+ abort();
+ /* NOTREACHED */
+ }
+ return(c);
+}
- if ('\"' == buf[*pos]) {
- /* Syntax error: quotation marks not allowed. */
- return(-1);
+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);
+}
- *v = &buf[*pos];
- while (buf[*pos] && ! isspace(buf[*pos]))
- (*pos)++;
+static int
+lookup(struct mdoc *mdoc, int line, int pos, int from, const char *p)
+{
+ int res;
- if (buf[*pos + 1] && '\\' == buf[*pos]) {
- /* Syntax error: escaped whitespace not allowed. */
+ res = mdoc_tokhash_find(mdoc->htab, p);
+ if (MDOC_PARSED & mdoc_macros[from].flags)
+ return(res);
+ if (MDOC_MAX == res)
+ return(res);
+ if ( ! pwarn(mdoc, line, pos, WMACPARM))
return(-1);
+ return(MDOC_MAX);
+}
+
+
+static int
+rewind_last(struct mdoc *mdoc, struct mdoc_node *to)
+{
+
+ assert(to);
+ mdoc->next = MDOC_NEXT_SIBLING;
+
+ /* LINTED */
+ while (mdoc->last != to) {
+ if ( ! mdoc_valid_post(mdoc))
+ return(0);
+ if ( ! mdoc_action_post(mdoc))
+ return(0);
+ mdoc->last = mdoc->last->parent;
+ assert(mdoc->last);
+ }
+
+ if ( ! mdoc_valid_post(mdoc))
+ return(0);
+ return(mdoc_action_post(mdoc));
+}
+
+
+static int
+rewind_alt(int tok)
+{
+ switch (tok) {
+ case (MDOC_Ac):
+ return(MDOC_Ao);
+ case (MDOC_Bc):
+ return(MDOC_Bo);
+ case (MDOC_Dc):
+ return(MDOC_Do);
+ case (MDOC_Ec):
+ return(MDOC_Eo);
+ case (MDOC_Ed):
+ return(MDOC_Bd);
+ case (MDOC_Ef):
+ return(MDOC_Bf);
+ case (MDOC_Ek):
+ return(MDOC_Bk);
+ case (MDOC_El):
+ return(MDOC_Bl);
+ case (MDOC_Fc):
+ return(MDOC_Fo);
+ case (MDOC_Oc):
+ return(MDOC_Oo);
+ case (MDOC_Pc):
+ return(MDOC_Po);
+ case (MDOC_Qc):
+ return(MDOC_Qo);
+ case (MDOC_Re):
+ return(MDOC_Rs);
+ case (MDOC_Sc):
+ return(MDOC_So);
+ case (MDOC_Xc):
+ return(MDOC_Xo);
+ default:
+ break;
+ }
+ abort();
+ /* NOTREACHED */
+}
+
+
+static int
+rewind_dohalt(int tok, enum mdoc_type type, const struct mdoc_node *p)
+{
+
+ if (MDOC_ROOT == p->type)
+ return(REWIND_HALT);
+ if (MDOC_VALID & p->flags)
+ return(REWIND_NOHALT);
+
+ switch (tok) {
+ /* One-liner implicit-scope. */
+ case (MDOC_Aq):
+ /* FALLTHROUGH */
+ case (MDOC_Bq):
+ /* FALLTHROUGH */
+ case (MDOC_D1):
+ /* FALLTHROUGH */
+ case (MDOC_Dl):
+ /* FALLTHROUGH */
+ case (MDOC_Dq):
+ /* FALLTHROUGH */
+ case (MDOC_Op):
+ /* FALLTHROUGH */
+ case (MDOC_Pq):
+ /* FALLTHROUGH */
+ case (MDOC_Ql):
+ /* FALLTHROUGH */
+ case (MDOC_Qq):
+ /* FALLTHROUGH */
+ case (MDOC_Sq):
+ assert(MDOC_HEAD != type);
+ assert(MDOC_TAIL != type);
+ if (type == p->type && tok == p->tok)
+ return(REWIND_REWIND);
+ break;
+
+ /* Multi-line implicit-scope. */
+ case (MDOC_It):
+ assert(MDOC_TAIL != type);
+ if (type == p->type && tok == p->tok)
+ return(REWIND_REWIND);
+ if (MDOC_BODY == p->type && MDOC_Bl == p->tok)
+ return(REWIND_HALT);
+ break;
+ case (MDOC_Sh):
+ if (type == p->type && tok == p->tok)
+ return(REWIND_REWIND);
+ break;
+ case (MDOC_Ss):
+ assert(MDOC_TAIL != type);
+ if (type == p->type && tok == p->tok)
+ return(REWIND_REWIND);
+ if (MDOC_BODY == p->type && MDOC_Sh == p->tok)
+ return(REWIND_HALT);
+ break;
+
+ /* Multi-line explicit scope start. */
+ case (MDOC_Ao):
+ /* FALLTHROUGH */
+ case (MDOC_Bd):
+ /* FALLTHROUGH */
+ case (MDOC_Bf):
+ /* FALLTHROUGH */
+ case (MDOC_Bk):
+ /* FALLTHROUGH */
+ case (MDOC_Bl):
+ /* FALLTHROUGH */
+ case (MDOC_Bo):
+ /* FALLTHROUGH */
+ case (MDOC_Do):
+ /* FALLTHROUGH */
+ case (MDOC_Eo):
+ /* FALLTHROUGH */
+ case (MDOC_Fo):
+ /* FALLTHROUGH */
+ case (MDOC_Oo):
+ /* FALLTHROUGH */
+ case (MDOC_Po):
+ /* FALLTHROUGH */
+ case (MDOC_Qo):
+ /* FALLTHROUGH */
+ case (MDOC_Rs):
+ /* FALLTHROUGH */
+ case (MDOC_So):
+ /* FALLTHROUGH */
+ case (MDOC_Xo):
+ if (type == p->type && tok == p->tok)
+ return(REWIND_REWIND);
+ break;
+
+ /* Multi-line explicit scope close. */
+ case (MDOC_Ac):
+ /* FALLTHROUGH */
+ case (MDOC_Bc):
+ /* FALLTHROUGH */
+ case (MDOC_Dc):
+ /* FALLTHROUGH */
+ case (MDOC_Ec):
+ /* FALLTHROUGH */
+ case (MDOC_Ed):
+ /* FALLTHROUGH */
+ case (MDOC_Ek):
+ /* FALLTHROUGH */
+ case (MDOC_El):
+ /* FALLTHROUGH */
+ case (MDOC_Fc):
+ /* FALLTHROUGH */
+ case (MDOC_Ef):
+ /* FALLTHROUGH */
+ case (MDOC_Oc):
+ /* FALLTHROUGH */
+ case (MDOC_Pc):
+ /* FALLTHROUGH */
+ case (MDOC_Qc):
+ /* FALLTHROUGH */
+ case (MDOC_Re):
+ /* FALLTHROUGH */
+ case (MDOC_Sc):
+ /* FALLTHROUGH */
+ case (MDOC_Xc):
+ if (type == p->type && rewind_alt(tok) == p->tok)
+ return(REWIND_REWIND);
+ break;
+ default:
+ abort();
+ /* NOTREACHED */
+ }
+
+ return(REWIND_NOHALT);
+}
+
+
+static int
+rewind_dobreak(int tok, const struct mdoc_node *p)
+{
+
+ assert(MDOC_ROOT != p->type);
+ if (MDOC_ELEM == p->type)
+ return(1);
+ if (MDOC_TEXT == p->type)
+ return(1);
+ if (MDOC_VALID & p->flags)
+ return(1);
+
+ switch (tok) {
+ /* Implicit rules. */
+ case (MDOC_It):
+ return(MDOC_It == p->tok);
+ case (MDOC_Ss):
+ return(MDOC_Ss == p->tok);
+ case (MDOC_Sh):
+ if (MDOC_Ss == p->tok)
+ return(1);
+ return(MDOC_Sh == p->tok);
+
+ /* Extra scope rules. */
+ case (MDOC_El):
+ if (MDOC_It == p->tok)
+ return(1);
+ break;
+ default:
+ break;
+ }
+
+ if (MDOC_EXPLICIT & mdoc_macros[tok].flags)
+ return(p->tok == rewind_alt(tok));
+ else if (MDOC_BLOCK == p->type)
+ return(1);
+
+ return(tok == p->tok);
+}
+
+
+static int
+rewind_elem(struct mdoc *mdoc, int tok)
+{
+ struct mdoc_node *n;
+
+ n = mdoc->last;
+ if (MDOC_ELEM != n->type)
+ n = n->parent;
+ assert(MDOC_ELEM == n->type);
+ assert(tok == n->tok);
+
+ return(rewind_last(mdoc, n));
+}
+
+
+static int
+rewind_subblock(enum mdoc_type type, struct mdoc *mdoc,
+ int tok, int line, int ppos)
+{
+ struct mdoc_node *n;
+ int c;
+
+ /* LINTED */
+ for (n = mdoc->last; n; n = n->parent) {
+ c = rewind_dohalt(tok, type, n);
+ if (REWIND_HALT == c)
+ return(1);
+ if (REWIND_REWIND == c)
+ break;
+ else if (rewind_dobreak(tok, n))
+ continue;
+ return(mdoc_perr(mdoc, line, ppos,
+ "scope breaks %s", MDOC_ROOT == n->type ?
+ "<root>" : mdoc_macronames[n->tok]));
+ }
+
+ assert(n);
+ return(rewind_last(mdoc, n));
+}
+
+
+static int
+rewind_expblock(struct mdoc *mdoc, int tok, int line, int ppos)
+{
+ struct mdoc_node *n;
+ int c;
+
+ /* LINTED */
+ for (n = mdoc->last; n; n = n->parent) {
+ c = rewind_dohalt(tok, MDOC_BLOCK, n);
+ if (REWIND_HALT == c)
+ 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 %s", MDOC_ROOT == n->type ?
+ "<root>" : mdoc_macronames[n->tok]));
+ }
+
+ assert(n);
+ return(rewind_last(mdoc, n));
+}
+
+
+static int
+rewind_impblock(struct mdoc *mdoc, int tok, int line, int ppos)
+{
+ struct mdoc_node *n;
+ int c;
+
+ /* LINTED */
+ for (n = mdoc->last; n; n = n->parent) {
+ c = rewind_dohalt(tok, MDOC_BLOCK, n);
+ if (REWIND_HALT == c)
+ return(1);
+ else if (REWIND_REWIND == c)
+ break;
+ else if (rewind_dobreak(tok, n))
+ continue;
+ return(mdoc_perr(mdoc, line, ppos,
+ "scope breaks %s", MDOC_ROOT == n->type ?
+ "<root>" : mdoc_macronames[n->tok]));
+ }
+
+ assert(n);
+ return(rewind_last(mdoc, n));
+}
+
+
+static int
+append_delims(struct mdoc *mdoc, int line, int *pos, char *buf)
+{
+ int c, lastarg;
+ char *p;
+
+ if (0 == buf[*pos])
+ return(1);
+
+ 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)
+ break;
+ assert(mdoc_isdelim(p));
+ if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
+ return(0);
+ mdoc->next = MDOC_NEXT_SIBLING;
}
- buf[i] = 0;
return(1);
}
+
+/*
+ * 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;
+ char *p;
+
+ switch (tok) {
+ case (MDOC_Ec):
+ maxargs = 1;
+ break;
+ default:
+ maxargs = 0;
+ break;
+ }
+
+ tt = rewind_alt(tok);
+
+ mdoc_msg(mdoc, "parse: %s closing %s",
+ mdoc_macronames[tok], mdoc_macronames[tt]);
+
+ if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) {
+ if (0 == buf[*pos]) {
+ if ( ! rewind_subblock(MDOC_BODY, mdoc,
+ tok, line, ppos))
+ return(0);
+ return(rewind_expblock(mdoc, tok, line, ppos));
+ }
+ return(perr(mdoc, line, ppos, ENOPARMS));
+ }
+
+ if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos))
+ return(0);
+
+ lastarg = ppos;
+ flushed = 0;
+
+ if (maxargs > 0) {
+ if ( ! mdoc_tail_alloc(mdoc, line, ppos, tt))
+ return(0);
+ mdoc->next = MDOC_NEXT_CHILD;
+ }
+
+ for (j = 0; /* No sentinel. */; j++) {
+ lastarg = *pos;
+
+ if (j == maxargs && ! flushed) {
+ if ( ! rewind_expblock(mdoc, tok, line, ppos))
+ return(0);
+ flushed = 1;
+ }
+
+ 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 (ARGS_EOLN == c)
+ break;
+
+ if (-1 == (c = lookup(mdoc, line, lastarg, tok, p)))
+ return(0);
+ else if (MDOC_MAX != c) {
+ if ( ! flushed) {
+ if ( ! rewind_expblock(mdoc, tok,
+ line, ppos))
+ return(0);
+ flushed = 1;
+ }
+ if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf))
+ return(0);
+ break;
+ }
+
+ if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
+ return(0);
+ mdoc->next = MDOC_NEXT_SIBLING;
+ }
+
+ if ( ! flushed && ! rewind_expblock(mdoc, tok, line, ppos))
+ return(0);
+
+ if (ppos > 1)
+ return(1);
+ return(append_delims(mdoc, line, pos, buf));
+}
+
+
/*
- * Parses the following:
+ * 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')
*
- * .Xx foo bar baz ; foo "bar baz" ; ;
- * ^---------- ^----------
+ * This must handle the following situations:
+ *
+ * .Fl Ar b ; ;
+ *
+ * ELEMENT (.Fl)
+ * ELEMENT (.Ar)
+ * TEXT (`b')
+ * TEXT (`;')
+ * TEXT (`;')
*/
static int
-macro_fl(struct rofftree *tree, int tok, int *pos, char *buf)
+macro_text(MACRO_PROT_ARGS)
{
- int i, j, c, first;
- char *args[ROFF_MAXLINEARG];
+ int la, lastpunct, c, w;
+ struct mdoc_arg *arg;
+ char *p;
- first = *pos == 0;
+ la = ppos;
+ lastpunct = 0;
+ arg = NULL;
- for (j = 0; ; ) {
- i = *pos;
- c = macro_args_next(tree, *i, buf, args[j]);
- if (-1 == c)
+ for (;;) {
+ la = *pos;
+ c = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
+ if (ARGV_EOLN == c)
+ break;
+ if (ARGV_WORD == c) {
+ *pos = la;
+ break;
+ } else if (ARGV_ARG == c)
+ continue;
+ mdoc_argv_free(arg);
+ return(0);
+ }
+
+ if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
+ return(0);
+
+ mdoc->next = MDOC_NEXT_CHILD;
+
+ lastpunct = 0;
+ for (;;) {
+ la = *pos;
+ w = mdoc_args(mdoc, line, pos, buf, tok, &p);
+ assert(ARGS_PHRASE != c);
+
+ if (ARGS_ERROR == w)
return(0);
- if (0 == c)
+ if (ARGS_EOLN == w)
+ break;
+ if (ARGS_PUNCT == w)
break;
- /* Break at the next command. */
+ c = ARGS_QWORD == w ? MDOC_MAX :
+ lookup(mdoc, line, la, tok, p);
- if (ROFF_MAX != (c = rofffindcallable(args[pos]))) {
- if ( ! macro(tree, tok, argc, argv, i, p))
+ if (MDOC_MAX != c && -1 != c) {
+ if (0 == lastpunct && ! rewind_elem(mdoc, tok))
+ return(0);
+ c = mdoc_macro(mdoc, c, line, la, pos, buf);
+ if (0 == c)
return(0);
- if ( ! parse(tree, c, pos, args))
+ if (ppos > 1)
+ return(1);
+ return(append_delims(mdoc, line, pos, buf));
+ } else if (-1 == c)
+ return(0);
+
+ /* FIXME: .Fl and .Ar handling of `|'. */
+
+ if (ARGS_QWORD != w && mdoc_isdelim(p)) {
+ if (0 == lastpunct && ! rewind_elem(mdoc, tok))
return(0);
+ lastpunct = 1;
+ } else if (lastpunct) {
+ c = mdoc_elem_alloc(mdoc, line, ppos, tok, arg);
+
+ if (0 == c)
+ return(0);
+
+ mdoc->next = MDOC_NEXT_CHILD;
+ lastpunct = 0;
+ }
+
+ if ( ! mdoc_word_alloc(mdoc, line, la, p))
+ return(0);
+ mdoc->next = MDOC_NEXT_SIBLING;
+ }
+
+ if (0 == lastpunct && ! rewind_elem(mdoc, tok))
+ return(0);
+ if (ppos > 1)
+ return(1);
+ return(append_delims(mdoc, line, pos, buf));
+}
+
+
+/*
+ * 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;
+ struct mdoc_arg *arg;
+ 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);
+ if ( ! rewind_impblock(mdoc, tok, line, ppos))
+ return(0);
+ }
+
+ /* Parse arguments. */
+
+ arg = NULL;
+
+ for (;;) {
+ lastarg = *pos;
+ c = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
+ if (ARGV_EOLN == c)
break;
+ if (ARGV_WORD == c) {
+ *pos = lastarg;
+ break;
+ } else if (ARGV_ARG == c)
+ continue;
+ mdoc_argv_free(arg);
+ return(0);
+ }
+
+ if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, arg))
+ return(0);
+
+ mdoc->next = MDOC_NEXT_CHILD;
+
+ if (0 == buf[*pos]) {
+ if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
+ return(0);
+ if ( ! rewind_subblock(MDOC_HEAD, mdoc,
+ tok, line, ppos))
+ return(0);
+ if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
+ return(0);
+ mdoc->next = MDOC_NEXT_CHILD;
+ return(1);
+ }
+
+ if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
+ return(0);
+ mdoc->next = MDOC_NEXT_CHILD;
+
+ for (;;) {
+ lastarg = *pos;
+ c = mdoc_args(mdoc, line, pos, buf, tok, &p);
+
+ if (ARGS_ERROR == c)
+ return(0);
+ if (ARGS_EOLN == c)
+ break;
+ if (ARGS_PHRASE == c) {
+ /*
+ if ( ! mdoc_phrase(mdoc, line, lastarg, buf))
+ return(0);
+ */
+ continue;
}
- /* Continue if we're just words. */
+ /* 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);
+
+ if (MDOC_MAX == c) {
+ if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
+ return(0);
+ mdoc->next = MDOC_NEXT_SIBLING;
+ continue;
+ }
+
+ if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf))
+ return(0);
+ break;
+ }
+
+ 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);
+ mdoc->next = MDOC_NEXT_CHILD;
+
+ return(1);
+}
+
+
+/*
+ * 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;
+ char *p;
+
+ if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL))
+ return(0);
+ mdoc->next = MDOC_NEXT_CHILD;
+
+ 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, tok, &p);
+ assert(ARGS_PHRASE != c);
- if ( ! roffispunct(args[pos])) {
- i++;
+ if (ARGS_ERROR == c)
+ return(0);
+ if (ARGS_PUNCT == c)
+ break;
+ if (ARGS_EOLN == c)
+ break;
+
+ if (-1 == (c = lookup(mdoc, line, lastarg, tok, p)))
+ return(0);
+ else if (MDOC_MAX == c) {
+ if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
+ return(0);
+ mdoc->next = MDOC_NEXT_SIBLING;
continue;
+ }
+
+ if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf))
+ return(0);
+ break;
+ }
+
+ if (1 == 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_BODY, mdoc, tok, line, ppos))
+ return(0);
+ return(rewind_impblock(mdoc, tok, line, ppos));
+}
+
+
+/*
+ * 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;
+ char *p;
+
+ lastarg = ppos;
+ flushed = 0;
+
+ switch (tok) {
+ case (MDOC_Eo):
+ maxargs = 1;
+ break;
+ default:
+ maxargs = 0;
+ break;
+ }
+
+ if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL))
+ return(0);
+ mdoc->next = MDOC_NEXT_CHILD;
+
+ if (0 == maxargs) {
+ if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
+ return(0);
+ if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
+ return(0);
+ if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
+ return(0);
+ flushed = 1;
+ } else if ( ! mdoc_head_alloc(mdoc, line, ppos, tok))
+ return(0);
+
+ mdoc->next = MDOC_NEXT_CHILD;
+
+ for (j = 0; /* No sentinel. */; j++) {
+ lastarg = *pos;
+
+ if (j == maxargs && ! flushed) {
+ if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
+ return(0);
+ flushed = 1;
+ if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
+ return(0);
+ mdoc->next = MDOC_NEXT_CHILD;
+ }
+
+ 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 (ARGS_EOLN == c)
+ break;
+
+ if (-1 == (c = lookup(mdoc, line, lastarg, tok, p)))
+ return(0);
+ else if (MDOC_MAX != c) {
+ if ( ! flushed) {
+ if ( ! rewind_subblock(MDOC_HEAD, mdoc,
+ tok, line, ppos))
+ return(0);
+ flushed = 1;
+ if ( ! mdoc_body_alloc(mdoc, line,
+ ppos, tok))
+ return(0);
+ mdoc->next = MDOC_NEXT_CHILD;
+ }
+ 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))
+ return(0);
+ flushed = 1;
+ if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
+ return(0);
+ mdoc->next = MDOC_NEXT_CHILD;
+ }
+
+ if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
+ return(0);
+ mdoc->next = MDOC_NEXT_SIBLING;
+ }
+
+ if ( ! flushed) {
+ if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos))
+ return(0);
+ if ( ! mdoc_body_alloc(mdoc, line, ppos, tok))
+ return(0);
+ mdoc->next = MDOC_NEXT_CHILD;
+ }
+
+ if (ppos > 1)
+ return(1);
+ return(append_delims(mdoc, line, pos, buf));
+}
+
+
+/*
+ * 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,
+ igndelim, ignargs;
+ struct mdoc_arg *arg;
+ 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_Ux):
+ maxargs = 0;
+ break;
+ default:
+ maxargs = 1;
+ break;
+ }
+
+ /*
+ * 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;
+ }
+
+ arg = NULL;
+
+ if ( ! ignargs)
+ for (;;) {
+ lastarg = *pos;
+ c = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
+ if (ARGV_EOLN == c)
+ break;
+ if (ARGV_WORD == c) {
+ *pos = lastarg;
+ break;
+ } else if (ARGV_ARG == c)
+ continue;
+ mdoc_argv_free(arg);
+ return(0);
+ }
+
+ if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
+ return(0);
+
+ mdoc->next = MDOC_NEXT_CHILD;
+
+ for (j = 0; /* No sentinel. */; j++) {
+ lastarg = *pos;
+
+ if (j == maxargs && ! flushed) {
+ if ( ! rewind_elem(mdoc, tok))
+ return(0);
+ flushed = 1;
+ }
+
+ 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 (ARGS_EOLN == c)
+ break;
+
+ if (-1 == (c = lookup(mdoc, line, lastarg, tok, p)))
+ return(0);
+ else if (MDOC_MAX != c) {
+ if ( ! flushed && ! rewind_elem(mdoc, tok))
+ return(0);
+ flushed = 1;
+ if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf))
+ return(0);
+ break;
}
- /* Break if there's only remaining punctuation. */
+ if ( ! flushed && mdoc_isdelim(p) && ! igndelim) {
+ if ( ! rewind_elem(mdoc, tok))
+ return(0);
+ flushed = 1;
+ }
+
+ if ( ! mdoc_word_alloc(mdoc, line, lastarg, p))
+ return(0);
+ mdoc->next = MDOC_NEXT_SIBLING;
+ }
+
+ if ( ! flushed && ! rewind_elem(mdoc, tok))
+ return(0);
- if (args[pos + 1] && roffispunct(args[pos + 1]))
+ if (ppos > 1)
+ return(1);
+ return(append_delims(mdoc, line, pos, buf));
+}
+
+
+/*
+ * A constant macro is the simplest classification. It spans an entire
+ * line.
+ */
+static int
+macro_constant(MACRO_PROT_ARGS)
+{
+ int c, w, la;
+ struct mdoc_arg *arg;
+ char *p;
+
+ assert( ! (MDOC_CALLABLE & mdoc_macros[tok].flags));
+
+ arg = NULL;
+
+ for (;;) {
+ la = *pos;
+ c = mdoc_argv(mdoc, line, tok, &arg, pos, buf);
+ if (ARGV_EOLN == c)
+ break;
+ if (ARGV_WORD == c) {
+ *pos = la;
break;
+ } else if (ARGV_ARG == c)
+ continue;
+ mdoc_argv_free(arg);
+ return(0);
+ }
+
+ if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg))
+ return(0);
+
+ mdoc->next = MDOC_NEXT_CHILD;
- /* If there are remaining words, start anew. */
+ for (;;) {
+ la = *pos;
+ w = mdoc_args(mdoc, line, pos, buf, tok, &p);
+ assert(ARGS_PHRASE != c);
- if ( ! macro(tree, tok, argc, argv, i, p))
+ if (ARGS_ERROR == w)
return(0);
+ if (ARGS_EOLN == w)
+ break;
- /* Spit out the punctuation. */
+ c = ARGS_QWORD == w ? MDOC_MAX :
+ lookup(mdoc, line, la, tok, p);
- if ( ! word(tree, tok, *args++))
+ if (MDOC_MAX != c && -1 != c) {
+ if ( ! rewind_elem(mdoc, tok))
+ return(0);
+ return(mdoc_macro(mdoc, c, line, la, pos, buf));
+ } else if (-1 == c)
+ return(0);
+
+ if ( ! mdoc_word_alloc(mdoc, line, la, p))
return(0);
- i++;
+ mdoc->next = MDOC_NEXT_SIBLING;
+ }
+
+ return(rewind_elem(mdoc, tok));
+}
+
+
+/* ARGSUSED */
+static int
+macro_obsolete(MACRO_PROT_ARGS)
+{
+
+ 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)
+{
+ struct mdoc_node *n;
+
+ assert(mdoc->first);
+ assert(mdoc->last);
+
+ /* Scan for open explicit scopes. */
+
+ n = MDOC_VALID & mdoc->last->flags ?
+ mdoc->last->parent : mdoc->last;
+
+ for ( ; n; n = n->parent) {
+ if (MDOC_BLOCK != n->type)
+ continue;
+ if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags))
+ continue;
+ return(mdoc_nerr(mdoc, n,
+ "macro scope still open on exit"));
}
+
+ return(rewind_last(mdoc, mdoc->first));
}
git.ckatri.com / mandoc.git / blobdiff