[BACK]Return to roff.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / mandoc

Annotation of src/usr.bin/mandoc/roff.c, Revision 1.32

1.32    ! schwarze    1: /*     $Id: roff.c,v 1.31 2011/01/25 00:23:23 schwarze Exp $ */
1.1       schwarze    2: /*
1.27      schwarze    3:  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.25      schwarze    4:  * Copyright (c) 2010, 2011 Ingo Schwarze <schwarze@openbsd.org>
1.1       schwarze    5:  *
                      6:  * Permission to use, copy, modify, and distribute this software for any
                      7:  * purpose with or without fee is hereby granted, provided that the above
                      8:  * copyright notice and this permission notice appear in all copies.
                      9:  *
1.16      schwarze   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1       schwarze   11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.16      schwarze   12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1       schwarze   13:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     17:  */
                     18: #include <assert.h>
1.6       schwarze   19: #include <errno.h>
1.3       schwarze   20: #include <ctype.h>
1.6       schwarze   21: #include <limits.h>
1.1       schwarze   22: #include <stdlib.h>
                     23: #include <string.h>
1.2       schwarze   24: #include <stdio.h>
1.1       schwarze   25:
                     26: #include "mandoc.h"
                     27: #include "roff.h"
1.27      schwarze   28: #include "libroff.h"
1.8       schwarze   29: #include "libmandoc.h"
1.1       schwarze   30:
1.2       schwarze   31: #define        RSTACK_MAX      128
                     32:
                     33: #define        ROFF_CTL(c) \
                     34:        ('.' == (c) || '\'' == (c))
                     35:
1.1       schwarze   36: enum   rofft {
1.20      schwarze   37:        ROFF_ad,
1.2       schwarze   38:        ROFF_am,
                     39:        ROFF_ami,
                     40:        ROFF_am1,
1.1       schwarze   41:        ROFF_de,
                     42:        ROFF_dei,
1.2       schwarze   43:        ROFF_de1,
                     44:        ROFF_ds,
                     45:        ROFF_el,
1.20      schwarze   46:        ROFF_hy,
1.2       schwarze   47:        ROFF_ie,
                     48:        ROFF_if,
1.1       schwarze   49:        ROFF_ig,
1.30      schwarze   50:        ROFF_it,
1.20      schwarze   51:        ROFF_ne,
                     52:        ROFF_nh,
1.14      schwarze   53:        ROFF_nr,
1.31      schwarze   54:        ROFF_ns,
                     55:        ROFF_ps,
1.2       schwarze   56:        ROFF_rm,
1.14      schwarze   57:        ROFF_so,
1.31      schwarze   58:        ROFF_ta,
1.2       schwarze   59:        ROFF_tr,
1.27      schwarze   60:        ROFF_TS,
                     61:        ROFF_TE,
                     62:        ROFF_T_,
1.32    ! schwarze   63:        ROFF_EQ,
        !            64:        ROFF_EN,
1.2       schwarze   65:        ROFF_cblock,
1.13      schwarze   66:        ROFF_ccond, /* FIXME: remove this. */
1.16      schwarze   67:        ROFF_USERDEF,
1.1       schwarze   68:        ROFF_MAX
                     69: };
                     70:
1.2       schwarze   71: enum   roffrule {
                     72:        ROFFRULE_ALLOW,
                     73:        ROFFRULE_DENY
                     74: };
                     75:
1.8       schwarze   76: struct roffstr {
                     77:        char            *name; /* key of symbol */
                     78:        char            *string; /* current value */
                     79:        struct roffstr  *next; /* next in list */
                     80: };
                     81:
1.1       schwarze   82: struct roff {
                     83:        struct roffnode *last; /* leaf of stack */
                     84:        mandocmsg        msg; /* err/warn/fatal messages */
                     85:        void            *data; /* privdata for messages */
1.2       schwarze   86:        enum roffrule    rstack[RSTACK_MAX]; /* stack of !`ie' rules */
                     87:        int              rstackpos; /* position in rstack */
1.6       schwarze   88:        struct regset   *regs; /* read/writable registers */
1.16      schwarze   89:        struct roffstr  *first_string; /* user-defined strings & macros */
                     90:        const char      *current_string; /* value of last called user macro */
1.27      schwarze   91:        struct tbl_node *first_tbl; /* first table parsed */
                     92:        struct tbl_node *last_tbl; /* last table parsed */
                     93:        struct tbl_node *tbl; /* current table being parsed */
1.32    ! schwarze   94:        struct eqn_node *last_eqn; /* last equation parsed */
        !            95:        struct eqn_node *first_eqn; /* first equation parsed */
        !            96:        struct eqn_node *eqn; /* current equation being parsed */
1.1       schwarze   97: };
                     98:
                     99: struct roffnode {
                    100:        enum rofft       tok; /* type of node */
                    101:        struct roffnode *parent; /* up one in stack */
                    102:        int              line; /* parse line */
                    103:        int              col; /* parse col */
1.16      schwarze  104:        char            *name; /* node name, e.g. macro name */
1.2       schwarze  105:        char            *end; /* end-rules: custom token */
                    106:        int              endspan; /* end-rules: next-line or infty */
                    107:        enum roffrule    rule; /* current evaluation rule */
1.1       schwarze  108: };
                    109:
                    110: #define        ROFF_ARGS        struct roff *r, /* parse ctx */ \
                    111:                         enum rofft tok, /* tok of macro */ \
                    112:                         char **bufp, /* input buffer */ \
                    113:                         size_t *szp, /* size of input buffer */ \
                    114:                         int ln, /* parse line */ \
1.2       schwarze  115:                         int ppos, /* original pos in buffer */ \
                    116:                         int pos, /* current pos in buffer */ \
                    117:                         int *offs /* reset offset of buffer data */
1.1       schwarze  118:
                    119: typedef        enum rofferr (*roffproc)(ROFF_ARGS);
                    120:
                    121: struct roffmac {
                    122:        const char      *name; /* macro name */
1.2       schwarze  123:        roffproc         proc; /* process new macro */
                    124:        roffproc         text; /* process as child text of macro */
                    125:        roffproc         sub; /* process as child of macro */
                    126:        int              flags;
                    127: #define        ROFFMAC_STRUCT  (1 << 0) /* always interpret */
1.3       schwarze  128:        struct roffmac  *next;
1.1       schwarze  129: };
                    130:
1.2       schwarze  131: static enum rofferr     roff_block(ROFF_ARGS);
                    132: static enum rofferr     roff_block_text(ROFF_ARGS);
                    133: static enum rofferr     roff_block_sub(ROFF_ARGS);
                    134: static enum rofferr     roff_cblock(ROFF_ARGS);
                    135: static enum rofferr     roff_ccond(ROFF_ARGS);
                    136: static enum rofferr     roff_cond(ROFF_ARGS);
                    137: static enum rofferr     roff_cond_text(ROFF_ARGS);
                    138: static enum rofferr     roff_cond_sub(ROFF_ARGS);
1.7       schwarze  139: static enum rofferr     roff_ds(ROFF_ARGS);
1.8       schwarze  140: static enum roffrule    roff_evalcond(const char *, int *);
                    141: static void             roff_freestr(struct roff *);
1.28      schwarze  142: static char            *roff_getname(struct roff *, char **, int, int);
1.8       schwarze  143: static const char      *roff_getstrn(const struct roff *,
                    144:                                const char *, size_t);
1.21      schwarze  145: static enum rofferr     roff_line_ignore(ROFF_ARGS);
1.6       schwarze  146: static enum rofferr     roff_nr(ROFF_ARGS);
1.9       schwarze  147: static int              roff_res(struct roff *,
                    148:                                char **, size_t *, int);
