]> git.cameronkatri.com Git - mandoc.git/blobdiff - roff.c
Note version 1.11.4 bits. Here we go!
[mandoc.git] / roff.c
diff --git a/roff.c b/roff.c
index a6ec079538433bc39f19a30b29a48c6a2ab4f741..79d0897ef3a79b22efa07b5c2867d0875d8ee43c 100644 (file)
--- a/roff.c
+++ b/roff.c
@@ -1,4 +1,4 @@
-/*     $Id: roff.c,v 1.128 2011/03/20 16:02:05 kristaps Exp $ */
+/*     $Id: roff.c,v 1.144 2011/07/08 09:28:33 kristaps Exp $ */
 /*
  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
 #endif
 
 #include <assert.h>
-#include <errno.h>
 #include <ctype.h>
-#include <limits.h>
 #include <stdlib.h>
 #include <string.h>
-#include <stdio.h>
 
 #include "mandoc.h"
-#include "roff.h"
 #include "libroff.h"
 #include "libmandoc.h"
 
+/* Maximum number of nested if-else conditionals. */
 #define        RSTACK_MAX      128
 
-#define        ROFF_CTL(c) \
-       ('.' == (c) || '\'' == (c))
-
 enum   rofft {
        ROFF_ad,
        ROFF_am,
@@ -67,7 +61,7 @@ enum  rofft {
        ROFF_EQ,
        ROFF_EN,
        ROFF_cblock,
-       ROFF_ccond, /* FIXME: remove this. */
+       ROFF_ccond,
        ROFF_USERDEF,
        ROFF_MAX
 };
@@ -131,6 +125,14 @@ struct     roffmac {
        struct roffmac  *next;
 };
 
+struct predef {
+       const char      *name; /* predefined input name */
+       const char      *str; /* replacement symbol */
+};
+
+#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);
@@ -148,7 +150,7 @@ static      const char      *roff_getstrn(const struct roff *,
 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);
+                               char **, size_t *, int, int);
 static enum rofferr     roff_rm(ROFF_ARGS);
 static void             roff_setstr(struct roff *,
                                const char *, const char *, int);
@@ -202,6 +204,12 @@ static     struct roffmac   roffs[ROFF_MAX] = {
        { NULL, roff_userdef, NULL, NULL, 0, NULL },
 };
 
+/* Array of injected predefined strings. */
+#define        PREDEFS_MAX      38
+static const struct predef predefs[PREDEFS_MAX] = {
+#include "predefs.in"
+};
+
 static void             roff_free1(struct roff *);
 static enum rofft       roff_hash_find(const char *, size_t);
 static void             roff_hash_init(void);
@@ -210,7 +218,6 @@ 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 *);
-static int              roff_parse_nat(const char *, unsigned int *);
 
 /* See roff_hash_find() */
 #define        ROFF_HASH(p)    (p[0] - ASCII_LO)
@@ -236,7 +243,6 @@ roff_hash_init(void)
        }
 }
 
-
 /*
  * Look up a roff token by its name.  Returns ROFF_MAX if no macro by
  * the nil-terminated string name could be found.
@@ -281,10 +287,6 @@ roffnode_pop(struct roff *r)
        assert(r->last);
        p = r->last; 
 
-       if (ROFF_el == p->tok)
-               if (r->rstackpos > -1)
-                       r->rstackpos--;
-
        r->last = r->last->parent;
        free(p->name);
        free(p->end);
@@ -345,8 +347,12 @@ roff_free1(struct roff *r)
 void
 roff_reset(struct roff *r)
 {
+       int              i;
 
        roff_free1(r);
+
+       for (i = 0; i < PREDEFS_MAX; i++) 
+               roff_setstr(r, predefs[i].name, predefs[i].str, 0);
 }
 
 
@@ -363,6 +369,7 @@ struct roff *
 roff_alloc(struct regset *regs, struct mparse *parse)
 {
        struct roff     *r;
+       int              i;
 
        r = mandoc_calloc(1, sizeof(struct roff));
        r->regs = regs;
@@ -370,6 +377,10 @@ roff_alloc(struct regset *regs, struct mparse *parse)
        r->rstackpos = -1;
        
        roff_hash_init();
+
+       for (i = 0; i < PREDEFS_MAX; i++) 
+               roff_setstr(r, predefs[i].name, predefs[i].str, 0);
+
        return(r);
 }
 
@@ -380,7 +391,7 @@ roff_alloc(struct regset *regs, struct mparse *parse)
  * is processed. 
  */
 static int
