-/* $Id: roff.c,v 1.53 2008/12/08 20:32:49 kristaps Exp $ */
+/* $Id: roff.c,v 1.144 2011/07/08 09:28:33 kristaps Exp $ */
/*
- * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
*
* Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the
- * above copyright notice and this permission notice appear in all
- * copies.
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
*
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
- * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
- * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
- * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- * PERFORMANCE OF THIS SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-#include <sys/param.h>
-#include <sys/types.h>
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
#include <assert.h>
#include <ctype.h>
-#include <err.h>
-#include <stdarg.h>
#include <stdlib.h>
-#include <stdio.h>
#include <string.h>
-#include <time.h>
-
-#include "libmdocml.h"
-#include "private.h"
-#include "roff.h"
-
-/* FIXME: First letters of quoted-text interpreted in rofffindtok. */
-/* FIXME: `No' not implemented. */
-/* TODO: warn if Pp occurs before/after Sh etc. (see mdoc.samples). */
-/* TODO: warn about empty lists. */
-/* TODO: (warn) some sections need specific elements. */
-/* TODO: (warn) NAME section has particular order. */
-/* TODO: unify empty-content tags a la <br />. */
-/* TODO: macros with a set number of arguments? */
-/* TODO: validate Dt macro arguments. */
-/* FIXME: Bl -diag supposed to ignore callable children. */
-/* FIXME: Nm has newline when used in NAME section. */
-struct roffnode {
- int tok; /* Token id. */
- struct roffnode *parent; /* Parent (or NULL). */
+#include "mandoc.h"
+#include "libroff.h"
+#include "libmandoc.h"
+
+/* Maximum number of nested if-else conditionals. */
+#define RSTACK_MAX 128
+
+enum rofft {
+ ROFF_ad,
+ ROFF_am,
+ ROFF_ami,
+ ROFF_am1,
+ ROFF_de,
+ ROFF_dei,
+ ROFF_de1,
+ ROFF_ds,
+ ROFF_el,
+ ROFF_hy,
+ ROFF_ie,
+ ROFF_if,
+ ROFF_ig,
+ ROFF_it,
+ ROFF_ne,
+ ROFF_nh,
+ ROFF_nr,
+ ROFF_ns,
+ ROFF_ps,
+ ROFF_rm,
+ ROFF_so,
+ ROFF_ta,
+ ROFF_tr,
+ ROFF_TS,
+ ROFF_TE,
+ ROFF_T_,
+ ROFF_EQ,
+ ROFF_EN,
+ ROFF_cblock,
+ ROFF_ccond,
+ ROFF_USERDEF,
+ ROFF_MAX
};
-struct rofftree {
- struct roffnode *last; /* Last parsed node. */
- char *cur; /* Line start. */
- struct tm tm; /* `Dd' results. */
- char name[64]; /* `Nm' results. */
- char os[64]; /* `Os' results. */
- char title[64]; /* `Dt' results. */
- enum roffmsec section;
- char volume[64]; /* `Dt' results. */
- int state;
-#define ROFF_PRELUDE (1 << 1) /* In roff prelude. */
-#define ROFF_PRELUDE_Os (1 << 2) /* `Os' is parsed. */
-#define ROFF_PRELUDE_Dt (1 << 3) /* `Dt' is parsed. */
-#define ROFF_PRELUDE_Dd (1 << 4) /* `Dd' is parsed. */
-#define ROFF_BODY (1 << 5) /* In roff body. */
- struct roffcb cb; /* Callbacks. */
- void *arg; /* Callbacks' arg. */
- int csec; /* Current section. */
- int asec; /* Thus-far sections. */
+enum roffrule {
+ ROFFRULE_ALLOW,
+ ROFFRULE_DENY
};
-static struct roffnode *roffnode_new(int, struct rofftree *);
-static void roffnode_free(struct rofftree *);
-static void roff_warn(const struct rofftree *,
- const char *, char *, ...);
-static void roff_err(const struct rofftree *,
- const char *, char *, ...);
-static int roffpurgepunct(struct rofftree *, char **);
-static int roffscan(int, const int *);
-static int rofffindtok(const char *);
-static int rofffindarg(const char *);
-static int rofffindcallable(const char *);
-static int roffismsec(const char *);
-static int roffissec(const char **);
-static int roffispunct(const char *);
-static int roffisatt(const char *);
-static int roffchecksec(struct rofftree *,
- const char *, int);
-static int roffargs(const struct rofftree *,
- int, char *, char **);
-static int roffargok(int, int);
-static int roffnextopt(const struct rofftree *,
- int, char ***, char **);
-static int roffparseopts(struct rofftree *, int,
- char ***, int *, char **);
-static int roffcall(struct rofftree *, int, char **);
-static int roffexit(struct rofftree *, int);
-static int roffparse(struct rofftree *, char *);
-static int textparse(struct rofftree *, char *);
-static int roffdata(struct rofftree *, int, char *);
-static int roffspecial(struct rofftree *, int,
- const char *, const int *,
- const char **, size_t, char **);
-static int roffsetname(struct rofftree *, char **);
-
-#ifdef __linux__
-extern size_t strlcat(char *, const char *, size_t);
-extern size_t strlcpy(char *, const char *, size_t);
-extern int vsnprintf(char *, size_t,
- const char *, va_list);
-extern char *strptime(const char *, const char *,
- struct tm *);
-#endif
-
-int
-roff_free(struct rofftree *tree, int flush)
-{
- int error, t;
- struct roffnode *n;
+struct roffstr {
+ char *name; /* key of symbol */
+ char *string; /* current value */
+ struct roffstr *next; /* next in list */
+};
- error = 0;
+struct roff {
+ struct mparse *parse; /* parse point */
+ struct roffnode *last; /* leaf of stack */
+ enum roffrule rstack[RSTACK_MAX]; /* stack of !`ie' rules */
+ int rstackpos; /* position in rstack */
+ struct regset *regs; /* read/writable registers */
+ struct roffstr *first_string; /* user-defined strings & macros */
+ const char *current_string; /* value of last called user macro */
+ struct tbl_node *first_tbl; /* first table parsed */
+ struct tbl_node *last_tbl; /* last table parsed */
+ struct tbl_node *tbl; /* current table being parsed */
+ struct eqn_node *last_eqn; /* last equation parsed */
+ struct eqn_node *first_eqn; /* first equation parsed */
+ struct eqn_node *eqn; /* current equation being parsed */
+};
- if ( ! flush)
- goto end;
+struct roffnode {
+ enum rofft tok; /* type of node */
+ struct roffnode *parent; /* up one in stack */
+ int line; /* parse line */
+ int col; /* parse col */
+ char *name; /* node name, e.g. macro name */
+ char *end; /* end-rules: custom token */
+ int endspan; /* end-rules: next-line or infty */
+ enum roffrule rule; /* current evaluation rule */
+};
- error = 1;
+#define ROFF_ARGS struct roff *r, /* parse ctx */ \
+ enum rofft tok, /* tok of macro */ \
+ char **bufp, /* input buffer */ \
+ size_t *szp, /* size of input buffer */ \
+ int ln, /* parse line */ \
+ int ppos, /* original pos in buffer */ \
+ int pos, /* current pos in buffer */ \
+ int *offs /* reset offset of buffer data */
+
+typedef enum rofferr (*roffproc)(ROFF_ARGS);
+
+struct roffmac {
+ const char *name; /* macro name */
+ roffproc proc; /* process new macro */
+ roffproc text; /* process as child text of macro */
+ roffproc sub; /* process as child of macro */
+ int flags;
+#define ROFFMAC_STRUCT (1 << 0) /* always interpret */
+ struct roffmac *next;
+};
- if (ROFF_PRELUDE & tree->state) {
- roff_err(tree, NULL, "prelude never finished");
- goto end;
- } else if ( ! (ROFFSec_NAME & tree->asec)) {
- roff_err(tree, NULL, "missing `NAME' section");
- goto end;
- } else if ( ! (ROFFSec_NMASK & tree->asec))
- roff_warn(tree, NULL, "missing suggested `NAME', "
- "`SYNOPSIS', `DESCRIPTION' sections");
+struct predef {
+ const char *name; /* predefined input name */
+ const char *str; /* replacement symbol */
+};
- for (n = tree->last; n; n = n->parent) {
- if (0 != tokens[n->tok].ctx)
- continue;
- roff_err(tree, NULL, "closing explicit scope `%s'",
- toknames[n->tok]);
- goto end;
- }
+#define PREDEF(__name, __str) \
+ { (__name), (__str) },
+
+static enum rofferr roff_block(ROFF_ARGS);
+static enum rofferr roff_block_text(ROFF_ARGS);
+static enum rofferr roff_block_sub(ROFF_ARGS);
+static enum rofferr roff_cblock(ROFF_ARGS);
+static enum rofferr roff_ccond(ROFF_ARGS);
+static enum rofferr roff_cond(ROFF_ARGS);
+static enum rofferr roff_cond_text(ROFF_ARGS);
+static enum rofferr roff_cond_sub(ROFF_ARGS);
+static enum rofferr roff_ds(ROFF_ARGS);
+static enum roffrule roff_evalcond(const char *, int *);
+static void roff_freestr(struct roff *);
+static char *roff_getname(struct roff *, char **, int, int);
+static const char *roff_getstrn(const struct roff *,
+ const char *, size_t);
+static enum rofferr roff_line_ignore(ROFF_ARGS);
+static enum rofferr roff_nr(ROFF_ARGS);
+static int roff_res(struct roff *,
+ char **, size_t *, int, int);
+static enum rofferr roff_rm(ROFF_ARGS);
+static void roff_setstr(struct roff *,
+ const char *, const char *, int);
+static enum rofferr roff_so(ROFF_ARGS);
+static enum rofferr roff_TE(ROFF_ARGS);
+static enum rofferr roff_TS(ROFF_ARGS);
+static enum rofferr roff_EQ(ROFF_ARGS);
+static enum rofferr roff_EN(ROFF_ARGS);
+static enum rofferr roff_T_(ROFF_ARGS);
+static enum rofferr roff_userdef(ROFF_ARGS);
+
+/* See roff_hash_find() */
+
+#define ASCII_HI 126
+#define ASCII_LO 33
+#define HASHWIDTH (ASCII_HI - ASCII_LO + 1)
+
+static struct roffmac *hash[HASHWIDTH];
+
+static struct roffmac roffs[ROFF_MAX] = {
+ { "ad", roff_line_ignore, NULL, NULL, 0, NULL },
+ { "am", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "ami", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "am1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "de", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "dei", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "de1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "ds", roff_ds, NULL, NULL, 0, NULL },
+ { "el", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
+ { "hy", roff_line_ignore, NULL, NULL, 0, NULL },
+ { "ie", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
+ { "if", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
+ { "ig", roff_block, roff_block_text, roff_block_sub, 0, NULL },
+ { "it", roff_line_ignore, NULL, NULL, 0, NULL },
+ { "ne", roff_line_ignore, NULL, NULL, 0, NULL },
+ { "nh", roff_line_ignore, NULL, NULL, 0, NULL },
+ { "nr", roff_nr, NULL, NULL, 0, NULL },
+ { "ns", roff_line_ignore, NULL, NULL, 0, NULL },
+ { "ps", roff_line_ignore, NULL, NULL, 0, NULL },
+ { "rm", roff_rm, NULL, NULL, 0, NULL },
+ { "so", roff_so, NULL, NULL, 0, NULL },
+ { "ta", roff_line_ignore, NULL, NULL, 0, NULL },
+ { "tr", roff_line_ignore, NULL, NULL, 0, NULL },
+ { "TS", roff_TS, NULL, NULL, 0, NULL },
+ { "TE", roff_TE, NULL, NULL, 0, NULL },
+ { "T&", roff_T_, NULL, NULL, 0, NULL },
+ { "EQ", roff_EQ, NULL, NULL, 0, NULL },
+ { "EN", roff_EN, NULL, NULL, 0, NULL },
+ { ".", roff_cblock, NULL, NULL, 0, NULL },
+ { "\\}", roff_ccond, NULL, NULL, 0, NULL },
+ { NULL, roff_userdef, NULL, NULL, 0, NULL },
+};
- while (tree->last) {
- t = tree->last->tok;
- if ( ! roffexit(tree, t))
- goto end;
- }
+/* Array of injected predefined strings. */
+#define PREDEFS_MAX 38
+static const struct predef predefs[PREDEFS_MAX] = {
+#include "predefs.in"
+};
- if ( ! (*tree->cb.rofftail)(tree->arg))
- goto end;
+static void roff_free1(struct roff *);
+static enum rofft roff_hash_find(const char *, size_t);
+static void roff_hash_init(void);
+static void roffnode_cleanscope(struct roff *);
+static void roffnode_push(struct roff *, enum rofft,
+ const char *, int, int);
+static void roffnode_pop(struct roff *);
+static enum rofft roff_parse(struct roff *, const char *, int *);
- error = 0;
+/* See roff_hash_find() */
+#define ROFF_HASH(p) (p[0] - ASCII_LO)
-end:
+static void
+roff_hash_init(void)
+{
+ struct roffmac *n;
+ int buc, i;
- while (tree->last)
- roffnode_free(tree);
+ for (i = 0; i < (int)ROFF_USERDEF; i++) {
+ assert(roffs[i].name[0] >= ASCII_LO);
+ assert(roffs[i].name[0] <= ASCII_HI);
- free(tree);
+ buc = ROFF_HASH(roffs[i].name);
- return(error ? 0 : 1);
+ if (NULL != (n = hash[buc])) {
+ for ( ; n->next; n = n->next)
+ /* Do nothing. */ ;
+ n->next = &roffs[i];
+ } else
+ hash[buc] = &roffs[i];
+ }
}
-
-struct rofftree *
-roff_alloc(const struct roffcb *cb, void *args)
+/*
+ * Look up a roff token by its name. Returns ROFF_MAX if no macro by
+ * the nil-terminated string name could be found.
+ */
+static enum rofft
+roff_hash_find(const char *p, size_t s)
{
- struct rofftree *tree;
+ int buc;
+ struct roffmac *n;
- assert(args);
- assert(cb);
+ /*
+ * libroff has an extremely simple hashtable, for the time
+ * being, which simply keys on the first character, which must
+ * be printable, then walks a chain. It works well enough until
+ * optimised.
+ */
- if (NULL == (tree = calloc(1, sizeof(struct rofftree))))
- err(1, "calloc");
+ if (p[0] < ASCII_LO || p[0] > ASCII_HI)
+ return(ROFF_MAX);
- tree->state = ROFF_PRELUDE;
- tree->arg = args;
- tree->section = ROFF_MSEC_MAX;
+ buc = ROFF_HASH(p);
- (void)memcpy(&tree->cb, cb, sizeof(struct roffcb));
+ if (NULL == (n = hash[buc]))
+ return(ROFF_MAX);
+ for ( ; n; n = n->next)
+ if (0 == strncmp(n->name, p, s) && '\0' == n->name[(int)s])
+ return((enum rofft)(n - roffs));
- return(tree);
+ return(ROFF_MAX);
}
-int
-roff_engine(struct rofftree *tree, char *buf)
+/*
+ * Pop the current node off of the stack of roff instructions currently
+ * pending.
+ */
+static void
+roffnode_pop(struct roff *r)
{
+ struct roffnode *p;
- tree->cur = buf;
- assert(buf);
+ assert(r->last);
+ p = r->last;
- if (0 == *buf) {
- roff_err(tree, buf, "blank line");
- return(0);
- } else if ('.' != *buf)
- return(textparse(tree, buf));
-
- return(roffparse(tree, buf));
+ r->last = r->last->parent;
+ free(p->name);
+ free(p->end);
+ free(p);
}
-static int
-textparse(struct rofftree *tree, char *buf)
+/*
+ * Push a roff node onto the instruction stack. This must later be
+ * removed with roffnode_pop().
+ */
+static void
+roffnode_push(struct roff *r, enum rofft tok, const char *name,
+ int line, int col)
{
- char *bufp;
+ struct roffnode *p;
- /* TODO: literal parsing. */
+ p = mandoc_calloc(1, sizeof(struct roffnode));
+ p->tok = tok;
+ if (name)
+ p->name = mandoc_strdup(name);
+ p->parent = r->last;
+ p->line = line;
+ p->col = col;
+ p->rule = p->parent ? p->parent->rule : ROFFRULE_DENY;
- if ( ! (ROFF_BODY & tree->state)) {
- roff_err(tree, buf, "data not in body");
- return(0);
- }
-
- /* LINTED */
- while (*buf) {
- while (*buf && isspace(*buf))
- buf++;
+ r->last = p;
+}
- if (0 == *buf)
- break;
- bufp = buf++;
+static void
+roff_free1(struct roff *r)
+{
+ struct tbl_node *t;
+ struct eqn_node *e;
- while (*buf && ! isspace(*buf))
- buf++;
+ while (NULL != (t = r->first_tbl)) {
+ r->first_tbl = t->next;
+ tbl_free(t);
+ }
- if (0 != *buf) {
- *buf++ = 0;
- if ( ! roffdata(tree, 1, bufp))
- return(0);
- continue;
- }
+ r->first_tbl = r->last_tbl = r->tbl = NULL;
- if ( ! roffdata(tree, 1, bufp))
- return(0);
- break;
+ while (NULL != (e = r->first_eqn)) {
+ r->first_eqn = e->next;
+ eqn_free(e);
}
- return(1);
+ r->first_eqn = r->last_eqn = r->eqn = NULL;
+
+ while (r->last)
+ roffnode_pop(r);
+
+ roff_freestr(r);
}
-static int
-roffargs(const struct rofftree *tree,
- int tok, char *buf, char **argv)
+void
+roff_reset(struct roff *r)
{
int i;
- char *p;
- assert(tok >= 0 && tok < ROFF_MAX);
- assert('.' == *buf);
+ roff_free1(r);
- p = buf;
+ for (i = 0; i < PREDEFS_MAX; i++)
+ roff_setstr(r, predefs[i].name, predefs[i].str, 0);
+}
- /*
- * This is an ugly little loop. It parses a line into
- * space-delimited tokens. If a quote mark is encountered, a
- * token is alloted the entire quoted text. If whitespace is
- * escaped, it's included in the prior alloted token.
- */
- /* LINTED */
- for (i = 0; *buf && i < ROFF_MAXLINEARG; i++) {
- if ('\"' == *buf) {
- argv[i] = ++buf;
- while (*buf && '\"' != *buf)
- buf++;
- if (0 == *buf) {
- roff_err(tree, argv[i], "unclosed "
- "quote in argument "
- "list for `%s'",
- toknames[tok]);
- return(0);
- }
- } else {
- argv[i] = buf++;
- while (*buf) {
- if ( ! isspace(*buf)) {
- buf++;
- continue;
- }
- if (*(buf - 1) == '\\') {
- buf++;
- continue;
- }
- break;
- }
- if (0 == *buf)
- continue;
- }
- *buf++ = 0;
- while (*buf && isspace(*buf))
- buf++;
- }
-
- assert(i > 0);
- if (ROFF_MAXLINEARG == i && *buf) {
- roff_err(tree, p, "too many arguments for `%s'", toknames
- [tok]);
- return(0);
- }
+void
+roff_free(struct roff *r)
+{
- argv[i] = NULL;
- return(1);
+ roff_free1(r);
+ free(r);
}
-static int
-roffscan(int tok, const int *tokv)
+struct roff *
+roff_alloc(struct regset *regs, struct mparse *parse)
{
+ struct roff *r;
+ int i;
- if (NULL == tokv)
- return(1);
+ r = mandoc_calloc(1, sizeof(struct roff));
+ r->regs = regs;
+ r->parse = parse;
+ r->rstackpos = -1;
+
+ roff_hash_init();
- for ( ; ROFF_MAX != *tokv; tokv++)
- if (tok == *tokv)
- return(1);
+ for (i = 0; i < PREDEFS_MAX; i++)
+ roff_setstr(r, predefs[i].name, predefs[i].str, 0);
- return(0);
+ return(r);
}
+/*
+ * Pre-filter each and every line for reserved words (one beginning with
+ * `\*', e.g., `\*(ab'). These must be handled before the actual line
+ * is processed.
+ */
static int
-roffparse(struct rofftree *tree, char *buf)
+roff_res(struct roff *r, char **bufp, size_t *szp, int ln, int pos)
{
- int tok, t;
- struct roffnode *n;
- char *argv[ROFF_MAXLINEARG];
- char **argvp;
+ const char *stesc; /* start of an escape sequence ('\\') */
+ const char *stnam; /* start of the name, after "[(*" */
+ const char *cp; /* end of the name, e.g. before ']' */
+ const char *res; /* the string to be substituted */
+ int i, maxl;
+ size_t nsz;
+ char *n;
- if (0 != *buf && 0 != *(buf + 1) && 0 != *(buf + 2))
- if (0 == strncmp(buf, ".\\\"", 3))
- return(1);
-
- if (ROFF_MAX == (tok = rofffindtok(buf + 1))) {
- roff_err(tree, buf, "bogus line macro");
- return(0);
- } else if ( ! roffargs(tree, tok, buf, argv))
- return(0);
-
- argvp = (char **)argv;
-
- /*
- * Prelude macros break some assumptions, so branch now.
- */
-
- if (ROFF_PRELUDE & tree->state) {
- assert(NULL == tree->last);
- return(roffcall(tree, tok, argvp));
- }
+ /* Search for a leading backslash and save a pointer to it. */
- assert(ROFF_BODY & tree->state);
+ cp = *bufp + pos;
+ while (NULL != (cp = strchr(cp, '\\'))) {
+ stesc = cp++;
- /*
- * First check that our possible parents and parent's possible
- * children are satisfied.
- */
-
- if (tree->last && ! roffscan
- (tree->last->tok, tokens[tok].parents)) {
- roff_err(tree, *argvp, "`%s' has invalid parent `%s'",
- toknames[tok],
- toknames[tree->last->tok]);
- return(0);
- }
-
- if (tree->last && ! roffscan
- (tok, tokens[tree->last->tok].children)) {
- roff_err(tree, *argvp, "`%s' is invalid child of `%s'",
- toknames[tok],
- toknames[tree->last->tok]);
- return(0);
- }
+ /*
+ * The second character must be an asterisk.
+ * If it isn't, skip it anyway: It is escaped,
+ * so it can't start another escape sequence.
+ */
- /*
- * Branch if we're not a layout token.
- */
+ if ('\0' == *cp)
+ return(1);
+ if ('*' != *cp++)
+ continue;
- if (ROFF_LAYOUT != tokens[tok].type)
- return(roffcall(tree, tok, argvp));
- if (0 == tokens[tok].ctx)
- return(roffcall(tree, tok, argvp));
+ /*
+ * The third character decides the length
+ * of the name of the string.
+ * Save a pointer to the name.
+ */
- /*
- * First consider implicit-end tags, like as follows:
- * .Sh SECTION 1
- * .Sh SECTION 2
- * In this, we want to close the scope of the NAME section. If
- * there's an intermediary implicit-end tag, such as
- * .Sh SECTION 1
- * .Ss Subsection 1
- * .Sh SECTION 2
- * then it must be closed as well.
- */
+ switch (*cp) {
+ case ('\0'):
+ return(1);
+ case ('('):
+ cp++;
+ maxl = 2;
+ break;
+ case ('['):
+ cp++;
+ maxl = 0;
+ break;
+ default:
+ maxl = 1;
+ break;
+ }
+ stnam = cp;
- if (tok == tokens[tok].ctx) {
- /*
- * First search up to the point where we must close.
- * If one doesn't exist, then we can open a new scope.
- */
+ /* Advance to the end of the name. */
- for (n = tree->last; n; n = n->parent) {
- assert(0 == tokens[n->tok].ctx ||
- n->tok == tokens[n->tok].ctx);
- if (n->tok == tok)
- break;
- if (ROFF_SHALLOW & tokens[tok].flags) {
- n = NULL;
+ for (i = 0; 0 == maxl || i < maxl; i++, cp++) {
+ if ('\0' == *cp)
+ return(1); /* Error. */
+ if (0 == maxl && ']' == *cp)
break;
- }
- if (tokens[n->tok].ctx == n->tok)
- continue;
- roff_err(tree, *argv, "`%s' breaks `%s' scope",
- toknames[tok], toknames[n->tok]);
- return(0);
}
/*
- * Create a new scope, as no previous one exists to
- * close out.
+ * Retrieve the replacement string; if it is
+ * undefined, resume searching for escapes.
*/
- if (NULL == n)
- return(roffcall(tree, tok, argvp));
+ res = roff_getstrn(r, stnam, (size_t)i);
- /*
- * Close out all intermediary scoped blocks, then hang
- * the current scope from our predecessor's parent.
- */
-
- do {
- t = tree->last->tok;
- if ( ! roffexit(tree, t))
- return(0);
- } while (t != tok);
+ if (NULL == res) {
+ /* TODO: keep track of the correct position. */
+ mandoc_msg(MANDOCERR_BADESCAPE, r->parse, ln, pos, NULL);
+ res = "";
+ }
- return(roffcall(tree, tok, argvp));
- }
+ /* Replace the escape sequence by the string. */
- /*
- * Now consider explicit-end tags, where we want to close back
- * to a specific tag. Example:
- * .Bl
- * .It Item.
- * .El
- * In this, the `El' tag closes out the scope of `Bl'.
- */
+ nsz = *szp + strlen(res) + 1;
+ n = mandoc_malloc(nsz);
- assert(tok != tokens[tok].ctx && 0 != tokens[tok].ctx);
-
- /* LINTED */
- for (n = tree->last; n; n = n->parent)
- if (n->tok != tokens[tok].ctx) {
- if (n->tok == tokens[n->tok].ctx)
- continue;
- roff_err(tree, *argv, "`%s' breaks `%s' scope",
- toknames[tok], toknames[n->tok]);
- return(0);
- } else
- break;
+ strlcpy(n, *bufp, (size_t)(stesc - *bufp + 1));
+ strlcat(n, res, nsz);
+ strlcat(n, cp + (maxl ? 0 : 1), nsz);
+ free(*bufp);
- if (NULL == n) {
- roff_err(tree, *argv, "`%s' has no starting tag `%s'",
- toknames[tok],
- toknames[tokens[tok].ctx]);
+ *bufp = n;
+ *szp = nsz;
return(0);
}
- /* LINTED */
- do {
- t = tree->last->tok;
- if ( ! roffexit(tree, t))
- return(0);
- } while (t != tokens[tok].ctx);
-
return(1);
}
-static int
-rofffindarg(const char *name)
+enum rofferr
+roff_parseln(struct roff *r, int ln, char **bufp,
+ size_t *szp, int pos, int *offs)
{
- size_t i;
+ enum rofft t;
+ enum rofferr e;
+ int ppos, ctl;
- /* FIXME: use a table, this is slow but ok for now. */
+ /*
+ * Run the reserved-word filter only if we have some reserved
+ * words to fill in.
+ */
- /* LINTED */
- for (i = 0; i < ROFF_ARGMAX; i++)
- /* LINTED */
- if (0 == strcmp(name, tokargnames[i]))
- return((int)i);
-
- return(ROFF_ARGMAX);
-}
+ if (r->first_string && ! roff_res(r, bufp, szp, ln, pos))
+ return(ROFF_REPARSE);
+ ppos = pos;
+ ctl = mandoc_getcontrol(*bufp, &pos);
-static int
-rofffindtok(const char *buf)
-{
- char token[4];
- int i;
+ /*
+ * First, if a scope is open and we're not a macro, pass the
+ * text through the macro's filter. If a scope isn't open and
+ * we're not a macro, just let it through.
+ * Finally, if there's an equation scope open, divert it into it
+ * no matter our state.
+ */
- for (i = 0; *buf && ! isspace(*buf) && i < 3; i++, buf++)
- token[i] = *buf;
+ if (r->last && ! ctl) {
+ t = r->last->tok;
+ assert(roffs[t].text);
+ e = (*roffs[t].text)
+ (r, t, bufp, szp, ln, pos, pos, offs);
+ assert(ROFF_IGN == e || ROFF_CONT == e);
+ if (ROFF_CONT != e)
+ return(e);
+ if (r->eqn)
+ return(eqn_read(&r->eqn, ln, *bufp, pos));
+ if (r->tbl)
+ return(tbl_read(r->tbl, ln, *bufp, pos));
+ return(ROFF_CONT);
+ } else if ( ! ctl) {
+ if (r->eqn)
+ return(eqn_read(&r->eqn, ln, *bufp, pos));
+ if (r->tbl)
+ return(tbl_read(r->tbl, ln, *bufp, pos));
+ return(ROFF_CONT);
+ } else if (r->eqn)
+ return(eqn_read(&r->eqn, ln, *bufp, ppos));
- if (i == 3)
- return(ROFF_MAX);
+ /*
+ * If a scope is open, go to the child handler for that macro,
+ * as it may want to preprocess before doing anything with it.
+ * Don't do so if an equation is open.
+ */
- token[i] = 0;
+ if (r->last) {
+ t = r->last->tok;
+ assert(roffs[t].sub);
+ return((*roffs[t].sub)
+ (r, t, bufp, szp,
+ ln, ppos, pos, offs));
+ }
- /* FIXME: use a table, this is slow but ok for now. */
+ /*
+ * Lastly, as we've no scope open, try to look up and execute
+ * the new macro. If no macro is found, simply return and let
+ * the compilers handle it.
+ */
- /* LINTED */
- for (i = 0; i < ROFF_MAX; i++)
- /* LINTED */
- if (0 == strcmp(toknames[i], token))
- return((int)i);
+ if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos)))
+ return(ROFF_CONT);
- return(ROFF_MAX);
+ assert(roffs[t].proc);
+ return((*roffs[t].proc)
+ (r, t, bufp, szp,
+ ln, ppos, pos, offs));
}
-static int
-roffchecksec(struct rofftree *tree, const char *start, int sec)
+void
+roff_endparse(struct roff *r)
{
- int prior;
- switch (sec) {
- case(ROFFSec_SYNOP):
- if ((prior = ROFFSec_NAME) & tree->asec)
- return(1);
- break;
- case(ROFFSec_DESC):
- if ((prior = ROFFSec_SYNOP) & tree->asec)
- return(1);
- break;
- case(ROFFSec_RETVAL):
- if ((prior = ROFFSec_DESC) & tree->asec)
- return(1);
- break;
- case(ROFFSec_ENV):
- if ((prior = ROFFSec_RETVAL) & tree->asec)
- return(1);
- break;
- case(ROFFSec_FILES):
- if ((prior = ROFFSec_ENV) & tree->asec)
- return(1);
- break;
- case(ROFFSec_EX):
- if ((prior = ROFFSec_FILES) & tree->asec)
- return(1);
- break;
- case(ROFFSec_DIAG):
- if ((prior = ROFFSec_EX) & tree->asec)
- return(1);
- break;
- case(ROFFSec_ERRS):
- if ((prior = ROFFSec_DIAG) & tree->asec)
- return(1);
- break;
- case(ROFFSec_SEEALSO):
- if ((prior = ROFFSec_ERRS) & tree->asec)
- return(1);
- break;
- case(ROFFSec_STAND):
- if ((prior = ROFFSec_SEEALSO) & tree->asec)
- return(1);
- break;
- case(ROFFSec_HIST):
- if ((prior = ROFFSec_STAND) & tree->asec)
- return(1);
- break;
- case(ROFFSec_AUTH):
- if ((prior = ROFFSec_HIST) & tree->asec)
- return(1);
- break;
- case(ROFFSec_CAVEATS):
- if ((prior = ROFFSec_AUTH) & tree->asec)
- return(1);
- break;
- case(ROFFSec_BUGS):
- if ((prior = ROFFSec_CAVEATS) & tree->asec)
- return(1);
- break;
- default:
- return(1);
+ if (r->last)
+ mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
+ r->last->line, r->last->col, NULL);
+
+ if (r->eqn) {
+ mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
+ r->eqn->eqn.line, r->eqn->eqn.pos, NULL);
+ eqn_end(r->eqn);
+ r->eqn = NULL;
}
- roff_warn(tree, start, "section violates conventional order");
- return(1);
+ if (r->tbl) {
+ mandoc_msg(MANDOCERR_SCOPEEXIT, r->parse,
+ r->tbl->line, r->tbl->pos, NULL);
+ tbl_end(r->tbl);
+ r->tbl = NULL;
+ }
}
-
-static int
-roffissec(const char **p)
+/*
+ * Parse a roff node's type from the input buffer. This must be in the
+ * form of ".foo xxx" in the usual way.
+ */
+static enum rofft
+roff_parse(struct roff *r, const char *buf, int *pos)
{
+ const char *mac;
+ size_t maclen;
+ enum rofft t;
- assert(*p);
- if (NULL != *(p + 1)) {
- if (NULL != *(p + 2))
- return(ROFFSec_OTHER);
- if (0 == strcmp(*p, "RETURN") &&
- 0 == strcmp(*(p + 1), "VALUES"))
- return(ROFFSec_RETVAL);
- if (0 == strcmp(*p, "SEE") &&
- 0 == strcmp(*(p + 1), "ALSO"))
- return(ROFFSec_SEEALSO);
- return(ROFFSec_OTHER);
- }
+ if ('\0' == buf[*pos] || '"' == buf[*pos] ||
+ '\t' == buf[*pos] || ' ' == buf[*pos])
+ return(ROFF_MAX);
- if (0 == strcmp(*p, "NAME"))
- return(ROFFSec_NAME);
- else if (0 == strcmp(*p, "SYNOPSIS"))
- return(ROFFSec_SYNOP);
- else if (0 == strcmp(*p, "DESCRIPTION"))
- return(ROFFSec_DESC);
- else if (0 == strcmp(*p, "ENVIRONMENT"))
- return(ROFFSec_ENV);
- else if (0 == strcmp(*p, "FILES"))
- return(ROFFSec_FILES);
- else if (0 == strcmp(*p, "EXAMPLES"))
- return(ROFFSec_EX);
- else if (0 == strcmp(*p, "DIAGNOSTICS"))
- return(ROFFSec_DIAG);
- else if (0 == strcmp(*p, "ERRORS"))
- return(ROFFSec_ERRS);
- else if (0 == strcmp(*p, "STANDARDS"))
- return(ROFFSec_STAND);
- else if (0 == strcmp(*p, "HISTORY"))
- return(ROFFSec_HIST);
- else if (0 == strcmp(*p, "AUTHORS"))
- return(ROFFSec_AUTH);
- else if (0 == strcmp(*p, "CAVEATS"))
- return(ROFFSec_CAVEATS);
- else if (0 == strcmp(*p, "BUGS"))
- return(ROFFSec_BUGS);
-
- return(ROFFSec_OTHER);
-}
+ /*
+ * We stop the macro parse at an escape, tab, space, or nil.
+ * However, `\}' is also a valid macro, so make sure we don't
+ * clobber it by seeing the `\' as the end of token.
+ */
+ mac = buf + *pos;
+ maclen = strcspn(mac + 1, " \\\t\0") + 1;
-static int
-roffismsec(const char *p)
-{
+ t = (r->current_string = roff_getstrn(r, mac, maclen))
+ ? ROFF_USERDEF : roff_hash_find(mac, maclen);
- if (0 == strcmp(p, "1"))
- return(ROFF_MSEC_1);
- else if (0 == strcmp(p, "2"))
- return(ROFF_MSEC_2);
- else if (0 == strcmp(p, "3"))
- return(ROFF_MSEC_3);
- else if (0 == strcmp(p, "3p"))
- return(ROFF_MSEC_3p);
- else if (0 == strcmp(p, "4"))
- return(ROFF_MSEC_4);
- else if (0 == strcmp(p, "5"))
- return(ROFF_MSEC_5);
- else if (0 == strcmp(p, "6"))
- return(ROFF_MSEC_6);
- else if (0 == strcmp(p, "7"))
- return(ROFF_MSEC_7);
- else if (0 == strcmp(p, "8"))
- return(ROFF_MSEC_8);
- else if (0 == strcmp(p, "9"))
- return(ROFF_MSEC_9);
- else if (0 == strcmp(p, "unass"))
- return(ROFF_MSEC_UNASS);
- else if (0 == strcmp(p, "draft"))
- return(ROFF_MSEC_DRAFT);
- else if (0 == strcmp(p, "paper"))
- return(ROFF_MSEC_PAPER);
-
- return(ROFF_MSEC_MAX);
-}
+ *pos += (int)maclen;
+ while (buf[*pos] && ' ' == buf[*pos])
+ (*pos)++;
-static int
-roffisatt(const char *p)
-{
-
- assert(p);
- if (0 == strcmp(p, "v1"))
- return(1);
- else if (0 == strcmp(p, "v2"))
- return(1);
- else if (0 == strcmp(p, "v3"))
- return(1);
- else if (0 == strcmp(p, "v6"))
- return(1);
- else if (0 == strcmp(p, "v7"))
- return(1);
- else if (0 == strcmp(p, "32v"))
- return(1);
- else if (0 == strcmp(p, "V.1"))
- return(1);
- else if (0 == strcmp(p, "V.4"))
- return(1);
-
- return(0);
+ return(t);
}
-
-static int
-roffispunct(const char *p)
+/* ARGSUSED */
+static enum rofferr
+roff_cblock(ROFF_ARGS)
{
- if (0 == *p)
- return(0);
- if (0 != *(p + 1))
- return(0);
+ /*
+ * A block-close `..' should only be invoked as a child of an
+ * ignore macro, otherwise raise a warning and just ignore it.
+ */
- switch (*p) {
- case('{'):
- /* FALLTHROUGH */
- case('.'):
- /* FALLTHROUGH */
- case(','):
- /* FALLTHROUGH */
- case(';'):
- /* FALLTHROUGH */
- case(':'):
- /* FALLTHROUGH */
- case('?'):
- /* FALLTHROUGH */
- case('!'):
+ if (NULL == r->last) {
+ mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
+ return(ROFF_IGN);
+ }
+
+ switch (r->last->tok) {
+ case (ROFF_am):
/* FALLTHROUGH */
- case('('):
+ case (ROFF_ami):
/* FALLTHROUGH */
- case(')'):
+ case (ROFF_am1):
/* FALLTHROUGH */
- case('['):
+ case (ROFF_de):
+ /* ROFF_de1 is remapped to ROFF_de in roff_block(). */
/* FALLTHROUGH */
- case(']'):
+ case (ROFF_dei):
/* FALLTHROUGH */
- case('}'):
- return(1);
- default:
+ case (ROFF_ig):
break;
+ default:
+ mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
+ return(ROFF_IGN);
}
- return(0);
-}
-
-
-static int
-rofffindcallable(const char *name)
-{
- int c;
-
- if (ROFF_MAX == (c = rofffindtok(name)))
- return(ROFF_MAX);
- assert(c >= 0 && c < ROFF_MAX);
- return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX);
-}
-
-
-static struct roffnode *
-roffnode_new(int tokid, struct rofftree *tree)
-{
- struct roffnode *p;
-
- if (NULL == (p = malloc(sizeof(struct roffnode))))
- err(1, "malloc");
-
- p->tok = tokid;
- p->parent = tree->last;
- tree->last = p;
-
- return(p);
-}
-
-
-static int
-roffargok(int tokid, int argid)
-{
- const int *c;
-
- if (NULL == (c = tokens[tokid].args))
- return(0);
+ if ((*bufp)[pos])
+ mandoc_msg(MANDOCERR_ARGSLOST, r->parse, ln, pos, NULL);
- for ( ; ROFF_ARGMAX != *c; c++)
- if (argid == *c)
- return(1);
+ roffnode_pop(r);
+ roffnode_cleanscope(r);
+ return(ROFF_IGN);
- return(0);
}
static void
-roffnode_free(struct rofftree *tree)
+roffnode_cleanscope(struct roff *r)
{
- struct roffnode *p;
- assert(tree->last);
-
- p = tree->last;
- tree->last = tree->last->parent;
- free(p);
+ while (r->last) {
+ if (--r->last->endspan < 0)
+ break;
+ roffnode_pop(r);
+ }
}
-static int
-roffspecial(struct rofftree *tree, int tok, const char *start,
- const int *argc, const char **argv,
- size_t sz, char **ordp)
+/* ARGSUSED */
+static enum rofferr
+roff_ccond(ROFF_ARGS)
{
- switch (tok) {
- case (ROFF_At):
- if (0 == sz)
- break;
- if (roffisatt(*ordp))
- break;
- roff_err(tree, *ordp, "invalid `At' arg");
- return(0);
-
- case (ROFF_Xr):
- if (2 == sz) {
- assert(ordp[1]);
- if (ROFF_MSEC_MAX != roffismsec(ordp[1]))
- break;
- roff_warn(tree, start, "invalid `%s' manual "
- "section", toknames[tok]);
- }
- /* FALLTHROUGH */
-
- case (ROFF_Sx):
- /* FALLTHROUGH*/
- case (ROFF_Fn):
- if (0 != sz)
- break;
- roff_err(tree, start, "`%s' expects at least "
- "one arg", toknames[tok]);
- return(0);
-
- case (ROFF_Nm):
- if (0 == sz) {
- if (0 == tree->name[0]) {
- roff_err(tree, start, "`Nm' not set");
- return(0);
- }
- ordp[0] = tree->name;
- ordp[1] = NULL;
- } else if ( ! roffsetname(tree, ordp))
- return(0);
- break;
-
- case (ROFF_Rv):
- /* FALLTHROUGH*/
- case (ROFF_Ex):
- if (1 == sz)
- break;
- roff_err(tree, start, "`%s' expects one arg",
- toknames[tok]);
- return(0);
+ if (NULL == r->last) {
+ mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
+ return(ROFF_IGN);
+ }
- case (ROFF_Sm):
- if (1 != sz) {
- roff_err(tree, start, "`Sm' expects one arg");
- return(0);
- }
-
- if (0 != strcmp(ordp[0], "on") &&
- 0 != strcmp(ordp[0], "off")) {
- roff_err(tree, start, "`Sm' has invalid argument");
- return(0);
- }
- break;
-
- case (ROFF_Ud):
+ switch (r->last->tok) {
+ case (ROFF_el):
/* FALLTHROUGH */
- case (ROFF_Ux):
+ case (ROFF_ie):
/* FALLTHROUGH */
- case (ROFF_Bt):
- if (0 != sz) {
- roff_err(tree, start, "`%s' expects no args",
- toknames[tok]);
- return(0);
- }
+ case (ROFF_if):
break;
default:
- break;
+ mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
+ return(ROFF_IGN);
}
- return((*tree->cb.roffspecial)(tree->arg, tok, tree->cur,
- argc, argv, (const char **)ordp));
-}
-
-
-static int
-roffexit(struct rofftree *tree, int tok)
-{
-
- assert(tokens[tok].cb);
- return((*tokens[tok].cb)(tok, tree, NULL, ROFF_EXIT));
-}
-
-
-static int
-roffcall(struct rofftree *tree, int tok, char **argv)
-{
- int i;
- enum roffmsec c;
-
- if (NULL == tokens[tok].cb) {
- roff_err(tree, *argv, "`%s' is unsupported",
- toknames[tok]);
- return(0);
- }
- if (tokens[tok].sections && ROFF_MSEC_MAX != tree->section) {
- i = 0;
- while (ROFF_MSEC_MAX !=
- (c = tokens[tok].sections[i++]))
- if (c == tree->section)
- break;
- if (ROFF_MSEC_MAX == c) {
- roff_warn(tree, *argv, "`%s' is not a valid "
- "macro in this manual section",
- toknames[tok]);
- }
- }
-
- return((*tokens[tok].cb)(tok, tree, argv, ROFF_ENTER));
-}
-
-
-static int
-roffnextopt(const struct rofftree *tree, int tok,
- char ***in, char **val)
-{
- char *arg, **argv;
- int v;
-
- *val = NULL;
- argv = *in;
- assert(argv);
-
- if (NULL == (arg = *argv))
- return(-1);
- if ('-' != *arg)
- return(-1);
-
- if (ROFF_ARGMAX == (v = rofffindarg(arg + 1))) {
- roff_warn(tree, arg, "argument-like parameter `%s' to "
- "`%s'", arg, toknames[tok]);
- return(-1);
- }
-
- if ( ! roffargok(tok, v)) {
- roff_warn(tree, arg, "invalid argument parameter `%s' to "
- "`%s'", tokargnames[v], toknames[tok]);
- return(-1);
- }
-
- if ( ! (ROFF_VALUE & tokenargs[v]))
- return(v);
-
- *in = ++argv;
-
- if (NULL == *argv) {
- roff_err(tree, arg, "empty value of `%s' for `%s'",
- tokargnames[v], toknames[tok]);
- return(ROFF_ARGMAX);
- }
-
- return(v);
-}
-
-
-static int
-roffpurgepunct(struct rofftree *tree, char **argv)
-{
- int i;
+ if (r->last->endspan > -1) {
+ mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
+ return(ROFF_IGN);
+ }
- i = 0;
- while (argv[i])
- i++;
- assert(i > 0);
- if ( ! roffispunct(argv[--i]))
- return(1);
- while (i >= 0 && roffispunct(argv[i]))
- i--;
- i++;
-
- /* LINTED */
- while (argv[i])
- if ( ! roffdata(tree, 0, argv[i++]))
- return(0);
- return(1);
+ if ((*bufp)[pos])
+ mandoc_msg(MANDOCERR_ARGSLOST, r->parse, ln, pos, NULL);
+
+ roffnode_pop(r);
+ roffnode_cleanscope(r);
+ return(ROFF_IGN);
}
-static int
-roffparseopts(struct rofftree *tree, int tok,
- char ***args, int *argc, char **argv)
+/* ARGSUSED */
+static enum rofferr
+roff_block(ROFF_ARGS)
{
- int i, c;
- char *v;
-
- i = 0;
+ int sv;
+ size_t sz;
+ char *name;
- while (-1 != (c = roffnextopt(tree, tok, args, &v))) {
- if (ROFF_ARGMAX == c)
- return(0);
+ name = NULL;
- argc[i] = c;
- argv[i] = v;
- i++;
- *args = *args + 1;
- }
+ if (ROFF_ig != tok) {
+ if ('\0' == (*bufp)[pos]) {
+ mandoc_msg(MANDOCERR_NOARGS, r->parse, ln, ppos, NULL);
+ return(ROFF_IGN);
+ }
- argc[i] = ROFF_ARGMAX;
- argv[i] = NULL;
- return(1);
-}
+ /*
+ * Re-write `de1', since we don't really care about
+ * groff's strange compatibility mode, into `de'.
+ */
+ if (ROFF_de1 == tok)
+ tok = ROFF_de;
+ if (ROFF_de == tok)
+ name = *bufp + pos;
+ else
+ mandoc_msg(MANDOCERR_REQUEST, r->parse, ln, ppos,
+ roffs[tok].name);
-static int
-roffdata(struct rofftree *tree, int space, char *buf)
-{
+ while ((*bufp)[pos] && ! isspace((unsigned char)(*bufp)[pos]))
+ pos++;
- if (0 == *buf)
- return(1);
- return((*tree->cb.roffdata)(tree->arg,
- space != 0, tree->cur, buf));
-}
+ while (isspace((unsigned char)(*bufp)[pos]))
+ (*bufp)[pos++] = '\0';
+ }
+ roffnode_push(r, tok, name, ln, ppos);
-/* ARGSUSED */
-static int
-roff_Dd(ROFFCALL_ARGS)
-{
- time_t t;
- char *p, buf[32];
+ /*
+ * At the beginning of a `de' macro, clear the existing string
+ * with the same name, if there is one. New content will be
+ * added from roff_block_text() in multiline mode.
+ */
- if (ROFF_BODY & tree->state) {
- assert( ! (ROFF_PRELUDE & tree->state));
- assert(ROFF_PRELUDE_Dd & tree->state);
- return(roff_text(tok, tree, argv, type));
- }
+ if (ROFF_de == tok)
+ roff_setstr(r, name, "", 0);
- assert(ROFF_PRELUDE & tree->state);
- assert( ! (ROFF_BODY & tree->state));
+ if ('\0' == (*bufp)[pos])
+ return(ROFF_IGN);
- if (ROFF_PRELUDE_Dd & tree->state) {
- roff_err(tree, *argv, "repeated `Dd' in prelude");
- return(0);
- } else if (ROFF_PRELUDE_Dt & tree->state) {
- roff_err(tree, *argv, "out-of-order `Dd' in prelude");
- return(0);
- }
+ /* If present, process the custom end-of-line marker. */
- assert(NULL == tree->last);
+ sv = pos;
+ while ((*bufp)[pos] && ! isspace((unsigned char)(*bufp)[pos]))
+ pos++;
- argv++;
+ /*
+ * Note: groff does NOT like escape characters in the input.
+ * Instead of detecting this, we're just going to let it fly and
+ * to hell with it.
+ */
- if (0 == strcmp(*argv, "$Mdocdate: December 8 2008 $")) {
- t = time(NULL);
- if (NULL == localtime_r(&t, &tree->tm))
- err(1, "localtime_r");
- tree->state |= ROFF_PRELUDE_Dd;
- return(1);
- }
+ assert(pos > sv);
+ sz = (size_t)(pos - sv);
- /* Build this from Mdocdate or raw date. */
-
- buf[0] = 0;
- p = *argv;
+ if (1 == sz && '.' == (*bufp)[sv])
+ return(ROFF_IGN);
- if (0 != strcmp(*argv, "$Mdocdate:")) {
- while (*argv) {
- if (strlcat(buf, *argv++, sizeof(buf))
- < sizeof(buf))
- continue;
- roff_err(tree, p, "bad `Dd' date");
- return(0);
- }
- if (strptime(buf, "%b%d,%Y", &tree->tm)) {
- tree->state |= ROFF_PRELUDE_Dd;
- return(1);
- }
- roff_err(tree, *argv, "bad `Dd' date");
- return(0);
- }
+ r->last->end = mandoc_malloc(sz + 1);
- argv++;
- while (*argv && **argv != '$') {
- if (strlcat(buf, *argv++, sizeof(buf))
- >= sizeof(buf)) {
- roff_err(tree, p, "bad `Dd' Mdocdate");
- return(0);
- }
- if (strlcat(buf, " ", sizeof(buf))
- >= sizeof(buf)) {
- roff_err(tree, p, "bad `Dd' Mdocdate");
- return(0);
- }
- }
- if (NULL == *argv) {
- roff_err(tree, p, "bad `Dd' Mdocdate");
- return(0);
- }
+ memcpy(r->last->end, *bufp + sv, sz);
+ r->last->end[(int)sz] = '\0';
- if (NULL == strptime(buf, "%b %d %Y", &tree->tm)) {
- roff_err(tree, *argv, "bad `Dd' Mdocdate");
- return(0);
- }
+ if ((*bufp)[pos])
+ mandoc_msg(MANDOCERR_ARGSLOST, r->parse, ln, pos, NULL);
- tree->state |= ROFF_PRELUDE_Dd;
- return(1);
+ return(ROFF_IGN);
}
/* ARGSUSED */
-static int
-roff_Dt(ROFFCALL_ARGS)
+static enum rofferr
+roff_block_sub(ROFF_ARGS)
{
+ enum rofft t;
+ int i, j;
- if (ROFF_BODY & tree->state) {
- assert( ! (ROFF_PRELUDE & tree->state));
- assert(ROFF_PRELUDE_Dt & tree->state);
- return(roff_text(tok, tree, argv, type));
- }
+ /*
+ * First check whether a custom macro exists at this level. If
+ * it does, then check against it. This is some of groff's
+ * stranger behaviours. If we encountered a custom end-scope
+ * tag and that tag also happens to be a "real" macro, then we
+ * need to try interpreting it again as a real macro. If it's
+ * not, then return ignore. Else continue.
+ */
- assert(ROFF_PRELUDE & tree->state);
- assert( ! (ROFF_BODY & tree->state));
+ if (r->last->end) {
+ for (i = pos, j = 0; r->last->end[j]; j++, i++)
+ if ((*bufp)[i] != r->last->end[j])
+ break;
- if ( ! (ROFF_PRELUDE_Dd & tree->state)) {
- roff_err(tree, *argv, "out-of-order `Dt' in prelude");
- return(0);
- } else if (ROFF_PRELUDE_Dt & tree->state) {
- roff_err(tree, *argv, "repeated `Dt' in prelude");
- return(0);
- }
+ if ('\0' == r->last->end[j] &&
+ ('\0' == (*bufp)[i] ||
+ ' ' == (*bufp)[i] ||
+ '\t' == (*bufp)[i])) {
+ roffnode_pop(r);
+ roffnode_cleanscope(r);
- argv++;
- if (NULL == *argv) {
- roff_err(tree, *argv, "`Dt' needs document title");
- return(0);
- } else if (strlcpy(tree->title, *argv, sizeof(tree->title))
- >= sizeof(tree->title)) {
- roff_err(tree, *argv, "`Dt' document title too long");
- return(0);
+ while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
+ i++;
+
+ pos = i;
+ if (ROFF_MAX != roff_parse(r, *bufp, &pos))
+ return(ROFF_RERUN);
+ return(ROFF_IGN);
+ }
}
- argv++;
- if (NULL == *argv) {
- roff_err(tree, *argv, "`Dt' needs section");
- return(0);
- }
+ /*
+ * If we have no custom end-query or lookup failed, then try
+ * pulling it out of the hashtable.
+ */
- if (ROFF_MSEC_MAX == (tree->section = roffismsec(*argv))) {
- roff_err(tree, *argv, "bad `Dt' section");
- return(0);
- }
+ t = roff_parse(r, *bufp, &pos);
- argv++;
- if (NULL == *argv) {
- tree->volume[0] = 0;
- } else if (strlcpy(tree->volume, *argv, sizeof(tree->volume))
- >= sizeof(tree->volume)) {
- roff_err(tree, *argv, "`Dt' volume too long");
- return(0);
+ /*
+ * Macros other than block-end are only significant
+ * in `de' blocks; elsewhere, simply throw them away.
+ */
+ if (ROFF_cblock != t) {
+ if (ROFF_de == tok)
+ roff_setstr(r, r->last->name, *bufp + ppos, 1);
+ return(ROFF_IGN);
}
- assert(NULL == tree->last);
- tree->state |= ROFF_PRELUDE_Dt;
-
- return(1);
+ assert(roffs[t].proc);
+ return((*roffs[t].proc)(r, t, bufp, szp,
+ ln, ppos, pos, offs));
}
-static int
-roffsetname(struct rofftree *tree, char **ordp)
+/* ARGSUSED */
+static enum rofferr
+roff_block_text(ROFF_ARGS)
{
-
- assert(*ordp);
- /* FIXME: not all sections can set this. */
-
- if (NULL != *(ordp + 1)) {
- roff_err(tree, *ordp, "too many `Nm' args");
- return(0);
- }
-
- if (strlcpy(tree->name, *ordp, sizeof(tree->name))
- >= sizeof(tree->name)) {
- roff_err(tree, *ordp, "`Nm' arg too long");
- return(0);
- }
+ if (ROFF_de == tok)
+ roff_setstr(r, r->last->name, *bufp + pos, 1);
- return(1);
+ return(ROFF_IGN);
}
/* ARGSUSED */
-static int
-roff_Ns(ROFFCALL_ARGS)
+static enum rofferr
+roff_cond_sub(ROFF_ARGS)
{
- int j, c, first;
- char *morep[1];
-
- first = (*argv++ == tree->cur);
- morep[0] = NULL;
-
- if ( ! roffspecial(tree, tok, *argv, NULL, NULL, 0, morep))
- return(0);
+ enum rofft t;
+ enum roffrule rr;
+ char *ep;
- while (*argv) {
- if (ROFF_MAX != (c = rofffindcallable(*argv))) {
- if ( ! roffcall(tree, c, argv))
- return(0);
- break;
- }
+ rr = r->last->rule;
+ roffnode_cleanscope(r);
- if ( ! roffispunct(*argv)) {
- if ( ! roffdata(tree, 1, *argv++))
- return(0);
- continue;
- }
+ /*
+ * If the macro is unknown, first check if it contains a closing
+ * delimiter `\}'. If it does, close out our scope and return
+ * the currently-scoped rule (ignore or continue). Else, drop
+ * into the currently-scoped rule.
+ */
- for (j = 0; argv[j]; j++)
- if ( ! roffispunct(argv[j]))
- break;
+ if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos))) {
+ ep = &(*bufp)[pos];
+ for ( ; NULL != (ep = strchr(ep, '\\')); ep++) {
+ ep++;
+ if ('}' != *ep)
+ continue;
- if (argv[j]) {
- if ( ! roffdata(tree, 0, *argv++))
- return(0);
- continue;
+ /*
+ * Make the \} go away.
+ * This is a little haphazard, as it's not quite
+ * clear how nroff does this.
+ * If we're at the end of line, then just chop
+ * off the \} and resize the buffer.
+ * If we aren't, then conver it to spaces.
+ */
+
+ if ('\0' == *(ep + 1)) {
+ *--ep = '\0';
+ *szp -= 2;
+ } else
+ *(ep - 1) = *ep = ' ';
+
+ roff_ccond(r, ROFF_ccond, bufp, szp,
+ ln, pos, pos + 2, offs);
+ break;
}
-
- break;
+ return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
}
- if ( ! first)
- return(1);
+ /*
+ * A denied conditional must evaluate its children if and only
+ * if they're either structurally required (such as loops and
+ * conditionals) or a closing macro.
+ */
- return(roffpurgepunct(tree, argv));
-}
+ if (ROFFRULE_DENY == rr)
+ if ( ! (ROFFMAC_STRUCT & roffs[t].flags))
+ if (ROFF_ccond != t)
+ return(ROFF_IGN);
+ assert(roffs[t].proc);
+ return((*roffs[t].proc)(r, t, bufp, szp,
+ ln, ppos, pos, offs));
+}
/* ARGSUSED */
-static int
-roff_Os(ROFFCALL_ARGS)
+static enum rofferr
+roff_cond_text(ROFF_ARGS)
{
- char *p;
+ char *ep;
+ enum roffrule rr;
- if (ROFF_BODY & tree->state) {
- assert( ! (ROFF_PRELUDE & tree->state));
- assert(ROFF_PRELUDE_Os & tree->state);
- return(roff_text(tok, tree, argv, type));
- }
+ rr = r->last->rule;
+ roffnode_cleanscope(r);
- assert(ROFF_PRELUDE & tree->state);
- if ( ! (ROFF_PRELUDE_Dt & tree->state) ||
- ! (ROFF_PRELUDE_Dd & tree->state)) {
- roff_err(tree, *argv, "out-of-order `Os' in prelude");
- return(0);
+ ep = &(*bufp)[pos];
+ for ( ; NULL != (ep = strchr(ep, '\\')); ep++) {
+ ep++;
+ if ('}' != *ep)
+ continue;
+ *ep = '&';
+ roff_ccond(r, ROFF_ccond, bufp, szp,
+ ln, pos, pos + 2, offs);
}
+ return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
+}
- tree->os[0] = 0;
-
- p = *++argv;
+static enum roffrule
+roff_evalcond(const char *v, int *pos)
+{
- while (*argv) {
- if (strlcat(tree->os, *argv++, sizeof(tree->os))
- < sizeof(tree->os))
- continue;
- roff_err(tree, p, "`Os' value too long");
- return(0);
+ switch (v[*pos]) {
+ case ('n'):
+ (*pos)++;
+ return(ROFFRULE_ALLOW);
+ case ('e'):
+ /* FALLTHROUGH */
+ case ('o'):
+ /* FALLTHROUGH */
+ case ('t'):
+ (*pos)++;
+ return(ROFFRULE_DENY);
+ default:
+ break;
}
- if (0 == tree->os[0])
- if (strlcpy(tree->os, "LOCAL", sizeof(tree->os))
- >= sizeof(tree->os)) {
- roff_err(tree, p, "`Os' value too long");
- return(0);
- }
-
- tree->state |= ROFF_PRELUDE_Os;
- tree->state &= ~ROFF_PRELUDE;
- tree->state |= ROFF_BODY;
+ while (v[*pos] && ' ' != v[*pos])
+ (*pos)++;
+ return(ROFFRULE_DENY);
+}
- assert(ROFF_MSEC_MAX != tree->section);
- assert(0 != tree->title[0]);
- assert(0 != tree->os[0]);
+/* ARGSUSED */
+static enum rofferr
+roff_line_ignore(ROFF_ARGS)
+{
- assert(NULL == tree->last);
+ if (ROFF_it == tok)
+ mandoc_msg(MANDOCERR_REQUEST, r->parse, ln, ppos, "it");
- return((*tree->cb.roffhead)(tree->arg, &tree->tm,
- tree->os, tree->title, tree->section,
- tree->volume));
+ return(ROFF_IGN);
}
-
/* ARGSUSED */
-static int
-roff_layout(ROFFCALL_ARGS)
+static enum rofferr
+roff_cond(ROFF_ARGS)
{
- int i, c, argcp[ROFF_MAXLINEARG];
- char *argvp[ROFF_MAXLINEARG], *p;
+ int sv;
+ enum roffrule rule;
- /*
- * The roff_layout function is for multi-line macros. A layout
- * has a start and end point, which is either declared
- * explicitly or implicitly. An explicit start and end is
- * embodied by `.Bl' and `.El', with the former being the start
- * and the latter being an end. The `.Sh' and `.Ss' tags, on
- * the other hand, are implicit. The scope of a layout is the
- * space between start and end. Explicit layouts may not close
- * out implicit ones and vice versa; implicit layouts may close
- * out other implicit layouts.
+ /*
+ * An `.el' has no conditional body: it will consume the value
+ * of the current rstack entry set in prior `ie' calls or
+ * defaults to DENY.
+ *
+ * If we're not an `el', however, then evaluate the conditional.
*/
- assert( ! (ROFF_CALLABLE & tokens[tok].flags));
+ rule = ROFF_el == tok ?
+ (r->rstackpos < 0 ?
+ ROFFRULE_DENY : r->rstack[r->rstackpos--]) :
+ roff_evalcond(*bufp, &pos);
- if (ROFF_PRELUDE & tree->state) {
- roff_err(tree, *argv, "bad `%s' in prelude",
- toknames[tok]);
- return(0);
- } else if (ROFF_EXIT == type) {
- roffnode_free(tree);
- if ( ! (*tree->cb.roffblkbodyout)(tree->arg, tok))
- return(0);
- return((*tree->cb.roffblkout)(tree->arg, tok));
- }
+ sv = pos;
+ while (' ' == (*bufp)[pos])
+ pos++;
- assert( ! (ROFF_CALLABLE & tokens[tok].flags));
+ /*
+ * Roff is weird. If we have just white-space after the
+ * conditional, it's considered the BODY and we exit without
+ * really doing anything. Warn about this. It's probably
+ * wrong.
+ */
- p = *argv++;
+ if ('\0' == (*bufp)[pos] && sv != pos) {
+ mandoc_msg(MANDOCERR_NOARGS, r->parse, ln, ppos, NULL);
+ return(ROFF_IGN);
+ }
- if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))
- return(0);
- if (NULL == roffnode_new(tok, tree))
- return(0);
+ roffnode_push(r, tok, NULL, ln, ppos);
+
+ r->last->rule = rule;
/*
- * Layouts have two parts: the layout body and header. The
- * layout header is the trailing text of the line macro, while
- * the layout body is everything following until termination.
- * Example:
- *
- * .It Fl f ) ;
- * Bar.
- *
- * ...Produces...
- *
- * <block>
- * <head>
- * <!Fl f!> ;
- * </head>
- *
- * <body>
- * Bar.
- * </body>
- * </block>
+ * An if-else will put the NEGATION of the current evaluated
+ * conditional into the stack of rules.
*/
- if ( ! (*tree->cb.roffblkin)(tree->arg, tok, argcp,
- (const char **)argvp))
- return(0);
-
- /* +++ Begin run macro-specific hooks over argv. */
-
- switch (tok) {
- case (ROFF_Sh):
- if (NULL == *argv) {
- roff_err(tree, *(argv - 1),
- "`Sh' expects arguments");
- return(0);
+ if (ROFF_ie == tok) {
+ if (r->rstackpos == RSTACK_MAX - 1) {
+ mandoc_msg(MANDOCERR_MEM,
+ r->parse, ln, ppos, NULL);
+ return(ROFF_ERR);
}
- tree->csec = roffissec((const char **)argv);
- if ( ! (ROFFSec_OTHER & tree->csec) &&
- tree->asec & tree->csec)
- roff_warn(tree, *argv, "section repeated");
- if (0 == tree->asec && ! (ROFFSec_NAME & tree->csec)) {
- roff_err(tree, *argv, "`NAME' section "
- "must be first");
- return(0);
- } else if ( ! roffchecksec(tree, *argv, tree->csec))
- return(0);
-
- tree->asec |= tree->csec;
- break;
- default:
- break;
+ r->rstack[++r->rstackpos] =
+ ROFFRULE_DENY == r->last->rule ?
+ ROFFRULE_ALLOW : ROFFRULE_DENY;
}
- /* --- End run macro-specific hooks over argv. */
-
- if (NULL == *argv)
- return((*tree->cb.roffblkbodyin)
- (tree->arg, tok, argcp,
- (const char **)argvp));
+ /* If the parent has false as its rule, then so do we. */
- if ( ! (*tree->cb.roffblkheadin)(tree->arg, tok, argcp,
- (const char **)argvp))
- return(0);
+ if (r->last->parent && ROFFRULE_DENY == r->last->parent->rule)
+ r->last->rule = ROFFRULE_DENY;
/*
- * If there are no parsable parts, then write remaining tokens
- * into the layout header and exit.
+ * Determine scope. If we're invoked with "\{" trailing the
+ * conditional, then we're in a multiline scope. Else our scope
+ * expires on the next line.
*/
- if ( ! (ROFF_PARSED & tokens[tok].flags)) {
- i = 0;
- while (*argv)
- if ( ! roffdata(tree, i++, *argv++))
- return(0);
+ r->last->endspan = 1;
- if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))
- return(0);
- return((*tree->cb.roffblkbodyin)(tree->arg, tok, argcp,
- (const char **)argvp));
- }
+ if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
+ r->last->endspan = -1;
+ pos += 2;
+ }
/*
- * Parsable elements may be in the header (or be the header, for
- * that matter). Follow the regular parsing rules for these.
- */
-
- i = 0;
- while (*argv) {
- if (ROFF_MAX == (c = rofffindcallable(*argv))) {
- assert(tree->arg);
- if ( ! roffdata(tree, i++, *argv++))
- return(0);
- continue;
- }
- if ( ! roffcall(tree, c, argv))
- return(0);
- break;
- }
-
- /*
- * If there's trailing punctuation in the header, then write it
- * out now. Here we mimic the behaviour of a line-dominant text
- * macro.
+ * If there are no arguments on the line, the next-line scope is
+ * assumed.
*/
- if (NULL == *argv) {
- if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))
- return(0);
- return((*tree->cb.roffblkbodyin)
- (tree->arg, tok, argcp,
- (const char **)argvp));
- }
+ if ('\0' == (*bufp)[pos])
+ return(ROFF_IGN);
- /*
- * Expensive. Scan to the end of line then work backwards until
- * a token isn't punctuation.
- */
+ /* Otherwise re-run the roff parser after recalculating. */
- if ( ! roffpurgepunct(tree, argv))
- return(0);
- if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok))
- return(0);
- return((*tree->cb.roffblkbodyin)(tree->arg,
- tok, argcp, (const char **)argvp));
+ *offs = pos;
+ return(ROFF_RERUN);
}
/* ARGSUSED */
-static int
-roff_ordered(ROFFCALL_ARGS)
+static enum rofferr
+roff_ds(ROFF_ARGS)
{
- int i, first, c, argcp[ROFF_MAXLINEARG];
- char *ordp[ROFF_MAXLINEARG], *p,
- *argvp[ROFF_MAXLINEARG];
+ char *name, *string;
/*
- * Ordered macros pass their arguments directly to handlers,
- * instead of considering it free-form text. Thus, the
- * following macro looks as follows:
+ * A symbol is named by the first word following the macro
+ * invocation up to a space. Its value is anything after the
+ * name's trailing whitespace and optional double-quote. Thus,
*
- * .Xr foo 1 ) ,
+ * [.ds foo "bar " ]
*
- * .Xr arg1 arg2 punctuation
+ * will have `bar " ' as its value.
*/
- if (ROFF_PRELUDE & tree->state) {
- roff_err(tree, *argv, "`%s' disallowed in prelude",
- toknames[tok]);
- return(0);
+ string = *bufp + pos;
+ name = roff_getname(r, &string, ln, pos);
+ if ('\0' == *name)
+ return(ROFF_IGN);
+
+ /* Read past initial double-quote. */
+ if ('"' == *string)
+ string++;
+
+ /* The rest is the value. */
+ roff_setstr(r, name, string, 0);
+ return(ROFF_IGN);
+}
+
+
+/* ARGSUSED */
+static enum rofferr
+roff_nr(ROFF_ARGS)
+{
+ const char *key;
+ char *val;
+ int iv;
+ struct reg *rg;
+
+ val = *bufp + pos;
+ key = roff_getname(r, &val, ln, pos);
+ rg = r->regs->regs;
+
+ if (0 == strcmp(key, "nS")) {
+ rg[(int)REG_nS].set = 1;
+ if ((iv = mandoc_strntou(val, strlen(val), 10)) >= 0)
+ rg[REG_nS].v.u = (unsigned)iv;
+ else
+ rg[(int)REG_nS].v.u = 0u;
}
- first = (*argv == tree->cur);
- p = *argv++;
- ordp[0] = NULL;
+ return(ROFF_IGN);
+}
- if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))
- return(0);
+/* ARGSUSED */
+static enum rofferr
+roff_rm(ROFF_ARGS)
+{
+ const char *name;
+ char *cp;
+
+ cp = *bufp + pos;
+ while ('\0' != *cp) {
+ name = roff_getname(r, &cp, ln, (int)(cp - *bufp));
+ if ('\0' != *name)
+ roff_setstr(r, name, NULL, 0);
+ }
+ return(ROFF_IGN);
+}
- if (NULL == *argv)
- return(roffspecial(tree, tok, p, argcp,
- (const char **)argvp, 0, ordp));
+/* ARGSUSED */
+static enum rofferr
+roff_TE(ROFF_ARGS)
+{
- i = 0;
- while (*argv && i < ROFF_MAXLINEARG) {
- c = ROFF_PARSED & tokens[tok].flags ?
- rofffindcallable(*argv) : ROFF_MAX;
+ if (NULL == r->tbl)
+ mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
+ else
+ tbl_end(r->tbl);
- if (ROFF_MAX == c && ! roffispunct(*argv)) {
- ordp[i++] = *argv++;
- continue;
- }
- ordp[i] = NULL;
+ r->tbl = NULL;
+ return(ROFF_IGN);
+}
- if (ROFF_MAX == c)
- break;
+/* ARGSUSED */
+static enum rofferr
+roff_T_(ROFF_ARGS)
+{
- if ( ! roffspecial(tree, tok, p, argcp,
- (const char **)argvp,
- (size_t)i, ordp))
- return(0);
+ if (NULL == r->tbl)
+ mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
+ else
+ tbl_restart(ppos, ln, r->tbl);
- return(roffcall(tree, c, argv));
- }
+ return(ROFF_IGN);
+}
- assert(i != ROFF_MAXLINEARG);
- ordp[i] = NULL;
+/* ARGSUSED */
+static enum rofferr
+roff_EQ(ROFF_ARGS)
+{
+ struct eqn_node *e;
- if ( ! roffspecial(tree, tok, p, argcp,
- (const char**)argvp,
- (size_t)i, ordp))
- return(0);
+ assert(NULL == r->eqn);
+ e = eqn_alloc(ppos, ln);
- /* FIXME: error if there's stuff after the punctuation. */
+ if (r->last_eqn)
+ r->last_eqn->next = e;
+ else
+ r->first_eqn = r->last_eqn = e;
- if ( ! first || NULL == *argv)
- return(1);
+ r->eqn = r->last_eqn = e;
+ return(ROFF_IGN);
+}
+
+/* ARGSUSED */
+static enum rofferr
+roff_EN(ROFF_ARGS)
+{
- return(roffpurgepunct(tree, argv));
+ mandoc_msg(MANDOCERR_NOSCOPE, r->parse, ln, ppos, NULL);
+ return(ROFF_IGN);
}
+/* ARGSUSED */
+static enum rofferr
+roff_TS(ROFF_ARGS)
+{
+ struct tbl_node *t;
+
+ if (r->tbl) {
+ mandoc_msg(MANDOCERR_SCOPEBROKEN, r->parse, ln, ppos, NULL);
+ tbl_end(r->tbl);
+ }
+
+ t = tbl_alloc(ppos, ln, r->parse);
+
+ if (r->last_tbl)
+ r->last_tbl->next = t;
+ else
+ r->first_tbl = r->last_tbl = t;
+
+ r->tbl = r->last_tbl = t;
+ return(ROFF_IGN);
+}
/* ARGSUSED */
-static int
-roff_text(ROFFCALL_ARGS)
+static enum rofferr
+roff_so(ROFF_ARGS)
{
- int i, j, first, c, argcp[ROFF_MAXLINEARG];
- char *argvp[ROFF_MAXLINEARG];
+ char *name;
+
+ mandoc_msg(MANDOCERR_SO, r->parse, ln, ppos, NULL);
/*
- * Text macros are similar to special tokens, except that
- * arguments are instead flushed as pure data: we're only
- * concerned with the macro and its arguments. Example:
- *
- * .Fl v W f ;
- *
- * ...Produces...
- *
- * <fl> v W f </fl> ;
+ * Handle `so'. Be EXTREMELY careful, as we shouldn't be
+ * opening anything that's not in our cwd or anything beneath
+ * it. Thus, explicitly disallow traversing up the file-system
+ * or using absolute paths.
*/
- if (ROFF_PRELUDE & tree->state) {
- roff_err(tree, *argv, "`%s' disallowed in prelude",
- toknames[tok]);
- return(0);
+ name = *bufp + pos;
+ if ('/' == *name || strstr(name, "../") || strstr(name, "/..")) {
+ mandoc_msg(MANDOCERR_SOPATH, r->parse, ln, pos, NULL);
+ return(ROFF_ERR);
}
- first = (*argv == tree->cur);
- argv++;
-
- if ( ! roffparseopts(tree, tok, &argv, argcp, argvp))
- return(0);
- if ( ! (*tree->cb.roffin)(tree->arg, tok, argcp,
- (const char **)argvp))
- return(0);
- if (NULL == *argv)
- return((*tree->cb.roffout)(tree->arg, tok));
-
- if ( ! (ROFF_PARSED & tokens[tok].flags)) {
- i = 0;
- while (*argv)
- if ( ! roffdata(tree, i++, *argv++))
- return(0);
+ *offs = pos;
+ return(ROFF_SO);
+}
- return((*tree->cb.roffout)(tree->arg, tok));
- }
+/* ARGSUSED */
+static enum rofferr
+roff_userdef(ROFF_ARGS)
+{
+ const char *arg[9];
+ char *cp, *n1, *n2;
+ int i;
/*
- * Deal with punctuation. Ugly. Work ahead until we encounter
- * terminating punctuation. If we encounter it and all
- * subsequent tokens are punctuation, then stop processing (the
- * line-dominant macro will print these tokens after closure).
- * If the punctuation is followed by non-punctuation, then close
- * and re-open our scope, then continue.
+ * Collect pointers to macro argument strings
+ * and null-terminate them.
*/
+ cp = *bufp + pos;
+ for (i = 0; i < 9; i++)
+ arg[i] = '\0' == *cp ? "" :
+ mandoc_getarg(r->parse, &cp, ln, &pos);
- i = 0;
- while (*argv) {
- if (ROFF_MAX != (c = rofffindcallable(*argv))) {
- if ( ! (ROFF_LSCOPE & tokens[tok].flags))
- if ( ! (*tree->cb.roffout)(tree->arg, tok))
- return(0);
-
- if ( ! roffcall(tree, c, argv))
- return(0);
-
- if (ROFF_LSCOPE & tokens[tok].flags)
- if ( ! (*tree->cb.roffout)(tree->arg, tok))
- return(0);
-
- break;
- }
-
- if ( ! roffispunct(*argv)) {
- if ( ! roffdata(tree, i++, *argv++))
- return(0);
+ /*
+ * Expand macro arguments.
+ */
+ *szp = 0;
+ n1 = cp = mandoc_strdup(r->current_string);
+ while (NULL != (cp = strstr(cp, "\\$"))) {
+ i = cp[2] - '1';
+ if (0 > i || 8 < i) {
+ /* Not an argument invocation. */
+ cp += 2;
continue;
}
- i = 1;
- for (j = 0; argv[j]; j++)
- if ( ! roffispunct(argv[j]))
- break;
+ *szp = strlen(n1) - 3 + strlen(arg[i]) + 1;
+ n2 = mandoc_malloc(*szp);
- if (argv[j]) {
- if (ROFF_LSCOPE & tokens[tok].flags) {
- if ( ! roffdata(tree, 0, *argv++))
- return(0);
- continue;
- }
- if ( ! (*tree->cb.roffout)(tree->arg, tok))
- return(0);
- if ( ! roffdata(tree, 0, *argv++))
- return(0);
- if ( ! (*tree->cb.roffin)(tree->arg, tok,
- argcp,
- (const char **)argvp))
- return(0);
-
- i = 0;
- continue;
- }
+ strlcpy(n2, n1, (size_t)(cp - n1 + 1));
+ strlcat(n2, arg[i], *szp);
+ strlcat(n2, cp + 3, *szp);
- if ( ! (*tree->cb.roffout)(tree->arg, tok))
- return(0);
- break;
+ cp = n2 + (cp - n1);
+ free(n1);
+ n1 = n2;
}
- if (NULL == *argv)
- return((*tree->cb.roffout)(tree->arg, tok));
- if ( ! first)
- return(1);
+ /*
+ * Replace the macro invocation
+ * by the expanded macro.
+ */
+ free(*bufp);
+ *bufp = n1;
+ if (0 == *szp)
+ *szp = strlen(*bufp) + 1;
- return(roffpurgepunct(tree, argv));
+ return(*szp > 1 && '\n' == (*bufp)[(int)*szp - 2] ?
+ ROFF_REPARSE : ROFF_APPEND);
}
-
-/* ARGSUSED */
-static int
-roff_noop(ROFFCALL_ARGS)
+static char *
+roff_getname(struct roff *r, char **cpp, int ln, int pos)
{
+ char *name, *cp;
- return(1);
-}
+ name = *cpp;
+ if ('\0' == *name)
+ return(name);
+
+ /* Read until end of name. */
+ for (cp = name; '\0' != *cp && ' ' != *cp; cp++) {
+ if ('\\' != *cp)
+ continue;
+ cp++;
+ if ('\\' == *cp)
+ continue;
+ mandoc_msg(MANDOCERR_NAMESC, r->parse, ln, pos, NULL);
+ *cp = '\0';
+ name = cp;
+ }
+ /* Nil-terminate name. */
+ if ('\0' != *cp)
+ *(cp++) = '\0';
-/* ARGSUSED */
-static int
-roff_depr(ROFFCALL_ARGS)
-{
+ /* Read past spaces. */
+ while (' ' == *cp)
+ cp++;
- roff_err(tree, *argv, "`%s' is deprecated", toknames[tok]);
- return(0);
+ *cpp = cp;
+ return(name);
}
-
+/*
+ * Store *string into the user-defined string called *name.
+ * In multiline mode, append to an existing entry and append '\n';
+ * else replace the existing entry, if there is one.
+ * To clear an existing entry, call with (*r, *name, NULL, 0).
+ */
static void
-roff_warn(const struct rofftree *tree, const char *pos, char *fmt, ...)
+roff_setstr(struct roff *r, const char *name, const char *string,
+ int multiline)
{
- va_list ap;
- char buf[128];
+ struct roffstr *n;
+ char *c;
+ size_t oldch, newch;
+
+ /* Search for an existing string with the same name. */
+ n = r->first_string;
+ while (n && strcmp(name, n->name))
+ n = n->next;
+
+ if (NULL == n) {
+ /* Create a new string table entry. */
+ n = mandoc_malloc(sizeof(struct roffstr));
+ n->name = mandoc_strdup(name);
+ n->string = NULL;
+ n->next = r->first_string;
+ r->first_string = n;
+ } else if (0 == multiline) {
+ /* In multiline mode, append; else replace. */
+ free(n->string);
+ n->string = NULL;
+ }
+
+ if (NULL == string)
+ return;
+
+ /*
+ * One additional byte for the '\n' in multiline mode,
+ * and one for the terminating '\0'.
+ */
+ newch = strlen(string) + (multiline ? 2u : 1u);
+ if (NULL == n->string) {
+ n->string = mandoc_malloc(newch);
+ *n->string = '\0';
+ oldch = 0;
+ } else {
+ oldch = strlen(n->string);
+ n->string = mandoc_realloc(n->string, oldch + newch);
+ }
- va_start(ap, fmt);
- (void)vsnprintf(buf, sizeof(buf), fmt, ap);
- va_end(ap);
+ /* Skip existing content in the destination buffer. */
+ c = n->string + (int)oldch;
- (*tree->cb.roffmsg)(tree->arg,
- ROFF_WARN, tree->cur, pos, buf);
+ /* Append new content to the destination buffer. */
+ while (*string) {
+ /*
+ * Rudimentary roff copy mode:
+ * Handle escaped backslashes.
+ */
+ if ('\\' == *string && '\\' == *(string + 1))
+ string++;
+ *c++ = *string++;
+ }
+
+ /* Append terminating bytes. */
+ if (multiline)
+ *c++ = '\n';
+ *c = '\0';
}
+static const char *
+roff_getstrn(const struct roff *r, const char *name, size_t len)
+{
+ const struct roffstr *n;
+
+ n = r->first_string;
+ while (n && (strncmp(name, n->name, len) || '\0' != n->name[(int)len]))
+ n = n->next;
+
+ return(n ? n->string : NULL);
+}
static void
-roff_err(const struct rofftree *tree, const char *pos, char *fmt, ...)
+roff_freestr(struct roff *r)
{
- va_list ap;
- char buf[128];
+ struct roffstr *n, *nn;
- va_start(ap, fmt);
- (void)vsnprintf(buf, sizeof(buf), fmt, ap);
- va_end(ap);
+ for (n = r->first_string; n; n = nn) {
+ free(n->name);
+ free(n->string);
+ nn = n->next;
+ free(n);
+ }
+
+ r->first_string = NULL;
+}
- (*tree->cb.roffmsg)(tree->arg,
- ROFF_ERROR, tree->cur, pos, buf);
+const struct tbl_span *
+roff_span(const struct roff *r)
+{
+
+ return(r->tbl ? tbl_span(r->tbl) : NULL);
}
+const struct eqn *
+roff_eqn(const struct roff *r)
+{
+
+ return(r->last_eqn ? &r->last_eqn->eqn : NULL);
+}
git.ckatri.com / mandoc.git / blobdiff