1.29      schwarze  149: static enum rofferr     roff_rm(ROFF_ARGS);
1.8       schwarze  150: static void             roff_setstr(struct roff *,
1.16      schwarze  151:                                const char *, const char *, int);
1.14      schwarze  152: static enum rofferr     roff_so(ROFF_ARGS);
1.27      schwarze  153: static enum rofferr     roff_TE(ROFF_ARGS);
                    154: static enum rofferr     roff_TS(ROFF_ARGS);
1.32    ! schwarze  155: static enum rofferr     roff_EQ(ROFF_ARGS);
        !           156: static enum rofferr     roff_EN(ROFF_ARGS);
1.27      schwarze  157: static enum rofferr     roff_T_(ROFF_ARGS);
1.16      schwarze  158: static enum rofferr     roff_userdef(ROFF_ARGS);
1.1       schwarze  159:
1.3       schwarze  160: /* See roff_hash_find() */
                    161:
                    162: #define        ASCII_HI         126
                    163: #define        ASCII_LO         33
                    164: #define        HASHWIDTH       (ASCII_HI - ASCII_LO + 1)
                    165:
                    166: static struct roffmac  *hash[HASHWIDTH];
                    167:
                    168: static struct roffmac   roffs[ROFF_MAX] = {
1.21      schwarze  169:        { "ad", roff_line_ignore, NULL, NULL, 0, NULL },
1.3       schwarze  170:        { "am", roff_block, roff_block_text, roff_block_sub, 0, NULL },
                    171:        { "ami", roff_block, roff_block_text, roff_block_sub, 0, NULL },
                    172:        { "am1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
                    173:        { "de", roff_block, roff_block_text, roff_block_sub, 0, NULL },
                    174:        { "dei", roff_block, roff_block_text, roff_block_sub, 0, NULL },
                    175:        { "de1", roff_block, roff_block_text, roff_block_sub, 0, NULL },
1.7       schwarze  176:        { "ds", roff_ds, NULL, NULL, 0, NULL },
1.3       schwarze  177:        { "el", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
1.21      schwarze  178:        { "hy", roff_line_ignore, NULL, NULL, 0, NULL },
1.3       schwarze  179:        { "ie", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
                    180:        { "if", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL },
                    181:        { "ig", roff_block, roff_block_text, roff_block_sub, 0, NULL },
1.30      schwarze  182:        { "it", roff_line_ignore, NULL, NULL, 0, NULL },
1.21      schwarze  183:        { "ne", roff_line_ignore, NULL, NULL, 0, NULL },
                    184:        { "nh", roff_line_ignore, NULL, NULL, 0, NULL },
1.14      schwarze  185:        { "nr", roff_nr, NULL, NULL, 0, NULL },
1.31      schwarze  186:        { "ns", roff_line_ignore, NULL, NULL, 0, NULL },
                    187:        { "ps", roff_line_ignore, NULL, NULL, 0, NULL },
1.29      schwarze  188:        { "rm", roff_rm, NULL, NULL, 0, NULL },
1.14      schwarze  189:        { "so", roff_so, NULL, NULL, 0, NULL },
1.31      schwarze  190:        { "ta", roff_line_ignore, NULL, NULL, 0, NULL },
1.21      schwarze  191:        { "tr", roff_line_ignore, NULL, NULL, 0, NULL },
1.27      schwarze  192:        { "TS", roff_TS, NULL, NULL, 0, NULL },
                    193:        { "TE", roff_TE, NULL, NULL, 0, NULL },
                    194:        { "T&", roff_T_, NULL, NULL, 0, NULL },
1.32    ! schwarze  195:        { "EQ", roff_EQ, NULL, NULL, 0, NULL },
        !           196:        { "EN", roff_EN, NULL, NULL, 0, NULL },
1.3       schwarze  197:        { ".", roff_cblock, NULL, NULL, 0, NULL },
                    198:        { "\\}", roff_ccond, NULL, NULL, 0, NULL },
1.16      schwarze  199:        { NULL, roff_userdef, NULL, NULL, 0, NULL },
1.1       schwarze  200: };
                    201:
                    202: static void             roff_free1(struct roff *);
1.16      schwarze  203: static enum rofft       roff_hash_find(const char *, size_t);
1.3       schwarze  204: static void             roff_hash_init(void);
1.2       schwarze  205: static void             roffnode_cleanscope(struct roff *);
1.16      schwarze  206: static void             roffnode_push(struct roff *, enum rofft,
                    207:                                const char *, int, int);
1.1       schwarze  208: static void             roffnode_pop(struct roff *);
1.16      schwarze  209: static enum rofft       roff_parse(struct roff *, const char *, int *);
1.6       schwarze  210: static int              roff_parse_nat(const char *, unsigned int *);
1.1       schwarze  211:
1.3       schwarze  212: /* See roff_hash_find() */
                    213: #define        ROFF_HASH(p)    (p[0] - ASCII_LO)
                    214:
                    215: static void
                    216: roff_hash_init(void)
                    217: {
                    218:        struct roffmac   *n;
                    219:        int               buc, i;
                    220:
1.16      schwarze  221:        for (i = 0; i < (int)ROFF_USERDEF; i++) {
1.3       schwarze  222:                assert(roffs[i].name[0] >= ASCII_LO);
                    223:                assert(roffs[i].name[0] <= ASCII_HI);
                    224:
                    225:                buc = ROFF_HASH(roffs[i].name);
                    226:
                    227:                if (NULL != (n = hash[buc])) {
                    228:                        for ( ; n->next; n = n->next)
                    229:                                /* Do nothing. */ ;
                    230:                        n->next = &roffs[i];
                    231:                } else
                    232:                        hash[buc] = &roffs[i];
                    233:        }
                    234: }
                    235:
1.1       schwarze  236:
                    237: /*
                    238:  * Look up a roff token by its name.  Returns ROFF_MAX if no macro by
                    239:  * the nil-terminated string name could be found.
                    240:  */
                    241: static enum rofft
1.16      schwarze  242: roff_hash_find(const char *p, size_t s)
1.1       schwarze  243: {
1.3       schwarze  244:        int              buc;
                    245:        struct roffmac  *n;
1.1       schwarze  246:
1.3       schwarze  247:        /*
                    248:         * libroff has an extremely simple hashtable, for the time
                    249:         * being, which simply keys on the first character, which must
                    250:         * be printable, then walks a chain.  It works well enough until
                    251:         * optimised.
                    252:         */
                    253:
                    254:        if (p[0] < ASCII_LO || p[0] > ASCII_HI)
                    255:                return(ROFF_MAX);
                    256:
                    257:        buc = ROFF_HASH(p);
                    258:
                    259:        if (NULL == (n = hash[buc]))
                    260:                return(ROFF_MAX);
                    261:        for ( ; n; n = n->next)
1.16      schwarze  262:                if (0 == strncmp(n->name, p, s) && '\0' == n->name[(int)s])
1.3       schwarze  263:                        return((enum rofft)(n - roffs));
1.1       schwarze  264:
                    265:        return(ROFF_MAX);
                    266: }
                    267:
                    268:
                    269: /*
                    270:  * Pop the current node off of the stack of roff instructions currently
                    271:  * pending.
                    272:  */
                    273: static void
                    274: roffnode_pop(struct roff *r)
                    275: {
                    276:        struct roffnode *p;
                    277:
1.2       schwarze  278:        assert(r->last);
                    279:        p = r->last;
                    280:
                    281:        if (ROFF_el == p->tok)
                    282:                if (r->rstackpos > -1)
                    283:                        r->rstackpos--;
                    284:
                    285:        r->last = r->last->parent;
1.16      schwarze  286:        free(p->name);
                    287:        free(p->end);
1.1       schwarze  288:        free(p);
                    289: }
                    290:
                    291:
                    292: /*
                    293:  * Push a roff node onto the instruction stack.  This must later be
                    294:  * removed with roffnode_pop().
                    295:  */
1.11      schwarze  296: static void
1.16      schwarze  297: roffnode_push(struct roff *r, enum rofft tok, const char *name,
                    298:                int line, int col)
1.1       schwarze  299: {
                    300:        struct roffnode *p;
                    301:
1.11      schwarze  302:        p = mandoc_calloc(1, sizeof(struct roffnode));
1.1       schwarze  303:        p->tok = tok;
1.16      schwarze  304:        if (name)
                    305:                p->name = mandoc_strdup(name);
1.1       schwarze  306:        p->parent = r->last;
                    307:        p->line = line;
                    308:        p->col = col;
1.2       schwarze  309:        p->rule = p->parent ? p->parent->rule : ROFFRULE_DENY;
1.1       schwarze  310:
                    311:        r->last = p;
                    312: }
                    313:
                    314:
                    315: static void
                    316: roff_free1(struct roff *r)
                    317: {
1.27      schwarze  318:        struct tbl_node *t;
1.32    ! schwarze  319:        struct eqn_node *e;
1.27      schwarze  320:
1.32    ! schwarze  321:        while (NULL != (t = r->first_tbl)) {
1.27      schwarze  322:                r->first_tbl = t->next;
                    323:                tbl_free(t);
                    324:        }
                    325:
                    326:        r->first_tbl = r->last_tbl = r->tbl = NULL;
1.1       schwarze  327:
1.32    ! schwarze  328:        while (NULL != (e = r->first_eqn)) {
        !           329:                r->first_eqn = e->next;
        !           330:                eqn_free(e);
        !           331:        }
        !           332:
        !           333:        r->first_eqn = r->last_eqn = r->eqn = NULL;
        !           334:
1.1       schwarze  335:        while (r->last)
                    336:                roffnode_pop(r);
1.27      schwarze  337:
1.8       schwarze  338:        roff_freestr(r);
1.1       schwarze  339: }
                    340:
                    341:
                    342: void
                    343: roff_reset(struct roff *r)
                    344: {
                    345:
                    346:        roff_free1(r);
                    347: }
                    348:
                    349:
                    350: void
                    351: roff_free(struct roff *r)
                    352: {
                    353:
                    354:        roff_free1(r);
                    355:        free(r);
                    356: }
                    357:
                    358:
                    359: struct roff *
1.11      schwarze  360: roff_alloc(struct regset *regs, void *data, const mandocmsg msg)
1.1       schwarze  361: {
                    362:        struct roff     *r;
                    363:
1.11      schwarze  364:        r = mandoc_calloc(1, sizeof(struct roff));
1.6       schwarze  365:        r->regs = regs;
1.1       schwarze  366:        r->msg = msg;
                    367:        r->data = data;
1.2       schwarze  368:        r->rstackpos = -1;
1.3       schwarze  369:
                    370:        roff_hash_init();
1.1       schwarze  371:        return(r);
                    372: }
                    373:
                    374:
1.8       schwarze  375: /*
                    376:  * Pre-filter each and every line for reserved words (one beginning with
                    377:  * `\*', e.g., `\*(ab').  These must be handled before the actual line
                    378:  * is processed.
                    379:  */
                    380: static int
1.9       schwarze  381: roff_res(struct roff *r, char **bufp, size_t *szp, int pos)
1.8       schwarze  382: {
1.23      schwarze  383:        const char      *stesc; /* start of an escape sequence ('\\') */
                    384:        const char      *stnam; /* start of the name, after "[(*" */
                    385:        const char      *cp;    /* end of the name, e.g. before ']' */
                    386:        const char      *res;   /* the string to be substituted */
1.8       schwarze  387:        int              i, maxl;
                    388:        size_t           nsz;
                    389:        char            *n;
                    390:
1.24      schwarze  391:        /* Search for a leading backslash and save a pointer to it. */
1.23      schwarze  392:
1.24      schwarze  393:        cp = *bufp + pos;
                    394:        while (NULL != (cp = strchr(cp, '\\'))) {
                    395:                stesc = cp++;
1.23      schwarze  396:
                    397:                /*
                    398:                 * The second character must be an asterisk.
                    399:                 * If it isn't, skip it anyway:  It is escaped,
                    400:                 * so it can't start another escape sequence.
                    401:                 */
                    402:
1.24      schwarze  403:                if ('\0' == *cp)
                    404:                        return(1);
                    405:                if ('*' != *cp++)
1.23      schwarze  406:                        continue;
                    407:
                    408:                /*
                    409:                 * The third character decides the length
                    410:                 * of the name of the string.
                    411:                 * Save a pointer to the name.
                    412:                 */
                    413:
1.24      schwarze  414:                switch (*cp) {
                    415:                case ('\0'):
                    416:                        return(1);
1.8       schwarze  417:                case ('('):
                    418:                        cp++;
                    419:                        maxl = 2;
                    420:                        break;
                    421:                case ('['):
                    422:                        cp++;
                    423:                        maxl = 0;
                    424:                        break;
                    425:                default:
                    426:                        maxl = 1;
                    427:                        break;
                    428:                }
1.23      schwarze  429:                stnam = cp;
1.8       schwarze  430:
1.23      schwarze  431:                /* Advance to the end of the name. */
1.8       schwarze  432:
                    433:                for (i = 0; 0 == maxl || i < maxl; i++, cp++) {
                    434:                        if ('\0' == *cp)
                    435:                                return(1); /* Error. */
                    436:                        if (0 == maxl && ']' == *cp)
                    437:                                break;
                    438:                }
                    439:
1.23      schwarze  440:                /*
                    441:                 * Retrieve the replacement string; if it is
                    442:                 * undefined, resume searching for escapes.
                    443:                 */
                    444:
                    445:                res = roff_getstrn(r, stnam, (size_t)i);
1.8       schwarze  446:
                    447:                if (NULL == res) {
                    448:                        cp -= maxl ? 1 : 0;
                    449:                        continue;
                    450:                }
                    451:
1.23      schwarze  452:                /* Replace the escape sequence by the string. */
                    453:
1.8       schwarze  454:                nsz = *szp + strlen(res) + 1;
                    455:                n = mandoc_malloc(nsz);
                    456:
1.23      schwarze  457:                strlcpy(n, *bufp, (size_t)(stesc - *bufp + 1));
1.8       schwarze  458:                strlcat(n, res, nsz);
                    459:                strlcat(n, cp + (maxl ? 0 : 1), nsz);
                    460:
                    461:                free(*bufp);
                    462:
                    463:                *bufp = n;
                    464:                *szp = nsz;
                    465:                return(0);
                    466:        }
                    467:
                    468:        return(1);
                    469: }
                    470:
                    471:
1.1       schwarze  472: enum rofferr
1.6       schwarze  473: roff_parseln(struct roff *r, int ln, char **bufp,
                    474:                size_t *szp, int pos, int *offs)
1.1       schwarze  475: {
                    476:        enum rofft       t;
1.27      schwarze  477:        enum rofferr     e;
1.1       schwarze  478:        int              ppos;
                    479:
1.2       schwarze  480:        /*
1.8       schwarze  481:         * Run the reserved-word filter only if we have some reserved
                    482:         * words to fill in.
                    483:         */
                    484:
1.9       schwarze  485:        if (r->first_string && ! roff_res(r, bufp, szp, pos))
1.16      schwarze  486:                return(ROFF_REPARSE);
1.8       schwarze  487:
                    488:        /*
1.2       schwarze  489:         * First, if a scope is open and we're not a macro, pass the
                    490:         * text through the macro's filter.  If a scope isn't open and
                    491:         * we're not a macro, just let it through.
1.32    ! schwarze  492:         * Finally, if there's an equation scope open, divert it into it
        !           493:         * no matter our state.
1.2       schwarze  494:         */
                    495:
                    496:        if (r->last && ! ROFF_CTL((*bufp)[pos])) {
                    497:                t = r->last->tok;
                    498:                assert(roffs[t].text);
1.27      schwarze  499:                e = (*roffs[t].text)
                    500:                        (r, t, bufp, szp, ln, pos, pos, offs);
                    501:                assert(ROFF_IGN == e || ROFF_CONT == e);
1.32    ! schwarze  502:                if (ROFF_CONT != e)
        !           503:                        return(e);
        !           504:                if (r->eqn)
        !           505:                        return(eqn_read(&r->eqn, ln, *bufp, *offs));
        !           506:                if (r->tbl)
1.27      schwarze  507:                        return(tbl_read(r->tbl, ln, *bufp, *offs));
1.32    ! schwarze  508:                return(ROFF_CONT);
1.27      schwarze  509:        } else if ( ! ROFF_CTL((*bufp)[pos])) {
1.32    ! schwarze  510:                if (r->eqn)
        !           511:                        return(eqn_read(&r->eqn, ln, *bufp, *offs));
1.27      schwarze  512:                if (r->tbl)
                    513:                        return(tbl_read(r->tbl, ln, *bufp, *offs));
1.2       schwarze  514:                return(ROFF_CONT);
1.32    ! schwarze  515:        } else if (r->eqn)
        !           516:                return(eqn_read(&r->eqn, ln, *bufp, *offs));
1.2       schwarze  517:
                    518:        /*
                    519:         * If a scope is open, go to the child handler for that macro,
                    520:         * as it may want to preprocess before doing anything with it.
1.32    ! schwarze  521:         * Don't do so if an equation is open.
1.2       schwarze  522:         */
                    523:
                    524:        if (r->last) {
1.1       schwarze  525:                t = r->last->tok;
                    526:                assert(roffs[t].sub);
1.2       schwarze  527:                return((*roffs[t].sub)
1.8       schwarze  528:                                (r, t, bufp, szp,
                    529:                                 ln, pos, pos, offs));
1.2       schwarze  530:        }
                    531:
                    532:        /*
                    533:         * Lastly, as we've no scope open, try to look up and execute
                    534:         * the new macro.  If no macro is found, simply return and let
                    535:         * the compilers handle it.
                    536:         */
                    537:
                    538:        ppos = pos;
1.16      schwarze  539:        if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos)))
1.1       schwarze  540:                return(ROFF_CONT);
                    541:
1.2       schwarze  542:        assert(roffs[t].proc);
                    543:        return((*roffs[t].proc)
1.8       schwarze  544:                        (r, t, bufp, szp,
                    545:                         ln, ppos, pos, offs));
1.2       schwarze  546: }
                    547:
1.1       schwarze  548:
1.27      schwarze  549: void
1.2       schwarze  550: roff_endparse(struct roff *r)
                    551: {
1.1       schwarze  552:
1.27      schwarze  553:        if (r->last)
                    554:                (*r->msg)(MANDOCERR_SCOPEEXIT, r->data,
                    555:                                r->last->line, r->last->col, NULL);
                    556:
1.32    ! schwarze  557:        if (r->eqn) {
        !           558:                (*r->msg)(MANDOCERR_SCOPEEXIT, r->data,
        !           559:                                r->eqn->eqn.line, r->eqn->eqn.pos, NULL);
        !           560:                eqn_end(r->eqn);
        !           561:                r->eqn = NULL;
        !           562:        }
        !           563:
1.27      schwarze  564:        if (r->tbl) {
                    565:                (*r->msg)(MANDOCERR_SCOPEEXIT, r->data,
                    566:                                r->tbl->line, r->tbl->pos, NULL);
                    567:                tbl_end(r->tbl);
                    568:                r->tbl = NULL;
                    569:        }
1.1       schwarze  570: }
                    571:
                    572:
                    573: /*
                    574:  * Parse a roff node's type from the input buffer.  This must be in the
                    575:  * form of ".foo xxx" in the usual way.
                    576:  */
                    577: static enum rofft
