]> git.cameronkatri.com Git - mandoc.git/blobdiff - roff.c
Add initial EQN support to mandoc. This parses, then throws away, data
[mandoc.git] / roff.c
diff --git a/roff.c b/roff.c
index 513de8e0509119f3a05863db9768c620a25530f6..7d76fb563d517bf25bbe7f2d45cd1fd69f30d907 100644 (file)
--- a/roff.c
+++ b/roff.c
@@ -1,14 +1,15 @@
-/*     $Id: roff.c,v 1.89 2010/06/26 15:22:19 kristaps Exp $ */
+/*     $Id: roff.c,v 1.125 2011/02/06 20:36:36 kristaps Exp $ */
 /*
- * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * 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.
  *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * 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 AUTHOR BE LIABLE FOR
+ * 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
 #include <stdio.h>
 
 #include "mandoc.h"
-#include "regs.h"
 #include "roff.h"
+#include "libroff.h"
+#include "libmandoc.h"
 
 #define        RSTACK_MAX      128
 
 #define        ROFF_CTL(c) \
        ('.' == (c) || '\'' == (c))
 
-#if 1
-#define        ROFF_DEBUG(fmt, args...) \
-       do { /* Nothing. */ } while (/*CONSTCOND*/ 0)
-#else
-#define        ROFF_DEBUG(fmt, args...) \
-       do { fprintf(stderr, fmt , ##args); } while (/*CONSTCOND*/ 0)
-#endif
-
 enum   rofft {
+       ROFF_ad,
        ROFF_am,
        ROFF_ami,
        ROFF_am1,
@@ -52,14 +47,28 @@ enum        rofft {
        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_nr,
+       ROFF_ccond, /* FIXME: remove this. */
+       ROFF_USERDEF,
        ROFF_MAX
 };
 
@@ -68,12 +77,27 @@ enum        roffrule {
        ROFFRULE_DENY
 };
 
+struct roffstr {
+       char            *name; /* key of symbol */
+       char            *string; /* current value */
+       struct roffstr  *next; /* next in list */
+};
+
 struct roff {
        struct roffnode *last; /* leaf of stack */
        mandocmsg        msg; /* err/warn/fatal messages */
        void            *data; /* privdata for messages */
        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 */
 };
 
 struct roffnode {
@@ -81,13 +105,13 @@ struct     roffnode {
        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 */
 };
 
 #define        ROFF_ARGS        struct roff *r, /* parse ctx */ \
-                        struct regset *regs, /* registers */ \
                         enum rofft tok, /* tok of macro */ \
                         char **bufp, /* input buffer */ \
                         size_t *szp, /* size of input buffer */ \
@@ -116,9 +140,26 @@ 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_line(ROFF_ARGS);
-static enum rofferr     roff_nr(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);
+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() */
 
@@ -129,33 +170,48 @@ static    enum roffrule    roff_evalcond(const char *, int *);
 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_line, NULL, NULL, 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 },
-       { "rm", roff_line, NULL, NULL, 0, NULL },
-       { "tr", roff_line, NULL, NULL, 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 },
-       { "nr", roff_nr, NULL, NULL, 0, NULL },
+       { NULL, roff_userdef, NULL, NULL, 0, NULL },
 };
 
 static void             roff_free1(struct roff *);
-static enum rofft       roff_hash_find(const char *);
+static enum rofft       roff_hash_find(const char *, size_t);
 static void             roff_hash_init(void);
 static void             roffnode_cleanscope(struct roff *);
-static int              roffnode_push(struct roff *, 
-                               enum rofft, int, int);
+static void             roffnode_push(struct roff *, enum rofft,
+                               const char *, int, int);
 static void             roffnode_pop(struct roff *);
-static enum rofft       roff_parse(const char *, int *);
-static int              roff_parse_nat(const char *, int *);
+static enum rofft       roff_parse(struct roff *, const char *, int *);
+static int              roff_parse_nat(const char *, unsigned int *);
 
 /* See roff_hash_find() */
 #define        ROFF_HASH(p)    (p[0] - ASCII_LO)
@@ -166,7 +222,7 @@ roff_hash_init(void)
        struct roffmac   *n;
        int               buc, i;
 
-       for (i = 0; i < (int)ROFF_MAX; i++) {
+       for (i = 0; i < (int)ROFF_USERDEF; i++) {
                assert(roffs[i].name[0] >= ASCII_LO);
                assert(roffs[i].name[0] <= ASCII_HI);
 
@@ -187,7 +243,7 @@ roff_hash_init(void)
  * the nil-terminated string name could be found.
  */
 static enum rofft
-roff_hash_find(const char *p)
+roff_hash_find(const char *p, size_t s)
 {
        int              buc;
        struct roffmac  *n;
@@ -207,7 +263,7 @@ roff_hash_find(const char *p)
        if (NULL == (n = hash[buc]))
                return(ROFF_MAX);
        for ( ; n; n = n->next)
-               if (0 == strcmp(n->name, p))
+               if (0 == strncmp(n->name, p, s) && '\0' == n->name[(int)s])
                        return((enum rofft)(n - roffs));
 
        return(ROFF_MAX);
@@ -231,8 +287,8 @@ roffnode_pop(struct roff *r)
                        r->rstackpos--;
 
        r->last = r->last->parent;
-       if (p->end)
-               free(p->end);
+       free(p->name);
+       free(p->end);
        free(p);
 }
 
@@ -241,33 +297,49 @@ roffnode_pop(struct roff *r)
  * Push a roff node onto the instruction stack.  This must later be
  * removed with roffnode_pop().
  */
-static int
-roffnode_push(struct roff *r, enum rofft tok, int line, int col)
+static void
+roffnode_push(struct roff *r, enum rofft tok, const char *name,
+               int line, int col)
 {
        struct roffnode *p;
 
-       if (NULL == (p = calloc(1, sizeof(struct roffnode)))) {
-               (*r->msg)(MANDOCERR_MEM, r->data, line, col, NULL);
-               return(0);
-       }
-
+       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;
 
        r->last = p;
-       return(1);
 }
 
 
 static void
 roff_free1(struct roff *r)
 {
+       struct tbl_node *t;
+       struct eqn_node *e;
+
+       while (NULL != (t = r->first_tbl)) {
+               r->first_tbl = t->next;
+               tbl_free(t);
+       }
+
+       r->first_tbl = r->last_tbl = r->tbl = NULL;
+
+       while (NULL != (e = r->first_eqn)) {
+               r->first_eqn = e->next;
+               eqn_free(e);
+       }
+
+       r->first_eqn = r->last_eqn = r->eqn = NULL;
 
        while (r->last)
                roffnode_pop(r);
+
+       roff_freestr(r);
 }
 
 
@@ -289,15 +361,12 @@ roff_free(struct roff *r)
 
 
 struct roff *
-roff_alloc(const mandocmsg msg, void *data)
+roff_alloc(struct regset *regs, void *data, const mandocmsg msg)
 {
        struct roff     *r;
 
-       if (NULL == (r = calloc(1, sizeof(struct roff)))) {
-               (*msg)(MANDOCERR_MEM, data, 0, 0, NULL);
-               return(0);
-       }
-
+       r = mandoc_calloc(1, sizeof(struct roff));
+       r->regs = regs;
        r->msg = msg;
        r->data = data;
        r->rstackpos = -1;
@@ -307,46 +376,161 @@ roff_alloc(const mandocmsg msg, void *data)
 }
 
 
+/*
+ * 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
+roff_res(struct roff *r, char **bufp, size_t *szp, int pos)
+{
+       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;
+
+       /* Search for a leading backslash and save a pointer to it. */
+
+       cp = *bufp + pos;
+       while (NULL != (cp = strchr(cp, '\\'))) {
+               stesc = cp++;
+
+               /*
+                * 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.
+                */
+
+               if ('\0' == *cp)
+                       return(1);
+               if ('*' != *cp++)
+                       continue;
+
+               /*
+                * The third character decides the length
+                * of the name of the string.
+                * Save a pointer to the name.
+                */
+
+               switch (*cp) {
+               case ('\0'):
+                       return(1);
+               case ('('):
+                       cp++;
+                       maxl = 2;
+                       break;
+               case ('['):
+                       cp++;
+                       maxl = 0;
+                       break;
+               default:
+                       maxl = 1;
+                       break;
+               }
+               stnam = cp;
+
+               /* Advance to the end of the name. */
+
+               for (i = 0; 0 == maxl || i < maxl; i++, cp++) {
+                       if ('\0' == *cp)
+                               return(1); /* Error. */
+                       if (0 == maxl && ']' == *cp)
+                               break;
+               }
+
+               /*
+                * Retrieve the replacement string; if it is
+                * undefined, resume searching for escapes.
+                */
+
+               res = roff_getstrn(r, stnam, (size_t)i);
+
+               if (NULL == res) {
+                       cp -= maxl ? 1 : 0;
+                       continue;
+               }
+
+               /* Replace the escape sequence by the string. */
+
+               nsz = *szp + strlen(res) + 1;
+               n = mandoc_malloc(nsz);
+
+               strlcpy(n, *bufp, (size_t)(stesc - *bufp + 1));
+               strlcat(n, res, nsz);
+               strlcat(n, cp + (maxl ? 0 : 1), nsz);
+
+               free(*bufp);
+
+               *bufp = n;
+               *szp = nsz;
+               return(0);
+       }
+
+       return(1);
+}
+
+
 enum rofferr
-roff_parseln(struct roff *r, struct regset *regs, int ln
-               char **bufp, size_t *szp, int pos, int *offs)
+roff_parseln(struct roff *r, int ln, char **bufp
+               size_t *szp, int pos, int *offs)
 {
        enum rofft       t;
+       enum rofferr     e;
        int              ppos;
 
+       /*
+        * Run the reserved-word filter only if we have some reserved
+        * words to fill in.
+        */
+
+       if (r->first_string && ! roff_res(r, bufp, szp, pos))
+               return(ROFF_REPARSE);
+
        /*
         * 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.
         */
 
        if (r->last && ! ROFF_CTL((*bufp)[pos])) {
                t = r->last->tok;
                assert(roffs[t].text);
-               ROFF_DEBUG("roff: intercept scoped text: %s, [%s]\n", 
-                               roffs[t].name, &(*bufp)[pos]);
-               return((*roffs[t].text)
-                               (r, regs, t, bufp, 
-                                szp, ln, pos, pos, offs));
+               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, *offs));
+               if (r->tbl)
+                       return(tbl_read(r->tbl, ln, *bufp, *offs));
+               return(ROFF_CONT);
        } else if ( ! ROFF_CTL((*bufp)[pos])) {
-               ROFF_DEBUG("roff: pass non-scoped text: [%s]\n", 
-                               &(*bufp)[pos]);
+               if (r->eqn)
+                       return(eqn_read(&r->eqn, ln, *bufp, *offs));
+               if (r->tbl)
+                       return(tbl_read(r->tbl, ln, *bufp, *offs));
                return(ROFF_CONT);
-       }
+       } else if (r->eqn)
+               return(eqn_read(&r->eqn, ln, *bufp, *offs));
 
        /*
         * 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.
         */
 
        if (r->last) {
                t = r->last->tok;
                assert(roffs[t].sub);
-               ROFF_DEBUG("roff: intercept scoped context: %s\n", 
-                               roffs[t].name);
                return((*roffs[t].sub)
-                               (r, regs, t, bufp, 
-                                szp, ln, pos, pos, offs));
+                               (r, t, bufp, szp, 
+                                ln, pos, pos, offs));
        }
 
        /*
@@ -356,29 +540,37 @@ roff_parseln(struct roff *r, struct regset *regs, int ln,
         */
 
        ppos = pos;
