=================================================================== RCS file: /cvs/mandoc/mdoc_macro.c,v retrieving revision 1.5 retrieving revision 1.54 diff -u -p -r1.5 -r1.54 --- mandoc/mdoc_macro.c 2009/03/31 13:50:19 1.5 +++ mandoc/mdoc_macro.c 2010/05/07 05:39:35 1.54 @@ -1,88 +1,74 @@ -/* $Id: mdoc_macro.c,v 1.5 2009/03/31 13:50:19 kristaps Exp $ */ +/* $Id: mdoc_macro.c,v 1.54 2010/05/07 05:39:35 kristaps Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any - * purpose with or without fee is hereby granted, provided that the - * above copyright notice and this permission notice appear in all - * copies. + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL - * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED - * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE - * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL - * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR - * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER - * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - * PERFORMANCE OF THIS SOFTWARE. + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +#ifdef HAVE_CONFIG_H +#include "config.h" +#endif + #include #include #include #include #include +#include #include "libmdoc.h" -/* FIXME: .Fl, .Ar, .Cd handling of `|'. */ - -enum mwarn { - WIGNE, - WIMPBRK, - WMACPARM, - WOBS +enum rew { + REWIND_REWIND, + REWIND_NOHALT, + REWIND_HALT }; -enum merr { - EOPEN, - EQUOT, - ENOCTX, - ENOPARMS -}; +static int blk_full(MACRO_PROT_ARGS); +static int blk_exp_close(MACRO_PROT_ARGS); +static int blk_part_exp(MACRO_PROT_ARGS); +static int blk_part_imp(MACRO_PROT_ARGS); +static int ctx_synopsis(MACRO_PROT_ARGS); +static int in_line_eoln(MACRO_PROT_ARGS); +static int in_line_argn(MACRO_PROT_ARGS); +static int in_line(MACRO_PROT_ARGS); +static int obsolete(MACRO_PROT_ARGS); -#define REWIND_REWIND (1 << 0) -#define REWIND_NOHALT (1 << 1) -#define REWIND_HALT (1 << 2) +static int append_delims(struct mdoc *, + int, int *, char *); +static enum mdoct lookup(int, const char *); +static enum mdoct lookup_raw(const char *); +static int phrase(struct mdoc *, int, int, char *); +static enum mdoct rew_alt(enum mdoct); +static int rew_dobreak(enum mdoct, + const struct mdoc_node *); +static enum rew rew_dohalt(enum mdoct, enum mdoc_type, + const struct mdoc_node *); +static int rew_elem(struct mdoc *, enum mdoct); +static int rew_last(struct mdoc *, + const struct mdoc_node *); +static int rew_sub(enum mdoc_type, struct mdoc *, + enum mdoct, int, int); +static int swarn(struct mdoc *, enum mdoc_type, int, + int, const struct mdoc_node *); -static int obsolete(MACRO_PROT_ARGS); -static int blk_part_exp(MACRO_PROT_ARGS); -static int in_line_eoln(MACRO_PROT_ARGS); -static int in_line_argn(MACRO_PROT_ARGS); -static int in_line(MACRO_PROT_ARGS); -static int blk_full(MACRO_PROT_ARGS); -static int blk_exp_close(MACRO_PROT_ARGS); -static int blk_part_imp(MACRO_PROT_ARGS); - -static int phrase(struct mdoc *, int, int, char *); -static int rew_dohalt(int, enum mdoc_type, - const struct mdoc_node *); -static int rew_alt(int); -static int rew_dobreak(int, const struct mdoc_node *); -static int rew_elem(struct mdoc *, int); -static int rew_impblock(struct mdoc *, int, int, int); -static int rew_expblock(struct mdoc *, int, int, int); -static int rew_subblock(enum mdoc_type, - struct mdoc *, int, int, int); -static int rew_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, enum mwarn); -static int perr(struct mdoc *, int, int, enum merr); -static int swarn(struct mdoc *, enum mdoc_type, int, int, - const struct mdoc_node *); - -#define nerr(m, n, t) perr((m), (n)->line, (n)->pos, (t)) - -/* Central table of library: who gets parsed how. */ - const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { - { NULL, 0 }, /* \" */ + { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */ { in_line_eoln, MDOC_PROLOGUE }, /* Dd */ { in_line_eoln, MDOC_PROLOGUE }, /* Dt */ { in_line_eoln, MDOC_PROLOGUE }, /* Os */ { blk_full, 0 }, /* Sh */ { blk_full, 0 }, /* Ss */ - { in_line, 0 }, /* Pp */ + { in_line_eoln, 0 }, /* Pp */ { blk_part_imp, MDOC_PARSED }, /* D1 */ { blk_part_imp, MDOC_PARSED }, /* Dl */ { blk_full, MDOC_EXPLICIT }, /* Bd */ @@ -91,9 +77,9 @@ const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { { blk_exp_close, MDOC_EXPLICIT }, /* El */ { blk_full, MDOC_PARSED }, /* It */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */ - { in_line, MDOC_PARSED }, /* An */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* An */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */ - { in_line_eoln, MDOC_CALLABLE }, /* Cd */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cd */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Er */ @@ -103,11 +89,11 @@ const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { { in_line_eoln, 0 }, /* Fd */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */ - { in_line, MDOC_PARSED }, /* Ft */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ft */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */ - { in_line_eoln, 0 }, /* In */ + { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* In */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Li */ - { in_line_eoln, 0 }, /* Nd */ + { blk_full, 0 }, /* Nd */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */ { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */ { obsolete, 0 }, /* Ot */ @@ -115,8 +101,8 @@ const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { { in_line_eoln, 0 }, /* Rv */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* St */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Va */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */ + { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */ + { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */ { in_line_eoln, 0 }, /* %A */ { in_line_eoln, 0 }, /* %B */ { in_line_eoln, 0 }, /* %D */ @@ -147,13 +133,13 @@ const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Em */ { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */ - { in_line, MDOC_PARSED }, /* Ms */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* No */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Nx */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ox */ { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */ - { in_line_argn, MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */ + { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */ { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Po */ { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */ { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Qc */ @@ -183,10 +169,9 @@ const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { { obsolete, 0 }, /* Fr */ { in_line_eoln, 0 }, /* Ud */ { in_line_eoln, 0 }, /* Lb */ - { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */ - { in_line, 0 }, /* Lp */ - { in_line, MDOC_PARSED }, /* Lk */ - { in_line, MDOC_PARSED }, /* Mt */ + { in_line_eoln, 0 }, /* Lp */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Lk */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Mt */ { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Brq */ { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bro */ { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Brc */ @@ -195,62 +180,15 @@ const struct mdoc_macro __mdoc_macros[MDOC_MAX] = { { obsolete, 0 }, /* En */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Dx */ { in_line_eoln, 0 }, /* %Q */ + { in_line_eoln, 0 }, /* br */ + { in_line_eoln, 0 }, /* sp */ + { in_line_eoln, 0 }, /* %U */ }; const struct mdoc_macro * const mdoc_macros = __mdoc_macros; static int -perr(struct mdoc *mdoc, int line, int pos, enum merr type) -{ - char *p; - - p = NULL; - switch (type) { - case (EOPEN): - p = "explicit scope still open on exit"; - break; - case (EQUOT): - p = "unterminated quotation"; - break; - case (ENOCTX): - p = "closure has no prior context"; - break; - case (ENOPARMS): - p = "unexpect line arguments"; - break; - } - assert(p); - return(mdoc_perr(mdoc, line, pos, p)); -} - - -static int -pwarn(struct mdoc *mdoc, int line, int pos, enum mwarn type) -{ - char *p; - - p = NULL; - switch (type) { - case (WIGNE): - p = "ignoring empty element"; - break; - case (WIMPBRK): - p = "crufty end-of-line scope violation"; - break; - case (WMACPARM): - p = "macro-like parameter"; - break; - case (WOBS): - p = "macro marked obsolete"; - break; - } - assert(p); - return(mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, p)); -} - - -static int swarn(struct mdoc *mdoc, enum mdoc_type type, int line, int pos, const struct mdoc_node *p) { @@ -288,10 +226,10 @@ swarn(struct mdoc *mdoc, enum mdoc_type type, } if ( ! (MDOC_IGN_SCOPE & mdoc->pflags)) - return(mdoc_perr(mdoc, line, pos, + return(mdoc_verr(mdoc, line, pos, "%s scope breaks %s scope of %s", tt, t, n)); - return(mdoc_pwarn(mdoc, line, pos, WARN_SYNTAX, + return(mdoc_vwarn(mdoc, line, pos, "%s scope breaks %s scope of %s", tt, t, n)); } @@ -303,44 +241,60 @@ swarn(struct mdoc *mdoc, enum mdoc_type type, * are errors. */ int -mdoc_macroend(struct mdoc *mdoc) +mdoc_macroend(struct mdoc *m) { struct mdoc_node *n; /* Scan for open explicit scopes. */ - n = MDOC_VALID & mdoc->last->flags ? - mdoc->last->parent : mdoc->last; + n = MDOC_VALID & m->last->flags ? m->last->parent : m->last; for ( ; n; n = n->parent) { if (MDOC_BLOCK != n->type) continue; if ( ! (MDOC_EXPLICIT & mdoc_macros[n->tok].flags)) continue; - return(nerr(mdoc, n, EOPEN)); + return(mdoc_nerr(m, n, EOPEN)); } - return(rew_last(mdoc, mdoc->first)); + /* Rewind to the first. */ + + return(rew_last(m, m->first)); } -static int -lookup(struct mdoc *mdoc, int line, int pos, int from, const char *p) + +/* + * Look up a macro from within a subsequent context. + */ +static enum mdoct +lookup(int from, const char *p) { + /* FIXME: make -diag lists be un-PARSED. */ + + if ( ! (MDOC_PARSED & mdoc_macros[from].flags)) + return(MDOC_MAX); + return(lookup_raw(p)); +} + + +/* + * Lookup a macro following the initial line macro. + */ +static enum mdoct +lookup_raw(const char *p) +{ int res; - res = mdoc_tokhash_find(mdoc->htab, p); - if (MDOC_PARSED & mdoc_macros[from].flags) + if (MDOC_MAX == (res = mdoc_hash_find(p))) + return(MDOC_MAX); + if (MDOC_CALLABLE & mdoc_macros[res].flags) return(res); - if (MDOC_MAX == res) - return(res); - if ( ! pwarn(mdoc, line, pos, WMACPARM)) - return(-1); return(MDOC_MAX); } static int -rew_last(struct mdoc *mdoc, struct mdoc_node *to) +rew_last(struct mdoc *mdoc, const struct mdoc_node *to) { assert(to); @@ -362,8 +316,12 @@ rew_last(struct mdoc *mdoc, struct mdoc_node *to) } -static int -rew_alt(int tok) +/* + * Return the opening macro of a closing one, e.g., `Ec' has `Eo' as its + * matching pair. + */ +static enum mdoct +rew_alt(enum mdoct tok) { switch (tok) { case (MDOC_Ac): @@ -412,8 +370,9 @@ rew_alt(int tok) * close our current scope (REWIND_REWIND), or continue (REWIND_NOHALT). * The scope-closing and so on occurs in the various rew_* routines. */ -static int -rew_dohalt(int tok, enum mdoc_type type, const struct mdoc_node *p) +static enum rew +rew_dohalt(enum mdoct tok, enum mdoc_type type, + const struct mdoc_node *p) { if (MDOC_ROOT == p->type) @@ -443,7 +402,8 @@ rew_dohalt(int tok, enum mdoc_type type, const struct case (MDOC_Qq): /* FALLTHROUGH */ case (MDOC_Sq): - assert(MDOC_HEAD != type); + /* FALLTHROUGH */ + case (MDOC_Vt): assert(MDOC_TAIL != type); if (type == p->type && tok == p->tok) return(REWIND_REWIND); @@ -459,6 +419,8 @@ rew_dohalt(int tok, enum mdoc_type type, const struct if (type == p->type && tok == p->tok) return(REWIND_REWIND); break; + case (MDOC_Nd): + /* FALLTHROUGH */ case (MDOC_Ss): assert(MDOC_TAIL != type); if (type == p->type && tok == p->tok) @@ -500,7 +462,6 @@ rew_dohalt(int tok, enum mdoc_type type, const struct if (type == p->type && tok == p->tok) return(REWIND_REWIND); break; - /* Multi-line explicit scope close. */ case (MDOC_Ac): /* FALLTHROUGH */ @@ -550,7 +511,7 @@ rew_dohalt(int tok, enum mdoc_type type, const struct * REWIND_NOHALT). */ static int -rew_dobreak(int tok, const struct mdoc_node *p) +rew_dobreak(enum mdoct tok, const struct mdoc_node *p) { assert(MDOC_ROOT != p->type); @@ -564,9 +525,13 @@ rew_dobreak(int tok, const struct mdoc_node *p) switch (tok) { case (MDOC_It): return(MDOC_It == p->tok); + case (MDOC_Nd): + return(MDOC_Nd == p->tok); case (MDOC_Ss): return(MDOC_Ss == p->tok); case (MDOC_Sh): + if (MDOC_Nd == p->tok) + return(1); if (MDOC_Ss == p->tok) return(1); return(MDOC_Sh == p->tok); @@ -575,7 +540,6 @@ rew_dobreak(int tok, const struct mdoc_node *p) return(1); break; case (MDOC_Oc): - /* XXX - experimental! */ if (MDOC_Op == p->tok) return(1); break; @@ -593,7 +557,7 @@ rew_dobreak(int tok, const struct mdoc_node *p) static int -rew_elem(struct mdoc *mdoc, int tok) +rew_elem(struct mdoc *mdoc, enum mdoct tok) { struct mdoc_node *n; @@ -608,82 +572,58 @@ rew_elem(struct mdoc *mdoc, int tok) static int -rew_subblock(enum mdoc_type type, struct mdoc *mdoc, - int tok, int line, int ppos) +rew_sub(enum mdoc_type t, struct mdoc *m, + enum mdoct tok, int line, int ppos) { struct mdoc_node *n; - int c; + enum rew c; /* LINTED */ - for (n = mdoc->last; n; n = n->parent) { - c = rew_dohalt(tok, type, n); - if (REWIND_HALT == c) - return(1); + for (n = m->last; n; n = n->parent) { + c = rew_dohalt(tok, t, n); + if (REWIND_HALT == c) { + if (MDOC_BLOCK != t) + return(1); + if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) + return(1); + return(mdoc_perr(m, line, ppos, ENOCTX)); + } if (REWIND_REWIND == c) break; else if (rew_dobreak(tok, n)) continue; - if ( ! swarn(mdoc, type, line, ppos, n)) + if ( ! swarn(m, t, line, ppos, n)) return(0); } assert(n); - return(rew_last(mdoc, n)); -} + if ( ! rew_last(m, n)) + return(0); - -static int -rew_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 = rew_dohalt(tok, MDOC_BLOCK, n); - if (REWIND_HALT == c) - return(perr(mdoc, line, ppos, ENOCTX)); - if (REWIND_REWIND == c) - break; - else if (rew_dobreak(tok, n)) - continue; - if ( ! swarn(mdoc, MDOC_BLOCK, line, ppos, n)) +#ifdef UGLY + /* + * The current block extends an enclosing block beyond a line + * break. Now that the current block ends, close the enclosing + * block, too. + */ + if (NULL != (n = n->pending)) { + assert(MDOC_HEAD == n->type); + if ( ! rew_last(m, n)) return(0); - } - - assert(n); - return(rew_last(mdoc, n)); -} - - -static int -rew_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 = rew_dohalt(tok, MDOC_BLOCK, n); - if (REWIND_HALT == c) - return(1); - else if (REWIND_REWIND == c) - break; - else if (rew_dobreak(tok, n)) - continue; - if ( ! swarn(mdoc, MDOC_BLOCK, line, ppos, n)) + if ( ! mdoc_body_alloc(m, n->line, n->pos, n->tok)) return(0); } +#endif - assert(n); - return(rew_last(mdoc, n)); + return(1); } static int append_delims(struct mdoc *mdoc, int line, int *pos, char *buf) { - int c, lastarg; + int lastarg; + enum margerr ac; char *p; if (0 == buf[*pos]) @@ -691,17 +631,16 @@ append_delims(struct mdoc *mdoc, int line, int *pos, c for (;;) { lastarg = *pos; - c = mdoc_args(mdoc, line, pos, buf, 0, &p); - assert(ARGS_PHRASE != c); + ac = mdoc_zargs(mdoc, line, pos, buf, ARGS_NOWARN, &p); + assert(ARGS_PHRASE != ac); - if (ARGS_ERROR == c) + if (ARGS_ERROR == ac) return(0); - else if (ARGS_EOLN == c) + else if (ARGS_EOLN == ac) break; assert(mdoc_isdelim(p)); if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; } return(1); @@ -714,7 +653,9 @@ append_delims(struct mdoc *mdoc, int line, int *pos, c static int blk_exp_close(MACRO_PROT_ARGS) { - int j, c, lastarg, maxargs, flushed; + int j, lastarg, maxargs, flushed; + enum margerr ac; + enum mdoct ntok; char *p; switch (tok) { @@ -727,95 +668,93 @@ blk_exp_close(MACRO_PROT_ARGS) } if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) { - if (0 == buf[*pos]) { - if ( ! rew_subblock(MDOC_BODY, mdoc, - tok, line, ppos)) + if (buf[*pos]) + if ( ! mdoc_pwarn(m, line, ppos, ENOLINE)) return(0); - return(rew_expblock(mdoc, tok, line, ppos)); - } - return(perr(mdoc, line, ppos, ENOPARMS)); + + if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos)) + return(0); + return(rew_sub(MDOC_BLOCK, m, tok, line, ppos)); } - if ( ! rew_subblock(MDOC_BODY, mdoc, tok, line, ppos)) + if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos)) return(0); - if (maxargs > 0) { - if ( ! mdoc_tail_alloc(mdoc, line, - ppos, rew_alt(tok))) + if (maxargs > 0) + if ( ! mdoc_tail_alloc(m, line, ppos, rew_alt(tok))) return(0); - mdoc->next = MDOC_NEXT_CHILD; - } - for (lastarg = ppos, flushed = j = 0; ; j++) { + for (flushed = j = 0; ; j++) { lastarg = *pos; if (j == maxargs && ! flushed) { - if ( ! rew_expblock(mdoc, tok, line, ppos)) + if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos)) return(0); flushed = 1; } - c = mdoc_args(mdoc, line, pos, buf, tok, &p); + ac = mdoc_args(m, line, pos, buf, tok, &p); - if (ARGS_ERROR == c) + if (ARGS_ERROR == ac) return(0); - if (ARGS_PUNCT == c) + if (ARGS_PUNCT == ac) break; - if (ARGS_EOLN == c) + if (ARGS_EOLN == ac) break; - if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) - return(0); - else if (MDOC_MAX != c) { - if ( ! flushed) { - if ( ! rew_expblock(mdoc, tok, - line, ppos)) - return(0); - flushed = 1; - } - if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) + ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); + + if (MDOC_MAX == ntok) { + if ( ! mdoc_word_alloc(m, line, lastarg, p)) return(0); - break; - } + continue; + } - if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + if ( ! flushed) { + if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos)) + return(0); + flushed = 1; + } + if ( ! mdoc_macro(m, ntok, line, lastarg, pos, buf)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; + break; } - if ( ! flushed && ! rew_expblock(mdoc, tok, line, ppos)) + if ( ! flushed && ! rew_sub(MDOC_BLOCK, m, tok, line, ppos)) return(0); if (ppos > 1) return(1); - return(append_delims(mdoc, line, pos, buf)); + return(append_delims(m, line, pos, buf)); } -/* - * In-line macros where reserved words cause scope close-reopen. - */ static int in_line(MACRO_PROT_ARGS) { - int la, lastpunct, c, w, cnt, d, nc; - struct mdoc_arg *arg; - char *p; + int la, lastpunct, c, cnt, d, nc; + enum mdoct ntok; + enum margerr ac; + struct mdoc_arg *arg; + char *p; /* * Whether we allow ignored elements (those without content, * usually because of reserved words) to squeak by. */ + switch (tok) { - case (MDOC_Lp): + case (MDOC_An): /* FALLTHROUGH */ - case (MDOC_Pp): + case (MDOC_Ar): /* FALLTHROUGH */ - case (MDOC_Nm): - /* FALLTHROUGH */ case (MDOC_Fl): /* FALLTHROUGH */ - case (MDOC_Ar): + case (MDOC_Lk): + /* FALLTHROUGH */ + case (MDOC_Nm): + /* FALLTHROUGH */ + case (MDOC_Pa): nc = 1; break; default: @@ -823,9 +762,9 @@ in_line(MACRO_PROT_ARGS) break; } - for (la = ppos, arg = NULL;; ) { + for (arg = NULL;; ) { la = *pos; - c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); + c = mdoc_argv(m, line, tok, &arg, pos, buf); if (ARGV_WORD == c) { *pos = la; @@ -842,20 +781,17 @@ in_line(MACRO_PROT_ARGS) for (cnt = 0, lastpunct = 1;; ) { la = *pos; - w = mdoc_args(mdoc, line, pos, buf, tok, &p); + ac = mdoc_args(m, line, pos, buf, tok, &p); - if (ARGS_ERROR == w) + if (ARGS_ERROR == ac) return(0); - if (ARGS_EOLN == w) + if (ARGS_EOLN == ac) break; - if (ARGS_PUNCT == w) + if (ARGS_PUNCT == ac) break; - /* Quoted words shouldn't be looked-up. */ + ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); - c = ARGS_QWORD == w ? MDOC_MAX : - lookup(mdoc, line, la, tok, p); - /* * In this case, we've located a submacro and must * execute it. Close out scope, if open. If no @@ -863,25 +799,25 @@ in_line(MACRO_PROT_ARGS) * or raise a warning. */ - if (MDOC_MAX != c && -1 != c) { - if (0 == lastpunct && ! rew_elem(mdoc, tok)) + if (MDOC_MAX != ntok) { + if (0 == lastpunct && ! rew_elem(m, tok)) return(0); if (nc && 0 == cnt) { - if ( ! mdoc_elem_alloc(mdoc, line, ppos, - tok, arg)) + if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; - } else if ( ! nc && 0 == cnt) - if ( ! pwarn(mdoc, line, ppos, WIGNE)) + if ( ! rew_last(m, m->last)) return(0); - c = mdoc_macro(mdoc, c, line, la, pos, buf); - if (0 == c) + } else if ( ! nc && 0 == cnt) { + mdoc_argv_free(arg); + if ( ! mdoc_pwarn(m, line, ppos, EIGNE)) + return(0); + } + if ( ! mdoc_macro(m, ntok, line, la, pos, buf)) return(0); if (ppos > 1) return(1); - return(append_delims(mdoc, line, pos, buf)); - } else if (-1 == c) - return(0); + return(append_delims(m, line, pos, buf)); + } /* * Non-quote-enclosed punctuation. Set up our scope, if @@ -889,75 +825,99 @@ in_line(MACRO_PROT_ARGS) * the word. */ - d = mdoc_isdelim(p); + d = ARGS_QWORD == ac ? 0 : mdoc_isdelim(p); - if (ARGS_QWORD != w && d) { - if (0 == lastpunct && ! rew_elem(mdoc, tok)) + if (ARGS_QWORD != ac && d) { + if (0 == lastpunct && ! rew_elem(m, tok)) return(0); lastpunct = 1; } else if (lastpunct) { - c = mdoc_elem_alloc(mdoc, line, ppos, tok, arg); - if (0 == c) + if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg)) return(0); - mdoc->next = MDOC_NEXT_CHILD; lastpunct = 0; } if ( ! d) cnt++; - if ( ! mdoc_word_alloc(mdoc, line, la, p)) + if ( ! mdoc_word_alloc(m, line, la, p)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; + + /* + * `Fl' macros have their scope re-opened with each new + * word so that the `-' can be added to each one without + * having to parse out spaces. + */ + if (0 == lastpunct && MDOC_Fl == tok) { + if ( ! rew_elem(m, tok)) + return(0); + lastpunct = 1; + } } - if (0 == lastpunct && ! rew_elem(mdoc, tok)) + if (0 == lastpunct && ! rew_elem(m, tok)) return(0); /* * If no elements have been collected and we're allowed to have * empties (nc), open a scope and close it out. Otherwise, * raise a warning. - * */ + if (nc && 0 == cnt) { - c = mdoc_elem_alloc(mdoc, line, ppos, tok, arg); - if (0 == c) + if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; - } else if ( ! nc && 0 == cnt) - if ( ! pwarn(mdoc, line, ppos, WIGNE)) + if ( ! rew_last(m, m->last)) return(0); + } else if ( ! nc && 0 == cnt) { + mdoc_argv_free(arg); + if ( ! mdoc_pwarn(m, line, ppos, EIGNE)) + return(0); + } if (ppos > 1) return(1); - return(append_delims(mdoc, line, pos, buf)); + return(append_delims(m, line, pos, buf)); } -/* - * Block full-explicit and full-implicit. - */ static int blk_full(MACRO_PROT_ARGS) { - int c, lastarg, reopen; + int c, la; struct mdoc_arg *arg; + struct mdoc_node *head; /* save of head macro */ + struct mdoc_node *body; /* save of body macro */ +#ifdef UGLY + struct mdoc_node *n; +#endif + enum mdoct ntok; + enum margerr ac; char *p; + /* Close out prior implicit scope. */ + if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) { - if ( ! rew_subblock(MDOC_BODY, mdoc, - tok, line, ppos)) + if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos)) return(0); - if ( ! rew_impblock(mdoc, tok, line, ppos)) + if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos)) return(0); } + /* + * This routine accomodates implicitly- and explicitly-scoped + * macro openings. Implicit ones first close out prior scope + * (seen above). Delay opening the head until necessary to + * allow leading punctuation to print. Special consideration + * for `It -column', which has phrase-part syntax instead of + * regular child nodes. + */ + for (arg = NULL;; ) { - lastarg = *pos; - c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); + la = *pos; + c = mdoc_argv(m, line, tok, &arg, pos, buf); if (ARGV_WORD == c) { - *pos = lastarg; + *pos = la; break; } @@ -970,288 +930,357 @@ blk_full(MACRO_PROT_ARGS) return(0); } - if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, arg)) + if ( ! mdoc_block_alloc(m, line, ppos, tok, arg)) return(0); - mdoc->next = MDOC_NEXT_CHILD; - if (0 == buf[*pos]) { - if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) + head = body = NULL; + + /* + * The `Nd' macro has all arguments in its body: it's a hybrid + * of block partial-explicit and full-implicit. Stupid. + */ + + if (MDOC_Nd == tok) { + if ( ! mdoc_head_alloc(m, line, ppos, tok)) return(0); - if ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) + head = m->last; + if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) return(0); - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + if ( ! mdoc_body_alloc(m, line, ppos, tok)) return(0); - mdoc->next = MDOC_NEXT_CHILD; - return(1); - } + body = m->last; + } - if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; + for (;;) { + la = *pos; + ac = mdoc_args(m, line, pos, buf, tok, &p); - for (reopen = 0;; ) { - lastarg = *pos; - c = mdoc_args(mdoc, line, pos, buf, tok, &p); - - if (ARGS_ERROR == c) + if (ARGS_ERROR == ac) return(0); - if (ARGS_EOLN == c) + if (ARGS_EOLN == ac) break; - if (ARGS_PHRASE == c) { - if (reopen && ! mdoc_head_alloc - (mdoc, line, ppos, tok)) + + /* Don't emit leading punct. for phrases. */ + + if (NULL == head && ARGS_PHRASE != ac && + ARGS_QWORD != ac && + 1 == mdoc_isdelim(p)) { + if ( ! mdoc_word_alloc(m, line, la, p)) 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 ( ! phrase(mdoc, line, lastarg, buf)) + continue; + } + + /* Always re-open head for phrases. */ + + if (NULL == head || ARGS_PHRASE == ac) { + if ( ! mdoc_head_alloc(m, line, ppos, tok)) return(0); - if ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) - return(0); + head = m->last; + } - reopen = 1; + if (ARGS_PHRASE == ac) { + if ( ! phrase(m, line, la, buf)) + return(0); + if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) + return(0); continue; } - if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) - return(0); + ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); - if (MDOC_MAX == c) { - if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + if (MDOC_MAX == ntok) { + if ( ! mdoc_word_alloc(m, line, la, p)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; continue; - } + } - if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) + if ( ! mdoc_macro(m, ntok, line, la, pos, buf)) return(0); break; } + + if (NULL == head) { + if ( ! mdoc_head_alloc(m, line, ppos, tok)) + return(0); + head = m->last; + } - if (1 == ppos && ! append_delims(mdoc, line, pos, buf)) + if (1 == ppos && ! append_delims(m, line, pos, buf)) return(0); - if ( ! rew_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) - return(0); - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + /* If we've already opened our body, exit now. */ + + if (NULL != body) + return(1); + +#ifdef UGLY + /* + * If there is an open (i.e., unvalidated) sub-block requiring + * explicit close-out, postpone switching the current block from + * head to body until the rew_sub() call closing out that + * sub-block. + */ + for (n = m->last; n && n != head; n = n->parent) { + if (MDOC_BLOCK == n->type && + MDOC_EXPLICIT & mdoc_macros[n->tok].flags && + ! (MDOC_VALID & n->flags)) { + assert( ! (MDOC_ACTED & n->flags)); + n->pending = head; + return(1); + } + } +#endif + + /* Close out scopes to remain in a consistent state. */ + + if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) return(0); - mdoc->next = MDOC_NEXT_CHILD; + if ( ! mdoc_body_alloc(m, line, ppos, tok)) + return(0); return(1); } -/* - * Block partial-imnplicit scope. - */ static int blk_part_imp(MACRO_PROT_ARGS) { - int lastarg, c; + int la; + enum mdoct ntok; + enum margerr ac; char *p; - struct mdoc_node *blk, *body, *n; + struct mdoc_node *blk; /* saved block context */ + struct mdoc_node *body; /* saved body context */ + struct mdoc_node *n; - if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; - blk = mdoc->last; + /* + * A macro that spans to the end of the line. This is generally + * (but not necessarily) called as the first macro. The block + * has a head as the immediate child, which is always empty, + * followed by zero or more opening punctuation nodes, then the + * body (which may be empty, depending on the macro), then zero + * or more closing punctuation nodes. + */ - if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) + if ( ! mdoc_block_alloc(m, line, ppos, tok, NULL)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + blk = m->last; + + if ( ! mdoc_head_alloc(m, line, ppos, tok)) return(0); - mdoc->next = MDOC_NEXT_CHILD; - body = mdoc->last; + if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) + return(0); - /* XXX - no known argument macros. */ + /* + * Open the body scope "on-demand", that is, after we've + * processed all our the leading delimiters (open parenthesis, + * etc.). + */ - for (lastarg = ppos;; ) { - lastarg = *pos; - c = mdoc_args(mdoc, line, pos, buf, tok, &p); - assert(ARGS_PHRASE != c); + for (body = NULL; ; ) { + la = *pos; + ac = mdoc_args(m, line, pos, buf, tok, &p); - if (ARGS_ERROR == c) + assert(ARGS_PHRASE != ac); + + if (ARGS_ERROR == ac) return(0); - if (ARGS_PUNCT == c) + if (ARGS_EOLN == ac) break; - if (ARGS_EOLN == c) + if (ARGS_PUNCT == ac) break; - if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) - return(0); - else if (MDOC_MAX == c) { - if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + if (NULL == body && ARGS_QWORD != ac && + 1 == mdoc_isdelim(p)) { + if ( ! mdoc_word_alloc(m, line, la, p)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; continue; } - if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) + if (NULL == body) { + if ( ! mdoc_body_alloc(m, line, ppos, tok)) + return(0); + body = m->last; + } + + ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); + + if (MDOC_MAX == ntok) { + if ( ! mdoc_word_alloc(m, line, la, p)) + return(0); + continue; + } + + if ( ! mdoc_macro(m, ntok, line, la, pos, buf)) return(0); break; } - /* - * Since we know what our context is, we can rewind directly to - * it. This allows us to accomodate for our scope being - * violated by another token. - */ + /* Clean-ups to leave in a consistent state. */ - for (n = mdoc->last; n; n = n->parent) + if (NULL == body) { + if ( ! mdoc_body_alloc(m, line, ppos, tok)) + return(0); + body = m->last; + } + + /* + * If we can't rewind to our body, then our scope has already + * been closed by another macro (like `Oc' closing `Op'). This + * is ugly behaviour nodding its head to OpenBSD's overwhelming + * crufty use of `Op' breakage. + */ + for (n = m->last; n; n = n->parent) if (body == n) break; - if (NULL == n && ! pwarn(mdoc, body->line, body->pos, WIMPBRK)) - return(0); + if (NULL == n && ! mdoc_nwarn(m, body, EIMPBRK)) + return(0); - if (n && ! rew_last(mdoc, body)) + if (n && ! rew_last(m, body)) return(0); - if (1 == ppos && ! append_delims(mdoc, line, pos, buf)) + /* Standard appending of delimiters. */ + + if (1 == ppos && ! append_delims(m, line, pos, buf)) return(0); - if (n && ! rew_last(mdoc, blk)) + /* Rewind scope, if applicable. */ + + if (n && ! rew_last(m, blk)) return(0); return(1); } -/* - * Block partial-explicit macros. - */ static int blk_part_exp(MACRO_PROT_ARGS) { - int lastarg, flushed, j, c, maxargs; + int la; + enum margerr ac; + struct mdoc_node *head; /* keep track of head */ + struct mdoc_node *body; /* keep track of body */ char *p; + enum mdoct ntok; - lastarg = ppos; - flushed = 0; - /* - * Number of arguments (head arguments). Only `Eo' has these, + * The opening of an explicit macro having zero or more leading + * punctuation nodes; a head with optional single element (the + * case of `Eo'); and a body that may be empty. */ - switch (tok) { - case (MDOC_Eo): - maxargs = 1; - break; - default: - maxargs = 0; - break; - } - - if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL)) + if ( ! mdoc_block_alloc(m, line, ppos, tok, NULL)) return(0); - mdoc->next = MDOC_NEXT_CHILD; - if (0 == maxargs) { - if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) + for (head = body = NULL; ; ) { + la = *pos; + ac = mdoc_args(m, line, pos, buf, tok, &p); + + if (ARGS_ERROR == ac) return(0); - if ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) - return(0); - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) - return(0); - flushed = 1; - } else if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) - return(0); + if (ARGS_PUNCT == ac) + break; + if (ARGS_EOLN == ac) + break; - mdoc->next = MDOC_NEXT_CHILD; + assert(ARGS_PHRASE != ac); - for (j = 0; ; j++) { - lastarg = *pos; - if (j == maxargs && ! flushed) { - if ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) + /* Flush out leading punctuation. */ + + if (NULL == head && ARGS_QWORD != ac && + 1 == mdoc_isdelim(p)) { + assert(NULL == body); + if ( ! mdoc_word_alloc(m, line, la, p)) return(0); - flushed = 1; - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + continue; + } + + if (NULL == head) { + assert(NULL == body); + if ( ! mdoc_head_alloc(m, line, ppos, tok)) return(0); - mdoc->next = MDOC_NEXT_CHILD; + head = m->last; } - c = mdoc_args(mdoc, line, pos, buf, tok, &p); - assert(ARGS_PHRASE != c); + /* + * `Eo' gobbles any data into the head, but most other + * macros just immediately close out and begin the body. + */ - 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 ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) + if (NULL == body) { + assert(head); + /* No check whether it's a macro! */ + if (MDOC_Eo == tok) + if ( ! mdoc_word_alloc(m, line, la, p)) 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)) + + if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) return(0); - break; + if ( ! mdoc_body_alloc(m, line, ppos, tok)) + return(0); + body = m->last; + + if (MDOC_Eo == tok) + continue; } - if ( ! flushed && mdoc_isdelim(p)) { - if ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) + assert(NULL != head && NULL != body); + + ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); + + if (MDOC_MAX == ntok) { + if ( ! mdoc_word_alloc(m, line, la, p)) return(0); - flushed = 1; - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; + continue; } - - if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + + if ( ! mdoc_macro(m, ntok, line, la, pos, buf)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; + break; } - if ( ! flushed) { - if ( ! rew_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) + /* Clean-up to leave in a consistent state. */ + + if (NULL == head) { + if ( ! mdoc_head_alloc(m, line, ppos, tok)) return(0); - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + head = m->last; + } + + if (NULL == body) { + if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) return(0); - mdoc->next = MDOC_NEXT_CHILD; + if ( ! mdoc_body_alloc(m, line, ppos, tok)) + return(0); + body = m->last; } + /* Standard appending of delimiters. */ + if (ppos > 1) return(1); - return(append_delims(mdoc, line, pos, buf)); + + return(append_delims(m, line, pos, buf)); } -/* - * In-line macros where reserved words signal closure of the macro. - * Macros also have a fixed number of arguments. - */ static int in_line_argn(MACRO_PROT_ARGS) { - int lastarg, flushed, j, c, maxargs; - struct mdoc_arg *arg; - char *p; + int la, flushed, j, c, maxargs; + enum margerr ac; + struct mdoc_arg *arg; + char *p; + enum mdoct ntok; - - /* - * Fixed maximum arguments per macro. Some of these have none - * and close as soon as the invocation is parsed. + /* + * A line macro that has a fixed number of arguments (maxargs). + * Only open the scope once the first non-leading-punctuation is + * found (unless MDOC_IGNDELIM is noted, like in `Pf'), then + * keep it open until the maximum number of arguments are + * exhausted. */ switch (tok) { @@ -1264,17 +1293,20 @@ in_line_argn(MACRO_PROT_ARGS) case (MDOC_Ux): maxargs = 0; break; + case (MDOC_Xr): + maxargs = 2; + break; default: maxargs = 1; break; } - for (lastarg = ppos, arg = NULL;; ) { - lastarg = *pos; - c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); + for (arg = NULL; ; ) { + la = *pos; + c = mdoc_argv(m, line, tok, &arg, pos, buf); if (ARGV_WORD == c) { - *pos = lastarg; + *pos = la; break; } @@ -1287,78 +1319,104 @@ in_line_argn(MACRO_PROT_ARGS) return(0); } - if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; + for (flushed = j = 0; ; ) { + la = *pos; + ac = mdoc_args(m, line, pos, buf, tok, &p); - for (flushed = j = 0; ; j++) { - lastarg = *pos; + if (ARGS_ERROR == ac) + return(0); + if (ARGS_PUNCT == ac) + break; + if (ARGS_EOLN == ac) + break; + if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) && + ARGS_QWORD != ac && + 0 == j && 1 == mdoc_isdelim(p)) { + if ( ! mdoc_word_alloc(m, line, la, p)) + return(0); + continue; + } else if (0 == j) + if ( ! mdoc_elem_alloc(m, line, la, tok, arg)) + return(0); + if (j == maxargs && ! flushed) { - if ( ! rew_elem(mdoc, tok)) + if ( ! rew_elem(m, tok)) return(0); flushed = 1; } - c = mdoc_args(mdoc, line, pos, buf, tok, &p); + ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); - 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 && ! rew_elem(mdoc, tok)) + if (MDOC_MAX != ntok) { + if ( ! flushed && ! rew_elem(m, tok)) return(0); flushed = 1; - if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) + if ( ! mdoc_macro(m, ntok, line, la, pos, buf)) return(0); + j++; break; } if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) && + ARGS_QWORD != ac && ! flushed && mdoc_isdelim(p)) { - if ( ! rew_elem(mdoc, tok)) + if ( ! rew_elem(m, tok)) return(0); flushed = 1; } - - if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + + /* + * XXX: this is a hack to work around groff's ugliness + * as regards `Xr' and extraneous arguments. It should + * ideally be deprecated behaviour, but because this is + * code is no here, it's unlikely to be removed. + */ + +#ifdef __OpenBSD__ + if (MDOC_Xr == tok && j == maxargs) { + if ( ! mdoc_elem_alloc(m, line, la, MDOC_Ns, NULL)) + return(0); + if ( ! rew_elem(m, MDOC_Ns)) + return(0); + } +#endif + + if ( ! mdoc_word_alloc(m, line, la, p)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; + j++; } - if ( ! flushed && ! rew_elem(mdoc, tok)) + if (0 == j && ! mdoc_elem_alloc(m, line, la, tok, arg)) + return(0); + + /* Close out in a consistent state. */ + + if ( ! flushed && ! rew_elem(m, tok)) return(0); if (ppos > 1) return(1); - return(append_delims(mdoc, line, pos, buf)); + return(append_delims(m, line, pos, buf)); } -/* - * In-line macro that spans an entire line. May be callable, but has no - * subsequent parsed arguments. - */ static int in_line_eoln(MACRO_PROT_ARGS) { - int c, w, la; - struct mdoc_arg *arg; - char *p; + int c, la; + enum margerr ac; + struct mdoc_arg *arg; + char *p; + enum mdoct ntok; assert( ! (MDOC_PARSED & mdoc_macros[tok].flags)); - arg = NULL; + /* Parse macro arguments. */ - for (;;) { + for (arg = NULL; ; ) { la = *pos; - c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); + c = mdoc_argv(m, line, tok, &arg, pos, buf); if (ARGV_WORD == c) { *pos = la; @@ -1373,120 +1431,111 @@ in_line_eoln(MACRO_PROT_ARGS) return(0); } - if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg)) + /* Open element scope. */ + + if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg)) return(0); - mdoc->next = MDOC_NEXT_CHILD; + /* Parse argument terms. */ for (;;) { la = *pos; - w = mdoc_args(mdoc, line, pos, buf, tok, &p); + ac = mdoc_args(m, line, pos, buf, tok, &p); - if (ARGS_ERROR == w) + if (ARGS_ERROR == ac) return(0); - if (ARGS_EOLN == w) + if (ARGS_EOLN == ac) break; - c = ARGS_QWORD == w ? MDOC_MAX : - lookup(mdoc, line, la, tok, p); + ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); - if (MDOC_MAX != c && -1 != c) { - if ( ! rew_elem(mdoc, tok)) + if (MDOC_MAX == ntok) { + if ( ! mdoc_word_alloc(m, line, la, p)) return(0); - return(mdoc_macro(mdoc, c, line, la, pos, buf)); - } else if (-1 == c) - return(0); + continue; + } - if ( ! mdoc_word_alloc(mdoc, line, la, p)) + if ( ! rew_elem(m, tok)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; + return(mdoc_macro(m, ntok, line, la, pos, buf)); } - return(rew_elem(mdoc, tok)); + /* Close out (no delimiters). */ + + return(rew_elem(m, tok)); } /* ARGSUSED */ static int -obsolete(MACRO_PROT_ARGS) +ctx_synopsis(MACRO_PROT_ARGS) { - return(pwarn(mdoc, line, ppos, WOBS)); -} + /* If we're not in the SYNOPSIS, go straight to in-line. */ + if (SEC_SYNOPSIS != m->lastsec) + return(in_line(m, tok, line, ppos, pos, buf)); + /* If we're a nested call, same place. */ + if (ppos > 1) + return(in_line(m, tok, line, ppos, pos, buf)); -static int -phrase(struct mdoc *mdoc, int line, int ppos, char *buf) -{ - int i, la, c, quoted; - /* - * Parse over words in a phrase. We have to handle this - * specially because we assume no calling context -- in normal - * circumstances, we switch argument parsing based on whether - * the parent macro accepts quotes, tabs, etc. Here, anything - * goes. + * XXX: this will open a block scope; however, if later we end + * up formatting the block scope, then child nodes will inherit + * the formatting. Be careful. */ - for (i = ppos; buf[i]; ) { - assert(' ' != buf[i]); - la = i; - quoted = 0; + return(blk_part_imp(m, tok, line, ppos, pos, buf)); +} - /* - * Read to next token. If quoted (check not escaped), - * scan ahead to next unescaped quote. If not quoted or - * escape-quoted, then scan ahead to next space. - */ - if ((i && '\"' == buf[i] && '\\' != buf[i - 1]) || - (0 == i && '\"' == buf[i])) { - for (la = ++i; buf[i]; i++) - if ('\"' != buf[i]) - continue; - else if ('\\' != buf[i - 1]) - break; - if (0 == buf[i]) - return(perr(mdoc, line, la, EQUOT)); - quoted = 1; - } else - for ( ; buf[i]; i++) - if (i && ' ' == buf[i]) { - if ('\\' != buf[i - 1]) - break; - } else if (' ' == buf[i]) - break; +/* ARGSUSED */ +static int +obsolete(MACRO_PROT_ARGS) +{ - /* If not end-of-line, terminate argument. */ + return(mdoc_pwarn(m, line, ppos, EOBS)); +} - if (buf[i]) - buf[i++] = 0; - /* Read to next argument. */ +/* + * Phrases occur within `Bl -column' entries, separated by `Ta' or tabs. + * They're unusual because they're basically free-form text until a + * macro is encountered. + */ +static int +phrase(struct mdoc *m, int line, int ppos, char *buf) +{ + int la, pos; + enum margerr ac; + enum mdoct ntok; + char *p; - for ( ; buf[i] && ' ' == buf[i]; i++) - /* Spin. */ ; + for (pos = ppos; ; ) { + la = pos; - /* - * If we're a non-quoted string, try to look up the - * value as a macro and execute it, if found. - */ + /* Note: no calling context! */ + ac = mdoc_zargs(m, line, &pos, buf, 0, &p); - c = quoted ? MDOC_MAX : - mdoc_tokhash_find(mdoc->htab, &buf[la]); + if (ARGS_ERROR == ac) + return(0); + if (ARGS_EOLN == ac) + break; - if (MDOC_MAX != c) { - if ( ! mdoc_macro(mdoc, c, line, la, &i, buf)) + ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p); + + if (MDOC_MAX == ntok) { + if ( ! mdoc_word_alloc(m, line, la, p)) return(0); - return(append_delims(mdoc, line, &i, buf)); + continue; } - /* A regular word or quoted string. */ - - if ( ! mdoc_word_alloc(mdoc, line, la, &buf[la])) + if ( ! mdoc_macro(m, ntok, line, la, &pos, buf)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; + return(append_delims(m, line, &pos, buf)); } return(1); } + +