1.16      schwarze  578: roff_parse(struct roff *r, const char *buf, int *pos)
1.1       schwarze  579: {
1.16      schwarze  580:        const char      *mac;
                    581:        size_t           maclen;
1.1       schwarze  582:        enum rofft       t;
                    583:
1.2       schwarze  584:        assert(ROFF_CTL(buf[*pos]));
                    585:        (*pos)++;
1.1       schwarze  586:
1.16      schwarze  587:        while (' ' == buf[*pos] || '\t' == buf[*pos])
1.1       schwarze  588:                (*pos)++;
                    589:
                    590:        if ('\0' == buf[*pos])
                    591:                return(ROFF_MAX);
                    592:
1.16      schwarze  593:        mac = buf + *pos;
                    594:        maclen = strcspn(mac, " \\\t\0");
1.1       schwarze  595:
1.16      schwarze  596:        t = (r->current_string = roff_getstrn(r, mac, maclen))
                    597:            ? ROFF_USERDEF : roff_hash_find(mac, maclen);
1.1       schwarze  598:
1.16      schwarze  599:        *pos += maclen;
1.1       schwarze  600:        while (buf[*pos] && ' ' == buf[*pos])
                    601:                (*pos)++;
                    602:
                    603:        return(t);
                    604: }
                    605:
                    606:
1.6       schwarze  607: static int
                    608: roff_parse_nat(const char *buf, unsigned int *res)
                    609: {
                    610:        char            *ep;
                    611:        long             lval;
                    612:
                    613:        errno = 0;
                    614:        lval = strtol(buf, &ep, 10);
                    615:        if (buf[0] == '\0' || *ep != '\0')
                    616:                return(0);
                    617:        if ((errno == ERANGE &&
                    618:                        (lval == LONG_MAX || lval == LONG_MIN)) ||
                    619:                        (lval > INT_MAX || lval < 0))
                    620:                return(0);
                    621:
                    622:        *res = (unsigned int)lval;
                    623:        return(1);
                    624: }
                    625:
                    626:
1.1       schwarze  627: /* ARGSUSED */
                    628: static enum rofferr