-       if (ROFF_MAX == (t = roff_parse(*bufp, &pos))) {
-               ROFF_DEBUG("roff: pass non-scoped non-macro: [%s]\n", 
-                               &(*bufp)[pos]);
+       if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos)))
                return(ROFF_CONT);
-       }
 
-       ROFF_DEBUG("roff: intercept new-scope: %s, [%s]\n", 
-                       roffs[t].name, &(*bufp)[pos]);
        assert(roffs[t].proc);
        return((*roffs[t].proc)
-                       (r, regs, t, bufp, 
-                        szp, ln, ppos, pos, offs));
+                       (r, t, bufp, szp, 
+                        ln, ppos, pos, offs));
 }
 
 
-int
+void
 roff_endparse(struct roff *r)
 {
 
-       if (NULL == r->last)
-               return(1);
-       return((*r->msg)(MANDOCERR_SCOPEEXIT, r->data, r->last->line, 
-                               r->last->col, NULL));
+       if (r->last)
+               (*r->msg)(MANDOCERR_SCOPEEXIT, r->data,
+                               r->last->line, r->last->col, NULL);
+
+       if (r->eqn) {
+               (*r->msg)(MANDOCERR_SCOPEEXIT, r->data, 
+                               r->eqn->line, r->eqn->pos, NULL);
+               eqn_end(r->eqn);
+               r->eqn = NULL;
+       }
+
+       if (r->tbl) {
+               (*r->msg)(MANDOCERR_SCOPEEXIT, r->data, 
+                               r->tbl->line, r->tbl->pos, NULL);
+               tbl_end(r->tbl);
+               r->tbl = NULL;
+       }
 }
 
 