-roff_res(struct roff *r, char **bufp, size_t *szp, int pos)
+roff_res(struct roff *r, char **bufp, size_t *szp, int ln, int pos)
 {
        const char      *stesc; /* start of an escape sequence ('\\') */
        const char      *stnam; /* start of the name, after "[(*" */
@@ -447,8 +458,9 @@ roff_res(struct roff *r, char **bufp, size_t *szp, int pos)
                res = roff_getstrn(r, stnam, (size_t)i);
 
                if (NULL == res) {
-                       cp -= maxl ? 1 : 0;
-                       continue;
+                       /* TODO: keep track of the correct position. */
+                       mandoc_msg(MANDOCERR_BADESCAPE, r->parse, ln, pos, NULL);
+                       res = "";
                }
 
                /* Replace the escape sequence by the string. */
@@ -477,16 +489,19 @@ roff_parseln(struct roff *r, int ln, char **bufp,
 {
        enum rofft       t;
        enum rofferr     e;
-       int              ppos;
+       int              ppos, ctl;
 
        /*
         * 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))
+       if (r->first_string && ! roff_res(r, bufp, szp, ln, pos))
                return(ROFF_REPARSE);
 
+       ppos = pos;
+       ctl = mandoc_getcontrol(*bufp, &pos);
+
        /*
         * 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
@@ -495,7 +510,7 @@ roff_parseln(struct roff *r, int ln, char **bufp,
         * no matter our state.
         */
 
-       if (r->last && ! ROFF_CTL((*bufp)[pos])) {
+       if (r->last && ! ctl) {
                t = r->last->tok;
                assert(roffs[t].text);
                e = (*roffs[t].text)
@@ -504,18 +519,18 @@ roff_parseln(struct roff *r, int ln, char **bufp,
                if (ROFF_CONT != e)
                        return(e);
                if (r->eqn)
-                       return(eqn_read(&r->eqn, ln, *bufp, *offs));
+                       return(eqn_read(&r->eqn, ln, *bufp, pos));
                if (r->tbl)
-                       return(tbl_read(r->tbl, ln, *bufp, *offs));
+                       return(tbl_read(r->tbl, ln, *bufp, pos));
                return(ROFF_CONT);
-       } else if ( ! ROFF_CTL((*bufp)[pos])) {
+       } else if ( ! ctl) {
                if (r->eqn)
-                       return(eqn_read(&r->eqn, ln, *bufp, *offs));
+                       return(eqn_read(&r->eqn, ln, *bufp, pos));
                if (r->tbl)
-                       return(tbl_read(r->tbl, ln, *bufp, *offs));
+                       return(tbl_read(r->tbl, ln, *bufp, pos));
                return(ROFF_CONT);
        } else if (r->eqn)
-               return(eqn_read(&r->eqn, ln, *bufp, *offs));
+               return(eqn_read(&r->eqn, ln, *bufp, ppos));
 
        /*
         * If a scope is open, go to the child handler for that macro,
@@ -528,7 +543,7 @@ roff_parseln(struct roff *r, int ln, char **bufp,
                assert(roffs[t].sub);
                return((*roffs[t].sub)
                                (r, t, bufp, szp, 
-                                ln, pos, pos, offs));
+                                ln, ppos, pos, offs));
        }
 
        /*
@@ -537,7 +552,6 @@ roff_parseln(struct roff *r, int ln, char **bufp,
         * the compilers handle it.
         */
 
-       ppos = pos;
        if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos)))
                return(ROFF_CONT);
 
@@ -571,7 +585,6 @@ roff_endparse(struct roff *r)
        }
 }
 
