[BACK]Return to roff.c CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/roff.c, Revision 1.399

1.399   ! schwarze    1: /* $Id: roff.c,v 1.398 2023/10/22 16:02:01 schwarze Exp $ */
1.1       kristaps    2: /*
1.399   ! schwarze    3:  * Copyright (c) 2010-2015, 2017-2023 Ingo Schwarze <schwarze@openbsd.org>
1.267     schwarze    4:  * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
1.1       kristaps    5:  *
                      6:  * Permission to use, copy, modify, and distribute this software for any
1.66      kristaps    7:  * purpose with or without fee is hereby granted, provided that the above
                      8:  * copyright notice and this permission notice appear in all copies.
1.1       kristaps    9:  *
1.106     kristaps   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.66      kristaps   11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.106     kristaps   12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.66      kristaps   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.
1.372     schwarze   17:  *
                     18:  * Implementation of the roff(7) parser for mandoc(1).
1.1       kristaps   19:  */
1.66      kristaps   20: #include "config.h"
1.225     schwarze   21:
                     22: #include <sys/types.h>
1.30      kristaps   23:
1.67      kristaps   24: #include <assert.h>
1.85      kristaps   25: #include <ctype.h>
1.245     schwarze   26: #include <limits.h>
1.295     schwarze   27: #include <stddef.h>
                     28: #include <stdint.h>
1.178     schwarze   29: #include <stdio.h>
1.1       kristaps   30: #include <stdlib.h>
1.67      kristaps   31: #include <string.h>
1.1       kristaps   32:
1.201     schwarze   33: #include "mandoc_aux.h"
1.295     schwarze   34: #include "mandoc_ohash.h"
1.345     schwarze   35: #include "mandoc.h"
1.265     schwarze   36: #include "roff.h"
1.349     schwarze   37: #include "mandoc_parse.h"
1.226     schwarze   38: #include "libmandoc.h"
1.266     schwarze   39: #include "roff_int.h"
1.346     schwarze   40: #include "tbl_parse.h"
1.347     schwarze   41: #include "eqn_parse.h"
1.82      kristaps   42:
1.170     schwarze   43: /* Maximum number of string expansions per line, to break infinite loops. */
                     44: #define        EXPAND_LIMIT    1000
                     45:
1.315     schwarze   46: /* Types of definitions of macros and strings. */
                     47: #define        ROFFDEF_USER    (1 << 1)  /* User-defined. */
                     48: #define        ROFFDEF_PRE     (1 << 2)  /* Predefined. */
                     49: #define        ROFFDEF_REN     (1 << 3)  /* Renamed standard macro. */
                     50: #define        ROFFDEF_STD     (1 << 4)  /* mdoc(7) or man(7) macro. */
                     51: #define        ROFFDEF_ANY     (ROFFDEF_USER | ROFFDEF_PRE | \
                     52:                         ROFFDEF_REN | ROFFDEF_STD)
1.325     schwarze   53: #define        ROFFDEF_UNDEF   (1 << 5)  /* Completely undefined. */
1.315     schwarze   54:
1.266     schwarze   55: /* --- data types --------------------------------------------------------- */
                     56:
1.147     kristaps   57: /*
1.167     kristaps   58:  * An incredibly-simple string buffer.
                     59:  */
1.94      kristaps   60: struct roffstr {
1.167     kristaps   61:        char            *p; /* nil-terminated buffer */
                     62:        size_t           sz; /* saved strlen(p) */
1.166     kristaps   63: };
                     64:
                     65: /*
1.167     kristaps   66:  * A key-value roffstr pair as part of a singly-linked list.
1.166     kristaps   67:  */
                     68: struct roffkv {
                     69:        struct roffstr   key;
                     70:        struct roffstr   val;
                     71:        struct roffkv   *next; /* next in list */
1.94      kristaps   72: };
                     73:
1.180     schwarze   74: /*
                     75:  * A single number register as part of a singly-linked list.
                     76:  */
                     77: struct roffreg {
                     78:        struct roffstr   key;
1.181     schwarze   79:        int              val;
1.327     schwarze   80:        int              step;
1.180     schwarze   81:        struct roffreg  *next;
                     82: };
                     83:
1.295     schwarze   84: /*
                     85:  * Association of request and macro names with token IDs.
                     86:  */
                     87: struct roffreq {
                     88:        enum roff_tok    tok;
                     89:        char             name[];
                     90: };
                     91:
1.339     schwarze   92: /*
                     93:  * A macro processing context.
                     94:  * More than one is needed when macro calls are nested.
                     95:  */
                     96: struct mctx {
                     97:        char            **argv;
                     98:        int              argc;
                     99:        int              argsz;
                    100: };
                    101:
1.67      kristaps  102: struct roff {
1.296     schwarze  103:        struct roff_man *man; /* mdoc or man parser */
1.67      kristaps  104:        struct roffnode *last; /* leaf of stack */
1.339     schwarze  105:        struct mctx     *mstack; /* stack of macro contexts */
1.223     schwarze  106:        int             *rstack; /* stack of inverted `ie' values */
1.295     schwarze  107:        struct ohash    *reqtab; /* request lookup table */
1.180     schwarze  108:        struct roffreg  *regtab; /* number registers */
1.166     kristaps  109:        struct roffkv   *strtab; /* user-defined strings & macros */
1.306     schwarze  110:        struct roffkv   *rentab; /* renamed strings & macros */
1.167     kristaps  111:        struct roffkv   *xmbtab; /* multi-byte trans table (`tr') */
                    112:        struct roffstr  *xtab; /* single-byte trans table (`tr') */
1.106     kristaps  113:        const char      *current_string; /* value of last called user macro */
1.118     kristaps  114:        struct tbl_node *first_tbl; /* first table parsed */
                    115:        struct tbl_node *last_tbl; /* last table parsed */
                    116:        struct tbl_node *tbl; /* current table being parsed */
1.319     schwarze  117:        struct eqn_node *last_eqn; /* equation parser */
                    118:        struct eqn_node *eqn; /* active equation parser */
1.230     schwarze  119:        int              eqn_inline; /* current equation is inline */
1.223     schwarze  120:        int              options; /* parse options */
1.339     schwarze  121:        int              mstacksz; /* current size of mstack */
                    122:        int              mstackpos; /* position in mstack */
1.223     schwarze  123:        int              rstacksz; /* current size limit of rstack */
                    124:        int              rstackpos; /* position in rstack */
1.227     schwarze  125:        int              format; /* current file in mdoc or man format */
1.223     schwarze  126:        char             control; /* control character */
1.303     schwarze  127:        char             escape; /* escape character */
1.79      kristaps  128: };
                    129:
1.364     schwarze  130: /*
                    131:  * A macro definition, condition, or ignored block.
                    132:  */
1.67      kristaps  133: struct roffnode {
1.294     schwarze  134:        enum roff_tok    tok; /* type of node */
1.67      kristaps  135:        struct roffnode *parent; /* up one in stack */
                    136:        int              line; /* parse line */
                    137:        int              col; /* parse col */
1.106     kristaps  138:        char            *name; /* node name, e.g. macro name */
1.364     schwarze  139:        char            *end; /* custom end macro of the block */
                    140:        int              endspan; /* scope to: 1=eol 2=next line -1=\} */
                    141:        int              rule; /* content is: 1=evaluated 0=skipped */
1.67      kristaps  142: };
                    143:
                    144: #define        ROFF_ARGS        struct roff *r, /* parse ctx */ \
1.294     schwarze  145:                         enum roff_tok tok, /* tok of macro */ \
1.238     schwarze  146:                         struct buf *buf, /* input buffer */ \
1.67      kristaps  147:                         int ln, /* parse line */ \
1.75      kristaps  148:                         int ppos, /* original pos in buffer */ \
                    149:                         int pos, /* current pos in buffer */ \
1.74      kristaps  150:                         int *offs /* reset offset of buffer data */
1.67      kristaps  151:
1.340     schwarze  152: typedef        int (*roffproc)(ROFF_ARGS);
1.67      kristaps  153:
                    154: struct roffmac {
1.79      kristaps  155:        roffproc         proc; /* process new macro */
                    156:        roffproc         text; /* process as child text of macro */
                    157:        roffproc         sub; /* process as child of macro */
                    158:        int              flags;
                    159: #define        ROFFMAC_STRUCT  (1 << 0) /* always interpret */
1.67      kristaps  160: };
                    161:
1.141     kristaps  162: struct predef {
                    163:        const char      *name; /* predefined input name */
                    164:        const char      *str; /* replacement symbol */
                    165: };
                    166:
                    167: #define        PREDEF(__name, __str) \
                    168:        { (__name), (__str) },
                    169:
1.266     schwarze  170: /* --- function prototypes ------------------------------------------------ */
                    171:
1.340     schwarze  172: static int              roffnode_cleanscope(struct roff *);
                    173: static int              roffnode_pop(struct roff *);
1.294     schwarze  174: static void             roffnode_push(struct roff *, enum roff_tok,
1.155     kristaps  175:                                const char *, int, int);
1.346     schwarze  176: static void             roff_addtbl(struct roff_man *, int, struct tbl_node *);
1.340     schwarze  177: static int              roff_als(ROFF_ARGS);
                    178: static int              roff_block(ROFF_ARGS);
                    179: static int              roff_block_text(ROFF_ARGS);
                    180: static int              roff_block_sub(ROFF_ARGS);
1.364     schwarze  181: static int              roff_break(ROFF_ARGS);
1.340     schwarze  182: static int              roff_cblock(ROFF_ARGS);
                    183: static int              roff_cc(ROFF_ARGS);
                    184: static int              roff_ccond(struct roff *, int, int);
1.341     schwarze  185: static int              roff_char(ROFF_ARGS);
1.340     schwarze  186: static int              roff_cond(ROFF_ARGS);
1.375     schwarze  187: static int              roff_cond_checkend(ROFF_ARGS);
1.340     schwarze  188: static int              roff_cond_text(ROFF_ARGS);
                    189: static int              roff_cond_sub(ROFF_ARGS);
                    190: static int              roff_ds(ROFF_ARGS);
                    191: static int              roff_ec(ROFF_ARGS);
                    192: static int              roff_eo(ROFF_ARGS);
                    193: static int              roff_eqndelim(struct roff *, struct buf *, int);
1.372     schwarze  194: static int              roff_evalcond(struct roff *, int, char *, int *);
1.234     kristaps  195: static int              roff_evalnum(struct roff *, int,
                    196:                                const char *, int *, int *, int);
                    197: static int              roff_evalpar(struct roff *, int,
1.261     schwarze  198:                                const char *, int *, int *, int);
1.198     schwarze  199: static int              roff_evalstrcond(const char *, int *);
1.355     schwarze  200: static int              roff_expand(struct roff *, struct buf *,
                    201:                                int, int, char);
1.388     schwarze  202: static void             roff_expand_patch(struct buf *, int,
                    203:                                const char *, int);
1.155     kristaps  204: static void             roff_free1(struct roff *);
1.180     schwarze  205: static void             roff_freereg(struct roffreg *);
1.167     kristaps  206: static void             roff_freestr(struct roffkv *);
1.212     schwarze  207: static size_t           roff_getname(struct roff *, char **, int, int);
1.261     schwarze  208: static int              roff_getnum(const char *, int *, int *, int);
1.184     schwarze  209: static int              roff_getop(const char *, int *, char *);
1.327     schwarze  210: static int              roff_getregn(struct roff *,
                    211:                                const char *, size_t, char);
1.273     schwarze  212: static int              roff_getregro(const struct roff *,
                    213:                                const char *name);
1.325     schwarze  214: static const char      *roff_getstrn(struct roff *,
1.315     schwarze  215:                                const char *, size_t, int *);
1.271     schwarze  216: static int              roff_hasregn(const struct roff *,
                    217:                                const char *, size_t);
1.340     schwarze  218: static int              roff_insec(ROFF_ARGS);
                    219: static int              roff_it(ROFF_ARGS);
                    220: static int              roff_line_ignore(ROFF_ARGS);
1.265     schwarze  221: static void             roff_man_alloc1(struct roff_man *);
                    222: static void             roff_man_free1(struct roff_man *);
1.340     schwarze  223: static int              roff_manyarg(ROFF_ARGS);
1.384     schwarze  224: static int              roff_mc(ROFF_ARGS);
1.358     schwarze  225: static int              roff_noarg(ROFF_ARGS);
1.340     schwarze  226: static int              roff_nop(ROFF_ARGS);
                    227: static int              roff_nr(ROFF_ARGS);
                    228: static int              roff_onearg(ROFF_ARGS);
1.294     schwarze  229: static enum roff_tok    roff_parse(struct roff *, char *, int *,
1.214     schwarze  230:                                int, int);
1.387     schwarze  231: static int              roff_parse_comment(struct roff *, struct buf *,
                    232:                                int, int, char);
1.340     schwarze  233: static int              roff_parsetext(struct roff *, struct buf *,
1.305     schwarze  234:                                int, int *);
1.340     schwarze  235: static int              roff_renamed(ROFF_ARGS);
1.386     schwarze  236: static int              roff_req_or_macro(ROFF_ARGS);
1.340     schwarze  237: static int              roff_return(ROFF_ARGS);
                    238: static int              roff_rm(ROFF_ARGS);
                    239: static int              roff_rn(ROFF_ARGS);
                    240: static int              roff_rr(ROFF_ARGS);
1.326     schwarze  241: static void             roff_setregn(struct roff *, const char *,
1.327     schwarze  242:                                size_t, int, char, int);
1.94      kristaps  243: static void             roff_setstr(struct roff *,
1.106     kristaps  244:                                const char *, const char *, int);
1.207     schwarze  245: static void             roff_setstrn(struct roffkv **, const char *,
1.164     kristaps  246:                                size_t, const char *, size_t, int);
1.340     schwarze  247: static int              roff_shift(ROFF_ARGS);
                    248: static int              roff_so(ROFF_ARGS);
                    249: static int              roff_tr(ROFF_ARGS);
                    250: static int              roff_Dd(ROFF_ARGS);
                    251: static int              roff_TE(ROFF_ARGS);
                    252: static int              roff_TS(ROFF_ARGS);
                    253: static int              roff_EQ(ROFF_ARGS);
                    254: static int              roff_EN(ROFF_ARGS);
                    255: static int              roff_T_(ROFF_ARGS);
                    256: static int              roff_unsupp(ROFF_ARGS);
                    257: static int              roff_userdef(ROFF_ARGS);
1.67      kristaps  258:
1.266     schwarze  259: /* --- constant data ------------------------------------------------------ */
                    260:
1.261     schwarze  261: #define        ROFFNUM_SCALE   (1 << 0)  /* Honour scaling in roff_getnum(). */
                    262: #define        ROFFNUM_WHITE   (1 << 1)  /* Skip whitespace in roff_evalnum(). */
                    263:
1.294     schwarze  264: const char *__roff_name[MAN_MAX + 1] = {
1.358     schwarze  265:        "br",           "ce",           "fi",           "ft",
                    266:        "ll",           "mc",           "nf",
                    267:        "po",           "rj",           "sp",
1.312     schwarze  268:        "ta",           "ti",           NULL,
1.294     schwarze  269:        "ab",           "ad",           "af",           "aln",
                    270:        "als",          "am",           "am1",          "ami",
                    271:        "ami1",         "as",           "as1",          "asciify",
                    272:        "backtrace",    "bd",           "bleedat",      "blm",
                    273:         "box",         "boxa",         "bp",           "BP",
                    274:        "break",        "breakchar",    "brnl",         "brp",
1.305     schwarze  275:        "brpnl",        "c2",           "cc",
1.294     schwarze  276:        "cf",           "cflags",       "ch",           "char",
                    277:        "chop",         "class",        "close",        "CL",
                    278:        "color",        "composite",    "continue",     "cp",
                    279:        "cropat",       "cs",           "cu",           "da",
                    280:        "dch",          "Dd",           "de",           "de1",
                    281:        "defcolor",     "dei",          "dei1",         "device",
                    282:        "devicem",      "di",           "do",           "ds",
                    283:        "ds1",          "dwh",          "dt",           "ec",
                    284:        "ecr",          "ecs",          "el",           "em",
                    285:        "EN",           "eo",           "EP",           "EQ",
                    286:        "errprint",     "ev",           "evc",          "ex",
                    287:        "fallback",     "fam",          "fc",           "fchar",
                    288:        "fcolor",       "fdeferlig",    "feature",      "fkern",
                    289:        "fl",           "flig",         "fp",           "fps",
                    290:        "fschar",       "fspacewidth",  "fspecial",     "ftr",
                    291:        "fzoom",        "gcolor",       "hc",           "hcode",
                    292:        "hidechar",     "hla",          "hlm",          "hpf",
                    293:        "hpfa",         "hpfcode",      "hw",           "hy",
                    294:        "hylang",       "hylen",        "hym",          "hypp",
                    295:        "hys",          "ie",           "if",           "ig",
                    296:        "index",        "it",           "itc",          "IX",
                    297:        "kern",         "kernafter",    "kernbefore",   "kernpair",
                    298:        "lc",           "lc_ctype",     "lds",          "length",
                    299:        "letadj",       "lf",           "lg",           "lhang",
                    300:        "linetabs",     "lnr",          "lnrf",         "lpfx",
1.304     schwarze  301:        "ls",           "lsm",          "lt",
1.294     schwarze  302:        "mediasize",    "minss",        "mk",           "mso",
                    303:        "na",           "ne",           "nh",           "nhychar",
                    304:        "nm",           "nn",           "nop",          "nr",
                    305:        "nrf",          "nroff",        "ns",           "nx",
                    306:        "open",         "opena",        "os",           "output",
                    307:        "padj",         "papersize",    "pc",           "pev",
                    308:        "pi",           "PI",           "pl",           "pm",
1.312     schwarze  309:        "pn",           "pnr",          "ps",
1.294     schwarze  310:        "psbb",         "pshape",       "pso",          "ptr",
                    311:        "pvs",          "rchar",        "rd",           "recursionlimit",
1.309     schwarze  312:        "return",       "rfschar",      "rhang",
1.294     schwarze  313:        "rm",           "rn",           "rnn",          "rr",
                    314:        "rs",           "rt",           "schar",        "sentchar",
                    315:        "shc",          "shift",        "sizes",        "so",
                    316:        "spacewidth",   "special",      "spreadwarn",   "ss",
                    317:        "sty",          "substring",    "sv",           "sy",
1.300     schwarze  318:        "T&",           "tc",           "TE",
1.301     schwarze  319:        "TH",           "tkf",          "tl",
1.294     schwarze  320:        "tm",           "tm1",          "tmc",          "tr",
                    321:        "track",        "transchar",    "trf",          "trimat",
                    322:        "trin",         "trnt",         "troff",        "TS",
                    323:        "uf",           "ul",           "unformat",     "unwatch",
                    324:        "unwatchn",     "vpt",          "vs",           "warn",
                    325:        "warnscale",    "watch",        "watchlength",  "watchn",
                    326:        "wh",           "while",        "write",        "writec",
                    327:        "writem",       "xflag",        ".",            NULL,
1.306     schwarze  328:        NULL,           "text",
1.294     schwarze  329:        "Dd",           "Dt",           "Os",           "Sh",
                    330:        "Ss",           "Pp",           "D1",           "Dl",
                    331:        "Bd",           "Ed",           "Bl",           "El",
                    332:        "It",           "Ad",           "An",           "Ap",
                    333:        "Ar",           "Cd",           "Cm",           "Dv",
                    334:        "Er",           "Ev",           "Ex",           "Fa",
                    335:        "Fd",           "Fl",           "Fn",           "Ft",
                    336:        "Ic",           "In",           "Li",           "Nd",
                    337:        "Nm",           "Op",           "Ot",           "Pa",
                    338:        "Rv",           "St",           "Va",           "Vt",
                    339:        "Xr",           "%A",           "%B",           "%D",
                    340:        "%I",           "%J",           "%N",           "%O",
                    341:        "%P",           "%R",           "%T",           "%V",
                    342:        "Ac",           "Ao",           "Aq",           "At",
                    343:        "Bc",           "Bf",           "Bo",           "Bq",
                    344:        "Bsx",          "Bx",           "Db",           "Dc",
                    345:        "Do",           "Dq",           "Ec",           "Ef",
                    346:        "Em",           "Eo",           "Fx",           "Ms",
                    347:        "No",           "Ns",           "Nx",           "Ox",
                    348:        "Pc",           "Pf",           "Po",           "Pq",
                    349:        "Qc",           "Ql",           "Qo",           "Qq",
                    350:        "Re",           "Rs",           "Sc",           "So",
                    351:        "Sq",           "Sm",           "Sx",           "Sy",
                    352:        "Tn",           "Ux",           "Xc",           "Xo",
                    353:        "Fo",           "Fc",           "Oo",           "Oc",
                    354:        "Bk",           "Ek",           "Bt",           "Hf",
                    355:        "Fr",           "Ud",           "Lb",           "Lp",
                    356:        "Lk",           "Mt",           "Brq",          "Bro",
                    357:        "Brc",          "%C",           "Es",           "En",
1.299     schwarze  358:        "Dx",           "%Q",           "%U",           "Ta",
1.369     schwarze  359:        "Tg",           NULL,
1.294     schwarze  360:        "TH",           "SH",           "SS",           "TP",
1.332     schwarze  361:        "TQ",
1.294     schwarze  362:        "LP",           "PP",           "P",            "IP",
                    363:        "HP",           "SM",           "SB",           "BI",
                    364:        "IB",           "BR",           "RB",           "R",
                    365:        "B",            "I",            "IR",           "RI",
                    366:        "RE",           "RS",           "DT",           "UC",
1.297     schwarze  367:        "PD",           "AT",           "in",
1.333     schwarze  368:        "SY",           "YS",           "OP",
                    369:        "EX",           "EE",           "UR",
1.317     schwarze  370:        "UE",           "MT",           "ME",           NULL
1.294     schwarze  371: };
                    372: const  char *const *roff_name = __roff_name;
                    373:
                    374: static struct roffmac   roffs[TOKEN_NONE] = {
1.358     schwarze  375:        { roff_noarg, NULL, NULL, 0 },  /* br */
1.305     schwarze  376:        { roff_onearg, NULL, NULL, 0 },  /* ce */
1.358     schwarze  377:        { roff_noarg, NULL, NULL, 0 },  /* fi */
1.297     schwarze  378:        { roff_onearg, NULL, NULL, 0 },  /* ft */
1.298     schwarze  379:        { roff_onearg, NULL, NULL, 0 },  /* ll */
1.384     schwarze  380:        { roff_mc, NULL, NULL, 0 },  /* mc */
1.358     schwarze  381:        { roff_noarg, NULL, NULL, 0 },  /* nf */
1.312     schwarze  382:        { roff_onearg, NULL, NULL, 0 },  /* po */
1.309     schwarze  383:        { roff_onearg, NULL, NULL, 0 },  /* rj */
1.299     schwarze  384:        { roff_onearg, NULL, NULL, 0 },  /* sp */
1.300     schwarze  385:        { roff_manyarg, NULL, NULL, 0 },  /* ta */
1.301     schwarze  386:        { roff_onearg, NULL, NULL, 0 },  /* ti */
1.296     schwarze  387:        { NULL, NULL, NULL, 0 },  /* ROFF_MAX */
1.295     schwarze  388:        { roff_unsupp, NULL, NULL, 0 },  /* ab */
                    389:        { roff_line_ignore, NULL, NULL, 0 },  /* ad */
                    390:        { roff_line_ignore, NULL, NULL, 0 },  /* af */
                    391:        { roff_unsupp, NULL, NULL, 0 },  /* aln */
1.311     schwarze  392:        { roff_als, NULL, NULL, 0 },  /* als */
1.295     schwarze  393:        { roff_block, roff_block_text, roff_block_sub, 0 },  /* am */
                    394:        { roff_block, roff_block_text, roff_block_sub, 0 },  /* am1 */
                    395:        { roff_block, roff_block_text, roff_block_sub, 0 },  /* ami */
                    396:        { roff_block, roff_block_text, roff_block_sub, 0 },  /* ami1 */
                    397:        { roff_ds, NULL, NULL, 0 },  /* as */
                    398:        { roff_ds, NULL, NULL, 0 },  /* as1 */
                    399:        { roff_unsupp, NULL, NULL, 0 },  /* asciify */
                    400:        { roff_line_ignore, NULL, NULL, 0 },  /* backtrace */
                    401:        { roff_line_ignore, NULL, NULL, 0 },  /* bd */
                    402:        { roff_line_ignore, NULL, NULL, 0 },  /* bleedat */
                    403:        { roff_unsupp, NULL, NULL, 0 },  /* blm */
                    404:        { roff_unsupp, NULL, NULL, 0 },  /* box */
                    405:        { roff_unsupp, NULL, NULL, 0 },  /* boxa */
                    406:        { roff_line_ignore, NULL, NULL, 0 },  /* bp */
                    407:        { roff_unsupp, NULL, NULL, 0 },  /* BP */
1.364     schwarze  408:        { roff_break, NULL, NULL, 0 },  /* break */
1.295     schwarze  409:        { roff_line_ignore, NULL, NULL, 0 },  /* breakchar */
                    410:        { roff_line_ignore, NULL, NULL, 0 },  /* brnl */
1.358     schwarze  411:        { roff_noarg, NULL, NULL, 0 },  /* brp */
1.295     schwarze  412:        { roff_line_ignore, NULL, NULL, 0 },  /* brpnl */
                    413:        { roff_unsupp, NULL, NULL, 0 },  /* c2 */
                    414:        { roff_cc, NULL, NULL, 0 },  /* cc */
                    415:        { roff_insec, NULL, NULL, 0 },  /* cf */
                    416:        { roff_line_ignore, NULL, NULL, 0 },  /* cflags */
                    417:        { roff_line_ignore, NULL, NULL, 0 },  /* ch */
1.341     schwarze  418:        { roff_char, NULL, NULL, 0 },  /* char */
1.295     schwarze  419:        { roff_unsupp, NULL, NULL, 0 },  /* chop */
                    420:        { roff_line_ignore, NULL, NULL, 0 },  /* class */
                    421:        { roff_insec, NULL, NULL, 0 },  /* close */
                    422:        { roff_unsupp, NULL, NULL, 0 },  /* CL */
                    423:        { roff_line_ignore, NULL, NULL, 0 },  /* color */
                    424:        { roff_unsupp, NULL, NULL, 0 },  /* composite */
                    425:        { roff_unsupp, NULL, NULL, 0 },  /* continue */
                    426:        { roff_line_ignore, NULL, NULL, 0 },  /* cp */
                    427:        { roff_line_ignore, NULL, NULL, 0 },  /* cropat */
                    428:        { roff_line_ignore, NULL, NULL, 0 },  /* cs */
                    429:        { roff_line_ignore, NULL, NULL, 0 },  /* cu */
                    430:        { roff_unsupp, NULL, NULL, 0 },  /* da */
                    431:        { roff_unsupp, NULL, NULL, 0 },  /* dch */
                    432:        { roff_Dd, NULL, NULL, 0 },  /* Dd */
                    433:        { roff_block, roff_block_text, roff_block_sub, 0 },  /* de */
                    434:        { roff_block, roff_block_text, roff_block_sub, 0 },  /* de1 */
                    435:        { roff_line_ignore, NULL, NULL, 0 },  /* defcolor */
                    436:        { roff_block, roff_block_text, roff_block_sub, 0 },  /* dei */
                    437:        { roff_block, roff_block_text, roff_block_sub, 0 },  /* dei1 */
                    438:        { roff_unsupp, NULL, NULL, 0 },  /* device */
                    439:        { roff_unsupp, NULL, NULL, 0 },  /* devicem */
                    440:        { roff_unsupp, NULL, NULL, 0 },  /* di */
                    441:        { roff_unsupp, NULL, NULL, 0 },  /* do */
                    442:        { roff_ds, NULL, NULL, 0 },  /* ds */
                    443:        { roff_ds, NULL, NULL, 0 },  /* ds1 */
                    444:        { roff_unsupp, NULL, NULL, 0 },  /* dwh */
                    445:        { roff_unsupp, NULL, NULL, 0 },  /* dt */
1.303     schwarze  446:        { roff_ec, NULL, NULL, 0 },  /* ec */
1.295     schwarze  447:        { roff_unsupp, NULL, NULL, 0 },  /* ecr */
                    448:        { roff_unsupp, NULL, NULL, 0 },  /* ecs */
                    449:        { roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT },  /* el */
                    450:        { roff_unsupp, NULL, NULL, 0 },  /* em */
                    451:        { roff_EN, NULL, NULL, 0 },  /* EN */
1.303     schwarze  452:        { roff_eo, NULL, NULL, 0 },  /* eo */
1.295     schwarze  453:        { roff_unsupp, NULL, NULL, 0 },  /* EP */
                    454:        { roff_EQ, NULL, NULL, 0 },  /* EQ */
                    455:        { roff_line_ignore, NULL, NULL, 0 },  /* errprint */
                    456:        { roff_unsupp, NULL, NULL, 0 },  /* ev */
                    457:        { roff_unsupp, NULL, NULL, 0 },  /* evc */
                    458:        { roff_unsupp, NULL, NULL, 0 },  /* ex */
                    459:        { roff_line_ignore, NULL, NULL, 0 },  /* fallback */
                    460:        { roff_line_ignore, NULL, NULL, 0 },  /* fam */
                    461:        { roff_unsupp, NULL, NULL, 0 },  /* fc */
                    462:        { roff_unsupp, NULL, NULL, 0 },  /* fchar */
                    463:        { roff_line_ignore, NULL, NULL, 0 },  /* fcolor */
                    464:        { roff_line_ignore, NULL, NULL, 0 },  /* fdeferlig */
                    465:        { roff_line_ignore, NULL, NULL, 0 },  /* feature */
                    466:        { roff_line_ignore, NULL, NULL, 0 },  /* fkern */
                    467:        { roff_line_ignore, NULL, NULL, 0 },  /* fl */
                    468:        { roff_line_ignore, NULL, NULL, 0 },  /* flig */
                    469:        { roff_line_ignore, NULL, NULL, 0 },  /* fp */
                    470:        { roff_line_ignore, NULL, NULL, 0 },  /* fps */
                    471:        { roff_unsupp, NULL, NULL, 0 },  /* fschar */
                    472:        { roff_line_ignore, NULL, NULL, 0 },  /* fspacewidth */
                    473:        { roff_line_ignore, NULL, NULL, 0 },  /* fspecial */
                    474:        { roff_line_ignore, NULL, NULL, 0 },  /* ftr */
                    475:        { roff_line_ignore, NULL, NULL, 0 },  /* fzoom */
                    476:        { roff_line_ignore, NULL, NULL, 0 },  /* gcolor */
                    477:        { roff_line_ignore, NULL, NULL, 0 },  /* hc */
                    478:        { roff_line_ignore, NULL, NULL, 0 },  /* hcode */
                    479:        { roff_line_ignore, NULL, NULL, 0 },  /* hidechar */
                    480:        { roff_line_ignore, NULL, NULL, 0 },  /* hla */
                    481:        { roff_line_ignore, NULL, NULL, 0 },  /* hlm */
                    482:        { roff_line_ignore, NULL, NULL, 0 },  /* hpf */
                    483:        { roff_line_ignore, NULL, NULL, 0 },  /* hpfa */
                    484:        { roff_line_ignore, NULL, NULL, 0 },  /* hpfcode */
                    485:        { roff_line_ignore, NULL, NULL, 0 },  /* hw */
                    486:        { roff_line_ignore, NULL, NULL, 0 },  /* hy */
                    487:        { roff_line_ignore, NULL, NULL, 0 },  /* hylang */
                    488:        { roff_line_ignore, NULL, NULL, 0 },  /* hylen */
                    489:        { roff_line_ignore, NULL, NULL, 0 },  /* hym */
                    490:        { roff_line_ignore, NULL, NULL, 0 },  /* hypp */
                    491:        { roff_line_ignore, NULL, NULL, 0 },  /* hys */
                    492:        { roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT },  /* ie */
                    493:        { roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT },  /* if */
                    494:        { roff_block, roff_block_text, roff_block_sub, 0 },  /* ig */
                    495:        { roff_unsupp, NULL, NULL, 0 },  /* index */
                    496:        { roff_it, NULL, NULL, 0 },  /* it */
                    497:        { roff_unsupp, NULL, NULL, 0 },  /* itc */
                    498:        { roff_line_ignore, NULL, NULL, 0 },  /* IX */
                    499:        { roff_line_ignore, NULL, NULL, 0 },  /* kern */
                    500:        { roff_line_ignore, NULL, NULL, 0 },  /* kernafter */
                    501:        { roff_line_ignore, NULL, NULL, 0 },  /* kernbefore */
                    502:        { roff_line_ignore, NULL, NULL, 0 },  /* kernpair */
                    503:        { roff_unsupp, NULL, NULL, 0 },  /* lc */
                    504:        { roff_unsupp, NULL, NULL, 0 },  /* lc_ctype */
                    505:        { roff_unsupp, NULL, NULL, 0 },  /* lds */
                    506:        { roff_unsupp, NULL, NULL, 0 },  /* length */
                    507:        { roff_line_ignore, NULL, NULL, 0 },  /* letadj */
                    508:        { roff_insec, NULL, NULL, 0 },  /* lf */
                    509:        { roff_line_ignore, NULL, NULL, 0 },  /* lg */
                    510:        { roff_line_ignore, NULL, NULL, 0 },  /* lhang */
                    511:        { roff_unsupp, NULL, NULL, 0 },  /* linetabs */
                    512:        { roff_unsupp, NULL, NULL, 0 },  /* lnr */
                    513:        { roff_unsupp, NULL, NULL, 0 },  /* lnrf */
                    514:        { roff_unsupp, NULL, NULL, 0 },  /* lpfx */
                    515:        { roff_line_ignore, NULL, NULL, 0 },  /* ls */
                    516:        { roff_unsupp, NULL, NULL, 0 },  /* lsm */
                    517:        { roff_line_ignore, NULL, NULL, 0 },  /* lt */
                    518:        { roff_line_ignore, NULL, NULL, 0 },  /* mediasize */
                    519:        { roff_line_ignore, NULL, NULL, 0 },  /* minss */
                    520:        { roff_line_ignore, NULL, NULL, 0 },  /* mk */
                    521:        { roff_insec, NULL, NULL, 0 },  /* mso */
                    522:        { roff_line_ignore, NULL, NULL, 0 },  /* na */
                    523:        { roff_line_ignore, NULL, NULL, 0 },  /* ne */
                    524:        { roff_line_ignore, NULL, NULL, 0 },  /* nh */
                    525:        { roff_line_ignore, NULL, NULL, 0 },  /* nhychar */
                    526:        { roff_unsupp, NULL, NULL, 0 },  /* nm */
                    527:        { roff_unsupp, NULL, NULL, 0 },  /* nn */
1.330     schwarze  528:        { roff_nop, NULL, NULL, 0 },  /* nop */
1.295     schwarze  529:        { roff_nr, NULL, NULL, 0 },  /* nr */
                    530:        { roff_unsupp, NULL, NULL, 0 },  /* nrf */
                    531:        { roff_line_ignore, NULL, NULL, 0 },  /* nroff */
                    532:        { roff_line_ignore, NULL, NULL, 0 },  /* ns */
                    533:        { roff_insec, NULL, NULL, 0 },  /* nx */
                    534:        { roff_insec, NULL, NULL, 0 },  /* open */
                    535:        { roff_insec, NULL, NULL, 0 },  /* opena */
                    536:        { roff_line_ignore, NULL, NULL, 0 },  /* os */
                    537:        { roff_unsupp, NULL, NULL, 0 },  /* output */
                    538:        { roff_line_ignore, NULL, NULL, 0 },  /* padj */
                    539:        { roff_line_ignore, NULL, NULL, 0 },  /* papersize */
                    540:        { roff_line_ignore, NULL, NULL, 0 },  /* pc */
                    541:        { roff_line_ignore, NULL, NULL, 0 },  /* pev */
                    542:        { roff_insec, NULL, NULL, 0 },  /* pi */
                    543:        { roff_unsupp, NULL, NULL, 0 },  /* PI */
                    544:        { roff_line_ignore, NULL, NULL, 0 },  /* pl */
                    545:        { roff_line_ignore, NULL, NULL, 0 },  /* pm */
                    546:        { roff_line_ignore, NULL, NULL, 0 },  /* pn */
                    547:        { roff_line_ignore, NULL, NULL, 0 },  /* pnr */
                    548:        { roff_line_ignore, NULL, NULL, 0 },  /* ps */
                    549:        { roff_unsupp, NULL, NULL, 0 },  /* psbb */
                    550:        { roff_unsupp, NULL, NULL, 0 },  /* pshape */
                    551:        { roff_insec, NULL, NULL, 0 },  /* pso */
                    552:        { roff_line_ignore, NULL, NULL, 0 },  /* ptr */
                    553:        { roff_line_ignore, NULL, NULL, 0 },  /* pvs */
                    554:        { roff_unsupp, NULL, NULL, 0 },  /* rchar */
                    555:        { roff_line_ignore, NULL, NULL, 0 },  /* rd */
                    556:        { roff_line_ignore, NULL, NULL, 0 },  /* recursionlimit */
1.339     schwarze  557:        { roff_return, NULL, NULL, 0 },  /* return */
1.295     schwarze  558:        { roff_unsupp, NULL, NULL, 0 },  /* rfschar */
                    559:        { roff_line_ignore, NULL, NULL, 0 },  /* rhang */
                    560:        { roff_rm, NULL, NULL, 0 },  /* rm */
1.306     schwarze  561:        { roff_rn, NULL, NULL, 0 },  /* rn */
1.295     schwarze  562:        { roff_unsupp, NULL, NULL, 0 },  /* rnn */
                    563:        { roff_rr, NULL, NULL, 0 },  /* rr */
                    564:        { roff_line_ignore, NULL, NULL, 0 },  /* rs */
                    565:        { roff_line_ignore, NULL, NULL, 0 },  /* rt */
                    566:        { roff_unsupp, NULL, NULL, 0 },  /* schar */
                    567:        { roff_line_ignore, NULL, NULL, 0 },  /* sentchar */
                    568:        { roff_line_ignore, NULL, NULL, 0 },  /* shc */
1.339     schwarze  569:        { roff_shift, NULL, NULL, 0 },  /* shift */
1.295     schwarze  570:        { roff_line_ignore, NULL, NULL, 0 },  /* sizes */
                    571:        { roff_so, NULL, NULL, 0 },  /* so */
                    572:        { roff_line_ignore, NULL, NULL, 0 },  /* spacewidth */
                    573:        { roff_line_ignore, NULL, NULL, 0 },  /* special */
                    574:        { roff_line_ignore, NULL, NULL, 0 },  /* spreadwarn */
                    575:        { roff_line_ignore, NULL, NULL, 0 },  /* ss */
                    576:        { roff_line_ignore, NULL, NULL, 0 },  /* sty */
                    577:        { roff_unsupp, NULL, NULL, 0 },  /* substring */
                    578:        { roff_line_ignore, NULL, NULL, 0 },  /* sv */
                    579:        { roff_insec, NULL, NULL, 0 },  /* sy */
                    580:        { roff_T_, NULL, NULL, 0 },  /* T& */
                    581:        { roff_unsupp, NULL, NULL, 0 },  /* tc */
                    582:        { roff_TE, NULL, NULL, 0 },  /* TE */
1.315     schwarze  583:        { roff_Dd, NULL, NULL, 0 },  /* TH */
1.295     schwarze  584:        { roff_line_ignore, NULL, NULL, 0 },  /* tkf */
                    585:        { roff_unsupp, NULL, NULL, 0 },  /* tl */
                    586:        { roff_line_ignore, NULL, NULL, 0 },  /* tm */
                    587:        { roff_line_ignore, NULL, NULL, 0 },  /* tm1 */
                    588:        { roff_line_ignore, NULL, NULL, 0 },  /* tmc */
                    589:        { roff_tr, NULL, NULL, 0 },  /* tr */
                    590:        { roff_line_ignore, NULL, NULL, 0 },  /* track */
                    591:        { roff_line_ignore, NULL, NULL, 0 },  /* transchar */
                    592:        { roff_insec, NULL, NULL, 0 },  /* trf */
                    593:        { roff_line_ignore, NULL, NULL, 0 },  /* trimat */
                    594:        { roff_unsupp, NULL, NULL, 0 },  /* trin */
                    595:        { roff_unsupp, NULL, NULL, 0 },  /* trnt */
                    596:        { roff_line_ignore, NULL, NULL, 0 },  /* troff */
                    597:        { roff_TS, NULL, NULL, 0 },  /* TS */
                    598:        { roff_line_ignore, NULL, NULL, 0 },  /* uf */
                    599:        { roff_line_ignore, NULL, NULL, 0 },  /* ul */
                    600:        { roff_unsupp, NULL, NULL, 0 },  /* unformat */
                    601:        { roff_line_ignore, NULL, NULL, 0 },  /* unwatch */
                    602:        { roff_line_ignore, NULL, NULL, 0 },  /* unwatchn */
                    603:        { roff_line_ignore, NULL, NULL, 0 },  /* vpt */
                    604:        { roff_line_ignore, NULL, NULL, 0 },  /* vs */
                    605:        { roff_line_ignore, NULL, NULL, 0 },  /* warn */
                    606:        { roff_line_ignore, NULL, NULL, 0 },  /* warnscale */
                    607:        { roff_line_ignore, NULL, NULL, 0 },  /* watch */
                    608:        { roff_line_ignore, NULL, NULL, 0 },  /* watchlength */
                    609:        { roff_line_ignore, NULL, NULL, 0 },  /* watchn */
                    610:        { roff_unsupp, NULL, NULL, 0 },  /* wh */
1.340     schwarze  611:        { roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT }, /*while*/
1.295     schwarze  612:        { roff_insec, NULL, NULL, 0 },  /* write */
                    613:        { roff_insec, NULL, NULL, 0 },  /* writec */
                    614:        { roff_insec, NULL, NULL, 0 },  /* writem */
                    615:        { roff_line_ignore, NULL, NULL, 0 },  /* xflag */
                    616:        { roff_cblock, NULL, NULL, 0 },  /* . */
1.306     schwarze  617:        { roff_renamed, NULL, NULL, 0 },
1.295     schwarze  618:        { roff_userdef, NULL, NULL, 0 }
1.67      kristaps  619: };
                    620:
1.141     kristaps  621: /* Array of injected predefined strings. */
                    622: #define        PREDEFS_MAX      38
                    623: static const struct predef predefs[PREDEFS_MAX] = {
                    624: #include "predefs.in"
                    625: };
                    626:
1.305     schwarze  627: static int      roffce_lines;  /* number of input lines to center */
                    628: static struct roff_node *roffce_node;  /* active request */
1.178     schwarze  629: static int      roffit_lines;  /* number of lines to delay */
                    630: static char    *roffit_macro;  /* nil-terminated macro line */
                    631:
1.207     schwarze  632:
1.266     schwarze  633: /* --- request table ------------------------------------------------------ */
                    634:
1.295     schwarze  635: struct ohash *
                    636: roffhash_alloc(enum roff_tok mintok, enum roff_tok maxtok)
1.85      kristaps  637: {
1.295     schwarze  638:        struct ohash    *htab;
                    639:        struct roffreq  *req;
                    640:        enum roff_tok    tok;
                    641:        size_t           sz;
                    642:        unsigned int     slot;
1.85      kristaps  643:
1.295     schwarze  644:        htab = mandoc_malloc(sizeof(*htab));
                    645:        mandoc_ohash_init(htab, 8, offsetof(struct roffreq, name));
1.85      kristaps  646:
1.295     schwarze  647:        for (tok = mintok; tok < maxtok; tok++) {
1.296     schwarze  648:                if (roff_name[tok] == NULL)
                    649:                        continue;
1.295     schwarze  650:                sz = strlen(roff_name[tok]);
                    651:                req = mandoc_malloc(sizeof(*req) + sz + 1);
                    652:                req->tok = tok;
                    653:                memcpy(req->name, roff_name[tok], sz + 1);
                    654:                slot = ohash_qlookup(htab, req->name);
                    655:                ohash_insert(htab, slot, req);
1.85      kristaps  656:        }
1.295     schwarze  657:        return htab;
1.85      kristaps  658: }
                    659:
1.295     schwarze  660: void
                    661: roffhash_free(struct ohash *htab)
1.67      kristaps  662: {
1.295     schwarze  663:        struct roffreq  *req;
                    664:        unsigned int     slot;
1.67      kristaps  665:
1.295     schwarze  666:        if (htab == NULL)
                    667:                return;
                    668:        for (req = ohash_first(htab, &slot); req != NULL;
                    669:             req = ohash_next(htab, &slot))
                    670:                free(req);
                    671:        ohash_delete(htab);
                    672:        free(htab);
                    673: }
                    674:
                    675: enum roff_tok
                    676: roffhash_find(struct ohash *htab, const char *name, size_t sz)
                    677: {
                    678:        struct roffreq  *req;
                    679:        const char      *end;
                    680:
                    681:        if (sz) {
                    682:                end = name + sz;
                    683:                req = ohash_find(htab, ohash_qlookupi(htab, name, &end));
                    684:        } else
                    685:                req = ohash_find(htab, ohash_qlookup(htab, name));
                    686:        return req == NULL ? TOKEN_NONE : req->tok;
1.67      kristaps  687: }
                    688:
1.266     schwarze  689: /* --- stack of request blocks -------------------------------------------- */
                    690:
1.67      kristaps  691: /*
                    692:  * Pop the current node off of the stack of roff instructions currently
1.364     schwarze  693:  * pending.  Return 1 if it is a loop or 0 otherwise.
1.67      kristaps  694:  */
1.340     schwarze  695: static int
1.67      kristaps  696: roffnode_pop(struct roff *r)
                    697: {
                    698:        struct roffnode *p;
1.340     schwarze  699:        int              inloop;
1.67      kristaps  700:
1.207     schwarze  701:        p = r->last;
1.340     schwarze  702:        inloop = p->tok == ROFF_while;
                    703:        r->last = p->parent;
1.106     kristaps  704:        free(p->name);
                    705:        free(p->end);
1.67      kristaps  706:        free(p);
1.340     schwarze  707:        return inloop;
1.67      kristaps  708: }
                    709:
                    710: /*
                    711:  * Push a roff node onto the instruction stack.  This must later be
                    712:  * removed with roffnode_pop().
                    713:  */
1.98      schwarze  714: static void
1.294     schwarze  715: roffnode_push(struct roff *r, enum roff_tok tok, const char *name,
1.106     kristaps  716:                int line, int col)
1.67      kristaps  717: {
                    718:        struct roffnode *p;
                    719:
1.98      schwarze  720:        p = mandoc_calloc(1, sizeof(struct roffnode));
1.67      kristaps  721:        p->tok = tok;
1.106     kristaps  722:        if (name)
                    723:                p->name = mandoc_strdup(name);
1.67      kristaps  724:        p->parent = r->last;
                    725:        p->line = line;
                    726:        p->col = col;
1.198     schwarze  727:        p->rule = p->parent ? p->parent->rule : 0;
1.67      kristaps  728:
                    729:        r->last = p;
                    730: }
                    731:
1.266     schwarze  732: /* --- roff parser state data management ---------------------------------- */
                    733:
1.67      kristaps  734: static void
                    735: roff_free1(struct roff *r)
                    736: {
1.167     kristaps  737:        int              i;
1.67      kristaps  738:
1.346     schwarze  739:        tbl_free(r->first_tbl);
1.113     kristaps  740:        r->first_tbl = r->last_tbl = r->tbl = NULL;
                    741:
1.347     schwarze  742:        eqn_free(r->last_eqn);
1.319     schwarze  743:        r->last_eqn = r->eqn = NULL;
1.125     kristaps  744:
1.339     schwarze  745:        while (r->mstackpos >= 0)
                    746:                roff_userret(r);
                    747:
1.67      kristaps  748:        while (r->last)
                    749:                roffnode_pop(r);
1.109     kristaps  750:
1.223     schwarze  751:        free (r->rstack);
                    752:        r->rstack = NULL;
                    753:        r->rstacksz = 0;
                    754:        r->rstackpos = -1;
                    755:
                    756:        roff_freereg(r->regtab);
                    757:        r->regtab = NULL;
                    758:
1.167     kristaps  759:        roff_freestr(r->strtab);
1.306     schwarze  760:        roff_freestr(r->rentab);
1.167     kristaps  761:        roff_freestr(r->xmbtab);
1.306     schwarze  762:        r->strtab = r->rentab = r->xmbtab = NULL;
1.167     kristaps  763:
                    764:        if (r->xtab)
                    765:                for (i = 0; i < 128; i++)
                    766:                        free(r->xtab[i].p);
                    767:        free(r->xtab);
                    768:        r->xtab = NULL;
1.67      kristaps  769: }
                    770:
                    771: void
                    772: roff_reset(struct roff *r)
                    773: {
                    774:        roff_free1(r);
1.367     schwarze  775:        r->options |= MPARSE_COMMENT;
1.227     schwarze  776:        r->format = r->options & (MPARSE_MDOC | MPARSE_MAN);
1.303     schwarze  777:        r->control = '\0';
                    778:        r->escape = '\\';
1.307     schwarze  779:        roffce_lines = 0;
                    780:        roffce_node = NULL;
                    781:        roffit_lines = 0;
                    782:        roffit_macro = NULL;
1.67      kristaps  783: }
                    784:
                    785: void
                    786: roff_free(struct roff *r)
                    787: {
1.366     schwarze  788:        int              i;
1.339     schwarze  789:
1.67      kristaps  790:        roff_free1(r);
1.339     schwarze  791:        for (i = 0; i < r->mstacksz; i++)
                    792:                free(r->mstack[i].argv);
                    793:        free(r->mstack);
1.295     schwarze  794:        roffhash_free(r->reqtab);
1.67      kristaps  795:        free(r);
                    796: }
                    797:
                    798: struct roff *
1.351     schwarze  799: roff_alloc(int options)
1.67      kristaps  800: {
                    801:        struct roff     *r;
                    802:
1.98      schwarze  803:        r = mandoc_calloc(1, sizeof(struct roff));
1.328     schwarze  804:        r->reqtab = roffhash_alloc(0, ROFF_RENAMED);
1.367     schwarze  805:        r->options = options | MPARSE_COMMENT;
1.227     schwarze  806:        r->format = options & (MPARSE_MDOC | MPARSE_MAN);
1.339     schwarze  807:        r->mstackpos = -1;
1.82      kristaps  808:        r->rstackpos = -1;
1.303     schwarze  809:        r->escape = '\\';
1.277     schwarze  810:        return r;
1.265     schwarze  811: }
                    812:
1.266     schwarze  813: /* --- syntax tree state data management ---------------------------------- */
                    814:
1.265     schwarze  815: static void
                    816: roff_man_free1(struct roff_man *man)
                    817: {
1.356     schwarze  818:        if (man->meta.first != NULL)
                    819:                roff_node_delete(man, man->meta.first);
1.265     schwarze  820:        free(man->meta.msec);
                    821:        free(man->meta.vol);
                    822:        free(man->meta.os);
                    823:        free(man->meta.arch);
                    824:        free(man->meta.title);
                    825:        free(man->meta.name);
                    826:        free(man->meta.date);
1.356     schwarze  827:        free(man->meta.sodest);
1.265     schwarze  828: }
                    829:
1.357     schwarze  830: void
                    831: roff_state_reset(struct roff_man *man)
                    832: {
                    833:        man->last = man->meta.first;
                    834:        man->last_es = NULL;
                    835:        man->flags = 0;
                    836:        man->lastsec = man->lastnamed = SEC_NONE;
                    837:        man->next = ROFF_NEXT_CHILD;
                    838:        roff_setreg(man->roff, "nS", 0, '=');
                    839: }
                    840:
1.265     schwarze  841: static void
                    842: roff_man_alloc1(struct roff_man *man)
                    843: {
                    844:        memset(&man->meta, 0, sizeof(man->meta));
1.356     schwarze  845:        man->meta.first = mandoc_calloc(1, sizeof(*man->meta.first));
                    846:        man->meta.first->type = ROFFT_ROOT;
                    847:        man->meta.macroset = MACROSET_NONE;
1.357     schwarze  848:        roff_state_reset(man);
1.265     schwarze  849: }
                    850:
                    851: void
                    852: roff_man_reset(struct roff_man *man)
                    853: {
                    854:        roff_man_free1(man);
                    855:        roff_man_alloc1(man);
                    856: }
                    857:
                    858: void
                    859: roff_man_free(struct roff_man *man)
                    860: {
                    861:        roff_man_free1(man);
1.380     schwarze  862:        free(man->os_r);
1.265     schwarze  863:        free(man);
                    864: }
                    865:
                    866: struct roff_man *
1.351     schwarze  867: roff_man_alloc(struct roff *roff, const char *os_s, int quick)
1.265     schwarze  868: {
                    869:        struct roff_man *man;
                    870:
                    871:        man = mandoc_calloc(1, sizeof(*man));
                    872:        man->roff = roff;
1.316     schwarze  873:        man->os_s = os_s;
1.265     schwarze  874:        man->quick = quick;
                    875:        roff_man_alloc1(man);
1.296     schwarze  876:        roff->man = man;
1.277     schwarze  877:        return man;
1.67      kristaps  878: }
                    879:
1.266     schwarze  880: /* --- syntax tree handling ----------------------------------------------- */
                    881:
                    882: struct roff_node *
                    883: roff_node_alloc(struct roff_man *man, int line, int pos,
                    884:        enum roff_type type, int tok)
                    885: {
                    886:        struct roff_node        *n;
                    887:
                    888:        n = mandoc_calloc(1, sizeof(*n));
                    889:        n->line = line;
                    890:        n->pos = pos;
                    891:        n->tok = tok;
                    892:        n->type = type;
                    893:        n->sec = man->lastsec;
                    894:
                    895:        if (man->flags & MDOC_SYNOPSIS)
1.285     schwarze  896:                n->flags |= NODE_SYNPRETTY;
1.266     schwarze  897:        else
1.285     schwarze  898:                n->flags &= ~NODE_SYNPRETTY;
1.360     schwarze  899:        if ((man->flags & (ROFF_NOFILL | ROFF_NONOFILL)) == ROFF_NOFILL)
1.359     schwarze  900:                n->flags |= NODE_NOFILL;
                    901:        else
                    902:                n->flags &= ~NODE_NOFILL;
1.266     schwarze  903:        if (man->flags & MDOC_NEWLINE)
1.285     schwarze  904:                n->flags |= NODE_LINE;
1.266     schwarze  905:        man->flags &= ~MDOC_NEWLINE;
                    906:
1.277     schwarze  907:        return n;
1.266     schwarze  908: }
                    909:
                    910: void
                    911: roff_node_append(struct roff_man *man, struct roff_node *n)
                    912: {
                    913:
                    914:        switch (man->next) {
                    915:        case ROFF_NEXT_SIBLING:
1.281     schwarze  916:                if (man->last->next != NULL) {
                    917:                        n->next = man->last->next;
                    918:                        man->last->next->prev = n;
                    919:                } else
                    920:                        man->last->parent->last = n;
1.266     schwarze  921:                man->last->next = n;
                    922:                n->prev = man->last;
                    923:                n->parent = man->last->parent;
                    924:                break;
                    925:        case ROFF_NEXT_CHILD:
1.287     schwarze  926:                if (man->last->child != NULL) {
                    927:                        n->next = man->last->child;
                    928:                        man->last->child->prev = n;
                    929:                } else
                    930:                        man->last->last = n;
1.266     schwarze  931:                man->last->child = n;
                    932:                n->parent = man->last;
                    933:                break;
                    934:        default:
                    935:                abort();
                    936:        }
1.282     schwarze  937:        man->last = n;
1.266     schwarze  938:
                    939:        switch (n->type) {
                    940:        case ROFFT_HEAD:
                    941:                n->parent->head = n;
                    942:                break;
                    943:        case ROFFT_BODY:
1.282     schwarze  944:                if (n->end != ENDBODY_NOT)
                    945:                        return;
1.266     schwarze  946:                n->parent->body = n;
                    947:                break;
                    948:        case ROFFT_TAIL:
                    949:                n->parent->tail = n;
                    950:                break;
                    951:        default:
1.282     schwarze  952:                return;
1.266     schwarze  953:        }
1.282     schwarze  954:
                    955:        /*
                    956:         * Copy over the normalised-data pointer of our parent.  Not
                    957:         * everybody has one, but copying a null pointer is fine.
                    958:         */
                    959:
                    960:        n->norm = n->parent->norm;
                    961:        assert(n->parent->type == ROFFT_BLOCK);
1.266     schwarze  962: }
                    963:
1.267     schwarze  964: void
                    965: roff_word_alloc(struct roff_man *man, int line, int pos, const char *word)
                    966: {
                    967:        struct roff_node        *n;
                    968:
                    969:        n = roff_node_alloc(man, line, pos, ROFFT_TEXT, TOKEN_NONE);
                    970:        n->string = roff_strdup(man->roff, word);
                    971:        roff_node_append(man, n);
1.286     schwarze  972:        n->flags |= NODE_VALID | NODE_ENDED;
1.267     schwarze  973:        man->next = ROFF_NEXT_SIBLING;
                    974: }
                    975:
                    976: void
                    977: roff_word_append(struct roff_man *man, const char *word)
                    978: {
                    979:        struct roff_node        *n;
                    980:        char                    *addstr, *newstr;
                    981:
                    982:        n = man->last;
                    983:        addstr = roff_strdup(man->roff, word);
                    984:        mandoc_asprintf(&newstr, "%s %s", n->string, addstr);
                    985:        free(addstr);
                    986:        free(n->string);
                    987:        n->string = newstr;
                    988:        man->next = ROFF_NEXT_SIBLING;
1.268     schwarze  989: }
                    990:
                    991: void
                    992: roff_elem_alloc(struct roff_man *man, int line, int pos, int tok)
                    993: {
                    994:        struct roff_node        *n;
                    995:
                    996:        n = roff_node_alloc(man, line, pos, ROFFT_ELEM, tok);
                    997:        roff_node_append(man, n);
                    998:        man->next = ROFF_NEXT_CHILD;
                    999: }
                   1000:
                   1001: struct roff_node *
                   1002: roff_block_alloc(struct roff_man *man, int line, int pos, int tok)
                   1003: {
                   1004:        struct roff_node        *n;
                   1005:
                   1006:        n = roff_node_alloc(man, line, pos, ROFFT_BLOCK, tok);
                   1007:        roff_node_append(man, n);
                   1008:        man->next = ROFF_NEXT_CHILD;
1.277     schwarze 1009:        return n;
1.267     schwarze 1010: }
                   1011:
1.266     schwarze 1012: struct roff_node *
                   1013: roff_head_alloc(struct roff_man *man, int line, int pos, int tok)
                   1014: {
                   1015:        struct roff_node        *n;
                   1016:
                   1017:        n = roff_node_alloc(man, line, pos, ROFFT_HEAD, tok);
                   1018:        roff_node_append(man, n);
                   1019:        man->next = ROFF_NEXT_CHILD;
1.277     schwarze 1020:        return n;
1.266     schwarze 1021: }
                   1022:
                   1023: struct roff_node *
                   1024: roff_body_alloc(struct roff_man *man, int line, int pos, int tok)
                   1025: {
                   1026:        struct roff_node        *n;
                   1027:
                   1028:        n = roff_node_alloc(man, line, pos, ROFFT_BODY, tok);
                   1029:        roff_node_append(man, n);
                   1030:        man->next = ROFF_NEXT_CHILD;
1.277     schwarze 1031:        return n;
1.267     schwarze 1032: }
                   1033:
1.321     schwarze 1034: static void
1.346     schwarze 1035: roff_addtbl(struct roff_man *man, int line, struct tbl_node *tbl)
1.267     schwarze 1036: {
                   1037:        struct roff_node        *n;
1.346     schwarze 1038:        struct tbl_span         *span;
1.267     schwarze 1039:
1.356     schwarze 1040:        if (man->meta.macroset == MACROSET_MAN)
1.302     schwarze 1041:                man_breakscope(man, ROFF_TS);
1.321     schwarze 1042:        while ((span = tbl_span(tbl)) != NULL) {
1.346     schwarze 1043:                n = roff_node_alloc(man, line, 0, ROFFT_TBL, TOKEN_NONE);
1.321     schwarze 1044:                n->span = span;
                   1045:                roff_node_append(man, n);
                   1046:                n->flags |= NODE_VALID | NODE_ENDED;
                   1047:                man->next = ROFF_NEXT_SIBLING;
                   1048:        }
1.266     schwarze 1049: }
                   1050:
                   1051: void
                   1052: roff_node_unlink(struct roff_man *man, struct roff_node *n)
                   1053: {
                   1054:
                   1055:        /* Adjust siblings. */
                   1056:
                   1057:        if (n->prev)
                   1058:                n->prev->next = n->next;
                   1059:        if (n->next)
                   1060:                n->next->prev = n->prev;
                   1061:
                   1062:        /* Adjust parent. */
                   1063:
                   1064:        if (n->parent != NULL) {
                   1065:                if (n->parent->child == n)
                   1066:                        n->parent->child = n->next;
                   1067:                if (n->parent->last == n)
                   1068:                        n->parent->last = n->prev;
                   1069:        }
                   1070:
                   1071:        /* Adjust parse point. */
                   1072:
                   1073:        if (man == NULL)
                   1074:                return;
                   1075:        if (man->last == n) {
                   1076:                if (n->prev == NULL) {
                   1077:                        man->last = n->parent;
                   1078:                        man->next = ROFF_NEXT_CHILD;
                   1079:                } else {
                   1080:                        man->last = n->prev;
                   1081:                        man->next = ROFF_NEXT_SIBLING;
                   1082:                }
                   1083:        }
1.356     schwarze 1084:        if (man->meta.first == n)
                   1085:                man->meta.first = NULL;
1.344     schwarze 1086: }
                   1087:
                   1088: void
                   1089: roff_node_relink(struct roff_man *man, struct roff_node *n)
                   1090: {
                   1091:        roff_node_unlink(man, n);
                   1092:        n->prev = n->next = NULL;
                   1093:        roff_node_append(man, n);
1.266     schwarze 1094: }
                   1095:
                   1096: void
                   1097: roff_node_free(struct roff_node *n)
                   1098: {
                   1099:
                   1100:        if (n->args != NULL)
                   1101:                mdoc_argv_free(n->args);
                   1102:        if (n->type == ROFFT_BLOCK || n->type == ROFFT_ELEM)
                   1103:                free(n->norm);
1.347     schwarze 1104:        eqn_box_free(n->eqn);
1.266     schwarze 1105:        free(n->string);
1.374     schwarze 1106:        free(n->tag);
1.266     schwarze 1107:        free(n);
                   1108: }
                   1109:
                   1110: void
                   1111: roff_node_delete(struct roff_man *man, struct roff_node *n)
                   1112: {
                   1113:
                   1114:        while (n->child != NULL)
                   1115:                roff_node_delete(man, n->child);
                   1116:        roff_node_unlink(man, n);
                   1117:        roff_node_free(n);
1.370     schwarze 1118: }
                   1119:
                   1120: int
                   1121: roff_node_transparent(struct roff_node *n)
                   1122: {
                   1123:        if (n == NULL)
                   1124:                return 0;
                   1125:        if (n->type == ROFFT_COMMENT || n->flags & NODE_NOPRT)
                   1126:                return 1;
1.373     schwarze 1127:        return roff_tok_transparent(n->tok);
                   1128: }
                   1129:
                   1130: int
                   1131: roff_tok_transparent(enum roff_tok tok)
                   1132: {
                   1133:        switch (tok) {
1.370     schwarze 1134:        case ROFF_ft:
                   1135:        case ROFF_ll:
                   1136:        case ROFF_mc:
                   1137:        case ROFF_po:
                   1138:        case ROFF_ta:
                   1139:        case MDOC_Db:
                   1140:        case MDOC_Es:
                   1141:        case MDOC_Sm:
                   1142:        case MDOC_Tg:
                   1143:        case MAN_DT:
                   1144:        case MAN_UC:
                   1145:        case MAN_PD:
                   1146:        case MAN_AT:
                   1147:                return 1;
                   1148:        default:
                   1149:                return 0;
                   1150:        }
                   1151: }
                   1152:
                   1153: struct roff_node *
                   1154: roff_node_child(struct roff_node *n)
                   1155: {
                   1156:        for (n = n->child; roff_node_transparent(n); n = n->next)
                   1157:                continue;
                   1158:        return n;
                   1159: }
                   1160:
                   1161: struct roff_node *
                   1162: roff_node_prev(struct roff_node *n)
                   1163: {
                   1164:        do {
                   1165:                n = n->prev;
                   1166:        } while (roff_node_transparent(n));
                   1167:        return n;
                   1168: }
                   1169:
                   1170: struct roff_node *
                   1171: roff_node_next(struct roff_node *n)
                   1172: {
                   1173:        do {
                   1174:                n = n->next;
                   1175:        } while (roff_node_transparent(n));
                   1176:        return n;
1.269     schwarze 1177: }
                   1178:
                   1179: void
                   1180: deroff(char **dest, const struct roff_node *n)
                   1181: {
                   1182:        char    *cp;
                   1183:        size_t   sz;
                   1184:
1.371     schwarze 1185:        if (n->string == NULL) {
1.269     schwarze 1186:                for (n = n->child; n != NULL; n = n->next)
                   1187:                        deroff(dest, n);
                   1188:                return;
                   1189:        }
                   1190:
1.288     schwarze 1191:        /* Skip leading whitespace. */
1.269     schwarze 1192:
1.288     schwarze 1193:        for (cp = n->string; *cp != '\0'; cp++) {
1.289     schwarze 1194:                if (cp[0] == '\\' && cp[1] != '\0' &&
                   1195:                    strchr(" %&0^|~", cp[1]) != NULL)
1.269     schwarze 1196:                        cp++;
1.288     schwarze 1197:                else if ( ! isspace((unsigned char)*cp))
1.269     schwarze 1198:                        break;
                   1199:        }
                   1200:
1.289     schwarze 1201:        /* Skip trailing backslash. */
                   1202:
                   1203:        sz = strlen(cp);
1.290     schwarze 1204:        if (sz > 0 && cp[sz - 1] == '\\')
1.289     schwarze 1205:                sz--;
                   1206:
1.269     schwarze 1207:        /* Skip trailing whitespace. */
                   1208:
1.289     schwarze 1209:        for (; sz; sz--)
1.269     schwarze 1210:                if ( ! isspace((unsigned char)cp[sz-1]))
                   1211:                        break;
                   1212:
                   1213:        /* Skip empty strings. */
                   1214:
                   1215:        if (sz == 0)
                   1216:                return;
                   1217:
                   1218:        if (*dest == NULL) {
                   1219:                *dest = mandoc_strndup(cp, sz);
                   1220:                return;
                   1221:        }
                   1222:
                   1223:        mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp);
                   1224:        free(*dest);
                   1225:        *dest = cp;
1.266     schwarze 1226: }
                   1227:
                   1228: /* --- main functions of the roff parser ---------------------------------- */
                   1229:
1.388     schwarze 1230: /*
                   1231:  * Save comments preceding the title macro, for example in order to
                   1232:  * preserve Copyright and license headers in HTML output,
                   1233:  * provide diagnostics about RCS ids and trailing whitespace in comments,
                   1234:  * then discard comments including preceding whitespace.
                   1235:  * This function also handles input line continuation.
                   1236:  */
1.387     schwarze 1237: static int
1.388     schwarze 1238: roff_parse_comment(struct roff *r, struct buf *buf, int ln, int pos, char ec)
1.387     schwarze 1239: {
                   1240:        struct roff_node *n;    /* used for header comments */
                   1241:        const char      *start; /* start of the string to process */
                   1242:        const char      *cp;    /* for RCS id parsing */
                   1243:        char            *stesc; /* start of an escape sequence ('\\') */
                   1244:        char            *ep;    /* end of comment string */
                   1245:        int              rcsid; /* kind of RCS id seen */
                   1246:
                   1247:        for (start = stesc = buf->buf + pos;; stesc++) {
1.388     schwarze 1248:                /*
                   1249:                 * XXX Ugly hack: Remove the newline character that
                   1250:                 * mparse_buf_r() appended to mark the end of input
                   1251:                 * if it is not preceded by an escape character.
                   1252:                 */
                   1253:                if (stesc[0] == '\n') {
                   1254:                        assert(stesc[1] == '\0');
                   1255:                        stesc[0] = '\0';
                   1256:                }
                   1257:
1.387     schwarze 1258:                /* The line ends without continuation or comment. */
                   1259:                if (stesc[0] == '\0')
                   1260:                        return ROFF_CONT;
                   1261:
                   1262:                /* Unescaped byte: skip it. */
1.388     schwarze 1263:                if (stesc[0] != ec)
1.387     schwarze 1264:                        continue;
                   1265:
1.388     schwarze 1266:                /*
                   1267:                 * XXX Ugly hack: Do not attempt to append another line
                   1268:                 * if the function mparse_buf_r() appended a newline
                   1269:                 * character to indicate the end of input.
                   1270:                 */
                   1271:                if (stesc[1] == '\n') {
                   1272:                        assert(stesc[2] == '\0');
                   1273:                        stesc[0] = '\0';
                   1274:                        return ROFF_CONT;
                   1275:                }
                   1276:
                   1277:                /*
                   1278:                 * An escape character at the end of an input line
                   1279:                 * requests line continuation.
                   1280:                 */
1.387     schwarze 1281:                if (stesc[1] == '\0') {
                   1282:                        stesc[0] = '\0';
                   1283:                        return ROFF_IGN | ROFF_APPEND;
                   1284:                }
                   1285:
                   1286:                /* Found a comment: process it. */
                   1287:                if (stesc[1] == '"' || stesc[1] == '#')
                   1288:                        break;
                   1289:
                   1290:                /* Escaped escape character: skip them both. */
1.388     schwarze 1291:                if (stesc[1] == ec)
1.387     schwarze 1292:                        stesc++;
                   1293:        }
                   1294:
                   1295:        /* Look for an RCS id in the comment. */
                   1296:
                   1297:        rcsid = 0;
                   1298:        if ((cp = strstr(stesc + 2, "$" "OpenBSD")) != NULL) {
                   1299:                rcsid = 1 << MANDOC_OS_OPENBSD;
                   1300:                cp += 8;
                   1301:        } else if ((cp = strstr(stesc + 2, "$" "NetBSD")) != NULL) {
                   1302:                rcsid = 1 << MANDOC_OS_NETBSD;
                   1303:                cp += 7;
                   1304:        }
                   1305:        if (cp != NULL && isalnum((unsigned char)*cp) == 0 &&
                   1306:            strchr(cp, '$') != NULL) {
                   1307:                if (r->man->meta.rcsids & rcsid)
                   1308:                        mandoc_msg(MANDOCERR_RCS_REP, ln,
                   1309:                            (int)(stesc - buf->buf) + 2, "%s", stesc + 1);
                   1310:                r->man->meta.rcsids |= rcsid;
                   1311:        }
                   1312:
                   1313:        /* Warn about trailing whitespace at the end of the comment. */
                   1314:
                   1315:        ep = strchr(stesc + 2, '\0') - 1;
                   1316:        if (*ep == '\n')
                   1317:                *ep-- = '\0';
                   1318:        if (*ep == ' ' || *ep == '\t')
                   1319:                mandoc_msg(MANDOCERR_SPACE_EOL,
                   1320:                    ln, (int)(ep - buf->buf), NULL);
                   1321:
                   1322:        /* Save comments preceding the title macro in the syntax tree. */
                   1323:
                   1324:        if (r->options & MPARSE_COMMENT) {
                   1325:                while (*ep == ' ' || *ep == '\t')
                   1326:                        ep--;
                   1327:                ep[1] = '\0';
                   1328:                n = roff_node_alloc(r->man, ln, stesc + 1 - buf->buf,
                   1329:                    ROFFT_COMMENT, TOKEN_NONE);
                   1330:                n->string = mandoc_strdup(stesc + 2);
                   1331:                roff_node_append(r->man, n);
                   1332:                n->flags |= NODE_VALID | NODE_ENDED;
                   1333:                r->man->next = ROFF_NEXT_SIBLING;
                   1334:        }
                   1335:
                   1336:        /* The comment requests line continuation. */
                   1337:
                   1338:        if (stesc[1] == '#') {
                   1339:                *stesc = '\0';
                   1340:                return ROFF_IGN | ROFF_APPEND;
                   1341:        }
                   1342:
                   1343:        /* Discard the comment including preceding whitespace. */
                   1344:
                   1345:        while (stesc > start && stesc[-1] == ' ' &&
                   1346:            (stesc == start + 1 || stesc[-2] != '\\'))
                   1347:                stesc--;
                   1348:        *stesc = '\0';
                   1349:        return ROFF_CONT;
                   1350: }
                   1351:
1.94      kristaps 1352: /*
1.355     schwarze 1353:  * In the current line, expand escape sequences that produce parsable
                   1354:  * input text.  Also check the syntax of the remaining escape sequences,
                   1355:  * which typically produce output glyphs or change formatter state.
1.154     kristaps 1356:  */
1.340     schwarze 1357: static int
1.388     schwarze 1358: roff_expand(struct roff *r, struct buf *buf, int ln, int pos, char ec)
1.94      kristaps 1359: {
1.388     schwarze 1360:        char             ubuf[24];      /* buffer to print a number */
                   1361:        struct mctx     *ctx;           /* current macro call context */
                   1362:        const char      *res;           /* the string to be pasted */
                   1363:        const char      *src;           /* source for copying */
                   1364:        char            *dst;           /* destination for copying */
1.399   ! schwarze 1365:        enum mandoc_esc  subtype;       /* return value from roff_escape */
1.388     schwarze 1366:        int              iesc;          /* index of leading escape char */
                   1367:        int              inam;          /* index of the escape name */
                   1368:        int              iarg;          /* index beginning the argument */
                   1369:        int              iendarg;       /* index right after the argument */
                   1370:        int              iend;          /* index right after the sequence */
1.393     schwarze 1371:        int              isrc, idst;    /* to reduce \\ and \. in names */
1.388     schwarze 1372:        int              deftype;       /* type of definition to paste */
                   1373:        int              argi;          /* macro argument index */
                   1374:        int              quote_args;    /* true for \\$@, false for \\$* */
                   1375:        int              asz;           /* length of the replacement */
                   1376:        int              rsz;           /* length of the rest of the string */
                   1377:        int              npos;          /* position in numeric expression */
1.181     schwarze 1378:        int              expand_count;  /* to avoid infinite loops */
1.303     schwarze 1379:
1.170     schwarze 1380:        expand_count = 0;
1.388     schwarze 1381:        while (buf->buf[pos] != '\0') {
1.170     schwarze 1382:
1.388     schwarze 1383:                /*
                   1384:                 * Skip plain ASCII characters.
                   1385:                 * If we have a non-standard escape character,
                   1386:                 * escape literal backslashes because all processing in
                   1387:                 * subsequent functions uses the standard escaping rules.
                   1388:                 */
1.205     schwarze 1389:
1.388     schwarze 1390:                if (buf->buf[pos] != ec) {
1.397     schwarze 1391:                        if (buf->buf[pos] == '\\') {
1.388     schwarze 1392:                                roff_expand_patch(buf, pos, "\\e", pos + 1);
                   1393:                                pos++;
1.303     schwarze 1394:                        }
1.388     schwarze 1395:                        pos++;
1.205     schwarze 1396:                        continue;
1.303     schwarze 1397:                }
1.205     schwarze 1398:
1.388     schwarze 1399:                /*
                   1400:                 * Parse escape sequences,
                   1401:                 * issue diagnostic messages when appropriate,
                   1402:                 * and skip sequences that do not need expansion.
                   1403:                 * If we have a non-standard escape character, translate
                   1404:                 * it to backslashes and translate backslashes to \e.
                   1405:                 */
1.205     schwarze 1406:
1.392     schwarze 1407:                if (roff_escape(buf->buf, ln, pos, &iesc, &inam,
                   1408:                    &iarg, &iendarg, &iend) != ESCAPE_EXPAND) {
1.388     schwarze 1409:                        while (pos < iend) {
                   1410:                                if (buf->buf[pos] == ec) {
                   1411:                                        buf->buf[pos] = '\\';
                   1412:                                        if (pos + 1 < iend)
                   1413:                                                pos++;
                   1414:                                } else if (buf->buf[pos] == '\\') {
                   1415:                                        roff_expand_patch(buf,
                   1416:                                            pos, "\\e", pos + 1);
                   1417:                                        pos++;
                   1418:                                        iend++;
                   1419:                                }
                   1420:                                pos++;
1.352     schwarze 1421:                        }
1.205     schwarze 1422:                        continue;
1.152     kristaps 1423:                }
1.388     schwarze 1424:
1.393     schwarze 1425:                /* Reduce \\ and \. in names. */
                   1426:
                   1427:                if (buf->buf[inam] == '*' || buf->buf[inam] == 'n') {
                   1428:                        isrc = idst = iarg;
                   1429:                        while (isrc < iendarg) {
                   1430:                                if (isrc + 1 < iendarg &&
                   1431:                                    buf->buf[isrc] == '\\' &&
                   1432:                                    (buf->buf[isrc + 1] == '\\' ||
                   1433:                                     buf->buf[isrc + 1] == '.'))
                   1434:                                        isrc++;
                   1435:                                buf->buf[idst++] = buf->buf[isrc++];
                   1436:                        }
                   1437:                        iendarg -= isrc - idst;
                   1438:                }
                   1439:
1.388     schwarze 1440:                /* Handle expansion. */
                   1441:
                   1442:                res = NULL;
                   1443:                switch (buf->buf[inam]) {
                   1444:                case '*':
                   1445:                        if (iendarg == iarg)
1.206     schwarze 1446:                                break;
1.388     schwarze 1447:                        deftype = ROFFDEF_USER | ROFFDEF_PRE;
                   1448:                        if ((res = roff_getstrn(r, buf->buf + iarg,
                   1449:                            iendarg - iarg, &deftype)) != NULL)
1.206     schwarze 1450:                                break;
1.94      kristaps 1451:
1.388     schwarze 1452:                        /*
1.396     schwarze 1453:                         * If not overridden,
1.388     schwarze 1454:                         * let \*(.T through to the formatters.
                   1455:                         */
1.94      kristaps 1456:
1.388     schwarze 1457:                        if (iendarg - iarg == 2 &&
                   1458:                            buf->buf[iarg] == '.' &&
                   1459:                            buf->buf[iarg + 1] == 'T') {
                   1460:                                roff_setstrn(&r->strtab, ".T", 2, NULL, 0, 0);
                   1461:                                pos = iend;
1.253     schwarze 1462:                                continue;
                   1463:                        }
1.94      kristaps 1464:
1.388     schwarze 1465:                        mandoc_msg(MANDOCERR_STR_UNDEF, ln, iesc,
                   1466:                            "%.*s", iendarg - iarg, buf->buf + iarg);
                   1467:                        break;
1.108     schwarze 1468:
1.339     schwarze 1469:                case '$':
                   1470:                        if (r->mstackpos < 0) {
1.388     schwarze 1471:                                mandoc_msg(MANDOCERR_ARG_UNDEF, ln, iesc,
                   1472:                                    "%.*s", iend - iesc, buf->buf + iesc);
1.339     schwarze 1473:                                break;
                   1474:                        }
                   1475:                        ctx = r->mstack + r->mstackpos;
1.388     schwarze 1476:                        argi = buf->buf[iarg] - '1';
                   1477:                        if (argi >= 0 && argi <= 8) {
                   1478:                                if (argi < ctx->argc)
                   1479:                                        res = ctx->argv[argi];
1.339     schwarze 1480:                                break;
                   1481:                        }
1.388     schwarze 1482:                        if (buf->buf[iarg] == '*')
1.339     schwarze 1483:                                quote_args = 0;
1.388     schwarze 1484:                        else if (buf->buf[iarg] == '@')
1.339     schwarze 1485:                                quote_args = 1;
                   1486:                        else {
1.388     schwarze 1487:                                mandoc_msg(MANDOCERR_ARG_NONUM, ln, iesc,
                   1488:                                    "%.*s", iend - iesc, buf->buf + iesc);
1.339     schwarze 1489:                                break;
                   1490:                        }
                   1491:                        asz = 0;
1.388     schwarze 1492:                        for (argi = 0; argi < ctx->argc; argi++) {
                   1493:                                if (argi)
1.339     schwarze 1494:                                        asz++;  /* blank */
                   1495:                                if (quote_args)
                   1496:                                        asz += 2;  /* quotes */
1.388     schwarze 1497:                                asz += strlen(ctx->argv[argi]);
1.339     schwarze 1498:                        }
1.388     schwarze 1499:                        if (asz != iend - iesc) {
                   1500:                                rsz = buf->sz - iend;
                   1501:                                if (asz < iend - iesc)
                   1502:                                        memmove(buf->buf + iesc + asz,
                   1503:                                            buf->buf + iend, rsz);
                   1504:                                buf->sz = iesc + asz + rsz;
                   1505:                                buf->buf = mandoc_realloc(buf->buf, buf->sz);
                   1506:                                if (asz > iend - iesc)
                   1507:                                        memmove(buf->buf + iesc + asz,
                   1508:                                            buf->buf + iend, rsz);
1.339     schwarze 1509:                        }
1.388     schwarze 1510:                        dst = buf->buf + iesc;
                   1511:                        for (argi = 0; argi < ctx->argc; argi++) {
                   1512:                                if (argi)
                   1513:                                        *dst++ = ' ';
1.339     schwarze 1514:                                if (quote_args)
1.388     schwarze 1515:                                        *dst++ = '"';
                   1516:                                src = ctx->argv[argi];
                   1517:                                while (*src != '\0')
                   1518:                                        *dst++ = *src++;
1.339     schwarze 1519:                                if (quote_args)
1.388     schwarze 1520:                                        *dst++ = '"';
1.339     schwarze 1521:                        }
                   1522:                        continue;
1.391     schwarze 1523:                case 'A':
                   1524:                        ubuf[0] = iendarg > iarg ? '1' : '0';
                   1525:                        ubuf[1] = '\0';
                   1526:                        res = ubuf;
                   1527:                        break;
1.207     schwarze 1528:                case 'B':
1.206     schwarze 1529:                        npos = 0;
1.388     schwarze 1530:                        ubuf[0] = iendarg > iarg && iend > iendarg &&
                   1531:                            roff_evalnum(r, ln, buf->buf + iarg, &npos,
                   1532:                                         NULL, ROFFNUM_SCALE) &&
                   1533:                            npos == iendarg - iarg ? '1' : '0';
1.206     schwarze 1534:                        ubuf[1] = '\0';
1.388     schwarze 1535:                        res = ubuf;
1.206     schwarze 1536:                        break;
1.389     schwarze 1537:                case 'V':
                   1538:                        mandoc_msg(MANDOCERR_UNSUPP, ln, iesc,
                   1539:                            "%.*s", iend - iesc, buf->buf + iesc);
                   1540:                        roff_expand_patch(buf, iendarg, "}", iend);
                   1541:                        roff_expand_patch(buf, iesc, "${", iarg);
                   1542:                        continue;
1.390     schwarze 1543:                case 'g':
                   1544:                        break;
1.207     schwarze 1545:                case 'n':
1.388     schwarze 1546:                        if (iendarg > iarg)
1.218     schwarze 1547:                                (void)snprintf(ubuf, sizeof(ubuf), "%d",
1.388     schwarze 1548:                                    roff_getregn(r, buf->buf + iarg,
                   1549:                                    iendarg - iarg, buf->buf[inam + 1]));
1.218     schwarze 1550:                        else
                   1551:                                ubuf[0] = '\0';
1.388     schwarze 1552:                        res = ubuf;
1.206     schwarze 1553:                        break;
1.207     schwarze 1554:                case 'w':
1.399   ! schwarze 1555:                        rsz = 0;
        !          1556:                        subtype = ESCAPE_UNDEF;
        !          1557:                        while (iarg < iendarg) {
        !          1558:                                asz = subtype == ESCAPE_SKIPCHAR ? 0 : 1;
        !          1559:                                if (buf->buf[iarg] != '\\') {
        !          1560:                                        rsz += asz;
        !          1561:                                        iarg++;
        !          1562:                                        continue;
        !          1563:                                }
        !          1564:                                switch ((subtype = roff_escape(buf->buf, 0,
        !          1565:                                    iarg, NULL, NULL, NULL, NULL, &iarg))) {
        !          1566:                                case ESCAPE_SPECIAL:
        !          1567:                                case ESCAPE_NUMBERED:
        !          1568:                                case ESCAPE_UNICODE:
        !          1569:                                case ESCAPE_OVERSTRIKE:
        !          1570:                                case ESCAPE_UNDEF:
        !          1571:                                        break;
        !          1572:                                case ESCAPE_DEVICE:
        !          1573:                                        asz *= 8;
        !          1574:                                        break;
        !          1575:                                case ESCAPE_EXPAND:
        !          1576:                                        abort();
        !          1577:                                default:
        !          1578:                                        continue;
        !          1579:                                }
        !          1580:                                rsz += asz;
        !          1581:                        }
        !          1582:                        (void)snprintf(ubuf, sizeof(ubuf), "%d", rsz * 24);
1.388     schwarze 1583:                        res = ubuf;
                   1584:                        break;
                   1585:                default:
1.206     schwarze 1586:                        break;
                   1587:                }
1.388     schwarze 1588:                if (res == NULL)
1.142     kristaps 1589:                        res = "";
1.388     schwarze 1590:                if (++expand_count > EXPAND_LIMIT ||
                   1591:                    buf->sz + strlen(res) > SHRT_MAX) {
                   1592:                        mandoc_msg(MANDOCERR_ROFFLOOP, ln, iesc, NULL);
1.277     schwarze 1593:                        return ROFF_IGN;
1.94      kristaps 1594:                }
1.388     schwarze 1595:                roff_expand_patch(buf, iesc, res, iend);
                   1596:        }
                   1597:        return ROFF_CONT;
                   1598: }
