=================================================================== RCS file: /cvs/mandoc/Attic/macro.c,v retrieving revision 1.24 retrieving revision 1.54 diff -u -p -r1.24 -r1.54 --- mandoc/Attic/macro.c 2009/01/06 15:49:44 1.24 +++ mandoc/Attic/macro.c 2009/02/27 09:39:40 1.54 @@ -1,4 +1,4 @@ -/* $Id: macro.c,v 1.24 2009/01/06 15:49:44 kristaps Exp $ */ +/* $Id: macro.c,v 1.54 2009/02/27 09:39:40 kristaps Exp $ */ /* * Copyright (c) 2008 Kristaps Dzonsons * @@ -25,158 +25,558 @@ #include #endif +/* + * 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. + */ + #include "private.h" -/* FIXME: maxlineargs should be per LINE, no per TOKEN. */ +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 rewind_elem(struct mdoc *, int, int); -static int rewind_impblock(struct mdoc *, int, int); +#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_head(struct mdoc *, int, int); -static int rewind_body(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, const 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); +#define WMACPARM (1) +#define WOBS (2) +#define ENOCTX (1) +#define ENOPARMS (2) +#define EARGVLIM (3) + +/* 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, 0 }, /* 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 */ +}; + +const struct mdoc_macro * const mdoc_macros = __mdoc_macros; + + static int -lookup(struct mdoc *mdoc, int from, const char *p) +perr(struct mdoc *mdoc, int line, int pos, int type) { + int c; - if ( ! (MDOC_PARSED & mdoc_macros[from].flags)) - return(MDOC_MAX); - return(mdoc_find(mdoc, p)); + switch (type) { + case (ENOCTX): + c = mdoc_perr(mdoc, line, pos, + "closing macro has prior context"); + break; + case (ENOPARMS): + c = mdoc_perr(mdoc, line, pos, + "macro doesn't expect parameters"); + break; + case (EARGVLIM): + c = mdoc_perr(mdoc, line, pos, + "argument hard-limit %d reached", + MDOC_LINEARG_MAX); + break; + default: + abort(); + /* NOTREACHED */ + } + return(c); } +static int +pwarn(struct mdoc *mdoc, int line, int pos, int type) +{ + int c; + 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 -rewind_elem(struct mdoc *mdoc, int ppos, int tok) +lookup(struct mdoc *mdoc, int line, int pos, int from, const char *p) { - struct mdoc_node *n; + int res; - n = mdoc->last; - if (MDOC_ELEM != n->type) - n = n->parent; - assert(MDOC_ELEM == n->type); - assert(tok == n->data.elem.tok); + res = mdoc_find(mdoc, 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); +} - mdoc->last = n; + +static int +rewind_last(struct mdoc *mdoc, struct mdoc_node *to) +{ + + assert(to); mdoc->next = MDOC_NEXT_SIBLING; - if ( ! mdoc_valid_post(mdoc, tok, ppos)) + + /* LINTED */ + while (mdoc->last != to) { + if ( ! mdoc_valid_post(mdoc)) + return(0); + if ( ! mdoc_action_post(mdoc)) + return(0); + mdoc->last = mdoc->last->parent; + assert(mdoc->last); + } + + if ( ! mdoc_valid_post(mdoc)) return(0); - return(mdoc_action(mdoc, tok, ppos)); + return(mdoc_action_post(mdoc)); } static int -rewind_body(struct mdoc *mdoc, int ppos, int tok, int tt) +rewind_alt(int tok) { - struct mdoc_node *n; + switch (tok) { + case (MDOC_Ac): + return(MDOC_Ao); + case (MDOC_Bc): + return(MDOC_Bo); + 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; + } + abort(); + /* NOTREACHED */ +} - /* LINTED */ - for (n = mdoc->last; n; n = n->parent) { - if (MDOC_BODY != n->type) - continue; - if (tt == n->data.head.tok) - break; - if ( ! (MDOC_EXPLICIT & mdoc_macros[tt].flags)) - continue; - return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK)); + +static int +rewind_dohalt(int tok, enum mdoc_type type, const struct mdoc_node *p) +{ + + if (MDOC_ROOT == p->type) + return(REWIND_HALT); + if (MDOC_VALID & p->flags) + return(REWIND_NOHALT); + + switch (tok) { + /* One-liner implicit-scope. */ + case (MDOC_Aq): + /* FALLTHROUGH */ + case (MDOC_Bq): + /* 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; + + /* 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_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; + + /* Multi-line explicit scope close. */ + case (MDOC_Ac): + /* FALLTHROUGH */ + case (MDOC_Bc): + /* 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->last = n ? n : mdoc->last; - mdoc->next = MDOC_NEXT_SIBLING; - /* XXX - no validation, we do this only for blocks/elements. */ - return(1); + return(REWIND_NOHALT); } static int -rewind_head(struct mdoc *mdoc, int ppos, int tok) +rewind_dobreak(int tok, const struct mdoc_node *p) { + + 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) { + /* 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); + return(MDOC_Sh == p->tok); + + /* Extra scope rules. */ + case (MDOC_El): + if (MDOC_It == p->tok) + return(1); + break; + default: + break; + } + + if (MDOC_EXPLICIT & mdoc_macros[tok].flags) + return(p->tok == rewind_alt(tok)); + else if (MDOC_BLOCK == p->type) + return(1); + + return(tok == p->tok); +} + + +static int +rewind_elem(struct mdoc *mdoc, int tok) +{ struct mdoc_node *n; - int t; + n = mdoc->last; + if (MDOC_ELEM != n->type) + n = n->parent; + assert(MDOC_ELEM == n->type); + assert(tok == n->tok); + + return(rewind_last(mdoc, n)); +} + + +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) { - if (MDOC_HEAD != n->type) - continue; - if (tok == (t = n->data.head.tok)) + c = rewind_dohalt(tok, type, n); + if (REWIND_HALT == c) + return(1); + if (REWIND_REWIND == c) break; - if ( ! (MDOC_EXPLICIT & mdoc_macros[t].flags)) + else if (rewind_dobreak(tok, n)) continue; - return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK)); + return(mdoc_perr(mdoc, line, ppos, "scope breaks prior %s", mdoc_node2a(n))); } - mdoc->last = n ? n : mdoc->last; - mdoc->next = MDOC_NEXT_SIBLING; - /* XXX - no validation, we do this only for blocks/elements. */ - return(1); + assert(n); + return(rewind_last(mdoc, n)); } static int -rewind_expblock(struct mdoc *mdoc, int ppos, int tok, int tt) +rewind_expblock(struct mdoc *mdoc, int tok, int line, int ppos) { struct mdoc_node *n; - int t; + int c; - assert(mdoc->last); - /* LINTED */ - for (n = mdoc->last->parent; n; n = n->parent) { - if (MDOC_BLOCK != n->type) - continue; - if (tt == (t = n->data.block.tok)) + 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; - if (MDOC_NESTED & mdoc_macros[t].flags) + else if (rewind_dobreak(tok, n)) continue; - return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK)); + return(mdoc_perr(mdoc, line, ppos, + "scope breaks prior %s", + mdoc_node2a(n))); } - if (NULL == (mdoc->last = n)) - return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_NOCTX)); - - mdoc->next = MDOC_NEXT_SIBLING; - if ( ! mdoc_valid_post(mdoc, tok, ppos)) - return(0); - return(mdoc_action(mdoc, tok, ppos)); + assert(n); + return(rewind_last(mdoc, n)); } static int -rewind_impblock(struct mdoc *mdoc, int ppos, int tok) +rewind_impblock(struct mdoc *mdoc, int tok, int line, int ppos) { struct mdoc_node *n; - int t; + int c; - n = mdoc->last ? mdoc->last->parent : NULL; - /* LINTED */ - for ( ; n; n = n->parent) { - if (MDOC_BLOCK != n->type) - continue; - if (tok == (t = n->data.block.tok)) + 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; - if ( ! (MDOC_EXPLICIT & mdoc_macros[t].flags)) + else if (rewind_dobreak(tok, n)) continue; - if (MDOC_NESTED & mdoc_macros[tok].flags) - return(1); - return(mdoc_err(mdoc, tok, ppos, ERR_SCOPE_BREAK)); + return(mdoc_perr(mdoc, line, ppos, + "scope breaks prior %s", + mdoc_node2a(n))); } - if (NULL == n) - return(1); - - mdoc->next = MDOC_NEXT_SIBLING; - mdoc->last = n; - if ( ! mdoc_valid_post(mdoc, tok, ppos)) - return(0); - return(mdoc_action(mdoc, tok, ppos)); + assert(n); + return(rewind_last(mdoc, n)); } static int -append_delims(struct mdoc *mdoc, int tok, int *pos, char *buf) +append_delims(struct mdoc *mdoc, int line, int *pos, char *buf) { int c, lastarg; char *p; @@ -186,13 +586,16 @@ append_delims(struct mdoc *mdoc, int tok, int *pos, ch for (;;) { lastarg = *pos; - c = mdoc_args(mdoc, tok, pos, buf, 0, &p); + 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)); - mdoc_word_alloc(mdoc, lastarg, p); + if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + return(0); mdoc->next = MDOC_NEXT_SIBLING; } @@ -200,66 +603,18 @@ append_delims(struct mdoc *mdoc, int tok, int *pos, ch } -/* ARGSUSED */ -int -macro_close_explicit(MACRO_PROT_ARGS) +/* + * 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; + int tt, j, c, lastarg, maxargs, flushed; char *p; switch (tok) { - case (MDOC_Ac): - tt = MDOC_Ao; - break; - case (MDOC_Bc): - tt = MDOC_Bo; - break; - case (MDOC_Dc): - tt = MDOC_Do; - break; case (MDOC_Ec): - tt = MDOC_Eo; - break; - case (MDOC_Ed): - tt = MDOC_Bd; - break; - case (MDOC_Ef): - tt = MDOC_Bf; - break; - case (MDOC_Ek): - tt = MDOC_Bk; - break; - case (MDOC_El): - tt = MDOC_Bl; - break; - case (MDOC_Fc): - tt = MDOC_Fo; - break; - case (MDOC_Oc): - tt = MDOC_Oo; - break; - case (MDOC_Pc): - tt = MDOC_Po; - break; - case (MDOC_Qc): - tt = MDOC_Qo; - break; - case (MDOC_Re): - tt = MDOC_Rs; - break; - case (MDOC_Sc): - tt = MDOC_So; - break; - case (MDOC_Xc): - tt = MDOC_Xo; - break; - default: - abort(); - /* NOTREACHED */ - } - - switch (tok) { - case (MDOC_Ec): maxargs = 1; break; default: @@ -267,35 +622,45 @@ macro_close_explicit(MACRO_PROT_ARGS) break; } + tt = rewind_alt(tok); + + mdoc_msg(mdoc, "parse: %s closing %s", + mdoc_macronames[tok], mdoc_macronames[tt]); + if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) { - if ( ! rewind_expblock(mdoc, ppos, tok, tt)) - return(0); - if (0 != buf[*pos]) - return(mdoc_err(mdoc, tok, *pos, ERR_ARGS_EQ0)); - return(1); + 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)); } - if ( ! rewind_body(mdoc, ppos, tok, tt)) + if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos)) return(0); lastarg = ppos; flushed = 0; if (maxargs > 0) { - mdoc_tail_alloc(mdoc, ppos, tt); + if ( ! mdoc_tail_alloc(mdoc, line, ppos, tt)) + return(0); mdoc->next = MDOC_NEXT_CHILD; } - for (j = 0; j < MDOC_LINEARG_MAX; j++) { + for (j = 0; /* No sentinel. */; j++) { lastarg = *pos; if (j == maxargs && ! flushed) { - if ( ! rewind_expblock(mdoc, ppos, tok, tt)) + if ( ! rewind_expblock(mdoc, tok, line, ppos)) return(0); flushed = 1; } - c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p); + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); + if (ARGS_ERROR == c) return(0); if (ARGS_PUNCT == c) @@ -303,213 +668,295 @@ macro_close_explicit(MACRO_PROT_ARGS) if (ARGS_EOLN == c) break; - if (MDOC_MAX != (c = lookup(mdoc, tok, p))) { + if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) + return(0); + else if (MDOC_MAX != c) { if ( ! flushed) { - if ( ! rewind_expblock(mdoc, ppos, tok, tt)) + if ( ! rewind_expblock(mdoc, tok, + line, ppos)) return(0); flushed = 1; } - if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) return(0); break; - } + } - mdoc_word_alloc(mdoc, lastarg, p); + if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + return(0); mdoc->next = MDOC_NEXT_SIBLING; } - if (MDOC_LINEARG_MAX == j) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + if ( ! flushed && ! rewind_expblock(mdoc, tok, line, ppos)) + return(0); - if ( ! flushed) - if ( ! rewind_expblock(mdoc, ppos, tok, tt)) - return(0); - if (ppos > 1) return(1); - return(append_delims(mdoc, tok, pos, buf)); + return(append_delims(mdoc, line, pos, buf)); } /* - * A general text domain macro. When invoked, this opens a scope that - * accepts words until either end-of-line, only-punctuation, or a - * callable macro. If the word is punctuation (not only-punctuation), - * then the scope is closed out, the punctuation appended, then the - * scope opened again. If any terminating conditions are met, the scope - * is closed out. If this is the first macro in the line and - * only-punctuation remains, this punctuation is flushed. + * 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 (`;') */ -int +static int macro_text(MACRO_PROT_ARGS) { - int lastarg, lastpunct, c, sz, fl, argc; + int la, lastpunct, c, w, argc; struct mdoc_arg argv[MDOC_LINEARG_MAX]; char *p; - lastarg = ppos; + la = ppos; lastpunct = 0; 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) + la = *pos; + c = mdoc_argv(mdoc, line, tok, &argv[argc], 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); return(0); } - if ( ! mdoc_valid_pre(mdoc, tok, ppos, argc, argv)) { + if (MDOC_LINEARG_MAX == argc) { + mdoc_argv_free(argc - 1, argv); + return(perr(mdoc, line, ppos, EARGVLIM)); + } + + c = mdoc_elem_alloc(mdoc, line, ppos, + tok, (size_t)argc, argv); + + if (0 == c) { mdoc_argv_free(argc, argv); return(0); } - fl = ARGS_DELIM; - if (MDOC_QUOTABLE & mdoc_macros[tok].flags) - fl |= ARGS_QUOTED; - - mdoc_elem_alloc(mdoc, lastarg, tok, argc, argv); mdoc->next = MDOC_NEXT_CHILD; - for (lastpunct = sz = 0; sz + argc < MDOC_LINEARG_MAX; sz++) { - lastarg = *pos; + lastpunct = 0; + for (;;) { + la = *pos; + w = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); - if (lastpunct) { - mdoc_elem_alloc(mdoc, lastarg, tok, argc, argv); - mdoc->next = MDOC_NEXT_CHILD; - lastpunct = 0; - } - - c = mdoc_args(mdoc, tok, pos, buf, fl, &p); - if (ARGS_ERROR == c) { + if (ARGS_ERROR == w) { mdoc_argv_free(argc, argv); return(0); } - if (ARGS_EOLN == c) + if (ARGS_EOLN == w) break; - if (ARGS_PUNCT == c) + if (ARGS_PUNCT == w) break; - if (MDOC_MAX != (c = lookup(mdoc, tok, p))) { - if ( ! rewind_elem(mdoc, ppos, tok)) { + c = ARGS_QWORD == w ? MDOC_MAX : + lookup(mdoc, line, la, tok, p); + + if (MDOC_MAX != c && -1 != c) { + if (0 == lastpunct && ! rewind_elem(mdoc, tok)) { mdoc_argv_free(argc, argv); return(0); } mdoc_argv_free(argc, argv); - if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + c = mdoc_macro(mdoc, c, line, la, pos, buf); + if (0 == c) return(0); if (ppos > 1) return(1); - return(append_delims(mdoc, tok, pos, buf)); + return(append_delims(mdoc, line, pos, buf)); + } else if (-1 == c) { + mdoc_argv_free(argc, argv); + return(0); } - if (mdoc_isdelim(p)) { - if ( ! rewind_elem(mdoc, ppos, tok)) { + if (ARGS_QWORD != w && mdoc_isdelim(p)) { + if (0 == lastpunct && ! rewind_elem(mdoc, tok)) { mdoc_argv_free(argc, argv); return(0); } lastpunct = 1; + } else if (lastpunct) { + c = mdoc_elem_alloc(mdoc, line, ppos, + tok, (size_t)argc, argv); + if (0 == c) { + mdoc_argv_free(argc, argv); + return(0); + } + mdoc->next = MDOC_NEXT_CHILD; + lastpunct = 0; } - mdoc_word_alloc(mdoc, lastarg, p); + + if ( ! mdoc_word_alloc(mdoc, line, la, p)) + return(0); mdoc->next = MDOC_NEXT_SIBLING; } mdoc_argv_free(argc, argv); - if (sz == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); - - if ( ! rewind_elem(mdoc, ppos, tok)) + if (0 == lastpunct && ! rewind_elem(mdoc, tok)) return(0); if (ppos > 1) return(1); - return(append_delims(mdoc, tok, pos, buf)); + return(append_delims(mdoc, line, pos, buf)); } /* - * Multi-line-scoped macro. + * 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. */ -int +static int macro_scoped(MACRO_PROT_ARGS) { - int c, lastarg, argc, j; + int c, lastarg, argc; struct mdoc_arg argv[MDOC_LINEARG_MAX]; char *p; assert ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)); - if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) - if ( ! rewind_impblock(mdoc, ppos, tok)) + /* 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); + } - lastarg = ppos; + /* Parse arguments. */ 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) + c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf); + if (ARGV_EOLN == c) break; - else if (ARGV_ARG == c) + if (ARGV_WORD == c) { + *pos = lastarg; + break; + } else if (ARGV_ARG == c) continue; mdoc_argv_free(argc, argv); return(0); } - if ( ! mdoc_valid_pre(mdoc, tok, ppos, argc, argv)) { - mdoc_argv_free(argc, argv); - return(0); + if (MDOC_LINEARG_MAX == argc) { + mdoc_argv_free(argc - 1, argv); + return(perr(mdoc, line, ppos, EARGVLIM)); } - mdoc_block_alloc(mdoc, ppos, tok, (size_t)argc, argv); - mdoc->next = MDOC_NEXT_CHILD; - + c = mdoc_block_alloc(mdoc, line, ppos, + tok, (size_t)argc, argv); mdoc_argv_free(argc, argv); + if (0 == c) + return(0); + + mdoc->next = MDOC_NEXT_CHILD; + if (0 == buf[*pos]) { - mdoc_body_alloc(mdoc, ppos, tok); + 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); mdoc->next = MDOC_NEXT_CHILD; - for (j = 0; j < MDOC_LINEARG_MAX; j++) { + for (;;) { lastarg = *pos; - c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p); - + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + if (ARGS_ERROR == c) return(0); - if (ARGS_PUNCT == c) - break; if (ARGS_EOLN == c) break; + if (ARGS_PHRASE == c) { + /* + if ( ! mdoc_phrase(mdoc, line, lastarg, buf)) + return(0); + */ + continue; + } + + /* FIXME: if .It -column, the lookup must be for a + * sub-line component. BLAH. */ - if (MDOC_MAX == (c = lookup(mdoc, tok, p))) { - mdoc_word_alloc(mdoc, lastarg, p); + 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, lastarg, pos, buf)) + if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) return(0); break; } - - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); - - if ( ! rewind_head(mdoc, ppos, tok)) + + if (1 == ppos && ! append_delims(mdoc, line, pos, buf)) return(0); - if (1 == ppos && ! append_delims(mdoc, tok, pos, buf)) + 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); @@ -517,32 +964,48 @@ macro_scoped(MACRO_PROT_ARGS) /* - * When scoped to a line, a macro encompasses all of the contents. This - * differs from constants or text macros, where a new macro will - * terminate the existing context. + * 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 (`;') */ -int +static int macro_scoped_line(MACRO_PROT_ARGS) { - int lastarg, c, j; + int lastarg, c; char *p; - mdoc_block_alloc(mdoc, ppos, tok, 0, NULL); + if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, 0, 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; /* XXX - no known argument macros. */ - if ( ! mdoc_valid_pre(mdoc, tok, ppos, 0, NULL)) - return(0); - - /* Process line parameters. */ - - for (lastarg = ppos, j = 0; j < MDOC_LINEARG_MAX; j++) { + lastarg = ppos; + for (;;) { lastarg = *pos; - c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p); + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); if (ARGS_ERROR == c) return(0); @@ -551,31 +1014,47 @@ macro_scoped_line(MACRO_PROT_ARGS) if (ARGS_EOLN == c) break; - if (MDOC_MAX == (c = lookup(mdoc, tok, p))) { - mdoc_word_alloc(mdoc, lastarg, 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; - } + } - if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) return(0); break; } - if (j == MDOC_LINEARG_MAX) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); - if (1 == ppos) { - if ( ! rewind_head(mdoc, ppos, tok)) + 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(rewind_impblock(mdoc, ppos, tok)); + } else if ( ! rewind_subblock(MDOC_BODY, mdoc, tok, line, ppos)) + return(0); + return(rewind_impblock(mdoc, tok, line, ppos)); } -int +/* + * 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; @@ -593,32 +1072,38 @@ macro_constant_scoped(MACRO_PROT_ARGS) break; } - if ( ! mdoc_valid_pre(mdoc, tok, ppos, 0, NULL)) - return(0); - - mdoc_block_alloc(mdoc, ppos, tok, 0, NULL); + if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, 0, NULL)) + return(0); mdoc->next = MDOC_NEXT_CHILD; if (0 == maxargs) { - mdoc_body_alloc(mdoc, ppos, tok); + 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); flushed = 1; - } else - mdoc_head_alloc(mdoc, ppos, tok); + } else if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) + return(0); mdoc->next = MDOC_NEXT_CHILD; - for (j = 0; j < MDOC_LINEARG_MAX; j++) { + for (j = 0; /* No sentinel. */; j++) { lastarg = *pos; if (j == maxargs && ! flushed) { - if ( ! rewind_head(mdoc, ppos, tok)) + if ( ! rewind_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) return(0); flushed = 1; - mdoc_body_alloc(mdoc, ppos, tok); + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + return(0); mdoc->next = MDOC_NEXT_CHILD; } - c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p); + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); + if (ARGS_ERROR == c) return(0); if (ARGS_PUNCT == c) @@ -626,57 +1111,72 @@ macro_constant_scoped(MACRO_PROT_ARGS) if (ARGS_EOLN == c) break; - if (MDOC_MAX != (c = lookup(mdoc, tok, p))) { + if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) + return(0); + else if (MDOC_MAX != c) { if ( ! flushed) { - if ( ! rewind_head(mdoc, ppos, tok)) + if ( ! rewind_subblock(MDOC_HEAD, mdoc, + tok, line, ppos)) return(0); flushed = 1; - mdoc_body_alloc(mdoc, ppos, tok); + if ( ! mdoc_body_alloc(mdoc, line, + ppos, tok)) + return(0); mdoc->next = MDOC_NEXT_CHILD; } - if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + if ( ! mdoc_macro(mdoc, c, line, lastarg, + pos, buf)) return(0); break; } if ( ! flushed && mdoc_isdelim(p)) { - if ( ! rewind_head(mdoc, ppos, tok)) + if ( ! rewind_subblock(MDOC_HEAD, mdoc, + tok, line, ppos)) return(0); flushed = 1; - mdoc_body_alloc(mdoc, ppos, tok); + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + return(0); mdoc->next = MDOC_NEXT_CHILD; } - mdoc_word_alloc(mdoc, lastarg, p); + if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + return(0); mdoc->next = MDOC_NEXT_SIBLING; } - if (MDOC_LINEARG_MAX == j) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); - if ( ! flushed) { - if ( ! rewind_head(mdoc, ppos, tok)) + 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; } if (ppos > 1) return(1); - return(append_delims(mdoc, tok, pos, buf)); + return(append_delims(mdoc, line, pos, buf)); } /* - * Delimited macros are like text macros except that, should punctuation - * be encountered, the macro isn't re-started with remaining tokens - * (it's only emitted once). Delimited macros can have a maximum number - * of arguments. + * 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, j, c, maxargs, argc; + int lastarg, flushed, j, c, maxargs, argc, + igndelim; struct mdoc_arg argv[MDOC_LINEARG_MAX]; char *p; @@ -698,37 +1198,56 @@ macro_constant_delimited(MACRO_PROT_ARGS) break; } + switch (tok) { + case (MDOC_Pf): + igndelim = 1; + break; + default: + igndelim = 0; + break; + } + 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) + c = mdoc_argv(mdoc, line, tok, &argv[argc], pos, buf); + if (ARGV_EOLN == c) break; - else if (ARGV_ARG == c) + if (ARGV_WORD == c) { + *pos = lastarg; + break; + } else if (ARGV_ARG == c) continue; mdoc_argv_free(argc, argv); return(0); } - if ( ! mdoc_valid_pre(mdoc, tok, ppos, argc, argv)) { - mdoc_argv_free(argc, argv); - return(0); + if (MDOC_LINEARG_MAX == argc) { + mdoc_argv_free(argc - 1, argv); + return(perr(mdoc, line, ppos, EARGVLIM)); } - mdoc_elem_alloc(mdoc, lastarg, tok, argc, argv); - mdoc->next = MDOC_NEXT_CHILD; + c = mdoc_elem_alloc(mdoc, line, ppos, + tok, (size_t)argc, argv); mdoc_argv_free(argc, argv); - for (j = 0; j < MDOC_LINEARG_MAX; j++) { + if (0 == c) + return(0); + + mdoc->next = MDOC_NEXT_CHILD; + + for (j = 0; /* No sentinel. */; j++) { lastarg = *pos; if (j == maxargs && ! flushed) { - if ( ! rewind_elem(mdoc, ppos, tok)) + if ( ! rewind_elem(mdoc, tok)) return(0); flushed = 1; } - c = mdoc_args(mdoc, tok, pos, buf, ARGS_DELIM, &p); + c = mdoc_args(mdoc, line, pos, buf, tok, &p); + assert(ARGS_PHRASE != c); + if (ARGS_ERROR == c) return(0); if (ARGS_PUNCT == c) @@ -736,102 +1255,144 @@ macro_constant_delimited(MACRO_PROT_ARGS) if (ARGS_EOLN == c) break; - if (MDOC_MAX != (c = lookup(mdoc, tok, p))) { - if ( ! flushed && ! rewind_elem(mdoc, ppos, tok)) + if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) + return(0); + else if (MDOC_MAX != c) { + if ( ! flushed && ! rewind_elem(mdoc, tok)) return(0); flushed = 1; - if ( ! mdoc_macro(mdoc, c, lastarg, pos, buf)) + if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) return(0); break; } - if ( ! flushed && mdoc_isdelim(p)) { - if ( ! rewind_elem(mdoc, ppos, tok)) + if ( ! flushed && mdoc_isdelim(p) && ! igndelim) { + if ( ! rewind_elem(mdoc, tok)) return(0); flushed = 1; } - mdoc_word_alloc(mdoc, lastarg, p); + if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + return(0); mdoc->next = MDOC_NEXT_SIBLING; } - if (MDOC_LINEARG_MAX == j) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); - - if ( ! flushed && rewind_elem(mdoc, ppos, tok)) + if ( ! flushed && ! rewind_elem(mdoc, tok)) return(0); if (ppos > 1) return(1); - return(append_delims(mdoc, tok, pos, buf)); + return(append_delims(mdoc, line, pos, buf)); } /* - * Constant macros span an entire line: they constitute a macro and all - * of its arguments and child data. + * A constant macro is the simplest classification. It spans an entire + * line. */ -int +static int macro_constant(MACRO_PROT_ARGS) { - int c, lastarg, argc, sz, fl; - struct mdoc_arg argv[MDOC_LINEARG_MAX]; - char *p; + int c, w, la, argc; + struct mdoc_arg argv[MDOC_LINEARG_MAX]; + char *p; - /*assert( ! (MDOC_PARSED & mdoc_macros[tok].flags));*/ - /*FIXME*/ + assert( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)); - fl = 0; - if (MDOC_QUOTABLE & mdoc_macros[tok].flags) - fl = ARGS_QUOTED; - for (argc = 0; argc < MDOC_LINEARG_MAX; argc++) { - lastarg = *pos; - c = mdoc_argv(mdoc, tok, &argv[argc], pos, buf); + la = *pos; + c = mdoc_argv(mdoc, line, tok, &argv[argc], 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; + } else if (ARGV_ARG == c) + continue; mdoc_argv_free(argc, argv); return(0); } if (MDOC_LINEARG_MAX == argc) { - mdoc_argv_free(argc, argv); - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); + mdoc_argv_free(argc - 1, argv); + return(perr(mdoc, line, ppos, EARGVLIM)); } - mdoc_elem_alloc(mdoc, ppos, tok, argc, argv); - mdoc->next = MDOC_NEXT_CHILD; + c = mdoc_elem_alloc(mdoc, line, ppos, + tok, (size_t)argc, argv); mdoc_argv_free(argc, argv); - for (sz = 0; sz + argc < MDOC_LINEARG_MAX; sz++) { - lastarg = *pos; - c = mdoc_args(mdoc, tok, pos, buf, fl, &p); - if (ARGS_ERROR == c) + if (0 == c) + return(0); + + 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; - mdoc_word_alloc(mdoc, lastarg, p); + 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; } - if (MDOC_LINEARG_MAX == sz + argc) - return(mdoc_err(mdoc, tok, lastarg, ERR_ARGS_MANY)); - - return(rewind_elem(mdoc, ppos, tok)); + 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)); +} + + +/* + * 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; + + 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 ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags)) + continue; + return(mdoc_nerr(mdoc, n, + "macro scope still open on exit")); + } + + return(rewind_last(mdoc, mdoc->first)); }