1.2       schwarze  629: roff_cblock(ROFF_ARGS)
1.1       schwarze  630: {
                    631:
1.2       schwarze  632:        /*
                    633:         * A block-close `..' should only be invoked as a child of an
                    634:         * ignore macro, otherwise raise a warning and just ignore it.
                    635:         */
                    636:
                    637:        if (NULL == r->last) {
1.27      schwarze  638:                (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
1.2       schwarze  639:                return(ROFF_IGN);
                    640:        }
1.1       schwarze  641:
1.2       schwarze  642:        switch (r->last->tok) {
                    643:        case (ROFF_am):
                    644:                /* FALLTHROUGH */
                    645:        case (ROFF_ami):
                    646:                /* FALLTHROUGH */
                    647:        case (ROFF_am1):
                    648:                /* FALLTHROUGH */
                    649:        case (ROFF_de):
1.23      schwarze  650:                /* ROFF_de1 is remapped to ROFF_de in roff_block(). */
1.2       schwarze  651:                /* FALLTHROUGH */
                    652:        case (ROFF_dei):
                    653:                /* FALLTHROUGH */
                    654:        case (ROFF_ig):
                    655:                break;
                    656:        default:
1.27      schwarze  657:                (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
1.1       schwarze  658:                return(ROFF_IGN);
1.2       schwarze  659:        }
                    660:
                    661:        if ((*bufp)[pos])
1.27      schwarze  662:                (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL);
1.2       schwarze  663:
                    664:        roffnode_pop(r);
                    665:        roffnode_cleanscope(r);
                    666:        return(ROFF_IGN);
                    667:
                    668: }
1.1       schwarze  669:
                    670:
1.2       schwarze  671: static void
                    672: roffnode_cleanscope(struct roff *r)
                    673: {
1.1       schwarze  674:
1.2       schwarze  675:        while (r->last) {
                    676:                if (--r->last->endspan < 0)
                    677:                        break;
                    678:                roffnode_pop(r);
                    679:        }
                    680: }
1.1       schwarze  681:
                    682:
1.2       schwarze  683: /* ARGSUSED */
                    684: static enum rofferr
                    685: roff_ccond(ROFF_ARGS)
                    686: {
1.1       schwarze  687:
1.2       schwarze  688:        if (NULL == r->last) {
1.27      schwarze  689:                (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
1.1       schwarze  690:                return(ROFF_IGN);
1.2       schwarze  691:        }
1.1       schwarze  692:
1.2       schwarze  693:        switch (r->last->tok) {
                    694:        case (ROFF_el):
                    695:                /* FALLTHROUGH */
                    696:        case (ROFF_ie):
                    697:                /* FALLTHROUGH */
                    698:        case (ROFF_if):
                    699:                break;
                    700:        default:
1.27      schwarze  701:                (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
1.2       schwarze  702:                return(ROFF_IGN);
                    703:        }
1.1       schwarze  704:
1.2       schwarze  705:        if (r->last->endspan > -1) {
1.27      schwarze  706:                (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
1.1       schwarze  707:                return(ROFF_IGN);
1.2       schwarze  708:        }
                    709:
                    710:        if ((*bufp)[pos])
1.27      schwarze  711:                (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL);
1.1       schwarze  712:
1.2       schwarze  713:        roffnode_pop(r);
                    714:        roffnode_cleanscope(r);
1.1       schwarze  715:        return(ROFF_IGN);
                    716: }
                    717:
                    718:
                    719: /* ARGSUSED */
                    720: static enum rofferr
1.2       schwarze  721: roff_block(ROFF_ARGS)
1.1       schwarze  722: {
1.2       schwarze  723:        int             sv;
                    724:        size_t          sz;
1.16      schwarze  725:        char            *name;
                    726:
                    727:        name = NULL;
1.2       schwarze  728:
1.16      schwarze  729:        if (ROFF_ig != tok) {
                    730:                if ('\0' == (*bufp)[pos]) {
                    731:                        (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL);
                    732:                        return(ROFF_IGN);
                    733:                }
1.22      schwarze  734:
                    735:                /*
                    736:                 * Re-write `de1', since we don't really care about
                    737:                 * groff's strange compatibility mode, into `de'.
                    738:                 */
                    739:
1.18      schwarze  740:                if (ROFF_de1 == tok)
                    741:                        tok = ROFF_de;
1.16      schwarze  742:                if (ROFF_de == tok)
                    743:                        name = *bufp + pos;
1.21      schwarze  744:                else
                    745:                        (*r->msg)(MANDOCERR_REQUEST, r->data, ln, ppos,
                    746:                            roffs[tok].name);
1.22      schwarze  747:
1.2       schwarze  748:                while ((*bufp)[pos] && ' ' != (*bufp)[pos])
                    749:                        pos++;
1.22      schwarze  750:
1.2       schwarze  751:                while (' ' == (*bufp)[pos])
1.16      schwarze  752:                        (*bufp)[pos++] = '\0';
1.2       schwarze  753:        }
                    754:
1.16      schwarze  755:        roffnode_push(r, tok, name, ln, ppos);
                    756:
                    757:        /*
                    758:         * At the beginning of a `de' macro, clear the existing string
                    759:         * with the same name, if there is one.  New content will be
                    760:         * added from roff_block_text() in multiline mode.
                    761:         */
1.22      schwarze  762:
1.16      schwarze  763:        if (ROFF_de == tok)
1.19      schwarze  764:                roff_setstr(r, name, "", 0);
1.2       schwarze  765:
                    766:        if ('\0' == (*bufp)[pos])
                    767:                return(ROFF_IGN);
1.1       schwarze  768:
1.22      schwarze  769:        /* If present, process the custom end-of-line marker. */
                    770:
1.2       schwarze  771:        sv = pos;
1.22      schwarze  772:        while ((*bufp)[pos] &&
                    773:                        ' ' != (*bufp)[pos] &&
1.2       schwarze  774:                        '\t' != (*bufp)[pos])
                    775:                pos++;
                    776:
                    777:        /*
                    778:         * Note: groff does NOT like escape characters in the input.
                    779:         * Instead of detecting this, we're just going to let it fly and
                    780:         * to hell with it.
                    781:         */
                    782:
                    783:        assert(pos > sv);
                    784:        sz = (size_t)(pos - sv);
                    785:
                    786:        if (1 == sz && '.' == (*bufp)[sv])
                    787:                return(ROFF_IGN);
                    788:
1.11      schwarze  789:        r->last->end = mandoc_malloc(sz + 1);
1.2       schwarze  790:
                    791:        memcpy(r->last->end, *bufp + sv, sz);
                    792:        r->last->end[(int)sz] = '\0';
                    793:
                    794:        if ((*bufp)[pos])
1.22      schwarze  795:                (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL);
1.1       schwarze  796:
                    797:        return(ROFF_IGN);
                    798: }
                    799:
                    800:
                    801: /* ARGSUSED */
                    802: static enum rofferr
1.2       schwarze  803: roff_block_sub(ROFF_ARGS)
1.1       schwarze  804: {
1.2       schwarze  805:        enum rofft      t;
                    806:        int             i, j;
                    807:
                    808:        /*
                    809:         * First check whether a custom macro exists at this level.  If
                    810:         * it does, then check against it.  This is some of groff's
                    811:         * stranger behaviours.  If we encountered a custom end-scope
                    812:         * tag and that tag also happens to be a "real" macro, then we
                    813:         * need to try interpreting it again as a real macro.  If it's
                    814:         * not, then return ignore.  Else continue.
                    815:         */
                    816:
                    817:        if (r->last->end) {
                    818:                i = pos + 1;
                    819:                while (' ' == (*bufp)[i] || '\t' == (*bufp)[i])
                    820:                        i++;
                    821:
                    822:                for (j = 0; r->last->end[j]; j++, i++)
                    823:                        if ((*bufp)[i] != r->last->end[j])
                    824:                                break;
1.1       schwarze  825:
1.2       schwarze  826:                if ('\0' == r->last->end[j] &&
                    827:                                ('\0' == (*bufp)[i] ||
                    828:                                 ' ' == (*bufp)[i] ||
                    829:                                 '\t' == (*bufp)[i])) {
                    830:                        roffnode_pop(r);
                    831:                        roffnode_cleanscope(r);
1.1       schwarze  832:
1.16      schwarze  833:                        if (ROFF_MAX != roff_parse(r, *bufp, &pos))
1.2       schwarze  834:                                return(ROFF_RERUN);
                    835:                        return(ROFF_IGN);
                    836:                }
1.1       schwarze  837:        }
                    838:
1.2       schwarze  839:        /*
                    840:         * If we have no custom end-query or lookup failed, then try
                    841:         * pulling it out of the hashtable.
                    842:         */
1.1       schwarze  843:
1.2       schwarze  844:        ppos = pos;
1.16      schwarze  845:        t = roff_parse(r, *bufp, &pos);
1.1       schwarze  846:
1.16      schwarze  847:        /*
                    848:         * Macros other than block-end are only significant
                    849:         * in `de' blocks; elsewhere, simply throw them away.
                    850:         */
                    851:        if (ROFF_cblock != t) {
                    852:                if (ROFF_de == tok)
                    853:                        roff_setstr(r, r->last->name, *bufp + ppos, 1);
1.1       schwarze  854:                return(ROFF_IGN);
1.16      schwarze  855:        }
1.1       schwarze  856:
1.2       schwarze  857:        assert(roffs[t].proc);
1.6       schwarze  858:        return((*roffs[t].proc)(r, t, bufp, szp,
                    859:                                ln, ppos, pos, offs));
1.2       schwarze  860: }
                    861:
                    862:
                    863: /* ARGSUSED */
                    864: static enum rofferr
                    865: roff_block_text(ROFF_ARGS)
                    866: {
                    867:
1.16      schwarze  868:        if (ROFF_de == tok)
                    869:                roff_setstr(r, r->last->name, *bufp + pos, 1);
                    870:
1.2       schwarze  871:        return(ROFF_IGN);
                    872: }
                    873:
                    874:
                    875: /* ARGSUSED */
                    876: static enum rofferr
                    877: roff_cond_sub(ROFF_ARGS)
                    878: {
                    879:        enum rofft       t;
                    880:        enum roffrule    rr;
                    881:
                    882:        ppos = pos;
                    883:        rr = r->last->rule;
                    884:
1.5       schwarze  885:        /*
                    886:         * Clean out scope.  If we've closed ourselves, then don't
                    887:         * continue.
                    888:         */
                    889:
                    890:        roffnode_cleanscope(r);
                    891:
1.16      schwarze  892:        if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos))) {
1.12      schwarze  893:                if ('\\' == (*bufp)[pos] && '}' == (*bufp)[pos + 1])
                    894:                        return(roff_ccond
                    895:                                (r, ROFF_ccond, bufp, szp,
                    896:                                 ln, pos, pos + 2, offs));
1.2       schwarze  897:                return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
1.12      schwarze  898:        }
1.2       schwarze  899:
                    900:        /*
                    901:         * A denied conditional must evaluate its children if and only
                    902:         * if they're either structurally required (such as loops and
                    903:         * conditionals) or a closing macro.
                    904:         */
                    905:        if (ROFFRULE_DENY == rr)
                    906:                if ( ! (ROFFMAC_STRUCT & roffs[t].flags))
                    907:                        if (ROFF_ccond != t)
                    908:                                return(ROFF_IGN);
                    909:
                    910:        assert(roffs[t].proc);
1.6       schwarze  911:        return((*roffs[t].proc)(r, t, bufp, szp,
                    912:                                ln, ppos, pos, offs));
1.2       schwarze  913: }
                    914:
                    915:
                    916: /* ARGSUSED */
                    917: static enum rofferr
                    918: roff_cond_text(ROFF_ARGS)
                    919: {
                    920:        char            *ep, *st;
                    921:        enum roffrule    rr;
                    922:
                    923:        rr = r->last->rule;
1.1       schwarze  924:
                    925:        /*
1.2       schwarze  926:         * We display the value of the text if out current evaluation
                    927:         * scope permits us to do so.
1.1       schwarze  928:         */
1.13      schwarze  929:
                    930:        /* FIXME: use roff_ccond? */
1.1       schwarze  931:
1.2       schwarze  932:        st = &(*bufp)[pos];
                    933:        if (NULL == (ep = strstr(st, "\\}"))) {
                    934:                roffnode_cleanscope(r);
                    935:                return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
                    936:        }
                    937:
1.4       schwarze  938:        if (ep == st || (ep > st && '\\' != *(ep - 1)))
1.2       schwarze  939:                roffnode_pop(r);
                    940:
                    941:        roffnode_cleanscope(r);
                    942:        return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT);
                    943: }
                    944:
                    945:
1.5       schwarze  946: static enum roffrule
                    947: roff_evalcond(const char *v, int *pos)
                    948: {
                    949:
                    950:        switch (v[*pos]) {
                    951:        case ('n'):
                    952:                (*pos)++;
                    953:                return(ROFFRULE_ALLOW);
                    954:        case ('e'):
                    955:                /* FALLTHROUGH */
                    956:        case ('o'):
                    957:                /* FALLTHROUGH */
                    958:        case ('t'):
                    959:                (*pos)++;
                    960:                return(ROFFRULE_DENY);
                    961:        default:
                    962:                break;
                    963:        }
                    964:
                    965:        while (v[*pos] && ' ' != v[*pos])
                    966:                (*pos)++;
                    967:        return(ROFFRULE_DENY);
                    968: }
                    969:
1.2       schwarze  970: /* ARGSUSED */
                    971: static enum rofferr
1.21      schwarze  972: roff_line_ignore(ROFF_ARGS)
1.6       schwarze  973: {
1.30      schwarze  974:
                    975:        if (ROFF_it == tok)
                    976:                (*r->msg)(MANDOCERR_REQUEST, r->data, ln, ppos, "it");
1.6       schwarze  977:
1.21      schwarze  978:        return(ROFF_IGN);
                    979: }
                    980:
                    981: /* ARGSUSED */
                    982: static enum rofferr
1.2       schwarze  983: roff_cond(ROFF_ARGS)
                    984: {
                    985:        int              sv;
1.5       schwarze  986:        enum roffrule    rule;
1.2       schwarze  987:
                    988:        /* Stack overflow! */
                    989:
                    990:        if (ROFF_ie == tok && r->rstackpos == RSTACK_MAX - 1) {
1.1       schwarze  991:                (*r->msg)(MANDOCERR_MEM, r->data, ln, ppos, NULL);
                    992:                return(ROFF_ERR);
                    993:        }
                    994:
1.5       schwarze  995:        /* First, evaluate the conditional. */
1.2       schwarze  996:
1.5       schwarze  997:        if (ROFF_el == tok) {
                    998:                /*
                    999:                 * An `.el' will get the value of the current rstack
                   1000:                 * entry set in prior `ie' calls or defaults to DENY.
                   1001:                 */
                   1002:                if (r->rstackpos < 0)
                   1003:                        rule = ROFFRULE_DENY;
                   1004:                else
                   1005:                        rule = r->rstack[r->rstackpos];
                   1006:        } else
                   1007:                rule = roff_evalcond(*bufp, &pos);
1.2       schwarze 1008:
                   1009:        sv = pos;
1.5       schwarze 1010:
1.2       schwarze 1011:        while (' ' == (*bufp)[pos])
                   1012:                pos++;
                   1013:
                   1014:        /*
                   1015:         * Roff is weird.  If we have just white-space after the
                   1016:         * conditional, it's considered the BODY and we exit without
                   1017:         * really doing anything.  Warn about this.  It's probably
                   1018:         * wrong.
                   1019:         */
1.5       schwarze 1020:
1.2       schwarze 1021:        if ('\0' == (*bufp)[pos] && sv != pos) {
1.22      schwarze 1022:                (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL);
                   1023:                return(ROFF_IGN);
1.2       schwarze 1024:        }
                   1025:
1.16      schwarze 1026:        roffnode_push(r, tok, NULL, ln, ppos);
1.2       schwarze 1027:
1.5       schwarze 1028:        r->last->rule = rule;
1.2       schwarze 1029:
                   1030:        if (ROFF_ie == tok) {
                   1031:                /*
                   1032:                 * An if-else will put the NEGATION of the current
                   1033:                 * evaluated conditional into the stack.
                   1034:                 */
                   1035:                r->rstackpos++;
                   1036:                if (ROFFRULE_DENY == r->last->rule)
                   1037:                        r->rstack[r->rstackpos] = ROFFRULE_ALLOW;
                   1038:                else
                   1039:                        r->rstack[r->rstackpos] = ROFFRULE_DENY;
                   1040:        }
1.5       schwarze 1041:
                   1042:        /* If the parent has false as its rule, then so do we. */
                   1043:
1.2       schwarze 1044:        if (r->last->parent && ROFFRULE_DENY == r->last->parent->rule)
                   1045:                r->last->rule = ROFFRULE_DENY;
1.5       schwarze 1046:
                   1047:        /*
                   1048:         * Determine scope.  If we're invoked with "\{" trailing the
                   1049:         * conditional, then we're in a multiline scope.  Else our scope
                   1050:         * expires on the next line.
                   1051:         */
1.2       schwarze 1052:
                   1053:        r->last->endspan = 1;
                   1054:
                   1055:        if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) {
                   1056:                r->last->endspan = -1;
                   1057:                pos += 2;
                   1058:        }
                   1059:
                   1060:        /*
                   1061:         * If there are no arguments on the line, the next-line scope is
                   1062:         * assumed.
                   1063:         */
                   1064:
                   1065:        if ('\0' == (*bufp)[pos])
                   1066:                return(ROFF_IGN);
                   1067:
                   1068:        /* Otherwise re-run the roff parser after recalculating. */
1.1       schwarze 1069:
1.2       schwarze 1070:        *offs = pos;
                   1071:        return(ROFF_RERUN);
1.1       schwarze 1072: }
                   1073:
                   1074:
1.2       schwarze 1075: /* ARGSUSED */
                   1076: static enum rofferr
1.7       schwarze 1077: roff_ds(ROFF_ARGS)
                   1078: {
1.10      schwarze 1079:        char            *name, *string;
                   1080:
                   1081:        /*
                   1082:         * A symbol is named by the first word following the macro
                   1083:         * invocation up to a space.  Its value is anything after the
                   1084:         * name's trailing whitespace and optional double-quote.  Thus,
                   1085:         *
                   1086:         *  [.ds foo "bar  "     ]
                   1087:         *
                   1088:         * will have `bar  "     ' as its value.
                   1089:         */
1.7       schwarze 1090:
1.28      schwarze 1091:        string = *bufp + pos;
                   1092:        name = roff_getname(r, &string, ln, pos);
1.7       schwarze 1093:        if ('\0' == *name)
                   1094:                return(ROFF_IGN);
                   1095:
1.28      schwarze 1096:        /* Read past initial double-quote. */
                   1097:        if ('"' == *string)
1.7       schwarze 1098:                string++;
                   1099:
1.10      schwarze 1100:        /* The rest is the value. */
1.16      schwarze 1101:        roff_setstr(r, name, string, 0);
1.7       schwarze 1102:        return(ROFF_IGN);
                   1103: }
                   1104:
                   1105:
                   1106: /* ARGSUSED */
                   1107: static enum rofferr