-
 /*
  * Parse a roff node's type from the input buffer.  This must be in the
  * form of ".foo xxx" in the usual way.
@@ -583,49 +596,30 @@ roff_parse(struct roff *r, const char *buf, int *pos)
        size_t           maclen;
        enum rofft       t;
 
-       assert(ROFF_CTL(buf[*pos]));
-       (*pos)++;
-
-       while (' ' == buf[*pos] || '\t' == buf[*pos])
-               (*pos)++;
-
-       if ('\0' == buf[*pos])
+       if ('\0' == buf[*pos] || '"' == buf[*pos] || 
+                       '\t' == buf[*pos] || ' ' == buf[*pos])
                return(ROFF_MAX);
 
+       /*
+        * 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, " \\\t\0");
+       maclen = strcspn(mac + 1, " \\\t\0") + 1;
 
        t = (r->current_string = roff_getstrn(r, mac, maclen))
            ? ROFF_USERDEF : roff_hash_find(mac, maclen);
 
        *pos += (int)maclen;
+
        while (buf[*pos] && ' ' == buf[*pos])
                (*pos)++;
 
        return(t);
 }
 
-
-static int
-roff_parse_nat(const char *buf, unsigned int *res)
-{
-       char            *ep;
-       long             lval;
-
-       errno = 0;
-       lval = strtol(buf, &ep, 10);
-       if (buf[0] == '\0' || *ep != '\0')
-               return(0);
-       if ((errno == ERANGE && 
-                       (lval == LONG_MAX || lval == LONG_MIN)) ||
-                       (lval > INT_MAX || lval < 0))
-               return(0);
-
-       *res = (unsigned int)lval;
-       return(1);
-}
-
-
 /* ARGSUSED */
 static enum rofferr
 roff_cblock(ROFF_ARGS)
@@ -747,10 +741,10 @@ roff_block(ROFF_ARGS)
                        mandoc_msg(MANDOCERR_REQUEST, r->parse, ln, ppos,
                            roffs[tok].name);
 
-               while ((*bufp)[pos] && ' ' != (*bufp)[pos])
+               while ((*bufp)[pos] && ! isspace((unsigned char)(*bufp)[pos]))
                        pos++;
 
-               while (' ' == (*bufp)[pos])
+               while (isspace((unsigned char)(*bufp)[pos]))
                        (*bufp)[pos++] = '\0';
        }
 
@@ -771,9 +765,7 @@ roff_block(ROFF_ARGS)
        /* If present, process the custom end-of-line marker. */
 
        sv = pos;
-       while ((*bufp)[pos] &&
-                       ' ' != (*bufp)[pos] && 
-                       '\t' != (*bufp)[pos])
+       while ((*bufp)[pos] && ! isspace((unsigned char)(*bufp)[pos]))
                pos++;
 
        /*
@@ -817,11 +809,7 @@ roff_block_sub(ROFF_ARGS)
         */
 
        if (r->last->end) {
-               i = pos + 1;
-               while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
-                       i++;
-
-               for (j = 0; r->last->end[j]; j++, i++)
+               for (i = pos, j = 0; r->last->end[j]; j++, i++)
                        if ((*bufp)[i] != r->last->end[j])
                                break;
 
@@ -832,6 +820,10 @@ roff_block_sub(ROFF_ARGS)
                        roffnode_pop(r);
                        roffnode_cleanscope(r);
 
+                       while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
+                               i++;
+
+                       pos = i;
                        if (ROFF_MAX != roff_parse(r, *bufp, &pos))
                                return(ROFF_RERUN);
                        return(ROFF_IGN);
@@ -843,7 +835,6 @@ roff_block_sub(ROFF_ARGS)
         * pulling it out of the hashtable.
         */
 
-       ppos = pos;
        t = roff_parse(r, *bufp, &pos);
 
        /*
@@ -880,22 +871,44 @@ roff_cond_sub(ROFF_ARGS)
 {
        enum rofft       t;
        enum roffrule    rr;
+       char            *ep;
 
-       ppos = pos;
        rr = r->last->rule;
+       roffnode_cleanscope(r);
 
-       /* 
-        * Clean out scope.  If we've closed ourselves, then don't
-        * 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.
         */
 
-       roffnode_cleanscope(r);
-
        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));
+               ep = &(*bufp)[pos];
+               for ( ; NULL != (ep = strchr(ep, '\\')); ep++) {
+                       ep++;
+                       if ('}' != *ep)
+                               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;
+               }
                return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
        }
 
@@ -904,6 +917,7 @@ roff_cond_sub(ROFF_ARGS)
         * if they're either structurally required (such as loops and
         * conditionals) or a closing macro.
         */