@@ -387,35 +579,28 @@ roff_endparse(struct roff *r)
  * form of ".foo xxx" in the usual way.
  */
 static enum rofft
-roff_parse(const char *buf, int *pos)
+roff_parse(struct roff *r, const char *buf, int *pos)
 {
-       int              j;
-       char             mac[5];
+       const char      *mac;
+       size_t           maclen;
        enum rofft       t;
 
        assert(ROFF_CTL(buf[*pos]));
        (*pos)++;
 
-       while (buf[*pos] && (' ' == buf[*pos] || '\t' == buf[*pos]))
+       while (' ' == buf[*pos] || '\t' == buf[*pos])
                (*pos)++;
 
        if ('\0' == buf[*pos])
                return(ROFF_MAX);
 
-       for (j = 0; j < 4; j++, (*pos)++)
-               if ('\0' == (mac[j] = buf[*pos]))
-                       break;
-               else if (' ' == buf[*pos] || (j && '\\' == buf[*pos]))
-                       break;
-
-       if (j == 4 || j < 1)
-               return(ROFF_MAX);
-
-       mac[j] = '\0';
+       mac = buf + *pos;
+       maclen = strcspn(mac, " \\\t\0");
 
-       if (ROFF_MAX == (t = roff_hash_find(mac)))
-               return(t);
+       t = (r->current_string = roff_getstrn(r, mac, maclen))
+           ? ROFF_USERDEF : roff_hash_find(mac, maclen);
 
+       *pos += maclen;
        while (buf[*pos] && ' ' == buf[*pos])
                (*pos)++;
 
@@ -424,7 +609,7 @@ roff_parse(const char *buf, int *pos)
 
 
 static int
-roff_parse_nat(const char *buf, int *res)
+roff_parse_nat(const char *buf, unsigned int *res)
 {
        char            *ep;
        long             lval;
@@ -435,10 +620,10 @@ roff_parse_nat(const char *buf, int *res)
                return(0);
        if ((errno == ERANGE && 
                        (lval == LONG_MAX || lval == LONG_MIN)) ||
-                       (lval > INT_MAX || lval <= 0))
+                       (lval > INT_MAX || lval < 0))
                return(0);
 
-       *res = (int)lval;
+       *res = (unsigned int)lval;
        return(1);
 }
 
