=================================================================== RCS file: /cvs/mandoc/mdoc_macro.c,v retrieving revision 1.14 retrieving revision 1.129 diff -u -p -r1.14 -r1.129 --- mandoc/mdoc_macro.c 2009/06/17 19:02:26 1.14 +++ mandoc/mdoc_macro.c 2014/01/21 10:26:53 1.129 @@ -1,6 +1,7 @@ -/* $Id: mdoc_macro.c,v 1.14 2009/06/17 19:02:26 kristaps Exp $ */ +/* $Id: mdoc_macro.c,v 1.129 2014/01/21 10:26:53 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008-2012 Kristaps Dzonsons + * Copyright (c) 2010, 2012, 2013 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -14,284 +15,207 @@ * 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 "mdoc.h" +#include "mandoc.h" #include "libmdoc.h" +#include "libmandoc.h" -enum mwarn { - WIGNE, - WIMPBRK, - WMACPARM, - WOBS +enum rew { /* see rew_dohalt() */ + REWIND_NONE, + REWIND_THIS, + REWIND_MORE, + REWIND_FORCE, + REWIND_LATER, + REWIND_ERROR }; -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); +static int phrase_ta(MACRO_PROT_ARGS); -#define REWIND_REWIND (1 << 0) -#define REWIND_NOHALT (1 << 1) -#define REWIND_HALT (1 << 2) +static int dword(struct mdoc *, int, int, const char *, + enum mdelim, int); +static int append_delims(struct mdoc *, + int, int *, char *); +static enum mdoct lookup(enum mdoct, const char *); +static enum mdoct lookup_raw(const char *); +static int make_pending(struct mdoc_node *, enum mdoct, + struct mdoc *, int, int); +static int phrase(struct mdoc *, int, int, char *); +static enum mdoct rew_alt(enum mdoct); +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 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] = { - { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */ + { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* 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 */ - { blk_part_imp, MDOC_PARSED }, /* D1 */ - { blk_part_imp, MDOC_PARSED }, /* Dl */ + { blk_full, MDOC_PARSED | MDOC_JOIN }, /* Sh */ + { blk_full, MDOC_PARSED | MDOC_JOIN }, /* Ss */ + { in_line_eoln, 0 }, /* Pp */ + { blk_part_imp, MDOC_PARSED | MDOC_JOIN }, /* D1 */ + { blk_part_imp, MDOC_PARSED | MDOC_JOIN }, /* Dl */ { blk_full, MDOC_EXPLICIT }, /* Bd */ - { blk_exp_close, MDOC_EXPLICIT }, /* Ed */ + { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ed */ { blk_full, MDOC_EXPLICIT }, /* Bl */ - { blk_exp_close, MDOC_EXPLICIT }, /* El */ - { blk_full, MDOC_PARSED }, /* It */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* An */ + { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* El */ + { blk_full, MDOC_PARSED | MDOC_JOIN }, /* It */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */ + { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* An */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */ - { in_line_eoln, MDOC_CALLABLE }, /* Cd */ + { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Cd */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Er */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Er */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */ { in_line_eoln, 0 }, /* Ex */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fa */ - { in_line_eoln, 0 }, /* Fd */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fa */ + { in_line_eoln, 0 }, /* Fd */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ft */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */ - { in_line_eoln, 0 }, /* In */ /* FIXME: historic usage! */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Li */ - { in_line_eoln, 0 }, /* Nd */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Fn */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ft */ + { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ic */ + { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* In */ + { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Li */ + { blk_full, MDOC_JOIN }, /* Nd */ + { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */ { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Op */ { obsolete, 0 }, /* Ot */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */ { in_line_eoln, 0 }, /* Rv */ - { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* St */ + { 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 */ - { in_line_eoln, 0 }, /* %A */ - { in_line_eoln, 0 }, /* %B */ - { in_line_eoln, 0 }, /* %D */ - { in_line_eoln, 0 }, /* %I */ - { in_line_eoln, 0 }, /* %J */ + { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */ + { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */ + { in_line_eoln, MDOC_JOIN }, /* %A */ + { in_line_eoln, MDOC_JOIN }, /* %B */ + { in_line_eoln, MDOC_JOIN }, /* %D */ + { in_line_eoln, MDOC_JOIN }, /* %I */ + { in_line_eoln, MDOC_JOIN }, /* %J */ { in_line_eoln, 0 }, /* %N */ - { in_line_eoln, 0 }, /* %O */ + { in_line_eoln, MDOC_JOIN }, /* %O */ { in_line_eoln, 0 }, /* %P */ - { in_line_eoln, 0 }, /* %R */ - { in_line_eoln, 0 }, /* %T */ + { in_line_eoln, MDOC_JOIN }, /* %R */ + { in_line_eoln, MDOC_JOIN }, /* %T */ { in_line_eoln, 0 }, /* %V */ - { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ac */ - { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ao */ - { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */ + { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Ac */ + { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Ao */ + { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Aq */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* At */ - { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Bc */ - { blk_full, MDOC_EXPLICIT }, /* Bf */ - { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Bo */ - { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Bq */ + { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Bc */ + { blk_full, MDOC_EXPLICIT }, /* Bf */ + { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Bo */ + { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Bq */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bsx */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Bx */ { in_line_eoln, 0 }, /* Db */ - { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Dc */ - { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Do */ - { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Dq */ - { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ec */ - { blk_exp_close, MDOC_EXPLICIT }, /* Ef */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Em */ + { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Dc */ + { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Do */ + { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Dq */ + { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ec */ + { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ef */ + { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Em */ { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Eo */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Fx */ { 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 | + MDOC_IGNDELIM | MDOC_JOIN }, /* No */ + { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | + MDOC_IGNDELIM | MDOC_JOIN }, /* 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 */ - { 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 */ - { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Ql */ - { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Qo */ - { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Qq */ - { blk_exp_close, MDOC_EXPLICIT }, /* Re */ + { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Pc */ + { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Pf */ + { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Po */ + { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Pq */ + { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Qc */ + { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ql */ + { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Qo */ + { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Qq */ + { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Re */ { blk_full, MDOC_EXPLICIT }, /* Rs */ - { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Sc */ - { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* So */ - { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED }, /* Sq */ + { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Sc */ + { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* So */ + { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sq */ { in_line_eoln, 0 }, /* Sm */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sx */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sy */ + { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sx */ + { in_line, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Sy */ { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */ - { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ux */ + { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ux */ { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */ { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Xo */ - { blk_full, MDOC_EXPLICIT | MDOC_CALLABLE }, /* Fo */ - { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Fc */ - { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Oo */ - { blk_exp_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Oc */ + { blk_full, MDOC_EXPLICIT | MDOC_CALLABLE }, /* Fo */ + { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Fc */ + { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Oo */ + { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Oc */ { blk_full, MDOC_EXPLICIT }, /* Bk */ - { blk_exp_close, MDOC_EXPLICIT }, /* Ek */ + { blk_exp_close, MDOC_EXPLICIT | MDOC_JOIN }, /* Ek */ { in_line_eoln, 0 }, /* Bt */ { in_line_eoln, 0 }, /* Hf */ { obsolete, 0 }, /* Fr */ { in_line_eoln, 0 }, /* Ud */ - { in_line_eoln, 0 }, /* Lb */ - { in_line, 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 */ - { in_line_eoln, 0 }, /* %C */ + { in_line, 0 }, /* Lb */ + { 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 | MDOC_JOIN }, /* Brq */ + { blk_part_exp, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Bro */ + { blk_exp_close, MDOC_CALLABLE | MDOC_PARSED | + MDOC_EXPLICIT | MDOC_JOIN }, /* Brc */ + { in_line_eoln, MDOC_JOIN }, /* %C */ { obsolete, 0 }, /* Es */ { obsolete, 0 }, /* En */ { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Dx */ - { in_line_eoln, 0 }, /* %Q */ + { in_line_eoln, MDOC_JOIN }, /* %Q */ + { in_line_eoln, 0 }, /* br */ + { in_line_eoln, 0 }, /* sp */ + { in_line_eoln, 0 }, /* %U */ + { phrase_ta, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ta */ }; 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) -{ - const char *n, *t, *tt; - - n = t = ""; - tt = "block"; - - switch (type) { - case (MDOC_BODY): - tt = "multi-line"; - break; - case (MDOC_HEAD): - tt = "line"; - break; - default: - break; - } - - 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)); -} - - /* * This is called at the end of parsing. It must traverse up the tree, * closing out open [implicit] scopes. Obviously, open explicit scopes @@ -305,60 +229,83 @@ mdoc_macroend(struct mdoc *mdoc) /* Scan for open explicit scopes. */ n = MDOC_VALID & mdoc->last->flags ? - mdoc->last->parent : mdoc->last; + 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(nerr(mdoc, n, EOPEN)); - } + for ( ; n; n = n->parent) + if (MDOC_BLOCK == n->type && + MDOC_EXPLICIT & mdoc_macros[n->tok].flags) + mdoc_nmsg(mdoc, n, MANDOCERR_SCOPEEXIT); + /* Rewind to the first. */ + return(rew_last(mdoc, mdoc->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(enum mdoct from, const char *p) { - int res; - res = mdoc_hash_find(mdoc->htab, p); - if (MDOC_PARSED & mdoc_macros[from].flags) + 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) +{ + enum mdoct res; + + 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) { + struct mdoc_node *n, *np; assert(to); mdoc->next = MDOC_NEXT_SIBLING; /* LINTED */ while (mdoc->last != to) { + /* + * Save the parent here, because we may delete the + * mdoc->last node in the post-validation phase and reset + * it to mdoc->last->parent, causing a step in the closing + * out to be lost. + */ + np = mdoc->last->parent; if ( ! mdoc_valid_post(mdoc)) return(0); - if ( ! mdoc_action_post(mdoc)) - return(0); - mdoc->last = mdoc->last->parent; + n = mdoc->last; + mdoc->last = np; assert(mdoc->last); + mdoc->last->last = n; } - if ( ! mdoc_valid_post(mdoc)) - return(0); - return(mdoc_action_post(mdoc)); + return(mdoc_valid_post(mdoc)); } -static int -rew_alt(int tok) +/* + * For a block closing macro, return the corresponding opening one. + * Otherwise, return the macro itself. + */ +static enum mdoct +rew_alt(enum mdoct tok) { switch (tok) { case (MDOC_Ac): @@ -394,201 +341,124 @@ rew_alt(int tok) case (MDOC_Xc): return(MDOC_Xo); default: - break; + return(tok); } - abort(); /* NOTREACHED */ } -/* - * Rewind rules. This indicates whether to stop rewinding - * (REWIND_HALT) without touching our current scope, stop rewinding and - * close our current scope (REWIND_REWIND), or continue (REWIND_NOHALT). - * The scope-closing and so on occurs in the various rew_* routines. +/* + * Rewinding to tok, how do we have to handle *p? + * REWIND_NONE: *p would delimit tok, but no tok scope is open + * inside *p, so there is no need to rewind anything at all. + * REWIND_THIS: *p matches tok, so rewind *p and nothing else. + * REWIND_MORE: *p is implicit, rewind it and keep searching for tok. + * REWIND_FORCE: *p is explicit, but tok is full, force rewinding *p. + * REWIND_LATER: *p is explicit and still open, postpone rewinding. + * REWIND_ERROR: No tok block is open at all. */ -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) { + /* + * No matching token, no delimiting block, no broken block. + * This can happen when full implicit macros are called for + * the first time but try to rewind their previous + * instance anyway. + */ if (MDOC_ROOT == p->type) - return(REWIND_HALT); - if (MDOC_VALID & p->flags) - return(REWIND_NOHALT); + return(MDOC_BLOCK == type && + MDOC_EXPLICIT & mdoc_macros[tok].flags ? + REWIND_ERROR : REWIND_NONE); + /* + * When starting to rewind, skip plain text + * and nodes that have already been rewound. + */ + if (MDOC_TEXT == p->type || MDOC_VALID & p->flags) + return(REWIND_MORE); + + /* + * The easiest case: Found a matching token. + * This applies to both blocks and elements. + */ + tok = rew_alt(tok); + if (tok == p->tok) + return(p->end ? REWIND_NONE : + type == p->type ? REWIND_THIS : REWIND_MORE); + + /* + * While elements do require rewinding for themselves, + * they never affect rewinding of other nodes. + */ + if (MDOC_ELEM == p->type) + return(REWIND_MORE); + + /* + * Blocks delimited by our target token get REWIND_MORE. + * Blocks delimiting our target token get REWIND_NONE. + */ switch (tok) { - 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); + case (MDOC_Bl): + if (MDOC_It == p->tok) + return(REWIND_MORE); break; 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); + return(REWIND_NONE); 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; - 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 */ + /* + * XXX Badly nested block handling still fails badly + * when one block is breaking two blocks of the same type. + * This is an incomplete and extremely ugly workaround, + * required to let the OpenBSD tree build. + */ 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); + if (MDOC_Op == p->tok) + return(REWIND_MORE); break; - - /* Multi-line explicit scope close. */ - case (MDOC_Ac): + case (MDOC_Nm): + return(REWIND_NONE); + case (MDOC_Nd): /* 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 && rew_alt(tok) == p->tok) - return(REWIND_REWIND); - break; - default: - abort(); - /* NOTREACHED */ - } - - return(REWIND_NOHALT); -} - - -/* - * See if we can break an encountered scope (the rew_dohalt has returned - * REWIND_NOHALT). - */ -static int -rew_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) { - case (MDOC_It): - return(MDOC_It == p->tok); case (MDOC_Ss): - return(MDOC_Ss == p->tok); + if (MDOC_BODY == p->type && MDOC_Sh == p->tok) + return(REWIND_NONE); + /* FALLTHROUGH */ case (MDOC_Sh): - if (MDOC_Ss == p->tok) - return(1); - return(MDOC_Sh == p->tok); - case (MDOC_El): - if (MDOC_It == p->tok) - return(1); + if (MDOC_Nd == p->tok || MDOC_Ss == p->tok || + MDOC_Sh == p->tok) + return(REWIND_MORE); break; - case (MDOC_Oc): - /* XXX - experimental! */ - if (MDOC_Op == p->tok) - return(1); - break; default: break; } - if (MDOC_EXPLICIT & mdoc_macros[tok].flags) - return(p->tok == rew_alt(tok)); - else if (MDOC_BLOCK == p->type) - return(1); + /* + * Default block rewinding rules. + * In particular, always skip block end markers, + * and let all blocks rewind Nm children. + */ + if (ENDBODY_NOT != p->end || MDOC_Nm == p->tok || + (MDOC_BLOCK == p->type && + ! (MDOC_EXPLICIT & mdoc_macros[tok].flags))) + return(REWIND_MORE); - return(tok == p->tok); + /* + * By default, closing out full blocks + * forces closing of broken explicit blocks, + * while closing out partial blocks + * allows delayed rewinding by default. + */ + return (&blk_full == mdoc_macros[tok].fp ? + REWIND_FORCE : REWIND_LATER); } static int -rew_elem(struct mdoc *mdoc, int tok) +rew_elem(struct mdoc *mdoc, enum mdoct tok) { struct mdoc_node *n; @@ -602,101 +472,219 @@ rew_elem(struct mdoc *mdoc, int tok) } +/* + * We are trying to close a block identified by tok, + * but the child block *broken is still open. + * Thus, postpone closing the tok block + * until the rew_sub call closing *broken. + */ static int -rew_subblock(enum mdoc_type type, struct mdoc *mdoc, - int tok, int line, int ppos) +make_pending(struct mdoc_node *broken, enum mdoct tok, + struct mdoc *mdoc, int line, int ppos) { - struct mdoc_node *n; - int c; + struct mdoc_node *breaker; - /* LINTED */ - for (n = mdoc->last; n; n = n->parent) { - c = rew_dohalt(tok, type, n); - if (REWIND_HALT == c) - return(1); - if (REWIND_REWIND == c) - break; - else if (rew_dobreak(tok, n)) + /* + * Iterate backwards, searching for the block matching tok, + * that is, the block breaking the *broken block. + */ + for (breaker = broken->parent; breaker; breaker = breaker->parent) { + + /* + * If the *broken block had already been broken before + * and we encounter its breaker, make the tok block + * pending on the inner breaker. + * Graphically, "[A breaker=[B broken=[C->B B] tok=A] C]" + * becomes "[A broken=[B [C->B B] tok=A] C]" + * and finally "[A [B->A [C->B B] A] C]". + */ + if (breaker == broken->pending) { + broken = breaker; continue; - if ( ! swarn(mdoc, type, line, ppos, n)) - return(0); + } + + if (REWIND_THIS != rew_dohalt(tok, MDOC_BLOCK, breaker)) + continue; + if (MDOC_BODY == broken->type) + broken = broken->parent; + + /* + * Found the breaker. + * If another, outer breaker is already pending on + * the *broken block, we must not clobber the link + * to the outer breaker, but make it pending on the + * new, now inner breaker. + * Graphically, "[A breaker=[B broken=[C->A A] tok=B] C]" + * becomes "[A breaker=[B->A broken=[C A] tok=B] C]" + * and finally "[A [B->A [C->B A] B] C]". + */ + if (broken->pending) { + struct mdoc_node *taker; + + /* + * If the breaker had also been broken before, + * it cannot take on the outer breaker itself, + * but must hand it on to its own breakers. + * Graphically, this is the following situation: + * "[A [B breaker=[C->B B] broken=[D->A A] tok=C] D]" + * "[A taker=[B->A breaker=[C->B B] [D->C A] C] D]" + */ + taker = breaker; + while (taker->pending) + taker = taker->pending; + taker->pending = broken->pending; + } + broken->pending = breaker; + mandoc_vmsg(MANDOCERR_SCOPENEST, mdoc->parse, line, ppos, + "%s breaks %s", mdoc_macronames[tok], + mdoc_macronames[broken->tok]); + return(1); } - assert(n); - return(rew_last(mdoc, n)); + /* + * Found no matching block for tok. + * Are you trying to close a block that is not open? + */ + return(0); } static int -rew_expblock(struct mdoc *mdoc, int tok, int line, int ppos) +rew_sub(enum mdoc_type t, struct mdoc *mdoc, + enum mdoct 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) + n = mdoc->last; + while (n) { + switch (rew_dohalt(tok, t, n)) { + case (REWIND_NONE): + return(1); + case (REWIND_THIS): + n->lastline = line - + (MDOC_NEWLINE & mdoc->flags && + ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)); break; - else if (rew_dobreak(tok, n)) + case (REWIND_FORCE): + mandoc_vmsg(MANDOCERR_SCOPEBROKEN, mdoc->parse, + line, ppos, "%s breaks %s", + mdoc_macronames[tok], + mdoc_macronames[n->tok]); + /* FALLTHROUGH */ + case (REWIND_MORE): + n->lastline = line - + (MDOC_NEWLINE & mdoc->flags ? 1 : 0); + n = n->parent; continue; - if ( ! swarn(mdoc, MDOC_BLOCK, line, ppos, n)) - return(0); + case (REWIND_LATER): + if (make_pending(n, tok, mdoc, line, ppos) || + MDOC_BLOCK != t) + return(1); + /* FALLTHROUGH */ + case (REWIND_ERROR): + mdoc_pmsg(mdoc, line, ppos, MANDOCERR_NOSCOPE); + return(1); + } + break; } assert(n); - return(rew_last(mdoc, n)); -} + if ( ! rew_last(mdoc, n)) + return(0); + /* + * The current block extends an enclosing block. + * Now that the current block ends, close the enclosing block, too. + */ + while (NULL != (n = n->pending)) { + if ( ! rew_last(mdoc, n)) + return(0); + if (MDOC_HEAD == n->type && + ! mdoc_body_alloc(mdoc, n->line, n->pos, n->tok)) + return(0); + } + return(1); +} + +/* + * Allocate a word and check whether it's punctuation or not. + * Punctuation consists of those tokens found in mdoc_isdelim(). + */ static int -rew_impblock(struct mdoc *mdoc, int tok, int line, int ppos) +dword(struct mdoc *mdoc, int line, int col, const char *p, + enum mdelim d, int may_append) { - struct mdoc_node *n; - int c; + + if (DELIM_MAX == d) + d = mdoc_isdelim(p); - /* 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)) - return(0); + if (may_append && + ! ((MDOC_SYNOPSIS | MDOC_KEEP | MDOC_SMOFF) & mdoc->flags) && + DELIM_NONE == d && MDOC_TEXT == mdoc->last->type && + DELIM_NONE == mdoc_isdelim(mdoc->last->string)) { + mdoc_word_append(mdoc, p); + return(1); } - assert(n); - return(rew_last(mdoc, n)); -} + if ( ! mdoc_word_alloc(mdoc, line, col, p)) + return(0); + if (DELIM_OPEN == d) + mdoc->last->flags |= MDOC_DELIMO; + /* + * Closing delimiters only suppress the preceding space + * when they follow something, not when they start a new + * block or element, and not when they follow `No'. + * + * XXX Explicitly special-casing MDOC_No here feels + * like a layering violation. Find a better way + * and solve this in the code related to `No'! + */ + + else if (DELIM_CLOSE == d && mdoc->last->prev && + mdoc->last->prev->tok != MDOC_No && + mdoc->last->parent->tok != MDOC_Fd) + mdoc->last->flags |= MDOC_DELIMC; + + return(1); +} + static int append_delims(struct mdoc *mdoc, int line, int *pos, char *buf) { - int c, lastarg; + int la; + enum margserr ac; char *p; - if (0 == buf[*pos]) + if ('\0' == buf[*pos]) return(1); for (;;) { - lastarg = *pos; - c = mdoc_args(mdoc, line, pos, buf, 0, &p); - assert(ARGS_PHRASE != c); + la = *pos; + ac = mdoc_zargs(mdoc, line, pos, buf, &p); - 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; + + dword(mdoc, line, la, p, DELIM_MAX, 1); + + /* + * If we encounter end-of-sentence symbols, then trigger + * the double-space. + * + * XXX: it's easy to allow this to propagate outward to + * the last symbol, such that `. )' will cause the + * correct double-spacing. However, (1) groff isn't + * smart enough to do this and (2) it would require + * knowing which symbols break this behaviour, for + * example, `. ;' shouldn't propagate the double-space. + */ + if (mandoc_eos(p, strlen(p))) + mdoc->last->flags |= MDOC_EOS; } return(1); @@ -709,110 +697,183 @@ append_delims(struct mdoc *mdoc, int line, int *pos, c static int blk_exp_close(MACRO_PROT_ARGS) { - int j, c, lastarg, maxargs, flushed; + struct mdoc_node *body; /* Our own body. */ + struct mdoc_node *later; /* A sub-block starting later. */ + struct mdoc_node *n; /* For searching backwards. */ + + int j, lastarg, maxargs, flushed, nl; + enum margserr ac; + enum mdoct atok, ntok; char *p; + nl = MDOC_NEWLINE & mdoc->flags; + switch (tok) { case (MDOC_Ec): maxargs = 1; break; + case (MDOC_Ek): + mdoc->flags &= ~MDOC_KEEP; default: maxargs = 0; break; } - if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) { - if (0 == buf[*pos]) { - if ( ! rew_subblock(MDOC_BODY, mdoc, - tok, line, ppos)) + /* + * Search backwards for beginnings of blocks, + * both of our own and of pending sub-blocks. + */ + atok = rew_alt(tok); + body = later = NULL; + for (n = mdoc->last; n; n = n->parent) { + if (MDOC_VALID & n->flags) + continue; + + /* Remember the start of our own body. */ + if (MDOC_BODY == n->type && atok == n->tok) { + if (ENDBODY_NOT == n->end) + body = n; + continue; + } + + if (MDOC_BLOCK != n->type || MDOC_Nm == n->tok) + continue; + if (atok == n->tok) { + assert(body); + + /* + * Found the start of our own block. + * When there is no pending sub block, + * just proceed to closing out. + */ + if (NULL == later) + break; + + /* + * When there is a pending sub block, + * postpone closing out the current block + * until the rew_sub() closing out the sub-block. + */ + make_pending(later, tok, mdoc, line, ppos); + + /* + * Mark the place where the formatting - but not + * the scope - of the current block ends. + */ + if ( ! mdoc_endbody_alloc(mdoc, line, ppos, + atok, body, ENDBODY_SPACE)) return(0); - return(rew_expblock(mdoc, tok, line, ppos)); + break; } - return(perr(mdoc, line, ppos, ENOPARMS)); + + /* + * When finding an open sub block, remember the last + * open explicit block, or, in case there are only + * implicit ones, the first open implicit block. + */ + if (later && + MDOC_EXPLICIT & mdoc_macros[later->tok].flags) + continue; + if (MDOC_It != n->tok) + later = n; } - if ( ! rew_subblock(MDOC_BODY, mdoc, tok, line, ppos)) - return(0); + if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) { + /* FIXME: do this in validate */ + if (buf[*pos]) + mdoc_pmsg(mdoc, line, ppos, MANDOCERR_ARGSLOST); - if (maxargs > 0) { - if ( ! mdoc_tail_alloc(mdoc, line, - ppos, rew_alt(tok))) + if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos)) return(0); - mdoc->next = MDOC_NEXT_CHILD; + return(rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos)); } - for (lastarg = ppos, flushed = j = 0; ; j++) { + if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos)) + return(0); + + if (NULL == later && maxargs > 0) + if ( ! mdoc_tail_alloc(mdoc, line, ppos, rew_alt(tok))) + return(0); + + for (flushed = j = 0; ; j++) { lastarg = *pos; if (j == maxargs && ! flushed) { - if ( ! rew_expblock(mdoc, tok, line, ppos)) + if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos)) return(0); flushed = 1; } - c = mdoc_args(mdoc, line, pos, buf, tok, &p); + ac = mdoc_args(mdoc, 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 ( ! dword(mdoc, line, lastarg, p, DELIM_MAX, + MDOC_JOIN & mdoc_macros[tok].flags)) return(0); - break; - } + continue; + } - if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + if ( ! flushed) { + if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos)) + return(0); + flushed = 1; + } + + mdoc->flags &= ~MDOC_NEWLINE; + + if ( ! mdoc_macro(mdoc, 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, mdoc, tok, line, ppos)) return(0); - if (ppos > 1) + if ( ! nl) return(1); return(append_delims(mdoc, 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, scope, cnt, nc, nl; + enum margverr av; + enum mdoct ntok; + enum margserr ac; + enum mdelim d; + struct mdoc_arg *arg; + char *p; + nl = MDOC_NEWLINE & mdoc->flags; + /* * 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_Lk): + case (MDOC_Mt): /* FALLTHROUGH */ - case (MDOC_Ar): + case (MDOC_Nm): + /* FALLTHROUGH */ + case (MDOC_Pa): nc = 1; break; default: @@ -820,39 +881,36 @@ 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); + av = mdoc_argv(mdoc, line, tok, &arg, pos, buf); - if (ARGV_WORD == c) { + if (ARGV_WORD == av) { *pos = la; break; } - if (ARGV_EOLN == c) + if (ARGV_EOLN == av) break; - if (ARGV_ARG == c) + if (ARGV_ARG == av) continue; mdoc_argv_free(arg); return(0); } - for (cnt = 0, lastpunct = 1;; ) { + for (cnt = scope = 0;; ) { la = *pos; - w = mdoc_args(mdoc, line, pos, buf, tok, &p); + ac = mdoc_args(mdoc, 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 @@ -860,28 +918,27 @@ 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 (scope && ! rew_elem(mdoc, tok)) return(0); if (nc && 0 == cnt) { - if ( ! mdoc_elem_alloc(mdoc, line, ppos, - tok, arg)) + if ( ! mdoc_elem_alloc(mdoc, line, + ppos, tok, arg)) return(0); if ( ! rew_last(mdoc, mdoc->last)) return(0); } else if ( ! nc && 0 == cnt) { mdoc_argv_free(arg); - if ( ! pwarn(mdoc, line, ppos, WIGNE)) - return(0); + mdoc_pmsg(mdoc, line, ppos, + MANDOCERR_MACROEMPTY); } - c = mdoc_macro(mdoc, c, line, la, pos, buf); - if (0 == c) + + if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf)) return(0); - if (ppos > 1) + if ( ! nl) return(1); return(append_delims(mdoc, line, pos, buf)); - } else if (-1 == c) - return(0); + } /* * Non-quote-enclosed punctuation. Set up our scope, if @@ -889,84 +946,130 @@ in_line(MACRO_PROT_ARGS) * the word. */ - d = mdoc_isdelim(p); + d = ARGS_QWORD == ac ? DELIM_NONE : mdoc_isdelim(p); - if (ARGS_QWORD != w && d) { - if (0 == lastpunct && ! rew_elem(mdoc, tok)) + if (DELIM_NONE != d) { + /* + * If we encounter closing punctuation, no word + * has been omitted, no scope is open, and we're + * allowed to have an empty element, then start + * a new scope. `Ar', `Fl', and `Li', only do + * this once per invocation. There may be more + * of these (all of them?). + */ + if (0 == cnt && (nc || MDOC_Li == tok) && + DELIM_CLOSE == d && ! scope) { + if ( ! mdoc_elem_alloc(mdoc, line, + ppos, tok, arg)) + return(0); + if (MDOC_Ar == tok || MDOC_Li == tok || + MDOC_Fl == tok) + cnt++; + scope = 1; + } + /* + * Close out our scope, if one is open, before + * any punctuation. + */ + if (scope && ! rew_elem(mdoc, tok)) return(0); - lastpunct = 1; - } else if (lastpunct) { - c = mdoc_elem_alloc(mdoc, line, ppos, tok, arg); - if (0 == c) + scope = 0; + } else if ( ! scope) { + if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg)) return(0); - mdoc->next = MDOC_NEXT_CHILD; - lastpunct = 0; + scope = 1; } - if ( ! d) + if (DELIM_NONE == d) cnt++; - if ( ! mdoc_word_alloc(mdoc, line, la, p)) + + if ( ! dword(mdoc, line, la, p, d, + MDOC_JOIN & mdoc_macros[tok].flags)) 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 (scope && MDOC_Fl == tok) { + if ( ! rew_elem(mdoc, tok)) + return(0); + scope = 0; + } } - if (0 == lastpunct && ! rew_elem(mdoc, tok)) + if (scope && ! rew_elem(mdoc, 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(mdoc, line, ppos, tok, arg)) return(0); if ( ! rew_last(mdoc, mdoc->last)) return(0); } else if ( ! nc && 0 == cnt) { mdoc_argv_free(arg); - if ( ! pwarn(mdoc, line, ppos, WIGNE)) - return(0); + mdoc_pmsg(mdoc, line, ppos, MANDOCERR_MACROEMPTY); } - if (ppos > 1) + if ( ! nl) return(1); return(append_delims(mdoc, line, pos, buf)); } -/* - * Block full-explicit and full-implicit. - */ static int blk_full(MACRO_PROT_ARGS) { - int c, lastarg, reopen; + int la, nl, nparsed; struct mdoc_arg *arg; + struct mdoc_node *head; /* save of head macro */ + struct mdoc_node *body; /* save of body macro */ + struct mdoc_node *n; + enum mdoc_type mtt; + enum mdoct ntok; + enum margserr ac, lac; + enum margverr av; char *p; + nl = MDOC_NEWLINE & mdoc->flags; + + /* 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, mdoc, tok, line, ppos)) return(0); - if ( ! rew_impblock(mdoc, tok, line, ppos)) + if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos)) return(0); } + /* + * This routine accommodates 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; + av = mdoc_argv(mdoc, line, tok, &arg, pos, buf); - if (ARGV_WORD == c) { - *pos = lastarg; + if (ARGV_WORD == av) { + *pos = la; break; } - if (ARGV_EOLN == c) + if (ARGV_EOLN == av) break; - if (ARGV_ARG == c) + if (ARGV_ARG == av) continue; mdoc_argv_free(arg); @@ -975,286 +1078,456 @@ blk_full(MACRO_PROT_ARGS) if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, arg)) return(0); - mdoc->next = MDOC_NEXT_CHILD; - if (0 == buf[*pos]) { + head = body = NULL; + + /* + * Exception: Heads of `It' macros in `-diag' lists are not + * parsed, even though `It' macros in general are parsed. + */ + nparsed = MDOC_It == tok && + MDOC_Bl == mdoc->last->parent->tok && + LIST_diag == mdoc->last->parent->norm->Bl.type; + + /* + * 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(mdoc, line, ppos, tok)) return(0); - if ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) + head = mdoc->last; + if ( ! rew_sub(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); + body = mdoc->last; } - if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; + if (MDOC_Bk == tok) + mdoc->flags |= MDOC_KEEP; - for (reopen = 0;; ) { - lastarg = *pos; - c = mdoc_args(mdoc, line, pos, buf, tok, &p); + ac = ARGS_ERROR; - if (ARGS_ERROR == c) + for ( ; ; ) { + la = *pos; + /* Initialise last-phrase-type with ARGS_PEND. */ + lac = ARGS_ERROR == ac ? ARGS_PEND : ac; + ac = mdoc_args(mdoc, line, pos, buf, tok, &p); + + if (ARGS_PUNCT == ac) + break; + + if (ARGS_ERROR == ac) return(0); - if (ARGS_EOLN == c) + + if (ARGS_EOLN == ac) { + if (ARGS_PPHRASE != lac && ARGS_PHRASE != lac) + break; + /* + * This is necessary: if the last token on a + * line is a `Ta' or tab, then we'll get + * ARGS_EOLN, so we must be smart enough to + * reopen our scope if the last parse was a + * phrase or partial phrase. + */ + if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos)) + return(0); + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + return(0); + body = mdoc->last; break; - if (ARGS_PHRASE == c) { - if (reopen && ! mdoc_head_alloc - (mdoc, line, ppos, tok)) + } + + /* + * Emit leading punctuation (i.e., punctuation before + * the MDOC_HEAD) for non-phrase types. + */ + + if (NULL == head && + ARGS_PEND != ac && + ARGS_PHRASE != ac && + ARGS_PPHRASE != ac && + ARGS_QWORD != ac && + DELIM_OPEN == mdoc_isdelim(p)) { + if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0)) return(0); - mdoc->next = MDOC_NEXT_CHILD; + continue; + } + + /* Open a head if one hasn't been opened. */ + + if (NULL == head) { + if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) + return(0); + head = mdoc->last; + } + + if (ARGS_PHRASE == ac || + ARGS_PEND == ac || + ARGS_PPHRASE == ac) { /* - * Phrases are self-contained macro phrases used - * in the columnar output of a macro. They need - * special handling. + * If we haven't opened a body yet, rewind the + * head; if we have, rewind that instead. */ - if ( ! phrase(mdoc, line, lastarg, buf)) + + mtt = body ? MDOC_BODY : MDOC_HEAD; + if ( ! rew_sub(mtt, mdoc, tok, line, ppos)) return(0); - if ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) + + /* Then allocate our body context. */ + + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) return(0); + body = mdoc->last; - reopen = 1; + /* + * Process phrases: set whether we're in a + * partial-phrase (this effects line handling) + * then call down into the phrase parser. + */ + + if (ARGS_PPHRASE == ac) + mdoc->flags |= MDOC_PPHRASE; + if (ARGS_PEND == ac && ARGS_PPHRASE == lac) + mdoc->flags |= MDOC_PPHRASE; + + if ( ! phrase(mdoc, line, la, buf)) + return(0); + + mdoc->flags &= ~MDOC_PPHRASE; continue; } - if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) - return(0); + ntok = nparsed || 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 ( ! dword(mdoc, line, la, p, DELIM_MAX, + MDOC_JOIN & mdoc_macros[tok].flags)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; continue; - } + } - if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) + if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf)) return(0); break; } + + if (NULL == head) { + if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) + return(0); + head = mdoc->last; + } - if (1 == ppos && ! append_delims(mdoc, line, pos, buf)) + if (nl && ! append_delims(mdoc, line, pos, buf)) return(0); - if ( ! rew_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) - return(0); + /* If we've already opened our body, exit now. */ + + if (NULL != body) + goto out; + + /* + * 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 = mdoc->last; n && n != head; n = n->parent) { + if (MDOC_BLOCK == n->type && + MDOC_EXPLICIT & mdoc_macros[n->tok].flags && + ! (MDOC_VALID & n->flags)) { + n->pending = head; + return(1); + } + } + + /* Close out scopes to remain in a consistent state. */ + + if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos)) + return(0); if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) return(0); - mdoc->next = MDOC_NEXT_CHILD; +out: + if ( ! (MDOC_FREECOL & mdoc->flags)) + return(1); + + if ( ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos)) + return(0); + if ( ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos)) + return(0); + + mdoc->flags &= ~MDOC_FREECOL; return(1); } -/* - * Block partial-imnplicit scope. - */ static int blk_part_imp(MACRO_PROT_ARGS) { - int lastarg, c; + int la, nl; + enum mdoct ntok; + enum margserr 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; + nl = MDOC_NEWLINE & mdoc->flags; + + /* + * 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_block_alloc(mdoc, line, ppos, tok, NULL)) return(0); - mdoc->next = MDOC_NEXT_CHILD; + blk = mdoc->last; if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; - - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos)) return(0); - mdoc->next = MDOC_NEXT_CHILD; - body = mdoc->last; - /* 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(mdoc, line, pos, buf, tok, &p); - if (ARGS_ERROR == c) + 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 && + DELIM_OPEN == mdoc_isdelim(p)) { + if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; continue; - } + } - if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) + if (NULL == body) { + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + return(0); + body = mdoc->last; + } + + ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); + + if (MDOC_MAX == ntok) { + if ( ! dword(mdoc, line, la, p, DELIM_MAX, + MDOC_JOIN & mdoc_macros[tok].flags)) + return(0); + continue; + } + + if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf)) return(0); break; } + /* Clean-ups to leave in a consistent state. */ + + if (NULL == body) { + if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + return(0); + body = mdoc->last; + } + /* - * 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. + * If there is an open sub-block requiring explicit close-out, + * postpone closing out the current block + * until the rew_sub() call closing out the sub-block. */ + for (n = mdoc->last; n && n != body && n != blk->parent; + n = n->parent) { + if (MDOC_BLOCK == n->type && + MDOC_EXPLICIT & mdoc_macros[n->tok].flags && + ! (MDOC_VALID & n->flags)) { + make_pending(n, tok, mdoc, line, ppos); + if ( ! mdoc_endbody_alloc(mdoc, line, ppos, + tok, body, ENDBODY_NOSPACE)) + return(0); + return(1); + } + } - for (n = mdoc->last; n; n = n->parent) - if (body == n) - break; + /* + * 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. + */ + if (n != body) + mandoc_vmsg(MANDOCERR_SCOPENEST, mdoc->parse, line, ppos, + "%s broken", mdoc_macronames[tok]); - if (NULL == n && ! pwarn(mdoc, body->line, body->pos, WIMPBRK)) - return(0); - - if (n && ! rew_last(mdoc, body)) + if (n && ! rew_sub(MDOC_BODY, mdoc, tok, line, ppos)) return(0); - if (1 == ppos && ! append_delims(mdoc, line, pos, buf)) + /* Standard appending of delimiters. */ + + if (nl && ! append_delims(mdoc, line, pos, buf)) return(0); - if (n && ! rew_last(mdoc, blk)) + /* Rewind scope, if applicable. */ + + if (n && ! rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos)) return(0); + /* Move trailing .Ns out of scope. */ + + for (n = body->child; n && n->next; n = n->next) + /* Do nothing. */ ; + if (n && MDOC_Ns == n->tok) + mdoc_node_relink(mdoc, n); + return(1); } -/* - * Block partial-explicit macros. - */ static int blk_part_exp(MACRO_PROT_ARGS) { - int lastarg, flushed, j, c, maxargs; + int la, nl; + enum margserr 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; + nl = MDOC_NEWLINE & mdoc->flags; /* - * 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)) 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(mdoc, 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; + /* Flush out leading punctuation. */ - for (j = 0; ; j++) { - lastarg = *pos; - if (j == maxargs && ! flushed) { - if ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) + if (NULL == head && ARGS_QWORD != ac && + DELIM_OPEN == mdoc_isdelim(p)) { + assert(NULL == body); + if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0)) return(0); - flushed = 1; - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) + continue; + } + + if (NULL == head) { + assert(NULL == body); + if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) return(0); - mdoc->next = MDOC_NEXT_CHILD; + head = mdoc->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 ( ! dword(mdoc, line, la, p, DELIM_MAX, 0)) 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 ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) + if ( ! rew_sub(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; + body = mdoc->last; + + if (MDOC_Eo == tok) + continue; } - - if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + + assert(NULL != head && NULL != body); + + ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); + + if (MDOC_MAX == ntok) { + if ( ! dword(mdoc, line, la, p, DELIM_MAX, + MDOC_JOIN & mdoc_macros[tok].flags)) + return(0); + continue; + } + + if ( ! mdoc_macro(mdoc, 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(mdoc, line, ppos, tok)) return(0); + + if (NULL == body) { + if ( ! rew_sub(MDOC_HEAD, mdoc, tok, line, ppos)) + return(0); if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) return(0); - mdoc->next = MDOC_NEXT_CHILD; } - if (ppos > 1) + /* Standard appending of delimiters. */ + + if ( ! nl) return(1); return(append_delims(mdoc, line, pos, buf)); } -/* - * In-line macros where reserved words signal closure of the macro. - * Macros also have a fixed number of arguments. - */ +/* ARGSUSED */ static int in_line_argn(MACRO_PROT_ARGS) { - int lastarg, flushed, j, c, maxargs; - struct mdoc_arg *arg; - char *p; + int la, flushed, j, maxargs, nl; + enum margserr ac; + enum margverr av; + 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. + nl = MDOC_NEWLINE & mdoc->flags; + + /* + * 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) { @@ -1267,228 +1540,295 @@ in_line_argn(MACRO_PROT_ARGS) case (MDOC_Ux): maxargs = 0; break; + case (MDOC_Bx): + /* FALLTHROUGH */ + 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; + av = mdoc_argv(mdoc, line, tok, &arg, pos, buf); - if (ARGV_WORD == c) { - *pos = lastarg; + if (ARGV_WORD == av) { + *pos = la; break; } - if (ARGV_EOLN == c) + if (ARGV_EOLN == av) break; - if (ARGV_ARG == c) + if (ARGV_ARG == av) continue; mdoc_argv_free(arg); 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(mdoc, 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 && + DELIM_OPEN == mdoc_isdelim(p)) { + if ( ! dword(mdoc, line, la, p, DELIM_OPEN, 0)) + return(0); + continue; + } else if (0 == j) + if ( ! mdoc_elem_alloc(mdoc, line, la, tok, arg)) + return(0); + if (j == maxargs && ! flushed) { if ( ! rew_elem(mdoc, 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 (MDOC_MAX != ntok) { if ( ! flushed && ! rew_elem(mdoc, tok)) return(0); flushed = 1; - if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) + if ( ! mdoc_macro(mdoc, ntok, line, la, pos, buf)) return(0); + j++; break; } if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) && - ! flushed && mdoc_isdelim(p)) { + ARGS_QWORD != ac && + ! flushed && + DELIM_NONE != mdoc_isdelim(p)) { if ( ! rew_elem(mdoc, tok)) return(0); flushed = 1; } - - if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) + + if ( ! dword(mdoc, line, la, p, DELIM_MAX, + MDOC_JOIN & mdoc_macros[tok].flags)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; + j++; } + if (0 == j && ! mdoc_elem_alloc(mdoc, line, la, tok, arg)) + return(0); + + /* Close out in a consistent state. */ + if ( ! flushed && ! rew_elem(mdoc, tok)) return(0); - - if (ppos > 1) + if ( ! nl) return(1); return(append_delims(mdoc, 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 la; + enum margserr ac; + enum margverr av; + struct mdoc_arg *arg; + char *p; + enum mdoct ntok; assert( ! (MDOC_PARSED & mdoc_macros[tok].flags)); - arg = NULL; + if (tok == MDOC_Pp) + rew_sub(MDOC_BLOCK, mdoc, MDOC_Nm, line, ppos); - for (;;) { + /* Parse macro arguments. */ + + for (arg = NULL; ; ) { la = *pos; - c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); + av = mdoc_argv(mdoc, line, tok, &arg, pos, buf); - if (ARGV_WORD == c) { + if (ARGV_WORD == av) { *pos = la; break; } - if (ARGV_EOLN == c) + if (ARGV_EOLN == av) break; - if (ARGV_ARG == c) + if (ARGV_ARG == av) continue; mdoc_argv_free(arg); return(0); } + /* Open element scope. */ + if ( ! mdoc_elem_alloc(mdoc, 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(mdoc, 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 ( ! dword(mdoc, line, la, p, DELIM_MAX, + MDOC_JOIN & mdoc_macros[tok].flags)) 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(mdoc, tok)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; + return(mdoc_macro(mdoc, ntok, line, la, pos, buf)); } + /* Close out (no delimiters). */ + return(rew_elem(mdoc, tok)); } /* ARGSUSED */ static int +ctx_synopsis(MACRO_PROT_ARGS) +{ + int nl; + + nl = MDOC_NEWLINE & mdoc->flags; + + /* If we're not in the SYNOPSIS, go straight to in-line. */ + if ( ! (MDOC_SYNOPSIS & mdoc->flags)) + return(in_line(mdoc, tok, line, ppos, pos, buf)); + + /* If we're a nested call, same place. */ + if ( ! nl) + return(in_line(mdoc, tok, line, ppos, pos, buf)); + + /* + * 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. + */ + if (MDOC_Nm == tok) + return(blk_full(mdoc, tok, line, ppos, pos, buf)); + assert(MDOC_Vt == tok); + return(blk_part_imp(mdoc, tok, line, ppos, pos, buf)); +} + + +/* ARGSUSED */ +static int obsolete(MACRO_PROT_ARGS) { - return(pwarn(mdoc, line, ppos, WOBS)); + mdoc_pmsg(mdoc, line, ppos, MANDOCERR_MACROOBS); + return(1); } +/* + * 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 *mdoc, int line, int ppos, char *buf) { - int i, la, c, quoted; + int la, pos; + enum margserr ac; + enum mdoct ntok; + char *p; - /* - * 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. - */ + for (pos = ppos; ; ) { + la = pos; - for (i = ppos; buf[i]; ) { - assert(' ' != buf[i]); - la = i; - quoted = 0; + ac = mdoc_zargs(mdoc, line, &pos, buf, &p); - /* - * 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 (ARGS_ERROR == ac) + return(0); + if (ARGS_EOLN == ac) + break; - 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; + ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p); - /* If not end-of-line, terminate argument. */ + if (MDOC_MAX == ntok) { + if ( ! dword(mdoc, line, la, p, DELIM_MAX, 1)) + return(0); + continue; + } - if (buf[i]) - buf[i++] = 0; + if ( ! mdoc_macro(mdoc, ntok, line, la, &pos, buf)) + return(0); + return(append_delims(mdoc, line, &pos, buf)); + } - /* Read to next argument. */ + return(1); +} - for ( ; buf[i] && ' ' == buf[i]; i++) - /* Spin. */ ; - /* - * If we're a non-quoted string, try to look up the - * value as a macro and execute it, if found. - */ +/* ARGSUSED */ +static int +phrase_ta(MACRO_PROT_ARGS) +{ + struct mdoc_node *n; + int la; + enum mdoct ntok; + enum margserr ac; + char *p; - c = quoted ? MDOC_MAX : - mdoc_hash_find(mdoc->htab, &buf[la]); + /* Make sure we are in a column list or ignore this macro. */ + n = mdoc->last; + while (NULL != n && MDOC_Bl != n->tok) + n = n->parent; + if (NULL == n || LIST_column != n->norm->Bl.type) { + mdoc_pmsg(mdoc, line, ppos, MANDOCERR_STRAYTA); + return(1); + } - if (MDOC_MAX != c) { - if ( ! mdoc_macro(mdoc, c, line, la, &i, buf)) + /* Advance to the next column. */ + if ( ! rew_sub(MDOC_BODY, mdoc, MDOC_It, line, ppos)) + return(0); + if ( ! mdoc_body_alloc(mdoc, line, ppos, MDOC_It)) + return(0); + + for (;;) { + la = *pos; + ac = mdoc_zargs(mdoc, line, pos, buf, &p); + + if (ARGS_ERROR == ac) + return(0); + if (ARGS_EOLN == ac) + break; + + ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup_raw(p); + + if (MDOC_MAX == ntok) { + if ( ! dword(mdoc, line, la, p, DELIM_MAX, + MDOC_JOIN & mdoc_macros[tok].flags)) 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(mdoc, ntok, line, la, pos, buf)) return(0); - mdoc->next = MDOC_NEXT_SIBLING; + return(append_delims(mdoc, line, pos, buf)); } return(1);