=================================================================== RCS file: /cvs/mandoc/Attic/macro.c,v retrieving revision 1.17 retrieving revision 1.70 diff -u -p -r1.17 -r1.70 --- mandoc/Attic/macro.c 2009/01/02 14:06:16 1.17 +++ mandoc/Attic/macro.c 2009/03/12 16:30:50 1.70 @@ -1,4 +1,4 @@ -/* $Id: macro.c,v 1.17 2009/01/02 14:06:16 kristaps Exp $ */ +/* $Id: macro.c,v 1.70 2009/03/12 16:30:50 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -21,557 +21,1255 @@ #include #include #include -#ifdef __linux__ -#include -#endif #include "private.h" -/* FIXME: maxlineargs should be per LINE, no per TOKEN. */ +/* + * This has scanning/parsing routines, each of which extract a macro and + * its arguments and parameters, then know how to progress to the next + * macro. + */ -#define _CC(p) ((const char **)p) +/* FIXME: .Fl, .Ar, .Cd handling of `|'. */ -static int scope_rewind_imp(struct mdoc *, int, int); -static int scope_rewind_exp(struct mdoc *, int, int, int); -static int scope_rewind_line(struct mdoc *, int, int); -static int append_text(struct mdoc *, int, - int, int, char *[]); -static int append_text_argv(struct mdoc *, int, int, - int, char *[], int, const struct mdoc_arg *); +static int macro_obsolete(MACRO_PROT_ARGS); +static int macro_constant(MACRO_PROT_ARGS); +static int macro_constant_scoped(MACRO_PROT_ARGS); +static int macro_constant_delimited(MACRO_PROT_ARGS); +static int macro_text(MACRO_PROT_ARGS); +static int macro_scoped(MACRO_PROT_ARGS); +static int macro_scoped_close(MACRO_PROT_ARGS); +static int macro_scoped_line(MACRO_PROT_ARGS); +static int macro_phrase(struct mdoc *, int, int, char *); + +#define REWIND_REWIND (1 << 0) +#define REWIND_NOHALT (1 << 1) +#define REWIND_HALT (1 << 2) + +static int rewind_dohalt(int, enum mdoc_type, + const struct mdoc_node *); +static int rewind_alt(int); +static int rewind_dobreak(int, const struct mdoc_node *); +static int rewind_elem(struct mdoc *, int); +static int rewind_impblock(struct mdoc *, int, int, int); +static int rewind_expblock(struct mdoc *, int, int, int); +static int rewind_subblock(enum mdoc_type, + struct mdoc *, int, int, int); +static int rewind_last(struct mdoc *, struct mdoc_node *); static int append_delims(struct mdoc *, int, int *, char *); +static int lookup(struct mdoc *, int, int, int, const char *); +static int pwarn(struct mdoc *, int, int, int); +static int perr(struct mdoc *, int, int, int); +static int scopewarn(struct mdoc *, enum mdoc_type, int, int, + const struct mdoc_node *); +#define WMACPARM (1) +#define WOBS (2) -static int -scope_rewind_line(struct mdoc *mdoc, int ppos, int tok) +#define ENOCTX (1) +#define ENOPARMS (2) + +/* Central table of library: who gets parsed how. */ + +const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { + { NULL, 0 }, /* \" */ + { macro_constant, MDOC_PROLOGUE }, /* Dd */ + { macro_constant, MDOC_PROLOGUE }, /* Dt */ + { macro_constant, MDOC_PROLOGUE }, /* Os */ + { macro_scoped, 0 }, /* Sh */ + { macro_scoped, 0 }, /* Ss */ + { macro_text, 0 }, /* Pp */ + { macro_scoped_line, MDOC_PARSED }, /* D1 */ + { macro_scoped_line, MDOC_PARSED }, /* Dl */ + { macro_scoped, MDOC_EXPLICIT }, /* Bd */ + { macro_scoped_close, MDOC_EXPLICIT }, /* Ed */ + { macro_scoped, MDOC_EXPLICIT }, /* Bl */ + { macro_scoped_close, MDOC_EXPLICIT }, /* El */ + { macro_scoped, MDOC_PARSED }, /* It */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */ + { macro_text, MDOC_PARSED }, /* An */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */ + { macro_constant, MDOC_CALLABLE }, /* Cd */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Er */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */ + { macro_constant, 0 }, /* Ex */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fa */ + { macro_constant, 0 }, /* Fd */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */ + { macro_text, MDOC_PARSED }, /* Ft */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */ + { macro_constant, 0 }, /* In */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Li */ + { macro_constant, 0 }, /* Nd */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Op */ + { macro_obsolete, 0 }, /* Ot */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */ + { macro_constant, 0 }, /* Rv */ + /* XXX - .St supposed to be (but isn't) callable. */ + { macro_constant_delimited, MDOC_PARSED }, /* St */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Va */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */ + { macro_constant, 0 }, /* %A */ + { macro_constant, 0 }, /* %B */ + { macro_constant, 0 }, /* %D */ + { macro_constant, 0 }, /* %I */ + { macro_constant, 0 }, /* %J */ + { macro_constant, 0 }, /* %N */ + { macro_constant, 0 }, /* %O */ + { macro_constant, 0 }, /* %P */ + { macro_constant, 0 }, /* %R */ + { macro_constant, 0 }, /* %T */ + { macro_constant, 0 }, /* %V */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ac */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ao */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */ + { macro_constant_delimited, 0 }, /* At */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Bc */ + { macro_scoped, MDOC_EXPLICIT }, /* Bf */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bo */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Bq */ + { macro_constant_delimited, MDOC_PARSED }, /* Bsx */ + { macro_constant_delimited, MDOC_PARSED }, /* Bx */ + { macro_constant, 0 }, /* Db */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Dc */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Do */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dq */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ec */ + { macro_scoped_close, MDOC_EXPLICIT }, /* Ef */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Em */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */ + { macro_constant_delimited, MDOC_PARSED }, /* Fx */ + { macro_text, MDOC_PARSED }, /* Ms */ + { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* No */ + { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */ + { macro_constant_delimited, MDOC_PARSED }, /* Nx */ + { macro_constant_delimited, MDOC_PARSED }, /* Ox */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */ + { macro_constant_delimited, MDOC_PARSED }, /* Pf */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Po */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Qc */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ql */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Qo */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Qq */ + { macro_scoped_close, MDOC_EXPLICIT }, /* Re */ + { macro_scoped, MDOC_EXPLICIT }, /* Rs */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Sc */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* So */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sq */ + { macro_constant, 0 }, /* Sm */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sx */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sy */ + { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */ + { macro_constant_delimited, MDOC_PARSED }, /* Ux */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */ + /* XXX - .Fo supposed to be (but isn't) callable. */ + { macro_scoped, MDOC_EXPLICIT }, /* Fo */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Fc */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Oo */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Oc */ + { macro_scoped, MDOC_EXPLICIT }, /* Bk */ + { macro_scoped_close, MDOC_EXPLICIT }, /* Ek */ + { macro_constant, 0 }, /* Bt */ + { macro_constant, 0 }, /* Hf */ + { macro_obsolete, 0 }, /* Fr */ + { macro_constant, 0 }, /* Ud */ + { macro_constant, 0 }, /* Lb */ + { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */ + { macro_text, 0 }, /* Lp */ + { macro_text, MDOC_PARSED }, /* Lk */ + { macro_text, MDOC_PARSED }, /* Mt */ + { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Brq */ + { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bro */ + { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Brc */ + { macro_constant, 0 }, /* %C */ +}; + +const struct mdoc_macro * const mdoc_macros = __mdoc_macros; + + +/* + * This is called at the end of parsing. It must traverse up the tree, + * closing out open [implicit] scopes. Obviously, open explicit scopes + * are errors. + */ +int +macro_end(struct mdoc *mdoc) { struct mdoc_node *n; - int t; - /* LINTED */ - for (n = mdoc->last; n; n = n->parent) { - if (MDOC_HEAD != n->type) + assert(mdoc->first); + assert(mdoc->last); + + /* Scan for open explicit scopes. */ + + n = MDOC_VALID & mdoc->last->flags ? + mdoc->last->parent : mdoc->last; + + for ( ; n; n = n->parent) { + if (MDOC_BLOCK != n->type) continue; - if (tok == (t = n->data.head.tok)) - break; - if ( ! (MDOC_EXPLICIT & mdoc_macros[t].flags)) + if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags)) continue; - return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK)); + return(mdoc_nerr(mdoc, n, + "macro scope still open on exit")); } - mdoc->last = n ? n : mdoc->last; - mdoc->next = MDOC_NEXT_SIBLING; - return(1); + return(rewind_last(mdoc, mdoc->first)); } static int -scope_rewind_exp(struct mdoc *mdoc, int ppos, int tok, int tt) +perr(struct mdoc *mdoc, int line, int pos, int type) { - struct mdoc_node *n; + int c; - assert(mdoc->last); - - /* LINTED */ - for (n = mdoc->last->parent; n; n = n->parent) { - if (MDOC_BLOCK != n->type) - continue; - if (tt == n->data.block.tok) - break; - return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK)); + switch (type) { + case (ENOCTX): + c = mdoc_perr(mdoc, line, pos, + "closing macro has no prior context"); + break; + case (ENOPARMS): + c = mdoc_perr(mdoc, line, pos, + "macro doesn't expect parameters"); + break; + default: + abort(); + /* NOTREACHED */ } + return(c); +} - if (NULL == (mdoc->last = n)) - return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_NOCTX)); +static int +pwarn(struct mdoc *mdoc, int line, int pos, int type) +{ + int c; - mdoc->next = MDOC_NEXT_SIBLING; - return(mdoc_valid_post(mdoc, tok, ppos)); + switch (type) { + case (WMACPARM): + c = mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, + "macro-like parameter"); + break; + case (WOBS): + c = mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, + "macro is marked obsolete"); + break; + default: + abort(); + /* NOTREACHED */ + } + return(c); } static int -scope_rewind_imp(struct mdoc *mdoc, int ppos, int tok) +scopewarn(struct mdoc *mdoc, enum mdoc_type type, + int line, int pos, const struct mdoc_node *p) { - struct mdoc_node *n; - int t; + const char *n, *t, *tt; - n = mdoc->last ? mdoc->last->parent : NULL; + n = t = ""; + tt = "block"; - /* LINTED */ - for ( ; n; n = n->parent) { - if (MDOC_BLOCK != n->type) - continue; - if (tok == (t = n->data.block.tok)) - break; - if ( ! (MDOC_EXPLICIT & mdoc_macros[t].flags)) - continue; - return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK)); + switch (type) { + case (MDOC_BODY): + tt = "multi-line"; + break; + case (MDOC_HEAD): + tt = "line"; + break; + default: + break; } - mdoc->last = n ? n : mdoc->last; - mdoc->next = MDOC_NEXT_SIBLING; - return(mdoc_valid_post(mdoc, tok, ppos)); + switch (p->type) { + case (MDOC_BLOCK): + n = mdoc_macronames[p->tok]; + t = "block"; + break; + case (MDOC_BODY): + n = mdoc_macronames[p->tok]; + t = "multi-line"; + break; + case (MDOC_HEAD): + n = mdoc_macronames[p->tok]; + t = "line"; + break; + default: + break; + } + + if ( ! (MDOC_IGN_SCOPE & mdoc->pflags)) + return(mdoc_perr(mdoc, line, pos, + "%s scope breaks %s scope of %s", + tt, t, n)); + return(mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, + "%s scope breaks %s scope of %s", + tt, t, n)); } static int -append_delims(struct mdoc *mdoc, int tok, int *pos, char *buf) +lookup(struct mdoc *mdoc, int line, int pos, int from, const char *p) { - int c, lastarg; - char *p; + int res; - if (0 == buf[*pos]) - return(1); + res = mdoc_tokhash_find(mdoc->htab, p); + if (MDOC_PARSED & mdoc_macros[from].flags) + return(res); + if (MDOC_MAX == res) + return(res); + if ( ! pwarn(mdoc, line, pos, WMACPARM)) + return(-1); + return(MDOC_MAX); +} - for (;;) { - lastarg = *pos; - c = mdoc_args(mdoc, tok, pos, buf, 0, &p); - if (ARGS_ERROR == c) + +static int +rewind_last(struct mdoc *mdoc, struct mdoc_node *to) +{ + + assert(to); + mdoc->next = MDOC_NEXT_SIBLING; + + /* LINTED */ + while (mdoc->last != to) { + if ( ! mdoc_valid_post(mdoc)) return(0); - else if (ARGS_EOLN == c) - break; - assert(mdoc_isdelim(p)); - mdoc_word_alloc(mdoc, lastarg, p); - mdoc->next = MDOC_NEXT_SIBLING; + if ( ! mdoc_action_post(mdoc)) + return(0); + mdoc->last = mdoc->last->parent; + assert(mdoc->last); } - return(1); + if ( ! mdoc_valid_post(mdoc)) + return(0); + return(mdoc_action_post(mdoc)); } static int -append_text_argv(struct mdoc *mdoc, int tok, int pos, - int sz, char *args[], - int argc, const struct mdoc_arg *argv) +rewind_alt(int tok) { - - if ( ! mdoc_valid_pre(mdoc, tok, pos, 0, NULL, argc, argv)) - return(0); - switch (tok) { - case (MDOC_Pf): - /* TODO: only use first two arguments in element. */ - break; + case (MDOC_Ac): + return(MDOC_Ao); + case (MDOC_Bc): + return(MDOC_Bo); + case (MDOC_Brc): + return(MDOC_Bro); + case (MDOC_Dc): + return(MDOC_Do); + case (MDOC_Ec): + return(MDOC_Eo); + case (MDOC_Ed): + return(MDOC_Bd); + case (MDOC_Ef): + return(MDOC_Bf); + case (MDOC_Ek): + return(MDOC_Bk); + case (MDOC_El): + return(MDOC_Bl); + case (MDOC_Fc): + return(MDOC_Fo); + case (MDOC_Oc): + return(MDOC_Oo); + case (MDOC_Pc): + return(MDOC_Po); + case (MDOC_Qc): + return(MDOC_Qo); + case (MDOC_Re): + return(MDOC_Rs); + case (MDOC_Sc): + return(MDOC_So); + case (MDOC_Xc): + return(MDOC_Xo); default: break; } - - mdoc_elem_alloc(mdoc, pos, tok, (size_t)argc, - argv, (size_t)sz, _CC(args)); - mdoc->next = MDOC_NEXT_SIBLING; - return(1); + abort(); + /* NOTREACHED */ } static int -append_text(struct mdoc *mdoc, int tok, - int pos, int sz, char *args[]) +rewind_dohalt(int tok, enum mdoc_type type, const struct mdoc_node *p) { - if ( ! mdoc_valid_pre(mdoc, tok, pos, sz, _CC(args), 0, NULL)) - return(0); + if (MDOC_ROOT == p->type) + return(REWIND_HALT); + if (MDOC_VALID & p->flags) + return(REWIND_NOHALT); switch (tok) { - case (MDOC_At): - if (0 == sz) - break; - if (ATT_DEFAULT == mdoc_atoatt(args[0])) { - mdoc_elem_alloc(mdoc, pos, tok, - 0, NULL, 0, NULL); - mdoc->next = MDOC_NEXT_SIBLING; - mdoc_word_alloc(mdoc, pos, args[0]); - mdoc->next = MDOC_NEXT_SIBLING; - } else { - mdoc_elem_alloc(mdoc, pos, tok, 0, - NULL, 1, _CC(&args[0])); - mdoc->next = MDOC_NEXT_SIBLING; - } + /* One-liner implicit-scope. */ + case (MDOC_Aq): + /* FALLTHROUGH */ + case (MDOC_Bq): + /* FALLTHROUGH */ + case (MDOC_Brq): + /* FALLTHROUGH */ + case (MDOC_D1): + /* FALLTHROUGH */ + case (MDOC_Dl): + /* FALLTHROUGH */ + case (MDOC_Dq): + /* FALLTHROUGH */ + case (MDOC_Op): + /* FALLTHROUGH */ + case (MDOC_Pq): + /* FALLTHROUGH */ + case (MDOC_Ql): + /* FALLTHROUGH */ + case (MDOC_Qq): + /* FALLTHROUGH */ + case (MDOC_Sq): + assert(MDOC_HEAD != type); + assert(MDOC_TAIL != type); + if (type == p->type && tok == p->tok) + return(REWIND_REWIND); + break; - if (sz > 1) - mdoc_word_alloc(mdoc, pos, args[1]); - mdoc->next = MDOC_NEXT_SIBLING; - return(1); + /* Multi-line implicit-scope. */ + case (MDOC_It): + assert(MDOC_TAIL != type); + if (type == p->type && tok == p->tok) + return(REWIND_REWIND); + if (MDOC_BODY == p->type && MDOC_Bl == p->tok) + return(REWIND_HALT); + break; + case (MDOC_Sh): + if (type == p->type && tok == p->tok) + return(REWIND_REWIND); + break; + case (MDOC_Ss): + assert(MDOC_TAIL != type); + if (type == p->type && tok == p->tok) + return(REWIND_REWIND); + if (MDOC_BODY == p->type && MDOC_Sh == p->tok) + return(REWIND_HALT); + break; + + /* Multi-line explicit scope start. */ + case (MDOC_Ao): + /* FALLTHROUGH */ + case (MDOC_Bd): + /* FALLTHROUGH */ + case (MDOC_Bf): + /* FALLTHROUGH */ + case (MDOC_Bk): + /* FALLTHROUGH */ + case (MDOC_Bl): + /* FALLTHROUGH */ + case (MDOC_Bo): + /* FALLTHROUGH */ + case (MDOC_Bro): + /* FALLTHROUGH */ + case (MDOC_Do): + /* FALLTHROUGH */ + case (MDOC_Eo): + /* FALLTHROUGH */ + case (MDOC_Fo): + /* FALLTHROUGH */ + case (MDOC_Oo): + /* FALLTHROUGH */ + case (MDOC_Po): + /* FALLTHROUGH */ + case (MDOC_Qo): + /* FALLTHROUGH */ + case (MDOC_Rs): + /* FALLTHROUGH */ + case (MDOC_So): + /* FALLTHROUGH */ + case (MDOC_Xo): + if (type == p->type && tok == p->tok) + return(REWIND_REWIND); + break; - default: + /* Multi-line explicit scope close. */ + case (MDOC_Ac): + /* FALLTHROUGH */ + case (MDOC_Bc): + /* FALLTHROUGH */ + case (MDOC_Brc): + /* FALLTHROUGH */ + case (MDOC_Dc): + /* FALLTHROUGH */ + case (MDOC_Ec): + /* FALLTHROUGH */ + case (MDOC_Ed): + /* FALLTHROUGH */ + case (MDOC_Ek): + /* FALLTHROUGH */ + case (MDOC_El): + /* FALLTHROUGH */ + case (MDOC_Fc): + /* FALLTHROUGH */ + case (MDOC_Ef): + /* FALLTHROUGH */ + case (MDOC_Oc): + /* FALLTHROUGH */ + case (MDOC_Pc): + /* FALLTHROUGH */ + case (MDOC_Qc): + /* FALLTHROUGH */ + case (MDOC_Re): + /* FALLTHROUGH */ + case (MDOC_Sc): + /* FALLTHROUGH */ + case (MDOC_Xc): + if (type == p->type && rewind_alt(tok) == p->tok) + return(REWIND_REWIND); break; + default: + abort(); + /* NOTREACHED */ } - mdoc_elem_alloc(mdoc, pos, tok, 0, NULL, (size_t)sz, _CC(args)); - mdoc->next = MDOC_NEXT_SIBLING; - return(1); + return(REWIND_NOHALT); } -int -macro_text(MACRO_PROT_ARGS) +static int +rewind_dobreak(int tok, const struct mdoc_node *p) { - int lastarg, lastpunct, c, j, fl; - char *args[MDOC_LINEARG_MAX]; - /* Token pre-processing. */ + assert(MDOC_ROOT != p->type); + if (MDOC_ELEM == p->type) + return(1); + if (MDOC_TEXT == p->type) + return(1); + if (MDOC_VALID & p->flags) + return(1); switch (tok) { - case (MDOC_Pp): - /* `.Pp' ignored when following `.Sh' or `.Ss'. */ - assert(mdoc->last); - if (MDOC_BODY != mdoc->last->type) - break; - switch (mdoc->last->data.body.tok) { - case (MDOC_Ss): - /* FALLTHROUGH */ - case (MDOC_Sh): - if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_AFTER_BLK)) - return(0); + /* Implicit rules. */ + case (MDOC_It): + return(MDOC_It == p->tok); + case (MDOC_Ss): + return(MDOC_Ss == p->tok); + case (MDOC_Sh): + if (MDOC_Ss == p->tok) return(1); - default: - break; - } + return(MDOC_Sh == p->tok); + + /* Extra scope rules. */ + case (MDOC_El): + if (MDOC_It == p->tok) + return(1); break; default: break; } - /* Process line parameters. */ + if (MDOC_EXPLICIT & mdoc_macros[tok].flags) + return(p->tok == rewind_alt(tok)); + else if (MDOC_BLOCK == p->type) + return(1); - j = 0; - lastarg = ppos; - lastpunct = 0; - fl = ARGS_DELIM; + return(tok == p->tok); +} - if (MDOC_QUOTABLE & mdoc_macros[tok].flags) - fl |= ARGS_QUOTED; -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); +static int +rewind_elem(struct mdoc *mdoc, int tok) +{ + struct mdoc_node *n; - /* - * Parse out the next argument, unquoted and unescaped. If - * we're a word (which may be punctuation followed eventually by - * a real word), then fall into checking for callables. If - * only punctuation remains and we're the first, then flush - * arguments, punctuation and exit; else, return to the caller. - */ + n = mdoc->last; + if (MDOC_ELEM != n->type) + n = n->parent; + assert(MDOC_ELEM == n->type); + assert(tok == n->tok); - lastarg = *pos; + return(rewind_last(mdoc, n)); +} - switch (mdoc_args(mdoc, tok, pos, buf, fl, &args[j])) { - case (ARGS_ERROR): - return(0); - case (ARGS_WORD): - break; - case (ARGS_PUNCT): - if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args)) - return(0); - if (ppos > 1) + +static int +rewind_subblock(enum mdoc_type type, struct mdoc *mdoc, + int tok, int line, int ppos) +{ + struct mdoc_node *n; + int c; + + /* LINTED */ + for (n = mdoc->last; n; n = n->parent) { + c = rewind_dohalt(tok, type, n); + if (REWIND_HALT == c) return(1); - return(append_delims(mdoc, tok, pos, buf)); - case (ARGS_EOLN): - if (lastpunct) - return(1); - return(append_text(mdoc, tok, ppos, j, args)); - default: - abort(); - /* NOTREACHED */ + if (REWIND_REWIND == c) + break; + else if (rewind_dobreak(tok, n)) + continue; + if ( ! scopewarn(mdoc, type, line, ppos, n)) + return(0); } - /* - * Command found. First flush out arguments, then call the - * command. If we're the line macro when it exits, flush - * terminal punctuation. - */ + assert(n); + return(rewind_last(mdoc, n)); +} - if (MDOC_MAX != (c = mdoc_find(mdoc, args[j]))) { - if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args)) + +static int +rewind_expblock(struct mdoc *mdoc, int tok, int line, int ppos) +{ + struct mdoc_node *n; + int c; + + /* LINTED */ + for (n = mdoc->last; n; n = n->parent) { + c = rewind_dohalt(tok, MDOC_BLOCK, n); + if (REWIND_HALT == c) + return(perr(mdoc, line, ppos, ENOCTX)); + if (REWIND_REWIND == c) + break; + else if (rewind_dobreak(tok, n)) + continue; + if ( ! scopewarn(mdoc, MDOC_BLOCK, line, ppos, n)) return(0); - if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) - return(0); - if (ppos > 1) - return(1); - return(append_delims(mdoc, tok, pos, buf)); } - /* Word/non-term-punctuation found. */ + assert(n); + return(rewind_last(mdoc, n)); +} - if ( ! mdoc_isdelim(args[j])) { - /* Words are appended to the array of arguments. */ - j++; - lastpunct = 0; - goto again; + +static int +rewind_impblock(struct mdoc *mdoc, int tok, int line, int ppos) +{ + struct mdoc_node *n; + int c; + + /* LINTED */ + for (n = mdoc->last; n; n = n->parent) { + c = rewind_dohalt(tok, MDOC_BLOCK, n); + if (REWIND_HALT == c) + return(1); + else if (REWIND_REWIND == c) + break; + else if (rewind_dobreak(tok, n)) + continue; + if ( ! scopewarn(mdoc, MDOC_BLOCK, line, ppos, n)) + return(0); } - /* - * For punctuation, flush all collected words, then flush - * punctuation, then start collecting again. Of course, this - * is non-terminal punctuation. - */ + assert(n); + return(rewind_last(mdoc, n)); +} - if ( ! lastpunct && ! append_text(mdoc, tok, ppos, j, args)) - return(0); - mdoc_word_alloc(mdoc, lastarg, args[j]); - mdoc->next = MDOC_NEXT_SIBLING; - j = 0; - lastpunct = 1; +static int +append_delims(struct mdoc *mdoc, int line, int *pos, char *buf) +{ + int c, lastarg; + char *p; - goto again; - /* NOTREACHED */ -} + if (0 == buf[*pos]) + return(1); + for (;;) { + lastarg = *pos; + c = mdoc_args(mdoc, line, pos, buf, 0, &p); + assert(ARGS_PHRASE != c); + if (ARGS_ERROR == c) + return(0); + else if (ARGS_EOLN == c) + break; + assert(mdoc_isdelim(p)); + if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + return(0); + mdoc->next = MDOC_NEXT_SIBLING; + } -/* ARGSUSED */ -int -macro_close_explicit(MACRO_PROT_ARGS) -{ - int tt; + return(1); +} - /* - * First close out the explicit scope. The `end' tags (such as - * `.El' to `.Bl' don't cause anything to happen: we merely - * readjust our last parse point. - */ +/* + * Close out an explicit scope. This optionally parses a TAIL type with + * a set number of TEXT children. + */ +static int +macro_scoped_close(MACRO_PROT_ARGS) +{ + int tt, j, c, lastarg, maxargs, flushed; + char *p; + switch (tok) { - case (MDOC_El): - tt = MDOC_Bl; + case (MDOC_Ec): + maxargs = 1; break; - case (MDOC_Ed): - tt = MDOC_Bd; - break; - case (MDOC_Re): - tt = MDOC_Rs; - break; - case (MDOC_Ef): - tt = MDOC_Bf; - break; default: - abort(); - /* NOTREACHED */ + maxargs = 0; + break; } - return(scope_rewind_exp(mdoc, ppos, tok, tt)); -} + tt = rewind_alt(tok); + mdoc_msg(mdoc, "parse: %s closing %s", + mdoc_macronames[tok], mdoc_macronames[tt]); -int -macro_scoped(MACRO_PROT_ARGS) -{ - int i, c, lastarg, argc, sz; - char *args[MDOC_LINEARG_MAX]; - struct mdoc_arg argv[MDOC_LINEARG_MAX]; - enum mdoc_sec sec; - struct mdoc_node *n; + if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) { + if (0 == buf[*pos]) { + if ( ! rewind_subblock(MDOC_BODY, mdoc, + tok, line, ppos)) + return(0); + return(rewind_expblock(mdoc, tok, line, ppos)); + } + return(perr(mdoc, line, ppos, ENOPARMS)); + } - assert ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)); + if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos)) + return(0); - /* Token pre-processing. */ + lastarg = ppos; + flushed = 0; - switch (tok) { - case (MDOC_Bl): - /* FALLTHROUGH */ - case (MDOC_Bd): - /* `.Pp' ignored when preceding `.Bl' or `.Bd'. */ - assert(mdoc->last); - if (MDOC_ELEM != mdoc->last->type) - break; - if (MDOC_Pp != mdoc->last->data.elem.tok) - break; - if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_BEFORE_BLK)) + if (maxargs > 0) { + if ( ! mdoc_tail_alloc(mdoc, line, ppos, tt)) return(0); - assert(mdoc->last->prev); - n = mdoc->last; - mdoc->last = mdoc->last->prev; - mdoc->last->next = NULL; - mdoc_node_free(n); - break; - case (MDOC_Sh): - /* FALLTHROUGH */ - case (MDOC_Ss): - if ( ! scope_rewind_imp(mdoc, ppos, tok)) + mdoc->next = MDOC_NEXT_CHILD; + } + + for (j = 0; /* No sentinel. */; j++) { + lastarg = *pos; + + if (j == maxargs && ! flushed) { + if ( ! rewind_expblock(mdoc, tok, line, ppos)) + return(0); + flushed = 1; + } + + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); + + if (ARGS_ERROR == c) return(0); - /* `.Pp' ignored when preceding `.Ss' or `.Sh'. */ - if (NULL == mdoc->last) + if (ARGS_PUNCT == c) break; - if (MDOC_ELEM != mdoc->last->type) + if (ARGS_EOLN == c) break; - if (MDOC_Pp != mdoc->last->data.elem.tok) + + if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) + return(0); + else if (MDOC_MAX != c) { + if ( ! flushed) { + if ( ! rewind_expblock(mdoc, tok, + line, ppos)) + return(0); + flushed = 1; + } + if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) + return(0); break; - if ( ! mdoc_warn(mdoc, tok, ppos, WARN_IGN_BEFORE_BLK)) + } + + if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) return(0); - assert(mdoc->last->prev); - n = mdoc->last; - mdoc_msg(mdoc, ppos, "removing prior `Pp' macro"); - mdoc->last = mdoc->last->prev; - mdoc->last->next = NULL; - mdoc_node_free(n); - break; - default: - break; + mdoc->next = MDOC_NEXT_SIBLING; } - /* Argument processing. */ + if ( ! flushed && ! rewind_expblock(mdoc, tok, line, ppos)) + return(0); - lastarg = *pos; + if (ppos > 1) + return(1); + return(append_delims(mdoc, line, pos, buf)); +} - for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) { - lastarg = *pos; - c = mdoc_argv(mdoc, tok, &argv[argc], pos, buf); - if (ARGV_EOLN == c || ARGV_WORD == c) + +/* + * A general text macro. This is a complex case because of punctuation. + * If a text macro is followed by words, then punctuation, the macro is + * "stopped" and "reopened" following the punctuation. Thus, the + * following arises: + * + * .Fl a ; b + * + * ELEMENT (.Fl) + * TEXT (`a') + * TEXT (`;') + * ELEMENT (.Fl) + * TEXT (`b') + * + * This must handle the following situations: + * + * .Fl Ar b ; ; + * + * ELEMENT (.Fl) + * ELEMENT (.Ar) + * TEXT (`b') + * TEXT (`;') + * TEXT (`;') + */ +static int +macro_text(MACRO_PROT_ARGS) +{ + int la, lastpunct, c, w; + struct mdoc_arg *arg; + char *p; + + la = ppos; + lastpunct = 0; + arg = NULL; + + for (;;) { + la = *pos; + c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); + if (ARGV_EOLN == c) break; - else if (ARGV_ARG == c) + if (ARGV_WORD == c) { + *pos = la; + break; + } else if (ARGV_ARG == c) continue; - mdoc_argv_free(argc, argv); + mdoc_argv_free(arg); return(0); } - /* Parameter processing. */ + if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg)) + return(0); - for (sz = 0; argc + sz < MDOC_LINEARG_MAX; sz++) { - lastarg = *pos; - c = mdoc_args(mdoc, tok, pos, buf, 0, &args[sz]); - if (ARGS_EOLN == c) + mdoc->next = MDOC_NEXT_CHILD; + + lastpunct = 0; + for (;;) { + la = *pos; + w = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != w); + + if (ARGS_ERROR == w) + return(0); + if (ARGS_EOLN == w) break; - if (ARGS_WORD == c) - continue; - mdoc_argv_free(argc, argv); - return(0); + if (ARGS_PUNCT == w) + break; + + /* Quoted words shouldn't be looked-up. */ + + c = ARGS_QWORD == w ? MDOC_MAX : + lookup(mdoc, line, la, tok, p); + + /* MDOC_MAX (not a macro) or -1 (error). */ + + if (MDOC_MAX != c && -1 != c) { + if (0 == lastpunct && ! rewind_elem(mdoc, tok)) + return(0); + c = mdoc_macro(mdoc, c, line, la, pos, buf); + if (0 == c) + return(0); + if (ppos > 1) + return(1); + return(append_delims(mdoc, line, pos, buf)); + } else if (-1 == c) + return(0); + + /* Non-quote-enclosed punctuation. */ + + if (ARGS_QWORD != w && mdoc_isdelim(p)) { + if (0 == lastpunct && ! rewind_elem(mdoc, tok)) + return(0); + lastpunct = 1; + } else if (lastpunct) { + c = mdoc_elem_alloc(mdoc, line, ppos, tok, arg); + + if (0 == c) + return(0); + + mdoc->next = MDOC_NEXT_CHILD; + lastpunct = 0; + } + + if ( ! mdoc_word_alloc(mdoc, line, la, p)) + return(0); + mdoc->next = MDOC_NEXT_SIBLING; } - if (MDOC_LINEARG_MAX == (argc + sz)) { - mdoc_argv_free(argc, argv); - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + if (0 == lastpunct && ! rewind_elem(mdoc, tok)) + return(0); + if (ppos > 1) + return(1); + return(append_delims(mdoc, line, pos, buf)); +} + + +/* + * Handle explicit-scope (having a different closure token) and implicit + * scope (closing out prior scopes when re-invoked) macros. These + * constitute the BLOCK type and usually span multiple lines. These + * always have HEAD and sometimes have BODY types. In the multi-line + * case: + * + * .Bd -ragged + * Text. + * .Fl macro + * Another. + * .Ed + * + * BLOCK (.Bd) + * HEAD + * BODY + * TEXT (`Text.') + * ELEMENT (.Fl) + * TEXT (`macro') + * TEXT (`Another.') + * + * Note that the `.It' macro, possibly the most difficult (as it has + * embedded scope, etc.) is handled by this routine. It handles + * columnar output, where columns are "phrases" and denote multiple + * block heads. + */ +static int +macro_scoped(MACRO_PROT_ARGS) +{ + int c, lastarg, reopen; + struct mdoc_arg *arg; + char *p; + + assert ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)); + + /* First rewind extant implicit scope. */ + + if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) { + if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos)) + return(0); + if ( ! rewind_impblock(mdoc, tok, line, ppos)) + return(0); } - /* Post-processing. */ + /* Parse arguments. */ + + arg = NULL; - if ( ! mdoc_valid_pre(mdoc, tok, ppos, sz, _CC(args), argc, argv)) { - mdoc_argv_free(argc, argv); + for (;;) { + lastarg = *pos; + c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); + if (ARGV_EOLN == c) + break; + if (ARGV_WORD == c) { + *pos = lastarg; + break; + } else if (ARGV_ARG == c) + continue; + mdoc_argv_free(arg); return(0); } - switch (tok) { - case (MDOC_Sh): - sec = mdoc_atosec((size_t)sz, _CC(args)); - if (SEC_CUSTOM != sec) - mdoc->sec_lastn = sec; - mdoc->sec_last = sec; - break; - default: - break; - } + if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, arg)) + return(0); - mdoc_block_alloc(mdoc, ppos, tok, (size_t)argc, argv); mdoc->next = MDOC_NEXT_CHILD; - mdoc_argv_free(argc, argv); + if (0 == buf[*pos]) { + if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) + return(0); + if ( ! rewind_subblock(MDOC_HEAD, mdoc, + tok, line, ppos)) + return(0); + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + return(0); + mdoc->next = MDOC_NEXT_CHILD; + return(1); + } - mdoc_head_alloc(mdoc, ppos, tok); + if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) + return(0); + + /* Indicate that columnar scope shouldn't be reopened. */ + reopen = 0; mdoc->next = MDOC_NEXT_CHILD; - for (i = 0; i < sz; i++) { - mdoc_word_alloc(mdoc, ppos, args[i]); - mdoc->next = MDOC_NEXT_SIBLING; - } + for (;;) { + lastarg = *pos; + c = mdoc_args(mdoc, line, pos, buf, tok, &p); - if ( ! scope_rewind_line(mdoc, ppos, tok)) + if (ARGS_ERROR == c) + return(0); + if (ARGS_EOLN == c) + break; + if (ARGS_PHRASE == c) { + if (reopen && ! mdoc_head_alloc(mdoc, line, ppos, tok)) + return(0); + mdoc->next = MDOC_NEXT_CHILD; + + /* + * Phrases are self-contained macro phrases used + * in the columnar output of a macro. They need + * special handling. + */ + if ( ! macro_phrase(mdoc, line, lastarg, buf)) + return(0); + if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) + return(0); + + reopen = 1; + continue; + } + + if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) + return(0); + + if (MDOC_MAX == c) { + if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + return(0); + mdoc->next = MDOC_NEXT_SIBLING; + continue; + } + + if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) + return(0); + break; + } + + if (1 == ppos && ! append_delims(mdoc, line, pos, buf)) return(0); + if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) + return(0); - mdoc_body_alloc(mdoc, ppos, tok); + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + return(0); mdoc->next = MDOC_NEXT_CHILD; return(1); } -int +/* + * This handles a case of implicitly-scoped macro (BLOCK) limited to a + * single line. Instead of being closed out by a subsequent call to + * another macro, the scope is closed at the end of line. These don't + * have BODY or TAIL types. Notice that the punctuation falls outside + * of the HEAD type. + * + * .Qq a Fl b Ar d ; ; + * + * BLOCK (Qq) + * HEAD + * TEXT (`a') + * ELEMENT (.Fl) + * TEXT (`b') + * ELEMENT (.Ar) + * TEXT (`d') + * TEXT (`;') + * TEXT (`;') + */ +static int macro_scoped_line(MACRO_PROT_ARGS) { - int lastarg, c, j; + int lastarg, c; char *p; - assert(1 == ppos); - - mdoc_block_alloc(mdoc, ppos, tok, 0, NULL); + if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL)) + return(0); mdoc->next = MDOC_NEXT_CHILD; - mdoc_head_alloc(mdoc, ppos, tok); + if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) + return(0); + mdoc->next = MDOC_NEXT_SIBLING; + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + return(0); mdoc->next = MDOC_NEXT_CHILD; - if ( ! mdoc_valid_pre(mdoc, tok, ppos, 0, NULL, 0, NULL)) - return(0); + /* XXX - no known argument macros. */ - /* Process line parameters. */ - - j = 0; lastarg = ppos; + for (;;) { + lastarg = *pos; + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); -again: - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + if (ARGS_ERROR == c) + return(0); + if (ARGS_PUNCT == c) + break; + if (ARGS_EOLN == c) + break; - lastarg = *pos; - c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p); + if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) + return(0); + else if (MDOC_MAX == c) { + if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + return(0); + mdoc->next = MDOC_NEXT_SIBLING; + continue; + } - switch (c) { - case (ARGS_ERROR): - return(0); - case (ARGS_WORD): + if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) + return(0); break; - case (ARGS_PUNCT): - if (ppos > 1) - return(scope_rewind_imp(mdoc, ppos, tok)); - if ( ! scope_rewind_line(mdoc, ppos, tok)) + } + + if (1 == ppos) { + if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos)) return(0); - if ( ! append_delims(mdoc, tok, pos, buf)) + if ( ! append_delims(mdoc, line, pos, buf)) return(0); - return(scope_rewind_imp(mdoc, ppos, tok)); - case (ARGS_EOLN): - return(scope_rewind_imp(mdoc, ppos, tok)); + } else if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos)) + return(0); + return(rewind_impblock(mdoc, tok, line, ppos)); +} + + +/* + * A constant-scoped macro is like a simple-scoped macro (mdoc_scoped) + * except that it doesn't handle implicit scopes and explicit ones have + * a fixed number of TEXT children to the BODY. + * + * .Fl a So b Sc ; + * + * ELEMENT (.Fl) + * TEXT (`a') + * BLOCK (.So) + * HEAD + * BODY + * TEXT (`b') + * TEXT (';') + */ +static int +macro_constant_scoped(MACRO_PROT_ARGS) +{ + int lastarg, flushed, j, c, maxargs; + char *p; + + lastarg = ppos; + flushed = 0; + + switch (tok) { + case (MDOC_Eo): + maxargs = 1; + break; default: - abort(); - /* NOTREACHED */ + maxargs = 0; + break; } - if (MDOC_MAX != (c = mdoc_find(mdoc, p))) { - if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL)) + return(0); + mdoc->next = MDOC_NEXT_CHILD; + + if (0 == maxargs) { + if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) return(0); - if (ppos > 1) - return(scope_rewind_imp(mdoc, ppos, tok)); - if ( ! scope_rewind_line(mdoc, ppos, tok)) + if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) return(0); - if ( ! append_delims(mdoc, tok, pos, buf)) + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) return(0); - return(scope_rewind_imp(mdoc, ppos, tok)); + flushed = 1; + } else if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) + return(0); + + mdoc->next = MDOC_NEXT_CHILD; + + for (j = 0; /* No sentinel. */; j++) { + lastarg = *pos; + + if (j == maxargs && ! flushed) { + if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) + return(0); + flushed = 1; + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + return(0); + mdoc->next = MDOC_NEXT_CHILD; + } + + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); + + if (ARGS_ERROR == c) + return(0); + if (ARGS_PUNCT == c) + break; + if (ARGS_EOLN == c) + break; + + if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) + return(0); + else if (MDOC_MAX != c) { + if ( ! flushed) { + if ( ! rewind_subblock(MDOC_HEAD, mdoc, + tok, line, ppos)) + return(0); + flushed = 1; + if ( ! mdoc_body_alloc(mdoc, line, + ppos, tok)) + return(0); + mdoc->next = MDOC_NEXT_CHILD; + } + if ( ! mdoc_macro(mdoc, c, line, lastarg, + pos, buf)) + return(0); + break; + } + + if ( ! flushed && mdoc_isdelim(p)) { + if ( ! rewind_subblock(MDOC_HEAD, mdoc, + tok, line, ppos)) + return(0); + flushed = 1; + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + return(0); + mdoc->next = MDOC_NEXT_CHILD; + } + + if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + return(0); + mdoc->next = MDOC_NEXT_SIBLING; } - if (mdoc_isdelim(p)) - j = 0; + if ( ! flushed) { + if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) + return(0); + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + return(0); + mdoc->next = MDOC_NEXT_CHILD; + } - mdoc_word_alloc(mdoc, lastarg, p); - mdoc->next = MDOC_NEXT_SIBLING; - goto again; - /* NOTREACHED */ + if (ppos > 1) + return(1); + return(append_delims(mdoc, line, pos, buf)); } -/* - * FIXME: like in with macro_constant, have the append_ routine chop the - * number of requisite arguments (this is ugly when done in-line). +/* + * A delimited constant is very similar to the macros parsed by + * macro_text except that, in the event of punctuation, the macro isn't + * "re-opened" as it is in macro_text. Also, these macros have a fixed + * number of parameters. + * + * .Fl a No b + * + * ELEMENT (.Fl) + * TEXT (`a') + * ELEMENT (.No) + * TEXT (`b') */ -int +static int macro_constant_delimited(MACRO_PROT_ARGS) { - int lastarg, flushed, c, maxargs; + int lastarg, flushed, j, c, maxargs, + igndelim, ignargs; + struct mdoc_arg *arg; char *p; - /* Process line parameters. */ - lastarg = ppos; flushed = 0; + + /* + * Maximum arguments per macro. Some of these have none and + * exit as soon as they're parsed. + */ - /* Token pre-processing. */ - switch (tok) { + case (MDOC_Ap): + /* FALLTHROUGH */ case (MDOC_No): /* FALLTHROUGH */ case (MDOC_Ns): @@ -584,124 +1282,215 @@ macro_constant_delimited(MACRO_PROT_ARGS) break; } -again: - lastarg = *pos; + /* + * Whether to ignore delimiter characters. `Pf' accepts its + * first token as a parameter no matter what it looks like (if + * it's text). + */ - switch (mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p)) { - case (ARGS_ERROR): - return(0); - case (ARGS_WORD): + switch (tok) { + case (MDOC_Pf): + igndelim = 1; break; - case (ARGS_PUNCT): - if ( ! flushed && ! append_text(mdoc, tok, ppos, 0, &p)) - return(0); - if (ppos > 1) - return(1); - return(append_delims(mdoc, tok, pos, buf)); - case (ARGS_EOLN): - if (flushed) - return(1); - return(append_text(mdoc, tok, ppos, 0, &p)); default: - abort(); - /* NOTREACHED */ + igndelim = 0; + break; } - /* Accepts no arguments: flush out symbol and continue. */ + /* + * Whether to ignore arguments: `St', for example, handles its + * argument-like parameters as regular parameters. + */ - if ( ! flushed && 0 == maxargs) { - if ( ! append_text(mdoc, tok, ppos, 0, &p)) - return(0); - flushed = 1; + switch (tok) { + case (MDOC_St): + ignargs = 1; + break; + default: + ignargs = 0; + break; } - if (MDOC_MAX != (c = mdoc_find(mdoc, p))) { - if ( ! flushed && ! append_text(mdoc, tok, ppos, 0, &p)) + arg = NULL; + + if ( ! ignargs) + for (;;) { + lastarg = *pos; + c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); + if (ARGV_EOLN == c) + break; + if (ARGV_WORD == c) { + *pos = lastarg; + break; + } else if (ARGV_ARG == c) + continue; + mdoc_argv_free(arg); return(0); - if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) - return(0); - if (ppos > 1) - return(1); - return(append_delims(mdoc, tok, pos, buf)); - } + } - /* - * We only accept one argument; subsequent tokens are considered - * as literal words (until a macro). - */ + if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg)) + return(0); - if ( ! flushed && ! mdoc_isdelim(p)) { - if ( ! append_text(mdoc, tok, ppos, 1, &p)) + mdoc->next = MDOC_NEXT_CHILD; + + for (j = 0; /* No sentinel. */; j++) { + lastarg = *pos; + + if (j == maxargs && ! flushed) { + if ( ! rewind_elem(mdoc, tok)) + return(0); + flushed = 1; + } + + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); + + if (ARGS_ERROR == c) return(0); - flushed = 1; - goto again; - } else if ( ! flushed) { - if ( ! append_text(mdoc, tok, ppos, 0, &p)) + if (ARGS_PUNCT == c) + break; + if (ARGS_EOLN == c) + break; + + if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) return(0); - flushed = 1; + else if (MDOC_MAX != c) { + if ( ! flushed && ! rewind_elem(mdoc, tok)) + return(0); + flushed = 1; + if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) + return(0); + break; + } + + if ( ! flushed && mdoc_isdelim(p) && ! igndelim) { + if ( ! rewind_elem(mdoc, tok)) + return(0); + flushed = 1; + } + + if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + return(0); + mdoc->next = MDOC_NEXT_SIBLING; } - mdoc_word_alloc(mdoc, lastarg, p); - mdoc->next = MDOC_NEXT_SIBLING; - goto again; - /* NOTREACHED */ + if ( ! flushed && ! rewind_elem(mdoc, tok)) + return(0); + + if (ppos > 1) + return(1); + return(append_delims(mdoc, line, pos, buf)); } -int +/* + * A constant macro is the simplest classification. It spans an entire + * line. + */ +static int macro_constant(MACRO_PROT_ARGS) { - int c, lastarg, argc, sz, fl; - char *args[MDOC_LINEARG_MAX]; - struct mdoc_arg argv[MDOC_LINEARG_MAX]; + int c, w, la; + struct mdoc_arg *arg; + char *p; - fl = 0; - if (MDOC_QUOTABLE & mdoc_macros[tok].flags) - fl = ARGS_QUOTED; + arg = NULL; - for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) { - lastarg = *pos; - c = mdoc_argv(mdoc, tok, &argv[argc], pos, buf); + for (;;) { + la = *pos; + c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); if (ARGV_EOLN == c) break; - else if (ARGV_ARG == c) - continue; - else if (ARGV_WORD == c) + if (ARGV_WORD == c) { + *pos = la; break; - - mdoc_argv_free(argc, argv); + } else if (ARGV_ARG == c) + continue; + mdoc_argv_free(arg); return(0); } - if (MDOC_LINEARG_MAX == argc) { - mdoc_argv_free(argc, argv); - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); - } + if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg)) + return(0); - for (sz = 0; sz + argc < MDOC_LINEARG_MAX; sz++) { - lastarg = *pos; - c = mdoc_args(mdoc, tok, pos, buf, fl, &args[sz]); - if (ARGS_ERROR == c) + mdoc->next = MDOC_NEXT_CHILD; + + for (;;) { + la = *pos; + w = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); + + if (ARGS_ERROR == w) return(0); - if (ARGS_EOLN == c) + if (ARGS_EOLN == w) break; - } - if (MDOC_LINEARG_MAX == sz + argc) { - mdoc_argv_free(argc, argv); - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + c = ARGS_QWORD == w ? MDOC_MAX : + lookup(mdoc, line, la, tok, p); + + if (MDOC_MAX != c && -1 != c) { + if ( ! rewind_elem(mdoc, tok)) + return(0); + return(mdoc_macro(mdoc, c, line, la, pos, buf)); + } else if (-1 == c) + return(0); + + if ( ! mdoc_word_alloc(mdoc, line, la, p)) + return(0); + mdoc->next = MDOC_NEXT_SIBLING; } - c = append_text_argv(mdoc, tok, ppos, sz, args, argc, argv); - mdoc_argv_free(argc, argv); - return(c); + return(rewind_elem(mdoc, tok)); } /* ARGSUSED */ -int +static int macro_obsolete(MACRO_PROT_ARGS) { - return(mdoc_warn(mdoc, tok, ppos, WARN_IGN_OBSOLETE)); + return(pwarn(mdoc, line, ppos, WOBS)); +} + + +static int +macro_phrase(struct mdoc *mdoc, int line, int ppos, char *buf) +{ + int i, la, c; + + for (i = ppos; buf[i]; ) { + assert(' ' != buf[i]); + + la = i; + if ('\"' == buf[i]) { + la = ++i; + while (buf[i] && '\"' != buf[i]) + i++; + if (0 == buf[i]) + return(mdoc_err(mdoc, "unterminated quoted parameter")); + } else + while (buf[i] && ! isspace ((unsigned char)buf[i])) + i++; + + if (buf[i]) + buf[i++] = 0; + + while (buf[i] && isspace((unsigned char)buf[i])) + i++; + + if (MDOC_MAX != (c = mdoc_tokhash_find(mdoc->htab, &buf[la]))) { + if ( ! mdoc_macro(mdoc, c, line, la, &i, buf)) + return(0); + return(append_delims(mdoc, line, &i, buf)); + } + + if ( ! mdoc_word_alloc(mdoc, line, la, &buf[la])) + return(0); + mdoc->next = MDOC_NEXT_SIBLING; + + while (buf[i] && isspace((unsigned char)buf[i])) + i++; + } + + return(1); }