@@ -454,8 +639,7 @@ roff_cblock(ROFF_ARGS)
         */
 
        if (NULL == r->last) {
-               if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
-                       return(ROFF_ERR);
+               (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
                return(ROFF_IGN);
        }
 
@@ -467,22 +651,19 @@ roff_cblock(ROFF_ARGS)
        case (ROFF_am1):
                /* FALLTHROUGH */
        case (ROFF_de):
+               /* ROFF_de1 is remapped to ROFF_de in roff_block(). */
                /* FALLTHROUGH */
        case (ROFF_dei):
                /* FALLTHROUGH */
-       case (ROFF_de1):
-               /* FALLTHROUGH */
        case (ROFF_ig):
                break;
        default:
-               if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
-                       return(ROFF_ERR);
+               (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
                return(ROFF_IGN);
        }
 
        if ((*bufp)[pos])
-               if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
-                       return(ROFF_ERR);
+               (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL);
 
        roffnode_pop(r);
        roffnode_cleanscope(r);
@@ -509,8 +690,7 @@ roff_ccond(ROFF_ARGS)
 {
 
        if (NULL == r->last) {
-               if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
-                       return(ROFF_ERR);
+               (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
                return(ROFF_IGN);
        }
 
@@ -522,20 +702,17 @@ roff_ccond(ROFF_ARGS)
        case (ROFF_if):
                break;
        default:
-               if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
-                       return(ROFF_ERR);
+               (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
                return(ROFF_IGN);
        }
 
        if (r->last->endspan > -1) {
-               if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL))
-                       return(ROFF_ERR);
+               (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
                return(ROFF_IGN);
        }
 
        if ((*bufp)[pos])
-               if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
-                       return(ROFF_ERR);
+               (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL);
 
        roffnode_pop(r);
        roffnode_cleanscope(r);
@@ -549,26 +726,55 @@ roff_block(ROFF_ARGS)
 {
        int             sv;
        size_t          sz;
+       char            *name;
+
+       name = NULL;
+
+       if (ROFF_ig != tok) {
+               if ('\0' == (*bufp)[pos]) {
+                       (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL);
+                       return(ROFF_IGN);
+               }
+
+               /*
+                * 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
+                       (*r->msg)(MANDOCERR_REQUEST, r->data, ln, ppos,
+                           roffs[tok].name);
 
-       if (ROFF_ig != tok && '\0' == (*bufp)[pos]) {
-               if ( ! (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL))
-                       return(ROFF_ERR);
-               return(ROFF_IGN);
-       } else if (ROFF_ig != tok) {
                while ((*bufp)[pos] && ' ' != (*bufp)[pos])
                        pos++;
+
                while (' ' == (*bufp)[pos])
-                       pos++;
+                       (*bufp)[pos++] = '\0';
        }
 
-       if ( ! roffnode_push(r, tok, ln, ppos))
-               return(ROFF_ERR);
+       roffnode_push(r, tok, name, ln, ppos);
+
+       /*
+        * 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_de == tok)
+               roff_setstr(r, name, "", 0);
 
        if ('\0' == (*bufp)[pos])
                return(ROFF_IGN);
 
+       /* If present, process the custom end-of-line marker. */
+
        sv = pos;
-       while ((*bufp)[pos] && ' ' != (*bufp)[pos] && 
+       while ((*bufp)[pos] &&
+                       ' ' != (*bufp)[pos] && 
                        '\t' != (*bufp)[pos])
                pos++;
 
@@ -584,19 +790,13 @@ roff_block(ROFF_ARGS)
        if (1 == sz && '.' == (*bufp)[sv])
                return(ROFF_IGN);
 
-       r->last->end = malloc(sz + 1);
-
-       if (NULL == r->last->end) {
-               (*r->msg)(MANDOCERR_MEM, r->data, ln, pos, NULL);
-               return(ROFF_ERR);
-       }
+       r->last->end = mandoc_malloc(sz + 1);
 
        memcpy(r->last->end, *bufp + sv, sz);
        r->last->end[(int)sz] = '\0';
 
        if ((*bufp)[pos])
-               if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL))
-                       return(ROFF_ERR);
+               (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL);
 
        return(ROFF_IGN);
 }
@@ -634,7 +834,7 @@ roff_block_sub(ROFF_ARGS)
                        roffnode_pop(r);
                        roffnode_cleanscope(r);
 
-                       if (ROFF_MAX != roff_parse(*bufp, &pos))
+                       if (ROFF_MAX != roff_parse(r, *bufp, &pos))
                                return(ROFF_RERUN);
                        return(ROFF_IGN);
                }
@@ -646,15 +846,21 @@ roff_block_sub(ROFF_ARGS)
         */
 
        ppos = pos;
-       t = roff_parse(*bufp, &pos);
+       t = roff_parse(r, *bufp, &pos);
 
-       /* If we're not a comment-end, then throw it away. */
-       if (ROFF_cblock != t)
+       /*
+        * 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(roffs[t].proc);
-       return((*roffs[t].proc)(r, regs, t, bufp, 
-                       szp, ln, ppos, pos, offs));
+       return((*roffs[t].proc)(r, t, bufp, szp, 
+                               ln, ppos, pos, offs));
 }
 
 
@@ -663,6 +869,9 @@ static enum rofferr
 roff_block_text(ROFF_ARGS)
 {
 
+       if (ROFF_de == tok)
+               roff_setstr(r, r->last->name, *bufp + pos, 1);
+
        return(ROFF_IGN);
 }
 
@@ -673,7 +882,6 @@ roff_cond_sub(ROFF_ARGS)
 {
        enum rofft       t;
        enum roffrule    rr;
-       struct roffnode *l;
 
        ppos = pos;
        rr = r->last->rule;
@@ -683,14 +891,15 @@ roff_cond_sub(ROFF_ARGS)
         * continue. 
         */
 
-       l = r->last;
        roffnode_cleanscope(r);
 
-       if (l != r->last)
-               return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
-
-       if (ROFF_MAX == (t = roff_parse(*bufp, &pos)))
+       if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos))) {
+               if ('\\' == (*bufp)[pos] && '}' == (*bufp)[pos + 1])
+                       return(roff_ccond
+                               (r, ROFF_ccond, bufp, szp,
+                                ln, pos, pos + 2, offs));
                return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
+       }
 
        /*
         * A denied conditional must evaluate its children if and only
@@ -703,8 +912,8 @@ roff_cond_sub(ROFF_ARGS)
                                return(ROFF_IGN);
 
        assert(roffs[t].proc);
-       return((*roffs[t].proc)
-                       (r, regs, t, bufp, szp, ln, ppos, pos, offs));
+       return((*roffs[t].proc)(r, t, bufp, szp, 
+                               ln, ppos, pos, offs));
 }
 
 
@@ -722,6 +931,8 @@ roff_cond_text(ROFF_ARGS)
         * scope permits us to do so.
         */
 