1.6       schwarze 1108: roff_nr(ROFF_ARGS)
1.1       schwarze 1109: {
1.28      schwarze 1110:        const char      *key;
                   1111:        char            *val;
1.6       schwarze 1112:        struct reg      *rg;
                   1113:
1.28      schwarze 1114:        val = *bufp + pos;
                   1115:        key = roff_getname(r, &val, ln, pos);
1.6       schwarze 1116:        rg = r->regs->regs;
                   1117:
                   1118:        if (0 == strcmp(key, "nS")) {
                   1119:                rg[(int)REG_nS].set = 1;
                   1120:                if ( ! roff_parse_nat(val, &rg[(int)REG_nS].v.u))
                   1121:                        rg[(int)REG_nS].v.u = 0;
                   1122:        }
1.1       schwarze 1123:
1.29      schwarze 1124:        return(ROFF_IGN);
                   1125: }
                   1126:
                   1127: /* ARGSUSED */
                   1128: static enum rofferr
                   1129: roff_rm(ROFF_ARGS)
                   1130: {
                   1131:        const char       *name;
                   1132:        char             *cp;
                   1133:
                   1134:        cp = *bufp + pos;
                   1135:        while ('\0' != *cp) {
                   1136:                name = roff_getname(r, &cp, ln, cp - *bufp);
                   1137:                if ('\0' != *name)
                   1138:                        roff_setstr(r, name, NULL, 0);
                   1139:        }
1.2       schwarze 1140:        return(ROFF_IGN);
1.14      schwarze 1141: }
                   1142:
                   1143: /* ARGSUSED */
                   1144: static enum rofferr
