=================================================================== RCS file: /cvs/mandoc/roff.c,v retrieving revision 1.4 retrieving revision 1.92 diff -u -p -r1.4 -r1.92 --- mandoc/roff.c 2008/11/25 12:14:02 1.4 +++ mandoc/roff.c 2010/07/03 16:02:12 1.92 @@ -1,691 +1,1033 @@ -/* $Id: roff.c,v 1.4 2008/11/25 12:14:02 kristaps Exp $ */ +/* $Id: roff.c,v 1.92 2010/07/03 16:02:12 schwarze Exp $ */ /* - * Copyright (c) 2008 Kristaps Dzonsons + * Copyright (c) 2010 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any - * purpose with or without fee is hereby granted, provided that the - * above copyright notice and this permission notice appear in all - * copies. + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL - * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED - * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE - * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL - * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR - * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER - * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - * PERFORMANCE OF THIS SOFTWARE. + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + #include +#include #include -#include +#include #include -#include #include -#include +#include -#include "libmdocml.h" -#include "private.h" +#include "mandoc.h" +#include "regs.h" +#include "roff.h" -#define ROFF_MAXARG 10 +#define RSTACK_MAX 128 -enum roffd { - ROFF_ENTER = 0, - ROFF_EXIT -}; +#define ROFF_CTL(c) \ + ('.' == (c) || '\'' == (c)) -/* FIXME: prolog roffs can be text roffs, too. */ +#if 1 +#define ROFF_DEBUG(fmt, args...) \ + do { /* Nothing. */ } while (/*CONSTCOND*/ 0) +#else +#define ROFF_DEBUG(fmt, args...) \ + do { fprintf(stderr, fmt , ##args); } while (/*CONSTCOND*/ 0) +#endif -enum rofftype { - ROFF_COMMENT, - ROFF_TEXT, - ROFF_LAYOUT +enum rofft { + ROFF_am, + ROFF_ami, + ROFF_am1, + ROFF_de, + ROFF_dei, + ROFF_de1, + ROFF_ds, + ROFF_el, + ROFF_ie, + ROFF_if, + ROFF_ig, + ROFF_rm, + ROFF_tr, + ROFF_cblock, + ROFF_ccond, + ROFF_nr, + ROFF_MAX }; -#define ROFFCALL_ARGS \ - int tok, struct rofftree *tree, \ - const char *argv[], enum roffd type - -struct rofftree; - -struct rofftok { - int (*cb)(ROFFCALL_ARGS); - enum rofftype type; - int flags; -#define ROFF_NESTED (1 << 0) -#define ROFF_PARSED (1 << 1) -#define ROFF_CALLABLE (1 << 2) -#define ROFF_QUOTES (1 << 3) +enum roffrule { + ROFFRULE_ALLOW, + ROFFRULE_DENY }; -struct roffarg { - int tok; - int flags; -#define ROFF_VALUE (1 << 0) +struct roff { + struct roffnode *last; /* leaf of stack */ + mandocmsg msg; /* err/warn/fatal messages */ + void *data; /* privdata for messages */ + enum roffrule rstack[RSTACK_MAX]; /* stack of !`ie' rules */ + int rstackpos; /* position in rstack */ + struct regset *regs; /* read/writable registers */ }; struct roffnode { - int tok; - struct roffnode *parent; - size_t line; + enum rofft tok; /* type of node */ + struct roffnode *parent; /* up one in stack */ + int line; /* parse line */ + int col; /* parse col */ + char *end; /* end-rules: custom token */ + int endspan; /* end-rules: next-line or infty */ + enum roffrule rule; /* current evaluation rule */ }; -struct rofftree { - struct roffnode *last; - time_t date; - char os[64]; - char title[64]; - char section[64]; - char volume[64]; - int state; -#define ROFF_PRELUDE (1 << 1) -#define ROFF_PRELUDE_Os (1 << 2) -#define ROFF_PRELUDE_Dt (1 << 3) -#define ROFF_PRELUDE_Dd (1 << 4) -#define ROFF_BODY (1 << 5) +#define ROFF_ARGS struct roff *r, /* parse ctx */ \ + enum rofft tok, /* tok of macro */ \ + char **bufp, /* input buffer */ \ + size_t *szp, /* size of input buffer */ \ + int ln, /* parse line */ \ + int ppos, /* original pos in buffer */ \ + int pos, /* current pos in buffer */ \ + int *offs /* reset offset of buffer data */ - roffin roffin; - roffblkin roffblkin; - roffout roffout; - roffblkout roffblkout; +typedef enum rofferr (*roffproc)(ROFF_ARGS); - struct md_mbuf *mbuf; /* NULL if !flush. */ - const struct md_args *args; - const struct md_rbuf *rbuf; +struct roffmac { + const char *name; /* macro name */ + roffproc proc; /* process new macro */ + roffproc text; /* process as child text of macro */ + roffproc sub; /* process as child of macro */ + int flags; +#define ROFFMAC_STRUCT (1 << 0) /* always interpret */ + struct roffmac *next; }; -static int roff_Dd(ROFFCALL_ARGS); -static int roff_Dt(ROFFCALL_ARGS); -static int roff_Os(ROFFCALL_ARGS); +struct roffstr { + char *name; + char *string; + struct roffstr *next; +} *first_string; -static int roff_layout(ROFFCALL_ARGS); -static int roff_text(ROFFCALL_ARGS); +static enum rofferr roff_block(ROFF_ARGS); +static enum rofferr roff_block_text(ROFF_ARGS); +static enum rofferr roff_block_sub(ROFF_ARGS); +static enum rofferr roff_cblock(ROFF_ARGS); +static enum rofferr roff_ccond(ROFF_ARGS); +static enum rofferr roff_cond(ROFF_ARGS); +static enum rofferr roff_cond_text(ROFF_ARGS); +static enum rofferr roff_cond_sub(ROFF_ARGS); +static enum rofferr roff_ds(ROFF_ARGS); +static enum rofferr roff_line(ROFF_ARGS); +static enum rofferr roff_nr(ROFF_ARGS); +static enum roffrule roff_evalcond(const char *, int *); -static struct roffnode *roffnode_new(int, struct rofftree *); -static void roffnode_free(int, struct rofftree *); +/* See roff_hash_find() */ -static int rofffindtok(const char *); -static int rofffindarg(const char *); -static int rofffindcallable(const char *); -static int roffargs(int, char *, char **); -static int roffparse(struct rofftree *, char *, size_t); -static int textparse(const struct rofftree *, - const char *, size_t); +#define ASCII_HI 126 +#define ASCII_LO 33 +#define HASHWIDTH (ASCII_HI - ASCII_LO + 1) +static struct roffmac *hash[HASHWIDTH]; -static const struct rofftok tokens[ROFF_MAX] = { - { NULL, ROFF_COMMENT, 0 }, - { roff_Dd, ROFF_TEXT, 0 }, /* Dd */ - { roff_Dt, ROFF_TEXT, 0 }, /* Dt */ - { roff_Os, ROFF_TEXT, 0 }, /* Os */ - { roff_layout, ROFF_LAYOUT, ROFF_PARSED }, /* Sh */ - { roff_layout, ROFF_LAYOUT, ROFF_PARSED }, /* Ss XXX */ - { roff_layout, ROFF_LAYOUT, 0 }, /* Pp */ - { roff_layout, ROFF_LAYOUT, 0 }, /* D1 */ - { roff_layout, ROFF_LAYOUT, 0 }, /* Dl */ - { roff_layout, ROFF_LAYOUT, 0 }, /* Bd */ - { roff_layout, ROFF_LAYOUT, 0 }, /* Ed */ - { roff_layout, ROFF_LAYOUT, 0 }, /* Bl */ - { roff_layout, ROFF_LAYOUT, 0 }, /* El */ - { roff_layout, ROFF_LAYOUT, 0 }, /* It */ - { roff_text, ROFF_TEXT, ROFF_PARSED }, /* An */ - { roff_text, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Li */ +static struct roffmac roffs[ROFF_MAX] = { + { "am", roff_block, roff_block_text, roff_block_sub, 0, NULL }, + { "ami", roff_block, roff_block_text, roff_block_sub, 0, NULL }, + { "am1", roff_block, roff_block_text, roff_block_sub, 0, NULL }, + { "de", roff_block, roff_block_text, roff_block_sub, 0, NULL }, + { "dei", roff_block, roff_block_text, roff_block_sub, 0, NULL }, + { "de1", roff_block, roff_block_text, roff_block_sub, 0, NULL }, + { "ds", roff_ds, NULL, NULL, 0, NULL }, + { "el", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL }, + { "ie", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL }, + { "if", roff_cond, roff_cond_text, roff_cond_sub, ROFFMAC_STRUCT, NULL }, + { "ig", roff_block, roff_block_text, roff_block_sub, 0, NULL }, + { "rm", roff_line, NULL, NULL, 0, NULL }, + { "tr", roff_line, NULL, NULL, 0, NULL }, + { ".", roff_cblock, NULL, NULL, 0, NULL }, + { "\\}", roff_ccond, NULL, NULL, 0, NULL }, + { "nr", roff_nr, NULL, NULL, 0, NULL }, }; -/* FIXME: multiple owners? */ +static void roff_free1(struct roff *); +static enum rofft roff_hash_find(const char *); +static void roff_hash_init(void); +static void roffnode_cleanscope(struct roff *); +static int roffnode_push(struct roff *, + enum rofft, int, int); +static void roffnode_pop(struct roff *); +static enum rofft roff_parse(const char *, int *); +static int roff_parse_nat(const char *, unsigned int *); -static const struct roffarg tokenargs[ROFF_ARGMAX] = { - { ROFF_An, 0 }, /* split */ - { ROFF_An, 0 }, /* nosplit */ - { ROFF_Bd, 0 }, /* ragged */ - { ROFF_Bd, 0 }, /* unfilled */ - { ROFF_Bd, 0 }, /* literal */ - { ROFF_Bd, ROFF_VALUE }, /* file */ - { ROFF_Bd, ROFF_VALUE }, /* offset */ - { ROFF_Bl, 0 }, /* bullet */ - { ROFF_Bl, 0 }, /* dash */ - { ROFF_Bl, 0 }, /* hyphen */ - { ROFF_Bl, 0 }, /* item */ - { ROFF_Bl, 0 }, /* enum */ - { ROFF_Bl, 0 }, /* tag */ - { ROFF_Bl, 0 }, /* diag */ - { ROFF_Bl, 0 }, /* hang */ - { ROFF_Bl, 0 }, /* ohang */ - { ROFF_Bl, 0 }, /* inset */ - { ROFF_Bl, 0 }, /* column */ -}; +/* See roff_hash_find() */ +#define ROFF_HASH(p) (p[0] - ASCII_LO) -static const char *const toknames[ROFF_MAX] = ROFF_NAMES; -static const char *const tokargnames[ROFF_ARGMAX] = ROFF_ARGNAMES; - - -int -roff_free(struct rofftree *tree, int flush) +static void +roff_hash_init(void) { - int error; + struct roffmac *n; + int buc, i; - assert(tree->mbuf); - if ( ! flush) - tree->mbuf = NULL; + for (i = 0; i < (int)ROFF_MAX; i++) { + assert(roffs[i].name[0] >= ASCII_LO); + assert(roffs[i].name[0] <= ASCII_HI); - /* LINTED */ - while (tree->last) - if ( ! (*tokens[tree->last->tok].cb) - (tree->last->tok, tree, NULL, ROFF_EXIT)) - /* Disallow flushing. */ - tree->mbuf = NULL; + buc = ROFF_HASH(roffs[i].name); - error = tree->mbuf ? 0 : 1; - - if (tree->mbuf && (ROFF_PRELUDE & tree->state)) { - warnx("%s: prelude never finished", - tree->rbuf->name); - error = 1; + if (NULL != (n = hash[buc])) { + for ( ; n->next; n = n->next) + /* Do nothing. */ ; + n->next = &roffs[i]; + } else + hash[buc] = &roffs[i]; } - - free(tree); - return(error ? 0 : 1); } -struct rofftree * -roff_alloc(const struct md_args *args, struct md_mbuf *out, - const struct md_rbuf *in, roffin textin, - roffout textout, roffblkin blkin, roffblkout blkout) +/* + * Look up a roff token by its name. Returns ROFF_MAX if no macro by + * the nil-terminated string name could be found. + */ +static enum rofft +roff_hash_find(const char *p) { - struct rofftree *tree; + int buc; + struct roffmac *n; - if (NULL == (tree = calloc(1, sizeof(struct rofftree)))) { - warn("malloc"); - return(NULL); - } + /* + * libroff has an extremely simple hashtable, for the time + * being, which simply keys on the first character, which must + * be printable, then walks a chain. It works well enough until + * optimised. + */ - tree->state = ROFF_PRELUDE; - tree->args = args; - tree->mbuf = out; - tree->rbuf = in; - tree->roffin = textin; - tree->roffout = textout; - tree->roffblkin = blkin; - tree->roffblkout = blkout; + if (p[0] < ASCII_LO || p[0] > ASCII_HI) + return(ROFF_MAX); - return(tree); + buc = ROFF_HASH(p); + + if (NULL == (n = hash[buc])) + return(ROFF_MAX); + for ( ; n; n = n->next) + if (0 == strcmp(n->name, p)) + return((enum rofft)(n - roffs)); + + return(ROFF_MAX); } -int -roff_engine(struct rofftree *tree, char *buf, size_t sz) +/* + * Pop the current node off of the stack of roff instructions currently + * pending. + */ +static void +roffnode_pop(struct roff *r) { + struct roffnode *p; - if (0 == sz) { - warnx("%s: blank line (line %zu)", - tree->rbuf->name, - tree->rbuf->line); - return(0); - } else if ('.' != *buf) - return(textparse(tree, buf, sz)); + assert(r->last); + p = r->last; - return(roffparse(tree, buf, sz)); + if (ROFF_el == p->tok) + if (r->rstackpos > -1) + r->rstackpos--; + + r->last = r->last->parent; + if (p->end) + free(p->end); + free(p); } +/* + * Push a roff node onto the instruction stack. This must later be + * removed with roffnode_pop(). + */ static int -textparse(const struct rofftree *tree, const char *buf, size_t sz) +roffnode_push(struct roff *r, enum rofft tok, int line, int col) { - - if (NULL == tree->last) { - warnx("%s: unexpected text (line %zu)", - tree->rbuf->name, - tree->rbuf->line); + struct roffnode *p; + + if (NULL == (p = calloc(1, sizeof(struct roffnode)))) { + (*r->msg)(MANDOCERR_MEM, r->data, line, col, NULL); return(0); - } else if (NULL == tree->last->parent) { - warnx("%s: disallowed text (line %zu)", - tree->rbuf->name, - tree->rbuf->line); - return(0); } - /* Print text. */ + p->tok = tok; + p->parent = r->last; + p->line = line; + p->col = col; + p->rule = p->parent ? p->parent->rule : ROFFRULE_DENY; + r->last = p; return(1); } -static int -roffargs(int tok, char *buf, char **argv) +static void +roff_free1(struct roff *r) { - int i; - (void)tok;/* FIXME: quotable strings? */ + while (r->last) + roffnode_pop(r); + roff_freestr(); +} - assert(tok >= 0 && tok < ROFF_MAX); - assert('.' == *buf); - /* LINTED */ - for (i = 0; *buf && i < ROFF_MAXARG; i++) { - argv[i] = buf++; - while (*buf && ! isspace(*buf)) - buf++; - if (0 == *buf) { - continue; - } - *buf++ = 0; - while (*buf && isspace(*buf)) - buf++; - } - - assert(i > 0); - if (i < ROFF_MAXARG) - argv[i] = NULL; +void +roff_reset(struct roff *r) +{ - return(ROFF_MAXARG > i); + roff_free1(r); } -static int -roffparse(struct rofftree *tree, char *buf, size_t sz) +void +roff_free(struct roff *r) { - int tok, t; - struct roffnode *node; - char *argv[ROFF_MAXARG]; - const char **argvp; - assert(sz > 0); + roff_free1(r); + free(r); +} - /* - * Extract the token identifier from the buffer. If there's no - * callback for the token (comment, etc.) then exit immediately. - * We don't do any error handling (yet), so if the token doesn't - * exist, die. - */ - if (3 > sz) { - warnx("%s: malformed line (line %zu)", - tree->rbuf->name, - tree->rbuf->line); +struct roff * +roff_alloc(struct regset *regs, const mandocmsg msg, void *data) +{ + struct roff *r; + + if (NULL == (r = calloc(1, sizeof(struct roff)))) { + (*msg)(MANDOCERR_MEM, data, 0, 0, NULL); return(0); - } else if (ROFF_MAX == (tok = rofffindtok(buf + 1))) { - warnx("%s: unknown line token `%c%c' (line %zu)", - tree->rbuf->name, - *(buf + 1), *(buf + 2), - tree->rbuf->line); - return(0); - } else if (ROFF_COMMENT == tokens[tok].type) - /* Ignore comment tokens. */ - return(1); - - if ( ! roffargs(tok, buf, argv)) { - warnx("%s: too many arguments to `%s' (line %zu)", - tree->rbuf->name, toknames[tok], - tree->rbuf->line); - return(0); } - /* - * If this is a non-nestable layout token and we're below a - * token of the same type, then recurse upward to the token, - * closing out the interim scopes. - * - * If there's a nested token on the chain, then raise an error - * as nested tokens have corresponding "ending" tokens and we're - * breaking their scope. - */ + r->regs = regs; + r->msg = msg; + r->data = data; + r->rstackpos = -1; + + roff_hash_init(); + return(r); +} - node = NULL; - if (ROFF_LAYOUT == tokens[tok].type && - ! (ROFF_NESTED & tokens[tok].flags)) { - for (node = tree->last; node; node = node->parent) { - if (node->tok == tok) - break; +enum rofferr +roff_parseln(struct roff *r, int ln, char **bufp, + size_t *szp, int pos, int *offs) +{ + enum rofft t; + int ppos; - /* Don't break nested scope. */ + /* + * First, if a scope is open and we're not a macro, pass the + * text through the macro's filter. If a scope isn't open and + * we're not a macro, just let it through. + */ - if ( ! (ROFF_NESTED & tokens[node->tok].flags)) - continue; - warnx("%s: scope of %s (line %zu) broken by " - "%s (line %zu)", - tree->rbuf->name, - toknames[tok], node->line, - toknames[node->tok], - tree->rbuf->line); - return(0); - } + if (r->last && ! ROFF_CTL((*bufp)[pos])) { + t = r->last->tok; + assert(roffs[t].text); + ROFF_DEBUG("roff: intercept scoped text: %s, [%s]\n", + roffs[t].name, &(*bufp)[pos]); + return((*roffs[t].text) + (r, t, bufp, szp, + ln, pos, pos, offs)); + } else if ( ! ROFF_CTL((*bufp)[pos])) { + ROFF_DEBUG("roff: pass non-scoped text: [%s]\n", + &(*bufp)[pos]); + return(ROFF_CONT); } - if (node) { - assert(ROFF_LAYOUT == tokens[tok].type); - assert( ! (ROFF_NESTED & tokens[tok].flags)); - assert(node->tok == tok); + /* + * If a scope is open, go to the child handler for that macro, + * as it may want to preprocess before doing anything with it. + */ - /* Clear up to last scoped token. */ - - /* LINTED */ - do { - t = tree->last->tok; - if ( ! (*tokens[tree->last->tok].cb) - (tree->last->tok, tree, NULL, ROFF_EXIT)) - return(0); - } while (t != tok); + if (r->last) { + t = r->last->tok; + assert(roffs[t].sub); + ROFF_DEBUG("roff: intercept scoped context: %s\n", + roffs[t].name); + return((*roffs[t].sub) + (r, t, bufp, szp, + ln, pos, pos, offs)); } - /* Proceed with actual token processing. */ + /* + * Lastly, as we've no scope open, try to look up and execute + * the new macro. If no macro is found, simply return and let + * the compilers handle it. + */ - argvp = (const char **)&argv[1]; - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); + ppos = pos; + if (ROFF_MAX == (t = roff_parse(*bufp, &pos))) { + ROFF_DEBUG("roff: pass non-scoped non-macro: [%s]\n", + &(*bufp)[pos]); + return(ROFF_CONT); + } + + ROFF_DEBUG("roff: intercept new-scope: %s, [%s]\n", + roffs[t].name, &(*bufp)[pos]); + assert(roffs[t].proc); + return((*roffs[t].proc) + (r, t, bufp, szp, + ln, ppos, pos, offs)); } -static int -rofffindarg(const char *name) +int +roff_endparse(struct roff *r) { - size_t i; - /* FIXME: use a table, this is slow but ok for now. */ - - /* LINTED */ - for (i = 0; i < ROFF_ARGMAX; i++) - /* LINTED */ - if (0 == strcmp(name, tokargnames[i])) - return((int)i); - - return(ROFF_ARGMAX); + if (NULL == r->last) + return(1); + return((*r->msg)(MANDOCERR_SCOPEEXIT, r->data, r->last->line, + r->last->col, NULL)); } -static int -rofffindtok(const char *name) +/* + * Parse a roff node's type from the input buffer. This must be in the + * form of ".foo xxx" in the usual way. + */ +static enum rofft +roff_parse(const char *buf, int *pos) { - size_t i; + int j; + char mac[5]; + enum rofft t; - /* FIXME: use a table, this is slow but ok for now. */ + assert(ROFF_CTL(buf[*pos])); + (*pos)++; - /* LINTED */ - for (i = 0; i < ROFF_MAX; i++) - /* LINTED */ - if (0 == strncmp(name, toknames[i], 2)) - return((int)i); - - return(ROFF_MAX); + while (buf[*pos] && (' ' == buf[*pos] || '\t' == buf[*pos])) + (*pos)++; + + if ('\0' == buf[*pos]) + return(ROFF_MAX); + + for (j = 0; j < 4; j++, (*pos)++) + if ('\0' == (mac[j] = buf[*pos])) + break; + else if (' ' == buf[*pos] || (j && '\\' == buf[*pos])) + break; + + if (j == 4 || j < 1) + return(ROFF_MAX); + + mac[j] = '\0'; + + if (ROFF_MAX == (t = roff_hash_find(mac))) + return(t); + + while (buf[*pos] && ' ' == buf[*pos]) + (*pos)++; + + return(t); } static int -rofffindcallable(const char *name) +roff_parse_nat(const char *buf, unsigned int *res) { - int c; + char *ep; + long lval; - if (ROFF_MAX == (c = rofffindtok(name))) - return(ROFF_MAX); - return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX); + errno = 0; + lval = strtol(buf, &ep, 10); + if (buf[0] == '\0' || *ep != '\0') + return(0); + if ((errno == ERANGE && + (lval == LONG_MAX || lval == LONG_MIN)) || + (lval > INT_MAX || lval < 0)) + return(0); + + *res = (unsigned int)lval; + return(1); } -static struct roffnode * -roffnode_new(int tokid, struct rofftree *tree) +/* ARGSUSED */ +static enum rofferr +roff_cblock(ROFF_ARGS) { - struct roffnode *p; - - if (NULL == (p = malloc(sizeof(struct roffnode)))) { - warn("malloc"); - return(NULL); + + /* + * A block-close `..' should only be invoked as a child of an + * ignore macro, otherwise raise a warning and just ignore it. + */ + + if (NULL == r->last) { + if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL)) + return(ROFF_ERR); + return(ROFF_IGN); } - p->line = tree->rbuf->line; - p->tok = tokid; - p->parent = tree->last; - tree->last = p; - return(p); + switch (r->last->tok) { + case (ROFF_am): + /* FALLTHROUGH */ + case (ROFF_ami): + /* FALLTHROUGH */ + case (ROFF_am1): + /* FALLTHROUGH */ + case (ROFF_de): + /* FALLTHROUGH */ + case (ROFF_dei): + /* FALLTHROUGH */ + case (ROFF_de1): + /* FALLTHROUGH */ + case (ROFF_ig): + break; + default: + if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL)) + return(ROFF_ERR); + return(ROFF_IGN); + } + + if ((*bufp)[pos]) + if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL)) + return(ROFF_ERR); + + roffnode_pop(r); + roffnode_cleanscope(r); + return(ROFF_IGN); + } static void -roffnode_free(int tokid, struct rofftree *tree) +roffnode_cleanscope(struct roff *r) { - struct roffnode *p; - assert(tree->last); - assert(tree->last->tok == tokid); - - p = tree->last; - tree->last = tree->last->parent; - free(p); + while (r->last) { + if (--r->last->endspan < 0) + break; + roffnode_pop(r); + } } /* ARGSUSED */ -static int -roff_Dd(ROFFCALL_ARGS) +static enum rofferr +roff_ccond(ROFF_ARGS) { - if (ROFF_BODY & tree->state) { - assert( ! (ROFF_PRELUDE & tree->state)); - assert(ROFF_PRELUDE_Dd & tree->state); - return(roff_text(tok, tree, argv, type)); + if (NULL == r->last) { + if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL)) + return(ROFF_ERR); + return(ROFF_IGN); } - assert(ROFF_PRELUDE & tree->state); - assert( ! (ROFF_BODY & tree->state)); + switch (r->last->tok) { + case (ROFF_el): + /* FALLTHROUGH */ + case (ROFF_ie): + /* FALLTHROUGH */ + case (ROFF_if): + break; + default: + if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL)) + return(ROFF_ERR); + return(ROFF_IGN); + } - if (ROFF_PRELUDE_Dd & tree->state || - ROFF_PRELUDE_Dt & tree->state) { - warnx("%s: prelude `Dd' out-of-order (line %zu)", - tree->rbuf->name, tree->rbuf->line); - return(0); + if (r->last->endspan > -1) { + if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL)) + return(ROFF_ERR); + return(ROFF_IGN); } - /* TODO: parse date. */ + if ((*bufp)[pos]) + if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL)) + return(ROFF_ERR); - assert(NULL == tree->last); - tree->state |= ROFF_PRELUDE_Dd; - - return(1); + roffnode_pop(r); + roffnode_cleanscope(r); + return(ROFF_IGN); } /* ARGSUSED */ -static int -roff_Dt(ROFFCALL_ARGS) +static enum rofferr +roff_block(ROFF_ARGS) { + int sv; + size_t sz; - if (ROFF_BODY & tree->state) { - assert( ! (ROFF_PRELUDE & tree->state)); - assert(ROFF_PRELUDE_Dt & tree->state); - return(roff_text(tok, tree, argv, type)); + if (ROFF_ig != tok && '\0' == (*bufp)[pos]) { + if ( ! (*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL)) + return(ROFF_ERR); + return(ROFF_IGN); + } else if (ROFF_ig != tok) { + while ((*bufp)[pos] && ' ' != (*bufp)[pos]) + pos++; + while (' ' == (*bufp)[pos]) + pos++; } - assert(ROFF_PRELUDE & tree->state); - assert( ! (ROFF_BODY & tree->state)); + if ( ! roffnode_push(r, tok, ln, ppos)) + return(ROFF_ERR); - if ( ! (ROFF_PRELUDE_Dd & tree->state) || - (ROFF_PRELUDE_Dt & tree->state)) { - warnx("%s: prelude `Dt' out-of-order (line %zu)", - tree->rbuf->name, tree->rbuf->line); - return(0); + if ('\0' == (*bufp)[pos]) + return(ROFF_IGN); + + sv = pos; + while ((*bufp)[pos] && ' ' != (*bufp)[pos] && + '\t' != (*bufp)[pos]) + pos++; + + /* + * Note: groff does NOT like escape characters in the input. + * Instead of detecting this, we're just going to let it fly and + * to hell with it. + */ + + assert(pos > sv); + sz = (size_t)(pos - sv); + + if (1 == sz && '.' == (*bufp)[sv]) + return(ROFF_IGN); + + r->last->end = malloc(sz + 1); + + if (NULL == r->last->end) { + (*r->msg)(MANDOCERR_MEM, r->data, ln, pos, NULL); + return(ROFF_ERR); } - /* TODO: parse date. */ + memcpy(r->last->end, *bufp + sv, sz); + r->last->end[(int)sz] = '\0'; - assert(NULL == tree->last); - tree->state |= ROFF_PRELUDE_Dt; + if ((*bufp)[pos]) + if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, pos, NULL)) + return(ROFF_ERR); - return(1); + return(ROFF_IGN); } /* ARGSUSED */ -static int -roff_Os(ROFFCALL_ARGS) +static enum rofferr +roff_block_sub(ROFF_ARGS) { + enum rofft t; + int i, j; - if (ROFF_EXIT == type) { - assert(ROFF_PRELUDE_Os & tree->state); - return(roff_layout(tok, tree, argv, type)); - } else if (ROFF_BODY & tree->state) { - assert( ! (ROFF_PRELUDE & tree->state)); - assert(ROFF_PRELUDE_Os & tree->state); - return(roff_text(tok, tree, argv, type)); - } + /* + * First check whether a custom macro exists at this level. If + * it does, then check against it. This is some of groff's + * stranger behaviours. If we encountered a custom end-scope + * tag and that tag also happens to be a "real" macro, then we + * need to try interpreting it again as a real macro. If it's + * not, then return ignore. Else continue. + */ - assert(ROFF_PRELUDE & tree->state); - if ( ! (ROFF_PRELUDE_Dt & tree->state) || - ! (ROFF_PRELUDE_Dd & tree->state)) { - warnx("%s: prelude `Os' out-of-order (line %zu)", - tree->rbuf->name, tree->rbuf->line); - return(0); + if (r->last->end) { + i = pos + 1; + while (' ' == (*bufp)[i] || '\t' == (*bufp)[i]) + i++; + + for (j = 0; r->last->end[j]; j++, i++) + if ((*bufp)[i] != r->last->end[j]) + break; + + if ('\0' == r->last->end[j] && + ('\0' == (*bufp)[i] || + ' ' == (*bufp)[i] || + '\t' == (*bufp)[i])) { + roffnode_pop(r); + roffnode_cleanscope(r); + + if (ROFF_MAX != roff_parse(*bufp, &pos)) + return(ROFF_RERUN); + return(ROFF_IGN); + } } - /* TODO: extract OS. */ + /* + * If we have no custom end-query or lookup failed, then try + * pulling it out of the hashtable. + */ - tree->state |= ROFF_PRELUDE_Os; - tree->state &= ~ROFF_PRELUDE; - tree->state |= ROFF_BODY; + ppos = pos; + t = roff_parse(*bufp, &pos); - assert(NULL == tree->last); + /* If we're not a comment-end, then throw it away. */ + if (ROFF_cblock != t) + return(ROFF_IGN); - return(roff_layout(tok, tree, argv, type)); + assert(roffs[t].proc); + return((*roffs[t].proc)(r, t, bufp, szp, + ln, ppos, pos, offs)); } -/* ARGUSED */ -static int -roffnextopt(const char ***in, char **val) +/* ARGSUSED */ +static enum rofferr +roff_block_text(ROFF_ARGS) { - const char *arg, **argv; - int v; - *val = NULL; - argv = *in; - assert(argv); + return(ROFF_IGN); +} - if (NULL == (arg = *argv)) - return(-1); - if ('-' != *arg) - return(-1); - if (ROFF_ARGMAX == (v = rofffindarg(&arg[1]))) - return(-1); - if ( ! (ROFF_VALUE & tokenargs[v].flags)) - return(v); - *in = ++argv; +/* ARGSUSED */ +static enum rofferr +roff_cond_sub(ROFF_ARGS) +{ + enum rofft t; + enum roffrule rr; + struct roffnode *l; - /* FIXME: what if this looks like a roff token or argument? */ + ppos = pos; + rr = r->last->rule; - return(*argv ? v : ROFF_ARGMAX); + /* + * Clean out scope. If we've closed ourselves, then don't + * continue. + */ + + l = r->last; + roffnode_cleanscope(r); + + if (l != r->last) + return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT); + + if (ROFF_MAX == (t = roff_parse(*bufp, &pos))) + return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT); + + /* + * A denied conditional must evaluate its children if and only + * if they're either structurally required (such as loops and + * conditionals) or a closing macro. + */ + if (ROFFRULE_DENY == rr) + if ( ! (ROFFMAC_STRUCT & roffs[t].flags)) + if (ROFF_ccond != t) + return(ROFF_IGN); + + assert(roffs[t].proc); + return((*roffs[t].proc)(r, t, bufp, szp, + ln, ppos, pos, offs)); } /* ARGSUSED */ -static int -roff_layout(ROFFCALL_ARGS) +static enum rofferr +roff_cond_text(ROFF_ARGS) { - int i, c, argcp[ROFF_MAXARG]; - char *v, *argvp[ROFF_MAXARG]; + char *ep, *st; + enum roffrule rr; - if (ROFF_PRELUDE & tree->state) { - warnx("%s: macro `%s' called in prelude (line %zu)", - tree->rbuf->name, toknames[tok], - tree->rbuf->line); - return(0); + rr = r->last->rule; + + /* + * We display the value of the text if out current evaluation + * scope permits us to do so. + */ + + st = &(*bufp)[pos]; + if (NULL == (ep = strstr(st, "\\}"))) { + roffnode_cleanscope(r); + return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT); } - if (ROFF_EXIT == type) { - roffnode_free(tok, tree); - return((*tree->roffblkout)(tok)); - } + if (ep == st || (ep > st && '\\' != *(ep - 1))) + roffnode_pop(r); - i = 0; - while (-1 != (c = roffnextopt(&argv, &v))) { - if (ROFF_ARGMAX == c) { - warnx("%s: error parsing `%s' args (line %zu)", - tree->rbuf->name, - toknames[tok], - tree->rbuf->line); - return(0); - } - argcp[i] = c; - argvp[i] = v; - argv++; + roffnode_cleanscope(r); + return(ROFFRULE_DENY == rr ? ROFF_IGN : ROFF_CONT); +} + + +static enum roffrule +roff_evalcond(const char *v, int *pos) +{ + + switch (v[*pos]) { + case ('n'): + (*pos)++; + return(ROFFRULE_ALLOW); + case ('e'): + /* FALLTHROUGH */ + case ('o'): + /* FALLTHROUGH */ + case ('t'): + (*pos)++; + return(ROFFRULE_DENY); + default: + break; } - if (NULL == roffnode_new(tok, tree)) - return(0); + while (v[*pos] && ' ' != v[*pos]) + (*pos)++; + return(ROFFRULE_DENY); +} - if ( ! (*tree->roffin)(tok, argcp, argvp)) - return(0); - if ( ! (ROFF_PARSED & tokens[tok].flags)) { - /* TODO: print all tokens. */ +/* ARGSUSED */ +static enum rofferr +roff_line(ROFF_ARGS) +{ - if ( ! ((*tree->roffout)(tok))) - return(0); - return((*tree->roffblkin)(tok)); + return(ROFF_IGN); +} + + +/* ARGSUSED */ +static enum rofferr +roff_cond(ROFF_ARGS) +{ + int sv; + enum roffrule rule; + + /* Stack overflow! */ + + if (ROFF_ie == tok && r->rstackpos == RSTACK_MAX - 1) { + (*r->msg)(MANDOCERR_MEM, r->data, ln, ppos, NULL); + return(ROFF_ERR); } - while (*argv) { - if (2 >= strlen(*argv) && ROFF_MAX != - (c = rofffindcallable(*argv))) - if ( ! (*tokens[c].cb)(c, tree, - argv + 1, ROFF_ENTER)) - return(0); + /* First, evaluate the conditional. */ - /* TODO: print token. */ - argv++; + if (ROFF_el == tok) { + /* + * An `.el' will get the value of the current rstack + * entry set in prior `ie' calls or defaults to DENY. + */ + if (r->rstackpos < 0) + rule = ROFFRULE_DENY; + else + rule = r->rstack[r->rstackpos]; + } else + rule = roff_evalcond(*bufp, &pos); + + sv = pos; + + while (' ' == (*bufp)[pos]) + pos++; + + /* + * Roff is weird. If we have just white-space after the + * conditional, it's considered the BODY and we exit without + * really doing anything. Warn about this. It's probably + * wrong. + */ + + if ('\0' == (*bufp)[pos] && sv != pos) { + if ((*r->msg)(MANDOCERR_NOARGS, r->data, ln, ppos, NULL)) + return(ROFF_IGN); + return(ROFF_ERR); } - if ( ! ((*tree->roffout)(tok))) - return(0); + if ( ! roffnode_push(r, tok, ln, ppos)) + return(ROFF_ERR); - return((*tree->roffblkin)(tok)); + r->last->rule = rule; + + ROFF_DEBUG("roff: cond: %s -> %s\n", roffs[tok].name, + ROFFRULE_ALLOW == rule ? "allow" : "deny"); + + if (ROFF_ie == tok) { + /* + * An if-else will put the NEGATION of the current + * evaluated conditional into the stack. + */ + r->rstackpos++; + if (ROFFRULE_DENY == r->last->rule) + r->rstack[r->rstackpos] = ROFFRULE_ALLOW; + else + r->rstack[r->rstackpos] = ROFFRULE_DENY; + } + + /* If the parent has false as its rule, then so do we. */ + + if (r->last->parent && ROFFRULE_DENY == r->last->parent->rule) { + r->last->rule = ROFFRULE_DENY; + ROFF_DEBUG("roff: cond override: %s -> deny\n", + roffs[tok].name); + } + + /* + * Determine scope. If we're invoked with "\{" trailing the + * conditional, then we're in a multiline scope. Else our scope + * expires on the next line. + */ + + r->last->endspan = 1; + + if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) { + r->last->endspan = -1; + pos += 2; + ROFF_DEBUG("roff: cond-scope: %s, multi-line\n", + roffs[tok].name); + } else + ROFF_DEBUG("roff: cond-scope: %s, one-line\n", + roffs[tok].name); + + /* + * If there are no arguments on the line, the next-line scope is + * assumed. + */ + + if ('\0' == (*bufp)[pos]) + return(ROFF_IGN); + + /* Otherwise re-run the roff parser after recalculating. */ + + *offs = pos; + return(ROFF_RERUN); } /* ARGSUSED */ -static int -roff_text(ROFFCALL_ARGS) +static enum rofferr +roff_ds(ROFF_ARGS) { - int i, c, argcp[ROFF_MAXARG]; - char *v, *argvp[ROFF_MAXARG]; + char *name, *string, *end; - if (ROFF_PRELUDE & tree->state) { - warnx("%s: macro `%s' called in prelude (line %zu)", - tree->rbuf->name, toknames[tok], - tree->rbuf->line); - return(0); + name = *bufp + pos; + if ('\0' == *name) + return(ROFF_IGN); + + string = name; + while (*string && ' ' != *string) + string++; + if (*string) + *(string++) = NULL; + if (*string && '"' == *string) + string++; + while (*string && ' ' == *string) + string++; + end = string; + while (*end) + end++; + if (string < end) { + end--; + if (*end == '"') + *end = '\0'; } - i = 0; - while (-1 != (c = roffnextopt(&argv, &v))) { - if (ROFF_ARGMAX == c) { - warnx("%s: error parsing `%s' args (line %zu)", - tree->rbuf->name, - toknames[tok], - tree->rbuf->line); - return(0); + roff_setstr(name, string); + return(ROFF_IGN); +} + + +/* ARGSUSED */ +static enum rofferr +roff_nr(ROFF_ARGS) +{ + const char *key, *val; + struct reg *rg; + + key = &(*bufp)[pos]; + rg = r->regs->regs; + + /* Parse register request. */ + while ((*bufp)[pos] && ' ' != (*bufp)[pos]) + pos++; + + /* + * Set our nil terminator. Because this line is going to be + * ignored anyway, we can munge it as we please. + */ + if ((*bufp)[pos]) + (*bufp)[pos++] = '\0'; + + /* Skip whitespace to register token. */ + while ((*bufp)[pos] && ' ' == (*bufp)[pos]) + pos++; + + val = &(*bufp)[pos]; + + /* Process register token. */ + + if (0 == strcmp(key, "nS")) { + rg[(int)REG_nS].set = 1; + if ( ! roff_parse_nat(val, &rg[(int)REG_nS].v.u)) + rg[(int)REG_nS].v.u = 0; + + ROFF_DEBUG("roff: register nS: %u\n", + rg[(int)REG_nS].v.u); + } else + ROFF_DEBUG("roff: ignoring register: %s\n", key); + + return(ROFF_IGN); +} + + +char * +roff_setstr(const char *name, const char *string) +{ + struct roffstr *n; + char *namecopy; + + n = first_string; + while (n && strcmp(name, n->name)) + n = n->next; + if (n) { + free(n->string); + } else { + if (NULL == (namecopy = strdup(name))) + return(NULL); + if (NULL == (n = malloc(sizeof(struct roffstr)))) { + free(n); + return(NULL); } - argcp[i] = c; - argvp[i] = v; - argv++; + n->name = namecopy; + n->next = first_string; + first_string = n; } + if (string) + n->string = strdup(string); + else + n->string = NULL; + return(n->string); +} - if ( ! (*tree->roffin)(tok, argcp, argvp)) - return(0); +char * +roff_getstr(const char *name) +{ + struct roffstr *n; - if ( ! (ROFF_PARSED & tokens[tok].flags)) { - /* TODO: print all tokens. */ - return((*tree->roffout)(tok)); - } + n = first_string; + while (n && strcmp(name, n->name)) + n = n->next; + if (n) + return(n->string); + else + return(NULL); +} - while (*argv) { - if (2 >= strlen(*argv) && ROFF_MAX != - (c = rofffindcallable(*argv))) - if ( ! (*tokens[c].cb)(c, tree, - argv + 1, ROFF_ENTER)) - return(0); +char * +roff_getstrn(const char *name, size_t len) +{ + struct roffstr *n; - /* TODO: print token. */ - argv++; - } + n = first_string; + while (n && (strncmp(name, n->name, len) || '\0' != n->name[len])) + n = n->next; + if (n) + return(n->string); + else + return(NULL); +} - return((*tree->roffout)(tok)); +void +roff_freestr(void) +{ + struct roffstr *n, *nn; + + for (n = first_string; n; n = nn) { + free(n->name); + free(n->string); + nn = n->next; + free(n); + } + first_string = NULL; }