1.94      kristaps 1599:
1.388     schwarze 1600: /*
                   1601:  * Replace the substring from the start position (inclusive)
                   1602:  * to end position (exclusive) with the repl(acement) string.
                   1603:  */
                   1604: static void
                   1605: roff_expand_patch(struct buf *buf, int start, const char *repl, int end)
                   1606: {
                   1607:        char    *nbuf;
1.108     schwarze 1608:
1.389     schwarze 1609:        buf->sz = mandoc_asprintf(&nbuf, "%.*s%s%s", start, buf->buf,
                   1610:            repl, buf->buf + end) + 1;
1.388     schwarze 1611:        free(buf->buf);
                   1612:        buf->buf = nbuf;
1.154     kristaps 1613: }
1.353     schwarze 1614:
                   1615: /*
                   1616:  * Parse a quoted or unquoted roff-style request or macro argument.
                   1617:  * Return a pointer to the parsed argument, which is either the original
                   1618:  * pointer or advanced by one byte in case the argument is quoted.
                   1619:  * NUL-terminate the argument in place.
                   1620:  * Collapse pairs of quotes inside quoted arguments.
                   1621:  * Advance the argument pointer to the next argument,
                   1622:  * or to the NUL byte terminating the argument line.
                   1623:  */
                   1624: char *
1.355     schwarze 1625: roff_getarg(struct roff *r, char **cpp, int ln, int *pos)
1.353     schwarze 1626: {
1.355     schwarze 1627:        struct buf       buf;
1.366     schwarze 1628:        char            *cp, *start;
1.355     schwarze 1629:        int              newesc, pairs, quoted, white;
1.353     schwarze 1630:
                   1631:        /* Quoting can only start with a new word. */
                   1632:        start = *cpp;
                   1633:        quoted = 0;
                   1634:        if ('"' == *start) {
                   1635:                quoted = 1;
                   1636:                start++;
                   1637:        }
                   1638:
1.355     schwarze 1639:        newesc = pairs = white = 0;
1.353     schwarze 1640:        for (cp = start; '\0' != *cp; cp++) {
                   1641:
                   1642:                /*
                   1643:                 * Move the following text left
                   1644:                 * after quoted quotes and after "\\" and "\t".
                   1645:                 */
                   1646:                if (pairs)
                   1647:                        cp[-pairs] = cp[0];
                   1648:
                   1649:                if ('\\' == cp[0]) {
                   1650:                        /*
                   1651:                         * In copy mode, translate double to single
                   1652:                         * backslashes and backslash-t to literal tabs.
                   1653:                         */
                   1654:                        switch (cp[1]) {
                   1655:                        case 'a':
                   1656:                        case 't':
1.354     schwarze 1657:                                cp[-pairs] = '\t';
1.355     schwarze 1658:                                pairs++;
                   1659:                                cp++;
                   1660:                                break;
1.353     schwarze 1661:                        case '\\':
1.397     schwarze 1662:                                cp[-pairs] = '\\';
1.355     schwarze 1663:                                newesc = 1;
1.353     schwarze 1664:                                pairs++;
                   1665:                                cp++;
                   1666:                                break;
                   1667:                        case ' ':
                   1668:                                /* Skip escaped blanks. */
                   1669:                                if (0 == quoted)
                   1670:                                        cp++;
                   1671:                                break;
                   1672:                        default:
                   1673:                                break;
                   1674:                        }
                   1675:                } else if (0 == quoted) {
                   1676:                        if (' ' == cp[0]) {
                   1677:                                /* Unescaped blanks end unquoted args. */
                   1678:                                white = 1;
                   1679:                                break;
                   1680:                        }
                   1681:                } else if ('"' == cp[0]) {
                   1682:                        if ('"' == cp[1]) {
                   1683:                                /* Quoted quotes collapse. */
                   1684:                                pairs++;
                   1685:                                cp++;
                   1686:                        } else {
                   1687:                                /* Unquoted quotes end quoted args. */
                   1688:                                quoted = 2;
                   1689:                                break;
                   1690:                        }
                   1691:                }
                   1692:        }
                   1693:
                   1694:        /* Quoted argument without a closing quote. */
                   1695:        if (1 == quoted)
                   1696:                mandoc_msg(MANDOCERR_ARG_QUOTE, ln, *pos, NULL);
                   1697:
                   1698:        /* NUL-terminate this argument and move to the next one. */
                   1699:        if (pairs)
                   1700:                cp[-pairs] = '\0';
                   1701:        if ('\0' != *cp) {
                   1702:                *cp++ = '\0';
                   1703:                while (' ' == *cp)
                   1704:                        cp++;
                   1705:        }
                   1706:        *pos += (int)(cp - start) + (quoted ? 1 : 0);
                   1707:        *cpp = cp;
                   1708:
                   1709:        if ('\0' == *cp && (white || ' ' == cp[-1]))
                   1710:                mandoc_msg(MANDOCERR_SPACE_EOL, ln, *pos, NULL);
                   1711:
1.355     schwarze 1712:        start = mandoc_strdup(start);
                   1713:        if (newesc == 0)
                   1714:                return start;
                   1715:
                   1716:        buf.buf = start;
                   1717:        buf.sz = strlen(start) + 1;
                   1718:        buf.next = NULL;
1.398     schwarze 1719:        if (roff_expand(r, &buf, ln, 0, '\\') == ROFF_IGN) {
1.355     schwarze 1720:                free(buf.buf);
                   1721:                buf.buf = mandoc_strdup("");
                   1722:        }
                   1723:        return buf.buf;
1.353     schwarze 1724: }
                   1725:
1.154     kristaps 1726:
                   1727: /*
1.275     schwarze 1728:  * Process text streams.
1.154     kristaps 1729:  */
1.340     schwarze 1730: static int
1.305     schwarze 1731: roff_parsetext(struct roff *r, struct buf *buf, int pos, int *offs)
1.154     kristaps 1732: {
                   1733:        size_t           sz;
                   1734:        const char      *start;
1.178     schwarze 1735:        char            *p;
                   1736:        int              isz;
1.154     kristaps 1737:        enum mandoc_esc  esc;
                   1738:
1.275     schwarze 1739:        /* Spring the input line trap. */
                   1740:
                   1741:        if (roffit_lines == 1) {
                   1742:                isz = mandoc_asprintf(&p, "%s\n.%s", buf->buf, roffit_macro);
                   1743:                free(buf->buf);
                   1744:                buf->buf = p;
                   1745:                buf->sz = isz + 1;
                   1746:                *offs = 0;
                   1747:                free(roffit_macro);
                   1748:                roffit_lines = 0;
1.277     schwarze 1749:                return ROFF_REPARSE;
1.275     schwarze 1750:        } else if (roffit_lines > 1)
                   1751:                --roffit_lines;
                   1752:
1.305     schwarze 1753:        if (roffce_node != NULL && buf->buf[pos] != '\0') {
                   1754:                if (roffce_lines < 1) {
                   1755:                        r->man->last = roffce_node;
                   1756:                        r->man->next = ROFF_NEXT_SIBLING;
                   1757:                        roffce_lines = 0;
                   1758:                        roffce_node = NULL;
                   1759:                } else
                   1760:                        roffce_lines--;
                   1761:        }
                   1762:
1.275     schwarze 1763:        /* Convert all breakable hyphens into ASCII_HYPH. */
                   1764:
1.238     schwarze 1765:        start = p = buf->buf + pos;
1.154     kristaps 1766:
1.238     schwarze 1767:        while (*p != '\0') {
1.154     kristaps 1768:                sz = strcspn(p, "-\\");
                   1769:                p += sz;
                   1770:
1.238     schwarze 1771:                if (*p == '\0')
1.159     kristaps 1772:                        break;
                   1773:
1.238     schwarze 1774:                if (*p == '\\') {
1.154     kristaps 1775:                        /* Skip over escapes. */
                   1776:                        p++;
1.189     schwarze 1777:                        esc = mandoc_escape((const char **)&p, NULL, NULL);
1.238     schwarze 1778:                        if (esc == ESCAPE_ERROR)
1.154     kristaps 1779:                                break;
1.264     schwarze 1780:                        while (*p == '-')
                   1781:                                p++;
1.155     kristaps 1782:                        continue;
1.159     kristaps 1783:                } else if (p == start) {
1.158     kristaps 1784:                        p++;
1.155     kristaps 1785:                        continue;
1.158     kristaps 1786:                }
1.155     kristaps 1787:
1.171     schwarze 1788:                if (isalpha((unsigned char)p[-1]) &&
                   1789:                    isalpha((unsigned char)p[1]))
1.155     kristaps 1790:                        *p = ASCII_HYPH;
                   1791:                p++;
1.94      kristaps 1792:        }
1.277     schwarze 1793:        return ROFF_CONT;
1.94      kristaps 1794: }
                   1795:
1.340     schwarze 1796: int
1.377     schwarze 1797: roff_parseln(struct roff *r, int ln, struct buf *buf, int *offs, size_t len)
1.67      kristaps 1798: {
1.294     schwarze 1799:        enum roff_tok    t;
1.340     schwarze 1800:        int              e;
1.238     schwarze 1801:        int              pos;   /* parse point */
1.243     schwarze 1802:        int              spos;  /* saved parse point for messages */
1.238     schwarze 1803:        int              ppos;  /* original offset in buf->buf */
                   1804:        int              ctl;   /* macro line (boolean) */
                   1805:
                   1806:        ppos = pos = *offs;
1.377     schwarze 1807:
                   1808:        if (len > 80 && r->tbl == NULL && r->eqn == NULL &&
                   1809:            (r->man->flags & ROFF_NOFILL) == 0 &&
                   1810:            strchr(" .\\", buf->buf[pos]) == NULL &&
                   1811:            buf->buf[pos] != r->control &&
                   1812:            strcspn(buf->buf, " ") < 80)
                   1813:                mandoc_msg(MANDOCERR_TEXT_LONG, ln, (int)len - 1,
                   1814:                    "%.20s...", buf->buf + pos);
1.79      kristaps 1815:
1.230     schwarze 1816:        /* Handle in-line equation delimiters. */
                   1817:
1.236     schwarze 1818:        if (r->tbl == NULL &&
                   1819:            r->last_eqn != NULL && r->last_eqn->delim &&
1.230     schwarze 1820:            (r->eqn == NULL || r->eqn_inline)) {
1.238     schwarze 1821:                e = roff_eqndelim(r, buf, pos);
1.230     schwarze 1822:                if (e == ROFF_REPARSE)
1.277     schwarze 1823:                        return e;
1.230     schwarze 1824:                assert(e == ROFF_CONT);
                   1825:        }
                   1826:
1.387     schwarze 1827:        /* Handle comments and escape sequences. */
                   1828:
                   1829:        e = roff_parse_comment(r, buf, ln, pos, r->escape);
                   1830:        if ((e & ROFF_MASK) == ROFF_IGN)
                   1831:                return e;
                   1832:        assert(e == ROFF_CONT);
1.94      kristaps 1833:
1.355     schwarze 1834:        e = roff_expand(r, buf, ln, pos, r->escape);
1.340     schwarze 1835:        if ((e & ROFF_MASK) == ROFF_IGN)
1.277     schwarze 1836:                return e;
1.238     schwarze 1837:        assert(e == ROFF_CONT);
1.94      kristaps 1838:
1.238     schwarze 1839:        ctl = roff_getcontrol(r, buf->buf, &pos);
1.130     kristaps 1840:
1.94      kristaps 1841:        /*
1.79      kristaps 1842:         * First, if a scope is open and we're not a macro, pass the
1.252     schwarze 1843:         * text through the macro's filter.
                   1844:         * Equations process all content themselves.
                   1845:         * Tables process almost all content themselves, but we want
                   1846:         * to warn about macros before passing it there.
1.79      kristaps 1847:         */
1.74      kristaps 1848:
1.252     schwarze 1849:        if (r->last != NULL && ! ctl) {
1.78      kristaps 1850:                t = r->last->tok;
1.238     schwarze 1851:                e = (*roffs[t].text)(r, t, buf, ln, pos, pos, offs);
1.340     schwarze 1852:                if ((e & ROFF_MASK) == ROFF_IGN)
1.277     schwarze 1853:                        return e;
1.340     schwarze 1854:                e &= ~ROFF_MASK;
                   1855:        } else
                   1856:                e = ROFF_IGN;
1.319     schwarze 1857:        if (r->eqn != NULL && strncmp(buf->buf + ppos, ".EN", 3)) {
                   1858:                eqn_read(r->eqn, buf->buf + ppos);
1.340     schwarze 1859:                return e;
1.319     schwarze 1860:        }
1.321     schwarze 1861:        if (r->tbl != NULL && (ctl == 0 || buf->buf[pos] == '\0')) {
                   1862:                tbl_read(r->tbl, ln, buf->buf, ppos);
1.346     schwarze 1863:                roff_addtbl(r->man, ln, r->tbl);
1.340     schwarze 1864:                return e;
1.321     schwarze 1865:        }
1.367     schwarze 1866:        if ( ! ctl) {
                   1867:                r->options &= ~MPARSE_COMMENT;
1.340     schwarze 1868:                return roff_parsetext(r, buf, pos, offs) | e;
1.367     schwarze 1869:        }
1.228     schwarze 1870:
                   1871:        /* Skip empty request lines. */
                   1872:
1.238     schwarze 1873:        if (buf->buf[pos] == '"') {
1.350     schwarze 1874:                mandoc_msg(MANDOCERR_COMMENT_BAD, ln, pos, NULL);
1.277     schwarze 1875:                return ROFF_IGN;
1.238     schwarze 1876:        } else if (buf->buf[pos] == '\0')
1.277     schwarze 1877:                return ROFF_IGN;
1.67      kristaps 1878:
1.79      kristaps 1879:        /*
                   1880:         * If a scope is open, go to the child handler for that macro,
                   1881:         * as it may want to preprocess before doing anything with it.
                   1882:         */
1.78      kristaps 1883:
1.79      kristaps 1884:        if (r->last) {
                   1885:                t = r->last->tok;
1.277     schwarze 1886:                return (*roffs[t].sub)(r, t, buf, ln, ppos, pos, offs);
1.79      kristaps 1887:        }
1.78      kristaps 1888:
1.367     schwarze 1889:        r->options &= ~MPARSE_COMMENT;
1.243     schwarze 1890:        spos = pos;
                   1891:        t = roff_parse(r, buf->buf, &pos, ln, ppos);
1.386     schwarze 1892:        return roff_req_or_macro(r, t, buf, ln, spos, pos, offs);
                   1893: }
                   1894:
                   1895: /*
                   1896:  * Handle a new request or macro.
                   1897:  * May be called outside any scope or from inside a conditional scope.
                   1898:  */
                   1899: static int
                   1900: roff_req_or_macro(ROFF_ARGS) {
1.243     schwarze 1901:
1.386     schwarze 1902:        /* For now, tables ignore most macros and some request. */
1.243     schwarze 1903:
1.386     schwarze 1904:        if (r->tbl != NULL && (tok == TOKEN_NONE || tok == ROFF_TS ||
                   1905:            tok == ROFF_br || tok == ROFF_ce || tok == ROFF_rj ||
                   1906:            tok == ROFF_sp)) {
1.350     schwarze 1907:                mandoc_msg(MANDOCERR_TBLMACRO,
1.386     schwarze 1908:                    ln, ppos, "%s", buf->buf + ppos);
                   1909:                if (tok != TOKEN_NONE)
1.277     schwarze 1910:                        return ROFF_IGN;
1.257     schwarze 1911:                while (buf->buf[pos] != '\0' && buf->buf[pos] != ' ')
                   1912:                        pos++;
1.291     schwarze 1913:                while (buf->buf[pos] == ' ')
1.257     schwarze 1914:                        pos++;
1.321     schwarze 1915:                tbl_read(r->tbl, ln, buf->buf, pos);
1.346     schwarze 1916:                roff_addtbl(r->man, ln, r->tbl);
1.321     schwarze 1917:                return ROFF_IGN;
1.243     schwarze 1918:        }
                   1919:
1.305     schwarze 1920:        /* For now, let high level macros abort .ce mode. */
                   1921:
1.386     schwarze 1922:        if (roffce_node != NULL &&
                   1923:            (tok == TOKEN_NONE || tok == ROFF_Dd || tok == ROFF_EQ ||
                   1924:             tok == ROFF_TH || tok == ROFF_TS)) {
1.305     schwarze 1925:                r->man->last = roffce_node;
                   1926:                r->man->next = ROFF_NEXT_SIBLING;
                   1927:                roffce_lines = 0;
                   1928:                roffce_node = NULL;
                   1929:        }
                   1930:
1.79      kristaps 1931:        /*
1.243     schwarze 1932:         * This is neither a roff request nor a user-defined macro.
                   1933:         * Let the standard macro set parsers handle it.
1.79      kristaps 1934:         */
1.67      kristaps 1935:
1.386     schwarze 1936:        if (tok == TOKEN_NONE)
1.277     schwarze 1937:                return ROFF_CONT;
1.243     schwarze 1938:
1.386     schwarze 1939:        /* Execute a roff request or a user-defined macro. */
1.67      kristaps 1940:
1.386     schwarze 1941:        return (*roffs[tok].proc)(r, tok, buf, ln, ppos, pos, offs);
1.74      kristaps 1942: }
                   1943:
1.339     schwarze 1944: /*
                   1945:  * Internal interface function to tell the roff parser that execution
                   1946:  * of the current macro ended.  This is required because macro
                   1947:  * definitions usually do not end with a .return request.
                   1948:  */
                   1949: void
                   1950: roff_userret(struct roff *r)
                   1951: {
                   1952:        struct mctx     *ctx;
                   1953:        int              i;
                   1954:
                   1955:        assert(r->mstackpos >= 0);
                   1956:        ctx = r->mstack + r->mstackpos;
                   1957:        for (i = 0; i < ctx->argc; i++)
                   1958:                free(ctx->argv[i]);
                   1959:        ctx->argc = 0;
                   1960:        r->mstackpos--;
                   1961: }
                   1962:
1.117     kristaps 1963: void
1.74      kristaps 1964: roff_endparse(struct roff *r)
                   1965: {
1.321     schwarze 1966:        if (r->last != NULL)
1.350     schwarze 1967:                mandoc_msg(MANDOCERR_BLK_NOEND, r->last->line,
                   1968:                    r->last->col, "%s", roff_name[r->last->tok]);
1.117     kristaps 1969:
1.321     schwarze 1970:        if (r->eqn != NULL) {
1.350     schwarze 1971:                mandoc_msg(MANDOCERR_BLK_NOEND,
1.319     schwarze 1972:                    r->eqn->node->line, r->eqn->node->pos, "EQ");
                   1973:                eqn_parse(r->eqn);
                   1974:                r->eqn = NULL;
1.125     kristaps 1975:        }
                   1976:
1.321     schwarze 1977:        if (r->tbl != NULL) {
1.346     schwarze 1978:                tbl_end(r->tbl, 1);
1.321     schwarze 1979:                r->tbl = NULL;
1.117     kristaps 1980:        }
1.67      kristaps 1981: }
                   1982:
                   1983: /*
1.386     schwarze 1984:  * Parse the request or macro name at buf[*pos].
                   1985:  * Return ROFF_RENAMED, ROFF_USERDEF, or a ROFF_* token value.
                   1986:  * For empty, undefined, mdoc(7), and man(7) macros, return TOKEN_NONE.
                   1987:  * As a side effect, set r->current_string to the definition or to NULL.
1.67      kristaps 1988:  */
1.294     schwarze 1989: static enum roff_tok
1.214     schwarze 1990: roff_parse(struct roff *r, char *buf, int *pos, int ln, int ppos)
1.67      kristaps 1991: {
1.214     schwarze 1992:        char            *cp;
1.106     kristaps 1993:        const char      *mac;
                   1994:        size_t           maclen;
1.315     schwarze 1995:        int              deftype;
1.294     schwarze 1996:        enum roff_tok    t;
1.67      kristaps 1997:
1.214     schwarze 1998:        cp = buf + *pos;
                   1999:
                   2000:        if ('\0' == *cp || '"' == *cp || '\t' == *cp || ' ' == *cp)
1.294     schwarze 2001:                return TOKEN_NONE;
1.67      kristaps 2002:
1.214     schwarze 2003:        mac = cp;
                   2004:        maclen = roff_getname(r, &cp, ln, ppos);
1.67      kristaps 2005:
1.315     schwarze 2006:        deftype = ROFFDEF_USER | ROFFDEF_REN;
                   2007:        r->current_string = roff_getstrn(r, mac, maclen, &deftype);
                   2008:        switch (deftype) {
                   2009:        case ROFFDEF_USER:
                   2010:                t = ROFF_USERDEF;
                   2011:                break;
                   2012:        case ROFFDEF_REN:
                   2013:                t = ROFF_RENAMED;
                   2014:                break;
                   2015:        default:
                   2016:                t = roffhash_find(r->reqtab, mac, maclen);
                   2017:                break;
                   2018:        }
1.294     schwarze 2019:        if (t != TOKEN_NONE)
1.214     schwarze 2020:                *pos = cp - buf;
1.325     schwarze 2021:        else if (deftype == ROFFDEF_UNDEF) {
                   2022:                /* Using an undefined macro defines it to be empty. */
                   2023:                roff_setstrn(&r->strtab, mac, maclen, "", 0, 0);
                   2024:                roff_setstrn(&r->rentab, mac, maclen, NULL, 0, 0);
                   2025:        }
1.277     schwarze 2026:        return t;
1.67      kristaps 2027: }
                   2028:
1.266     schwarze 2029: /* --- handling of request blocks ----------------------------------------- */
                   2030:
1.375     schwarze 2031: /*
                   2032:  * Close a macro definition block or an "ignore" block.
                   2033:  */
1.340     schwarze 2034: static int
1.76      kristaps 2035: roff_cblock(ROFF_ARGS)
1.67      kristaps 2036: {
1.375     schwarze 2037:        int      rr;
1.79      kristaps 2038:
1.238     schwarze 2039:        if (r->last == NULL) {
1.350     schwarze 2040:                mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, ppos, "..");
1.277     schwarze 2041:                return ROFF_IGN;
1.76      kristaps 2042:        }
1.67      kristaps 2043:
1.81      kristaps 2044:        switch (r->last->tok) {
1.207     schwarze 2045:        case ROFF_am:
                   2046:        case ROFF_ami:
                   2047:        case ROFF_de:
                   2048:        case ROFF_dei:
                   2049:        case ROFF_ig:
1.81      kristaps 2050:                break;
1.375     schwarze 2051:        case ROFF_am1:
                   2052:        case ROFF_de1:
                   2053:                /* Remapped in roff_block(). */
                   2054:                abort();
1.81      kristaps 2055:        default:
1.350     schwarze 2056:                mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, ppos, "..");
1.277     schwarze 2057:                return ROFF_IGN;
1.76      kristaps 2058:        }
1.67      kristaps 2059:
1.375     schwarze 2060:        roffnode_pop(r);
                   2061:        roffnode_cleanscope(r);
                   2062:
                   2063:        /*
                   2064:         * If a conditional block with braces is still open,
                   2065:         * check for "\}" block end markers.
                   2066:         */
                   2067:
                   2068:        if (r->last != NULL && r->last->endspan < 0) {
                   2069:                rr = 1;  /* If arguments follow "\}", warn about them. */
                   2070:                roff_cond_checkend(r, tok, buf, ln, ppos, pos, &rr);
                   2071:        }
                   2072:
1.238     schwarze 2073:        if (buf->buf[pos] != '\0')
1.350     schwarze 2074:                mandoc_msg(MANDOCERR_ARG_SKIP, ln, pos,
1.238     schwarze 2075:                    ".. %s", buf->buf + pos);
1.71      kristaps 2076:
1.277     schwarze 2077:        return ROFF_IGN;
1.67      kristaps 2078: }
                   2079:
1.364     schwarze 2080: /*
                   2081:  * Pop all nodes ending at the end of the current input line.
                   2082:  * Return the number of loops ended.
                   2083:  */
