=================================================================== RCS file: /cvs/mandoc/roff.c,v retrieving revision 1.5 retrieving revision 1.234 diff -u -p -r1.5 -r1.234 --- mandoc/roff.c 2008/11/25 16:49:57 1.5 +++ mandoc/roff.c 2014/10/20 19:04:45 1.234 @@ -1,987 +1,2451 @@ -/* $Id: roff.c,v 1.5 2008/11/25 16:49:57 kristaps Exp $ */ +/* $Id: roff.c,v 1.234 2014/10/20 19:04:45 kristaps Exp $ */ /* - * Copyright (c) 2008 Kristaps Dzonsons + * Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons + * Copyright (c) 2010-2014 Ingo Schwarze * * 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 AUTHORS DISCLAIM ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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 "config.h" + +#include + #include #include -#include -#include #include +#include #include -#include -#include "libmdocml.h" -#include "private.h" +#include "mandoc.h" +#include "mandoc_aux.h" +#include "libmandoc.h" +#include "libroff.h" -#define ROFF_MAXARG 10 +/* Maximum number of nested if-else conditionals. */ +#define RSTACK_MAX 128 -/* Whether we're entering or leaving a roff scope. */ -enum roffd { - ROFF_ENTER = 0, - ROFF_EXIT +/* Maximum number of string expansions per line, to break infinite loops. */ +#define EXPAND_LIMIT 1000 + +enum rofft { + ROFF_ad, + ROFF_am, + ROFF_ami, + ROFF_am1, + ROFF_as, + ROFF_cc, + ROFF_ce, + ROFF_de, + ROFF_dei, + ROFF_de1, + ROFF_ds, + ROFF_el, + ROFF_fam, + ROFF_hw, + ROFF_hy, + ROFF_ie, + ROFF_if, + ROFF_ig, + ROFF_it, + ROFF_ne, + ROFF_nh, + ROFF_nr, + ROFF_ns, + ROFF_pl, + ROFF_ps, + ROFF_rm, + ROFF_rr, + ROFF_so, + ROFF_ta, + ROFF_tr, + ROFF_Dd, + ROFF_TH, + ROFF_TS, + ROFF_TE, + ROFF_T_, + ROFF_EQ, + ROFF_EN, + ROFF_cblock, + ROFF_USERDEF, + ROFF_MAX }; -/* The type of a macro (see mdoc(7) for more). */ -enum rofftype { - ROFF_COMMENT, - ROFF_TEXT, - ROFF_LAYOUT +/* + * An incredibly-simple string buffer. + */ +struct roffstr { + char *p; /* nil-terminated buffer */ + size_t sz; /* saved strlen(p) */ }; -/* Arguments passed to a macro callback. */ -#define ROFFCALL_ARGS \ - int tok, struct rofftree *tree, \ - const char *argv[], enum roffd type +/* + * A key-value roffstr pair as part of a singly-linked list. + */ +struct roffkv { + struct roffstr key; + struct roffstr val; + struct roffkv *next; /* next in list */ +}; -struct rofftree; - -/* 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. */ +/* + * A single number register as part of a singly-linked list. + */ +struct roffreg { + struct roffstr key; + int val; + struct roffreg *next; }; -/* An argument to a roff token (like -split or -enum). */ -struct roffarg { - int flags; -#define ROFF_VALUE (1 << 0) /* Has a value. */ +struct roff { + struct mparse *parse; /* parse point */ + struct roffnode *last; /* leaf of stack */ + int *rstack; /* stack of inverted `ie' values */ + struct roffreg *regtab; /* number registers */ + struct roffkv *strtab; /* user-defined strings & macros */ + struct roffkv *xmbtab; /* multi-byte trans table (`tr') */ + struct roffstr *xtab; /* single-byte trans table (`tr') */ + const char *current_string; /* value of last called user macro */ + struct tbl_node *first_tbl; /* first table parsed */ + struct tbl_node *last_tbl; /* last table parsed */ + struct tbl_node *tbl; /* current table being parsed */ + struct eqn_node *last_eqn; /* last equation parsed */ + struct eqn_node *first_eqn; /* first equation parsed */ + struct eqn_node *eqn; /* current equation being parsed */ + int eqn_inline; /* current equation is inline */ + int options; /* parse options */ + int rstacksz; /* current size limit of rstack */ + int rstackpos; /* position in rstack */ + int format; /* current file in mdoc or man format */ + char control; /* control character */ }; -/* 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. */ + enum rofft tok; /* type of node */ + struct roffnode *parent; /* up one in stack */ + int line; /* parse line */ + int col; /* parse col */ + char *name; /* node name, e.g. macro name */ + char *end; /* end-rules: custom token */ + int endspan; /* end-rules: next-line or infty */ + int rule; /* current evaluation rule */ }; -/* 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. */ +#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 */ + +typedef enum rofferr (*roffproc)(ROFF_ARGS); + +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); -static int roff_layout(ROFFCALL_ARGS); -static int roff_text(ROFFCALL_ARGS); +struct predef { + const char *name; /* predefined input name */ + const char *str; /* replacement symbol */ +}; -static struct roffnode *roffnode_new(int, struct rofftree *); -static void roffnode_free(int, struct rofftree *); +#define PREDEF(__name, __str) \ + { (__name), (__str) }, -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 *, +static enum rofft roffhash_find(const char *, size_t); +static void roffhash_init(void); +static void roffnode_cleanscope(struct roff *); +static void roffnode_pop(struct roff *); +static void roffnode_push(struct roff *, enum rofft, + const char *, int, int); +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_cc(ROFF_ARGS); +static void roff_ccond(struct roff *, int, int); +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_eqndelim(struct roff *, + char **, size_t *, int); +static int roff_evalcond(struct roff *r, int, + const char *, int *); +static int roff_evalnum(struct roff *, int, + const char *, int *, int *, int); +static int roff_evalpar(struct roff *, int, + const char *, int *, int *); +static int roff_evalstrcond(const char *, int *); +static void roff_free1(struct roff *); +static void roff_freereg(struct roffreg *); +static void roff_freestr(struct roffkv *); +static size_t roff_getname(struct roff *, char **, int, int); +static int roff_getnum(const char *, int *, int *); +static int roff_getop(const char *, int *, char *); +static int roff_getregn(const struct roff *, const char *, size_t); +static int roff_getregro(const char *name); +static const char *roff_getstrn(const struct roff *, + const char *, size_t); +static enum rofferr roff_it(ROFF_ARGS); +static enum rofferr roff_line_ignore(ROFF_ARGS); +static enum rofferr roff_nr(ROFF_ARGS); +static void roff_openeqn(struct roff *, const char *, + int, int, const char *); +static enum rofft roff_parse(struct roff *, char *, int *, + int, int); +static enum rofferr roff_parsetext(char **, size_t *, int, int *); +static enum rofferr roff_res(struct roff *, + char **, size_t *, int, int); +static enum rofferr roff_rm(ROFF_ARGS); +static enum rofferr roff_rr(ROFF_ARGS); +static void roff_setstr(struct roff *, + const char *, const char *, int); +static void roff_setstrn(struct roffkv **, const char *, + size_t, const char *, size_t, int); +static enum rofferr roff_so(ROFF_ARGS); +static enum rofferr roff_tr(ROFF_ARGS); +static enum rofferr roff_Dd(ROFF_ARGS); +static enum rofferr roff_TH(ROFF_ARGS); +static enum rofferr roff_TE(ROFF_ARGS); +static enum rofferr roff_TS(ROFF_ARGS); +static enum rofferr roff_EQ(ROFF_ARGS); +static enum rofferr roff_EN(ROFF_ARGS); +static enum rofferr roff_T_(ROFF_ARGS); +static enum rofferr roff_userdef(ROFF_ARGS); -/* 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 }; +/* See roffhash_find() */ -/* 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. - */ +#define ASCII_HI 126 +#define ASCII_LO 33 +#define HASHWIDTH (ASCII_HI - ASCII_LO + 1) -/* 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 */ +static struct roffmac *hash[HASHWIDTH]; + +static struct roffmac roffs[ROFF_MAX] = { + { "ad", roff_line_ignore, NULL, NULL, 0, NULL }, + { "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 }, + { "as", roff_ds, NULL, NULL, 0, NULL }, + { "cc", roff_cc, NULL, NULL, 0, NULL }, + { "ce", roff_line_ignore, NULL, NULL, 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 }, + { "fam", roff_line_ignore, NULL, NULL, 0, NULL }, + { "hw", roff_line_ignore, NULL, NULL, 0, NULL }, + { "hy", roff_line_ignore, NULL, NULL, 0, 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 }, + { "it", roff_it, NULL, NULL, 0, NULL }, + { "ne", roff_line_ignore, NULL, NULL, 0, NULL }, + { "nh", roff_line_ignore, NULL, NULL, 0, NULL }, + { "nr", roff_nr, NULL, NULL, 0, NULL }, + { "ns", roff_line_ignore, NULL, NULL, 0, NULL }, + { "pl", roff_line_ignore, NULL, NULL, 0, NULL }, + { "ps", roff_line_ignore, NULL, NULL, 0, NULL }, + { "rm", roff_rm, NULL, NULL, 0, NULL }, + { "rr", roff_rr, NULL, NULL, 0, NULL }, + { "so", roff_so, NULL, NULL, 0, NULL }, + { "ta", roff_line_ignore, NULL, NULL, 0, NULL }, + { "tr", roff_tr, NULL, NULL, 0, NULL }, + { "Dd", roff_Dd, NULL, NULL, 0, NULL }, + { "TH", roff_TH, NULL, NULL, 0, NULL }, + { "TS", roff_TS, NULL, NULL, 0, NULL }, + { "TE", roff_TE, NULL, NULL, 0, NULL }, + { "T&", roff_T_, NULL, NULL, 0, NULL }, + { "EQ", roff_EQ, NULL, NULL, 0, NULL }, + { "EN", roff_EN, NULL, NULL, 0, NULL }, + { ".", roff_cblock, NULL, NULL, 0, NULL }, + { NULL, roff_userdef, NULL, NULL, 0, NULL }, }; -/* 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 */ +/* not currently implemented: Ds em Eq LP Me PP pp Or Rd Sf SH */ +const char *const __mdoc_reserved[] = { + "Ac", "Ad", "An", "Ao", "Ap", "Aq", "Ar", "At", + "Bc", "Bd", "Bf", "Bk", "Bl", "Bo", "Bq", + "Brc", "Bro", "Brq", "Bsx", "Bt", "Bx", + "Cd", "Cm", "Db", "Dc", "Dd", "Dl", "Do", "Dq", + "Dt", "Dv", "Dx", "D1", + "Ec", "Ed", "Ef", "Ek", "El", "Em", + "En", "Eo", "Er", "Es", "Ev", "Ex", + "Fa", "Fc", "Fd", "Fl", "Fn", "Fo", "Fr", "Ft", "Fx", + "Hf", "Ic", "In", "It", "Lb", "Li", "Lk", "Lp", + "Ms", "Mt", "Nd", "Nm", "No", "Ns", "Nx", + "Oc", "Oo", "Op", "Os", "Ot", "Ox", + "Pa", "Pc", "Pf", "Po", "Pp", "Pq", + "Qc", "Ql", "Qo", "Qq", "Re", "Rs", "Rv", + "Sc", "Sh", "Sm", "So", "Sq", + "Ss", "St", "Sx", "Sy", + "Ta", "Tn", "Ud", "Ux", "Va", "Vt", "Xc", "Xo", "Xr", + "%A", "%B", "%C", "%D", "%I", "%J", "%N", "%O", + "%P", "%Q", "%R", "%T", "%U", "%V", + NULL }; -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! */ - }; +/* not currently implemented: BT DE DS ME MT PT SY TQ YS */ +const char *const __man_reserved[] = { + "AT", "B", "BI", "BR", "DT", + "EE", "EN", "EQ", "EX", "HP", "I", "IB", "IP", "IR", + "LP", "OP", "P", "PD", "PP", + "R", "RB", "RE", "RI", "RS", "SB", "SH", "SM", "SS", + "TE", "TH", "TP", "TS", "T&", "UC", "UE", "UR", + NULL +}; -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", - }; +/* Array of injected predefined strings. */ +#define PREDEFS_MAX 38 +static const struct predef predefs[PREDEFS_MAX] = { +#include "predefs.in" +}; -const char *const *toknames = toknamesp; -const char *const *tokargnames = tokargnamesp; +/* See roffhash_find() */ +#define ROFF_HASH(p) (p[0] - ASCII_LO) +static int roffit_lines; /* number of lines to delay */ +static char *roffit_macro; /* nil-terminated macro line */ -int -roff_free(struct rofftree *tree, int flush) + +static void +roffhash_init(void) { - int error; + struct roffmac *n; + int buc, i; - assert(tree->mbuf); - if ( ! flush) - tree->mbuf = NULL; + for (i = 0; i < (int)ROFF_USERDEF; 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); +/* + * 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 +roffhash_find(const char *p, size_t s) +{ + int buc; + struct roffmac *n; + + /* + * 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. + */ + + if (p[0] < ASCII_LO || p[0] > ASCII_HI) + return(ROFF_MAX); + + buc = ROFF_HASH(p); + + if (NULL == (n = hash[buc])) + return(ROFF_MAX); + for ( ; n; n = n->next) + if (0 == strncmp(n->name, p, s) && '\0' == n->name[(int)s]) + return((enum rofft)(n - roffs)); + + return(ROFF_MAX); } +/* + * Pop the current node off of the stack of roff instructions currently + * pending. + */ +static void +roffnode_pop(struct roff *r) +{ + struct roffnode *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) + assert(r->last); + p = r->last; + + r->last = r->last->parent; + free(p->name); + free(p->end); + free(p); +} + +/* + * Push a roff node onto the instruction stack. This must later be + * removed with roffnode_pop(). + */ +static void +roffnode_push(struct roff *r, enum rofft tok, const char *name, + int line, int col) { - struct rofftree *tree; + struct roffnode *p; - if (NULL == (tree = calloc(1, sizeof(struct rofftree)))) { - warn("malloc"); - return(NULL); + p = mandoc_calloc(1, sizeof(struct roffnode)); + p->tok = tok; + if (name) + p->name = mandoc_strdup(name); + p->parent = r->last; + p->line = line; + p->col = col; + p->rule = p->parent ? p->parent->rule : 0; + + r->last = p; +} + +static void +roff_free1(struct roff *r) +{ + struct tbl_node *tbl; + struct eqn_node *e; + int i; + + while (NULL != (tbl = r->first_tbl)) { + r->first_tbl = tbl->next; + tbl_free(tbl); } + r->first_tbl = r->last_tbl = r->tbl = NULL; - 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; + while (NULL != (e = r->first_eqn)) { + r->first_eqn = e->next; + eqn_free(e); + } + r->first_eqn = r->last_eqn = r->eqn = NULL; - return(tree); -} + while (r->last) + roffnode_pop(r); + free (r->rstack); + r->rstack = NULL; + r->rstacksz = 0; + r->rstackpos = -1; -int -roff_engine(struct rofftree *tree, char *buf, size_t sz) -{ + roff_freereg(r->regtab); + r->regtab = NULL; - 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)); + roff_freestr(r->strtab); + roff_freestr(r->xmbtab); + r->strtab = r->xmbtab = NULL; - return(roffparse(tree, buf, sz)); + if (r->xtab) + for (i = 0; i < 128; i++) + free(r->xtab[i].p); + free(r->xtab); + r->xtab = NULL; } +void +roff_reset(struct roff *r) +{ -static int -textparse(const struct rofftree *tree, const char *buf, size_t sz) + roff_free1(r); + r->format = r->options & (MPARSE_MDOC | MPARSE_MAN); + r->control = 0; +} + +void +roff_free(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. */ + roff_free1(r); + free(r); +} - return(1); +struct roff * +roff_alloc(struct mparse *parse, int options) +{ + struct roff *r; + + r = mandoc_calloc(1, sizeof(struct roff)); + r->parse = parse; + r->options = options; + r->format = options & (MPARSE_MDOC | MPARSE_MAN); + r->rstackpos = -1; + + roffhash_init(); + + return(r); } +/* + * In the current line, expand escape sequences that tend to get + * used in numerical expressions and conditional requests. + * Also check the syntax of the remaining escape sequences. + */ +static enum rofferr +roff_res(struct roff *r, char **bufp, size_t *szp, int ln, int pos) +{ + char ubuf[24]; /* buffer to print the number */ + const char *start; /* start of the string to process */ + char *stesc; /* start of an escape sequence ('\\') */ + const char *stnam; /* start of the name, after "[(*" */ + const char *cp; /* end of the name, e.g. before ']' */ + const char *res; /* the string to be substituted */ + char *nbuf; /* new buffer to copy bufp to */ + size_t maxl; /* expected length of the escape name */ + size_t naml; /* actual length of the escape name */ + int expand_count; /* to avoid infinite loops */ + int npos; /* position in numeric expression */ + int arg_complete; /* argument not interrupted by eol */ + char term; /* character terminating the escape */ -static int -roffargs(int tok, char *buf, char **argv) + expand_count = 0; + start = *bufp + pos; + stesc = strchr(start, '\0') - 1; + while (stesc-- > start) { + + /* Search backwards for the next backslash. */ + + if ('\\' != *stesc) + continue; + + /* If it is escaped, skip it. */ + + for (cp = stesc - 1; cp >= start; cp--) + if ('\\' != *cp) + break; + + if (0 == (stesc - cp) % 2) { + stesc = (char *)cp; + continue; + } + + /* Decide whether to expand or to check only. */ + + term = '\0'; + cp = stesc + 1; + switch (*cp) { + case '*': + res = NULL; + break; + case 'B': + /* FALLTHROUGH */ + case 'w': + term = cp[1]; + /* FALLTHROUGH */ + case 'n': + res = ubuf; + break; + default: + if (ESCAPE_ERROR == mandoc_escape(&cp, NULL, NULL)) + mandoc_vmsg(MANDOCERR_ESC_BAD, + r->parse, ln, (int)(stesc - *bufp), + "%.*s", (int)(cp - stesc), stesc); + continue; + } + + if (EXPAND_LIMIT < ++expand_count) { + mandoc_msg(MANDOCERR_ROFFLOOP, r->parse, + ln, (int)(stesc - *bufp), NULL); + return(ROFF_IGN); + } + + /* + * The third character decides the length + * of the name of the string or register. + * Save a pointer to the name. + */ + + if ('\0' == term) { + switch (*++cp) { + case '\0': + maxl = 0; + break; + case '(': + cp++; + maxl = 2; + break; + case '[': + cp++; + term = ']'; + maxl = 0; + break; + default: + maxl = 1; + break; + } + } else { + cp += 2; + maxl = 0; + } + stnam = cp; + + /* Advance to the end of the name. */ + + arg_complete = 1; + for (naml = 0; 0 == maxl || naml < maxl; naml++, cp++) { + if ('\0' == *cp) { + mandoc_msg(MANDOCERR_ESC_BAD, r->parse, + ln, (int)(stesc - *bufp), stesc); + arg_complete = 0; + break; + } + if (0 == maxl && *cp == term) { + cp++; + break; + } + } + + /* + * Retrieve the replacement string; if it is + * undefined, resume searching for escapes. + */ + + switch (stesc[1]) { + case '*': + if (arg_complete) + res = roff_getstrn(r, stnam, naml); + break; + case 'B': + npos = 0; + ubuf[0] = arg_complete && + roff_evalnum(r, ln, stnam, &npos, NULL, 0) && + stnam + npos + 1 == cp ? '1' : '0'; + ubuf[1] = '\0'; + break; + case 'n': + if (arg_complete) + (void)snprintf(ubuf, sizeof(ubuf), "%d", + roff_getregn(r, stnam, naml)); + else + ubuf[0] = '\0'; + break; + case 'w': + /* use even incomplete args */ + (void)snprintf(ubuf, sizeof(ubuf), "%d", + 24 * (int)naml); + break; + } + + if (NULL == res) { + mandoc_vmsg(MANDOCERR_STR_UNDEF, + r->parse, ln, (int)(stesc - *bufp), + "%.*s", (int)naml, stnam); + res = ""; + } + + /* Replace the escape sequence by the string. */ + + *stesc = '\0'; + *szp = mandoc_asprintf(&nbuf, "%s%s%s", + *bufp, res, cp) + 1; + + /* Prepare for the next replacement. */ + + start = nbuf + pos; + stesc = nbuf + (stesc - *bufp) + strlen(res); + free(*bufp); + *bufp = nbuf; + } + return(ROFF_CONT); +} + +/* + * Process text streams: + * Convert all breakable hyphens into ASCII_HYPH. + * Decrement and spring input line trap. + */ +static enum rofferr +roff_parsetext(char **bufp, size_t *szp, int pos, int *offs) { - int i; + size_t sz; + const char *start; + char *p; + int isz; + enum mandoc_esc esc; - (void)tok;/* FIXME: quotable strings? */ + start = p = *bufp + pos; - assert(tok >= 0 && tok < ROFF_MAX); - assert('.' == *buf); + while ('\0' != *p) { + sz = strcspn(p, "-\\"); + p += sz; - /* LINTED */ - for (i = 0; *buf && i < ROFF_MAXARG; i++) { - argv[i] = buf++; - while (*buf && ! isspace(*buf)) - buf++; - if (0 == *buf) { + if ('\0' == *p) + break; + + if ('\\' == *p) { + /* Skip over escapes. */ + p++; + esc = mandoc_escape((const char **)&p, NULL, NULL); + if (ESCAPE_ERROR == esc) + break; continue; + } else if (p == start) { + p++; + continue; } - *buf++ = 0; - while (*buf && isspace(*buf)) - buf++; + + if (isalpha((unsigned char)p[-1]) && + isalpha((unsigned char)p[1])) + *p = ASCII_HYPH; + p++; } - - assert(i > 0); - if (i < ROFF_MAXARG) - argv[i] = NULL; - return(ROFF_MAXARG > i); + /* Spring the input line trap. */ + if (1 == roffit_lines) { + isz = mandoc_asprintf(&p, "%s\n.%s", *bufp, roffit_macro); + free(*bufp); + *bufp = p; + *szp = isz + 1; + *offs = 0; + free(roffit_macro); + roffit_lines = 0; + return(ROFF_REPARSE); + } else if (1 < roffit_lines) + --roffit_lines; + return(ROFF_CONT); } +enum rofferr +roff_parseln(struct roff *r, int ln, char **bufp, + size_t *szp, int pos, int *offs) +{ + enum rofft t; + enum rofferr e; + int ppos, ctl; -static int -roffparse(struct rofftree *tree, char *buf, size_t sz) + /* Handle in-line equation delimiters. */ + + if (r->last_eqn != NULL && r->last_eqn->delim && + (r->eqn == NULL || r->eqn_inline)) { + e = roff_eqndelim(r, bufp, szp, pos); + if (e == ROFF_REPARSE) + return(e); + assert(e == ROFF_CONT); + } + + /* Expand some escape sequences. */ + + e = roff_res(r, bufp, szp, ln, pos); + if (ROFF_IGN == e) + return(e); + assert(ROFF_CONT == e); + + ppos = pos; + ctl = roff_getcontrol(r, *bufp, &pos); + + /* + * 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. + * Finally, if there's an equation scope open, divert it into it + * no matter our state. + */ + + if (r->last && ! ctl) { + t = r->last->tok; + assert(roffs[t].text); + e = (*roffs[t].text)(r, t, bufp, szp, ln, pos, pos, offs); + assert(ROFF_IGN == e || ROFF_CONT == e); + if (ROFF_CONT != e) + return(e); + } + if (r->eqn) + return(eqn_read(&r->eqn, ln, *bufp, ppos, offs)); + if ( ! ctl) { + if (r->tbl) + return(tbl_read(r->tbl, ln, *bufp, pos)); + return(roff_parsetext(bufp, szp, pos, offs)); + } + + /* Skip empty request lines. */ + + if ((*bufp)[pos] == '"') { + mandoc_msg(MANDOCERR_COMMENT_BAD, r->parse, + ln, pos, NULL); + return(ROFF_IGN); + } else if ((*bufp)[pos] == '\0') + return(ROFF_IGN); + + /* + * If a scope is open, go to the child handler for that macro, + * as it may want to preprocess before doing anything with it. + * Don't do so if an equation is open. + */ + + if (r->last) { + t = r->last->tok; + assert(roffs[t].sub); + return((*roffs[t].sub)(r, t, bufp, szp, + ln, ppos, pos, offs)); + } + + /* + * 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. + */ + + if (ROFF_MAX == (t = roff_parse(r, *bufp, &pos, ln, ppos))) + return(ROFF_CONT); + + assert(roffs[t].proc); + return((*roffs[t].proc)(r, t, bufp, szp, ln, ppos, pos, offs)); +} + +void +roff_endparse(struct roff *r) { - int tok, t; - struct roffnode *node; - char *argv[ROFF_MAXARG]; - const char **argvp; - assert(sz > 0); + if (r->last) + mandoc_msg(MANDOCERR_BLK_NOEND, r->parse, + r->last->line, r->last->col, + roffs[r->last->tok].name); + if (r->eqn) { + mandoc_msg(MANDOCERR_BLK_NOEND, r->parse, + r->eqn->eqn.ln, r->eqn->eqn.pos, "EQ"); + eqn_end(&r->eqn); + } + + if (r->tbl) { + mandoc_msg(MANDOCERR_BLK_NOEND, r->parse, + r->tbl->line, r->tbl->pos, "TS"); + tbl_end(&r->tbl); + } +} + +/* + * 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(struct roff *r, char *buf, int *pos, int ln, int ppos) +{ + char *cp; + const char *mac; + size_t maclen; + enum rofft t; + + cp = buf + *pos; + + if ('\0' == *cp || '"' == *cp || '\t' == *cp || ' ' == *cp) + return(ROFF_MAX); + + mac = cp; + maclen = roff_getname(r, &cp, ln, ppos); + + t = (r->current_string = roff_getstrn(r, mac, maclen)) + ? ROFF_USERDEF : roffhash_find(mac, maclen); + + if (ROFF_MAX != t) + *pos = cp - buf; + + return(t); +} + +static enum rofferr +roff_cblock(ROFF_ARGS) +{ + /* - * 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. + * A block-close `..' should only be invoked as a child of an + * ignore macro, otherwise raise a warning and just ignore it. */ - if (3 > sz) { - warnx("%s: malformed line (line %zu)", - tree->rbuf->name, - tree->rbuf->line); - 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 (NULL == r->last) { + mandoc_msg(MANDOCERR_BLK_NOTOPEN, r->parse, + ln, ppos, ".."); + return(ROFF_IGN); } + switch (r->last->tok) { + case ROFF_am: + /* ROFF_am1 is remapped to ROFF_am in roff_block(). */ + /* FALLTHROUGH */ + case ROFF_ami: + /* FALLTHROUGH */ + case ROFF_de: + /* ROFF_de1 is remapped to ROFF_de in roff_block(). */ + /* FALLTHROUGH */ + case ROFF_dei: + /* FALLTHROUGH */ + case ROFF_ig: + break; + default: + mandoc_msg(MANDOCERR_BLK_NOTOPEN, r->parse, + ln, ppos, ".."); + return(ROFF_IGN); + } + + if ((*bufp)[pos]) + mandoc_vmsg(MANDOCERR_ARG_SKIP, r->parse, ln, pos, + ".. %s", *bufp + pos); + + roffnode_pop(r); + roffnode_cleanscope(r); + return(ROFF_IGN); + +} + +static void +roffnode_cleanscope(struct roff *r) +{ + + while (r->last) { + if (--r->last->endspan != 0) + break; + roffnode_pop(r); + } +} + +static void +roff_ccond(struct roff *r, int ln, int ppos) +{ + + if (NULL == r->last) { + mandoc_msg(MANDOCERR_BLK_NOTOPEN, r->parse, + ln, ppos, "\\}"); + return; + } + + switch (r->last->tok) { + case ROFF_el: + /* FALLTHROUGH */ + case ROFF_ie: + /* FALLTHROUGH */ + case ROFF_if: + break; + default: + mandoc_msg(MANDOCERR_BLK_NOTOPEN, r->parse, + ln, ppos, "\\}"); + return; + } + + if (r->last->endspan > -1) { + mandoc_msg(MANDOCERR_BLK_NOTOPEN, r->parse, + ln, ppos, "\\}"); + return; + } + + roffnode_pop(r); + roffnode_cleanscope(r); + return; +} + +static enum rofferr +roff_block(ROFF_ARGS) +{ + const char *name; + char *iname, *cp; + size_t namesz; + + /* Ignore groff compatibility mode for now. */ + + if (ROFF_de1 == tok) + tok = ROFF_de; + else if (ROFF_am1 == tok) + tok = ROFF_am; + + /* Parse the macro name argument. */ + + cp = *bufp + pos; + if (ROFF_ig == tok) { + iname = NULL; + namesz = 0; + } else { + iname = cp; + namesz = roff_getname(r, &cp, ln, ppos); + iname[namesz] = '\0'; + } + + /* Resolve the macro name argument if it is indirect. */ + + if (namesz && (ROFF_dei == tok || ROFF_ami == tok)) { + if (NULL == (name = roff_getstrn(r, iname, namesz))) { + mandoc_vmsg(MANDOCERR_STR_UNDEF, + r->parse, ln, (int)(iname - *bufp), + "%.*s", (int)namesz, iname); + namesz = 0; + } else + namesz = strlen(name); + } else + name = iname; + + if (0 == namesz && ROFF_ig != tok) { + mandoc_msg(MANDOCERR_REQ_EMPTY, r->parse, + ln, ppos, roffs[tok].name); + return(ROFF_IGN); + } + + roffnode_push(r, tok, name, ln, ppos); + /* - * 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. + * At the beginning of a `de' macro, clear the existing string + * with the same name, if there is one. New content will be + * appended from roff_block_text() in multiline mode. */ - node = NULL; + if (ROFF_de == tok || ROFF_dei == tok) + roff_setstrn(&r->strtab, name, namesz, "", 0, 0); - if (ROFF_LAYOUT == tokens[tok].type && - ! (ROFF_NESTED & tokens[tok].flags)) { - for (node = tree->last; node; node = node->parent) { - if (node->tok == tok) + if ('\0' == *cp) + return(ROFF_IGN); + + /* Get the custom end marker. */ + + iname = cp; + namesz = roff_getname(r, &cp, ln, ppos); + + /* Resolve the end marker if it is indirect. */ + + if (namesz && (ROFF_dei == tok || ROFF_ami == tok)) { + if (NULL == (name = roff_getstrn(r, iname, namesz))) { + mandoc_vmsg(MANDOCERR_STR_UNDEF, + r->parse, ln, (int)(iname - *bufp), + "%.*s", (int)namesz, iname); + namesz = 0; + } else + namesz = strlen(name); + } else + name = iname; + + if (namesz) + r->last->end = mandoc_strndup(name, namesz); + + if ('\0' != *cp) + mandoc_vmsg(MANDOCERR_ARG_EXCESS, r->parse, + ln, pos, ".%s ... %s", roffs[tok].name, cp); + + return(ROFF_IGN); +} + +static enum rofferr +roff_block_sub(ROFF_ARGS) +{ + enum rofft t; + int i, j; + + /* + * 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. + */ + + if (r->last->end) { + for (i = pos, j = 0; r->last->end[j]; j++, i++) + if ((*bufp)[i] != r->last->end[j]) break; - /* Don't break nested scope. */ + if ('\0' == r->last->end[j] && + ('\0' == (*bufp)[i] || + ' ' == (*bufp)[i] || + '\t' == (*bufp)[i])) { + roffnode_pop(r); + roffnode_cleanscope(r); - 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); + while (' ' == (*bufp)[i] || '\t' == (*bufp)[i]) + i++; + + pos = i; + if (ROFF_MAX != roff_parse(r, *bufp, &pos, ln, ppos)) + return(ROFF_RERUN); + return(ROFF_IGN); } } - if (node) { - assert(ROFF_LAYOUT == tokens[tok].type); - assert( ! (ROFF_NESTED & tokens[tok].flags)); - assert(node->tok == tok); + /* + * If we have no custom end-query or lookup failed, then try + * pulling it out of the hashtable. + */ - /* Clear up to last scoped token. */ + t = roff_parse(r, *bufp, &pos, ln, ppos); - /* 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 (ROFF_cblock != t) { + if (ROFF_ig != tok) + roff_setstr(r, r->last->name, *bufp + ppos, 2); + return(ROFF_IGN); } - /* Proceed with actual token processing. */ + assert(roffs[t].proc); + return((*roffs[t].proc)(r, t, bufp, szp, ln, ppos, pos, offs)); +} - argvp = (const char **)&argv[1]; - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); +static enum rofferr +roff_block_text(ROFF_ARGS) +{ + + if (ROFF_ig != tok) + roff_setstr(r, r->last->name, *bufp + pos, 2); + + return(ROFF_IGN); } +static enum rofferr +roff_cond_sub(ROFF_ARGS) +{ + enum rofft t; + char *ep; + int rr; + rr = r->last->rule; + roffnode_cleanscope(r); + t = roff_parse(r, *bufp, &pos, ln, ppos); + + /* + * Fully handle known macros when they are structurally + * required or when the conditional evaluated to true. + */ + + if ((ROFF_MAX != t) && + (rr || ROFFMAC_STRUCT & roffs[t].flags)) { + assert(roffs[t].proc); + return((*roffs[t].proc)(r, t, bufp, szp, + ln, ppos, pos, offs)); + } + + /* + * If `\}' occurs on a macro line without a preceding macro, + * drop the line completely. + */ + + ep = *bufp + pos; + if ('\\' == ep[0] && '}' == ep[1]) + rr = 0; + + /* Always check for the closing delimiter `\}'. */ + + while (NULL != (ep = strchr(ep, '\\'))) { + if ('}' == *(++ep)) { + *ep = '&'; + roff_ccond(r, ln, ep - *bufp - 1); + } + ++ep; + } + return(rr ? ROFF_CONT : ROFF_IGN); +} + +static enum rofferr +roff_cond_text(ROFF_ARGS) +{ + char *ep; + int rr; + + rr = r->last->rule; + roffnode_cleanscope(r); + + ep = *bufp + pos; + while (NULL != (ep = strchr(ep, '\\'))) { + if ('}' == *(++ep)) { + *ep = '&'; + roff_ccond(r, ln, ep - *bufp - 1); + } + ++ep; + } + return(rr ? ROFF_CONT : ROFF_IGN); +} + +/* + * Parse a single signed integer number. Stop at the first non-digit. + * If there is at least one digit, return success and advance the + * parse point, else return failure and let the parse point unchanged. + * Ignore overflows, treat them just like the C language. + */ static int -rofffindarg(const char *name) +roff_getnum(const char *v, int *pos, int *res) { - size_t i; + int myres, n, p; - /* FIXME: use a table, this is slow but ok for now. */ + if (NULL == res) + res = &myres; - /* LINTED */ - for (i = 0; i < ROFF_ARGMAX; i++) - /* LINTED */ - if (0 == strcmp(name, tokargnames[i])) - return((int)i); - - return(ROFF_ARGMAX); + p = *pos; + n = v[p] == '-'; + if (n) + p++; + + for (*res = 0; isdigit((unsigned char)v[p]); p++) + *res = 10 * *res + v[p] - '0'; + if (p == *pos + n) + return 0; + + if (n) + *res = -*res; + + *pos = p; + return 1; } +/* + * Evaluate a string comparison condition. + * The first character is the delimiter. + * Succeed if the string up to its second occurrence + * matches the string up to its third occurence. + * Advance the cursor after the third occurrence + * or lacking that, to the end of the line. + */ +static int +roff_evalstrcond(const char *v, int *pos) +{ + const char *s1, *s2, *s3; + int match; + match = 0; + s1 = v + *pos; /* initial delimiter */ + s2 = s1 + 1; /* for scanning the first string */ + s3 = strchr(s2, *s1); /* for scanning the second string */ + + if (NULL == s3) /* found no middle delimiter */ + goto out; + + while ('\0' != *++s3) { + if (*s2 != *s3) { /* mismatch */ + s3 = strchr(s3, *s1); + break; + } + if (*s3 == *s1) { /* found the final delimiter */ + match = 1; + break; + } + s2++; + } + +out: + if (NULL == s3) + s3 = strchr(s2, '\0'); + else + s3++; + *pos = s3 - v; + return(match); +} + +/* + * Evaluate an optionally negated single character, numerical, + * or string condition. + */ static int -rofffindtok(const char *name) +roff_evalcond(struct roff *r, int ln, const char *v, int *pos) { - size_t i; + int wanttrue, number; - /* FIXME: use a table, this is slow but ok for now. */ + if ('!' == v[*pos]) { + wanttrue = 0; + (*pos)++; + } else + wanttrue = 1; - /* LINTED */ - for (i = 0; i < ROFF_MAX; i++) - /* LINTED */ - if (0 == strncmp(name, toknames[i], 2)) - return((int)i); - - return(ROFF_MAX); + switch (v[*pos]) { + case 'n': + /* FALLTHROUGH */ + case 'o': + (*pos)++; + return(wanttrue); + case 'c': + /* FALLTHROUGH */ + case 'd': + /* FALLTHROUGH */ + case 'e': + /* FALLTHROUGH */ + case 'r': + /* FALLTHROUGH */ + case 't': + (*pos)++; + return(!wanttrue); + default: + break; + } + + if (roff_evalnum(r, ln, v, pos, &number, 0)) + return((number > 0) == wanttrue); + else + return(roff_evalstrcond(v, pos) == wanttrue); } +static enum rofferr +roff_line_ignore(ROFF_ARGS) +{ + return(ROFF_IGN); +} + +static enum rofferr +roff_cond(ROFF_ARGS) +{ + + roffnode_push(r, tok, NULL, ln, ppos); + + /* + * An `.el' has no conditional body: it will consume the value + * of the current rstack entry set in prior `ie' calls or + * defaults to DENY. + * + * If we're not an `el', however, then evaluate the conditional. + */ + + r->last->rule = ROFF_el == tok ? + (r->rstackpos < 0 ? 0 : r->rstack[r->rstackpos--]) : + roff_evalcond(r, ln, *bufp, &pos); + + /* + * An if-else will put the NEGATION of the current evaluated + * conditional into the stack of rules. + */ + + if (ROFF_ie == tok) { + if (r->rstackpos + 1 == r->rstacksz) { + r->rstacksz += 16; + r->rstack = mandoc_reallocarray(r->rstack, + r->rstacksz, sizeof(int)); + } + r->rstack[++r->rstackpos] = !r->last->rule; + } + + /* If the parent has false as its rule, then so do we. */ + + if (r->last->parent && !r->last->parent->rule) + r->last->rule = 0; + + /* + * Determine scope. + * If there is nothing on the line after the conditional, + * not even whitespace, use next-line scope. + */ + + if ('\0' == (*bufp)[pos]) { + r->last->endspan = 2; + goto out; + } + + while (' ' == (*bufp)[pos]) + pos++; + + /* An opening brace requests multiline scope. */ + + if ('\\' == (*bufp)[pos] && '{' == (*bufp)[pos + 1]) { + r->last->endspan = -1; + pos += 2; + goto out; + } + + /* + * Anything else following the conditional causes + * single-line scope. Warn if the scope contains + * nothing but trailing whitespace. + */ + + if ('\0' == (*bufp)[pos]) + mandoc_msg(MANDOCERR_COND_EMPTY, r->parse, + ln, ppos, roffs[tok].name); + + r->last->endspan = 1; + +out: + *offs = pos; + return(ROFF_RERUN); +} + +static enum rofferr +roff_ds(ROFF_ARGS) +{ + char *string; + const char *name; + size_t namesz; + + /* + * The first word is the name of the string. + * If it is empty or terminated by an escape sequence, + * abort the `ds' request without defining anything. + */ + + name = string = *bufp + pos; + if ('\0' == *name) + return(ROFF_IGN); + + namesz = roff_getname(r, &string, ln, pos); + if ('\\' == name[namesz]) + return(ROFF_IGN); + + /* Read past the initial double-quote, if any. */ + if ('"' == *string) + string++; + + /* The rest is the value. */ + roff_setstrn(&r->strtab, name, namesz, string, strlen(string), + ROFF_as == tok); + return(ROFF_IGN); +} + +/* + * Parse a single operator, one or two characters long. + * If the operator is recognized, return success and advance the + * parse point, else return failure and let the parse point unchanged. + */ static int -rofffindcallable(const char *name) +roff_getop(const char *v, int *pos, char *res) { - int c; - if (ROFF_MAX == (c = rofffindtok(name))) - return(ROFF_MAX); - return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX); + *res = v[*pos]; + + switch (*res) { + case '+': + /* FALLTHROUGH */ + case '-': + /* FALLTHROUGH */ + case '*': + /* FALLTHROUGH */ + case '/': + /* FALLTHROUGH */ + case '%': + /* FALLTHROUGH */ + case '&': + /* FALLTHROUGH */ + case ':': + break; + case '<': + switch (v[*pos + 1]) { + case '=': + *res = 'l'; + (*pos)++; + break; + case '>': + *res = '!'; + (*pos)++; + break; + case '?': + *res = 'i'; + (*pos)++; + break; + default: + break; + } + break; + case '>': + switch (v[*pos + 1]) { + case '=': + *res = 'g'; + (*pos)++; + break; + case '?': + *res = 'a'; + (*pos)++; + break; + default: + break; + } + break; + case '=': + if ('=' == v[*pos + 1]) + (*pos)++; + break; + default: + return(0); + } + (*pos)++; + + return(*res); } +/* + * Evaluate either a parenthesized numeric expression + * or a single signed integer number. + */ +static int +roff_evalpar(struct roff *r, int ln, + const char *v, int *pos, int *res) +{ -static struct roffnode * -roffnode_new(int tokid, struct rofftree *tree) + if ('(' != v[*pos]) + return(roff_getnum(v, pos, res)); + + (*pos)++; + if ( ! roff_evalnum(r, ln, v, pos, res, 1)) + return(0); + + /* + * Omission of the closing parenthesis + * is an error in validation mode, + * but ignored in evaluation mode. + */ + + if (')' == v[*pos]) + (*pos)++; + else if (NULL == res) + return(0); + + return(1); +} + +/* + * Evaluate a complete numeric expression. + * Proceed left to right, there is no concept of precedence. + */ +static int +roff_evalnum(struct roff *r, int ln, const char *v, + int *pos, int *res, int skipwhite) { - struct roffnode *p; - - if (NULL == (p = malloc(sizeof(struct roffnode)))) { - warn("malloc"); - return(NULL); + int mypos, operand2; + char operator; + + if (NULL == pos) { + mypos = 0; + pos = &mypos; } - p->line = tree->rbuf->line; - p->tok = tokid; - p->parent = tree->last; - tree->last = p; - return(p); + if (skipwhite) + while (isspace((unsigned char)v[*pos])) + (*pos)++; + + if ( ! roff_evalpar(r, ln, v, pos, res)) + return(0); + + while (1) { + if (skipwhite) + while (isspace((unsigned char)v[*pos])) + (*pos)++; + + if ( ! roff_getop(v, pos, &operator)) + break; + + if (skipwhite) + while (isspace((unsigned char)v[*pos])) + (*pos)++; + + if ( ! roff_evalpar(r, ln, v, pos, &operand2)) + return(0); + + if (skipwhite) + while (isspace((unsigned char)v[*pos])) + (*pos)++; + + if (NULL == res) + continue; + + switch (operator) { + case '+': + *res += operand2; + break; + case '-': + *res -= operand2; + break; + case '*': + *res *= operand2; + break; + case '/': + if (0 == operand2) { + mandoc_msg(MANDOCERR_DIVZERO, + r->parse, ln, *pos, v); + *res = 0; + break; + } + *res /= operand2; + break; + case '%': + *res %= operand2; + break; + case '<': + *res = *res < operand2; + break; + case '>': + *res = *res > operand2; + break; + case 'l': + *res = *res <= operand2; + break; + case 'g': + *res = *res >= operand2; + break; + case '=': + *res = *res == operand2; + break; + case '!': + *res = *res != operand2; + break; + case '&': + *res = *res && operand2; + break; + case ':': + *res = *res || operand2; + break; + case 'i': + if (operand2 < *res) + *res = operand2; + break; + case 'a': + if (operand2 > *res) + *res = operand2; + break; + default: + abort(); + } + } + return(1); } +void +roff_setreg(struct roff *r, const char *name, int val, char sign) +{ + struct roffreg *reg; + /* Search for an existing register with the same name. */ + reg = r->regtab; + + while (reg && strcmp(name, reg->key.p)) + reg = reg->next; + + if (NULL == reg) { + /* Create a new register. */ + reg = mandoc_malloc(sizeof(struct roffreg)); + reg->key.p = mandoc_strdup(name); + reg->key.sz = strlen(name); + reg->val = 0; + reg->next = r->regtab; + r->regtab = reg; + } + + if ('+' == sign) + reg->val += val; + else if ('-' == sign) + reg->val -= val; + else + reg->val = val; +} + +/* + * Handle some predefined read-only number registers. + * For now, return -1 if the requested register is not predefined; + * in case a predefined read-only register having the value -1 + * were to turn up, another special value would have to be chosen. + */ static int -roffargok(int tokid, int argid) +roff_getregro(const char *name) { - const int *c; - if (NULL == (c = tokens[tokid].args)) + switch (*name) { + case 'A': /* ASCII approximation mode is always off. */ return(0); + case 'g': /* Groff compatibility mode is always on. */ + return(1); + case 'H': /* Fixed horizontal resolution. */ + return (24); + case 'j': /* Always adjust left margin only. */ + return(0); + case 'T': /* Some output device is always defined. */ + return(1); + case 'V': /* Fixed vertical resolution. */ + return (40); + default: + return (-1); + } +} - for ( ; ROFF_ARGMAX != *c; c++) - if (argid == *c) - return(1); +int +roff_getreg(const struct roff *r, const char *name) +{ + struct roffreg *reg; + int val; + if ('.' == name[0] && '\0' != name[1] && '\0' == name[2]) { + val = roff_getregro(name + 1); + if (-1 != val) + return (val); + } + + for (reg = r->regtab; reg; reg = reg->next) + if (0 == strcmp(name, reg->key.p)) + return(reg->val); + return(0); } +static int +roff_getregn(const struct roff *r, const char *name, size_t len) +{ + struct roffreg *reg; + int val; + if ('.' == name[0] && 2 == len) { + val = roff_getregro(name + 1); + if (-1 != val) + return (val); + } + + for (reg = r->regtab; reg; reg = reg->next) + if (len == reg->key.sz && + 0 == strncmp(name, reg->key.p, len)) + return(reg->val); + + return(0); +} + static void -roffnode_free(int tokid, struct rofftree *tree) +roff_freereg(struct roffreg *reg) { - struct roffnode *p; + struct roffreg *old_reg; - assert(tree->last); - assert(tree->last->tok == tokid); - - p = tree->last; - tree->last = tree->last->parent; - free(p); + while (NULL != reg) { + free(reg->key.p); + old_reg = reg; + reg = reg->next; + free(old_reg); + } } +static enum rofferr +roff_nr(ROFF_ARGS) +{ + char *key, *val; + size_t keysz; + int iv; + char sign; -/* ARGSUSED */ -static int -roff_Dd(ROFFCALL_ARGS) + key = val = *bufp + pos; + if ('\0' == *key) + return(ROFF_IGN); + + keysz = roff_getname(r, &val, ln, pos); + if ('\\' == key[keysz]) + return(ROFF_IGN); + key[keysz] = '\0'; + + sign = *val; + if ('+' == sign || '-' == sign) + val++; + + if (roff_evalnum(r, ln, val, NULL, &iv, 0)) + roff_setreg(r, key, iv, sign); + + return(ROFF_IGN); +} + +static enum rofferr +roff_rr(ROFF_ARGS) { + struct roffreg *reg, **prev; + char *name, *cp; + size_t namesz; - if (ROFF_BODY & tree->state) { - assert( ! (ROFF_PRELUDE & tree->state)); - assert(ROFF_PRELUDE_Dd & tree->state); - return(roff_text(tok, tree, argv, type)); + name = cp = *bufp + pos; + if ('\0' == *name) + return(ROFF_IGN); + namesz = roff_getname(r, &cp, ln, pos); + name[namesz] = '\0'; + + prev = &r->regtab; + while (1) { + reg = *prev; + if (NULL == reg || !strcmp(name, reg->key.p)) + break; + prev = ®->next; } + if (NULL != reg) { + *prev = reg->next; + free(reg->key.p); + free(reg); + } + return(ROFF_IGN); +} - assert(ROFF_PRELUDE & tree->state); - assert( ! (ROFF_BODY & tree->state)); +static enum rofferr +roff_rm(ROFF_ARGS) +{ + const char *name; + char *cp; + size_t namesz; - 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); + cp = *bufp + pos; + while ('\0' != *cp) { + name = cp; + namesz = roff_getname(r, &cp, ln, (int)(cp - *bufp)); + roff_setstrn(&r->strtab, name, namesz, NULL, 0, 0); + if ('\\' == name[namesz]) + break; } + return(ROFF_IGN); +} - /* TODO: parse date. */ +static enum rofferr +roff_it(ROFF_ARGS) +{ + char *cp; + size_t len; + int iv; - assert(NULL == tree->last); - tree->state |= ROFF_PRELUDE_Dd; + /* Parse the number of lines. */ + cp = *bufp + pos; + len = strcspn(cp, " \t"); + cp[len] = '\0'; + if ((iv = mandoc_strntoi(cp, len, 10)) <= 0) { + mandoc_msg(MANDOCERR_IT_NONUM, r->parse, + ln, ppos, *bufp + 1); + return(ROFF_IGN); + } + cp += len + 1; - return(1); + /* Arm the input line trap. */ + roffit_lines = iv; + roffit_macro = mandoc_strdup(cp); + return(ROFF_IGN); } +static enum rofferr +roff_Dd(ROFF_ARGS) +{ + const char *const *cp; -/* ARGSUSED */ -static int -roff_Dt(ROFFCALL_ARGS) + if ((r->options & (MPARSE_MDOC | MPARSE_QUICK)) == 0) + for (cp = __mdoc_reserved; *cp; cp++) + roff_setstr(r, *cp, NULL, 0); + + if (r->format == 0) + r->format = MPARSE_MDOC; + + return(ROFF_CONT); +} + +static enum rofferr +roff_TH(ROFF_ARGS) { + const char *const *cp; - 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->options & MPARSE_QUICK) == 0) + for (cp = __man_reserved; *cp; cp++) + roff_setstr(r, *cp, NULL, 0); - assert(ROFF_PRELUDE & tree->state); - assert( ! (ROFF_BODY & tree->state)); + if (r->format == 0) + r->format = MPARSE_MAN; - 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); - } + return(ROFF_CONT); +} - /* TODO: parse date. */ +static enum rofferr +roff_TE(ROFF_ARGS) +{ - assert(NULL == tree->last); - tree->state |= ROFF_PRELUDE_Dt; + if (NULL == r->tbl) + mandoc_msg(MANDOCERR_BLK_NOTOPEN, r->parse, + ln, ppos, "TE"); + else + tbl_end(&r->tbl); - return(1); + return(ROFF_IGN); } +static enum rofferr +roff_T_(ROFF_ARGS) +{ -/* ARGSUSED */ -static int -roff_Os(ROFFCALL_ARGS) + if (NULL == r->tbl) + mandoc_msg(MANDOCERR_BLK_NOTOPEN, r->parse, + ln, ppos, "T&"); + else + tbl_restart(ppos, ln, r->tbl); + + return(ROFF_IGN); +} + +/* + * Handle in-line equation delimiters. + */ +static enum rofferr +roff_eqndelim(struct roff *r, char **bufp, size_t *szp, int pos) { + char *cp1, *cp2; + const char *bef_pr, *bef_nl, *mac, *aft_nl, *aft_pr; - 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)); + /* + * Outside equations, look for an opening delimiter. + * If we are inside an equation, we already know it is + * in-line, or this function wouldn't have been called; + * so look for a closing delimiter. + */ + + cp1 = *bufp + pos; + cp2 = strchr(cp1, r->eqn == NULL ? + r->last_eqn->odelim : r->last_eqn->cdelim); + if (cp2 == NULL) + return(ROFF_CONT); + + *cp2++ = '\0'; + bef_pr = bef_nl = aft_nl = aft_pr = ""; + + /* Handle preceding text, protecting whitespace. */ + + if (**bufp != '\0') { + if (r->eqn == NULL) + bef_pr = "\\&"; + bef_nl = "\n"; } - 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); + /* + * Prepare replacing the delimiter with an equation macro + * and drop leading white space from the equation. + */ + + if (r->eqn == NULL) { + while (*cp2 == ' ') + cp2++; + mac = ".EQ"; + } else + mac = ".EN"; + + /* Handle following text, protecting whitespace. */ + + if (*cp2 != '\0') { + aft_nl = "\n"; + if (r->eqn != NULL) + aft_pr = "\\&"; } - /* TODO: extract OS. */ + /* Do the actual replacement. */ - tree->state |= ROFF_PRELUDE_Os; - tree->state &= ~ROFF_PRELUDE; - tree->state |= ROFF_BODY; + *szp = mandoc_asprintf(&cp1, "%s%s%s%s%s%s%s", *bufp, + bef_pr, bef_nl, mac, aft_nl, aft_pr, cp2) + 1; + free(*bufp); + *bufp = cp1; - assert(NULL == tree->last); + /* Toggle the in-line state of the eqn subsystem. */ - return(roff_layout(tok, tree, argv, type)); + r->eqn_inline = r->eqn == NULL; + return(ROFF_REPARSE); } - -/* ARGUSED */ -static int -roffnextopt(int tok, const char ***in, char **val) +static void +roff_openeqn(struct roff *r, const char *name, int line, + int offs, const char *buf) { - const char *arg, **argv; - int v; + struct eqn_node *e; + int poff; - *val = NULL; - argv = *in; - assert(argv); + assert(NULL == r->eqn); + e = eqn_alloc(name, offs, line, r->parse); - if (NULL == (arg = *argv)) - return(-1); - if ('-' != *arg) - return(-1); + if (r->last_eqn) { + r->last_eqn->next = e; + e->delim = r->last_eqn->delim; + e->odelim = r->last_eqn->odelim; + e->cdelim = r->last_eqn->cdelim; + } else + r->first_eqn = r->last_eqn = e; - /* FIXME: should we let this slide... ? */ + r->eqn = r->last_eqn = e; - if (ROFF_ARGMAX == (v = rofffindarg(&arg[1]))) - return(-1); + if (buf) { + poff = 0; + eqn_read(&r->eqn, line, buf, offs, &poff); + } +} - /* FIXME: should we let this slide... ? */ +static enum rofferr +roff_EQ(ROFF_ARGS) +{ - if ( ! roffargok(tok, v)) - return(-1); - if ( ! (ROFF_VALUE & tokenargs[v].flags)) - return(v); + roff_openeqn(r, *bufp + pos, ln, ppos, NULL); + return(ROFF_IGN); +} - *in = ++argv; +static enum rofferr +roff_EN(ROFF_ARGS) +{ - /* FIXME: what if this looks like a roff token or argument? */ + mandoc_msg(MANDOCERR_BLK_NOTOPEN, r->parse, ln, ppos, "EN"); + return(ROFF_IGN); +} - return(*argv ? v : ROFF_ARGMAX); +static enum rofferr +roff_TS(ROFF_ARGS) +{ + struct tbl_node *tbl; + + if (r->tbl) { + mandoc_msg(MANDOCERR_BLK_BROKEN, r->parse, + ln, ppos, "TS breaks TS"); + tbl_end(&r->tbl); + } + + tbl = tbl_alloc(ppos, ln, r->parse); + + if (r->last_tbl) + r->last_tbl->next = tbl; + else + r->first_tbl = r->last_tbl = tbl; + + r->tbl = r->last_tbl = tbl; + return(ROFF_IGN); } +static enum rofferr +roff_cc(ROFF_ARGS) +{ + const char *p; -/* ARGSUSED */ -static int -roff_layout(ROFFCALL_ARGS) + p = *bufp + pos; + + if ('\0' == *p || '.' == (r->control = *p++)) + r->control = 0; + + if ('\0' != *p) + mandoc_msg(MANDOCERR_ARGCOUNT, r->parse, ln, ppos, NULL); + + return(ROFF_IGN); +} + +static enum rofferr +roff_tr(ROFF_ARGS) { - int i, c, argcp[ROFF_MAXARG]; - char *v, *argvp[ROFF_MAXARG]; + const char *p, *first, *second; + size_t fsz, ssz; + enum mandoc_esc esc; - if (ROFF_PRELUDE & tree->state) { - warnx("%s: macro `%s' called in prelude (line %zu)", - tree->rbuf->name, - toknames[tok], - tree->rbuf->line); - return(0); + p = *bufp + pos; + + if ('\0' == *p) { + mandoc_msg(MANDOCERR_ARGCOUNT, r->parse, ln, ppos, NULL); + return(ROFF_IGN); } - if (ROFF_EXIT == type) { - roffnode_free(tok, tree); - return((*tree->roffblkout)(tok)); - } + while ('\0' != *p) { + fsz = ssz = 1; - i = 0; + first = p++; + if ('\\' == *first) { + esc = mandoc_escape(&p, NULL, NULL); + if (ESCAPE_ERROR == esc) { + mandoc_msg(MANDOCERR_ESC_BAD, r->parse, + ln, (int)(p - *bufp), first); + return(ROFF_IGN); + } + fsz = (size_t)(p - first); + } - 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); + second = p++; + if ('\\' == *second) { + esc = mandoc_escape(&p, NULL, NULL); + if (ESCAPE_ERROR == esc) { + mandoc_msg(MANDOCERR_ESC_BAD, r->parse, + ln, (int)(p - *bufp), second); + return(ROFF_IGN); + } + ssz = (size_t)(p - second); + } else if ('\0' == *second) { + mandoc_msg(MANDOCERR_ARGCOUNT, r->parse, + ln, (int)(p - *bufp), NULL); + second = " "; + p--; } - argcp[i] = c; - argvp[i] = v; - i++; - argv++; + + if (fsz > 1) { + roff_setstrn(&r->xmbtab, first, fsz, + second, ssz, 0); + continue; + } + + if (NULL == r->xtab) + r->xtab = mandoc_calloc(128, + sizeof(struct roffstr)); + + free(r->xtab[(int)*first].p); + r->xtab[(int)*first].p = mandoc_strndup(second, ssz); + r->xtab[(int)*first].sz = ssz; } - argcp[i] = ROFF_ARGMAX; - argvp[i] = NULL; + return(ROFF_IGN); +} - if (NULL == roffnode_new(tok, tree)) - return(0); +static enum rofferr +roff_so(ROFF_ARGS) +{ + char *name; - if ( ! (*tree->roffin)(tok, argcp, argvp)) - return(0); + name = *bufp + pos; + mandoc_vmsg(MANDOCERR_SO, r->parse, ln, ppos, "so %s", name); - if ( ! (ROFF_PARSED & tokens[tok].flags)) { - /* TODO: print all tokens. */ + /* + * Handle `so'. Be EXTREMELY careful, as we shouldn't be + * opening anything that's not in our cwd or anything beneath + * it. Thus, explicitly disallow traversing up the file-system + * or using absolute paths. + */ - if ( ! ((*tree->roffout)(tok))) - return(0); - return((*tree->roffblkin)(tok)); + if ('/' == *name || strstr(name, "../") || strstr(name, "/..")) { + mandoc_vmsg(MANDOCERR_SO_PATH, r->parse, ln, ppos, + ".so %s", name); + 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); + *offs = pos; + return(ROFF_SO); +} - /* TODO: print token. */ - argv++; +static enum rofferr +roff_userdef(ROFF_ARGS) +{ + const char *arg[9]; + char *cp, *n1, *n2; + int i; + + /* + * Collect pointers to macro argument strings + * and NUL-terminate them. + */ + cp = *bufp + pos; + for (i = 0; i < 9; i++) + arg[i] = '\0' == *cp ? "" : + mandoc_getarg(r->parse, &cp, ln, &pos); + + /* + * Expand macro arguments. + */ + *szp = 0; + n1 = cp = mandoc_strdup(r->current_string); + while (NULL != (cp = strstr(cp, "\\$"))) { + i = cp[2] - '1'; + if (0 > i || 8 < i) { + /* Not an argument invocation. */ + cp += 2; + continue; + } + *cp = '\0'; + *szp = mandoc_asprintf(&n2, "%s%s%s", + n1, arg[i], cp + 3) + 1; + cp = n2 + (cp - n1); + free(n1); + n1 = n2; } - if ( ! ((*tree->roffout)(tok))) + /* + * Replace the macro invocation + * by the expanded macro. + */ + free(*bufp); + *bufp = n1; + if (0 == *szp) + *szp = strlen(*bufp) + 1; + + return(*szp > 1 && '\n' == (*bufp)[(int)*szp - 2] ? + ROFF_REPARSE : ROFF_APPEND); +} + +static size_t +roff_getname(struct roff *r, char **cpp, int ln, int pos) +{ + char *name, *cp; + size_t namesz; + + name = *cpp; + if ('\0' == *name) return(0); - return((*tree->roffblkin)(tok)); + /* Read until end of name and terminate it with NUL. */ + for (cp = name; 1; cp++) { + if ('\0' == *cp || ' ' == *cp) { + namesz = cp - name; + break; + } + if ('\\' != *cp) + continue; + namesz = cp - name; + if ('{' == cp[1] || '}' == cp[1]) + break; + cp++; + if ('\\' == *cp) + continue; + mandoc_vmsg(MANDOCERR_NAMESC, r->parse, ln, pos, + "%.*s", (int)(cp - name + 1), name); + mandoc_escape((const char **)&cp, NULL, NULL); + break; + } + + /* Read past spaces. */ + while (' ' == *cp) + cp++; + + *cpp = cp; + return(namesz); } +/* + * Store *string into the user-defined string called *name. + * To clear an existing entry, call with (*r, *name, NULL, 0). + * append == 0: replace mode + * append == 1: single-line append mode + * append == 2: multiline append mode, append '\n' after each call + */ +static void +roff_setstr(struct roff *r, const char *name, const char *string, + int append) +{ -/* ARGSUSED */ -static int -roff_text(ROFFCALL_ARGS) + roff_setstrn(&r->strtab, name, strlen(name), string, + string ? strlen(string) : 0, append); +} + +static void +roff_setstrn(struct roffkv **r, const char *name, size_t namesz, + const char *string, size_t stringsz, int append) { - int i, c, argcp[ROFF_MAXARG]; - char *v, *argvp[ROFF_MAXARG]; + struct roffkv *n; + char *c; + int i; + size_t oldch, newch; - if (ROFF_PRELUDE & tree->state) { - warnx("%s: macro `%s' called in prelude (line %zu)", - tree->rbuf->name, - toknames[tok], - tree->rbuf->line); - return(0); + /* Search for an existing string with the same name. */ + n = *r; + + while (n && (namesz != n->key.sz || + strncmp(n->key.p, name, namesz))) + n = n->next; + + if (NULL == n) { + /* Create a new string table entry. */ + n = mandoc_malloc(sizeof(struct roffkv)); + n->key.p = mandoc_strndup(name, namesz); + n->key.sz = namesz; + n->val.p = NULL; + n->val.sz = 0; + n->next = *r; + *r = n; + } else if (0 == append) { + free(n->val.p); + n->val.p = NULL; + n->val.sz = 0; } - i = 0; + if (NULL == string) + return; - 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++; + /* + * One additional byte for the '\n' in multiline mode, + * and one for the terminating '\0'. + */ + newch = stringsz + (1 < append ? 2u : 1u); + + if (NULL == n->val.p) { + n->val.p = mandoc_malloc(newch); + *n->val.p = '\0'; + oldch = 0; + } else { + oldch = n->val.sz; + n->val.p = mandoc_realloc(n->val.p, oldch + newch); } - argcp[i] = ROFF_ARGMAX; - argvp[i] = NULL; + /* Skip existing content in the destination buffer. */ + c = n->val.p + (int)oldch; - if ( ! (*tree->roffin)(tok, argcp, argvp)) - return(0); + /* Append new content to the destination buffer. */ + i = 0; + while (i < (int)stringsz) { + /* + * Rudimentary roff copy mode: + * Handle escaped backslashes. + */ + if ('\\' == string[i] && '\\' == string[i + 1]) + i++; + *c++ = string[i++]; + } - if ( ! (ROFF_PARSED & tokens[tok].flags)) { - /* TODO: print all tokens. */ - return((*tree->roffout)(tok)); + /* Append terminating bytes. */ + if (1 < append) + *c++ = '\n'; + + *c = '\0'; + n->val.sz = (int)(c - n->val.p); +} + +static const char * +roff_getstrn(const struct roff *r, const char *name, size_t len) +{ + const struct roffkv *n; + int i; + + for (n = r->strtab; n; n = n->next) + if (0 == strncmp(name, n->key.p, len) && + '\0' == n->key.p[(int)len]) + return(n->val.p); + + for (i = 0; i < PREDEFS_MAX; i++) + if (0 == strncmp(name, predefs[i].name, len) && + '\0' == predefs[i].name[(int)len]) + return(predefs[i].str); + + return(NULL); +} + +static void +roff_freestr(struct roffkv *r) +{ + struct roffkv *n, *nn; + + for (n = r; n; n = nn) { + free(n->key.p); + free(n->val.p); + nn = n->next; + free(n); } +} - while (*argv) { - if (2 >= strlen(*argv) && ROFF_MAX != - (c = rofffindcallable(*argv))) - if ( ! (*tokens[c].cb)(c, tree, - argv + 1, ROFF_ENTER)) - return(0); +const struct tbl_span * +roff_span(const struct roff *r) +{ - /* TODO: print token. */ - argv++; + return(r->tbl ? tbl_span(r->tbl) : NULL); +} + +const struct eqn * +roff_eqn(const struct roff *r) +{ + + return(r->last_eqn ? &r->last_eqn->eqn : NULL); +} + +/* + * Duplicate an input string, making the appropriate character + * conversations (as stipulated by `tr') along the way. + * Returns a heap-allocated string with all the replacements made. + */ +char * +roff_strdup(const struct roff *r, const char *p) +{ + const struct roffkv *cp; + char *res; + const char *pp; + size_t ssz, sz; + enum mandoc_esc esc; + + if (NULL == r->xmbtab && NULL == r->xtab) + return(mandoc_strdup(p)); + else if ('\0' == *p) + return(mandoc_strdup("")); + + /* + * Step through each character looking for term matches + * (remember that a `tr' can be invoked with an escape, which is + * a glyph but the escape is multi-character). + * We only do this if the character hash has been initialised + * and the string is >0 length. + */ + + res = NULL; + ssz = 0; + + while ('\0' != *p) { + if ('\\' != *p && r->xtab && r->xtab[(int)*p].p) { + sz = r->xtab[(int)*p].sz; + res = mandoc_realloc(res, ssz + sz + 1); + memcpy(res + ssz, r->xtab[(int)*p].p, sz); + ssz += sz; + p++; + continue; + } else if ('\\' != *p) { + res = mandoc_realloc(res, ssz + 2); + res[ssz++] = *p++; + continue; + } + + /* Search for term matches. */ + for (cp = r->xmbtab; cp; cp = cp->next) + if (0 == strncmp(p, cp->key.p, cp->key.sz)) + break; + + if (NULL != cp) { + /* + * A match has been found. + * Append the match to the array and move + * forward by its keysize. + */ + res = mandoc_realloc(res, + ssz + cp->val.sz + 1); + memcpy(res + ssz, cp->val.p, cp->val.sz); + ssz += cp->val.sz; + p += (int)cp->key.sz; + continue; + } + + /* + * Handle escapes carefully: we need to copy + * over just the escape itself, or else we might + * do replacements within the escape itself. + * Make sure to pass along the bogus string. + */ + pp = p++; + esc = mandoc_escape(&p, NULL, NULL); + if (ESCAPE_ERROR == esc) { + sz = strlen(pp); + res = mandoc_realloc(res, ssz + sz + 1); + memcpy(res + ssz, pp, sz); + break; + } + /* + * We bail out on bad escapes. + * No need to warn: we already did so when + * roff_res() was called. + */ + sz = (int)(p - pp); + res = mandoc_realloc(res, ssz + sz + 1); + memcpy(res + ssz, pp, sz); + ssz += sz; } - return((*tree->roffout)(tok)); + res[(int)ssz] = '\0'; + return(res); +} + +int +roff_getformat(const struct roff *r) +{ + + return(r->format); +} + +/* + * Find out whether a line is a macro line or not. + * If it is, adjust the current position and return one; if it isn't, + * return zero and don't change the current position. + * If the control character has been set with `.cc', then let that grain + * precedence. + * This is slighly contrary to groff, where using the non-breaking + * control character when `cc' has been invoked will cause the + * non-breaking macro contents to be printed verbatim. + */ +int +roff_getcontrol(const struct roff *r, const char *cp, int *ppos) +{ + int pos; + + pos = *ppos; + + if (0 != r->control && cp[pos] == r->control) + pos++; + else if (0 != r->control) + return(0); + else if ('\\' == cp[pos] && '.' == cp[pos + 1]) + pos += 2; + else if ('.' == cp[pos] || '\'' == cp[pos]) + pos++; + else + return(0); + + while (' ' == cp[pos] || '\t' == cp[pos]) + pos++; + + *ppos = pos; + return(1); }