=================================================================== RCS file: /cvs/mandoc/roff.c,v retrieving revision 1.46 retrieving revision 1.75 diff -u -p -r1.46 -r1.75 --- mandoc/roff.c 2008/12/06 19:41:41 1.46 +++ mandoc/roff.c 2010/05/16 13:49:23 1.75 @@ -1,1373 +1,478 @@ -/* $Id: roff.c,v 1.46 2008/12/06 19:41:41 kristaps Exp $ */ +/* $Id: roff.c,v 1.75 2010/05/16 13:49:23 kristaps 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. */ -#include -#include +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif #include -#include -#include -#include #include -#include #include -#include +#include -#include "libmdocml.h" -#include "private.h" +#include "mandoc.h" #include "roff.h" -/* FIXME: First letters of quoted-text interpreted in rofffindtok. */ -/* FIXME: `No' not implemented. */ -/* TODO: warn if Pp occurs before/after Sh etc. (see mdoc.samples). */ -/* TODO: warn about "X section only" macros. */ -/* TODO: warn about empty lists. */ -/* TODO: (warn) some sections need specific elements. */ -/* TODO: (warn) NAME section has particular order. */ -/* TODO: unify empty-content tags a la
. */ -/* TODO: macros with a set number of arguments? */ -/* TODO: validate Dt macro arguments. */ -/* FIXME: Bl -diag supposed to ignore callable children. */ -/* FIXME: Nm has newline when used in NAME section. */ +#define ROFF_CTL(c) \ + ('.' == (c) || '\'' == (c)) +#ifdef ROFF_DEBUG +#define ROFF_MDEBUG(p, str) \ + fprintf(stderr, "%s: %s (%d:%d)\n", (str), \ + roffs[(p)->last->tok].name, \ + (p)->last->line, (p)->last->col) +#else +#define ROFF_MDEBUG(p, str) while (/* CONSTCOND */ 0) +#endif -struct roffnode { - int tok; /* Token id. */ - struct roffnode *parent; /* Parent (or NULL). */ +enum rofft { + ROFF_if, + ROFF_ccond, +#if 0 + ROFF_am, + ROFF_ami, + ROFF_de, + ROFF_dei, + ROFF_ig, + ROFF_close, +#endif + ROFF_MAX }; -struct rofftree { - struct roffnode *last; /* Last parsed node. */ - char *cur; /* Line start. */ - struct tm tm; /* `Dd' results. */ - char name[64]; /* `Nm' results. */ - char os[64]; /* `Os' results. */ - char title[64]; /* `Dt' results. */ - char section[64]; /* `Dt' results. */ - char volume[64]; /* `Dt' results. */ - int state; -#define ROFF_PRELUDE (1 << 1) /* In roff prelude. */ -#define ROFF_PRELUDE_Os (1 << 2) /* `Os' is parsed. */ -#define ROFF_PRELUDE_Dt (1 << 3) /* `Dt' is parsed. */ -#define ROFF_PRELUDE_Dd (1 << 4) /* `Dd' is parsed. */ -#define ROFF_BODY (1 << 5) /* In roff body. */ - struct roffcb cb; /* Callbacks. */ - void *arg; /* Callbacks' arg. */ +struct roff { + struct roffnode *last; /* leaf of stack */ + mandocmsg msg; /* err/warn/fatal messages */ + void *data; /* privdata for messages */ }; -static struct roffnode *roffnode_new(int, struct rofftree *); -static void roffnode_free(struct rofftree *); -static void roff_warn(const struct rofftree *, - const char *, char *, ...); -static void roff_err(const struct rofftree *, - const char *, char *, ...); -static int roffpurgepunct(struct rofftree *, char **); -static int roffscan(int, const int *); -static int rofffindtok(const char *); -static int rofffindarg(const char *); -static int rofffindcallable(const char *); -static int roffargs(const struct rofftree *, - int, char *, char **); -static int roffargok(int, int); -static int roffnextopt(const struct rofftree *, - int, char ***, char **); -static int roffparseopts(struct rofftree *, int, - char ***, int *, char **); -static int roffcall(struct rofftree *, int, char **); -static int roffparse(struct rofftree *, char *); -static int textparse(struct rofftree *, char *); -static int roffdata(struct rofftree *, int, char *); -static int roffspecial(struct rofftree *, int, - const char *, size_t, char **); -static int roffsetname(struct rofftree *, char **); +struct roffnode { + enum rofft tok; /* type of node */ + struct roffnode *parent; /* up one in stack */ + char *end; /* end-token: custom */ + int line; /* parse line */ + int col; /* parse col */ + int endspan; +}; -#ifdef __linux__ -extern size_t strlcat(char *, const char *, size_t); -extern size_t strlcpy(char *, const char *, size_t); -extern int vsnprintf(char *, size_t, - const char *, va_list); -extern char *strptime(const char *, const char *, - struct tm *); -#endif +#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 */ -int -roff_free(struct rofftree *tree, int flush) -{ - int error, t; - struct roffnode *n; +typedef enum rofferr (*roffproc)(ROFF_ARGS); - error = 0; +struct roffmac { + const char *name; /* macro name */ + roffproc proc; +}; - if ( ! flush) - goto end; +static enum rofferr roff_if(ROFF_ARGS); +static enum rofferr roff_ccond(ROFF_ARGS); +#if 0 +static enum rofferr roff_new_close(ROFF_ARGS); +static enum rofferr roff_new_ig(ROFF_ARGS); +static enum rofferr roff_sub_ig(ROFF_ARGS); +#endif - error = 1; +const struct roffmac roffs[ROFF_MAX] = { + { "if", roff_if }, + { "\\}", roff_ccond }, +#if 0 + { "am", roff_sub_ig, roff_new_ig }, + { "ami", roff_sub_ig, roff_new_ig }, + { "de", roff_sub_ig, roff_new_ig }, + { "dei", roff_sub_ig, roff_new_ig }, + { "ig", roff_sub_ig, roff_new_ig }, + { ".", NULL, roff_new_close }, +#endif +}; - if (ROFF_PRELUDE & tree->state) { - roff_err(tree, NULL, "prelude never finished"); - goto end; - } +static void roff_free1(struct roff *); +static enum rofft roff_hash_find(const char *); +static int roffnode_push(struct roff *, + enum rofft, int, int); +static void roffnode_pop(struct roff *); +static enum rofft roff_parse(const char *, int *); - for (n = tree->last; n; n = n->parent) { - if (0 != tokens[n->tok].ctx) - continue; - roff_err(tree, NULL, "closing explicit scope `%s'", - toknames[n->tok]); - goto end; - } - while (tree->last) { - t = tree->last->tok; - if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT)) - goto end; - } - - if ( ! (*tree->cb.rofftail)(tree->arg)) - goto end; - - error = 0; - -end: - - while (tree->last) - roffnode_free(tree); - - free(tree); - - return(error ? 0 : 1); -} - - -struct rofftree * -roff_alloc(const struct roffcb *cb, void *args) +/* + * 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 i; - assert(args); - assert(cb); + /* FIXME: make this be fast and efficient. */ - if (NULL == (tree = calloc(1, sizeof(struct rofftree)))) - err(1, "calloc"); + for (i = 0; i < (int)ROFF_MAX; i++) + if (0 == strcmp(roffs[i].name, p)) + return((enum rofft)i); - tree->state = ROFF_PRELUDE; - tree->arg = args; - - (void)memcpy(&tree->cb, cb, sizeof(struct roffcb)); - - return(tree); + return(ROFF_MAX); } -int -roff_engine(struct rofftree *tree, char *buf) +/* + * Pop the current node off of the stack of roff instructions currently + * pending. + */ +static void +roffnode_pop(struct roff *r) { + struct roffnode *p; - tree->cur = buf; - assert(buf); - - if (0 == *buf) { - roff_err(tree, buf, "blank line"); - return(0); - } else if ('.' != *buf) - return(textparse(tree, buf)); - - return(roffparse(tree, buf)); + assert(r->last); + p = r->last; + 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(struct rofftree *tree, char *buf) +roffnode_push(struct roff *r, enum rofft tok, int line, int col) { - char *bufp; + struct roffnode *p; - /* TODO: literal parsing. */ - - if ( ! (ROFF_BODY & tree->state)) { - roff_err(tree, buf, "data not in body"); + if (NULL == (p = calloc(1, sizeof(struct roffnode)))) { + (*r->msg)(MANDOCERR_MEM, r->data, line, col, NULL); return(0); } - /* LINTED */ - while (*buf) { - while (*buf && isspace(*buf)) - buf++; + p->tok = tok; + p->parent = r->last; + p->line = line; + p->col = col; - if (0 == *buf) - break; - - bufp = buf++; - - while (*buf && ! isspace(*buf)) - buf++; - - if (0 != *buf) { - *buf++ = 0; - if ( ! roffdata(tree, 1, bufp)) - return(0); - continue; - } - - if ( ! roffdata(tree, 1, bufp)) - return(0); - break; - } - + r->last = p; return(1); } -static int -roffargs(const struct rofftree *tree, - int tok, char *buf, char **argv) +static void +roff_free1(struct roff *r) { - int i; - char *p; - assert(tok >= 0 && tok < ROFF_MAX); - assert('.' == *buf); - - p = buf; - - /* - * This is an ugly little loop. It parses a line into - * space-delimited tokens. If a quote mark is encountered, a - * token is alloted the entire quoted text. If whitespace is - * escaped, it's included in the prior alloted token. - */ - - /* LINTED */ - for (i = 0; *buf && i < ROFF_MAXLINEARG; i++) { - if ('\"' == *buf) { - argv[i] = ++buf; - while (*buf && '\"' != *buf) - buf++; - if (0 == *buf) { - roff_err(tree, argv[i], "unclosed " - "quote in argument " - "list for `%s'", - toknames[tok]); - return(0); - } - } else { - argv[i] = buf++; - while (*buf) { - if ( ! isspace(*buf)) { - buf++; - continue; - } - if (*(buf - 1) == '\\') { - buf++; - continue; - } - break; - } - if (0 == *buf) - continue; - } - *buf++ = 0; - while (*buf && isspace(*buf)) - buf++; - } - - assert(i > 0); - if (ROFF_MAXLINEARG == i && *buf) { - roff_err(tree, p, "too many arguments for `%s'", toknames - [tok]); - return(0); - } - - argv[i] = NULL; - return(1); + while (r->last) + roffnode_pop(r); } -static int -roffscan(int tok, const int *tokv) +void +roff_reset(struct roff *r) { - if (NULL == tokv) - return(1); - - for ( ; ROFF_MAX != *tokv; tokv++) - if (tok == *tokv) - return(1); - - return(0); + roff_free1(r); } -static int -roffparse(struct rofftree *tree, char *buf) +void +roff_free(struct roff *r) { - int tok, t; - struct roffnode *n; - char *argv[ROFF_MAXLINEARG]; - char **argvp; - if (0 != *buf && 0 != *(buf + 1) && 0 != *(buf + 2)) - if (0 == strncmp(buf, ".\\\"", 3)) - return(1); - - if (ROFF_MAX == (tok = rofffindtok(buf + 1))) { - roff_err(tree, buf + 1, "bogus line macro"); - return(0); - } else if (NULL == tokens[tok].cb) { - roff_err(tree, buf + 1, "unsupported macro `%s'", - toknames[tok]); - return(0); - } - - assert(ROFF___ != tok); - if ( ! roffargs(tree, tok, buf, argv)) - return(0); - - argvp = (char **)argv; - - /* - * Prelude macros break some assumptions, so branch now. - */ - - if (ROFF_PRELUDE & tree->state) { - assert(NULL == tree->last); - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); - } - - assert(ROFF_BODY & tree->state); - - /* - * First check that our possible parents and parent's possible - * children are satisfied. - */ - - if (tree->last && ! roffscan - (tree->last->tok, tokens[tok].parents)) { - roff_err(tree, *argvp, "`%s' has invalid parent `%s'", - toknames[tok], - toknames[tree->last->tok]); - return(0); - } - - if (tree->last && ! roffscan - (tok, tokens[tree->last->tok].children)) { - roff_err(tree, *argvp, "`%s' is invalid child of `%s'", - toknames[tok], - toknames[tree->last->tok]); - return(0); - } - - /* - * Branch if we're not a layout token. - */ - - if (ROFF_LAYOUT != tokens[tok].type) - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); - if (0 == tokens[tok].ctx) - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); - - /* - * First consider implicit-end tags, like as follows: - * .Sh SECTION 1 - * .Sh SECTION 2 - * In this, we want to close the scope of the NAME section. If - * there's an intermediary implicit-end tag, such as - * .Sh SECTION 1 - * .Ss Subsection 1 - * .Sh SECTION 2 - * then it must be closed as well. - */ - - if (tok == tokens[tok].ctx) { - /* - * First search up to the point where we must close. - * If one doesn't exist, then we can open a new scope. - */ - - for (n = tree->last; n; n = n->parent) { - assert(0 == tokens[n->tok].ctx || - n->tok == tokens[n->tok].ctx); - if (n->tok == tok) - break; - if (ROFF_SHALLOW & tokens[tok].flags) { - n = NULL; - break; - } - if (tokens[n->tok].ctx == n->tok) - continue; - roff_err(tree, *argv, "`%s' breaks `%s' scope", - toknames[tok], toknames[n->tok]); - return(0); - } - - /* - * Create a new scope, as no previous one exists to - * close out. - */ - - if (NULL == n) - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); - - /* - * Close out all intermediary scoped blocks, then hang - * the current scope from our predecessor's parent. - */ - - do { - t = tree->last->tok; - if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT)) - return(0); - } while (t != tok); - - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); - } - - /* - * Now consider explicit-end tags, where we want to close back - * to a specific tag. Example: - * .Bl - * .It Item. - * .El - * In this, the `El' tag closes out the scope of `Bl'. - */ - - assert(tok != tokens[tok].ctx && 0 != tokens[tok].ctx); - - /* LINTED */ - for (n = tree->last; n; n = n->parent) - if (n->tok != tokens[tok].ctx) { - if (n->tok == tokens[n->tok].ctx) - continue; - roff_err(tree, *argv, "`%s' breaks `%s' scope", - toknames[tok], toknames[n->tok]); - return(0); - } else - break; - - - if (NULL == n) { - roff_err(tree, *argv, "`%s' has no starting tag `%s'", - toknames[tok], - toknames[tokens[tok].ctx]); - return(0); - } - - /* LINTED */ - do { - t = tree->last->tok; - if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT)) - return(0); - } while (t != tokens[tok].ctx); - - return(1); + roff_free1(r); + free(r); } -static int -rofffindarg(const char *name) +struct roff * +roff_alloc(const mandocmsg msg, void *data) { - size_t i; + struct roff *r; - /* 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); -} - - -static int -rofffindtok(const char *buf) -{ - char token[4]; - int i; - - for (i = 0; *buf && ! isspace(*buf) && i < 3; i++, buf++) - token[i] = *buf; - - if (i == 3) - return(ROFF_MAX); - - token[i] = 0; - - /* FIXME: use a table, this is slow but ok for now. */ - - /* LINTED */ - for (i = 0; i < ROFF_MAX; i++) - /* LINTED */ - if (0 == strcmp(toknames[i], token)) - return((int)i); - - return(ROFF_MAX); -} - - -static int -roffispunct(const char *p) -{ - - if (0 == *p) + if (NULL == (r = calloc(1, sizeof(struct roff)))) { + (*msg)(MANDOCERR_MEM, data, 0, 0, NULL); return(0); - if (0 != *(p + 1)) - return(0); - - switch (*p) { - case('{'): - /* FALLTHROUGH */ - case('.'): - /* FALLTHROUGH */ - case(','): - /* FALLTHROUGH */ - case(';'): - /* FALLTHROUGH */ - case(':'): - /* FALLTHROUGH */ - case('?'): - /* FALLTHROUGH */ - case('!'): - /* FALLTHROUGH */ - case('('): - /* FALLTHROUGH */ - case(')'): - /* FALLTHROUGH */ - case('['): - /* FALLTHROUGH */ - case(']'): - /* FALLTHROUGH */ - case('}'): - return(1); - default: - break; } - return(0); + r->msg = msg; + r->data = data; + return(r); } -static int -rofffindcallable(const char *name) +enum rofferr +roff_parseln(struct roff *r, int ln, + char **bufp, size_t *szp, int pos, int *offs) { - int c; + enum rofft t; + int ppos; - if (ROFF_MAX == (c = rofffindtok(name))) - return(ROFF_MAX); - assert(c >= 0 && c < ROFF_MAX); - return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX); -} + /* Return when in free text without a context. */ + if (r->last && ! ROFF_CTL((*bufp)[pos])) { + /* XXX: this assumes we're just discarding. */ + while (r->last) { + if (r->last->endspan-- < 0) + break; + ROFF_MDEBUG(r, "closing implicit scope"); + roffnode_pop(r); + } + return(ROFF_IGN); + } else if ( ! ROFF_CTL((*bufp)[pos])) + return(ROFF_CONT); -static struct roffnode * -roffnode_new(int tokid, struct rofftree *tree) -{ - struct roffnode *p; - - if (NULL == (p = malloc(sizeof(struct roffnode)))) - err(1, "malloc"); + /* There's nothing on the stack: make us anew. */ - p->tok = tokid; - p->parent = tree->last; - tree->last = p; + ppos = pos; + if (ROFF_MAX == (t = roff_parse(*bufp, &pos))) + return(ROFF_CONT); - return(p); + assert(roffs[t].proc); + return((*roffs[t].proc)(r, t, bufp, szp, ln, ppos, pos, offs)); } -static int -roffargok(int tokid, int argid) +int +roff_endparse(struct roff *r) { - const int *c; - if (NULL == (c = tokens[tokid].args)) - return(0); - - for ( ; ROFF_ARGMAX != *c; c++) - if (argid == *c) - return(1); - - return(0); + if (NULL == r->last) + return(1); + return((*r->msg)(MANDOCERR_SCOPEEXIT, r->data, r->last->line, + r->last->col, NULL)); } -static void -roffnode_free(struct rofftree *tree) +/* + * 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) { - struct roffnode *p; + int j; + char mac[5]; + enum rofft t; - assert(tree->last); + assert(ROFF_CTL(buf[*pos])); + (*pos)++; - p = tree->last; - tree->last = tree->last->parent; - free(p); -} + while (buf[*pos] && (' ' == buf[*pos] || '\t' == buf[*pos])) + (*pos)++; + if ('\0' == buf[*pos]) + return(ROFF_MAX); -static int -roffspecial(struct rofftree *tree, int tok, - const char *start, size_t sz, char **ordp) -{ - - switch (tok) { - case (ROFF_At): - if (0 == sz) + for (j = 0; j < 4; j++, (*pos)++) + if ('\0' == (mac[j] = buf[*pos])) break; - if (0 == strcmp(*ordp, "v6")) + else if (' ' == buf[*pos]) break; - else if (0 == strcmp(*ordp, "v7")) - break; - else if (0 == strcmp(*ordp, "32v")) - break; - else if (0 == strcmp(*ordp, "V.1")) - break; - else if (0 == strcmp(*ordp, "V.4")) - break; - roff_err(tree, start, "invalid `At' arg"); - return(0); - case (ROFF_Nm): - if (0 == sz) { - if (0 == tree->name[0]) { - roff_err(tree, start, "`Nm' not set"); - return(0); - } - ordp[0] = tree->name; - ordp[1] = NULL; - } else if ( ! roffsetname(tree, ordp)) - return(0); - break; + if (j == 4 || j < 1) + return(ROFF_MAX); - case (ROFF_Sx): - /* FALLTHROUGH*/ - case (ROFF_Ex): - if (1 != sz) { - roff_err(tree, start, "`%s' expects one arg", - toknames[tok]); - return(0); - } - break; + mac[j] = '\0'; - case (ROFF_Sm): - if (1 != sz) { - roff_err(tree, start, "`Sm' expects one arg"); - return(0); - } - - if (0 != strcmp(ordp[0], "on") && - 0 != strcmp(ordp[0], "off")) { - roff_err(tree, start, "`Sm' has invalid argument"); - return(0); - } - break; - - case (ROFF_Ud): - /* FALLTHROUGH */ - case (ROFF_Ux): - /* FALLTHROUGH */ - case (ROFF_Bt): - if (0 != sz) { - roff_err(tree, start, "`%s' expects no args", - toknames[tok]); - return(0); - } - break; - default: - break; - } + if (ROFF_MAX == (t = roff_hash_find(mac))) + return(t); - return((*tree->cb.roffspecial) - (tree->arg, tok, tree->cur, ordp)); -} + while (buf[*pos] && ' ' == buf[*pos]) + (*pos)++; - -static int -roffcall(struct rofftree *tree, int tok, char **argv) -{ - - if (NULL == tokens[tok].cb) { - roff_err(tree, *argv, "unsupported macro `%s'", - toknames[tok]); - return(0); - } - if ( ! (*tokens[tok].cb)(tok, tree, argv, ROFF_ENTER)) - return(0); - return(1); + return(t); } -static int -roffnextopt(const struct rofftree *tree, int tok, - char ***in, char **val) +#if 0 +/* ARGSUSED */ +static enum rofferr +roff_sub_ig(ROFF_ARGS) { - char *arg, **argv; - int v; + int i, j; - *val = NULL; - argv = *in; - assert(argv); + /* Ignore free-text lines. */ - if (NULL == (arg = *argv)) - return(-1); - if ('-' != *arg) - return(-1); + if ('.' != (*bufp)[ppos] && '\'' != (*bufp)[ppos]) + return(ROFF_IGN); - if (ROFF_ARGMAX == (v = rofffindarg(arg + 1))) { - roff_warn(tree, arg, "argument-like parameter `%s' to " - "`%s'", arg, toknames[tok]); - return(-1); - } - - if ( ! roffargok(tok, v)) { - roff_warn(tree, arg, "invalid argument parameter `%s' to " - "`%s'", tokargnames[v], toknames[tok]); - return(-1); - } - - if ( ! (ROFF_VALUE & tokenargs[v])) - return(v); + if (r->last->end) { + i = ppos + 1; - *in = ++argv; + while ((*bufp)[i] && ' ' == (*bufp)[i]) + i++; - if (NULL == *argv) { - roff_err(tree, arg, "empty value of `%s' for `%s'", - tokargnames[v], toknames[tok]); - return(ROFF_ARGMAX); - } + for (j = 0; r->last->end[j]; i++, j++) + if ((*bufp)[i] != r->last->end[j]) + return(ROFF_IGN); - return(v); -} + if (r->last->end[j]) + return(ROFF_IGN); + if ((*bufp)[i] && ' ' != (*bufp)[i]) + return(ROFF_IGN); + while (' ' == (*bufp)[i]) + i++; -static int -roffpurgepunct(struct rofftree *tree, char **argv) -{ - int i; + } else if (ROFF_close != roff_parse(*bufp, &i)) + return(ROFF_IGN); - i = 0; - while (argv[i]) - i++; - assert(i > 0); - if ( ! roffispunct(argv[--i])) - return(1); - while (i >= 0 && roffispunct(argv[i])) - i--; - i++; + roffnode_pop(r); - /* LINTED */ - while (argv[i]) - if ( ! roffdata(tree, 0, argv[i++])) - return(0); - return(1); -} + if ('\0' == (*bufp)[i]) + return(ROFF_IGN); + if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, i, NULL)) + return(ROFF_ERR); - -static int -roffparseopts(struct rofftree *tree, int tok, - char ***args, int *argc, char **argv) -{ - int i, c; - char *v; - - i = 0; - - while (-1 != (c = roffnextopt(tree, tok, args, &v))) { - if (ROFF_ARGMAX == c) - return(0); - - argc[i] = c; - argv[i] = v; - i++; - *args = *args + 1; - } - - argc[i] = ROFF_ARGMAX; - argv[i] = NULL; - return(1); + return(ROFF_IGN); } -static int -roffdata(struct rofftree *tree, int space, char *buf) -{ - - if (0 == *buf) - return(1); - return((*tree->cb.roffdata)(tree->arg, - space != 0, tree->cur, buf)); -} - - /* ARGSUSED */ -static int -roff_Dd(ROFFCALL_ARGS) +static enum rofferr +roff_new_close(ROFF_ARGS) { - time_t t; - char *p, buf[32]; - if (ROFF_BODY & tree->state) { - assert( ! (ROFF_PRELUDE & tree->state)); - assert(ROFF_PRELUDE_Dd & tree->state); - return(roff_text(tok, tree, argv, type)); - } + if ( ! (*r->msg)(MANDOCERR_NOSCOPE, r->data, ln, ppos, NULL)) + return(ROFF_ERR); - assert(ROFF_PRELUDE & tree->state); - assert( ! (ROFF_BODY & tree->state)); - - if (ROFF_PRELUDE_Dd & tree->state) { - roff_err(tree, *argv, "repeated `Dd' in prelude"); - return(0); - } else if (ROFF_PRELUDE_Dt & tree->state) { - roff_err(tree, *argv, "out-of-order `Dd' in prelude"); - return(0); - } - - assert(NULL == tree->last); - - argv++; - - if (0 == strcmp(*argv, "$Mdocdate: December 6 2008 $")) { - t = time(NULL); - if (NULL == localtime_r(&t, &tree->tm)) - err(1, "localtime_r"); - tree->state |= ROFF_PRELUDE_Dd; - return(1); - } - - /* Build this from Mdocdate or raw date. */ - - buf[0] = 0; - p = *argv; - - if (0 != strcmp(*argv, "$Mdocdate:")) { - while (*argv) { - if (strlcat(buf, *argv++, sizeof(buf)) - < sizeof(buf)) - continue; - roff_err(tree, p, "bad `Dd' date"); - return(0); - } - if (strptime(buf, "%b%d,%Y", &tree->tm)) { - tree->state |= ROFF_PRELUDE_Dd; - return(1); - } - roff_err(tree, *argv, "bad `Dd' date"); - return(0); - } - - argv++; - while (*argv && **argv != '$') { - if (strlcat(buf, *argv++, sizeof(buf)) - >= sizeof(buf)) { - roff_err(tree, p, "bad `Dd' Mdocdate"); - return(0); - } - if (strlcat(buf, " ", sizeof(buf)) - >= sizeof(buf)) { - roff_err(tree, p, "bad `Dd' Mdocdate"); - return(0); - } - } - if (NULL == *argv) { - roff_err(tree, p, "bad `Dd' Mdocdate"); - return(0); - } - - if (NULL == strptime(buf, "%b %d %Y", &tree->tm)) { - roff_err(tree, *argv, "bad `Dd' Mdocdate"); - return(0); - } - - tree->state |= ROFF_PRELUDE_Dd; - return(1); + return(ROFF_IGN); } +#endif /* ARGSUSED */ -static int -roff_Dt(ROFFCALL_ARGS) +static enum rofferr +roff_ccond(ROFF_ARGS) { - if (ROFF_BODY & tree->state) { - assert( ! (ROFF_PRELUDE & tree->state)); - assert(ROFF_PRELUDE_Dt & tree->state); - return(roff_text(tok, tree, argv, type)); + if (NULL == r->last || ROFF_if != r->last->tok || r->last->endspan > -1) { + 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)); + ROFF_MDEBUG(r, "closing explicit scope"); + roffnode_pop(r); - if ( ! (ROFF_PRELUDE_Dd & tree->state)) { - roff_err(tree, *argv, "out-of-order `Dt' in prelude"); - return(0); - } else if (ROFF_PRELUDE_Dt & tree->state) { - roff_err(tree, *argv, "repeated `Dt' in prelude"); - return(0); - } - - argv++; - if (NULL == *argv) { - roff_err(tree, *argv, "`Dt' needs document title"); - return(0); - } else if (strlcpy(tree->title, *argv, sizeof(tree->title)) - >= sizeof(tree->title)) { - roff_err(tree, *argv, "`Dt' document title too long"); - return(0); - } - - argv++; - if (NULL == *argv) { - roff_err(tree, *argv, "`Dt' needs section"); - return(0); - } else if (strlcpy(tree->section, *argv, sizeof(tree->section)) - >= sizeof(tree->section)) { - roff_err(tree, *argv, "`Dt' section too long"); - return(0); - } - - argv++; - if (NULL == *argv) { - tree->volume[0] = 0; - } else if (strlcpy(tree->volume, *argv, sizeof(tree->volume)) - >= sizeof(tree->volume)) { - roff_err(tree, *argv, "`Dt' volume too long"); - return(0); - } - - assert(NULL == tree->last); - tree->state |= ROFF_PRELUDE_Dt; - - return(1); -} - - -static int -roffsetname(struct rofftree *tree, char **ordp) -{ - - assert(*ordp); - - /* FIXME: not all sections can set this. */ - - if (NULL != *(ordp + 1)) { - roff_err(tree, *ordp, "too many `Nm' args"); - return(0); - } - - if (strlcpy(tree->name, *ordp, sizeof(tree->name)) - >= sizeof(tree->name)) { - roff_err(tree, *ordp, "`Nm' arg too long"); - return(0); - } - - return(1); -} - - -/* ARGSUSED */ -static int -roff_Ns(ROFFCALL_ARGS) -{ - int j, c, first; - char *morep[1]; - - first = (*argv++ == tree->cur); - morep[0] = NULL; - - if ( ! roffspecial(tree, tok, *argv, 0, morep)) - return(0); - - while (*argv) { - if (ROFF_MAX != (c = rofffindcallable(*argv))) { - if ( ! roffcall(tree, c, argv)) - return(0); + while (r->last) { + if (--r->last->endspan < 0) break; - } - if ( ! roffispunct(*argv)) { - if ( ! roffdata(tree, 1, *argv++)) - return(0); - continue; - } - - for (j = 0; argv[j]; j++) - if ( ! roffispunct(argv[j])) - break; - - if (argv[j]) { - if ( ! roffdata(tree, 0, *argv++)) - return(0); - continue; - } - - break; + ROFF_MDEBUG(r, "closing implicit scope"); + roffnode_pop(r); } - if ( ! first) - return(1); - - return(roffpurgepunct(tree, argv)); + return(ROFF_IGN); } /* ARGSUSED */ -static int -roff_Os(ROFFCALL_ARGS) +static enum rofferr +roff_if(ROFF_ARGS) { - char *p; - if (ROFF_BODY & tree->state) { - assert( ! (ROFF_PRELUDE & tree->state)); - assert(ROFF_PRELUDE_Os & tree->state); - return(roff_text(tok, tree, argv, type)); - } + /* + * Read ahead past the conditional. + * FIXME: this does not work, as conditionals don't end on + * whitespace, but are parsed according to a formal grammar. + * It's good enough for now, however. + */ - assert(ROFF_PRELUDE & tree->state); - if ( ! (ROFF_PRELUDE_Dt & tree->state) || - ! (ROFF_PRELUDE_Dd & tree->state)) { - roff_err(tree, *argv, "out-of-order `Os' in prelude"); - return(0); - } + if ( ! roffnode_push(r, tok, ln, ppos)) + return(ROFF_ERR); - tree->os[0] = 0; + while ((*bufp)[pos] && ' ' != (*bufp)[pos]) + pos++; + while (' ' == (*bufp)[pos]) + pos++; - p = *++argv; + /* Don't evaluate: just assume NO. */ - while (*argv) { - if (strlcat(tree->os, *argv++, sizeof(tree->os)) - < sizeof(tree->os)) - continue; - roff_err(tree, p, "`Os' value too long"); - return(0); - } + r->last->endspan = 1; - if (0 == tree->os[0]) - if (strlcpy(tree->os, "LOCAL", sizeof(tree->os)) - >= sizeof(tree->os)) { - roff_err(tree, p, "`Os' value too long"); - return(0); - } + if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) { + ROFF_MDEBUG(r, "opening explicit scope"); + r->last->endspan = -1; + pos += 2; + } else + ROFF_MDEBUG(r, "opening implicit scope"); - tree->state |= ROFF_PRELUDE_Os; - tree->state &= ~ROFF_PRELUDE; - tree->state |= ROFF_BODY; + if ('\0' == (*bufp)[pos]) + return(ROFF_IGN); - assert(NULL == tree->last); - - return((*tree->cb.roffhead)(tree->arg, &tree->tm, - tree->os, tree->title, tree->section, - tree->volume)); + *offs = pos; + return(ROFF_RERUN); } -/* ARGSUSED */ -static int -roff_layout(ROFFCALL_ARGS) +#if 0 +static enum rofferr +roff_new_ig(ROFF_ARGS) { - int i, c, argcp[ROFF_MAXLINEARG]; - char *argvp[ROFF_MAXLINEARG]; + int i; - if (ROFF_PRELUDE & tree->state) { - roff_err(tree, *argv, "bad `%s' in prelude", - toknames[tok]); - return(0); - } else if (ROFF_EXIT == type) { - roffnode_free(tree); - if ( ! (*tree->cb.roffblkbodyout)(tree->arg, tok)) - return(0); - return((*tree->cb.roffblkout)(tree->arg, tok)); - } - - assert( ! (ROFF_CALLABLE & tokens[tok].flags)); - - ++argv; - - if ( ! roffparseopts(tree, tok, &argv, argcp, argvp)) - return(0); - if (NULL == roffnode_new(tok, tree)) - return(0); - + if ( ! roffnode_push(r, tok, ln, ppos)) + return(ROFF_ERR); + /* - * Layouts have two parts: the layout body and header. The - * layout header is the trailing text of the line macro, while - * the layout body is everything following until termination. + * Other macros (not `ig') using this routine have additional + * crap here that we discard. */ - if ( ! (*tree->cb.roffblkin)(tree->arg, tok, argcp, argvp)) - return(0); - if (NULL == *argv) - return((*tree->cb.roffblkbodyin) - (tree->arg, tok, argcp, argvp)); - - if ( ! (*tree->cb.roffblkheadin)(tree->arg, tok, argcp, argvp)) - return(0); - - /* - * If there are no parsable parts, then write remaining tokens - * into the layout header and exit. - */ - - if ( ! (ROFF_PARSED & tokens[tok].flags)) { - i = 0; - while (*argv) - if ( ! roffdata(tree, i++, *argv++)) - return(0); - - if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok)) - return(0); - return((*tree->cb.roffblkbodyin) - (tree->arg, tok, argcp, argvp)); + if (ROFF_ig != tok) { + while ((*bufp)[ppos] && ' ' != (*bufp)[ppos]) + ppos++; + while (' ' == (*bufp)[ppos]) + ppos++; } - /* - * Parsable elements may be in the header (or be the header, for - * that matter). Follow the regular parsing rules for these. - */ + i = (int)ppos; - i = 0; - while (*argv) { - if (ROFF_MAX == (c = rofffindcallable(*argv))) { - assert(tree->arg); - if ( ! roffdata(tree, i++, *argv++)) - return(0); - continue; - } - if ( ! roffcall(tree, c, argv)) - return(0); - break; - } + while ((*bufp)[i] && ' ' != (*bufp)[i]) + i++; - /* - * If there's trailing punctuation in the header, then write it - * out now. Here we mimic the behaviour of a line-dominant text - * macro. - */ + if (i == (int)ppos) + return(ROFF_IGN); - if (NULL == *argv) { - if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok)) - return(0); - return((*tree->cb.roffblkbodyin) - (tree->arg, tok, argcp, argvp)); - } + if ((*bufp)[i]) + if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, i, NULL)) + return(ROFF_ERR); /* - * Expensive. Scan to the end of line then work backwards until - * a token isn't punctuation. + * If the macro has arguments, the first argument (up to the + * next whitespace) is interpreted as an argument marking the + * macro close. Thus, `.ig foo' will close at `.foo'. + * + * NOTE: the closing macro `.foo' in the above case is not + * allowed to have leading spaces with old groff! Thus `.foo' + * != `. foo'. Oh yeah, everything after the `.foo' is lost. + * Merry fucking Christmas. */ - if ( ! roffpurgepunct(tree, argv)) - return(0); - - if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok)) - return(0); - return((*tree->cb.roffblkbodyin) - (tree->arg, tok, argcp, argvp)); -} - - -/* ARGSUSED */ -static int -roff_ordered(ROFFCALL_ARGS) -{ - int i, first, c, argcp[ROFF_MAXLINEARG]; - char *ordp[ROFF_MAXLINEARG], *p, - *argvp[ROFF_MAXLINEARG]; - - if (ROFF_PRELUDE & tree->state) { - roff_err(tree, *argv, "`%s' disallowed in prelude", - toknames[tok]); - return(0); + r->last->end = malloc((size_t)(i - ppos) + 1); + if (NULL == r->last->end) { + (*r->msg)(MANDOCERR_MEM, r->data, ln, ppos, NULL); + return(ROFF_ERR); } - first = (*argv == tree->cur); - p = *argv++; + memcpy(r->last->end, &(*bufp)[ppos], (size_t)(i - ppos)); + r->last->end[i - ppos] = '\0'; - if ( ! roffparseopts(tree, tok, &argv, argcp, argvp)) - return(0); - - if (NULL == *argv) - return(roffspecial(tree, tok, p, 0, ordp)); - - i = 0; - while (*argv && i < ROFF_MAXLINEARG) { - c = ROFF_PARSED & tokens[tok].flags ? - rofffindcallable(*argv) : ROFF_MAX; - - if (ROFF_MAX == c && ! roffispunct(*argv)) { - ordp[i++] = *argv++; - continue; - } - ordp[i] = NULL; - - if (ROFF_MAX == c) - break; - - if ( ! roffspecial(tree, tok, p, (size_t)i, ordp)) - return(0); - - return(roffcall(tree, c, argv)); - } - - assert(i != ROFF_MAXLINEARG); - ordp[i] = NULL; - - if ( ! roffspecial(tree, tok, p, (size_t)i, ordp)) - return(0); - - /* FIXME: error if there's stuff after the punctuation. */ - - if ( ! first || NULL == *argv) - return(1); - - return(roffpurgepunct(tree, argv)); + return(ROFF_IGN); } - - -/* ARGSUSED */ -static int -roff_text(ROFFCALL_ARGS) -{ - int i, j, first, c, argcp[ROFF_MAXLINEARG]; - char *argvp[ROFF_MAXLINEARG]; - - if (ROFF_PRELUDE & tree->state) { - roff_err(tree, *argv, "`%s' disallowed in prelude", - toknames[tok]); - return(0); - } - - first = (*argv == tree->cur); - argv++; - - if ( ! roffparseopts(tree, tok, &argv, argcp, argvp)) - return(0); - if ( ! (*tree->cb.roffin)(tree->arg, tok, argcp, argvp)) - return(0); - if (NULL == *argv) - return((*tree->cb.roffout)(tree->arg, tok)); - - if ( ! (ROFF_PARSED & tokens[tok].flags)) { - i = 0; - while (*argv) - if ( ! roffdata(tree, i++, *argv++)) - return(0); - - return((*tree->cb.roffout)(tree->arg, tok)); - } - - /* - * Deal with punctuation. Ugly. Work ahead until we encounter - * terminating punctuation. If we encounter it and all - * subsequent tokens are punctuation, then stop processing (the - * line-dominant macro will print these tokens after closure). - */ - - i = 0; - while (*argv) { - if (ROFF_MAX != (c = rofffindcallable(*argv))) { - if ( ! (ROFF_LSCOPE & tokens[tok].flags)) - if ( ! (*tree->cb.roffout)(tree->arg, tok)) - return(0); - - if ( ! roffcall(tree, c, argv)) - return(0); - - if (ROFF_LSCOPE & tokens[tok].flags) - if ( ! (*tree->cb.roffout)(tree->arg, tok)) - return(0); - - break; - } - - if ( ! roffispunct(*argv)) { - if ( ! roffdata(tree, i++, *argv++)) - return(0); - continue; - } - - i = 1; - for (j = 0; argv[j]; j++) - if ( ! roffispunct(argv[j])) - break; - - if (argv[j]) { - if ( ! roffdata(tree, 0, *argv++)) - return(0); - continue; - } - - if ( ! (*tree->cb.roffout)(tree->arg, tok)) - return(0); - break; - } - - if (NULL == *argv) - return((*tree->cb.roffout)(tree->arg, tok)); - if ( ! first) - return(1); - - return(roffpurgepunct(tree, argv)); -} - - -/* ARGSUSED */ -static int -roff_noop(ROFFCALL_ARGS) -{ - - return(1); -} - - -/* ARGSUSED */ -static int -roff_depr(ROFFCALL_ARGS) -{ - - roff_err(tree, *argv, "`%s' is deprecated", toknames[tok]); - return(0); -} - - -static void -roff_warn(const struct rofftree *tree, const char *pos, char *fmt, ...) -{ - va_list ap; - char buf[128]; - - va_start(ap, fmt); - (void)vsnprintf(buf, sizeof(buf), fmt, ap); - va_end(ap); - - (*tree->cb.roffmsg)(tree->arg, - ROFF_WARN, tree->cur, pos, buf); -} - - -static void -roff_err(const struct rofftree *tree, const char *pos, char *fmt, ...) -{ - va_list ap; - char buf[128]; - - va_start(ap, fmt); - (void)vsnprintf(buf, sizeof(buf), fmt, ap); - va_end(ap); - - (*tree->cb.roffmsg)(tree->arg, - ROFF_ERROR, tree->cur, pos, buf); -} - +#endif