1.340     schwarze 2084: static int
1.76      kristaps 2085: roffnode_cleanscope(struct roff *r)
1.67      kristaps 2086: {
1.340     schwarze 2087:        int inloop;
1.67      kristaps 2088:
1.340     schwarze 2089:        inloop = 0;
1.375     schwarze 2090:        while (r->last != NULL && r->last->endspan > 0) {
1.173     schwarze 2091:                if (--r->last->endspan != 0)
1.76      kristaps 2092:                        break;
1.340     schwarze 2093:                inloop += roffnode_pop(r);
1.76      kristaps 2094:        }
1.340     schwarze 2095:        return inloop;
1.67      kristaps 2096: }
                   2097:
1.364     schwarze 2098: /*
1.375     schwarze 2099:  * Handle the closing "\}" of a conditional block.
1.364     schwarze 2100:  * Apart from generating warnings, this only pops nodes.
                   2101:  * Return the number of loops ended.
                   2102:  */
1.340     schwarze 2103: static int
1.195     schwarze 2104: roff_ccond(struct roff *r, int ln, int ppos)
1.74      kristaps 2105: {
1.76      kristaps 2106:        if (NULL == r->last) {
1.350     schwarze 2107:                mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, ppos, "\\}");
1.340     schwarze 2108:                return 0;
1.76      kristaps 2109:        }
                   2110:
1.82      kristaps 2111:        switch (r->last->tok) {
1.207     schwarze 2112:        case ROFF_el:
                   2113:        case ROFF_ie:
                   2114:        case ROFF_if:
1.340     schwarze 2115:        case ROFF_while:
1.82      kristaps 2116:                break;
                   2117:        default:
1.350     schwarze 2118:                mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, ppos, "\\}");
1.340     schwarze 2119:                return 0;
1.75      kristaps 2120:        }
                   2121:
1.76      kristaps 2122:        if (r->last->endspan > -1) {
1.350     schwarze 2123:                mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, ppos, "\\}");
1.340     schwarze 2124:                return 0;
1.76      kristaps 2125:        }
                   2126:
1.340     schwarze 2127:        return roffnode_pop(r) + roffnode_cleanscope(r);
1.76      kristaps 2128: }
                   2129:
1.340     schwarze 2130: static int
1.80      kristaps 2131: roff_block(ROFF_ARGS)
1.76      kristaps 2132: {
1.315     schwarze 2133:        const char      *name, *value;
                   2134:        char            *call, *cp, *iname, *rname;
                   2135:        size_t           csz, namesz, rsz;
                   2136:        int              deftype;
1.106     kristaps 2137:
1.220     schwarze 2138:        /* Ignore groff compatibility mode for now. */
1.76      kristaps 2139:
1.238     schwarze 2140:        if (tok == ROFF_de1)
1.220     schwarze 2141:                tok = ROFF_de;
1.251     schwarze 2142:        else if (tok == ROFF_dei1)
                   2143:                tok = ROFF_dei;
1.238     schwarze 2144:        else if (tok == ROFF_am1)
1.220     schwarze 2145:                tok = ROFF_am;
1.251     schwarze 2146:        else if (tok == ROFF_ami1)
                   2147:                tok = ROFF_ami;
1.220     schwarze 2148:
                   2149:        /* Parse the macro name argument. */
                   2150:
1.238     schwarze 2151:        cp = buf->buf + pos;
                   2152:        if (tok == ROFF_ig) {
1.220     schwarze 2153:                iname = NULL;
                   2154:                namesz = 0;
                   2155:        } else {
                   2156:                iname = cp;
                   2157:                namesz = roff_getname(r, &cp, ln, ppos);
                   2158:                iname[namesz] = '\0';
                   2159:        }
1.107     kristaps 2160:
1.220     schwarze 2161:        /* Resolve the macro name argument if it is indirect. */
1.107     kristaps 2162:
1.238     schwarze 2163:        if (namesz && (tok == ROFF_dei || tok == ROFF_ami)) {
1.315     schwarze 2164:                deftype = ROFFDEF_USER;
                   2165:                name = roff_getstrn(r, iname, namesz, &deftype);
                   2166:                if (name == NULL) {
1.350     schwarze 2167:                        mandoc_msg(MANDOCERR_STR_UNDEF,
                   2168:                            ln, (int)(iname - buf->buf),
1.220     schwarze 2169:                            "%.*s", (int)namesz, iname);
                   2170:                        namesz = 0;
                   2171:                } else
                   2172:                        namesz = strlen(name);
                   2173:        } else
                   2174:                name = iname;
1.107     kristaps 2175:
1.238     schwarze 2176:        if (namesz == 0 && tok != ROFF_ig) {
1.350     schwarze 2177:                mandoc_msg(MANDOCERR_REQ_EMPTY,
                   2178:                    ln, ppos, "%s", roff_name[tok]);
1.277     schwarze 2179:                return ROFF_IGN;
1.220     schwarze 2180:        }
1.80      kristaps 2181:
1.106     kristaps 2182:        roffnode_push(r, tok, name, ln, ppos);
                   2183:
                   2184:        /*
                   2185:         * At the beginning of a `de' macro, clear the existing string
                   2186:         * with the same name, if there is one.  New content will be
1.193     schwarze 2187:         * appended from roff_block_text() in multiline mode.
1.106     kristaps 2188:         */
1.107     kristaps 2189:
1.311     schwarze 2190:        if (tok == ROFF_de || tok == ROFF_dei) {
1.213     schwarze 2191:                roff_setstrn(&r->strtab, name, namesz, "", 0, 0);
1.311     schwarze 2192:                roff_setstrn(&r->rentab, name, namesz, NULL, 0, 0);
1.315     schwarze 2193:        } else if (tok == ROFF_am || tok == ROFF_ami) {
                   2194:                deftype = ROFFDEF_ANY;
                   2195:                value = roff_getstrn(r, iname, namesz, &deftype);
                   2196:                switch (deftype) {  /* Before appending, ... */
                   2197:                case ROFFDEF_PRE: /* copy predefined to user-defined. */
                   2198:                        roff_setstrn(&r->strtab, name, namesz,
                   2199:                            value, strlen(value), 0);
                   2200:                        break;
                   2201:                case ROFFDEF_REN: /* call original standard macro. */
                   2202:                        csz = mandoc_asprintf(&call, ".%.*s \\$* \\\"\n",
                   2203:                            (int)strlen(value), value);
                   2204:                        roff_setstrn(&r->strtab, name, namesz, call, csz, 0);
                   2205:                        roff_setstrn(&r->rentab, name, namesz, NULL, 0, 0);
                   2206:                        free(call);
                   2207:                        break;
                   2208:                case ROFFDEF_STD:  /* rename and call standard macro. */
                   2209:                        rsz = mandoc_asprintf(&rname, "__%s_renamed", name);
                   2210:                        roff_setstrn(&r->rentab, rname, rsz, name, namesz, 0);
                   2211:                        csz = mandoc_asprintf(&call, ".%.*s \\$* \\\"\n",
                   2212:                            (int)rsz, rname);
                   2213:                        roff_setstrn(&r->strtab, name, namesz, call, csz, 0);
                   2214:                        free(call);
                   2215:                        free(rname);
                   2216:                        break;
                   2217:                default:
                   2218:                        break;
                   2219:                }
1.311     schwarze 2220:        }
1.76      kristaps 2221:
1.238     schwarze 2222:        if (*cp == '\0')
1.277     schwarze 2223:                return ROFF_IGN;
1.78      kristaps 2224:
1.220     schwarze 2225:        /* Get the custom end marker. */
1.107     kristaps 2226:
1.220     schwarze 2227:        iname = cp;
1.213     schwarze 2228:        namesz = roff_getname(r, &cp, ln, ppos);
1.220     schwarze 2229:
                   2230:        /* Resolve the end marker if it is indirect. */
                   2231:
1.238     schwarze 2232:        if (namesz && (tok == ROFF_dei || tok == ROFF_ami)) {
1.315     schwarze 2233:                deftype = ROFFDEF_USER;
                   2234:                name = roff_getstrn(r, iname, namesz, &deftype);
                   2235:                if (name == NULL) {
1.350     schwarze 2236:                        mandoc_msg(MANDOCERR_STR_UNDEF,
                   2237:                            ln, (int)(iname - buf->buf),
1.220     schwarze 2238:                            "%.*s", (int)namesz, iname);
                   2239:                        namesz = 0;
                   2240:                } else
                   2241:                        namesz = strlen(name);
                   2242:        } else
                   2243:                name = iname;
                   2244:
1.213     schwarze 2245:        if (namesz)
                   2246:                r->last->end = mandoc_strndup(name, namesz);
1.78      kristaps 2247:
1.238     schwarze 2248:        if (*cp != '\0')
1.350     schwarze 2249:                mandoc_msg(MANDOCERR_ARG_EXCESS,
1.295     schwarze 2250:                    ln, pos, ".%s ... %s", roff_name[tok], cp);
1.74      kristaps 2251:
1.277     schwarze 2252:        return ROFF_IGN;
1.78      kristaps 2253: }
                   2254:
1.340     schwarze 2255: static int
1.80      kristaps 2256: roff_block_sub(ROFF_ARGS)
1.79      kristaps 2257: {
1.294     schwarze 2258:        enum roff_tok   t;
1.79      kristaps 2259:        int             i, j;
                   2260:
                   2261:        /*
1.385     schwarze 2262:         * If a custom end marker is a user-defined or predefined macro
                   2263:         * or a request, interpret it.
1.79      kristaps 2264:         */
                   2265:
                   2266:        if (r->last->end) {
1.130     kristaps 2267:                for (i = pos, j = 0; r->last->end[j]; j++, i++)
1.238     schwarze 2268:                        if (buf->buf[i] != r->last->end[j])
1.79      kristaps 2269:                                break;
                   2270:
1.238     schwarze 2271:                if (r->last->end[j] == '\0' &&
                   2272:                    (buf->buf[i] == '\0' ||
                   2273:                     buf->buf[i] == ' ' ||
                   2274:                     buf->buf[i] == '\t')) {
1.79      kristaps 2275:                        roffnode_pop(r);
                   2276:                        roffnode_cleanscope(r);
                   2277:
1.238     schwarze 2278:                        while (buf->buf[i] == ' ' || buf->buf[i] == '\t')
1.130     kristaps 2279:                                i++;
                   2280:
                   2281:                        pos = i;
1.238     schwarze 2282:                        if (roff_parse(r, buf->buf, &pos, ln, ppos) !=
1.294     schwarze 2283:                            TOKEN_NONE)
1.277     schwarze 2284:                                return ROFF_RERUN;
                   2285:                        return ROFF_IGN;
1.79      kristaps 2286:                }
                   2287:        }
                   2288:
1.385     schwarze 2289:        /* Handle the standard end marker. */
1.79      kristaps 2290:
1.238     schwarze 2291:        t = roff_parse(r, buf->buf, &pos, ln, ppos);
1.385     schwarze 2292:        if (t == ROFF_cblock)
                   2293:                return roff_cblock(r, t, buf, ln, ppos, pos, offs);
1.79      kristaps 2294:
1.385     schwarze 2295:        /* Not an end marker, so append the line to the block. */
1.79      kristaps 2296:
1.385     schwarze 2297:        if (tok != ROFF_ig)
                   2298:                roff_setstr(r, r->last->name, buf->buf + ppos, 2);
                   2299:        return ROFF_IGN;
1.79      kristaps 2300: }
                   2301:
1.340     schwarze 2302: static int
1.80      kristaps 2303: roff_block_text(ROFF_ARGS)
1.78      kristaps 2304: {
                   2305:
1.238     schwarze 2306:        if (tok != ROFF_ig)
                   2307:                roff_setstr(r, r->last->name, buf->buf + pos, 2);
1.106     kristaps 2308:
1.277     schwarze 2309:        return ROFF_IGN;
1.78      kristaps 2310: }
                   2311:
1.375     schwarze 2312: /*
                   2313:  * Check for a closing "\}" and handle it.
                   2314:  * In this function, the final "int *offs" argument is used for
                   2315:  * different purposes than elsewhere:
                   2316:  * Input: *offs == 0: caller wants to discard arguments following \}
                   2317:  *        *offs == 1: caller wants to preserve text following \}
                   2318:  * Output: *offs = 0: tell caller to discard input line
                   2319:  *         *offs = 1: tell caller to use input line
                   2320:  */
1.340     schwarze 2321: static int
1.375     schwarze 2322: roff_cond_checkend(ROFF_ARGS)
1.82      kristaps 2323: {
1.340     schwarze 2324:        char            *ep;
                   2325:        int              endloop, irc, rr;
1.82      kristaps 2326:
1.340     schwarze 2327:        irc = ROFF_IGN;
1.82      kristaps 2328:        rr = r->last->rule;
1.340     schwarze 2329:        endloop = tok != ROFF_while ? ROFF_IGN :
                   2330:            rr ? ROFF_LOOPCONT : ROFF_LOOPEXIT;
                   2331:        if (roffnode_cleanscope(r))
                   2332:                irc |= endloop;
1.144     kristaps 2333:
1.196     schwarze 2334:        /*
1.375     schwarze 2335:         * If "\}" occurs on a macro line without a preceding macro or
                   2336:         * a text line contains nothing else, drop the line completely.
1.196     schwarze 2337:         */
                   2338:
1.238     schwarze 2339:        ep = buf->buf + pos;
1.375     schwarze 2340:        if (ep[0] == '\\' && ep[1] == '}' && (ep[2] == '\0' || *offs == 0))
1.198     schwarze 2341:                rr = 0;
1.196     schwarze 2342:
1.343     schwarze 2343:        /*
1.375     schwarze 2344:         * The closing delimiter "\}" rewinds the conditional scope
1.343     schwarze 2345:         * but is otherwise ignored when interpreting the line.
                   2346:         */
1.144     kristaps 2347:
1.238     schwarze 2348:        while ((ep = strchr(ep, '\\')) != NULL) {
1.318     schwarze 2349:                switch (ep[1]) {
                   2350:                case '}':
1.376     schwarze 2351:                        if (ep[2] == '\0')
                   2352:                                ep[0] = '\0';
                   2353:                        else if (rr)
1.375     schwarze 2354:                                ep[1] = '&';
                   2355:                        else
                   2356:                                memmove(ep, ep + 2, strlen(ep + 2) + 1);
1.340     schwarze 2357:                        if (roff_ccond(r, ln, ep - buf->buf))
                   2358:                                irc |= endloop;
1.318     schwarze 2359:                        break;
                   2360:                case '\0':
                   2361:                        ++ep;
                   2362:                        break;
                   2363:                default:
                   2364:                        ep += 2;
                   2365:                        break;
1.197     schwarze 2366:                }
1.177     schwarze 2367:        }
1.375     schwarze 2368:        *offs = rr;
                   2369:        return irc;
                   2370: }
1.318     schwarze 2371:
1.375     schwarze 2372: /*
                   2373:  * Parse and process a request or macro line in conditional scope.
                   2374:  */
                   2375: static int
                   2376: roff_cond_sub(ROFF_ARGS)
                   2377: {
                   2378:        struct roffnode *bl;
1.386     schwarze 2379:        int              irc, rr, spos;
1.375     schwarze 2380:        enum roff_tok    t;
                   2381:
                   2382:        rr = 0;  /* If arguments follow "\}", skip them. */
                   2383:        irc = roff_cond_checkend(r, tok, buf, ln, ppos, pos, &rr);
1.386     schwarze 2384:        spos = pos;
1.368     schwarze 2385:        t = roff_parse(r, buf->buf, &pos, ln, ppos);
                   2386:
1.318     schwarze 2387:        /*
1.386     schwarze 2388:         * Handle requests and macros if the conditional evaluated
                   2389:         * to true or if they are structurally required.
                   2390:         * The .break request is always handled specially.
1.318     schwarze 2391:         */
                   2392:
1.364     schwarze 2393:        if (t == ROFF_break) {
                   2394:                if (irc & ROFF_LOOPMASK)
                   2395:                        irc = ROFF_IGN | ROFF_LOOPEXIT;
                   2396:                else if (rr) {
                   2397:                        for (bl = r->last; bl != NULL; bl = bl->parent) {
                   2398:                                bl->rule = 0;
                   2399:                                if (bl->tok == ROFF_while)
                   2400:                                        break;
                   2401:                        }
                   2402:                }
1.386     schwarze 2403:        } else if (rr || (t < TOKEN_NONE && roffs[t].flags & ROFFMAC_STRUCT)) {
                   2404:                irc |= roff_req_or_macro(r, t, buf, ln, spos, pos, offs);
1.383     schwarze 2405:                if (irc & ROFF_WHILE)
                   2406:                        irc &= ~(ROFF_LOOPCONT | ROFF_LOOPEXIT);
1.386     schwarze 2407:        }
1.340     schwarze 2408:        return irc;
1.82      kristaps 2409: }
                   2410:
1.375     schwarze 2411: /*
                   2412:  * Parse and process a text line in conditional scope.
                   2413:  */
1.340     schwarze 2414: static int
1.82      kristaps 2415: roff_cond_text(ROFF_ARGS)
1.78      kristaps 2416: {
1.375     schwarze 2417:        int      irc, rr;
1.343     schwarze 2418:
1.375     schwarze 2419:        rr = 1;  /* If arguments follow "\}", preserve them. */
                   2420:        irc = roff_cond_checkend(r, tok, buf, ln, ppos, pos, &rr);
1.340     schwarze 2421:        if (rr)
                   2422:                irc |= ROFF_CONT;
                   2423:        return irc;
1.74      kristaps 2424: }
                   2425:
1.266     schwarze 2426: /* --- handling of numeric and conditional expressions -------------------- */
                   2427:
1.204     schwarze 2428: /*
                   2429:  * Parse a single signed integer number.  Stop at the first non-digit.
                   2430:  * If there is at least one digit, return success and advance the
                   2431:  * parse point, else return failure and let the parse point unchanged.
                   2432:  * Ignore overflows, treat them just like the C language.
                   2433:  */
1.184     schwarze 2434: static int
1.261     schwarze 2435: roff_getnum(const char *v, int *pos, int *res, int flags)
1.184     schwarze 2436: {
1.261     schwarze 2437:        int      myres, scaled, n, p;
1.206     schwarze 2438:
                   2439:        if (NULL == res)
                   2440:                res = &myres;
1.184     schwarze 2441:
                   2442:        p = *pos;
                   2443:        n = v[p] == '-';
1.261     schwarze 2444:        if (n || v[p] == '+')
1.184     schwarze 2445:                p++;
                   2446:
1.261     schwarze 2447:        if (flags & ROFFNUM_WHITE)
                   2448:                while (isspace((unsigned char)v[p]))
                   2449:                        p++;
                   2450:
1.184     schwarze 2451:        for (*res = 0; isdigit((unsigned char)v[p]); p++)
1.204     schwarze 2452:                *res = 10 * *res + v[p] - '0';
1.184     schwarze 2453:        if (p == *pos + n)
                   2454:                return 0;
                   2455:
                   2456:        if (n)
                   2457:                *res = -*res;
                   2458:
1.254     schwarze 2459:        /* Each number may be followed by one optional scaling unit. */
                   2460:
                   2461:        switch (v[p]) {
                   2462:        case 'f':
1.261     schwarze 2463:                scaled = *res * 65536;
1.254     schwarze 2464:                break;
                   2465:        case 'i':
1.261     schwarze 2466:                scaled = *res * 240;
1.254     schwarze 2467:                break;
                   2468:        case 'c':
1.261     schwarze 2469:                scaled = *res * 240 / 2.54;
1.254     schwarze 2470:                break;
                   2471:        case 'v':
                   2472:        case 'P':
1.261     schwarze 2473:                scaled = *res * 40;
1.254     schwarze 2474:                break;
                   2475:        case 'm':
                   2476:        case 'n':
1.261     schwarze 2477:                scaled = *res * 24;
1.254     schwarze 2478:                break;
                   2479:        case 'p':
1.261     schwarze 2480:                scaled = *res * 10 / 3;
1.254     schwarze 2481:                break;
                   2482:        case 'u':
1.261     schwarze 2483:                scaled = *res;
1.254     schwarze 2484:                break;
                   2485:        case 'M':
1.261     schwarze 2486:                scaled = *res * 6 / 25;
1.254     schwarze 2487:                break;
                   2488:        default:
1.261     schwarze 2489:                scaled = *res;
1.254     schwarze 2490:                p--;
                   2491:                break;
                   2492:        }
1.261     schwarze 2493:        if (flags & ROFFNUM_SCALE)
                   2494:                *res = scaled;
1.254     schwarze 2495:
                   2496:        *pos = p + 1;
1.277     schwarze 2497:        return 1;
1.184     schwarze 2498: }
                   2499:
1.198     schwarze 2500: /*
                   2501:  * Evaluate a string comparison condition.
                   2502:  * The first character is the delimiter.
                   2503:  * Succeed if the string up to its second occurrence
1.396     schwarze 2504:  * matches the string up to its third occurrence.
1.198     schwarze 2505:  * Advance the cursor after the third occurrence
                   2506:  * or lacking that, to the end of the line.
                   2507:  */
                   2508: static int
                   2509: roff_evalstrcond(const char *v, int *pos)
                   2510: {
                   2511:        const char      *s1, *s2, *s3;
                   2512:        int              match;
                   2513:
                   2514:        match = 0;
                   2515:        s1 = v + *pos;          /* initial delimiter */
                   2516:        s2 = s1 + 1;            /* for scanning the first string */
                   2517:        s3 = strchr(s2, *s1);   /* for scanning the second string */
                   2518:
                   2519:        if (NULL == s3)         /* found no middle delimiter */
                   2520:                goto out;
                   2521:
                   2522:        while ('\0' != *++s3) {
                   2523:                if (*s2 != *s3) {  /* mismatch */
                   2524:                        s3 = strchr(s3, *s1);
                   2525:                        break;
                   2526:                }
                   2527:                if (*s3 == *s1) {  /* found the final delimiter */
                   2528:                        match = 1;
                   2529:                        break;
                   2530:                }
                   2531:                s2++;
                   2532:        }
                   2533:
                   2534: out:
                   2535:        if (NULL == s3)
                   2536:                s3 = strchr(s2, '\0');
1.242     schwarze 2537:        else if (*s3 != '\0')
1.198     schwarze 2538:                s3++;
                   2539:        *pos = s3 - v;
1.277     schwarze 2540:        return match;
1.198     schwarze 2541: }
                   2542:
1.204     schwarze 2543: /*
                   2544:  * Evaluate an optionally negated single character, numerical,
                   2545:  * or string condition.
                   2546:  */
1.198     schwarze 2547: static int
1.271     schwarze 2548: roff_evalcond(struct roff *r, int ln, char *v, int *pos)
1.88      kristaps 2549: {
1.336     schwarze 2550:        const char      *start, *end;
                   2551:        char            *cp, *name;
                   2552:        size_t           sz;
                   2553:        int              deftype, len, number, savepos, istrue, wanttrue;
1.88      kristaps 2554:
1.198     schwarze 2555:        if ('!' == v[*pos]) {
                   2556:                wanttrue = 0;
                   2557:                (*pos)++;
                   2558:        } else
                   2559:                wanttrue = 1;
                   2560:
1.88      kristaps 2561:        switch (v[*pos]) {
1.240     schwarze 2562:        case '\0':
1.277     schwarze 2563:                return 0;
1.207     schwarze 2564:        case 'n':
                   2565:        case 'o':
1.88      kristaps 2566:                (*pos)++;
1.277     schwarze 2567:                return wanttrue;
1.207     schwarze 2568:        case 'e':
                   2569:        case 't':
1.239     schwarze 2570:        case 'v':
1.88      kristaps 2571:                (*pos)++;
1.277     schwarze 2572:                return !wanttrue;
1.336     schwarze 2573:        case 'c':
                   2574:                do {
                   2575:                        (*pos)++;
                   2576:                } while (v[*pos] == ' ');
                   2577:
                   2578:                /*
                   2579:                 * Quirk for groff compatibility:
                   2580:                 * The horizontal tab is neither available nor unavailable.
                   2581:                 */
                   2582:
                   2583:                if (v[*pos] == '\t') {
                   2584:                        (*pos)++;
                   2585:                        return 0;
                   2586:                }
                   2587:
                   2588:                /* Printable ASCII characters are available. */
                   2589:
                   2590:                if (v[*pos] != '\\') {
                   2591:                        (*pos)++;
                   2592:                        return wanttrue;
                   2593:                }
                   2594:
                   2595:                end = v + ++*pos;
                   2596:                switch (mandoc_escape(&end, &start, &len)) {
                   2597:                case ESCAPE_SPECIAL:
                   2598:                        istrue = mchars_spec2cp(start, len) != -1;
                   2599:                        break;
                   2600:                case ESCAPE_UNICODE:
                   2601:                        istrue = 1;
                   2602:                        break;
                   2603:                case ESCAPE_NUMBERED:
                   2604:                        istrue = mchars_num2char(start, len) != -1;
                   2605:                        break;
                   2606:                default:
                   2607:                        istrue = !wanttrue;
                   2608:                        break;
                   2609:                }
                   2610:                *pos = end - v;
                   2611:                return istrue == wanttrue;
1.310     schwarze 2612:        case 'd':
1.271     schwarze 2613:        case 'r':
1.310     schwarze 2614:                cp = v + *pos + 1;
                   2615:                while (*cp == ' ')
                   2616:                        cp++;
                   2617:                name = cp;
                   2618:                sz = roff_getname(r, &cp, ln, cp - v);
1.315     schwarze 2619:                if (sz == 0)
                   2620:                        istrue = 0;
                   2621:                else if (v[*pos] == 'r')
                   2622:                        istrue = roff_hasregn(r, name, sz);
                   2623:                else {
                   2624:                        deftype = ROFFDEF_ANY;
                   2625:                        roff_getstrn(r, name, sz, &deftype);
                   2626:                        istrue = !!deftype;
                   2627:                }
1.363     schwarze 2628:                *pos = (name + sz) - v;
1.310     schwarze 2629:                return istrue == wanttrue;
1.88      kristaps 2630:        default:
                   2631:                break;
                   2632:        }
                   2633:
1.241     schwarze 2634:        savepos = *pos;
1.261     schwarze 2635:        if (roff_evalnum(r, ln, v, pos, &number, ROFFNUM_SCALE))
1.277     schwarze 2636:                return (number > 0) == wanttrue;
1.241     schwarze 2637:        else if (*pos == savepos)
1.277     schwarze 2638:                return roff_evalstrcond(v, pos) == wanttrue;
1.204     schwarze 2639:        else
1.277     schwarze 2640:                return 0;
1.88      kristaps 2641: }
                   2642:
1.340     schwarze 2643: static int
1.103     kristaps 2644: roff_line_ignore(ROFF_ARGS)
1.89      kristaps 2645: {
1.123     schwarze 2646:
1.277     schwarze 2647:        return ROFF_IGN;
1.89      kristaps 2648: }
                   2649:
1.340     schwarze 2650: static int
1.251     schwarze 2651: roff_insec(ROFF_ARGS)
                   2652: {
                   2653:
1.350     schwarze 2654:        mandoc_msg(MANDOCERR_REQ_INSEC, ln, ppos, "%s", roff_name[tok]);
1.277     schwarze 2655:        return ROFF_IGN;
1.251     schwarze 2656: }
                   2657:
1.340     schwarze 2658: static int
1.251     schwarze 2659: roff_unsupp(ROFF_ARGS)
                   2660: {
                   2661:
1.350     schwarze 2662:        mandoc_msg(MANDOCERR_REQ_UNSUPP, ln, ppos, "%s", roff_name[tok]);
1.277     schwarze 2663:        return ROFF_IGN;
1.251     schwarze 2664: }
                   2665:
1.340     schwarze 2666: static int
1.82      kristaps 2667: roff_cond(ROFF_ARGS)
1.74      kristaps 2668: {
1.340     schwarze 2669:        int      irc;
1.173     schwarze 2670:
                   2671:        roffnode_push(r, tok, NULL, ln, ppos);
1.74      kristaps 2672:
1.207     schwarze 2673:        /*
1.134     kristaps 2674:         * An `.el' has no conditional body: it will consume the value
                   2675:         * of the current rstack entry set in prior `ie' calls or
1.207     schwarze 2676:         * defaults to DENY.
1.134     kristaps 2677:         *
                   2678:         * If we're not an `el', however, then evaluate the conditional.
                   2679:         */
1.133     kristaps 2680:
1.238     schwarze 2681:        r->last->rule = tok == ROFF_el ?
1.207     schwarze 2682:            (r->rstackpos < 0 ? 0 : r->rstack[r->rstackpos--]) :
1.238     schwarze 2683:            roff_evalcond(r, ln, buf->buf, &pos);
1.77      kristaps 2684:
1.134     kristaps 2685:        /*
                   2686:         * An if-else will put the NEGATION of the current evaluated
                   2687:         * conditional into the stack of rules.
                   2688:         */
                   2689:
1.238     schwarze 2690:        if (tok == ROFF_ie) {
1.223     schwarze 2691:                if (r->rstackpos + 1 == r->rstacksz) {
                   2692:                        r->rstacksz += 16;
                   2693:                        r->rstack = mandoc_reallocarray(r->rstack,
                   2694:                            r->rstacksz, sizeof(int));
1.134     kristaps 2695:                }
1.198     schwarze 2696:                r->rstack[++r->rstackpos] = !r->last->rule;
1.82      kristaps 2697:        }
1.88      kristaps 2698:
                   2699:        /* If the parent has false as its rule, then so do we. */
                   2700:
1.198     schwarze 2701:        if (r->last->parent && !r->last->parent->rule)
                   2702:                r->last->rule = 0;
1.88      kristaps 2703:
                   2704:        /*
1.173     schwarze 2705:         * Determine scope.
                   2706:         * If there is nothing on the line after the conditional,
                   2707:         * not even whitespace, use next-line scope.
1.340     schwarze 2708:         * Except that .while does not support next-line scope.
1.88      kristaps 2709:         */
1.74      kristaps 2710:
1.340     schwarze 2711:        if (buf->buf[pos] == '\0' && tok != ROFF_while) {
1.173     schwarze 2712:                r->last->endspan = 2;
                   2713:                goto out;
                   2714:        }
                   2715:
1.238     schwarze 2716:        while (buf->buf[pos] == ' ')
1.173     schwarze 2717:                pos++;
                   2718:
                   2719:        /* An opening brace requests multiline scope. */
1.75      kristaps 2720:
1.238     schwarze 2721:        if (buf->buf[pos] == '\\' && buf->buf[pos + 1] == '{') {
1.75      kristaps 2722:                r->last->endspan = -1;
                   2723:                pos += 2;
1.272     schwarze 2724:                while (buf->buf[pos] == ' ')
                   2725:                        pos++;
1.173     schwarze 2726:                goto out;
1.207     schwarze 2727:        }
1.74      kristaps 2728:
1.77      kristaps 2729:        /*
1.173     schwarze 2730:         * Anything else following the conditional causes
                   2731:         * single-line scope.  Warn if the scope contains
                   2732:         * nothing but trailing whitespace.
1.77      kristaps 2733:         */
                   2734:
1.238     schwarze 2735:        if (buf->buf[pos] == '\0')
1.350     schwarze 2736:                mandoc_msg(MANDOCERR_COND_EMPTY,
                   2737:                    ln, ppos, "%s", roff_name[tok]);
1.77      kristaps 2738:
1.173     schwarze 2739:        r->last->endspan = 1;
1.74      kristaps 2740:
1.173     schwarze 2741: out:
1.75      kristaps 2742:        *offs = pos;
1.340     schwarze 2743:        irc = ROFF_RERUN;
                   2744:        if (tok == ROFF_while)
                   2745:                irc |= ROFF_WHILE;
                   2746:        return irc;
1.83      schwarze 2747: }
                   2748:
1.340     schwarze 2749: static int
1.92      schwarze 2750: roff_ds(ROFF_ARGS)
                   2751: {
1.212     schwarze 2752:        char            *string;
                   2753:        const char      *name;
                   2754:        size_t           namesz;
1.96      kristaps 2755:
1.251     schwarze 2756:        /* Ignore groff compatibility mode for now. */
                   2757:
                   2758:        if (tok == ROFF_ds1)
                   2759:                tok = ROFF_ds;
                   2760:        else if (tok == ROFF_as1)
                   2761:                tok = ROFF_as;
                   2762:
1.96      kristaps 2763:        /*
1.212     schwarze 2764:         * The first word is the name of the string.
                   2765:         * If it is empty or terminated by an escape sequence,
                   2766:         * abort the `ds' request without defining anything.
1.96      kristaps 2767:         */
1.92      schwarze 2768:
1.238     schwarze 2769:        name = string = buf->buf + pos;
                   2770:        if (*name == '\0')
1.277     schwarze 2771:                return ROFF_IGN;
1.92      schwarze 2772:
1.212     schwarze 2773:        namesz = roff_getname(r, &string, ln, pos);
1.363     schwarze 2774:        switch (name[namesz]) {
                   2775:        case '\\':
1.277     schwarze 2776:                return ROFF_IGN;
1.363     schwarze 2777:        case '\t':
                   2778:                string = buf->buf + pos + namesz;
                   2779:                break;
                   2780:        default:
                   2781:                break;
                   2782:        }
1.212     schwarze 2783:
                   2784:        /* Read past the initial double-quote, if any. */
1.238     schwarze 2785:        if (*string == '"')
1.92      schwarze 2786:                string++;
                   2787:
1.96      kristaps 2788:        /* The rest is the value. */
1.212     schwarze 2789:        roff_setstrn(&r->strtab, name, namesz, string, strlen(string),
                   2790:            ROFF_as == tok);
1.311     schwarze 2791:        roff_setstrn(&r->rentab, name, namesz, NULL, 0, 0);
1.277     schwarze 2792:        return ROFF_IGN;
1.92      schwarze 2793: }
                   2794:
1.204     schwarze 2795: /*
                   2796:  * Parse a single operator, one or two characters long.
                   2797:  * If the operator is recognized, return success and advance the
                   2798:  * parse point, else return failure and let the parse point unchanged.
                   2799:  */
                   2800: static int
                   2801: roff_getop(const char *v, int *pos, char *res)
                   2802: {
                   2803:
                   2804:        *res = v[*pos];
                   2805:
                   2806:        switch (*res) {
1.207     schwarze 2807:        case '+':
                   2808:        case '-':
                   2809:        case '*':
                   2810:        case '/':
                   2811:        case '%':
                   2812:        case '&':
                   2813:        case ':':
1.204     schwarze 2814:                break;
                   2815:        case '<':
                   2816:                switch (v[*pos + 1]) {
1.207     schwarze 2817:                case '=':
1.204     schwarze 2818:                        *res = 'l';
                   2819:                        (*pos)++;
                   2820:                        break;
1.207     schwarze 2821:                case '>':
1.204     schwarze 2822:                        *res = '!';
                   2823:                        (*pos)++;
                   2824:                        break;
1.207     schwarze 2825:                case '?':
1.204     schwarze 2826:                        *res = 'i';
                   2827:                        (*pos)++;
                   2828:                        break;
                   2829:                default:
                   2830:                        break;
                   2831:                }
                   2832:                break;
                   2833:        case '>':
                   2834:                switch (v[*pos + 1]) {
1.207     schwarze 2835:                case '=':
1.204     schwarze 2836:                        *res = 'g';
                   2837:                        (*pos)++;
                   2838:                        break;
1.207     schwarze 2839:                case '?':
1.204     schwarze 2840:                        *res = 'a';
                   2841:                        (*pos)++;
                   2842:                        break;
                   2843:                default:
                   2844:                        break;
                   2845:                }
                   2846:                break;
                   2847:        case '=':
                   2848:                if ('=' == v[*pos + 1])
                   2849:                        (*pos)++;
                   2850:                break;
                   2851:        default:
1.277     schwarze 2852:                return 0;
1.204     schwarze 2853:        }
                   2854:        (*pos)++;
                   2855:
1.277     schwarze 2856:        return *res;
1.204     schwarze 2857: }
                   2858:
                   2859: /*
                   2860:  * Evaluate either a parenthesized numeric expression
                   2861:  * or a single signed integer number.
                   2862:  */
                   2863: static int
1.235     schwarze 2864: roff_evalpar(struct roff *r, int ln,
1.261     schwarze 2865:        const char *v, int *pos, int *res, int flags)
1.204     schwarze 2866: {
                   2867:
                   2868:        if ('(' != v[*pos])
1.277     schwarze 2869:                return roff_getnum(v, pos, res, flags);
1.204     schwarze 2870:
                   2871:        (*pos)++;
1.261     schwarze 2872:        if ( ! roff_evalnum(r, ln, v, pos, res, flags | ROFFNUM_WHITE))
1.277     schwarze 2873:                return 0;
1.204     schwarze 2874:
1.206     schwarze 2875:        /*
                   2876:         * Omission of the closing parenthesis
                   2877:         * is an error in validation mode,
                   2878:         * but ignored in evaluation mode.
                   2879:         */
                   2880:
1.204     schwarze 2881:        if (')' == v[*pos])
                   2882:                (*pos)++;
1.206     schwarze 2883:        else if (NULL == res)
1.277     schwarze 2884:                return 0;
1.204     schwarze 2885:
1.277     schwarze 2886:        return 1;
1.204     schwarze 2887: }
                   2888:
                   2889: /*
                   2890:  * Evaluate a complete numeric expression.
                   2891:  * Proceed left to right, there is no concept of precedence.
                   2892:  */
                   2893: static int
1.235     schwarze 2894: roff_evalnum(struct roff *r, int ln, const char *v,
1.261     schwarze 2895:        int *pos, int *res, int flags)
1.204     schwarze 2896: {
                   2897:        int              mypos, operand2;
                   2898:        char             operator;
                   2899:
                   2900:        if (NULL == pos) {
                   2901:                mypos = 0;
                   2902:                pos = &mypos;
                   2903:        }
                   2904:
1.261     schwarze 2905:        if (flags & ROFFNUM_WHITE)
1.204     schwarze 2906:                while (isspace((unsigned char)v[*pos]))
                   2907:                        (*pos)++;
                   2908:
1.261     schwarze 2909:        if ( ! roff_evalpar(r, ln, v, pos, res, flags))
1.277     schwarze 2910:                return 0;
1.204     schwarze 2911:
                   2912:        while (1) {
1.261     schwarze 2913:                if (flags & ROFFNUM_WHITE)
1.204     schwarze 2914:                        while (isspace((unsigned char)v[*pos]))
                   2915:                                (*pos)++;
                   2916:
                   2917:                if ( ! roff_getop(v, pos, &operator))
                   2918:                        break;
                   2919:
1.261     schwarze 2920:                if (flags & ROFFNUM_WHITE)
1.204     schwarze 2921:                        while (isspace((unsigned char)v[*pos]))
                   2922:                                (*pos)++;
                   2923:
1.261     schwarze 2924:                if ( ! roff_evalpar(r, ln, v, pos, &operand2, flags))
1.277     schwarze 2925:                        return 0;
1.204     schwarze 2926:
1.261     schwarze 2927:                if (flags & ROFFNUM_WHITE)
1.204     schwarze 2928:                        while (isspace((unsigned char)v[*pos]))
                   2929:                                (*pos)++;
1.206     schwarze 2930:
                   2931:                if (NULL == res)
                   2932:                        continue;
1.204     schwarze 2933:
                   2934:                switch (operator) {
1.207     schwarze 2935:                case '+':
1.204     schwarze 2936:                        *res += operand2;
                   2937:                        break;
1.207     schwarze 2938:                case '-':
1.204     schwarze 2939:                        *res -= operand2;
                   2940:                        break;
1.207     schwarze 2941:                case '*':
1.204     schwarze 2942:                        *res *= operand2;
                   2943:                        break;
1.207     schwarze 2944:                case '/':
1.244     schwarze 2945:                        if (operand2 == 0) {
1.235     schwarze 2946:                                mandoc_msg(MANDOCERR_DIVZERO,
1.350     schwarze 2947:                                        ln, *pos, "%s", v);
1.234     kristaps 2948:                                *res = 0;
                   2949:                                break;
                   2950:                        }
1.204     schwarze 2951:                        *res /= operand2;
                   2952:                        break;
1.207     schwarze 2953:                case '%':
1.244     schwarze 2954:                        if (operand2 == 0) {
                   2955:                                mandoc_msg(MANDOCERR_DIVZERO,
1.350     schwarze 2956:                                        ln, *pos, "%s", v);
1.244     schwarze 2957:                                *res = 0;
                   2958:                                break;
                   2959:                        }
1.204     schwarze 2960:                        *res %= operand2;
                   2961:                        break;
1.207     schwarze 2962:                case '<':
1.204     schwarze 2963:                        *res = *res < operand2;
                   2964:                        break;
1.207     schwarze 2965:                case '>':
1.204     schwarze 2966:                        *res = *res > operand2;
                   2967:                        break;
1.207     schwarze 2968:                case 'l':
1.204     schwarze 2969:                        *res = *res <= operand2;
                   2970:                        break;
1.207     schwarze 2971:                case 'g':
1.204     schwarze 2972:                        *res = *res >= operand2;
                   2973:                        break;
1.207     schwarze 2974:                case '=':
1.204     schwarze 2975:                        *res = *res == operand2;
                   2976:                        break;
1.207     schwarze 2977:                case '!':
1.204     schwarze 2978:                        *res = *res != operand2;
                   2979:                        break;
1.207     schwarze 2980:                case '&':
1.204     schwarze 2981:                        *res = *res && operand2;
                   2982:                        break;
1.207     schwarze 2983:                case ':':
1.204     schwarze 2984:                        *res = *res || operand2;
                   2985:                        break;
1.207     schwarze 2986:                case 'i':
1.204     schwarze 2987:                        if (operand2 < *res)
                   2988:                                *res = operand2;
                   2989:                        break;
1.207     schwarze 2990:                case 'a':
1.204     schwarze 2991:                        if (operand2 > *res)
                   2992:                                *res = operand2;
                   2993:                        break;
                   2994:                default:
                   2995:                        abort();
                   2996:                }
                   2997:        }
1.277     schwarze 2998:        return 1;
1.204     schwarze 2999: }
                   3000:
1.266     schwarze 3001: /* --- register management ------------------------------------------------ */
                   3002:
1.180     schwarze 3003: void
1.187     schwarze 3004: roff_setreg(struct roff *r, const char *name, int val, char sign)
1.147     kristaps 3005: {
1.327     schwarze 3006:        roff_setregn(r, name, strlen(name), val, sign, INT_MIN);
1.326     schwarze 3007: }
                   3008:
                   3009: static void
                   3010: roff_setregn(struct roff *r, const char *name, size_t len,
1.327     schwarze 3011:     int val, char sign, int step)
1.326     schwarze 3012: {
1.180     schwarze 3013:        struct roffreg  *reg;
                   3014:
                   3015:        /* Search for an existing register with the same name. */
                   3016:        reg = r->regtab;
                   3017:
1.326     schwarze 3018:        while (reg != NULL && (reg->key.sz != len ||
                   3019:            strncmp(reg->key.p, name, len) != 0))
1.180     schwarze 3020:                reg = reg->next;
1.147     kristaps 3021:
1.180     schwarze 3022:        if (NULL == reg) {
                   3023:                /* Create a new register. */
                   3024:                reg = mandoc_malloc(sizeof(struct roffreg));
1.326     schwarze 3025:                reg->key.p = mandoc_strndup(name, len);
                   3026:                reg->key.sz = len;
1.187     schwarze 3027:                reg->val = 0;
1.327     schwarze 3028:                reg->step = 0;
1.180     schwarze 3029:                reg->next = r->regtab;
                   3030:                r->regtab = reg;
                   3031:        }
                   3032:
1.187     schwarze 3033:        if ('+' == sign)
                   3034:                reg->val += val;
                   3035:        else if ('-' == sign)
                   3036:                reg->val -= val;
                   3037:        else
                   3038:                reg->val = val;
1.327     schwarze 3039:        if (step != INT_MIN)
                   3040:                reg->step = step;
1.147     kristaps 3041: }
                   3042:
1.192     schwarze 3043: /*
                   3044:  * Handle some predefined read-only number registers.
                   3045:  * For now, return -1 if the requested register is not predefined;
                   3046:  * in case a predefined read-only register having the value -1
                   3047:  * were to turn up, another special value would have to be chosen.
                   3048:  */
                   3049: static int
1.273     schwarze 3050: roff_getregro(const struct roff *r, const char *name)
1.192     schwarze 3051: {
                   3052:
                   3053:        switch (*name) {
1.273     schwarze 3054:        case '$':  /* Number of arguments of the last macro evaluated. */
1.339     schwarze 3055:                return r->mstackpos < 0 ? 0 : r->mstack[r->mstackpos].argc;
1.207     schwarze 3056:        case 'A':  /* ASCII approximation mode is always off. */
1.277     schwarze 3057:                return 0;
1.207     schwarze 3058:        case 'g':  /* Groff compatibility mode is always on. */
1.277     schwarze 3059:                return 1;
1.207     schwarze 3060:        case 'H':  /* Fixed horizontal resolution. */
1.277     schwarze 3061:                return 24;
1.207     schwarze 3062:        case 'j':  /* Always adjust left margin only. */
1.277     schwarze 3063:                return 0;
1.207     schwarze 3064:        case 'T':  /* Some output device is always defined. */
1.277     schwarze 3065:                return 1;
1.207     schwarze 3066:        case 'V':  /* Fixed vertical resolution. */
1.277     schwarze 3067:                return 40;
1.192     schwarze 3068:        default:
1.277     schwarze 3069:                return -1;
1.192     schwarze 3070:        }
                   3071: }
                   3072:
1.181     schwarze 3073: int
1.326     schwarze 3074: roff_getreg(struct roff *r, const char *name)
1.147     kristaps 3075: {
1.327     schwarze 3076:        return roff_getregn(r, name, strlen(name), '\0');
1.181     schwarze 3077: }
                   3078:
                   3079: static int
1.327     schwarze 3080: roff_getregn(struct roff *r, const char *name, size_t len, char sign)
1.181     schwarze 3081: {
                   3082:        struct roffreg  *reg;
1.192     schwarze 3083:        int              val;
                   3084:
                   3085:        if ('.' == name[0] && 2 == len) {
1.273     schwarze 3086:                val = roff_getregro(r, name + 1);
1.192     schwarze 3087:                if (-1 != val)
1.277     schwarze 3088:                        return val;
1.192     schwarze 3089:        }
1.181     schwarze 3090:
1.327     schwarze 3091:        for (reg = r->regtab; reg; reg = reg->next) {
1.181     schwarze 3092:                if (len == reg->key.sz &&
1.327     schwarze 3093:                    0 == strncmp(name, reg->key.p, len)) {
                   3094:                        switch (sign) {
                   3095:                        case '+':
                   3096:                                reg->val += reg->step;
                   3097:                                break;
                   3098:                        case '-':
                   3099:                                reg->val -= reg->step;
                   3100:                                break;
                   3101:                        default:
                   3102:                                break;
                   3103:                        }
1.277     schwarze 3104:                        return reg->val;
1.327     schwarze 3105:                }
                   3106:        }
1.271     schwarze 3107:
1.327     schwarze 3108:        roff_setregn(r, name, len, 0, '\0', INT_MIN);
1.277     schwarze 3109:        return 0;
1.271     schwarze 3110: }
                   3111:
                   3112: static int
                   3113: roff_hasregn(const struct roff *r, const char *name, size_t len)
                   3114: {
                   3115:        struct roffreg  *reg;
                   3116:        int              val;
                   3117:
                   3118:        if ('.' == name[0] && 2 == len) {
1.273     schwarze 3119:                val = roff_getregro(r, name + 1);
1.271     schwarze 3120:                if (-1 != val)
1.277     schwarze 3121:                        return 1;
1.271     schwarze 3122:        }
                   3123:
                   3124:        for (reg = r->regtab; reg; reg = reg->next)
                   3125:                if (len == reg->key.sz &&
                   3126:                    0 == strncmp(name, reg->key.p, len))
1.277     schwarze 3127:                        return 1;
1.147     kristaps 3128:
1.277     schwarze 3129:        return 0;
1.147     kristaps 3130: }
                   3131:
1.180     schwarze 3132: static void
                   3133: roff_freereg(struct roffreg *reg)
1.147     kristaps 3134: {
1.180     schwarze 3135:        struct roffreg  *old_reg;
1.147     kristaps 3136:
1.180     schwarze 3137:        while (NULL != reg) {
                   3138:                free(reg->key.p);
                   3139:                old_reg = reg;
                   3140:                reg = reg->next;
                   3141:                free(old_reg);
                   3142:        }
1.147     kristaps 3143: }
1.92      schwarze 3144:
1.340     schwarze 3145: static int
1.89      kristaps 3146: roff_nr(ROFF_ARGS)
1.83      schwarze 3147: {
1.327     schwarze 3148:        char            *key, *val, *step;
1.212     schwarze 3149:        size_t           keysz;
1.327     schwarze 3150:        int              iv, is, len;
1.187     schwarze 3151:        char             sign;
1.89      kristaps 3152:
1.238     schwarze 3153:        key = val = buf->buf + pos;
                   3154:        if (*key == '\0')
1.277     schwarze 3155:                return ROFF_IGN;
1.212     schwarze 3156:
                   3157:        keysz = roff_getname(r, &val, ln, pos);
1.363     schwarze 3158:        if (key[keysz] == '\\' || key[keysz] == '\t')
1.277     schwarze 3159:                return ROFF_IGN;
1.89      kristaps 3160:
1.187     schwarze 3161:        sign = *val;
1.238     schwarze 3162:        if (sign == '+' || sign == '-')
1.187     schwarze 3163:                val++;
                   3164:
1.327     schwarze 3165:        len = 0;
                   3166:        if (roff_evalnum(r, ln, val, &len, &iv, ROFFNUM_SCALE) == 0)
                   3167:                return ROFF_IGN;
                   3168:
                   3169:        step = val + len;
                   3170:        while (isspace((unsigned char)*step))
                   3171:                step++;
                   3172:        if (roff_evalnum(r, ln, step, NULL, &is, 0) == 0)
                   3173:                is = INT_MIN;
1.109     kristaps 3174:
1.327     schwarze 3175:        roff_setregn(r, key, keysz, iv, sign, is);
1.277     schwarze 3176:        return ROFF_IGN;
1.203     schwarze 3177: }
                   3178:
1.340     schwarze 3179: static int
1.203     schwarze 3180: roff_rr(ROFF_ARGS)
                   3181: {
                   3182:        struct roffreg  *reg, **prev;
1.212     schwarze 3183:        char            *name, *cp;
                   3184:        size_t           namesz;
1.203     schwarze 3185:
1.238     schwarze 3186:        name = cp = buf->buf + pos;
                   3187:        if (*name == '\0')
1.277     schwarze 3188:                return ROFF_IGN;
1.212     schwarze 3189:        namesz = roff_getname(r, &cp, ln, pos);
                   3190:        name[namesz] = '\0';
1.203     schwarze 3191:
                   3192:        prev = &r->regtab;
                   3193:        while (1) {
                   3194:                reg = *prev;
1.238     schwarze 3195:                if (reg == NULL || !strcmp(name, reg->key.p))
1.203     schwarze 3196:                        break;
                   3197:                prev = &reg->next;
                   3198:        }
1.238     schwarze 3199:        if (reg != NULL) {
1.203     schwarze 3200:                *prev = reg->next;
                   3201:                free(reg->key.p);
                   3202:                free(reg);
                   3203:        }
1.277     schwarze 3204:        return ROFF_IGN;
1.122     schwarze 3205: }
                   3206:
1.266     schwarze 3207: /* --- handler functions for roff requests -------------------------------- */
                   3208:
1.340     schwarze 3209: static int
1.122     schwarze 3210: roff_rm(ROFF_ARGS)
                   3211: {
                   3212:        const char       *name;
                   3213:        char             *cp;
1.212     schwarze 3214:        size_t            namesz;
1.122     schwarze 3215:
1.238     schwarze 3216:        cp = buf->buf + pos;
                   3217:        while (*cp != '\0') {
1.212     schwarze 3218:                name = cp;
1.238     schwarze 3219:                namesz = roff_getname(r, &cp, ln, (int)(cp - buf->buf));
1.212     schwarze 3220:                roff_setstrn(&r->strtab, name, namesz, NULL, 0, 0);
1.311     schwarze 3221:                roff_setstrn(&r->rentab, name, namesz, NULL, 0, 0);
1.363     schwarze 3222:                if (name[namesz] == '\\' || name[namesz] == '\t')
1.212     schwarze 3223:                        break;
1.122     schwarze 3224:        }
1.277     schwarze 3225:        return ROFF_IGN;
1.178     schwarze 3226: }
                   3227:
1.340     schwarze 3228: static int
1.178     schwarze 3229: roff_it(ROFF_ARGS)
                   3230: {
                   3231:        int              iv;
                   3232:
                   3233:        /* Parse the number of lines. */
1.261     schwarze 3234:
                   3235:        if ( ! roff_evalnum(r, ln, buf->buf, &pos, &iv, 0)) {
1.350     schwarze 3236:                mandoc_msg(MANDOCERR_IT_NONUM,
                   3237:                    ln, ppos, "%s", buf->buf + 1);
1.277     schwarze 3238:                return ROFF_IGN;
1.178     schwarze 3239:        }
                   3240:
1.262     schwarze 3241:        while (isspace((unsigned char)buf->buf[pos]))
                   3242:                pos++;
                   3243:
                   3244:        /*
                   3245:         * Arm the input line trap.
                   3246:         * Special-casing "an-trap" is an ugly workaround to cope
                   3247:         * with DocBook stupidly fiddling with man(7) internals.
                   3248:         */
1.261     schwarze 3249:
1.178     schwarze 3250:        roffit_lines = iv;
1.262     schwarze 3251:        roffit_macro = mandoc_strdup(iv != 1 ||
                   3252:            strcmp(buf->buf + pos, "an-trap") ?
                   3253:            buf->buf + pos : "br");
1.277     schwarze 3254:        return ROFF_IGN;
1.175     schwarze 3255: }
                   3256:
1.340     schwarze 3257: static int
1.175     schwarze 3258: roff_Dd(ROFF_ARGS)
                   3259: {
1.315     schwarze 3260:        int              mask;
                   3261:        enum roff_tok    t, te;
1.227     schwarze 3262:
1.315     schwarze 3263:        switch (tok) {
                   3264:        case ROFF_Dd:
                   3265:                tok = MDOC_Dd;
                   3266:                te = MDOC_MAX;
                   3267:                if (r->format == 0)
                   3268:                        r->format = MPARSE_MDOC;
                   3269:                mask = MPARSE_MDOC | MPARSE_QUICK;
                   3270:                break;
                   3271:        case ROFF_TH:
                   3272:                tok = MAN_TH;
                   3273:                te = MAN_MAX;
                   3274:                if (r->format == 0)
                   3275:                        r->format = MPARSE_MAN;
                   3276:                mask = MPARSE_QUICK;
                   3277:                break;
                   3278:        default:
                   3279:                abort();
                   3280:        }
                   3281:        if ((r->options & mask) == 0)
                   3282:                for (t = tok; t < te; t++)
                   3283:                        roff_setstr(r, roff_name[t], NULL, 0);
1.277     schwarze 3284:        return ROFF_CONT;
1.109     kristaps 3285: }
                   3286:
1.340     schwarze 3287: static int
1.109     kristaps 3288: roff_TE(ROFF_ARGS)
                   3289: {
1.361     schwarze 3290:        r->man->flags &= ~ROFF_NONOFILL;
1.321     schwarze 3291:        if (r->tbl == NULL) {
1.350     schwarze 3292:                mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, ppos, "TE");
1.321     schwarze 3293:                return ROFF_IGN;
                   3294:        }
1.346     schwarze 3295:        if (tbl_end(r->tbl, 0) == 0) {
1.321     schwarze 3296:                r->tbl = NULL;
1.258     schwarze 3297:                free(buf->buf);
                   3298:                buf->buf = mandoc_strdup(".sp");
                   3299:                buf->sz = 4;
1.329     schwarze 3300:                *offs = 0;
1.277     schwarze 3301:                return ROFF_REPARSE;
1.258     schwarze 3302:        }
1.321     schwarze 3303:        r->tbl = NULL;
1.277     schwarze 3304:        return ROFF_IGN;
1.112     kristaps 3305: }
                   3306:
1.340     schwarze 3307: static int
1.112     kristaps 3308: roff_T_(ROFF_ARGS)
                   3309: {
                   3310:
                   3311:        if (NULL == r->tbl)
1.350     schwarze 3312:                mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, ppos, "T&");
1.112     kristaps 3313:        else
1.296     schwarze 3314:                tbl_restart(ln, ppos, r->tbl);
1.112     kristaps 3315:
1.277     schwarze 3316:        return ROFF_IGN;
1.109     kristaps 3317: }
                   3318:
1.230     schwarze 3319: /*
                   3320:  * Handle in-line equation delimiters.
                   3321:  */
1.340     schwarze 3322: static int
1.238     schwarze 3323: roff_eqndelim(struct roff *r, struct buf *buf, int pos)
1.151     kristaps 3324: {
1.233     schwarze 3325:        char            *cp1, *cp2;
                   3326:        const char      *bef_pr, *bef_nl, *mac, *aft_nl, *aft_pr;
1.151     kristaps 3327:
1.230     schwarze 3328:        /*
                   3329:         * Outside equations, look for an opening delimiter.
                   3330:         * If we are inside an equation, we already know it is
                   3331:         * in-line, or this function wouldn't have been called;
                   3332:         * so look for a closing delimiter.
                   3333:         */
                   3334:
1.238     schwarze 3335:        cp1 = buf->buf + pos;
1.230     schwarze 3336:        cp2 = strchr(cp1, r->eqn == NULL ?
                   3337:            r->last_eqn->odelim : r->last_eqn->cdelim);
                   3338:        if (cp2 == NULL)
1.277     schwarze 3339:                return ROFF_CONT;
1.230     schwarze 3340:
1.233     schwarze 3341:        *cp2++ = '\0';
                   3342:        bef_pr = bef_nl = aft_nl = aft_pr = "";
                   3343:
                   3344:        /* Handle preceding text, protecting whitespace. */
                   3345:
1.238     schwarze 3346:        if (*buf->buf != '\0') {
1.233     schwarze 3347:                if (r->eqn == NULL)
                   3348:                        bef_pr = "\\&";
                   3349:                bef_nl = "\n";
                   3350:        }
                   3351:
                   3352:        /*
                   3353:         * Prepare replacing the delimiter with an equation macro
                   3354:         * and drop leading white space from the equation.
                   3355:         */
1.230     schwarze 3356:
1.233     schwarze 3357:        if (r->eqn == NULL) {
                   3358:                while (*cp2 == ' ')
                   3359:                        cp2++;
                   3360:                mac = ".EQ";
                   3361:        } else
                   3362:                mac = ".EN";
                   3363:
                   3364:        /* Handle following text, protecting whitespace. */
                   3365:
                   3366:        if (*cp2 != '\0') {
                   3367:                aft_nl = "\n";
                   3368:                if (r->eqn != NULL)
                   3369:                        aft_pr = "\\&";
                   3370:        }
                   3371:
                   3372:        /* Do the actual replacement. */
                   3373:
1.238     schwarze 3374:        buf->sz = mandoc_asprintf(&cp1, "%s%s%s%s%s%s%s", buf->buf,
1.233     schwarze 3375:            bef_pr, bef_nl, mac, aft_nl, aft_pr, cp2) + 1;
1.238     schwarze 3376:        free(buf->buf);
                   3377:        buf->buf = cp1;
1.230     schwarze 3378:
                   3379:        /* Toggle the in-line state of the eqn subsystem. */
                   3380:
                   3381:        r->eqn_inline = r->eqn == NULL;
1.277     schwarze 3382:        return ROFF_REPARSE;
1.151     kristaps 3383: }
                   3384:
1.340     schwarze 3385: static int
1.235     schwarze 3386: roff_EQ(ROFF_ARGS)
1.125     kristaps 3387: {
1.319     schwarze 3388:        struct roff_node        *n;
                   3389:
1.356     schwarze 3390:        if (r->man->meta.macroset == MACROSET_MAN)
1.322     schwarze 3391:                man_breakscope(r->man, ROFF_EQ);
1.319     schwarze 3392:        n = roff_node_alloc(r->man, ln, ppos, ROFFT_EQN, TOKEN_NONE);
                   3393:        if (ln > r->man->last->line)
                   3394:                n->flags |= NODE_LINE;
1.348     schwarze 3395:        n->eqn = eqn_box_new();
1.319     schwarze 3396:        roff_node_append(r->man, n);
                   3397:        r->man->next = ROFF_NEXT_SIBLING;
1.125     kristaps 3398:
1.238     schwarze 3399:        assert(r->eqn == NULL);
1.319     schwarze 3400:        if (r->last_eqn == NULL)
1.351     schwarze 3401:                r->last_eqn = eqn_alloc();
1.319     schwarze 3402:        else
                   3403:                eqn_reset(r->last_eqn);
                   3404:        r->eqn = r->last_eqn;
                   3405:        r->eqn->node = n;
1.151     kristaps 3406:
1.238     schwarze 3407:        if (buf->buf[pos] != '\0')
1.350     schwarze 3408:                mandoc_msg(MANDOCERR_ARG_SKIP, ln, pos,
1.238     schwarze 3409:                    ".EQ %s", buf->buf + pos);
1.151     kristaps 3410:
1.277     schwarze 3411:        return ROFF_IGN;
1.125     kristaps 3412: }
                   3413:
1.340     schwarze 3414: static int
1.125     kristaps 3415: roff_EN(ROFF_ARGS)
                   3416: {
1.319     schwarze 3417:        if (r->eqn != NULL) {
                   3418:                eqn_parse(r->eqn);
                   3419:                r->eqn = NULL;
                   3420:        } else
1.350     schwarze 3421:                mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, ppos, "EN");
1.319     schwarze 3422:        if (buf->buf[pos] != '\0')
1.350     schwarze 3423:                mandoc_msg(MANDOCERR_ARG_SKIP, ln, pos,
1.319     schwarze 3424:                    "EN %s", buf->buf + pos);
1.277     schwarze 3425:        return ROFF_IGN;
1.125     kristaps 3426: }
                   3427:
1.340     schwarze 3428: static int
1.109     kristaps 3429: roff_TS(ROFF_ARGS)
                   3430: {
1.321     schwarze 3431:        if (r->tbl != NULL) {
1.350     schwarze 3432:                mandoc_msg(MANDOCERR_BLK_BROKEN, ln, ppos, "TS breaks TS");
1.346     schwarze 3433:                tbl_end(r->tbl, 0);
1.115     kristaps 3434:        }
1.361     schwarze 3435:        r->man->flags |= ROFF_NONOFILL;
1.351     schwarze 3436:        r->tbl = tbl_alloc(ppos, ln, r->last_tbl);
1.346     schwarze 3437:        if (r->last_tbl == NULL)
1.321     schwarze 3438:                r->first_tbl = r->tbl;
                   3439:        r->last_tbl = r->tbl;
1.297     schwarze 3440:        return ROFF_IGN;
                   3441: }
                   3442:
1.340     schwarze 3443: static int
1.358     schwarze 3444: roff_noarg(ROFF_ARGS)
                   3445: {
                   3446:        if (r->man->flags & (MAN_BLINE | MAN_ELINE))
                   3447:                man_breakscope(r->man, tok);
                   3448:        if (tok == ROFF_brp)
                   3449:                tok = ROFF_br;
                   3450:        roff_elem_alloc(r->man, ln, ppos, tok);
                   3451:        if (buf->buf[pos] != '\0')
                   3452:                mandoc_msg(MANDOCERR_ARG_SKIP, ln, pos,
                   3453:                   "%s %s", roff_name[tok], buf->buf + pos);
                   3454:        if (tok == ROFF_nf)
                   3455:                r->man->flags |= ROFF_NOFILL;
                   3456:        else if (tok == ROFF_fi)
                   3457:                r->man->flags &= ~ROFF_NOFILL;
                   3458:        r->man->last->flags |= NODE_LINE | NODE_VALID | NODE_ENDED;
                   3459:        r->man->next = ROFF_NEXT_SIBLING;
                   3460:        return ROFF_IGN;
                   3461: }
                   3462:
                   3463: static int
1.297     schwarze 3464: roff_onearg(ROFF_ARGS)
                   3465: {
                   3466:        struct roff_node        *n;
                   3467:        char                    *cp;
1.305     schwarze 3468:        int                      npos;
1.297     schwarze 3469:
1.302     schwarze 3470:        if (r->man->flags & (MAN_BLINE | MAN_ELINE) &&
1.320     schwarze 3471:            (tok == ROFF_ce || tok == ROFF_rj || tok == ROFF_sp ||
                   3472:             tok == ROFF_ti))
1.302     schwarze 3473:                man_breakscope(r->man, tok);
                   3474:
1.309     schwarze 3475:        if (roffce_node != NULL && (tok == ROFF_ce || tok == ROFF_rj)) {
1.305     schwarze 3476:                r->man->last = roffce_node;
                   3477:                r->man->next = ROFF_NEXT_SIBLING;
                   3478:        }
                   3479:
1.297     schwarze 3480:        roff_elem_alloc(r->man, ln, ppos, tok);
                   3481:        n = r->man->last;
                   3482:
                   3483:        cp = buf->buf + pos;
                   3484:        if (*cp != '\0') {
                   3485:                while (*cp != '\0' && *cp != ' ')
                   3486:                        cp++;
                   3487:                while (*cp == ' ')
                   3488:                        *cp++ = '\0';
                   3489:                if (*cp != '\0')
1.350     schwarze 3490:                        mandoc_msg(MANDOCERR_ARG_EXCESS,
                   3491:                            ln, (int)(cp - buf->buf),
1.297     schwarze 3492:                            "%s ... %s", roff_name[tok], cp);
                   3493:                roff_word_alloc(r->man, ln, pos, buf->buf + pos);
1.300     schwarze 3494:        }
                   3495:
1.309     schwarze 3496:        if (tok == ROFF_ce || tok == ROFF_rj) {
                   3497:                if (r->man->last->type == ROFFT_ELEM) {
1.305     schwarze 3498:                        roff_word_alloc(r->man, ln, pos, "1");
                   3499:                        r->man->last->flags |= NODE_NOSRC;
                   3500:                }
                   3501:                npos = 0;
                   3502:                if (roff_evalnum(r, ln, r->man->last->string, &npos,
                   3503:                    &roffce_lines, 0) == 0) {
1.350     schwarze 3504:                        mandoc_msg(MANDOCERR_CE_NONUM,
                   3505:                            ln, pos, "ce %s", buf->buf + pos);
1.305     schwarze 3506:                        roffce_lines = 1;
                   3507:                }
                   3508:                if (roffce_lines < 1) {
                   3509:                        r->man->last = r->man->last->parent;
                   3510:                        roffce_node = NULL;
                   3511:                        roffce_lines = 0;
                   3512:                } else
                   3513:                        roffce_node = r->man->last->parent;
                   3514:        } else {
                   3515:                n->flags |= NODE_VALID | NODE_ENDED;
                   3516:                r->man->last = n;
                   3517:        }
                   3518:        n->flags |= NODE_LINE;
1.300     schwarze 3519:        r->man->next = ROFF_NEXT_SIBLING;
                   3520:        return ROFF_IGN;
                   3521: }
                   3522:
1.340     schwarze 3523: static int
1.300     schwarze 3524: roff_manyarg(ROFF_ARGS)
                   3525: {
                   3526:        struct roff_node        *n;
                   3527:        char                    *sp, *ep;
                   3528:
                   3529:        roff_elem_alloc(r->man, ln, ppos, tok);
                   3530:        n = r->man->last;
                   3531:
                   3532:        for (sp = ep = buf->buf + pos; *sp != '\0'; sp = ep) {
                   3533:                while (*ep != '\0' && *ep != ' ')
                   3534:                        ep++;
                   3535:                while (*ep == ' ')
                   3536:                        *ep++ = '\0';
                   3537:                roff_word_alloc(r->man, ln, sp - buf->buf, sp);
1.297     schwarze 3538:        }
                   3539:
                   3540:        n->flags |= NODE_LINE | NODE_VALID | NODE_ENDED;
                   3541:        r->man->last = n;
                   3542:        r->man->next = ROFF_NEXT_SIBLING;
1.277     schwarze 3543:        return ROFF_IGN;
1.251     schwarze 3544: }
                   3545:
1.340     schwarze 3546: static int
1.311     schwarze 3547: roff_als(ROFF_ARGS)
                   3548: {
                   3549:        char            *oldn, *newn, *end, *value;
                   3550:        size_t           oldsz, newsz, valsz;
                   3551:
                   3552:        newn = oldn = buf->buf + pos;
                   3553:        if (*newn == '\0')
                   3554:                return ROFF_IGN;
                   3555:
                   3556:        newsz = roff_getname(r, &oldn, ln, pos);
1.363     schwarze 3557:        if (newn[newsz] == '\\' || newn[newsz] == '\t' || *oldn == '\0')
1.311     schwarze 3558:                return ROFF_IGN;
                   3559:
                   3560:        end = oldn;
                   3561:        oldsz = roff_getname(r, &end, ln, oldn - buf->buf);
                   3562:        if (oldsz == 0)
                   3563:                return ROFF_IGN;
                   3564:
1.338     schwarze 3565:        valsz = mandoc_asprintf(&value, ".%.*s \\$@\\\"\n",
1.315     schwarze 3566:            (int)oldsz, oldn);
1.311     schwarze 3567:        roff_setstrn(&r->strtab, newn, newsz, value, valsz, 0);
                   3568:        roff_setstrn(&r->rentab, newn, newsz, NULL, 0, 0);
                   3569:        free(value);
1.364     schwarze 3570:        return ROFF_IGN;
                   3571: }
                   3572:
                   3573: /*
                   3574:  * The .break request only makes sense inside conditionals,
                   3575:  * and that case is already handled in roff_cond_sub().
                   3576:  */
                   3577: static int
                   3578: roff_break(ROFF_ARGS)
                   3579: {
                   3580:        mandoc_msg(MANDOCERR_BLK_NOTOPEN, ln, pos, "break");
1.296     schwarze 3581:        return ROFF_IGN;
1.92      schwarze 3582: }
                   3583:
1.340     schwarze 3584: static int
1.174     kristaps 3585: roff_cc(ROFF_ARGS)
                   3586: {
                   3587:        const char      *p;
                   3588:
1.238     schwarze 3589:        p = buf->buf + pos;
1.174     kristaps 3590:
1.238     schwarze 3591:        if (*p == '\0' || (r->control = *p++) == '.')
1.303     schwarze 3592:                r->control = '\0';
1.174     kristaps 3593:
1.238     schwarze 3594:        if (*p != '\0')
1.350     schwarze 3595:                mandoc_msg(MANDOCERR_ARG_EXCESS,
1.260     schwarze 3596:                    ln, p - buf->buf, "cc ... %s", p);
1.174     kristaps 3597:
1.341     schwarze 3598:        return ROFF_IGN;
                   3599: }
                   3600:
                   3601: static int
                   3602: roff_char(ROFF_ARGS)
                   3603: {
                   3604:        const char      *p, *kp, *vp;
                   3605:        size_t           ksz, vsz;
                   3606:        int              font;
                   3607:
                   3608:        /* Parse the character to be replaced. */
                   3609:
                   3610:        kp = buf->buf + pos;
                   3611:        p = kp + 1;
                   3612:        if (*kp == '\0' || (*kp == '\\' &&
                   3613:             mandoc_escape(&p, NULL, NULL) != ESCAPE_SPECIAL) ||
                   3614:            (*p != ' ' && *p != '\0')) {
1.350     schwarze 3615:                mandoc_msg(MANDOCERR_CHAR_ARG, ln, pos, "char %s", kp);
1.341     schwarze 3616:                return ROFF_IGN;
                   3617:        }
                   3618:        ksz = p - kp;
                   3619:        while (*p == ' ')
                   3620:                p++;
                   3621:
                   3622:        /*
                   3623:         * If the replacement string contains a font escape sequence,
                   3624:         * we have to restore the font at the end.
                   3625:         */
                   3626:
                   3627:        vp = p;
                   3628:        vsz = strlen(p);
                   3629:        font = 0;
                   3630:        while (*p != '\0') {
                   3631:                if (*p++ != '\\')
                   3632:                        continue;
                   3633:                switch (mandoc_escape(&p, NULL, NULL)) {
                   3634:                case ESCAPE_FONT:
                   3635:                case ESCAPE_FONTROMAN:
                   3636:                case ESCAPE_FONTITALIC:
                   3637:                case ESCAPE_FONTBOLD:
                   3638:                case ESCAPE_FONTBI:
1.378     schwarze 3639:                case ESCAPE_FONTCR:
                   3640:                case ESCAPE_FONTCB:
                   3641:                case ESCAPE_FONTCI:
1.341     schwarze 3642:                case ESCAPE_FONTPREV:
                   3643:                        font++;
                   3644:                        break;
                   3645:                default:
                   3646:                        break;
                   3647:                }
                   3648:        }
                   3649:        if (font > 1)
1.350     schwarze 3650:                mandoc_msg(MANDOCERR_CHAR_FONT,
                   3651:                    ln, (int)(vp - buf->buf), "%s", vp);
1.341     schwarze 3652:
                   3653:        /*
                   3654:         * Approximate the effect of .char using the .tr tables.
                   3655:         * XXX In groff, .char and .tr interact differently.
                   3656:         */
                   3657:
                   3658:        if (ksz == 1) {
                   3659:                if (r->xtab == NULL)
                   3660:                        r->xtab = mandoc_calloc(128, sizeof(*r->xtab));
                   3661:                assert((unsigned int)*kp < 128);
                   3662:                free(r->xtab[(int)*kp].p);
                   3663:                r->xtab[(int)*kp].sz = mandoc_asprintf(&r->xtab[(int)*kp].p,
                   3664:                    "%s%s", vp, font ? "\fP" : "");
                   3665:        } else {
                   3666:                roff_setstrn(&r->xmbtab, kp, ksz, vp, vsz, 0);
                   3667:                if (font)
                   3668:                        roff_setstrn(&r->xmbtab, kp, ksz, "\\fP", 3, 1);
                   3669:        }
1.277     schwarze 3670:        return ROFF_IGN;
1.174     kristaps 3671: }
                   3672:
1.340     schwarze 3673: static int
1.303     schwarze 3674: roff_ec(ROFF_ARGS)
                   3675: {
                   3676:        const char      *p;
                   3677:
                   3678:        p = buf->buf + pos;
                   3679:        if (*p == '\0')
                   3680:                r->escape = '\\';
                   3681:        else {
                   3682:                r->escape = *p;
                   3683:                if (*++p != '\0')
1.350     schwarze 3684:                        mandoc_msg(MANDOCERR_ARG_EXCESS, ln,
                   3685:                            (int)(p - buf->buf), "ec ... %s", p);
1.303     schwarze 3686:        }
                   3687:        return ROFF_IGN;
                   3688: }
                   3689:
1.340     schwarze 3690: static int
1.303     schwarze 3691: roff_eo(ROFF_ARGS)
                   3692: {
                   3693:        r->escape = '\0';
                   3694:        if (buf->buf[pos] != '\0')
1.350     schwarze 3695:                mandoc_msg(MANDOCERR_ARG_SKIP,
1.303     schwarze 3696:                    ln, pos, "eo %s", buf->buf + pos);
1.384     schwarze 3697:        return ROFF_IGN;
                   3698: }
                   3699:
                   3700: static int
                   3701: roff_mc(ROFF_ARGS)
                   3702: {
                   3703:        struct roff_node        *n;
                   3704:        char                    *cp;
                   3705:
                   3706:        /* Parse the first argument. */
                   3707:
                   3708:        cp = buf->buf + pos;
                   3709:        if (*cp != '\0')
                   3710:                cp++;
                   3711:        if (buf->buf[pos] == '\\') {
                   3712:                switch (mandoc_escape((const char **)&cp, NULL, NULL)) {
                   3713:                case ESCAPE_SPECIAL:
                   3714:                case ESCAPE_UNICODE:
                   3715:                case ESCAPE_NUMBERED:
                   3716:                        break;
                   3717:                default:
                   3718:                        *cp = '\0';
                   3719:                        mandoc_msg(MANDOCERR_MC_ESC, ln, pos,
                   3720:                            "mc %s", buf->buf + pos);
                   3721:                        buf->buf[pos] = '\0';
                   3722:                        break;
                   3723:                }
                   3724:        }
                   3725:
                   3726:        /* Ignore additional arguments. */
                   3727:
                   3728:        while (*cp == ' ')
                   3729:                *cp++ = '\0';
                   3730:        if (*cp != '\0') {
                   3731:                mandoc_msg(MANDOCERR_MC_DIST, ln, (int)(cp - buf->buf),
                   3732:                    "mc ... %s", cp);
                   3733:                *cp = '\0';
                   3734:        }
                   3735:
                   3736:        /* Create the .mc node. */
                   3737:
                   3738:        roff_elem_alloc(r->man, ln, ppos, tok);
                   3739:        n = r->man->last;
                   3740:        if (buf->buf[pos] != '\0')
                   3741:                roff_word_alloc(r->man, ln, pos, buf->buf + pos);
                   3742:        n->flags |= NODE_LINE | NODE_VALID | NODE_ENDED;
                   3743:        r->man->last = n;
                   3744:        r->man->next = ROFF_NEXT_SIBLING;
1.303     schwarze 3745:        return ROFF_IGN;
1.330     schwarze 3746: }
                   3747:
1.340     schwarze 3748: static int
1.330     schwarze 3749: roff_nop(ROFF_ARGS)
                   3750: {
                   3751:        while (buf->buf[pos] == ' ')
                   3752:                pos++;
                   3753:        *offs = pos;
                   3754:        return ROFF_RERUN;
1.303     schwarze 3755: }
                   3756:
1.340     schwarze 3757: static int
1.164     kristaps 3758: roff_tr(ROFF_ARGS)
                   3759: {
                   3760:        const char      *p, *first, *second;
                   3761:        size_t           fsz, ssz;
                   3762:
1.238     schwarze 3763:        p = buf->buf + pos;
1.164     kristaps 3764:
1.238     schwarze 3765:        if (*p == '\0') {
1.350     schwarze 3766:                mandoc_msg(MANDOCERR_REQ_EMPTY, ln, ppos, "tr");
1.277     schwarze 3767:                return ROFF_IGN;
1.164     kristaps 3768:        }
                   3769:
1.238     schwarze 3770:        while (*p != '\0') {
1.164     kristaps 3771:                fsz = ssz = 1;
                   3772:
                   3773:                first = p++;
1.238     schwarze 3774:                if (*first == '\\') {
1.394     schwarze 3775:                        if (mandoc_escape(&p, NULL, NULL) == ESCAPE_ERROR)
1.277     schwarze 3776:                                return ROFF_IGN;
1.164     kristaps 3777:                        fsz = (size_t)(p - first);
                   3778:                }
                   3779:
                   3780:                second = p++;
1.238     schwarze 3781:                if (*second == '\\') {
1.394     schwarze 3782:                        if (mandoc_escape(&p, NULL, NULL) == ESCAPE_ERROR)
1.277     schwarze 3783:                                return ROFF_IGN;
1.164     kristaps 3784:                        ssz = (size_t)(p - second);
1.238     schwarze 3785:                } else if (*second == '\0') {
1.350     schwarze 3786:                        mandoc_msg(MANDOCERR_TR_ODD, ln,
                   3787:                            (int)(first - buf->buf), "tr %s", first);
1.164     kristaps 3788:                        second = " ";
1.165     kristaps 3789:                        p--;
1.164     kristaps 3790:                }
                   3791:
1.167     kristaps 3792:                if (fsz > 1) {
1.207     schwarze 3793:                        roff_setstrn(&r->xmbtab, first, fsz,
                   3794:                            second, ssz, 0);
1.167     kristaps 3795:                        continue;
                   3796:                }
                   3797:
1.238     schwarze 3798:                if (r->xtab == NULL)
1.207     schwarze 3799:                        r->xtab = mandoc_calloc(128,
                   3800:                            sizeof(struct roffstr));
1.167     kristaps 3801:
                   3802:                free(r->xtab[(int)*first].p);
                   3803:                r->xtab[(int)*first].p = mandoc_strndup(second, ssz);
                   3804:                r->xtab[(int)*first].sz = ssz;
1.164     kristaps 3805:        }
                   3806:
1.277     schwarze 3807:        return ROFF_IGN;
1.164     kristaps 3808: }
                   3809:
1.339     schwarze 3810: /*
                   3811:  * Implementation of the .return request.
                   3812:  * There is no need to call roff_userret() from here.
                   3813:  * The read module will call that after rewinding the reader stack
                   3814:  * to the place from where the current macro was called.
                   3815:  */
1.340     schwarze 3816: static int
1.339     schwarze 3817: roff_return(ROFF_ARGS)
                   3818: {
                   3819:        if (r->mstackpos >= 0)
1.340     schwarze 3820:                return ROFF_IGN | ROFF_USERRET;
1.339     schwarze 3821:
1.350     schwarze 3822:        mandoc_msg(MANDOCERR_REQ_NOMAC, ln, ppos, "return");
1.339     schwarze 3823:        return ROFF_IGN;
                   3824: }
                   3825:
1.340     schwarze 3826: static int
1.306     schwarze 3827: roff_rn(ROFF_ARGS)
                   3828: {
                   3829:        const char      *value;
                   3830:        char            *oldn, *newn, *end;
                   3831:        size_t           oldsz, newsz;
1.315     schwarze 3832:        int              deftype;
1.306     schwarze 3833:
                   3834:        oldn = newn = buf->buf + pos;
                   3835:        if (*oldn == '\0')
                   3836:                return ROFF_IGN;
                   3837:
                   3838:        oldsz = roff_getname(r, &newn, ln, pos);
1.363     schwarze 3839:        if (oldn[oldsz] == '\\' || oldn[oldsz] == '\t' || *newn == '\0')
1.306     schwarze 3840:                return ROFF_IGN;
                   3841:
                   3842:        end = newn;
                   3843:        newsz = roff_getname(r, &end, ln, newn - buf->buf);
                   3844:        if (newsz == 0)
                   3845:                return ROFF_IGN;
                   3846:
1.315     schwarze 3847:        deftype = ROFFDEF_ANY;
                   3848:        value = roff_getstrn(r, oldn, oldsz, &deftype);
                   3849:        switch (deftype) {
                   3850:        case ROFFDEF_USER:
1.306     schwarze 3851:                roff_setstrn(&r->strtab, newn, newsz, value, strlen(value), 0);
                   3852:                roff_setstrn(&r->strtab, oldn, oldsz, NULL, 0, 0);
                   3853:                roff_setstrn(&r->rentab, newn, newsz, NULL, 0, 0);
1.315     schwarze 3854:                break;
                   3855:        case ROFFDEF_PRE:
                   3856:                roff_setstrn(&r->strtab, newn, newsz, value, strlen(value), 0);
                   3857:                roff_setstrn(&r->rentab, newn, newsz, NULL, 0, 0);
                   3858:                break;
                   3859:        case ROFFDEF_REN:
1.306     schwarze 3860:                roff_setstrn(&r->rentab, newn, newsz, value, strlen(value), 0);
                   3861:                roff_setstrn(&r->rentab, oldn, oldsz, NULL, 0, 0);
1.315     schwarze 3862:                roff_setstrn(&r->strtab, newn, newsz, NULL, 0, 0);
                   3863:                break;
                   3864:        case ROFFDEF_STD:
1.306     schwarze 3865:                roff_setstrn(&r->rentab, newn, newsz, oldn, oldsz, 0);
1.315     schwarze 3866:                roff_setstrn(&r->strtab, newn, newsz, NULL, 0, 0);
                   3867:                break;
                   3868:        default:
                   3869:                roff_setstrn(&r->strtab, newn, newsz, NULL, 0, 0);
                   3870:                roff_setstrn(&r->rentab, newn, newsz, NULL, 0, 0);
                   3871:                break;
                   3872:        }
1.306     schwarze 3873:        return ROFF_IGN;
                   3874: }
                   3875:
1.340     schwarze 3876: static int
1.339     schwarze 3877: roff_shift(ROFF_ARGS)
                   3878: {
                   3879:        struct mctx     *ctx;
1.382     schwarze 3880:        int              argpos, levels, i;
1.339     schwarze 3881:
1.382     schwarze 3882:        argpos = pos;
1.339     schwarze 3883:        levels = 1;
                   3884:        if (buf->buf[pos] != '\0' &&
                   3885:            roff_evalnum(r, ln, buf->buf, &pos, &levels, 0) == 0) {
1.350     schwarze 3886:                mandoc_msg(MANDOCERR_CE_NONUM,
1.339     schwarze 3887:                    ln, pos, "shift %s", buf->buf + pos);
                   3888:                levels = 1;
                   3889:        }
                   3890:        if (r->mstackpos < 0) {
1.350     schwarze 3891:                mandoc_msg(MANDOCERR_REQ_NOMAC, ln, ppos, "shift");
1.339     schwarze 3892:                return ROFF_IGN;
                   3893:        }
                   3894:        ctx = r->mstack + r->mstackpos;
                   3895:        if (levels > ctx->argc) {
1.350     schwarze 3896:                mandoc_msg(MANDOCERR_SHIFT,
1.382     schwarze 3897:                    ln, argpos, "%d, but max is %d", levels, ctx->argc);
1.339     schwarze 3898:                levels = ctx->argc;
1.382     schwarze 3899:        }
                   3900:        if (levels < 0) {
                   3901:                mandoc_msg(MANDOCERR_ARG_NEG, ln, argpos, "shift %d", levels);
                   3902:                levels = 0;
1.339     schwarze 3903:        }
                   3904:        if (levels == 0)
                   3905:                return ROFF_IGN;
                   3906:        for (i = 0; i < levels; i++)
                   3907:                free(ctx->argv[i]);
                   3908:        ctx->argc -= levels;
                   3909:        for (i = 0; i < ctx->argc; i++)
                   3910:                ctx->argv[i] = ctx->argv[i + levels];
                   3911:        return ROFF_IGN;
                   3912: }
                   3913:
1.340     schwarze 3914: static int
1.105     kristaps 3915: roff_so(ROFF_ARGS)
                   3916: {
1.249     schwarze 3917:        char *name, *cp;
1.105     kristaps 3918:
1.238     schwarze 3919:        name = buf->buf + pos;
1.350     schwarze 3920:        mandoc_msg(MANDOCERR_SO, ln, ppos, "so %s", name);
1.105     kristaps 3921:
                   3922:        /*
                   3923:         * Handle `so'.  Be EXTREMELY careful, as we shouldn't be
                   3924:         * opening anything that's not in our cwd or anything beneath
                   3925:         * it.  Thus, explicitly disallow traversing up the file-system
                   3926:         * or using absolute paths.
                   3927:         */
                   3928:
1.238     schwarze 3929:        if (*name == '/' || strstr(name, "../") || strstr(name, "/..")) {
1.350     schwarze 3930:                mandoc_msg(MANDOCERR_SO_PATH, ln, ppos, ".so %s", name);
1.249     schwarze 3931:                buf->sz = mandoc_asprintf(&cp,
                   3932:                    ".sp\nSee the file %s.\n.sp", name) + 1;
                   3933:                free(buf->buf);
                   3934:                buf->buf = cp;
                   3935:                *offs = 0;
1.277     schwarze 3936:                return ROFF_REPARSE;
1.105     kristaps 3937:        }
                   3938:
                   3939:        *offs = pos;
1.277     schwarze 3940:        return ROFF_SO;
1.105     kristaps 3941: }
1.92      schwarze 3942:
1.266     schwarze 3943: /* --- user defined strings and macros ------------------------------------ */
                   3944:
1.340     schwarze 3945: static int
1.106     kristaps 3946: roff_userdef(ROFF_ARGS)
1.99      kristaps 3947: {
1.339     schwarze 3948:        struct mctx      *ctx;
                   3949:        char             *arg, *ap, *dst, *src;
                   3950:        size_t            sz;
                   3951:
1.365     schwarze 3952:        /* If the macro is empty, ignore it altogether. */
                   3953:
                   3954:        if (*r->current_string == '\0')
                   3955:                return ROFF_IGN;
                   3956:
1.339     schwarze 3957:        /* Initialize a new macro stack context. */
                   3958:
                   3959:        if (++r->mstackpos == r->mstacksz) {
                   3960:                r->mstack = mandoc_recallocarray(r->mstack,
                   3961:                    r->mstacksz, r->mstacksz + 8, sizeof(*r->mstack));
                   3962:                r->mstacksz += 8;
                   3963:        }
                   3964:        ctx = r->mstack + r->mstackpos;
                   3965:        ctx->argc = 0;
                   3966:
                   3967:        /*
                   3968:         * Collect pointers to macro argument strings,
                   3969:         * NUL-terminating them and escaping quotes.
                   3970:         */
                   3971:
                   3972:        src = buf->buf + pos;
                   3973:        while (*src != '\0') {
                   3974:                if (ctx->argc == ctx->argsz) {
                   3975:                        ctx->argsz += 8;
                   3976:                        ctx->argv = mandoc_reallocarray(ctx->argv,
                   3977:                            ctx->argsz, sizeof(*ctx->argv));
                   3978:                }
1.355     schwarze 3979:                arg = roff_getarg(r, &src, ln, &pos);
1.339     schwarze 3980:                sz = 1;  /* For the terminating NUL. */
                   3981:                for (ap = arg; *ap != '\0'; ap++)
                   3982:                        sz += *ap == '"' ? 4 : 1;
                   3983:                ctx->argv[ctx->argc++] = dst = mandoc_malloc(sz);
                   3984:                for (ap = arg; *ap != '\0'; ap++) {
                   3985:                        if (*ap == '"') {
                   3986:                                memcpy(dst, "\\(dq", 4);
                   3987:                                dst += 4;
                   3988:                        } else
                   3989:                                *dst++ = *ap;
1.106     kristaps 3990:                }
1.339     schwarze 3991:                *dst = '\0';
1.355     schwarze 3992:                free(arg);
1.337     schwarze 3993:        }
                   3994:
1.339     schwarze 3995:        /* Replace the macro invocation by the macro definition. */
1.263     schwarze 3996:
1.238     schwarze 3997:        free(buf->buf);
1.339     schwarze 3998:        buf->buf = mandoc_strdup(r->current_string);
                   3999:        buf->sz = strlen(buf->buf) + 1;
1.248     schwarze 4000:        *offs = 0;
1.106     kristaps 4001:
1.365     schwarze 4002:        return buf->buf[buf->sz - 2] == '\n' ?
1.340     schwarze 4003:            ROFF_REPARSE | ROFF_USERCALL : ROFF_IGN | ROFF_APPEND;
1.99      kristaps 4004: }
1.121     schwarze 4005:
1.306     schwarze 4006: /*
                   4007:  * Calling a high-level macro that was renamed with .rn.
                   4008:  * r->current_string has already been set up by roff_parse().
                   4009:  */
1.340     schwarze 4010: static int
1.306     schwarze 4011: roff_renamed(ROFF_ARGS)
                   4012: {
                   4013:        char    *nbuf;
                   4014:
1.315     schwarze 4015:        buf->sz = mandoc_asprintf(&nbuf, ".%s%s%s", r->current_string,
                   4016:            buf->buf[pos] == '\0' ? "" : " ", buf->buf + pos) + 1;
1.306     schwarze 4017:        free(buf->buf);
                   4018:        buf->buf = nbuf;
1.329     schwarze 4019:        *offs = 0;
1.306     schwarze 4020:        return ROFF_CONT;
                   4021: }
                   4022:
1.362     schwarze 4023: /*
                   4024:  * Measure the length in bytes of the roff identifier at *cpp
                   4025:  * and advance the pointer to the next word.
                   4026:  */
1.212     schwarze 4027: static size_t
1.121     schwarze 4028: roff_getname(struct roff *r, char **cpp, int ln, int pos)
                   4029: {
                   4030:        char     *name, *cp;
1.393     schwarze 4031:        int       namesz, inam, iend;
1.121     schwarze 4032:
                   4033:        name = *cpp;
1.362     schwarze 4034:        if (*name == '\0')
1.277     schwarze 4035:                return 0;
1.121     schwarze 4036:
1.362     schwarze 4037:        /* Advance cp to the byte after the end of the name. */
                   4038:
1.393     schwarze 4039:        cp = name;
                   4040:        namesz = 0;
                   4041:        for (;;) {
1.363     schwarze 4042:                if (*cp == '\0')
1.212     schwarze 4043:                        break;
1.363     schwarze 4044:                if (*cp == ' ' || *cp == '\t') {
                   4045:                        cp++;
                   4046:                        break;
                   4047:                }
1.393     schwarze 4048:                if (*cp != '\\') {
                   4049:                        if (name + namesz < cp) {
                   4050:                                name[namesz] = *cp;
                   4051:                                *cp = ' ';
                   4052:                        }
                   4053:                        namesz++;
                   4054:                        cp++;
1.121     schwarze 4055:                        continue;
1.393     schwarze 4056:                }
1.362     schwarze 4057:                if (cp[1] == '{' || cp[1] == '}')
1.215     schwarze 4058:                        break;
1.393     schwarze 4059:                if (roff_escape(cp, 0, 0, NULL, &inam,
                   4060:                    NULL, NULL, &iend) != ESCAPE_UNDEF) {
                   4061:                        mandoc_msg(MANDOCERR_NAMESC, ln, pos,
                   4062:                            "%.*s%.*s", namesz, name, iend, cp);
                   4063:                        cp += iend;
                   4064:                        break;
                   4065:                }
                   4066:
                   4067:                /*
                   4068:                 * In an identifier, \\, \., \G and so on
                   4069:                 * are reduced to \, ., G and so on,
                   4070:                 * vaguely similar to copy mode.
                   4071:                 */
                   4072:
                   4073:                name[namesz++] = cp[inam];
                   4074:                while (iend--) {
                   4075:                        if (cp >= name + namesz)
                   4076:                                *cp = ' ';
                   4077:                        cp++;
                   4078:                }
1.121     schwarze 4079:        }
                   4080:
                   4081:        /* Read past spaces. */
1.362     schwarze 4082:
                   4083:        while (*cp == ' ')
1.121     schwarze 4084:                cp++;
                   4085:
                   4086:        *cpp = cp;
1.277     schwarze 4087:        return namesz;
1.121     schwarze 4088: }
                   4089:
1.106     kristaps 4090: /*
                   4091:  * Store *string into the user-defined string called *name.
                   4092:  * To clear an existing entry, call with (*r, *name, NULL, 0).
1.193     schwarze 4093:  * append == 0: replace mode
                   4094:  * append == 1: single-line append mode
                   4095:  * append == 2: multiline append mode, append '\n' after each call
1.106     kristaps 4096:  */
1.94      kristaps 4097: static void
1.106     kristaps 4098: roff_setstr(struct roff *r, const char *name, const char *string,
1.193     schwarze 4099:        int append)
1.92      schwarze 4100: {
1.315     schwarze 4101:        size_t   namesz;
1.164     kristaps 4102:
1.315     schwarze 4103:        namesz = strlen(name);
                   4104:        roff_setstrn(&r->strtab, name, namesz, string,
1.207     schwarze 4105:            string ? strlen(string) : 0, append);
1.315     schwarze 4106:        roff_setstrn(&r->rentab, name, namesz, NULL, 0, 0);
1.164     kristaps 4107: }
                   4108:
                   4109: static void
1.166     kristaps 4110: roff_setstrn(struct roffkv **r, const char *name, size_t namesz,
1.193     schwarze 4111:                const char *string, size_t stringsz, int append)
1.164     kristaps 4112: {
1.166     kristaps 4113:        struct roffkv   *n;
1.164     kristaps 4114:        char            *c;
                   4115:        int              i;
                   4116:        size_t           oldch, newch;
1.92      schwarze 4117:
1.106     kristaps 4118:        /* Search for an existing string with the same name. */
1.164     kristaps 4119:        n = *r;
                   4120:
1.211     schwarze 4121:        while (n && (namesz != n->key.sz ||
                   4122:                        strncmp(n->key.p, name, namesz)))
1.92      schwarze 4123:                n = n->next;
1.94      kristaps 4124:
                   4125:        if (NULL == n) {
1.106     kristaps 4126:                /* Create a new string table entry. */
1.166     kristaps 4127:                n = mandoc_malloc(sizeof(struct roffkv));
                   4128:                n->key.p = mandoc_strndup(name, namesz);
                   4129:                n->key.sz = namesz;
                   4130:                n->val.p = NULL;
                   4131:                n->val.sz = 0;
1.164     kristaps 4132:                n->next = *r;
                   4133:                *r = n;
1.193     schwarze 4134:        } else if (0 == append) {
1.166     kristaps 4135:                free(n->val.p);
                   4136:                n->val.p = NULL;
                   4137:                n->val.sz = 0;
1.106     kristaps 4138:        }
                   4139:
                   4140:        if (NULL == string)
                   4141:                return;
                   4142:
                   4143:        /*
                   4144:         * One additional byte for the '\n' in multiline mode,
                   4145:         * and one for the terminating '\0'.
                   4146:         */
1.193     schwarze 4147:        newch = stringsz + (1 < append ? 2u : 1u);
1.164     kristaps 4148:
1.166     kristaps 4149:        if (NULL == n->val.p) {
                   4150:                n->val.p = mandoc_malloc(newch);
                   4151:                *n->val.p = '\0';
1.106     kristaps 4152:                oldch = 0;
                   4153:        } else {
1.166     kristaps 4154:                oldch = n->val.sz;
                   4155:                n->val.p = mandoc_realloc(n->val.p, oldch + newch);
1.106     kristaps 4156:        }
                   4157:
                   4158:        /* Skip existing content in the destination buffer. */
1.166     kristaps 4159:        c = n->val.p + (int)oldch;
1.106     kristaps 4160:
                   4161:        /* Append new content to the destination buffer. */
1.164     kristaps 4162:        i = 0;
                   4163:        while (i < (int)stringsz) {
1.106     kristaps 4164:                /*
                   4165:                 * Rudimentary roff copy mode:
                   4166:                 * Handle escaped backslashes.
                   4167:                 */
1.164     kristaps 4168:                if ('\\' == string[i] && '\\' == string[i + 1])
                   4169:                        i++;
                   4170:                *c++ = string[i++];
1.106     kristaps 4171:        }
1.94      kristaps 4172:
1.106     kristaps 4173:        /* Append terminating bytes. */
1.193     schwarze 4174:        if (1 < append)
1.106     kristaps 4175:                *c++ = '\n';
1.163     kristaps 4176:
1.106     kristaps 4177:        *c = '\0';
1.166     kristaps 4178:        n->val.sz = (int)(c - n->val.p);
1.92      schwarze 4179: }
                   4180:
1.94      kristaps 4181: static const char *
1.325     schwarze 4182: roff_getstrn(struct roff *r, const char *name, size_t len,
1.315     schwarze 4183:     int *deftype)
1.92      schwarze 4184: {
1.315     schwarze 4185:        const struct roffkv     *n;
1.325     schwarze 4186:        int                      found, i;
1.315     schwarze 4187:        enum roff_tok            tok;
                   4188:
1.325     schwarze 4189:        found = 0;
                   4190:        for (n = r->strtab; n != NULL; n = n->next) {
                   4191:                if (strncmp(name, n->key.p, len) != 0 ||
                   4192:                    n->key.p[len] != '\0' || n->val.p == NULL)
                   4193:                        continue;
                   4194:                if (*deftype & ROFFDEF_USER) {
                   4195:                        *deftype = ROFFDEF_USER;
                   4196:                        return n->val.p;
                   4197:                } else {
                   4198:                        found = 1;
                   4199:                        break;
                   4200:                }
                   4201:        }
                   4202:        for (n = r->rentab; n != NULL; n = n->next) {
                   4203:                if (strncmp(name, n->key.p, len) != 0 ||
                   4204:                    n->key.p[len] != '\0' || n->val.p == NULL)
                   4205:                        continue;
                   4206:                if (*deftype & ROFFDEF_REN) {
                   4207:                        *deftype = ROFFDEF_REN;
                   4208:                        return n->val.p;
                   4209:                } else {
                   4210:                        found = 1;
                   4211:                        break;
1.315     schwarze 4212:                }
                   4213:        }
1.325     schwarze 4214:        for (i = 0; i < PREDEFS_MAX; i++) {
                   4215:                if (strncmp(name, predefs[i].name, len) != 0 ||
                   4216:                    predefs[i].name[len] != '\0')
                   4217:                        continue;
                   4218:                if (*deftype & ROFFDEF_PRE) {
                   4219:                        *deftype = ROFFDEF_PRE;
                   4220:                        return predefs[i].str;
                   4221:                } else {
                   4222:                        found = 1;
                   4223:                        break;
1.315     schwarze 4224:                }
                   4225:        }
1.356     schwarze 4226:        if (r->man->meta.macroset != MACROSET_MAN) {
1.325     schwarze 4227:                for (tok = MDOC_Dd; tok < MDOC_MAX; tok++) {
                   4228:                        if (strncmp(name, roff_name[tok], len) != 0 ||
                   4229:                            roff_name[tok][len] != '\0')
                   4230:                                continue;
                   4231:                        if (*deftype & ROFFDEF_STD) {
                   4232:                                *deftype = ROFFDEF_STD;
                   4233:                                return NULL;
                   4234:                        } else {
                   4235:                                found = 1;
                   4236:                                break;
1.315     schwarze 4237:                        }
                   4238:                }
                   4239:        }
1.356     schwarze 4240:        if (r->man->meta.macroset != MACROSET_MDOC) {
1.325     schwarze 4241:                for (tok = MAN_TH; tok < MAN_MAX; tok++) {
                   4242:                        if (strncmp(name, roff_name[tok], len) != 0 ||
                   4243:                            roff_name[tok][len] != '\0')
                   4244:                                continue;
                   4245:                        if (*deftype & ROFFDEF_STD) {
                   4246:                                *deftype = ROFFDEF_STD;
                   4247:                                return NULL;
                   4248:                        } else {
                   4249:                                found = 1;
                   4250:                                break;
1.315     schwarze 4251:                        }
                   4252:                }
1.325     schwarze 4253:        }
                   4254:
                   4255:        if (found == 0 && *deftype != ROFFDEF_ANY) {
                   4256:                if (*deftype & ROFFDEF_REN) {
                   4257:                        /*
                   4258:                         * This might still be a request,
                   4259:                         * so do not treat it as undefined yet.
                   4260:                         */
                   4261:                        *deftype = ROFFDEF_UNDEF;
                   4262:                        return NULL;
1.315     schwarze 4263:                }
1.325     schwarze 4264:
                   4265:                /* Using an undefined string defines it to be empty. */
                   4266:
                   4267:                roff_setstrn(&r->strtab, name, len, "", 0, 0);
                   4268:                roff_setstrn(&r->rentab, name, len, NULL, 0, 0);
1.315     schwarze 4269:        }
1.325     schwarze 4270:
1.315     schwarze 4271:        *deftype = 0;
1.277     schwarze 4272:        return NULL;
1.92      schwarze 4273: }
                   4274:
1.94      kristaps 4275: static void
1.167     kristaps 4276: roff_freestr(struct roffkv *r)
1.92      schwarze 4277: {
1.166     kristaps 4278:        struct roffkv    *n, *nn;
1.92      schwarze 4279:
1.167     kristaps 4280:        for (n = r; n; n = nn) {
1.166     kristaps 4281:                free(n->key.p);
                   4282:                free(n->val.p);
1.92      schwarze 4283:                nn = n->next;
                   4284:                free(n);
                   4285:        }
1.114     kristaps 4286: }
1.266     schwarze 4287:
                   4288: /* --- accessors and utility functions ------------------------------------ */
1.164     kristaps 4289:
                   4290: /*
                   4291:  * Duplicate an input string, making the appropriate character
                   4292:  * conversations (as stipulated by `tr') along the way.
                   4293:  * Returns a heap-allocated string with all the replacements made.
                   4294:  */
                   4295: char *
                   4296: roff_strdup(const struct roff *r, const char *p)
                   4297: {
1.166     kristaps 4298:        const struct roffkv *cp;
1.164     kristaps 4299:        char            *res;
                   4300:        const char      *pp;
                   4301:        size_t           ssz, sz;
                   4302:        enum mandoc_esc  esc;
                   4303:
1.167     kristaps 4304:        if (NULL == r->xmbtab && NULL == r->xtab)
1.277     schwarze 4305:                return mandoc_strdup(p);
1.164     kristaps 4306:        else if ('\0' == *p)
1.277     schwarze 4307:                return mandoc_strdup("");
1.164     kristaps 4308:
                   4309:        /*
                   4310:         * Step through each character looking for term matches
                   4311:         * (remember that a `tr' can be invoked with an escape, which is
                   4312:         * a glyph but the escape is multi-character).
                   4313:         * We only do this if the character hash has been initialised
                   4314:         * and the string is >0 length.
                   4315:         */
                   4316:
                   4317:        res = NULL;
                   4318:        ssz = 0;
                   4319:
                   4320:        while ('\0' != *p) {
1.289     schwarze 4321:                assert((unsigned int)*p < 128);
                   4322:                if ('\\' != *p && r->xtab && r->xtab[(unsigned int)*p].p) {
1.167     kristaps 4323:                        sz = r->xtab[(int)*p].sz;
                   4324:                        res = mandoc_realloc(res, ssz + sz + 1);
                   4325:                        memcpy(res + ssz, r->xtab[(int)*p].p, sz);
                   4326:                        ssz += sz;
                   4327:                        p++;
                   4328:                        continue;
                   4329:                } else if ('\\' != *p) {
                   4330:                        res = mandoc_realloc(res, ssz + 2);
                   4331:                        res[ssz++] = *p++;
                   4332:                        continue;
                   4333:                }
                   4334:
1.164     kristaps 4335:                /* Search for term matches. */
1.167     kristaps 4336:                for (cp = r->xmbtab; cp; cp = cp->next)
1.166     kristaps 4337:                        if (0 == strncmp(p, cp->key.p, cp->key.sz))
1.164     kristaps 4338:                                break;
                   4339:
                   4340:                if (NULL != cp) {
                   4341:                        /*
                   4342:                         * A match has been found.
                   4343:                         * Append the match to the array and move
                   4344:                         * forward by its keysize.
                   4345:                         */
1.207     schwarze 4346:                        res = mandoc_realloc(res,
                   4347:                            ssz + cp->val.sz + 1);
1.166     kristaps 4348:                        memcpy(res + ssz, cp->val.p, cp->val.sz);
                   4349:                        ssz += cp->val.sz;
                   4350:                        p += (int)cp->key.sz;
1.164     kristaps 4351:                        continue;
                   4352:                }
                   4353:
1.167     kristaps 4354:                /*
                   4355:                 * Handle escapes carefully: we need to copy
                   4356:                 * over just the escape itself, or else we might
                   4357:                 * do replacements within the escape itself.
                   4358:                 * Make sure to pass along the bogus string.
                   4359:                 */
                   4360:                pp = p++;
                   4361:                esc = mandoc_escape(&p, NULL, NULL);
                   4362:                if (ESCAPE_ERROR == esc) {
                   4363:                        sz = strlen(pp);
1.164     kristaps 4364:                        res = mandoc_realloc(res, ssz + sz + 1);
                   4365:                        memcpy(res + ssz, pp, sz);
1.167     kristaps 4366:                        break;
1.164     kristaps 4367:                }
1.207     schwarze 4368:                /*
                   4369:                 * We bail out on bad escapes.
1.167     kristaps 4370:                 * No need to warn: we already did so when
1.355     schwarze 4371:                 * roff_expand() was called.
1.167     kristaps 4372:                 */
                   4373:                sz = (int)(p - pp);
                   4374:                res = mandoc_realloc(res, ssz + sz + 1);
                   4375:                memcpy(res + ssz, pp, sz);
                   4376:                ssz += sz;
1.164     kristaps 4377:        }
                   4378:
                   4379:        res[(int)ssz] = '\0';
1.277     schwarze 4380:        return res;
1.227     schwarze 4381: }
                   4382:
                   4383: int
                   4384: roff_getformat(const struct roff *r)
                   4385: {
                   4386:
1.277     schwarze 4387:        return r->format;
1.174     kristaps 4388: }
                   4389:
                   4390: /*
1.207     schwarze 4391:  * Find out whether a line is a macro line or not.
1.174     kristaps 4392:  * If it is, adjust the current position and return one; if it isn't,
                   4393:  * return zero and don't change the current position.
                   4394:  * If the control character has been set with `.cc', then let that grain
                   4395:  * precedence.
1.396     schwarze 4396:  * This is slightly contrary to groff, where using the non-breaking
1.174     kristaps 4397:  * control character when `cc' has been invoked will cause the
                   4398:  * non-breaking macro contents to be printed verbatim.
                   4399:  */
                   4400: int
                   4401: roff_getcontrol(const struct roff *r, const char *cp, int *ppos)
                   4402: {
                   4403:        int             pos;
                   4404:
                   4405:        pos = *ppos;
                   4406:
1.303     schwarze 4407:        if (r->control != '\0' && cp[pos] == r->control)
1.174     kristaps 4408:                pos++;
1.303     schwarze 4409:        else if (r->control != '\0')
1.277     schwarze 4410:                return 0;
1.174     kristaps 4411:        else if ('\\' == cp[pos] && '.' == cp[pos + 1])
                   4412:                pos += 2;
                   4413:        else if ('.' == cp[pos] || '\'' == cp[pos])
                   4414:                pos++;
                   4415:        else
1.277     schwarze 4416:                return 0;
1.174     kristaps 4417:
                   4418:        while (' ' == cp[pos] || '\t' == cp[pos])
                   4419:                pos++;
                   4420:
                   4421:        *ppos = pos;
1.277     schwarze 4422:        return 1;
1.74      kristaps 4423: }

CVSweb