1.27      schwarze 1145: roff_TE(ROFF_ARGS)
                   1146: {
                   1147:
                   1148:        if (NULL == r->tbl)
                   1149:                (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
                   1150:        else
                   1151:                tbl_end(r->tbl);
                   1152:
                   1153:        r->tbl = NULL;
                   1154:        return(ROFF_IGN);
                   1155: }
                   1156:
                   1157: /* ARGSUSED */
                   1158: static enum rofferr
                   1159: roff_T_(ROFF_ARGS)
                   1160: {
                   1161:
                   1162:        if (NULL == r->tbl)
                   1163:                (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
                   1164:        else
                   1165:                tbl_restart(ppos, ln, r->tbl);
                   1166:
                   1167:        return(ROFF_IGN);
                   1168: }
                   1169:
                   1170: /* ARGSUSED */
                   1171: static enum rofferr
1.32    ! schwarze 1172: roff_EQ(ROFF_ARGS)
        !          1173: {
        !          1174:        struct eqn_node *e;
        !          1175:
        !          1176:        assert(NULL == r->eqn);
        !          1177:        e = eqn_alloc(ppos, ln);
        !          1178:
        !          1179:        if (r->last_eqn)
        !          1180:                r->last_eqn->next = e;
        !          1181:        else
        !          1182:                r->first_eqn = r->last_eqn = e;
        !          1183:
        !          1184:        r->eqn = r->last_eqn = e;
        !          1185:        return(ROFF_IGN);
        !          1186: }
        !          1187:
        !          1188: /* ARGSUSED */
        !          1189: static enum rofferr
        !          1190: roff_EN(ROFF_ARGS)
        !          1191: {
        !          1192:
        !          1193:        (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL);
        !          1194:        return(ROFF_IGN);
        !          1195: }
        !          1196:
        !          1197: /* ARGSUSED */
        !          1198: static enum rofferr
1.27      schwarze 1199: roff_TS(ROFF_ARGS)
                   1200: {
                   1201:        struct tbl_node *t;
                   1202:
                   1203:        if (r->tbl) {
                   1204:                (*r->msg)(MANDOCERR_SCOPEBROKEN, r->data, ln, ppos, NULL);
                   1205:                tbl_end(r->tbl);
                   1206:        }
                   1207:
                   1208:        t = tbl_alloc(ppos, ln, r->data, r->msg);
                   1209:
                   1210:        if (r->last_tbl)
                   1211:                r->last_tbl->next = t;
                   1212:        else
                   1213:                r->first_tbl = r->last_tbl = t;
                   1214:
                   1215:        r->tbl = r->last_tbl = t;
                   1216:        return(ROFF_IGN);
                   1217: }
                   1218:
                   1219: /* ARGSUSED */
                   1220: static enum rofferr
1.14      schwarze 1221: roff_so(ROFF_ARGS)
                   1222: {
                   1223:        char *name;
1.15      schwarze 1224:
                   1225:        (*r->msg)(MANDOCERR_SO, r->data, ln, ppos, NULL);
1.14      schwarze 1226:
1.22      schwarze 1227:        /*
                   1228:         * Handle `so'.  Be EXTREMELY careful, as we shouldn't be
                   1229:         * opening anything that's not in our cwd or anything beneath
                   1230:         * it.  Thus, explicitly disallow traversing up the file-system
                   1231:         * or using absolute paths.
                   1232:         */
                   1233:
1.14      schwarze 1234:        name = *bufp + pos;
                   1235:        if ('/' == *name || strstr(name, "../") || strstr(name, "/..")) {
                   1236:                (*r->msg)(MANDOCERR_SOPATH, r->data, ln, pos, NULL);
                   1237:                return(ROFF_ERR);
                   1238:        }
                   1239:
                   1240:        *offs = pos;
                   1241:        return(ROFF_SO);
1.7       schwarze 1242: }
                   1243:
1.16      schwarze 1244: /* ARGSUSED */
                   1245: static enum rofferr
                   1246: roff_userdef(ROFF_ARGS)
1.12      schwarze 1247: {
1.16      schwarze 1248:        const char       *arg[9];
                   1249:        char             *cp, *n1, *n2;
1.25      schwarze 1250:        int               i;
1.12      schwarze 1251:
1.16      schwarze 1252:        /*
                   1253:         * Collect pointers to macro argument strings
                   1254:         * and null-terminate them.
                   1255:         */
                   1256:        cp = *bufp + pos;
1.25      schwarze 1257:        for (i = 0; i < 9; i++)
1.26      schwarze 1258:                arg[i] = '\0' == *cp ? "" :
1.25      schwarze 1259:                    mandoc_getarg(&cp, r->msg, r->data, ln, &pos);
1.16      schwarze 1260:
                   1261:        /*
                   1262:         * Expand macro arguments.
1.12      schwarze 1263:         */
1.16      schwarze 1264:        *szp = 0;
                   1265:        n1 = cp = mandoc_strdup(r->current_string);
                   1266:        while (NULL != (cp = strstr(cp, "\\$"))) {
                   1267:                i = cp[2] - '1';
                   1268:                if (0 > i || 8 < i) {
                   1269:                        /* Not an argument invocation. */
                   1270:                        cp += 2;
                   1271:                        continue;
                   1272:                }
                   1273:
                   1274:                *szp = strlen(n1) - 3 + strlen(arg[i]) + 1;
                   1275:                n2 = mandoc_malloc(*szp);
                   1276:
                   1277:                strlcpy(n2, n1, (size_t)(cp - n1 + 1));
                   1278:                strlcat(n2, arg[i], *szp);
                   1279:                strlcat(n2, cp + 3, *szp);
                   1280:
                   1281:                cp = n2 + (cp - n1);
                   1282:                free(n1);
                   1283:                n1 = n2;
1.12      schwarze 1284:        }
                   1285:
1.16      schwarze 1286:        /*
                   1287:         * Replace the macro invocation
                   1288:         * by the expanded macro.
                   1289:         */
                   1290:        free(*bufp);
                   1291:        *bufp = n1;
                   1292:        if (0 == *szp)
                   1293:                *szp = strlen(*bufp) + 1;
                   1294:
1.19      schwarze 1295:        return(*szp > 1 && '\n' == (*bufp)[(int)*szp - 2] ?
1.16      schwarze 1296:           ROFF_REPARSE : ROFF_APPEND);
1.12      schwarze 1297: }
1.28      schwarze 1298:
                   1299: static char *
                   1300: roff_getname(struct roff *r, char **cpp, int ln, int pos)
                   1301: {
                   1302:        char     *name, *cp;
                   1303:
                   1304:        name = *cpp;
                   1305:        if ('\0' == *name)
                   1306:                return(name);
                   1307:
                   1308:        /* Read until end of name. */
                   1309:        for (cp = name; '\0' != *cp && ' ' != *cp; cp++) {
                   1310:                if ('\\' != *cp)
                   1311:                        continue;
                   1312:                cp++;
                   1313:                if ('\\' == *cp)
                   1314:                        continue;
                   1315:                (*r->msg)(MANDOCERR_NAMESC, r->data, ln, pos, NULL);
                   1316:                *cp = '\0';
                   1317:                name = cp;
                   1318:        }
                   1319:
                   1320:        /* Nil-terminate name. */
                   1321:        if ('\0' != *cp)
                   1322:                *(cp++) = '\0';
                   1323:
                   1324:        /* Read past spaces. */
                   1325:        while (' ' == *cp)
                   1326:                cp++;
                   1327:
                   1328:        *cpp = cp;
                   1329:        return(name);
                   1330: }
                   1331:
1.16      schwarze 1332: /*
                   1333:  * Store *string into the user-defined string called *name.
                   1334:  * In multiline mode, append to an existing entry and append '\n';
                   1335:  * else replace the existing entry, if there is one.
                   1336:  * To clear an existing entry, call with (*r, *name, NULL, 0).
                   1337:  */
1.8       schwarze 1338: static void
1.16      schwarze 1339: roff_setstr(struct roff *r, const char *name, const char *string,
                   1340:        int multiline)
1.7       schwarze 1341: {
                   1342:        struct roffstr   *n;
1.16      schwarze 1343:        char             *c;
                   1344:        size_t            oldch, newch;
1.7       schwarze 1345:
1.16      schwarze 1346:        /* Search for an existing string with the same name. */
1.8       schwarze 1347:        n = r->first_string;
1.7       schwarze 1348:        while (n && strcmp(name, n->name))
                   1349:                n = n->next;
1.8       schwarze 1350:
                   1351:        if (NULL == n) {
1.16      schwarze 1352:                /* Create a new string table entry. */
1.8       schwarze 1353:                n = mandoc_malloc(sizeof(struct roffstr));
1.16      schwarze 1354:                n->name = mandoc_strdup(name);
                   1355:                n->string = NULL;
1.8       schwarze 1356:                n->next = r->first_string;
                   1357:                r->first_string = n;
1.16      schwarze 1358:        } else if (0 == multiline) {
                   1359:                /* In multiline mode, append; else replace. */
1.7       schwarze 1360:                free(n->string);
1.16      schwarze 1361:                n->string = NULL;
                   1362:        }
                   1363:
                   1364:        if (NULL == string)
                   1365:                return;
                   1366:
                   1367:        /*
                   1368:         * One additional byte for the '\n' in multiline mode,
                   1369:         * and one for the terminating '\0'.
                   1370:         */
                   1371:        newch = strlen(string) + (multiline ? 2 : 1);
                   1372:        if (NULL == n->string) {
                   1373:                n->string = mandoc_malloc(newch);
                   1374:                *n->string = '\0';
                   1375:                oldch = 0;
                   1376:        } else {
                   1377:                oldch = strlen(n->string);
                   1378:                n->string = mandoc_realloc(n->string, oldch + newch);
                   1379:        }
                   1380:
                   1381:        /* Skip existing content in the destination buffer. */
                   1382:        c = n->string + oldch;
                   1383:
                   1384:        /* Append new content to the destination buffer. */
                   1385:        while (*string) {
                   1386:                /*
                   1387:                 * Rudimentary roff copy mode:
                   1388:                 * Handle escaped backslashes.
                   1389:                 */
                   1390:                if ('\\' == *string && '\\' == *(string + 1))
                   1391:                        string++;
                   1392:                *c++ = *string++;
                   1393:        }
1.8       schwarze 1394:
1.16      schwarze 1395:        /* Append terminating bytes. */
                   1396:        if (multiline)
                   1397:                *c++ = '\n';
                   1398:        *c = '\0';
1.7       schwarze 1399: }
                   1400:
1.8       schwarze 1401: static const char *
                   1402: roff_getstrn(const struct roff *r, const char *name, size_t len)
1.7       schwarze 1403: {
1.8       schwarze 1404:        const struct roffstr *n;
1.7       schwarze 1405:
1.8       schwarze 1406:        n = r->first_string;
1.10      schwarze 1407:        while (n && (strncmp(name, n->name, len) || '\0' != n->name[(int)len]))
1.7       schwarze 1408:                n = n->next;
1.8       schwarze 1409:
                   1410:        return(n ? n->string : NULL);
1.7       schwarze 1411: }
                   1412:
1.8       schwarze 1413: static void
                   1414: roff_freestr(struct roff *r)
1.7       schwarze 1415: {
                   1416:        struct roffstr   *n, *nn;
                   1417:
1.8       schwarze 1418:        for (n = r->first_string; n; n = nn) {
1.7       schwarze 1419:                free(n->name);
                   1420:                free(n->string);
                   1421:                nn = n->next;
                   1422:                free(n);
                   1423:        }
1.8       schwarze 1424:
                   1425:        r->first_string = NULL;
1.27      schwarze 1426: }
                   1427:
                   1428: const struct tbl_span *
                   1429: roff_span(const struct roff *r)
                   1430: {
                   1431:
                   1432:        return(r->tbl ? tbl_span(r->tbl) : NULL);
1.32    ! schwarze 1433: }
        !          1434:
        !          1435: const struct eqn *
        !          1436: roff_eqn(const struct roff *r)
        !          1437: {
        !          1438:
        !          1439:        return(r->last_eqn ? &r->last_eqn->eqn : NULL);
1.1       schwarze 1440: }