+       /* FIXME: use roff_ccond? */
+
        st = &(*bufp)[pos];
        if (NULL == (ep = strstr(st, "\\}"))) {
                roffnode_cleanscope(r);
@@ -760,16 +971,17 @@ roff_evalcond(const char *v, int *pos)
        return(ROFFRULE_DENY);
 }
 
-
 /* ARGSUSED */
 static enum rofferr
-roff_line(ROFF_ARGS)
+roff_line_ignore(ROFF_ARGS)
 {
 
+       if (ROFF_it == tok)
+               (*r->msg)(MANDOCERR_REQUEST, r->data, ln, ppos, "it");
+
        return(ROFF_IGN);
 }
 
-
 /* ARGSUSED */
 static enum rofferr
 roff_cond(ROFF_ARGS)
@@ -811,19 +1023,14 @@ roff_cond(ROFF_ARGS)
         */
 
        if ('\0' == (*bufp)[pos] && sv != pos) {
-               if ((*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL))
-                       return(ROFF_IGN);
-               return(ROFF_ERR);
+               (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL);
+               return(ROFF_IGN);
        }
 
-       if ( ! roffnode_push(r, tok, ln, ppos))
-               return(ROFF_ERR);
+       roffnode_push(r, tok, NULL, ln, ppos);
 
        r->last->rule = rule;
 
