]> git.cameronkatri.com Git - mandoc.git/blobdiff - roff.c
implement -Tman .Bk; OpenBSD rev. 1.10
[mandoc.git] / roff.c
diff --git a/roff.c b/roff.c
index f1258ef9964e04ae427f169f30c761978ba4eb6d..ad9645ee5924691343432d7ff4704bd4057e5753 100644 (file)
--- a/roff.c
+++ b/roff.c
@@ -1,7 +1,7 @@
-/*     $Id: roff.c,v 1.167 2011/07/29 10:16:59 kristaps Exp $ */
+/*     $Id: roff.c,v 1.174 2012/06/12 20:21:04 kristaps Exp $ */
 /*
  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010, 2011, 2012 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
 /* Maximum number of nested if-else conditionals. */
 #define        RSTACK_MAX      128
 
+/* Maximum number of string expansions per line, to break infinite loops. */
+#define        EXPAND_LIMIT    1000
+
 enum   rofft {
        ROFF_ad,
        ROFF_am,
        ROFF_ami,
        ROFF_am1,
+       ROFF_cc,
        ROFF_de,
        ROFF_dei,
        ROFF_de1,
@@ -102,6 +106,7 @@ struct      roff {
        struct mparse   *parse; /* parse point */
        struct roffnode *last; /* leaf of stack */
        enum roffrule    rstack[RSTACK_MAX]; /* stack of !`ie' rules */
+       char             control; /* control character */
        int              rstackpos; /* position in rstack */
        struct reg       regs[REG__MAX];
        struct roffkv   *strtab; /* user-defined strings & macros */
@@ -166,6 +171,7 @@ 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_cc(ROFF_ARGS);
 static enum rofferr     roff_ccond(ROFF_ARGS);
 static enum rofferr     roff_cond(ROFF_ARGS);
 static enum rofferr     roff_cond_text(ROFF_ARGS);
@@ -179,11 +185,11 @@ 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 void             roff_openeqn(struct roff *, const char *, 
+static void             roff_openeqn(struct roff *, const char *,
                                int, int, const char *);
 static enum rofft       roff_parse(struct roff *, const char *, int *);
 static enum rofferr     roff_parsetext(char *);
-static void             roff_res(struct roff *, 
+static enum rofferr     roff_res(struct roff *, 
                                char **, size_t *, int, int);
 static enum rofferr     roff_rm(ROFF_ARGS);
 static void             roff_setstr(struct roff *,
@@ -212,6 +218,7 @@ static      struct roffmac   roffs[ROFF_MAX] = {
        { "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 },
+       { "cc", roff_cc, NULL, NULL, 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 },
@@ -389,6 +396,7 @@ roff_reset(struct roff *r)
 
        roff_free1(r);
 
+       r->control = 0;
        memset(&r->regs, 0, sizeof(struct reg) * REG__MAX);
 
        for (i = 0; i < PREDEFS_MAX; i++) 
@@ -429,7 +437,7 @@ roff_alloc(struct mparse *parse)
  * is processed. 
  * This also checks the syntax of regular escapes.
  */
-static void
+static enum rofferr
 roff_res(struct roff *r, char **bufp, size_t *szp, int ln, int pos)
 {
        enum mandoc_esc  esc;
@@ -437,10 +445,12 @@ roff_res(struct roff *r, char **bufp, size_t *szp, int ln, int pos)
        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;
+       int              i, maxl, expand_count;
        size_t           nsz;
        char            *n;
 
+       expand_count = 0;
+
 again:
        cp = *bufp + pos;
        while (NULL != (cp = strchr(cp, '\\'))) {
@@ -453,7 +463,7 @@ again:
                 */
 
                if ('\0' == *cp)
-                       return;
+                       return(ROFF_CONT);
 
                if ('*' != *cp) {
                        res = cp;
@@ -464,7 +474,7 @@ again:
                        mandoc_msg
                                (MANDOCERR_BADESCAPE, r->parse, 
                                 ln, (int)(stesc - *bufp), NULL);
-                       return;
+                       return(ROFF_CONT);
                }
 
                cp++;
@@ -477,7 +487,7 @@ again:
 
                switch (*cp) {
                case ('\0'):
-                       return;
+                       return(ROFF_CONT);
                case ('('):
                        cp++;
                        maxl = 2;
@@ -500,7 +510,7 @@ again:
                                        (MANDOCERR_BADESCAPE, 
                                         r->parse, ln, 
                                         (int)(stesc - *bufp), NULL);
-                               return;
+                               return(ROFF_CONT);
                        }
                        if (0 == maxl && ']' == *cp)
                                break;
@@ -535,8 +545,15 @@ again:
 
                *bufp = n;
                *szp = nsz;
-               goto again;
+
+               if (EXPAND_LIMIT >= ++expand_count)
+                       goto again;
+
+               /* Just leave the string unexpanded. */
+               mandoc_msg(MANDOCERR_ROFFLOOP, r->parse, ln, pos, NULL);
+               return(ROFF_IGN);
        }
+       return(ROFF_CONT);
 }
 
 /*
@@ -545,7 +562,6 @@ again:
 static enum rofferr
 roff_parsetext(char *p)
 {
-       char             l, r;
        size_t           sz;
        const char      *start;
        enum mandoc_esc  esc;
@@ -572,14 +588,8 @@ roff_parsetext(char *p)
                        continue;
                }
 
-               l = *(p - 1);
-               r = *(p + 1);
-               if ('\\' != l &&
-                               '\t' != r && '\t' != l &&
-                               ' ' != r && ' ' != l &&
-                               '-' != r && '-' != l &&
-                               ! isdigit((unsigned char)l) &&
-                               ! isdigit((unsigned char)r))
+               if (isalpha((unsigned char)p[-1]) &&
+                   isalpha((unsigned char)p[1]))
                        *p = ASCII_HYPH;
                p++;
        }
@@ -600,10 +610,13 @@ roff_parseln(struct roff *r, int ln, char **bufp,
         * words to fill in.
         */
 
-       roff_res(r, bufp, szp, ln, pos);
+       e = roff_res(r, bufp, szp, ln, pos);
+       if (ROFF_IGN == e)
+               return(e);
+       assert(ROFF_CONT == e);
 
        ppos = pos;
-       ctl = mandoc_getcontrol(*bufp, &pos);
+       ctl = roff_getcontrol(r, *bufp, &pos);
 
        /*
         * First, if a scope is open and we're not a macro, pass the
@@ -770,7 +783,7 @@ roffnode_cleanscope(struct roff *r)
 {
 
        while (r->last) {
-               if (--r->last->endspan < 0)
+               if (--r->last->endspan != 0)
                        break;
                roffnode_pop(r);
        }
@@ -1090,8 +1103,8 @@ roff_line_ignore(ROFF_ARGS)
 static enum rofferr
 roff_cond(ROFF_ARGS)
 {
-       int              sv;
-       enum roffrule    rule;
+
+       roffnode_push(r, tok, NULL, ln, ppos);
 
        /* 
         * An `.el' has no conditional body: it will consume the value
@@ -1101,31 +1114,11 @@ roff_cond(ROFF_ARGS)
         * If we're not an `el', however, then evaluate the conditional.
         */
 
-       rule = ROFF_el == tok ?
+       r->last->rule = ROFF_el == tok ?
                (r->rstackpos < 0 ? 
                 ROFFRULE_DENY : r->rstack[r->rstackpos--]) :
                roff_evalcond(*bufp, &pos);
 
-       sv = pos;
-       while (' ' == (*bufp)[pos])
-               pos++;
-
-       /*
-        * 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.
-        */
-
-       if ('\0' == (*bufp)[pos] && sv != pos) {
-               mandoc_msg(MANDOCERR_NOARGS, r->parse, ln, ppos, NULL);
-               return(ROFF_IGN);
-       }
-
-       roffnode_push(r, tok, NULL, ln, ppos);
-
-       r->last->rule = rule;
-
        /*
         * An if-else will put the NEGATION of the current evaluated
         * conditional into the stack of rules.
@@ -1148,28 +1141,39 @@ roff_cond(ROFF_ARGS)
                r->last->rule = ROFFRULE_DENY;
 
        /*
-        * 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.
+        * Determine scope.
+        * If there is nothing on the line after the conditional,
+        * not even whitespace, use next-line scope.
         */
 
-       r->last->endspan = 1;
+       if ('\0' == (*bufp)[pos]) {
+               r->last->endspan = 2;
+               goto out;
+       }
+
+       while (' ' == (*bufp)[pos])
+               pos++;
+
+       /* An opening brace requests multiline scope. */
 
        if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
                r->last->endspan = -1;
                pos += 2;
+               goto out;
        } 
 
        /*
-        * If there are no arguments on the line, the next-line scope is
-        * assumed.
+        * Anything else following the conditional causes
+        * single-line scope.  Warn if the scope contains
+        * nothing but trailing whitespace.
         */
 
        if ('\0' == (*bufp)[pos])
-               return(ROFF_IGN);
+               mandoc_msg(MANDOCERR_NOARGS, r->parse, ln, ppos, NULL);
 
-       /* Otherwise re-run the roff parser after recalculating. */
+       r->last->endspan = 1;
 
+out:
        *offs = pos;
        return(ROFF_RERUN);
 }
@@ -1362,6 +1366,23 @@ roff_TS(ROFF_ARGS)
        return(ROFF_IGN);
 }
 
+/* ARGSUSED */
+static enum rofferr
+roff_cc(ROFF_ARGS)
+{
+       const char      *p;
+
+       p = *bufp + pos;
+
+       if ('\0' == *p || '.' == (r->control = *p++))
+               r->control = 0;
+
+       if ('\0' != *p)
+               mandoc_msg(MANDOCERR_ARGCOUNT, r->parse, ln, ppos, NULL);
+
+       return(ROFF_IGN);
+}
+
 /* ARGSUSED */
 static enum rofferr
 roff_tr(ROFF_ARGS)
@@ -1667,13 +1688,6 @@ roff_eqn(const struct roff *r)
        return(r->last_eqn ? &r->last_eqn->eqn : NULL);
 }
 
-char
-roff_eqndelim(const struct roff *r)
-{
-
-       return('\0');
-}
-
 /*
  * Duplicate an input string, making the appropriate character
  * conversations (as stipulated by `tr') along the way.
@@ -1765,3 +1779,38 @@ roff_strdup(const struct roff *r, const char *p)
        res[(int)ssz] = '\0';
        return(res);
 }
+
+/*
+ * Find out whether a line is a macro line or not.  
+ * If it is, adjust the current position and return one; if it isn't,
+ * return zero and don't change the current position.
+ * If the control character has been set with `.cc', then let that grain
+ * precedence.
+ * This is slighly contrary to groff, where using the non-breaking
+ * control character when `cc' has been invoked will cause the
+ * non-breaking macro contents to be printed verbatim.
+ */
+int
+roff_getcontrol(const struct roff *r, const char *cp, int *ppos)
+{
+       int             pos;
+
+       pos = *ppos;
+
+       if (0 != r->control && cp[pos] == r->control)
+               pos++;
+       else if (0 != r->control)
+               return(0);
+       else if ('\\' == cp[pos] && '.' == cp[pos + 1])
+               pos += 2;
+       else if ('.' == cp[pos] || '\'' == cp[pos])
+               pos++;
+       else
+               return(0);
+
+       while (' ' == cp[pos] || '\t' == cp[pos])
+               pos++;
+
+       *ppos = pos;
+       return(1);
+}