+
        if (ROFFRULE_DENY == rr)
                if ( ! (ROFFMAC_STRUCT & roffs[t].flags))
                        if (ROFF_ccond != t)
@@ -914,37 +928,28 @@ roff_cond_sub(ROFF_ARGS)
                                ln, ppos, pos, offs));
 }
 
-
 /* ARGSUSED */
 static enum rofferr
 roff_cond_text(ROFF_ARGS)
 {
-       char            *ep, *st;
+       char            *ep;
        enum roffrule    rr;
 
        rr = r->last->rule;
+       roffnode_cleanscope(r);
 
-       /*
-        * We display the value of the text if out current evaluation
-        * scope permits us to do so.
-        */
-
-       /* FIXME: use roff_ccond? */
-
-       st = &(*bufp)[pos];
-       if (NULL == (ep = strstr(st, "\\}"))) {
-               roffnode_cleanscope(r);
-               return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
+       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);
        }
-
-       if (ep == st || (ep > st && '\\' != *(ep - 1)))
-               roffnode_pop(r);
-
-       roffnode_cleanscope(r);
        return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
 }
 
-
 static enum roffrule
 roff_evalcond(const char *v, int *pos)
 {
@@ -987,29 +992,20 @@ roff_cond(ROFF_ARGS)
        int              sv;
        enum roffrule    rule;
 
-       /* Stack overflow! */
-
-       if (ROFF_ie == tok && r->rstackpos == RSTACK_MAX - 1) {
-               mandoc_msg(MANDOCERR_MEM, r->parse, ln, ppos, NULL);
-               return(ROFF_ERR);
-       }
-
-       /* First, evaluate the conditional. */
+       /* 
+        * 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.
+        */
 
-       if (ROFF_el == tok) {
-               /* 
-                * An `.el' will get the value of the current rstack
-                * entry set in prior `ie' calls or defaults to DENY.
-                */
-               if (r->rstackpos < 0)
-                       rule = ROFFRULE_DENY;
-               else
-                       rule = r->rstack[r->rstackpos];
-       } else
-               rule = roff_evalcond(*bufp, &pos);
+       rule = ROFF_el == tok ?
+               (r->rstackpos < 0 ? 
+                ROFFRULE_DENY : r->rstack[r->rstackpos--]) :
+               roff_evalcond(*bufp, &pos);
 
        sv = pos;
-
        while (' ' == (*bufp)[pos])
                pos++;
 
@@ -1029,16 +1025,20 @@ roff_cond(ROFF_ARGS)
 
        r->last->rule = rule;
 
+       /*
+        * An if-else will put the NEGATION of the current evaluated
+        * conditional into the stack of rules.
+        */
+
        if (ROFF_ie == tok) {
-               /*
-                * An if-else will put the NEGATION of the current
-                * evaluated conditional into the stack.
-                */
-               r->rstackpos++;
-               if (ROFFRULE_DENY == r->last->rule)
-                       r->rstack[r->rstackpos] = ROFFRULE_ALLOW;
-               else
-                       r->rstack[r->rstackpos] = ROFFRULE_DENY;
+               if (r->rstackpos == RSTACK_MAX - 1) {
+                       mandoc_msg(MANDOCERR_MEM, 
+                               r->parse, ln, ppos, NULL);
+                       return(ROFF_ERR);
+               }
+               r->rstack[++r->rstackpos] = 
+                       ROFFRULE_DENY == r->last->rule ?
+                       ROFFRULE_ALLOW : ROFFRULE_DENY;
        }
 
        /* If the parent has false as its rule, then so do we. */
@@ -1111,6 +1111,7 @@ roff_nr(ROFF_ARGS)
 {
        const char      *key;
        char            *val;
+       int              iv;
        struct reg      *rg;
 
        val = *bufp + pos;
@@ -1119,8 +1120,10 @@ roff_nr(ROFF_ARGS)
 
        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;
+               if ((iv = mandoc_strntou(val, strlen(val), 10)) >= 0)
+                       rg[REG_nS].v.u = (unsigned)iv;
+               else
+                       rg[(int)REG_nS].v.u = 0u;
        }
 
        return(ROFF_IGN);