-       ROFF_DEBUG("roff: cond: %s -> %s\n", roffs[tok].name, 
-                       ROFFRULE_ALLOW == rule ?  "allow" : "deny");
-
        if (ROFF_ie == tok) {
                /*
                 * An if-else will put the NEGATION of the current
@@ -838,11 +1045,8 @@ roff_cond(ROFF_ARGS)
 
        /* If the parent has false as its rule, then so do we. */
 
-       if (r->last->parent && ROFFRULE_DENY == r->last->parent->rule) {
+       if (r->last->parent && ROFFRULE_DENY == r->last->parent->rule)
                r->last->rule = ROFFRULE_DENY;
-               ROFF_DEBUG("roff: cond override: %s -> deny\n",
-                               roffs[tok].name);
-       }
 
        /*
         * Determine scope.  If we're invoked with "\{" trailing the
@@ -855,11 +1059,7 @@ roff_cond(ROFF_ARGS)
        if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
                r->last->endspan = -1;
                pos += 2;
-               ROFF_DEBUG("roff: cond-scope: %s, multi-line\n", 
-                               roffs[tok].name);
-       } else
-               ROFF_DEBUG("roff: cond-scope: %s, one-line\n", 
-                               roffs[tok].name);
+       } 
 
        /*
         * If there are no arguments on the line, the next-line scope is
@@ -876,41 +1076,369 @@ roff_cond(ROFF_ARGS)
 }
 
 
+/* ARGSUSED */
+static enum rofferr
+roff_ds(ROFF_ARGS)
+{
+       char            *name, *string;
+
+       /*
+        * 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,
+        *
+        *  [.ds foo "bar  "     ]
+        *
+        * will have `bar  "     ' as its value.
+        */
+
+       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, *val;
+       const char      *key;
+       char            *val;
+       struct reg      *rg;
 
-       key = &(*bufp)[pos];
+       val = *bufp + pos;
+       key = roff_getname(r, &val, ln, pos);
+       rg = r->regs->regs;
 
-       /* Parse register request. */
-       while ((*bufp)[pos] && ' ' != (*bufp)[pos])
-               pos++;
+       if (0 == strcmp(key, "nS")) {
+               rg[(int)REG_nS].set = 1;
+               if ( ! roff_parse_nat(val, &rg[(int)REG_nS].v.u))
+                       rg[(int)REG_nS].v.u = 0;
+       }
+
+       return(ROFF_IGN);
+}
+
+/* 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, cp - *bufp);
+               if ('\0' != *name)
+                       roff_setstr(r, name, NULL, 0);
+       }
+       return(ROFF_IGN);
+}
+
+/* ARGSUSED */
+static enum rofferr
+roff_TE(ROFF_ARGS)
+{
+
+       if (NULL == r->tbl)
+               (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
+       else
+               tbl_end(r->tbl);
+
+       r->tbl = NULL;
+       return(ROFF_IGN);
+}
+
+/* ARGSUSED */
+static enum rofferr
+roff_T_(ROFF_ARGS)
+{
+
+       if (NULL == r->tbl)
+               (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
+       else
+               tbl_restart(ppos, ln, r->tbl);
+
+       return(ROFF_IGN);
+}
+
+/* ARGSUSED */
+static enum rofferr
+roff_EQ(ROFF_ARGS)
+{
+       struct eqn_node *e;
+
+       assert(NULL == r->eqn);
+       e = eqn_alloc(ppos, ln);
+
+       if (r->last_eqn)
+               r->last_eqn->next = e;
+       else
+               r->first_eqn = r->last_eqn = e;
+
+       r->eqn = r->last_eqn = e;
+       return(ROFF_IGN);
+}
+
+/* ARGSUSED */
+static enum rofferr
+roff_EN(ROFF_ARGS)
+{
+
+       (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
+       return(ROFF_IGN);
+}
+
+/* ARGSUSED */
+static enum rofferr
+roff_TS(ROFF_ARGS)
+{
+       struct tbl_node *t;
+
+       if (r->tbl) {
+               (*r->msg)(MANDOCERR_SCOPEBROKEN, r->data, ln, ppos, NULL);
+               tbl_end(r->tbl);
+       }
+
+       t = tbl_alloc(ppos, ln, r->data, r->msg);
+
+       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 enum rofferr
+roff_so(ROFF_ARGS)
+{
+       char *name;
+
+       (*r->msg)(MANDOCERR_SO, r->data, ln, ppos, NULL);
 
        /*
-        * Set our nil terminator.  Because this line is going to be
-        * ignored anyway, we can munge it as we please.
+        * 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 ((*bufp)[pos])
-               (*bufp)[pos++] = '\0';
 
-       /* Skip whitespace to register token. */
-       while ((*bufp)[pos] && ' ' == (*bufp)[pos])
-               pos++;
+       name = *bufp + pos;
+       if ('/' == *name || strstr(name, "../") || strstr(name, "/..")) {
+               (*r->msg)(MANDOCERR_SOPATH, r->data, ln, pos, NULL);
+               return(ROFF_ERR);
+       }
 
-       val = &(*bufp)[pos];
+       *offs = pos;
+       return(ROFF_SO);
+}
 
-       /* Process register token. */
+/* ARGSUSED */
+static enum rofferr
+roff_userdef(ROFF_ARGS)
+{
+       const char       *arg[9];
+       char             *cp, *n1, *n2;
+       int               i;
 
-       if (0 == strcmp(key, "nS")) {
-               if ( ! roff_parse_nat(val, &regs->regs[(int)REG_nS].i))
-                       regs->regs[(int)REG_nS].i = 0;
+       /*
+        * 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(&cp, r->msg, r->data, ln, &pos);
 
-               ROFF_DEBUG("roff: register nS: %d\n", 
-                               regs->regs[(int)REG_nS].i);
-       } else
-               ROFF_DEBUG("roff: ignoring register: %s\n", key);
+       /*
+        * 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;
+               }
 
-       return(ROFF_IGN);
+               *szp = strlen(n1) - 3 + strlen(arg[i]) + 1;
+               n2 = mandoc_malloc(*szp);
+
+               strlcpy(n2, n1, (size_t)(cp - n1 + 1));
+               strlcat(n2, arg[i], *szp);
+               strlcat(n2, cp + 3, *szp);
+
+               cp = n2 + (cp - n1);
+               free(n1);
+               n1 = n2;
+       }
+
+       /*
+        * Replace the macro invocation
+        * by the expanded macro.
+        */
+       free(*bufp);
+       *bufp = n1;
+       if (0 == *szp)
+               *szp = strlen(*bufp) + 1;
+
+       return(*szp > 1 && '\n' == (*bufp)[(int)*szp - 2] ?
+          ROFF_REPARSE : ROFF_APPEND);
+}
+
+static char *
+roff_getname(struct roff *r, char **cpp, int ln, int pos)
+{
+       char     *name, *cp;
+
+       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;
+               (*r->msg)(MANDOCERR_NAMESC, r->data, ln, pos, NULL);
+               *cp = '\0';
+               name = cp;
+       }
+
+       /* Nil-terminate name. */
+       if ('\0' != *cp)
+               *(cp++) = '\0';
+
+       /* Read past spaces. */
+       while (' ' == *cp)
+               cp++;
+
+       *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_setstr(struct roff *r, const char *name, const char *string,
+       int multiline)
+{
+       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 ? 2 : 1);
+       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);
+       }
+
+       /* Skip existing content in the destination buffer. */
+       c = n->string + oldch;
+
+       /* 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_freestr(struct roff *r)
+{
+       struct roffstr   *n, *nn;
+
+       for (n = r->first_string; n; n = nn) {
+               free(n->name);
+               free(n->string);
+               nn = n->next;
+               free(n);
+       }
+
+       r->first_string = NULL;
+}
+
+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);
 }