]> 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 439784a97394e9c4940cb3c36bce091601f139fd..7d76fb563d517bf25bbe7f2d45cd1fd69f30d907 100644 (file)
--- a/roff.c
+++ b/roff.c
@@ -1,7 +1,7 @@
-/*     $Id: roff.c,v 1.113 2010/12/31 14:52:41 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 Ingo Schwarze <schwarze@openbsd.org>
+ * 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
@@ -51,15 +51,21 @@ enum        rofft {
        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, /* FIXME: remove this. */
        ROFF_USERDEF,
@@ -86,9 +92,12 @@ struct       roff {
        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      *first_tbl; /* first table parsed */
-       struct tbl      *last_tbl; /* last table parsed */
-       struct tbl      *tbl; /* current table being parsed */
+       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 {
@@ -134,18 +143,21 @@ 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_line_error(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);
 
@@ -171,15 +183,21 @@ static    struct roffmac   roffs[ROFF_MAX] = {
        { "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 },
-       { "rm", roff_line_error, 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 },
@@ -301,16 +319,23 @@ roffnode_push(struct roff *r, enum rofft tok, const char *name,
 static void
 roff_free1(struct roff *r)
 {
-       struct tbl      *t;
+       struct tbl_node *t;
+       struct eqn_node *e;
 
-       while (r->first_tbl) {
-               t = r->first_tbl;
+       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);
 
@@ -468,6 +493,8 @@ roff_parseln(struct roff *r, int ln, char **bufp,
         * 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])) {
@@ -476,18 +503,26 @@ roff_parseln(struct roff *r, int ln, char **bufp,
                e = (*roffs[t].text)
                        (r, t, bufp, szp, ln, pos, pos, offs);
                assert(ROFF_IGN == e || ROFF_CONT == e);
-               if (ROFF_CONT == e && r->tbl)
+               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(e);
+               return(ROFF_CONT);
        } else if ( ! ROFF_CTL((*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) {
@@ -515,15 +550,27 @@ roff_parseln(struct roff *r, int ln, char **bufp,
 }
 
 
-int
+void
 roff_endparse(struct roff *r)
 {
 
-       /* FIXME: if r->tbl */
        if (r->last)
-               (*r->msg)(MANDOCERR_SCOPEEXIT, r->data, 
+               (*r->msg)(MANDOCERR_SCOPEEXIT, r->data,
                                r->last->line, r->last->col, NULL);
-       return(1);
+
+       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;
+       }
 }
 
 
@@ -929,15 +976,9 @@ static enum rofferr
 roff_line_ignore(ROFF_ARGS)
 {
 
-       return(ROFF_IGN);
-}
+       if (ROFF_it == tok)
+               (*r->msg)(MANDOCERR_REQUEST, r->data, ln, ppos, "it");
 
-/* ARGSUSED */
-static enum rofferr
-roff_line_error(ROFF_ARGS)
-{
-
-       (*r->msg)(MANDOCERR_REQUEST, r->data, ln, ppos, roffs[tok].name);
        return(ROFF_IGN);
 }
 
@@ -1051,25 +1092,13 @@ roff_ds(ROFF_ARGS)
         * will have `bar  "     ' as its value.
         */
 
-       name = *bufp + pos;
+       string = *bufp + pos;
+       name = roff_getname(r, &string, ln, pos);
        if ('\0' == *name)
                return(ROFF_IGN);
 
-       string = name;
-       /* Read until end of name. */
-       while (*string && ' ' != *string)
-               string++;
-
-       /* Nil-terminate name. */
-       if (*string)
-               *(string++) = '\0';
-       
-       /* Read past spaces. */
-       while (*string && ' ' == *string)
-               string++;
-
-       /* Read passed initial double-quote. */
-       if (*string && '"' == *string)
+       /* Read past initial double-quote. */
+       if ('"' == *string)
                string++;
 
        /* The rest is the value. */
@@ -1082,31 +1111,14 @@ roff_ds(ROFF_ARGS)
 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++;
-
-       /*
-        * Set our nil terminator.  Because this line is going to be
-        * ignored anyway, we can munge it as we please.
-        */
-       if ((*bufp)[pos])
-               (*bufp)[pos++] = '\0';
-
-       /* Skip whitespace to register token. */
-       while ((*bufp)[pos] && ' ' == (*bufp)[pos])
-               pos++;
-
-       val = &(*bufp)[pos];
-
-       /* Process register token. */
-
        if (0 == strcmp(key, "nS")) {
                rg[(int)REG_nS].set = 1;
                if ( ! roff_parse_nat(val, &rg[(int)REG_nS].v.u))
@@ -1116,6 +1128,22 @@ roff_nr(ROFF_ARGS)
        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)
@@ -1123,6 +1151,8 @@ 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);
@@ -1136,21 +1166,50 @@ roff_T_(ROFF_ARGS)
        if (NULL == r->tbl)
                (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
        else
-               tbl_restart(r->tbl);
+               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      *t;
+       struct tbl_node *t;
 
-       if (r->tbl)
+       if (r->tbl) {
                (*r->msg)(MANDOCERR_SCOPEBROKEN, r->data, ln, ppos, NULL);
+               tbl_end(r->tbl);
+       }
 
-       t = tbl_alloc(r->data, r->msg);
+       t = tbl_alloc(ppos, ln, r->data, r->msg);
 
        if (r->last_tbl)
                r->last_tbl->next = t;
@@ -1192,53 +1251,16 @@ roff_userdef(ROFF_ARGS)
 {
        const char       *arg[9];
        char             *cp, *n1, *n2;
-       int               i, quoted, pairs;
+       int               i;
 
        /*
         * Collect pointers to macro argument strings
         * and null-terminate them.
         */
        cp = *bufp + pos;
-       for (i = 0; i < 9; i++) {
-               /* Quoting can only start with a new word. */
-               if ('"' == *cp) {
-                       quoted = 1;
-                       cp++;
-               } else
-                       quoted = 0;
-               arg[i] = cp;
-               for (pairs = 0; '\0' != *cp; cp++) {
-                       /* Unquoted arguments end at blanks. */
-                       if (0 == quoted) {
-                               if (' ' == *cp)
-                                       break;
-                               continue;
-                       }
-                       /* After pairs of quotes, move left. */
-                       if (pairs)
-                               cp[-pairs] = cp[0];
-                       /* Pairs of quotes do not end words, ... */
-                       if ('"' == cp[0] && '"' == cp[1]) {
-                               pairs++;
-                               cp++;
-                               continue;
-                       }
-                       /* ... but solitary quotes do. */
-                       if ('"' != *cp)
-                               continue;
-                       if (pairs)
-                               cp[-pairs] = '\0';
-                       *cp = ' ';
-                       break;
-               }
-               /* Last argument; the remaining ones are empty strings. */
-               if ('\0' == *cp)
-                       continue;
-               /* Null-terminate argument and move to the next one. */
-               *cp++ = '\0';
-               while (' ' == *cp)
-                       cp++;
-       }
+       for (i = 0; i < 9; i++)
+               arg[i] = '\0' == *cp ? "" :
+                   mandoc_getarg(&cp, r->msg, r->data, ln, &pos);
 
        /*
         * Expand macro arguments.
@@ -1278,6 +1300,39 @@ roff_userdef(ROFF_ARGS)
           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';
@@ -1347,7 +1402,6 @@ roff_setstr(struct roff *r, const char *name, const char *string,
        *c = '\0';
 }
 
-
 static const char *
 roff_getstrn(const struct roff *r, const char *name, size_t len)
 {
@@ -1360,7 +1414,6 @@ roff_getstrn(const struct roff *r, const char *name, size_t len)
        return(n ? n->string : NULL);
 }
 
-
 static void
 roff_freestr(struct roff *r)
 {
@@ -1375,3 +1428,17 @@ roff_freestr(struct roff *r)
 
        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);
+}