=================================================================== RCS file: /cvs/mandoc/roff.c,v retrieving revision 1.7 retrieving revision 1.52 diff -u -p -r1.7 -r1.52 --- mandoc/roff.c 2008/11/26 21:42:59 1.7 +++ mandoc/roff.c 2008/12/08 16:29:57 1.52 @@ -1,4 +1,4 @@ -/* $Id: roff.c,v 1.7 2008/11/26 21:42:59 kristaps Exp $ */ +/* $Id: roff.c,v 1.52 2008/12/08 16:29:57 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -16,9 +16,13 @@ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ +#include +#include + #include #include #include +#include #include #include #include @@ -26,551 +30,285 @@ #include "libmdocml.h" #include "private.h" +#include "roff.h" -/* FIXME: warn if Pp occurs before/after Sh etc. (see mdoc.samples). */ +/* FIXME: First letters of quoted-text interpreted in rofffindtok. */ +/* FIXME: `No' not implemented. */ +/* TODO: warn if Pp occurs before/after Sh etc. (see mdoc.samples). */ +/* TODO: warn about empty lists. */ +/* TODO: (warn) some sections need specific elements. */ +/* TODO: (warn) NAME section has particular order. */ +/* TODO: unify empty-content tags a la
. */ +/* TODO: macros with a set number of arguments? */ +/* TODO: validate Dt macro arguments. */ +/* FIXME: Bl -diag supposed to ignore callable children. */ +/* FIXME: Nm has newline when used in NAME section. */ -/* FIXME: warn about "X section only" macros. */ - -/* FIXME: warn about empty lists. */ - -/* FIXME: ; : } ) (etc.) after text macros? */ - -#define ROFF_MAXARG 10 - -enum roffd { - ROFF_ENTER = 0, - ROFF_EXIT -}; - -enum rofftype { - ROFF_COMMENT, - ROFF_TEXT, - ROFF_LAYOUT -}; - -#define ROFFCALL_ARGS \ - int tok, struct rofftree *tree, \ - const char *argv[], enum roffd type - -struct rofftree; - -struct rofftok { - int (*cb)(ROFFCALL_ARGS); /* Callback. */ - const int *args; /* Args (or NULL). */ - const int *parents; - const int *children; - int ctx; - enum rofftype type; /* Type of macro. */ - int flags; -#define ROFF_PARSED (1 << 0) /* "Parsed". */ -#define ROFF_CALLABLE (1 << 1) /* "Callable". */ -#define ROFF_QUOTES (1 << 2) /* Quoted args. */ -}; - -struct roffarg { - int flags; -#define ROFF_VALUE (1 << 0) /* Has a value. */ -}; - struct roffnode { int tok; /* Token id. */ struct roffnode *parent; /* Parent (or NULL). */ - size_t line; /* Parsed at line. */ }; struct rofftree { struct roffnode *last; /* Last parsed node. */ - time_t date; /* `Dd' results. */ + char *cur; /* Line start. */ + struct tm tm; /* `Dd' results. */ + char name[64]; /* `Nm' results. */ char os[64]; /* `Os' results. */ char title[64]; /* `Dt' results. */ - char section[64]; /* `Dt' results. */ + enum roffmsec section; 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. */ - struct md_mbuf *mbuf; /* Output (or NULL). */ - const struct md_args *args; /* Global args. */ - const struct md_rbuf *rbuf; /* Input. */ - const struct roffcb *cb; + struct roffcb cb; /* Callbacks. */ + void *arg; /* Callbacks' arg. */ + int csec; /* Current section. */ + int asec; /* Thus-far sections. */ }; -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 int roff_comment(ROFFCALL_ARGS); - static struct roffnode *roffnode_new(int, struct rofftree *); -static void roffnode_free(int, struct rofftree *); - +static void roffnode_free(struct rofftree *); +static void roff_warn(const struct rofftree *, + const char *, char *, ...); +static void roff_err(const struct rofftree *, + const char *, char *, ...); +static int roffpurgepunct(struct rofftree *, char **); static int roffscan(int, const int *); static int rofffindtok(const char *); static int rofffindarg(const char *); static int rofffindcallable(const char *); -static int roffargs(int, char *, char **); +static int roffismsec(const char *); +static int roffissec(const char **); +static int roffispunct(const char *); +static int roffchecksec(struct rofftree *, + const char *, int); +static int roffargs(const struct rofftree *, + 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); +static int roffnextopt(const struct rofftree *, + int, char ***, char **); +static int roffparseopts(struct rofftree *, int, + char ***, int *, char **); +static int roffcall(struct rofftree *, int, char **); +static int roffexit(struct rofftree *, int); +static int roffparse(struct rofftree *, char *); +static int textparse(struct rofftree *, char *); +static int roffdata(struct rofftree *, int, char *); +static int roffspecial(struct rofftree *, int, + const char *, const int *, + const char **, size_t, char **); +static int roffsetname(struct rofftree *, char **); +#ifdef __linux__ +extern size_t strlcat(char *, const char *, size_t); +extern size_t strlcpy(char *, const char *, size_t); +extern int vsnprintf(char *, size_t, + const char *, va_list); +extern char *strptime(const char *, const char *, + struct tm *); +#endif -static const int roffarg_An[] = { ROFF_Split, ROFF_Nosplit, - ROFF_ARGMAX }; -static const int roffarg_Bd[] = { ROFF_Ragged, ROFF_Unfilled, - ROFF_Literal, ROFF_File, ROFF_Offset, ROFF_ARGMAX }; -static const int roffarg_Ex[] = { ROFF_Std, ROFF_ARGMAX }; -static const int roffarg_Rv[] = { ROFF_Std, ROFF_ARGMAX }; -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 }; -static const int roffarg_St[] = { - ROFF_p1003_1_88, ROFF_p1003_1_90, ROFF_p1003_1_96, - ROFF_p1003_1_2001, ROFF_p1003_1_2004, ROFF_p1003_1, - ROFF_p1003_1b, ROFF_p1003_1b_93, ROFF_p1003_1c_95, - ROFF_p1003_1g_2000, ROFF_p1003_2_92, ROFF_p1387_2_95, - ROFF_p1003_2, ROFF_p1387_2, ROFF_isoC_90, ROFF_isoC_amd1, - ROFF_isoC_tcor1, ROFF_isoC_tcor2, ROFF_isoC_99, ROFF_ansiC, - ROFF_ansiC_89, ROFF_ansiC_99, ROFF_ieee754, ROFF_iso8802_3, - ROFF_xpg3, ROFF_xpg4, ROFF_xpg4_2, ROFF_xpg4_3, ROFF_xbd5, - ROFF_xcu5, ROFF_xsh5, ROFF_xns5, ROFF_xns5_2d2_0, - ROFF_xcurses4_2, ROFF_susv2, ROFF_susv3, ROFF_svid4, - ROFF_ARGMAX }; +int +roff_free(struct rofftree *tree, int flush) +{ + int error, t; + struct roffnode *n; -static const int roffchild_Oo[] = { ROFF_Op, ROFF_Oc, ROFF_MAX }; -static const int roffchild_Bl[] = { ROFF_It, ROFF_El, ROFF_MAX }; -static const int roffchild_Fo[] = { ROFF_Fa, ROFF_Fc, ROFF_MAX }; + error = 0; -static const int roffparent_El[] = { ROFF_Bl, ROFF_It, ROFF_MAX }; -static const int roffparent_Fc[] = { ROFF_Fo, ROFF_Fa, ROFF_MAX }; -static const int roffparent_Oc[] = { ROFF_Oo, ROFF_Oc, ROFF_MAX }; -static const int roffparent_It[] = { ROFF_Bl, ROFF_MAX }; + if ( ! flush) + goto end; -/* Table of all known tokens. */ -static const struct rofftok tokens[ROFF_MAX] = { - {roff_comment, NULL, NULL, NULL, 0, ROFF_COMMENT, 0 }, /* \" */ - { roff_Dd, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Dd */ - { roff_Dt, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Dt */ - { roff_Os, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Os */ - { roff_layout, NULL, NULL, NULL, ROFF_Sh, ROFF_LAYOUT, ROFF_PARSED }, /* Sh */ - { roff_layout, NULL, NULL, NULL, ROFF_Ss, ROFF_LAYOUT, ROFF_PARSED }, /* Ss */ - { roff_text, NULL, NULL, NULL, ROFF_Pp, ROFF_TEXT, 0 }, /* Pp */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* D1 */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Dl */ - { NULL, NULL, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Bd */ - { NULL, NULL, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Ed */ - { roff_layout, roffarg_Bl, NULL, roffchild_Bl, 0, ROFF_LAYOUT, 0 }, /* Bl */ - { roff_layout, NULL, roffparent_El, NULL, ROFF_Bl, ROFF_LAYOUT, 0 }, /* El */ - { roff_layout, NULL, roffparent_It, NULL, ROFF_It, ROFF_LAYOUT, 0 }, /* It */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ad */ - { roff_text, roffarg_An, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* An */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ar */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_QUOTES }, /* Cd */ /* XXX man.4 only */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Cm */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dv */ /* XXX needs arg */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Er */ /* XXX needs arg */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ev */ /* XXX needs arg */ - { roff_text, roffarg_Ex, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Ex */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fa */ /* XXX needs arg */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Fd */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fl */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Fn */ /* XXX needs arg */ /* FIXME */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ft */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ic */ /* XXX needs arg */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* In */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Li */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Nd */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Nm */ /* FIXME */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Op */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ot */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pa */ - { roff_text, roffarg_Rv, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Rv */ - { roff_text, roffarg_St, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* St */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Va */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Vt */ /* XXX needs arg */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xr */ /* XXX needs arg */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %A */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %B */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %D */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %I */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE}, /* %J */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %N */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %O */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %P */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %R */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* %T */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* %V */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ac */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ao */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Aq */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* At */ /* XXX at most 2 args */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bc */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Bf */ /* FIXME */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bo */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Bq */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bsx */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Bx */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Db */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dc */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Do */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Dq */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ec */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Ef */ /* FIXME */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Em */ /* XXX needs arg */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Eo */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Fx */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ms */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* No */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ns */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Nx */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ox */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pc */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Pf */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Po */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Pq */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qc */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Ql */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qo */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Qq */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Re */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Rs */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sc */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* So */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sq */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, 0 }, /* Sm */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sx */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Sy */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Tn */ - { roff_text, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED }, /* Ux */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xc */ - { NULL, NULL, NULL, NULL, 0, ROFF_TEXT, ROFF_PARSED | ROFF_CALLABLE }, /* Xo */ - { roff_layout, NULL, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Fo */ - { roff_layout, NULL, roffparent_Fc, NULL, ROFF_Fo, ROFF_LAYOUT, 0 }, /* Fc */ - { roff_layout, NULL, NULL, NULL, 0, ROFF_LAYOUT, 0 }, /* Oo */ - { roff_layout, NULL, roffparent_Oc, NULL, ROFF_Oo, ROFF_LAYOUT, 0 }, /* Oc */ -}; + error = 1; -/* 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 */ -}; + if (ROFF_PRELUDE & tree->state) { + roff_err(tree, NULL, "prelude never finished"); + goto end; + } else if ( ! (ROFFSec_NAME & tree->asec)) { + roff_err(tree, NULL, "missing `NAME' section"); + goto end; + } else if ( ! (ROFFSec_NMASK & tree->asec)) + roff_warn(tree, NULL, "missing suggested `NAME', " + "`SYNOPSIS', `DESCRIPTION' sections"); -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", - "Dv", - "Er", - "Ev", - "Ex", - "Fa", - "Fd", - "Fl", - "Fn", - "Ft", - "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! */ - "Fo", - "Fc", - "Oo", - "Oc", - }; + for (n = tree->last; n; n = n->parent) { + if (0 != tokens[n->tok].ctx) + continue; + roff_err(tree, NULL, "closing explicit scope `%s'", + toknames[n->tok]); + goto end; + } -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", - "std", - "-p1003.1-88", - "-p1003.1-90", - "-p1003.1-96", - "-p1003.1-2001", - "-p1003.1-2004", - "-p1003.1", - "-p1003.1b", - "-p1003.1b-93", - "-p1003.1c-95", - "-p1003.1g-2000", - "-p1003.2-92", - "-p1387.2-95", - "-p1003.2", - "-p1387.2", - "-isoC-90", - "-isoC-amd1", - "-isoC-tcor1", - "-isoC-tcor2", - "-isoC-99", - "-ansiC", - "-ansiC-89", - "-ansiC-99", - "-ieee754", - "-iso8802-3", - "-xpg3", - "-xpg4", - "-xpg4.2", - "-xpg4.3", - "-xbd5", - "-xcu5", - "-xsh5", - "-xns5", - "-xns5.2d2.0", - "-xcurses4.2", - "-susv2", - "-susv3", - "-svid4", - }; + while (tree->last) { + t = tree->last->tok; + if ( ! roffexit(tree, t)) + goto end; + } -const char *const *toknames = toknamesp; -const char *const *tokargnames = tokargnamesp; + if ( ! (*tree->cb.rofftail)(tree->arg)) + goto end; + error = 0; -int -roff_free(struct rofftree *tree, int flush) -{ - int error; +end: - assert(tree->mbuf); - if ( ! flush) - tree->mbuf = NULL; + while (tree->last) + roffnode_free(tree); - /* 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); } struct rofftree * -roff_alloc(const struct md_args *args, struct md_mbuf *out, - const struct md_rbuf *in, const struct roffcb *cb) +roff_alloc(const struct roffcb *cb, void *args) { struct rofftree *tree; - if (NULL == (tree = calloc(1, sizeof(struct rofftree)))) { - warn("malloc"); - return(NULL); - } + assert(args); + assert(cb); + if (NULL == (tree = calloc(1, sizeof(struct rofftree)))) + err(1, "calloc"); + tree->state = ROFF_PRELUDE; - tree->args = args; - tree->mbuf = out; - tree->rbuf = in; - tree->cb = cb; + tree->arg = args; + tree->section = ROFF_MSEC_MAX; + (void)memcpy(&tree->cb, cb, sizeof(struct roffcb)); + return(tree); } int -roff_engine(struct rofftree *tree, char *buf, size_t sz) +roff_engine(struct rofftree *tree, char *buf) { - if (0 == sz) { - warnx("%s: blank line (line %zu)", - tree->rbuf->name, - tree->rbuf->line); + tree->cur = buf; + assert(buf); + + if (0 == *buf) { + roff_err(tree, buf, "blank line"); return(0); } else if ('.' != *buf) - return(textparse(tree, buf, sz)); + return(textparse(tree, buf)); - return(roffparse(tree, buf, sz)); + return(roffparse(tree, buf)); } static int -textparse(const struct rofftree *tree, const char *buf, size_t sz) +textparse(struct rofftree *tree, char *buf) { - - if (NULL == tree->last) { - warnx("%s: unexpected text (line %zu)", - tree->rbuf->name, - tree->rbuf->line); + char *bufp; + + /* TODO: literal parsing. */ + + if ( ! (ROFF_BODY & tree->state)) { + roff_err(tree, buf, "data not in body"); return(0); - } else if (NULL == tree->last->parent) { - warnx("%s: disallowed text (line %zu)", - tree->rbuf->name, - tree->rbuf->line); - return(0); } - /* Print text. */ + /* LINTED */ + while (*buf) { + while (*buf && isspace(*buf)) + buf++; + if (0 == *buf) + break; + + bufp = buf++; + + while (*buf && ! isspace(*buf)) + buf++; + + if (0 != *buf) { + *buf++ = 0; + if ( ! roffdata(tree, 1, bufp)) + return(0); + continue; + } + + if ( ! roffdata(tree, 1, bufp)) + return(0); + break; + } + return(1); } static int -roffargs(int tok, char *buf, char **argv) +roffargs(const struct rofftree *tree, + int tok, char *buf, char **argv) { int i; + char *p; - (void)tok;/* FIXME: quotable strings? */ - assert(tok >= 0 && tok < ROFF_MAX); assert('.' == *buf); + p = buf; + + /* + * This is an ugly little loop. It parses a line into + * space-delimited tokens. If a quote mark is encountered, a + * token is alloted the entire quoted text. If whitespace is + * escaped, it's included in the prior alloted token. + */ + /* LINTED */ - for (i = 0; *buf && i < ROFF_MAXARG; i++) { - argv[i] = buf++; - while (*buf && ! isspace(*buf)) - buf++; - if (0 == *buf) { - continue; + for (i = 0; *buf && i < ROFF_MAXLINEARG; i++) { + if ('\"' == *buf) { + argv[i] = ++buf; + while (*buf && '\"' != *buf) + buf++; + if (0 == *buf) { + roff_err(tree, argv[i], "unclosed " + "quote in argument " + "list for `%s'", + toknames[tok]); + return(0); + } + } else { + argv[i] = buf++; + while (*buf) { + if ( ! isspace(*buf)) { + buf++; + continue; + } + if (*(buf - 1) == '\\') { + buf++; + continue; + } + break; + } + if (0 == *buf) + continue; } *buf++ = 0; while (*buf && isspace(*buf)) buf++; } - + assert(i > 0); - if (i < ROFF_MAXARG) - argv[i] = NULL; + if (ROFF_MAXLINEARG == i && *buf) { + roff_err(tree, p, "too many arguments for `%s'", toknames + [tok]); + return(0); + } - return(ROFF_MAXARG > i); + argv[i] = NULL; + return(1); } -/* XXX */ static int roffscan(int tok, const int *tokv) { @@ -587,44 +325,33 @@ roffscan(int tok, const int *tokv) static int -roffparse(struct rofftree *tree, char *buf, size_t sz) +roffparse(struct rofftree *tree, char *buf) { int tok, t; struct roffnode *n; - char *argv[ROFF_MAXARG]; - const char **argvp; + char *argv[ROFF_MAXLINEARG]; + char **argvp; - assert(sz > 0); + if (0 != *buf && 0 != *(buf + 1) && 0 != *(buf + 2)) + if (0 == strncmp(buf, ".\\\"", 3)) + return(1); if (ROFF_MAX == (tok = rofffindtok(buf + 1))) { - warnx("%s: unknown line macro (line %zu)", - tree->rbuf->name, tree->rbuf->line); + roff_err(tree, buf, "bogus line macro"); return(0); - } else if (NULL == tokens[tok].cb) { - warnx("%s: macro `%s' not supported (line %zu)", - tree->rbuf->name, toknames[tok], - tree->rbuf->line); + } else if ( ! roffargs(tree, tok, buf, argv)) return(0); - } else if (ROFF_COMMENT == tokens[tok].type) - return(1); - - if ( ! roffargs(tok, buf, argv)) { - warnx("%s: too many args to `%s' (line %zu)", - tree->rbuf->name, toknames[tok], - tree->rbuf->line); - return(0); - } else - argvp = (const char **)argv + 1; + argvp = (char **)argv; + /* - * Prelude macros break some assumptions: branch now. + * Prelude macros break some assumptions, so branch now. */ if (ROFF_PRELUDE & tree->state) { assert(NULL == tree->last); - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); - } else - assert(tree->last); + return(roffcall(tree, tok, argvp)); + } assert(ROFF_BODY & tree->state); @@ -633,82 +360,125 @@ roffparse(struct rofftree *tree, char *buf, size_t sz) * children are satisfied. */ - if ( ! roffscan(tree->last->tok, tokens[tok].parents)) { - warnx("%s: invalid parent `%s' for `%s' (line %zu)", - tree->rbuf->name, - toknames[tree->last->tok], - toknames[tok], tree->rbuf->line); + if (tree->last && ! roffscan + (tree->last->tok, tokens[tok].parents)) { + roff_err(tree, *argvp, "`%s' has invalid parent `%s'", + toknames[tok], + toknames[tree->last->tok]); return(0); } - -#if 0 - (void)printf("parse: macro `%s' (%d), parent `%s' (%d)\n", - toknames[tok], tok, - toknames[tree->last->tok], tree->last->tok); - - if ( ! roffscan(tok, tokens[tree->last->tok].children)) { - warnx("%s: invalid child `%s' for `%s' (line %zu)", - tree->rbuf->name, toknames[tok], - toknames[tree->last->tok], - tree->rbuf->line); + if (tree->last && ! roffscan + (tok, tokens[tree->last->tok].children)) { + roff_err(tree, *argvp, "`%s' is invalid child of `%s'", + toknames[tok], + toknames[tree->last->tok]); return(0); } -#endif /* * Branch if we're not a layout token. */ if (ROFF_LAYOUT != tokens[tok].type) - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); + return(roffcall(tree, tok, argvp)); + if (0 == tokens[tok].ctx) + return(roffcall(tree, tok, argvp)); - /* - * Check our scope rules. + /* + * First consider implicit-end tags, like as follows: + * .Sh SECTION 1 + * .Sh SECTION 2 + * In this, we want to close the scope of the NAME section. If + * there's an intermediary implicit-end tag, such as + * .Sh SECTION 1 + * .Ss Subsection 1 + * .Sh SECTION 2 + * then it must be closed as well. */ - if (0 == tokens[tok].ctx) - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); - if (tok == tokens[tok].ctx) { + /* + * First search up to the point where we must close. + * If one doesn't exist, then we can open a new scope. + */ + for (n = tree->last; n; n = n->parent) { assert(0 == tokens[n->tok].ctx || n->tok == tokens[n->tok].ctx); if (n->tok == tok) break; + if (ROFF_SHALLOW & tokens[tok].flags) { + n = NULL; + break; + } + if (tokens[n->tok].ctx == n->tok) + continue; + roff_err(tree, *argv, "`%s' breaks `%s' scope", + toknames[tok], toknames[n->tok]); + return(0); } - if (NULL == n) { -#ifdef DEBUG - (void)printf("scope: new `%s'\n", - toknames[tok]); -#endif - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); - } + + /* + * Create a new scope, as no previous one exists to + * close out. + */ + + if (NULL == n) + return(roffcall(tree, tok, argvp)); + + /* + * Close out all intermediary scoped blocks, then hang + * the current scope from our predecessor's parent. + */ + do { t = tree->last->tok; -#ifdef DEBUG - (void)printf("scope: closing `%s'\n", - toknames[t]); -#endif - if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT)) + if ( ! roffexit(tree, t)) return(0); } while (t != tok); - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); + return(roffcall(tree, tok, argvp)); } + /* + * Now consider explicit-end tags, where we want to close back + * to a specific tag. Example: + * .Bl + * .It Item. + * .El + * In this, the `El' tag closes out the scope of `Bl'. + */ + assert(tok != tokens[tok].ctx && 0 != tokens[tok].ctx); + /* LINTED */ + for (n = tree->last; n; n = n->parent) + if (n->tok != tokens[tok].ctx) { + if (n->tok == tokens[n->tok].ctx) + continue; + roff_err(tree, *argv, "`%s' breaks `%s' scope", + toknames[tok], toknames[n->tok]); + return(0); + } else + break; + + + if (NULL == n) { + roff_err(tree, *argv, "`%s' has no starting tag `%s'", + toknames[tok], + toknames[tokens[tok].ctx]); + return(0); + } + + /* LINTED */ do { t = tree->last->tok; -#ifdef DEBUG - (void)printf("scope: closing `%s'\n", toknames[t]); -#endif - if ( ! (*tokens[t].cb)(t, tree, NULL, ROFF_EXIT)) + if ( ! roffexit(tree, t)) return(0); } while (t != tokens[tok].ctx); - return((*tokens[tok].cb)(tok, tree, argvp, ROFF_ENTER)); + return(1); } @@ -733,17 +503,13 @@ static int rofffindtok(const char *buf) { char token[4]; - size_t i; + int i; for (i = 0; *buf && ! isspace(*buf) && i < 3; i++, buf++) token[i] = *buf; - if (i == 3) { -#ifdef DEBUG - (void)printf("lookup: macro too long: `%s'\n", buf); -#endif + if (i == 3) return(ROFF_MAX); - } token[i] = 0; @@ -752,29 +518,217 @@ rofffindtok(const char *buf) /* LINTED */ for (i = 0; i < ROFF_MAX; i++) /* LINTED */ - if (0 == strcmp(toknames[i], token)) { -#ifdef DEBUG - (void)printf("lookup (good): `%s' (%d)\n", - token, (int)i); -#endif + if (0 == strcmp(toknames[i], token)) return((int)i); - } -#ifdef DEBUG - (void)printf("lookup (bad): `%s'\n", token); -#endif - return(ROFF_MAX); } static int +roffchecksec(struct rofftree *tree, const char *start, int sec) +{ + int prior; + + switch (sec) { + case(ROFFSec_SYNOP): + if ((prior = ROFFSec_NAME) & tree->asec) + return(1); + break; + case(ROFFSec_DESC): + if ((prior = ROFFSec_SYNOP) & tree->asec) + return(1); + break; + case(ROFFSec_RETVAL): + if ((prior = ROFFSec_DESC) & tree->asec) + return(1); + break; + case(ROFFSec_ENV): + if ((prior = ROFFSec_RETVAL) & tree->asec) + return(1); + break; + case(ROFFSec_FILES): + if ((prior = ROFFSec_ENV) & tree->asec) + return(1); + break; + case(ROFFSec_EX): + if ((prior = ROFFSec_FILES) & tree->asec) + return(1); + break; + case(ROFFSec_DIAG): + if ((prior = ROFFSec_EX) & tree->asec) + return(1); + break; + case(ROFFSec_ERRS): + if ((prior = ROFFSec_DIAG) & tree->asec) + return(1); + break; + case(ROFFSec_SEEALSO): + if ((prior = ROFFSec_ERRS) & tree->asec) + return(1); + break; + case(ROFFSec_STAND): + if ((prior = ROFFSec_SEEALSO) & tree->asec) + return(1); + break; + case(ROFFSec_HIST): + if ((prior = ROFFSec_STAND) & tree->asec) + return(1); + break; + case(ROFFSec_AUTH): + if ((prior = ROFFSec_HIST) & tree->asec) + return(1); + break; + case(ROFFSec_CAVEATS): + if ((prior = ROFFSec_AUTH) & tree->asec) + return(1); + break; + case(ROFFSec_BUGS): + if ((prior = ROFFSec_CAVEATS) & tree->asec) + return(1); + break; + default: + return(1); + } + + roff_warn(tree, start, "section violates conventional order"); + return(1); +} + + +static int +roffissec(const char **p) +{ + + assert(*p); + if (NULL != *(p + 1)) { + if (NULL != *(p + 2)) + return(ROFFSec_OTHER); + if (0 == strcmp(*p, "RETURN") && + 0 == strcmp(*(p + 1), "VALUES")) + return(ROFFSec_RETVAL); + if (0 == strcmp(*p, "SEE") && + 0 == strcmp(*(p + 1), "ALSO")) + return(ROFFSec_SEEALSO); + return(ROFFSec_OTHER); + } + + if (0 == strcmp(*p, "NAME")) + return(ROFFSec_NAME); + else if (0 == strcmp(*p, "SYNOPSIS")) + return(ROFFSec_SYNOP); + else if (0 == strcmp(*p, "DESCRIPTION")) + return(ROFFSec_DESC); + else if (0 == strcmp(*p, "ENVIRONMENT")) + return(ROFFSec_ENV); + else if (0 == strcmp(*p, "FILES")) + return(ROFFSec_FILES); + else if (0 == strcmp(*p, "EXAMPLES")) + return(ROFFSec_EX); + else if (0 == strcmp(*p, "DIAGNOSTICS")) + return(ROFFSec_DIAG); + else if (0 == strcmp(*p, "ERRORS")) + return(ROFFSec_ERRS); + else if (0 == strcmp(*p, "STANDARDS")) + return(ROFFSec_STAND); + else if (0 == strcmp(*p, "HISTORY")) + return(ROFFSec_HIST); + else if (0 == strcmp(*p, "AUTHORS")) + return(ROFFSec_AUTH); + else if (0 == strcmp(*p, "CAVEATS")) + return(ROFFSec_CAVEATS); + else if (0 == strcmp(*p, "BUGS")) + return(ROFFSec_BUGS); + + return(ROFFSec_OTHER); +} + + +static int +roffismsec(const char *p) +{ + + if (0 == strcmp(p, "1")) + return(ROFF_MSEC_1); + else if (0 == strcmp(p, "2")) + return(ROFF_MSEC_2); + else if (0 == strcmp(p, "3")) + return(ROFF_MSEC_3); + else if (0 == strcmp(p, "3p")) + return(ROFF_MSEC_3p); + else if (0 == strcmp(p, "4")) + return(ROFF_MSEC_4); + else if (0 == strcmp(p, "5")) + return(ROFF_MSEC_5); + else if (0 == strcmp(p, "6")) + return(ROFF_MSEC_6); + else if (0 == strcmp(p, "7")) + return(ROFF_MSEC_7); + else if (0 == strcmp(p, "8")) + return(ROFF_MSEC_8); + else if (0 == strcmp(p, "9")) + return(ROFF_MSEC_9); + else if (0 == strcmp(p, "unass")) + return(ROFF_MSEC_UNASS); + else if (0 == strcmp(p, "draft")) + return(ROFF_MSEC_DRAFT); + else if (0 == strcmp(p, "paper")) + return(ROFF_MSEC_PAPER); + + return(ROFF_MSEC_MAX); +} + + +static int +roffispunct(const char *p) +{ + + if (0 == *p) + return(0); + if (0 != *(p + 1)) + return(0); + + switch (*p) { + case('{'): + /* FALLTHROUGH */ + case('.'): + /* FALLTHROUGH */ + case(','): + /* FALLTHROUGH */ + case(';'): + /* FALLTHROUGH */ + case(':'): + /* FALLTHROUGH */ + case('?'): + /* FALLTHROUGH */ + case('!'): + /* FALLTHROUGH */ + case('('): + /* FALLTHROUGH */ + case(')'): + /* FALLTHROUGH */ + case('['): + /* FALLTHROUGH */ + case(']'): + /* FALLTHROUGH */ + case('}'): + return(1); + default: + break; + } + + return(0); +} + + +static int rofffindcallable(const char *name) { int c; if (ROFF_MAX == (c = rofffindtok(name))) return(ROFF_MAX); + assert(c >= 0 && c < ROFF_MAX); return(ROFF_CALLABLE & tokens[c].flags ? c : ROFF_MAX); } @@ -784,15 +738,13 @@ roffnode_new(int tokid, struct rofftree *tree) { struct roffnode *p; - if (NULL == (p = malloc(sizeof(struct roffnode)))) { - warn("malloc"); - return(NULL); - } + if (NULL == (p = malloc(sizeof(struct roffnode)))) + err(1, "malloc"); - p->line = tree->rbuf->line; p->tok = tokid; p->parent = tree->last; tree->last = p; + return(p); } @@ -814,12 +766,11 @@ roffargok(int tokid, int argid) static void -roffnode_free(int tokid, struct rofftree *tree) +roffnode_free(struct rofftree *tree) { struct roffnode *p; assert(tree->last); - assert(tree->last->tok == tokid); p = tree->last; tree->last = tree->last->parent; @@ -828,9 +779,149 @@ roffnode_free(int tokid, struct rofftree *tree) static int -roffnextopt(int tok, const char ***in, char **val) +roffspecial(struct rofftree *tree, int tok, const char *start, + const int *argc, const char **argv, + size_t sz, char **ordp) { - const char *arg, **argv; + + switch (tok) { + case (ROFF_At): + if (0 == sz) + break; + if (0 == strcmp(*ordp, "v1")) + break; + else if (0 == strcmp(*ordp, "v2")) + break; + else if (0 == strcmp(*ordp, "v3")) + break; + else if (0 == strcmp(*ordp, "v6")) + break; + else if (0 == strcmp(*ordp, "v7")) + break; + else if (0 == strcmp(*ordp, "32v")) + break; + else if (0 == strcmp(*ordp, "V.1")) + break; + else if (0 == strcmp(*ordp, "V.4")) + break; + roff_err(tree, *ordp, "invalid `At' arg"); + return(0); + + case (ROFF_Xr): + if (2 == sz) { + assert(ordp[1]); + if (ROFF_MSEC_MAX != roffismsec(ordp[1])) + break; + roff_warn(tree, start, "invalid `%s' manual " + "section", toknames[tok]); + } + /* FALLTHROUGH */ + + case (ROFF_Sx): + /* FALLTHROUGH*/ + case (ROFF_Fn): + if (0 != sz) + break; + roff_err(tree, start, "`%s' expects at least " + "one arg", toknames[tok]); + return(0); + + case (ROFF_Nm): + if (0 == sz) { + if (0 == tree->name[0]) { + roff_err(tree, start, "`Nm' not set"); + return(0); + } + ordp[0] = tree->name; + ordp[1] = NULL; + } else if ( ! roffsetname(tree, ordp)) + return(0); + break; + + case (ROFF_Rv): + /* FALLTHROUGH*/ + case (ROFF_Ex): + if (1 == sz) + break; + roff_err(tree, start, "`%s' expects one arg", + toknames[tok]); + return(0); + + case (ROFF_Sm): + if (1 != sz) { + roff_err(tree, start, "`Sm' expects one arg"); + return(0); + } + + if (0 != strcmp(ordp[0], "on") && + 0 != strcmp(ordp[0], "off")) { + roff_err(tree, start, "`Sm' has invalid argument"); + return(0); + } + break; + + case (ROFF_Ud): + /* FALLTHROUGH */ + case (ROFF_Ux): + /* FALLTHROUGH */ + case (ROFF_Bt): + if (0 != sz) { + roff_err(tree, start, "`%s' expects no args", + toknames[tok]); + return(0); + } + break; + default: + break; + } + + return((*tree->cb.roffspecial)(tree->arg, tok, tree->cur, + argc, argv, (const char **)ordp)); +} + + +static int +roffexit(struct rofftree *tree, int tok) +{ + + assert(tokens[tok].cb); + return((*tokens[tok].cb)(tok, tree, NULL, ROFF_EXIT)); +} + + +static int +roffcall(struct rofftree *tree, int tok, char **argv) +{ + int i; + enum roffmsec c; + + if (NULL == tokens[tok].cb) { + roff_err(tree, *argv, "`%s' is unsupported", + toknames[tok]); + return(0); + } + if (tokens[tok].sections && ROFF_MSEC_MAX != tree->section) { + i = 0; + while (ROFF_MSEC_MAX != + (c = tokens[tok].sections[i++])) + if (c == tree->section) + break; + if (ROFF_MSEC_MAX == c) { + roff_warn(tree, *argv, "`%s' is not a valid " + "macro in this manual section", + toknames[tok]); + } + } + + return((*tokens[tok].cb)(tok, tree, argv, ROFF_ENTER)); +} + + +static int +roffnextopt(const struct rofftree *tree, int tok, + char ***in, char **val) +{ + char *arg, **argv; int v; *val = NULL; @@ -842,30 +933,98 @@ roffnextopt(int tok, const char ***in, char **val) if ('-' != *arg) return(-1); - /* FIXME: should we let this slide... ? */ - - if (ROFF_ARGMAX == (v = rofffindarg(&arg[1]))) + if (ROFF_ARGMAX == (v = rofffindarg(arg + 1))) { + roff_warn(tree, arg, "argument-like parameter `%s' to " + "`%s'", arg, toknames[tok]); return(-1); - - /* FIXME: should we let this slide... ? */ - - if ( ! roffargok(tok, v)) + } + + if ( ! roffargok(tok, v)) { + roff_warn(tree, arg, "invalid argument parameter `%s' to " + "`%s'", tokargnames[v], toknames[tok]); return(-1); - if ( ! (ROFF_VALUE & tokenargs[v].flags)) + } + + if ( ! (ROFF_VALUE & tokenargs[v])) return(v); *in = ++argv; - /* FIXME: what if this looks like a roff token or argument? */ + if (NULL == *argv) { + roff_err(tree, arg, "empty value of `%s' for `%s'", + tokargnames[v], toknames[tok]); + return(ROFF_ARGMAX); + } - return(*argv ? v : ROFF_ARGMAX); + return(v); } +static int +roffpurgepunct(struct rofftree *tree, char **argv) +{ + int i; + + i = 0; + while (argv[i]) + i++; + assert(i > 0); + if ( ! roffispunct(argv[--i])) + return(1); + while (i >= 0 && roffispunct(argv[i])) + i--; + i++; + + /* LINTED */ + while (argv[i]) + if ( ! roffdata(tree, 0, argv[i++])) + return(0); + return(1); +} + + +static int +roffparseopts(struct rofftree *tree, int tok, + char ***args, int *argc, char **argv) +{ + int i, c; + char *v; + + i = 0; + + while (-1 != (c = roffnextopt(tree, tok, args, &v))) { + if (ROFF_ARGMAX == c) + return(0); + + argc[i] = c; + argv[i] = v; + i++; + *args = *args + 1; + } + + argc[i] = ROFF_ARGMAX; + argv[i] = NULL; + return(1); +} + + +static int +roffdata(struct rofftree *tree, int space, char *buf) +{ + + if (0 == *buf) + return(1); + return((*tree->cb.roffdata)(tree->arg, + space != 0, tree->cur, buf)); +} + + /* ARGSUSED */ static int roff_Dd(ROFFCALL_ARGS) { + time_t t; + char *p, buf[32]; if (ROFF_BODY & tree->state) { assert( ! (ROFF_PRELUDE & tree->state)); @@ -877,20 +1036,70 @@ roff_Dd(ROFFCALL_ARGS) assert( ! (ROFF_BODY & tree->state)); if (ROFF_PRELUDE_Dd & tree->state) { - warnx("%s: prelude `Dd' repeated (line %zu)", - tree->rbuf->name, tree->rbuf->line); + roff_err(tree, *argv, "repeated `Dd' in prelude"); return(0); } else if (ROFF_PRELUDE_Dt & tree->state) { - warnx("%s: prelude `Dd' out-of-order (line %zu)", - tree->rbuf->name, tree->rbuf->line); + roff_err(tree, *argv, "out-of-order `Dd' in prelude"); return(0); } - /* TODO: parse date. */ - assert(NULL == tree->last); - tree->state |= ROFF_PRELUDE_Dd; + argv++; + + if (0 == strcmp(*argv, "$Mdocdate: December 8 2008 $")) { + t = time(NULL); + if (NULL == localtime_r(&t, &tree->tm)) + err(1, "localtime_r"); + tree->state |= ROFF_PRELUDE_Dd; + return(1); + } + + /* Build this from Mdocdate or raw date. */ + + buf[0] = 0; + p = *argv; + + if (0 != strcmp(*argv, "$Mdocdate:")) { + while (*argv) { + if (strlcat(buf, *argv++, sizeof(buf)) + < sizeof(buf)) + continue; + roff_err(tree, p, "bad `Dd' date"); + return(0); + } + if (strptime(buf, "%b%d,%Y", &tree->tm)) { + tree->state |= ROFF_PRELUDE_Dd; + return(1); + } + roff_err(tree, *argv, "bad `Dd' date"); + return(0); + } + + argv++; + while (*argv && **argv != '$') { + if (strlcat(buf, *argv++, sizeof(buf)) + >= sizeof(buf)) { + roff_err(tree, p, "bad `Dd' Mdocdate"); + return(0); + } + if (strlcat(buf, " ", sizeof(buf)) + >= sizeof(buf)) { + roff_err(tree, p, "bad `Dd' Mdocdate"); + return(0); + } + } + if (NULL == *argv) { + roff_err(tree, p, "bad `Dd' Mdocdate"); + return(0); + } + + if (NULL == strptime(buf, "%b %d %Y", &tree->tm)) { + roff_err(tree, *argv, "bad `Dd' Mdocdate"); + return(0); + } + + tree->state |= ROFF_PRELUDE_Dd; return(1); } @@ -910,17 +1119,43 @@ roff_Dt(ROFFCALL_ARGS) assert( ! (ROFF_BODY & tree->state)); if ( ! (ROFF_PRELUDE_Dd & tree->state)) { - warnx("%s: prelude `Dt' out-of-order (line %zu)", - tree->rbuf->name, tree->rbuf->line); + roff_err(tree, *argv, "out-of-order `Dt' in prelude"); return(0); } else if (ROFF_PRELUDE_Dt & tree->state) { - warnx("%s: prelude `Dt' repeated (line %zu)", - tree->rbuf->name, tree->rbuf->line); + roff_err(tree, *argv, "repeated `Dt' in prelude"); return(0); } - /* TODO: parse date. */ + argv++; + if (NULL == *argv) { + roff_err(tree, *argv, "`Dt' needs document title"); + return(0); + } else if (strlcpy(tree->title, *argv, sizeof(tree->title)) + >= sizeof(tree->title)) { + roff_err(tree, *argv, "`Dt' document title too long"); + return(0); + } + argv++; + if (NULL == *argv) { + roff_err(tree, *argv, "`Dt' needs section"); + return(0); + } + + if (ROFF_MSEC_MAX == (tree->section = roffismsec(*argv))) { + roff_err(tree, *argv, "bad `Dt' section"); + return(0); + } + + argv++; + if (NULL == *argv) { + tree->volume[0] = 0; + } else if (strlcpy(tree->volume, *argv, sizeof(tree->volume)) + >= sizeof(tree->volume)) { + roff_err(tree, *argv, "`Dt' volume too long"); + return(0); + } + assert(NULL == tree->last); tree->state |= ROFF_PRELUDE_Dt; @@ -928,15 +1163,82 @@ roff_Dt(ROFFCALL_ARGS) } +static int +roffsetname(struct rofftree *tree, char **ordp) +{ + + assert(*ordp); + + /* FIXME: not all sections can set this. */ + + if (NULL != *(ordp + 1)) { + roff_err(tree, *ordp, "too many `Nm' args"); + return(0); + } + + if (strlcpy(tree->name, *ordp, sizeof(tree->name)) + >= sizeof(tree->name)) { + roff_err(tree, *ordp, "`Nm' arg too long"); + return(0); + } + + return(1); +} + + /* ARGSUSED */ static int +roff_Ns(ROFFCALL_ARGS) +{ + int j, c, first; + char *morep[1]; + + first = (*argv++ == tree->cur); + morep[0] = NULL; + + if ( ! roffspecial(tree, tok, *argv, NULL, NULL, 0, morep)) + return(0); + + while (*argv) { + if (ROFF_MAX != (c = rofffindcallable(*argv))) { + if ( ! roffcall(tree, c, argv)) + return(0); + break; + } + + if ( ! roffispunct(*argv)) { + if ( ! roffdata(tree, 1, *argv++)) + return(0); + continue; + } + + for (j = 0; argv[j]; j++) + if ( ! roffispunct(argv[j])) + break; + + if (argv[j]) { + if ( ! roffdata(tree, 0, *argv++)) + return(0); + continue; + } + + break; + } + + if ( ! first) + return(1); + + return(roffpurgepunct(tree, argv)); +} + + +/* ARGSUSED */ +static int roff_Os(ROFFCALL_ARGS) { + char *p; - if (ROFF_EXIT == type) { - assert(ROFF_PRELUDE_Os & tree->state); - return(roff_layout(tok, tree, argv, type)); - } else if (ROFF_BODY & tree->state) { + if (ROFF_BODY & tree->state) { assert( ! (ROFF_PRELUDE & tree->state)); assert(ROFF_PRELUDE_Os & tree->state); return(roff_text(tok, tree, argv, type)); @@ -945,20 +1247,42 @@ roff_Os(ROFFCALL_ARGS) 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); + roff_err(tree, *argv, "out-of-order `Os' in prelude"); return(0); } - /* TODO: extract OS. */ + tree->os[0] = 0; + p = *++argv; + + while (*argv) { + if (strlcat(tree->os, *argv++, sizeof(tree->os)) + < sizeof(tree->os)) + continue; + roff_err(tree, p, "`Os' value too long"); + return(0); + } + + if (0 == tree->os[0]) + if (strlcpy(tree->os, "LOCAL", sizeof(tree->os)) + >= sizeof(tree->os)) { + roff_err(tree, p, "`Os' value too long"); + return(0); + } + tree->state |= ROFF_PRELUDE_Os; tree->state &= ~ROFF_PRELUDE; tree->state |= ROFF_BODY; + assert(ROFF_MSEC_MAX != tree->section); + assert(0 != tree->title[0]); + assert(0 != tree->os[0]); + assert(NULL == tree->last); - return(roff_layout(tok, tree, argv, type)); + return((*tree->cb.roffhead)(tree->arg, &tree->tm, + tree->os, tree->title, tree->section, + tree->volume)); } @@ -966,141 +1290,403 @@ roff_Os(ROFFCALL_ARGS) static int roff_layout(ROFFCALL_ARGS) { - int i, c, argcp[ROFF_MAXARG]; - char *v, *argvp[ROFF_MAXARG]; + int i, c, argcp[ROFF_MAXLINEARG]; + char *argvp[ROFF_MAXLINEARG]; + /* + * The roff_layout function is for multi-line macros. A layout + * has a start and end point, which is either declared + * explicitly or implicitly. An explicit start and end is + * embodied by `.Bl' and `.El', with the former being the start + * and the latter being an end. The `.Sh' and `.Ss' tags, on + * the other hand, are implicit. The scope of a layout is the + * space between start and end. Explicit layouts may not close + * out implicit ones and vice versa; implicit layouts may close + * out other implicit layouts. + */ + + assert( ! (ROFF_CALLABLE & tokens[tok].flags)); + if (ROFF_PRELUDE & tree->state) { - warnx("%s: macro `%s' called in prelude (line %zu)", - tree->rbuf->name, - toknames[tok], - tree->rbuf->line); + roff_err(tree, *argv, "bad `%s' in prelude", + toknames[tok]); return(0); - } - - if (ROFF_EXIT == type) { - roffnode_free(tok, tree); - return((*tree->cb->roffblkout)(tok)); + } else if (ROFF_EXIT == type) { + roffnode_free(tree); + if ( ! (*tree->cb.roffblkbodyout)(tree->arg, tok)) + return(0); + return((*tree->cb.roffblkout)(tree->arg, tok)); } - i = 0; + assert( ! (ROFF_CALLABLE & tokens[tok].flags)); - 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); + ++argv; + + if ( ! roffparseopts(tree, tok, &argv, argcp, argvp)) + return(0); + if (NULL == roffnode_new(tok, tree)) + return(0); + + /* + * Layouts have two parts: the layout body and header. The + * layout header is the trailing text of the line macro, while + * the layout body is everything following until termination. + * Example: + * + * .It Fl f ) ; + * Bar. + * + * ...Produces... + * + * + * + * ; + * + * + * + * Bar. + * + * + */ + + if ( ! (*tree->cb.roffblkin)(tree->arg, tok, argcp, + (const char **)argvp)) + return(0); + + /* +++ Begin run macro-specific hooks over argv. */ + + switch (tok) { + case (ROFF_Sh): + if (NULL == *argv) { + roff_err(tree, *(argv - 1), + "`Sh' expects arguments"); 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; - i++; - argv++; + tree->csec = roffissec((const char **)argv); + if ( ! (ROFFSec_OTHER & tree->csec) && + tree->asec & tree->csec) + roff_warn(tree, *argv, "section repeated"); + if (0 == tree->asec && ! (ROFFSec_NAME & tree->csec)) { + roff_err(tree, *argv, "`NAME' section " + "must be first"); + return(0); + } else if ( ! roffchecksec(tree, *argv, tree->csec)) + return(0); + + tree->asec |= tree->csec; + break; + default: + break; } - argcp[i] = ROFF_ARGMAX; - argvp[i] = NULL; + /* --- End run macro-specific hooks over argv. */ - if (NULL == roffnode_new(tok, tree)) - return(0); + if (NULL == *argv) + return((*tree->cb.roffblkbodyin) + (tree->arg, tok, argcp, + (const char **)argvp)); - if ( ! (*tree->cb->roffin)(tok, argcp, argvp)) + if ( ! (*tree->cb.roffblkheadin)(tree->arg, tok, argcp, + (const char **)argvp)) return(0); + /* + * If there are no parsable parts, then write remaining tokens + * into the layout header and exit. + */ + if ( ! (ROFF_PARSED & tokens[tok].flags)) { - /* TODO: print all tokens. */ + i = 0; + while (*argv) + if ( ! roffdata(tree, i++, *argv++)) + return(0); - if ( ! ((*tree->cb->roffout)(tok))) + if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok)) return(0); - return((*tree->cb->roffblkin)(tok)); + return((*tree->cb.roffblkbodyin)(tree->arg, tok, argcp, + (const char **)argvp)); } + /* + * Parsable elements may be in the header (or be the header, for + * that matter). Follow the regular parsing rules for these. + */ + + i = 0; while (*argv) { - if (2 >= strlen(*argv) && ROFF_MAX != - (c = rofffindcallable(*argv))) - if ( ! (*tokens[c].cb)(c, tree, - argv + 1, ROFF_ENTER)) + if (ROFF_MAX == (c = rofffindcallable(*argv))) { + assert(tree->arg); + if ( ! roffdata(tree, i++, *argv++)) return(0); + continue; + } + if ( ! roffcall(tree, c, argv)) + return(0); + break; + } - /* TODO: print token. */ - argv++; + /* + * If there's trailing punctuation in the header, then write it + * out now. Here we mimic the behaviour of a line-dominant text + * macro. + */ + + if (NULL == *argv) { + if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok)) + return(0); + return((*tree->cb.roffblkbodyin) + (tree->arg, tok, argcp, + (const char **)argvp)); } - if ( ! ((*tree->cb->roffout)(tok))) - return(0); + /* + * Expensive. Scan to the end of line then work backwards until + * a token isn't punctuation. + */ - return((*tree->cb->roffblkin)(tok)); + if ( ! roffpurgepunct(tree, argv)) + return(0); + if ( ! (*tree->cb.roffblkheadout)(tree->arg, tok)) + return(0); + return((*tree->cb.roffblkbodyin)(tree->arg, + tok, argcp, (const char **)argvp)); } /* ARGSUSED */ static int -roff_text(ROFFCALL_ARGS) +roff_ordered(ROFFCALL_ARGS) { - int i, c, argcp[ROFF_MAXARG]; - char *v, *argvp[ROFF_MAXARG]; + int i, first, c, argcp[ROFF_MAXLINEARG]; + char *ordp[ROFF_MAXLINEARG], *p, + *argvp[ROFF_MAXLINEARG]; + /* + * Ordered macros pass their arguments directly to handlers, + * instead of considering it free-form text. Thus, the + * following macro looks as follows: + * + * .Xr foo 1 ) , + * + * .Xr arg1 arg2 punctuation + */ + if (ROFF_PRELUDE & tree->state) { - warnx("%s: macro `%s' called in prelude (line %zu)", - tree->rbuf->name, - toknames[tok], - tree->rbuf->line); + roff_err(tree, *argv, "`%s' disallowed in prelude", + toknames[tok]); return(0); } + first = (*argv == tree->cur); + p = *argv++; + ordp[0] = NULL; + + if ( ! roffparseopts(tree, tok, &argv, argcp, argvp)) + return(0); + + if (NULL == *argv) + return(roffspecial(tree, tok, p, argcp, + (const char **)argvp, 0, ordp)); + i = 0; + while (*argv && i < ROFF_MAXLINEARG) { + c = ROFF_PARSED & tokens[tok].flags ? + rofffindcallable(*argv) : ROFF_MAX; - 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); + if (ROFF_MAX == c && ! roffispunct(*argv)) { + ordp[i++] = *argv++; + continue; + } + ordp[i] = NULL; + + if (ROFF_MAX == c) + break; + + if ( ! roffspecial(tree, tok, p, argcp, + (const char **)argvp, + (size_t)i, ordp)) return(0); - } - argcp[i] = c; - argvp[i] = v; - i++; - argv++; + + return(roffcall(tree, c, argv)); } - argcp[i] = ROFF_ARGMAX; - argvp[i] = NULL; + assert(i != ROFF_MAXLINEARG); + ordp[i] = NULL; - if ( ! (*tree->cb->roffin)(tok, argcp, argvp)) + if ( ! roffspecial(tree, tok, p, argcp, + (const char**)argvp, + (size_t)i, ordp)) return(0); + /* FIXME: error if there's stuff after the punctuation. */ + + if ( ! first || NULL == *argv) + return(1); + + return(roffpurgepunct(tree, argv)); +} + + +/* ARGSUSED */ +static int +roff_text(ROFFCALL_ARGS) +{ + int i, j, first, c, argcp[ROFF_MAXLINEARG]; + char *argvp[ROFF_MAXLINEARG]; + + /* + * Text macros are similar to special tokens, except that + * arguments are instead flushed as pure data: we're only + * concerned with the macro and its arguments. Example: + * + * .Fl v W f ; + * + * ...Produces... + * + * v W f ; + */ + + if (ROFF_PRELUDE & tree->state) { + roff_err(tree, *argv, "`%s' disallowed in prelude", + toknames[tok]); + return(0); + } + + first = (*argv == tree->cur); + argv++; + + if ( ! roffparseopts(tree, tok, &argv, argcp, argvp)) + return(0); + if ( ! (*tree->cb.roffin)(tree->arg, tok, argcp, + (const char **)argvp)) + return(0); + if (NULL == *argv) + return((*tree->cb.roffout)(tree->arg, tok)); + if ( ! (ROFF_PARSED & tokens[tok].flags)) { - /* TODO: print all tokens. */ - return((*tree->cb->roffout)(tok)); + i = 0; + while (*argv) + if ( ! roffdata(tree, i++, *argv++)) + return(0); + + return((*tree->cb.roffout)(tree->arg, tok)); } + /* + * Deal with punctuation. Ugly. Work ahead until we encounter + * terminating punctuation. If we encounter it and all + * subsequent tokens are punctuation, then stop processing (the + * line-dominant macro will print these tokens after closure). + * If the punctuation is followed by non-punctuation, then close + * and re-open our scope, then continue. + */ + + i = 0; while (*argv) { - if (2 >= strlen(*argv) && ROFF_MAX != - (c = rofffindcallable(*argv))) - if ( ! (*tokens[c].cb)(c, tree, - argv + 1, ROFF_ENTER)) + if (ROFF_MAX != (c = rofffindcallable(*argv))) { + if ( ! (ROFF_LSCOPE & tokens[tok].flags)) + if ( ! (*tree->cb.roffout)(tree->arg, tok)) + return(0); + + if ( ! roffcall(tree, c, argv)) return(0); + + if (ROFF_LSCOPE & tokens[tok].flags) + if ( ! (*tree->cb.roffout)(tree->arg, tok)) + return(0); + + break; + } - /* TODO: print token. */ - argv++; + if ( ! roffispunct(*argv)) { + if ( ! roffdata(tree, i++, *argv++)) + return(0); + continue; + } + + i = 1; + for (j = 0; argv[j]; j++) + if ( ! roffispunct(argv[j])) + break; + + if (argv[j]) { + if (ROFF_LSCOPE & tokens[tok].flags) { + if ( ! roffdata(tree, 0, *argv++)) + return(0); + continue; + } + if ( ! (*tree->cb.roffout)(tree->arg, tok)) + return(0); + if ( ! roffdata(tree, 0, *argv++)) + return(0); + if ( ! (*tree->cb.roffin)(tree->arg, tok, + argcp, + (const char **)argvp)) + return(0); + + i = 0; + continue; + } + + if ( ! (*tree->cb.roffout)(tree->arg, tok)) + return(0); + break; } - return((*tree->cb->roffout)(tok)); + if (NULL == *argv) + return((*tree->cb.roffout)(tree->arg, tok)); + if ( ! first) + return(1); + + return(roffpurgepunct(tree, argv)); } -/* ARGUSED */ +/* ARGSUSED */ static int -roff_comment(ROFFCALL_ARGS) +roff_noop(ROFFCALL_ARGS) { return(1); } + + +/* ARGSUSED */ +static int +roff_depr(ROFFCALL_ARGS) +{ + + roff_err(tree, *argv, "`%s' is deprecated", toknames[tok]); + return(0); +} + + +static void +roff_warn(const struct rofftree *tree, const char *pos, char *fmt, ...) +{ + va_list ap; + char buf[128]; + + va_start(ap, fmt); + (void)vsnprintf(buf, sizeof(buf), fmt, ap); + va_end(ap); + + (*tree->cb.roffmsg)(tree->arg, + ROFF_WARN, tree->cur, pos, buf); +} + + +static void +roff_err(const struct rofftree *tree, const char *pos, char *fmt, ...) +{ + va_list ap; + char buf[128]; + + va_start(ap, fmt); + (void)vsnprintf(buf, sizeof(buf), fmt, ap); + va_end(ap); + + (*tree->cb.roffmsg)(tree->arg, + ROFF_ERROR, tree->cur, pos, buf); +} +