=================================================================== RCS file: /cvs/mandoc/roff.c,v retrieving revision 1.5 retrieving revision 1.75 diff -u -p -r1.5 -r1.75 --- mandoc/roff.c 2008/11/25 16:49:57 1.5 +++ mandoc/roff.c 2010/05/16 13:49:23 1.75 @@ -1,987 +1,478 @@ -/* $Id: roff.c,v 1.5 2008/11/25 16:49:57 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. */ +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + #include -#include -#include #include -#include #include -#include +#include -#include "libmdocml.h" -#include "private.h" +#include "mandoc.h" +#include "roff.h" -#define ROFF_MAXARG 10 +#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 -/* Whether we're entering or leaving a roff scope. */ -enum roffd { - ROFF_ENTER = 0, - ROFF_EXIT +enum rofft { + ROFF_if, + ROFF_ccond, +#if 0 + ROFF_am, + ROFF_ami, + ROFF_de, + ROFF_dei, + ROFF_ig, + ROFF_close, +#endif + ROFF_MAX }; -/* The type of a macro (see mdoc(7) for more). */ -enum rofftype { - ROFF_COMMENT, - ROFF_TEXT, - ROFF_LAYOUT +struct roff { + struct roffnode *last; /* leaf of stack */ + mandocmsg msg; /* err/warn/fatal messages */ + void *data; /* privdata for messages */ }; -/* Arguments passed to a macro callback. */ -#define ROFFCALL_ARGS \ - int tok, struct rofftree *tree, \ - const char *argv[], enum roffd type +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; +}; -struct rofftree; +#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 */ -/* Describes a roff token (like D1 or Sh). */ -struct rofftok { - int (*cb)(ROFFCALL_ARGS); /* Callback. */ - const int *args; /* Args (or NULL). */ - enum rofftype type; /* Type of macro. */ - int symm; /* FIXME */ - int flags; -#define ROFF_NESTED (1 << 0) /* Nested-layout. */ -#define ROFF_PARSED (1 << 1) /* "Parsed". */ -#define ROFF_CALLABLE (1 << 2) /* "Callable". */ -#define ROFF_QUOTES (1 << 3) /* Quoted args. */ -}; +typedef enum rofferr (*roffproc)(ROFF_ARGS); -/* An argument to a roff token (like -split or -enum). */ -struct roffarg { - int flags; -#define ROFF_VALUE (1 << 0) /* Has a value. */ +struct roffmac { + const char *name; /* macro name */ + roffproc proc; }; -/* mdocml remembers only the current parse node and the chain leading to - * the document root (scopes). - */ -struct roffnode { - int tok; /* Token id. */ - struct roffnode *parent; /* Parent (or NULL). */ - size_t line; /* Parsed at line. */ -}; +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 -/* State of file parse. */ -struct rofftree { - struct roffnode *last; /* Last parsed node. */ - time_t date; /* `Dd' 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. */ - /* FIXME: if we had prev ptrs, this wouldn't be necessary. */ -#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. */ - roffin roffin; /* Text-macro cb. */ - roffblkin roffblkin; /* Block-macro cb. */ - roffout roffout; /* Text-macro cb. */ - roffblkout roffblkout; /* Block-macro cb. */ - struct md_mbuf *mbuf; /* Output (or NULL). */ - const struct md_args *args; /* Global args. */ - const struct md_rbuf *rbuf; /* Input. */ +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 }; -static int roff_Dd(ROFFCALL_ARGS); -static int roff_Dt(ROFFCALL_ARGS); -static int roff_Os(ROFFCALL_ARGS); -static int roff_layout(ROFFCALL_ARGS); -static int roff_text(ROFFCALL_ARGS); +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 *); -static struct roffnode *roffnode_new(int, struct rofftree *); -static void roffnode_free(int, struct rofftree *); -static int rofffindtok(const char *); -static int rofffindarg(const char *); -static int rofffindcallable(const char *); -static int roffargs(int, char *, char **); -static int roffargok(int, int); -static int roffnextopt(int, const char ***, char **); -static int roffparse(struct rofftree *, char *, size_t); -static int textparse(const struct rofftree *, - const char *, size_t); - -/* Arguments for `An' macro. */ -static const int roffarg_An[] = { - ROFF_Split, ROFF_Nosplit, ROFF_ARGMAX }; -/* Arguments for `Bd' macro. */ -static const int roffarg_Bd[] = { - ROFF_Ragged, ROFF_Unfilled, ROFF_Literal, ROFF_File, - ROFF_Offset, ROFF_ARGMAX }; -/* Arguments for `Bl' macro. */ -static const int roffarg_Bl[] = { - ROFF_Bullet, ROFF_Dash, ROFF_Hyphen, ROFF_Item, ROFF_Enum, - ROFF_Tag, ROFF_Diag, ROFF_Hang, ROFF_Ohang, ROFF_Inset, - ROFF_Column, ROFF_Offset, ROFF_ARGMAX }; - -/* FIXME: a big list of fixes that must occur. - * - * (1) Distinction not between ROFF_TEXT and ROFF_LAYOUT, but instead - * ROFF_ATOM and ROFF_NODE, which designate line spacing. If - * ROFF_ATOM, we need not remember any state. - * - * (2) Have a maybe-NULL list of possible subsequent children for each - * node. Bl, e.g., can only have It children (roffparse). - * - * (3) Have a maybe-NULL list of possible parents for each node. It, - * e.g., can only have Bl as a parent (roffparse). - * - * (N.B. If (2) were complete, (3) wouldn't be necessary.) - * - * (4) Scope rules. If Pp exists, it closes the scope out from the - * previous Pp (if it exists). Same with Sh and Ss. If El exists, - * it closes out Bl and interim It. - * - * (5) Nesting. Sh cannot be any descendant of Sh. Bl, however, can be - * nested within an It. - * - * Once that's done, we're golden. +/* + * 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) +{ + int i; -/* Table of all known tokens. */ -static const struct rofftok tokens[ROFF_MAX] = { - { NULL, NULL, 0, ROFF_COMMENT, 0 }, /* \" */ - { roff_Dd, NULL, 0, ROFF_TEXT, 0 }, /* Dd */ - { roff_Dt, NULL, 0, ROFF_TEXT, 0 }, /* Dt */ - { roff_Os, NULL, 0, ROFF_TEXT, 0 }, /* Os */ - { roff_layout, NULL, ROFF_Sh, ROFF_LAYOUT, ROFF_PARSED }, /* Sh */ - { roff_layout, NULL, ROFF_Ss, ROFF_LAYOUT, ROFF_PARSED }, /* Ss */ - { roff_layout, NULL, ROFF_Pp, ROFF_LAYOUT, 0 }, /* Pp */ - { roff_layout, NULL, 0, ROFF_TEXT, 0 }, /* D1 */ - { roff_layout, NULL, 0, ROFF_TEXT, 0 }, /* Dl */ - { roff_layout, roffarg_Bd, 0, ROFF_LAYOUT, 0 }, /* Bd */ - { roff_layout, NULL, ROFF_Bd, ROFF_LAYOUT, 0 }, /* Ed */ - { roff_layout, roffarg_Bl, 0, ROFF_LAYOUT, 0 }, /* Bl */ - { roff_layout, NULL, ROFF_Bl, ROFF_LAYOUT, 0 }, /* El */ - { roff_layout, NULL, ROFF_It, ROFF_LAYOUT, 0 }, /* It */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ad */ - { roff_text, roffarg_An, 0, ROFF_TEXT, ROFF_PARSED }, /* An */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ar */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* Cd */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Cm */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dv */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Er */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ev */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ex */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fa */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* Fd */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fl */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fn */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ft */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ic */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* In */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Li */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* Nd */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Nm */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Op */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ot */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pa */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* Rv */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* St */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Va */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Vt */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xr */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %A */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %B */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* %D */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %I */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %J */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* %N */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* %O */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* %P */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* %R */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %T */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* %V */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ac */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ao */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Aq */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* At */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bc */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* Bf */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bo */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bq */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bsx */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bx */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* Db */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dc */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Do */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dq */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ec */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* Ef */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Em */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Eo */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Fx */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ms */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* No */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ns */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Nx */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ox */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pc */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Pf */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Po */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pq */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qc */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ql */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qo */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qq */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* Re */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* Rs */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sc */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* So */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sq */ - { roff_text, NULL, 0, ROFF_TEXT, 0 }, /* Sm */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sx */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sy */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Tn */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ux */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xc */ - { roff_text, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xo */ -}; + /* FIXME: make this be fast and efficient. */ -/* Table of all known token arguments. */ -static const struct roffarg tokenargs[ROFF_ARGMAX] = { - { 0 }, /* split */ - { 0 }, /* nosplit */ - { 0 }, /* ragged */ - { 0 }, /* unfilled */ - { 0 }, /* literal */ - { ROFF_VALUE }, /* file */ - { ROFF_VALUE }, /* offset */ - { 0 }, /* bullet */ - { 0 }, /* dash */ - { 0 }, /* hyphen */ - { 0 }, /* item */ - { 0 }, /* enum */ - { 0 }, /* tag */ - { 0 }, /* diag */ - { 0 }, /* hang */ - { 0 }, /* ohang */ - { 0 }, /* inset */ - { 0 }, /* column */ - { 0 }, /* width */ - { 0 }, /* compact */ -}; + for (i = 0; i < (int)ROFF_MAX; i++) + if (0 == strcmp(roffs[i].name, p)) + return((enum rofft)i); -const char *const toknamesp[ROFF_MAX] = - { - "\\\"", - "Dd", /* Title macros. */ - "Dt", - "Os", - "Sh", /* Layout macros */ - "Ss", - "Pp", - "D1", - "Dl", - "Bd", - "Ed", - "Bl", - "El", - "It", - "Ad", /* Text macros. */ - "An", - "Ar", - "Cd", - "Cm", - "Dr", - "Er", - "Ev", - "Ex", - "Fa", - "Fd", - "Fl", - "Fn", - "Ft", - "Ex", - "Ic", - "In", - "Li", - "Nd", - "Nm", - "Op", - "Ot", - "Pa", - "Rv", - "St", - "Va", - "Vt", - "Xr", - "\%A", /* General text macros. */ - "\%B", - "\%D", - "\%I", - "\%J", - "\%N", - "\%O", - "\%P", - "\%R", - "\%T", - "\%V", - "Ac", - "Ao", - "Aq", - "At", - "Bc", - "Bf", - "Bo", - "Bq", - "Bsx", - "Bx", - "Db", - "Dc", - "Do", - "Dq", - "Ec", - "Ef", - "Em", - "Eo", - "Fx", - "Ms", - "No", - "Ns", - "Nx", - "Ox", - "Pc", - "Pf", - "Po", - "Pq", - "Qc", - "Ql", - "Qo", - "Qq", - "Re", - "Rs", - "Sc", - "So", - "Sq", - "Sm", - "Sx", - "Sy", - "Tn", - "Ux", - "Xc", /* FIXME: do not support! */ - "Xo", /* FIXME: do not support! */ - }; + return(ROFF_MAX); +} -const char *const tokargnamesp[ROFF_ARGMAX] = - { - "split", - "nosplit", - "ragged", - "unfilled", - "literal", - "file", - "offset", - "bullet", - "dash", - "hyphen", - "item", - "enum", - "tag", - "diag", - "hang", - "ohang", - "inset", - "column", - "width", - "compact", - }; -const char *const *toknames = toknamesp; -const char *const *tokargnames = tokargnamesp; - - -int -roff_free(struct rofftree *tree, int flush) +/* + * Pop the current node off of the stack of roff instructions currently + * pending. + */ +static void +roffnode_pop(struct roff *r) { - int error; + struct roffnode *p; - assert(tree->mbuf); - if ( ! flush) - tree->mbuf = NULL; - - /* LINTED */ - while (tree->last) - if ( ! (*tokens[tree->last->tok].cb) - (tree->last->tok, tree, NULL, ROFF_EXIT)) - /* Disallow flushing. */ - tree->mbuf = NULL; - - error = tree->mbuf ? 0 : 1; - - if (tree->mbuf && (ROFF_PRELUDE & tree->state)) { - warnx("%s: prelude never finished", - tree->rbuf->name); - error = 1; - } - - free(tree); - return(error ? 0 : 1); + assert(r->last); + p = r->last; + r->last = r->last->parent; + if (p->end) + free(p->end); + free(p); } -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) +/* + * Push a roff node onto the instruction stack. This must later be + * removed with roffnode_pop(). + */ +static int +roffnode_push(struct roff *r, enum rofft tok, int line, int col) { - struct rofftree *tree; + struct roffnode *p; - if (NULL == (tree = calloc(1, sizeof(struct rofftree)))) { - warn("malloc"); - return(NULL); + if (NULL == (p = calloc(1, sizeof(struct roffnode)))) { + (*r->msg)(MANDOCERR_MEM, r->data, line, col, NULL); + return(0); } - 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; + p->tok = tok; + p->parent = r->last; + p->line = line; + p->col = col; - return(tree); + r->last = p; + return(1); } -int -roff_engine(struct rofftree *tree, char *buf, size_t sz) +static void +roff_free1(struct roff *r) { - 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)); - - return(roffparse(tree, buf, sz)); + while (r->last) + roffnode_pop(r); } -static int -textparse(const struct rofftree *tree, const char *buf, size_t sz) +void +roff_reset(struct roff *r) { - - if (NULL == tree->last) { - warnx("%s: unexpected text (line %zu)", - tree->rbuf->name, - tree->rbuf->line); - return(0); - } else if (NULL == tree->last->parent) { - warnx("%s: disallowed text (line %zu)", - tree->rbuf->name, - tree->rbuf->line); - return(0); - } - /* Print text. */ - - return(1); + roff_free1(r); } -static int -roffargs(int tok, char *buf, char **argv) +void +roff_free(struct roff *r) { - int i; - (void)tok;/* FIXME: quotable strings? */ - - 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; - - return(ROFF_MAXARG > i); + roff_free1(r); + free(r); } -static int -roffparse(struct rofftree *tree, char *buf, size_t sz) +struct roff * +roff_alloc(const mandocmsg msg, void *data) { - int tok, t; - struct roffnode *node; - char *argv[ROFF_MAXARG]; - const char **argvp; + struct roff *r; - assert(sz > 0); - - /* - * 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); + if (NULL == (r = calloc(1, sizeof(struct roff)))) { + (*msg)(MANDOCERR_MEM, data, 0, 0, NULL); return(0); - - /* FIXME: .Bsx is three letters! */ - } 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->msg = msg; + r->data = data; + 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. */ + /* Return when in free text without a context. */ - 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])) { + /* 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); - if (node) { - assert(ROFF_LAYOUT == tokens[tok].type); - assert( ! (ROFF_NESTED & tokens[tok].flags)); - assert(node->tok == tok); + /* There's nothing on the stack: make us anew. */ - /* Clear up to last scoped token. */ + ppos = pos; + if (ROFF_MAX == (t = roff_parse(*bufp, &pos))) + return(ROFF_CONT); - /* LINTED */ - do { - t = tree->last->tok; - if ( ! (*tokens[tree->last->tok].cb) - (tree->last->tok, tree, NULL, ROFF_EXIT)) - return(0); - } while (t != tok); - } - - /* Proceed with actual token processing. */ - - argvp = (const char **)&argv[1]; - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); + 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); -static int -rofffindcallable(const char *name) -{ - int c; + for (j = 0; j < 4; j++, (*pos)++) + if ('\0' == (mac[j] = buf[*pos])) + break; + else if (' ' == buf[*pos]) + break; - if (ROFF_MAX == (c = rofffindtok(name))) + if (j == 4 || j < 1) return(ROFF_MAX); - return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX); -} + mac[j] = '\0'; -static struct roffnode * -roffnode_new(int tokid, struct rofftree *tree) -{ - struct roffnode *p; - - if (NULL == (p = malloc(sizeof(struct roffnode)))) { - warn("malloc"); - return(NULL); - } + if (ROFF_MAX == (t = roff_hash_find(mac))) + return(t); - p->line = tree->rbuf->line; - p->tok = tokid; - p->parent = tree->last; - tree->last = p; - return(p); -} + while (buf[*pos] && ' ' == buf[*pos]) + (*pos)++; - -static int -roffargok(int tokid, int argid) -{ - const int *c; - - if (NULL == (c = tokens[tokid].args)) - return(0); - - for ( ; ROFF_ARGMAX != *c; c++) - if (argid == *c) - return(1); - - return(0); + return(t); } -static void -roffnode_free(int tokid, struct rofftree *tree) +#if 0 +/* ARGSUSED */ +static enum rofferr +roff_sub_ig(ROFF_ARGS) { - struct roffnode *p; + int i, j; - assert(tree->last); - assert(tree->last->tok == tokid); + /* Ignore free-text lines. */ - p = tree->last; - tree->last = tree->last->parent; - free(p); -} + if ('.' != (*bufp)[ppos] && '\'' != (*bufp)[ppos]) + return(ROFF_IGN); + if (r->last->end) { + i = ppos + 1; -/* ARGSUSED */ -static int -roff_Dd(ROFFCALL_ARGS) -{ + while ((*bufp)[i] && ' ' == (*bufp)[i]) + i++; - if (ROFF_BODY & tree->state) { - assert( ! (ROFF_PRELUDE & tree->state)); - assert(ROFF_PRELUDE_Dd & tree->state); - return(roff_text(tok, tree, argv, type)); - } + for (j = 0; r->last->end[j]; i++, j++) + if ((*bufp)[i] != r->last->end[j]) + return(ROFF_IGN); - assert(ROFF_PRELUDE & tree->state); - assert( ! (ROFF_BODY & tree->state)); + if (r->last->end[j]) + return(ROFF_IGN); + if ((*bufp)[i] && ' ' != (*bufp)[i]) + 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); - } + while (' ' == (*bufp)[i]) + i++; - /* TODO: parse date. */ + } else if (ROFF_close != roff_parse(*bufp, &i)) + return(ROFF_IGN); - assert(NULL == tree->last); - tree->state |= ROFF_PRELUDE_Dd; + roffnode_pop(r); - return(1); + if ('\0' == (*bufp)[i]) + return(ROFF_IGN); + if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, i, NULL)) + return(ROFF_ERR); + + return(ROFF_IGN); } /* ARGSUSED */ -static int -roff_Dt(ROFFCALL_ARGS) +static enum rofferr +roff_new_close(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 ( ! (*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_PRELUDE_Dt & tree->state)) { - warnx("%s: prelude `Dt' out-of-order (line %zu)", - tree->rbuf->name, tree->rbuf->line); - return(0); - } - - /* TODO: parse date. */ - - assert(NULL == tree->last); - tree->state |= ROFF_PRELUDE_Dt; - - return(1); + return(ROFF_IGN); } +#endif /* ARGSUSED */ -static int -roff_Os(ROFFCALL_ARGS) +static enum rofferr +roff_ccond(ROFF_ARGS) { - 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)); + 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); - 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); - } + ROFF_MDEBUG(r, "closing explicit scope"); + roffnode_pop(r); - /* TODO: extract OS. */ + while (r->last) { + if (--r->last->endspan < 0) + break; - tree->state |= ROFF_PRELUDE_Os; - tree->state &= ~ROFF_PRELUDE; - tree->state |= ROFF_BODY; + ROFF_MDEBUG(r, "closing implicit scope"); + roffnode_pop(r); + } - assert(NULL == tree->last); - - return(roff_layout(tok, tree, argv, type)); + return(ROFF_IGN); } -/* ARGUSED */ -static int -roffnextopt(int tok, const char ***in, char **val) +/* ARGSUSED */ +static enum rofferr +roff_if(ROFF_ARGS) { - const char *arg, **argv; - int v; - *val = NULL; - argv = *in; - assert(argv); + /* + * 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. + */ - if (NULL == (arg = *argv)) - return(-1); - if ('-' != *arg) - return(-1); + if ( ! roffnode_push(r, tok, ln, ppos)) + return(ROFF_ERR); - /* FIXME: should we let this slide... ? */ + while ((*bufp)[pos] && ' ' != (*bufp)[pos]) + pos++; + while (' ' == (*bufp)[pos]) + pos++; - if (ROFF_ARGMAX == (v = rofffindarg(&arg[1]))) - return(-1); + /* Don't evaluate: just assume NO. */ - /* FIXME: should we let this slide... ? */ + r->last->endspan = 1; - if ( ! roffargok(tok, v)) - return(-1); - if ( ! (ROFF_VALUE & tokenargs[v].flags)) - return(v); + 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"); - *in = ++argv; + if ('\0' == (*bufp)[pos]) + return(ROFF_IGN); - /* FIXME: what if this looks like a roff token or argument? */ - - return(*argv ? v : ROFF_ARGMAX); + *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_MAXARG]; - char *v, *argvp[ROFF_MAXARG]; + int i; - if (ROFF_PRELUDE & tree->state) { - warnx("%s: macro `%s' called in prelude (line %zu)", - tree->rbuf->name, - toknames[tok], - tree->rbuf->line); - return(0); + if ( ! roffnode_push(r, tok, ln, ppos)) + return(ROFF_ERR); + + /* + * Other macros (not `ig') using this routine have additional + * crap here that we discard. + */ + + if (ROFF_ig != tok) { + while ((*bufp)[ppos] && ' ' != (*bufp)[ppos]) + ppos++; + while (' ' == (*bufp)[ppos]) + ppos++; } - if (ROFF_EXIT == type) { - roffnode_free(tok, tree); - return((*tree->roffblkout)(tok)); - } + i = (int)ppos; - i = 0; - - while (-1 != (c = roffnextopt(tok, &argv, &v))) { - if (ROFF_ARGMAX == c) { - warnx("%s: error parsing `%s' args (line %zu)", - tree->rbuf->name, - toknames[tok], - tree->rbuf->line); - return(0); - } else if ( ! roffargok(tok, c)) { - warnx("%s: arg `%s' not for `%s' (line %zu)", - tree->rbuf->name, - tokargnames[c], - toknames[tok], - tree->rbuf->line); - return(0); - } - argcp[i] = c; - argvp[i] = v; + while ((*bufp)[i] && ' ' != (*bufp)[i]) i++; - argv++; - } - argcp[i] = ROFF_ARGMAX; - argvp[i] = NULL; + if (i == (int)ppos) + return(ROFF_IGN); - if (NULL == roffnode_new(tok, tree)) - return(0); + if ((*bufp)[i]) + if ( ! (*r->msg)(MANDOCERR_ARGSLOST, r->data, ln, i, NULL)) + return(ROFF_ERR); - if ( ! (*tree->roffin)(tok, argcp, argvp)) - return(0); + /* + * 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 ( ! (ROFF_PARSED & tokens[tok].flags)) { - /* TODO: print all tokens. */ - - if ( ! ((*tree->roffout)(tok))) - return(0); - return((*tree->roffblkin)(tok)); + 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); } - while (*argv) { - if (2 >= strlen(*argv) && ROFF_MAX != - (c = rofffindcallable(*argv))) - if ( ! (*tokens[c].cb)(c, tree, - argv + 1, ROFF_ENTER)) - return(0); + memcpy(r->last->end, &(*bufp)[ppos], (size_t)(i - ppos)); + r->last->end[i - ppos] = '\0'; - /* TODO: print token. */ - argv++; - } - - if ( ! ((*tree->roffout)(tok))) - return(0); - - return((*tree->roffblkin)(tok)); + return(ROFF_IGN); } - - -/* ARGSUSED */ -static int -roff_text(ROFFCALL_ARGS) -{ - int i, c, argcp[ROFF_MAXARG]; - char *v, *argvp[ROFF_MAXARG]; - - if (ROFF_PRELUDE & tree->state) { - warnx("%s: macro `%s' called in prelude (line %zu)", - tree->rbuf->name, - toknames[tok], - tree->rbuf->line); - return(0); - } - - i = 0; - - while (-1 != (c = roffnextopt(tok, &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; - i++; - argv++; - } - - argcp[i] = ROFF_ARGMAX; - argvp[i] = NULL; - - if ( ! (*tree->roffin)(tok, argcp, argvp)) - return(0); - - if ( ! (ROFF_PARSED & tokens[tok].flags)) { - /* TODO: print all tokens. */ - return((*tree->roffout)(tok)); - } - - while (*argv) { - if (2 >= strlen(*argv) && ROFF_MAX != - (c = rofffindcallable(*argv))) - if ( ! (*tokens[c].cb)(c, tree, - argv + 1, ROFF_ENTER)) - return(0); - - /* TODO: print token. */ - argv++; - } - - return((*tree->roffout)(tok)); -} +#endif