=================================================================== RCS file: /cvs/mandoc/mdoc_macro.c,v retrieving revision 1.107 retrieving revision 1.177 diff -u -p -r1.107 -r1.177 --- mandoc/mdoc_macro.c 2011/04/19 16:38:48 1.107 +++ mandoc/mdoc_macro.c 2015/02/06 01:07:22 1.177 @@ -1,7 +1,7 @@ -/* $Id: mdoc_macro.c,v 1.107 2011/04/19 16:38:48 kristaps Exp $ */ +/* $Id: mdoc_macro.c,v 1.177 2015/02/06 01:07:22 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons - * Copyright (c) 2010 Ingo Schwarze + * Copyright (c) 2008-2012 Kristaps Dzonsons + * Copyright (c) 2010, 2012-2015 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 @@ -15,10 +15,10 @@ * 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 @@ -31,167 +31,173 @@ #include "libmdoc.h" #include "libmandoc.h" -enum rew { /* see rew_dohalt() */ - REWIND_NONE, - REWIND_THIS, - REWIND_MORE, - REWIND_FORCE, - REWIND_LATER, - REWIND_ERROR -}; +static void blk_full(MACRO_PROT_ARGS); +static void blk_exp_close(MACRO_PROT_ARGS); +static void blk_part_exp(MACRO_PROT_ARGS); +static void blk_part_imp(MACRO_PROT_ARGS); +static void ctx_synopsis(MACRO_PROT_ARGS); +static void in_line_eoln(MACRO_PROT_ARGS); +static void in_line_argn(MACRO_PROT_ARGS); +static void in_line(MACRO_PROT_ARGS); +static void phrase_ta(MACRO_PROT_ARGS); -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); - -static int dword(struct mdoc *, int, int, - const char *, enum mdelim); -static int append_delims(struct mdoc *, +static void dword(struct mdoc *, int, int, const char *, + enum mdelim, int); +static void append_delims(struct mdoc *, int, int *, char *); +static enum mdoct lookup(struct mdoc *, enum mdoct, + int, int, const char *); +static int macro_or_word(MACRO_PROT_ARGS, int); +static void make_pending(struct mdoc *, struct mdoc_node *, + struct mdoc_node *, int, int); +static int parse_rest(struct mdoc *, enum mdoct, 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 enum mdoct rew_alt(enum mdoct); +static void rew_elem(struct mdoc *, enum mdoct); +static void rew_last(struct mdoc *, const struct mdoc_node *); +static void rew_pending(struct mdoc *, const struct mdoc_node *); 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_eoln, 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, MDOC_CALLABLE | MDOC_PARSED }, /* 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, 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 }, /* Li */ - { blk_full, 0 }, /* Nd */ - { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */ + { 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 }, /* 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 */ - { ctx_synopsis, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */ + { 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 */ - { in_line_eoln, 0 }, /* %I */ - { in_line_eoln, 0 }, /* %J */ + { 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 | MDOC_IGNDELIM }, /* No */ - { in_line_argn, MDOC_CALLABLE | MDOC_PARSED | MDOC_IGNDELIM }, /* Ns */ + { in_line, MDOC_CALLABLE | MDOC_PARSED | 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 */ + { 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 }, /* 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_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 */ - { in_line_eoln, 0 }, /* Sm */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sx */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sy */ + { 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_argn, 0 }, /* Sm */ + { 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, MDOC_CALLABLE | MDOC_PARSED }, /* Fr */ { in_line_eoln, 0 }, /* Ud */ { 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 }, /* 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 */ - { obsolete, 0 }, /* Es */ - { obsolete, 0 }, /* En */ + { 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 */ + { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Es */ + { blk_part_imp, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* 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 }, /* Ta */ + { phrase_ta, MDOC_CALLABLE | MDOC_PARSED | MDOC_JOIN }, /* Ta */ + { in_line_eoln, MDOC_PROLOGUE }, /* ll */ }; const struct mdoc_macro * const mdoc_macros = __mdoc_macros; @@ -202,85 +208,95 @@ const struct mdoc_macro * const mdoc_macros = __mdoc_m * closing out open [implicit] scopes. Obviously, open explicit scopes * are errors. */ -int -mdoc_macroend(struct mdoc *m) +void +mdoc_macroend(struct mdoc *mdoc) { struct mdoc_node *n; /* Scan for open explicit scopes. */ - n = MDOC_VALID & m->last->flags ? m->last->parent : m->last; + n = mdoc->last->flags & MDOC_VALID ? + mdoc->last->parent : mdoc->last; for ( ; n; n = n->parent) - if (MDOC_BLOCK == n->type && - MDOC_EXPLICIT & mdoc_macros[n->tok].flags) - mdoc_nmsg(m, n, MANDOCERR_SCOPEEXIT); + if (n->type == MDOC_BLOCK && + mdoc_macros[n->tok].flags & MDOC_EXPLICIT) + mandoc_msg(MANDOCERR_BLK_NOEND, mdoc->parse, + n->line, n->pos, mdoc_macronames[n->tok]); /* Rewind to the first. */ - return(rew_last(m, m->first)); + rew_last(mdoc, mdoc->first); } - /* - * Look up a macro from within a subsequent context. + * Look up the macro at *p called by "from", + * or as a line macro if from == MDOC_MAX. */ static enum mdoct -lookup(enum mdoct from, const char *p) +lookup(struct mdoc *mdoc, enum mdoct from, int line, int ppos, 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) -{ enum mdoct res; - if (MDOC_MAX == (res = mdoc_hash_find(p))) - return(MDOC_MAX); - if (MDOC_CALLABLE & mdoc_macros[res].flags) - return(res); + if (from == MDOC_MAX || mdoc_macros[from].flags & MDOC_PARSED) { + res = mdoc_hash_find(p); + if (res != MDOC_MAX) { + if (mdoc_macros[res].flags & MDOC_CALLABLE) + return(res); + if (res != MDOC_br && res != MDOC_sp && res != MDOC_ll) + mandoc_msg(MANDOCERR_MACRO_CALL, + mdoc->parse, line, ppos, p); + } + } return(MDOC_MAX); } - -static int +/* + * Rewind up to and including a specific node. + */ +static void 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 - * m->last node in the post-validation phase and reset - * it to m->last->parent, causing a step in the closing + * 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); + mdoc_valid_post(mdoc); n = mdoc->last; mdoc->last = np; assert(mdoc->last); mdoc->last->last = n; } - - return(mdoc_valid_post(mdoc)); + mdoc_valid_post(mdoc); } +/* + * Rewind up to a specific block, including all blocks that broke it. + */ +static void +rew_pending(struct mdoc *mdoc, const struct mdoc_node *n) +{ + rew_last(mdoc, n); + + if (n->type != MDOC_BLOCK) + return; + + while ((n = n->pending) != NULL) { + rew_last(mdoc, n); + if (n->type == MDOC_HEAD) + mdoc_body_alloc(mdoc, n->line, n->pos, n->tok); + } +} + /* * For a block closing macro, return the corresponding opening one. * Otherwise, return the macro itself. @@ -289,37 +305,37 @@ static enum mdoct rew_alt(enum mdoct tok) { switch (tok) { - case (MDOC_Ac): + case MDOC_Ac: return(MDOC_Ao); - case (MDOC_Bc): + case MDOC_Bc: return(MDOC_Bo); - case (MDOC_Brc): + case MDOC_Brc: return(MDOC_Bro); - case (MDOC_Dc): + case MDOC_Dc: return(MDOC_Do); - case (MDOC_Ec): + case MDOC_Ec: return(MDOC_Eo); - case (MDOC_Ed): + case MDOC_Ed: return(MDOC_Bd); - case (MDOC_Ef): + case MDOC_Ef: return(MDOC_Bf); - case (MDOC_Ek): + case MDOC_Ek: return(MDOC_Bk); - case (MDOC_El): + case MDOC_El: return(MDOC_Bl); - case (MDOC_Fc): + case MDOC_Fc: return(MDOC_Fo); - case (MDOC_Oc): + case MDOC_Oc: return(MDOC_Oo); - case (MDOC_Pc): + case MDOC_Pc: return(MDOC_Po); - case (MDOC_Qc): + case MDOC_Qc: return(MDOC_Qo); - case (MDOC_Re): + case MDOC_Re: return(MDOC_Rs); - case (MDOC_Sc): + case MDOC_Sc: return(MDOC_So); - case (MDOC_Xc): + case MDOC_Xc: return(MDOC_Xo); default: return(tok); @@ -327,118 +343,7 @@ rew_alt(enum mdoct tok) /* NOTREACHED */ } - -/* - * 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 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(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_Bl): - if (MDOC_It == p->tok) - return(REWIND_MORE); - break; - case (MDOC_It): - if (MDOC_BODY == p->type && MDOC_Bl == p->tok) - return(REWIND_NONE); - break; - /* - * 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): - if (MDOC_Op == p->tok) - return(REWIND_MORE); - break; - case (MDOC_Nm): - return(REWIND_NONE); - case (MDOC_Nd): - /* FALLTHROUGH */ - case (MDOC_Ss): - if (MDOC_BODY == p->type && MDOC_Sh == p->tok) - return(REWIND_NONE); - /* FALLTHROUGH */ - case (MDOC_Sh): - if (MDOC_Nd == p->tok || MDOC_Ss == p->tok || - MDOC_Sh == p->tok) - return(REWIND_MORE); - break; - default: - break; - } - - /* - * 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); - - /* - * 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 +static void rew_elem(struct mdoc *mdoc, enum mdoct tok) { struct mdoc_node *n; @@ -448,225 +353,209 @@ rew_elem(struct mdoc *mdoc, enum mdoct tok) n = n->parent; assert(MDOC_ELEM == n->type); assert(tok == n->tok); - - return(rew_last(mdoc, n)); + rew_last(mdoc, n); } - /* - * We are trying to close a block identified by tok, + * We are trying to close the block *breaker, * but the child block *broken is still open. - * Thus, postpone closing the tok block - * until the rew_sub call closing *broken. + * Thus, postpone closing the *breaker + * until the rew_pending() call closing *broken. */ -static int -make_pending(struct mdoc_node *broken, enum mdoct tok, - struct mdoc *m, int line, int ppos) +static void +make_pending(struct mdoc *mdoc, struct mdoc_node *breaker, + struct mdoc_node *broken, int line, int ppos) { - struct mdoc_node *breaker; + struct mdoc_node *n; + mandoc_vmsg(MANDOCERR_BLK_NEST, mdoc->parse, line, ppos, + "%s breaks %s", mdoc_macronames[breaker->tok], + mdoc_macronames[broken->tok]); + /* - * Iterate backwards, searching for the block matching tok, - * that is, the block breaking the *broken block. + * If the *broken block (Z) is already broken by a block (B) + * contained in the breaker (A), make the breaker pending + * on that inner breaker (B). Graphically, + * + * breaker=[A! broken=n=[B!->A (old broken=)[Z->B B] A] Z] + * + * In these graphics, "->" indicates the "pending" pointer and + * "!" indicates the MDOC_BREAK flag. Each of the cases gets + * one additional pointer (B->A) and one additional flag (A!). */ - 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; - } + for (n = broken->parent; ; n = n->parent) + if (n == broken->pending) + broken = n; + else if (n == breaker) + break; - 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, m->parse, line, ppos, - "%s breaks %s", mdoc_macronames[tok], - mdoc_macronames[broken->tok]); - return(1); - } - /* - * Found no matching block for tok. - * Are you trying to close a block that is not open? + * Found the breaker. + * + * If another, outer breaker (X) is already pending on + * the *broken block (B), we must not clobber the link + * to the outer breaker, but make it pending on the new, + * now inner breaker (A). Graphically, + * + * [X! n=breaker=[A!->X broken=[B(->X)->A X] A] B]. */ - return(0); -} + if (broken->pending != NULL) { + n = breaker; -static int -rew_sub(enum mdoc_type t, struct mdoc *m, - enum mdoct tok, int line, int ppos) -{ - struct mdoc_node *n; + /* + * If the inner breaker (A) is already broken, too, + * it cannot take on the outer breaker (X) but must + * hand it on to its own breakers (Y). Graphically, + * + * [X! n=[Y!->X breaker=[A!->Y Y] broken=[B(->X)->A X] A] B] + */ - n = m->last; - while (n) { - switch (rew_dohalt(tok, t, n)) { - case (REWIND_NONE): - return(1); - case (REWIND_THIS): - break; - case (REWIND_FORCE): - mandoc_vmsg(MANDOCERR_SCOPEBROKEN, m->parse, - line, ppos, "%s breaks %s", - mdoc_macronames[tok], - mdoc_macronames[n->tok]); - /* FALLTHROUGH */ - case (REWIND_MORE): - n = n->parent; - continue; - case (REWIND_LATER): - if (make_pending(n, tok, m, line, ppos) || - MDOC_BLOCK != t) - return(1); - /* FALLTHROUGH */ - case (REWIND_ERROR): - mdoc_pmsg(m, line, ppos, MANDOCERR_NOSCOPE); - return(1); - } - break; + while (n->pending) + n = n->pending; + n->pending = broken->pending; } - assert(n); - if ( ! rew_last(m, n)) - return(0); - /* - * The current block extends an enclosing block. - * Now that the current block ends, close the enclosing block, too. + * Now we have reduced the situation to the simplest case: + * breaker=[A! broken=[B->A A] B]. */ - while (NULL != (n = n->pending)) { - if ( ! rew_last(m, n)) - return(0); - if (MDOC_HEAD == n->type && - ! mdoc_body_alloc(m, n->line, n->pos, n->tok)) - return(0); - } - return(1); + broken->pending = breaker; + breaker->flags |= MDOC_BREAK; + if (breaker->body != NULL) + breaker->body->flags |= MDOC_BREAK; } /* * Allocate a word and check whether it's punctuation or not. * Punctuation consists of those tokens found in mdoc_isdelim(). */ -static int -dword(struct mdoc *m, int line, - int col, const char *p, enum mdelim d) +static void +dword(struct mdoc *mdoc, int line, int col, const char *p, + enum mdelim d, int may_append) { - - if (DELIM_MAX == d) + + if (d == DELIM_MAX) d = mdoc_isdelim(p); - if ( ! mdoc_word_alloc(m, line, col, p)) - return(0); + if (may_append && + ! (mdoc->flags & (MDOC_SYNOPSIS | MDOC_KEEP | MDOC_SMOFF)) && + d == DELIM_NONE && mdoc->last->type == MDOC_TEXT && + mdoc_isdelim(mdoc->last->string) == DELIM_NONE) { + mdoc_word_append(mdoc, p); + return; + } - if (DELIM_OPEN == d) - m->last->flags |= MDOC_DELIMO; - else if (DELIM_CLOSE == d) - m->last->flags |= MDOC_DELIMC; + mdoc_word_alloc(mdoc, line, col, p); - return(1); + /* + * If the word consists of a bare delimiter, + * flag the new node accordingly, + * unless doing so was vetoed by the invoking macro. + * Always clear the veto, it is only valid for one word. + */ + + if (d == DELIM_OPEN) + mdoc->last->flags |= MDOC_DELIMO; + else if (d == DELIM_CLOSE && + ! (mdoc->flags & MDOC_NODELIMC) && + mdoc->last->parent->tok != MDOC_Fd) + mdoc->last->flags |= MDOC_DELIMC; + mdoc->flags &= ~MDOC_NODELIMC; } -static int -append_delims(struct mdoc *m, int line, int *pos, char *buf) +static void +append_delims(struct mdoc *mdoc, int line, int *pos, char *buf) { - int la; - enum margserr ac; char *p; + int la; - if ('\0' == buf[*pos]) - return(1); + if (buf[*pos] == '\0') + return; for (;;) { la = *pos; - ac = mdoc_zargs(m, line, pos, buf, &p); - - if (ARGS_ERROR == ac) - return(0); - else if (ARGS_EOLN == ac) + if (mdoc_args(mdoc, line, pos, buf, MDOC_MAX, &p) == ARGS_EOLN) break; + dword(mdoc, line, la, p, DELIM_MAX, 1); - dword(m, line, la, p, DELIM_MAX); - /* * If we encounter end-of-sentence symbols, then trigger * the double-space. * - * XXX: it's easy to allow this to propogate outward to + * 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 propogate the double-space. + * example, `. ;' shouldn't propagate the double-space. */ - if (mandoc_eos(p, strlen(p), 0)) - m->last->flags |= MDOC_EOS; - } - return(1); + if (mandoc_eos(p, strlen(p))) + mdoc->last->flags |= MDOC_EOS; + } } - /* - * Close out block partial/full explicit. + * Parse one word. + * If it is a macro, call it and return 1. + * Otherwise, allocate it and return 0. */ static int +macro_or_word(MACRO_PROT_ARGS, int parsed) +{ + char *p; + enum mdoct ntok; + + p = buf + ppos; + ntok = MDOC_MAX; + if (*p == '"') + p++; + else if (parsed && ! (mdoc->flags & MDOC_PHRASELIT)) + ntok = lookup(mdoc, tok, line, ppos, p); + + if (ntok == MDOC_MAX) { + dword(mdoc, line, ppos, p, DELIM_MAX, tok == MDOC_MAX || + mdoc_macros[tok].flags & MDOC_JOIN); + return(0); + } else { + if (mdoc_macros[tok].fp == in_line_eoln) + rew_elem(mdoc, tok); + mdoc_macro(mdoc, ntok, line, ppos, pos, buf); + if (tok == MDOC_MAX) + append_delims(mdoc, line, pos, buf); + return(1); + } +} + +/* + * Close out block partial/full explicit. + */ +static void blk_exp_close(MACRO_PROT_ARGS) { struct mdoc_node *body; /* Our own body. */ + struct mdoc_node *endbody; /* Our own end marker. */ + struct mdoc_node *itblk; /* An It block starting later. */ struct mdoc_node *later; /* A sub-block starting later. */ - struct mdoc_node *n; /* For searching backwards. */ + struct mdoc_node *n; /* Search back to our block. */ - int j, lastarg, maxargs, flushed, nl; + int j, lastarg, maxargs, nl; enum margserr ac; enum mdoct atok, ntok; char *p; - nl = MDOC_NEWLINE & m->flags; + nl = MDOC_NEWLINE & mdoc->flags; switch (tok) { - case (MDOC_Ec): + case MDOC_Ec: maxargs = 1; break; + case MDOC_Ek: + mdoc->flags &= ~MDOC_KEEP; + /* FALLTHROUGH */ default: maxargs = 0; break; @@ -676,21 +565,29 @@ blk_exp_close(MACRO_PROT_ARGS) * Search backwards for beginnings of blocks, * both of our own and of pending sub-blocks. */ + atok = rew_alt(tok); - body = later = NULL; - for (n = m->last; n; n = n->parent) { - if (MDOC_VALID & n->flags) + body = endbody = itblk = later = NULL; + for (n = mdoc->last; n; n = n->parent) { + if (n->flags & (MDOC_VALID | MDOC_BREAK)) continue; /* Remember the start of our own body. */ - if (MDOC_BODY == n->type && atok == n->tok) { - if (ENDBODY_NOT == n->end) + + if (n->type == MDOC_BODY && atok == n->tok) { + if (n->end == ENDBODY_NOT) body = n; continue; } - if (MDOC_BLOCK != n->type || MDOC_Nm == n->tok) + if (n->type != MDOC_BLOCK || n->tok == MDOC_Nm) continue; + + if (n->tok == MDOC_It) { + itblk = n; + continue; + } + if (atok == n->tok) { assert(body); @@ -699,23 +596,37 @@ blk_exp_close(MACRO_PROT_ARGS) * When there is no pending sub block, * just proceed to closing out. */ - if (NULL == later) + + if (later == NULL || + (tok == MDOC_El && itblk == NULL)) break; - /* - * When there is a pending sub block, - * postpone closing out the current block - * until the rew_sub() closing out the sub-block. + /* + * When there is a pending sub block, postpone + * closing out the current block until the + * rew_pending() closing out the sub-block. */ - make_pending(later, tok, m, line, ppos); + make_pending(mdoc, n, later, line, ppos); + if (tok == MDOC_El) + itblk->flags |= MDOC_BREAK; + /* * Mark the place where the formatting - but not * the scope - of the current block ends. */ - if ( ! mdoc_endbody_alloc(m, line, ppos, - atok, body, ENDBODY_SPACE)) - return(0); + + endbody = mdoc_endbody_alloc(mdoc, line, ppos, + atok, body, ENDBODY_SPACE); + + /* + * If a block closing macro taking arguments + * breaks another block, put the arguments + * into the end marker. + */ + + if (maxargs) + mdoc->next = MDOC_NEXT_CHILD; break; } @@ -724,87 +635,89 @@ blk_exp_close(MACRO_PROT_ARGS) * 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_CALLABLE & mdoc_macros[n->tok].flags) + + if (later == NULL || + ! (mdoc_macros[later->tok].flags & MDOC_EXPLICIT)) later = n; } - if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) { - /* FIXME: do this in validate */ - if (buf[*pos]) - mdoc_pmsg(m, line, ppos, MANDOCERR_ARGSLOST); + if (body == NULL) { + mandoc_msg(MANDOCERR_BLK_NOTOPEN, mdoc->parse, + line, ppos, mdoc_macronames[tok]); + if (maxargs && endbody == NULL) { + /* + * Stray .Ec without previous .Eo: + * Break the output line, keep the arguments. + */ + mdoc_elem_alloc(mdoc, line, ppos, MDOC_br, NULL); + rew_elem(mdoc, MDOC_br); + } + } else if (endbody == NULL) { + rew_last(mdoc, body); + if (maxargs) + mdoc_tail_alloc(mdoc, line, ppos, atok); + } - if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos)) - return(0); - return(rew_sub(MDOC_BLOCK, m, tok, line, ppos)); + if ( ! (mdoc_macros[tok].flags & MDOC_PARSED)) { + if (buf[*pos] != '\0') + mandoc_vmsg(MANDOCERR_ARG_SKIP, + mdoc->parse, line, ppos, + "%s %s", mdoc_macronames[tok], + buf + *pos); + if (endbody == NULL && n != NULL) + rew_pending(mdoc, n); + return; } - if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos)) - return(0); - - if (NULL == later && maxargs > 0) - if ( ! mdoc_tail_alloc(m, line, ppos, rew_alt(tok))) - return(0); - - for (flushed = j = 0; ; j++) { + if (endbody != NULL) + n = endbody; + for (j = 0; ; j++) { lastarg = *pos; - if (j == maxargs && ! flushed) { - if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos)) - return(0); - flushed = 1; + if (j == maxargs && n != NULL) { + rew_pending(mdoc, n); + n = NULL; } - ac = mdoc_args(m, line, pos, buf, tok, &p); - - if (ARGS_ERROR == ac) - return(0); - if (ARGS_PUNCT == ac) + ac = mdoc_args(mdoc, line, pos, buf, tok, &p); + if (ac == ARGS_PUNCT || ac == ARGS_EOLN) break; - if (ARGS_EOLN == ac) - break; - ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); + ntok = ac == ARGS_QWORD ? MDOC_MAX : + lookup(mdoc, tok, line, lastarg, p); - if (MDOC_MAX == ntok) { - if ( ! dword(m, line, lastarg, p, DELIM_MAX)) - return(0); + if (ntok == MDOC_MAX) { + dword(mdoc, line, lastarg, p, DELIM_MAX, + MDOC_JOIN & mdoc_macros[tok].flags); continue; } - if ( ! flushed) { - if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos)) - return(0); - flushed = 1; + if (n != NULL) { + rew_pending(mdoc, n); + n = NULL; } - if ( ! mdoc_macro(m, ntok, line, lastarg, pos, buf)) - return(0); + mdoc->flags &= ~MDOC_NEWLINE; + mdoc_macro(mdoc, ntok, line, lastarg, pos, buf); break; } - if ( ! flushed && ! rew_sub(MDOC_BLOCK, m, tok, line, ppos)) - return(0); - - if ( ! nl) - return(1); - return(append_delims(m, line, pos, buf)); + if (n != NULL) + rew_pending(mdoc, n); + if (nl) + append_delims(mdoc, line, pos, buf); } - -static int +static void in_line(MACRO_PROT_ARGS) { - int la, scope, cnt, nc, nl; - enum margverr av; + int la, scope, cnt, firstarg, mayopen, nc, nl; enum mdoct ntok; enum margserr ac; enum mdelim d; struct mdoc_arg *arg; char *p; - nl = MDOC_NEWLINE & m->flags; + nl = MDOC_NEWLINE & mdoc->flags; /* * Whether we allow ignored elements (those without content, @@ -812,17 +725,17 @@ in_line(MACRO_PROT_ARGS) */ switch (tok) { - case (MDOC_An): + case MDOC_An: /* FALLTHROUGH */ - case (MDOC_Ar): + case MDOC_Ar: /* FALLTHROUGH */ - case (MDOC_Fl): + case MDOC_Fl: /* FALLTHROUGH */ - case (MDOC_Mt): + case MDOC_Mt: /* FALLTHROUGH */ - case (MDOC_Nm): + case MDOC_Nm: /* FALLTHROUGH */ - case (MDOC_Pa): + case MDOC_Pa: nc = 1; break; default: @@ -830,122 +743,132 @@ in_line(MACRO_PROT_ARGS) break; } - for (arg = NULL;; ) { + mdoc_argv(mdoc, line, tok, &arg, pos, buf); + + d = DELIM_NONE; + firstarg = 1; + mayopen = 1; + for (cnt = scope = 0;; ) { la = *pos; - av = mdoc_argv(m, line, tok, &arg, pos, buf); + ac = mdoc_args(mdoc, line, pos, buf, tok, &p); - if (ARGV_WORD == av) { - *pos = la; + /* + * At the end of a macro line, + * opening delimiters do not suppress spacing. + */ + + if (ac == ARGS_EOLN) { + if (d == DELIM_OPEN) + mdoc->last->flags &= ~MDOC_DELIMO; break; - } - if (ARGV_EOLN == av) - break; - if (ARGV_ARG == av) - continue; + } - mdoc_argv_free(arg); - return(0); - } + /* + * The rest of the macro line is only punctuation, + * to be handled by append_delims(). + * If there were no other arguments, + * do not allow the first one to suppress spacing, + * even if it turns out to be a closing one. + */ - for (cnt = scope = 0;; ) { - la = *pos; - ac = mdoc_args(m, line, pos, buf, tok, &p); - - if (ARGS_ERROR == ac) - return(0); - if (ARGS_EOLN == ac) + if (ac == ARGS_PUNCT) { + if (cnt == 0 && (nc == 0 || tok == MDOC_An)) + mdoc->flags |= MDOC_NODELIMC; break; - if (ARGS_PUNCT == ac) - break; + } - ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); + ntok = (ac == ARGS_QWORD || (tok == MDOC_Fn && !cnt)) ? + MDOC_MAX : lookup(mdoc, tok, line, la, p); - /* + /* * In this case, we've located a submacro and must * execute it. Close out scope, if open. If no * elements have been generated, either create one (nc) * or raise a warning. */ - if (MDOC_MAX != ntok) { - if (scope && ! rew_elem(m, tok)) - return(0); - if (nc && 0 == cnt) { - if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg)) - return(0); - if ( ! rew_last(m, m->last)) - return(0); - } else if ( ! nc && 0 == cnt) { + if (ntok != MDOC_MAX) { + if (scope) + rew_elem(mdoc, tok); + if (nc && ! cnt) { + mdoc_elem_alloc(mdoc, line, ppos, tok, arg); + rew_last(mdoc, mdoc->last); + } else if ( ! nc && ! cnt) { mdoc_argv_free(arg); - mdoc_pmsg(m, line, ppos, MANDOCERR_MACROEMPTY); + mandoc_msg(MANDOCERR_MACRO_EMPTY, + mdoc->parse, line, ppos, + mdoc_macronames[tok]); } + mdoc_macro(mdoc, ntok, line, la, pos, buf); + if (nl) + append_delims(mdoc, line, pos, buf); + return; + } - if ( ! mdoc_macro(m, ntok, line, la, pos, buf)) - return(0); - if ( ! nl) - return(1); - return(append_delims(m, line, pos, buf)); - } - - /* + /* * Non-quote-enclosed punctuation. Set up our scope, if * a word; rewind the scope, if a delimiter; then append - * the word. + * the word. */ - d = ARGS_QWORD == ac ? DELIM_NONE : mdoc_isdelim(p); + d = ac == ARGS_QWORD ? DELIM_NONE : mdoc_isdelim(p); if (DELIM_NONE != d) { /* * If we encounter closing punctuation, no word - * has been omitted, no scope is open, and we're + * has been emitted, 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?). + * a new scope. */ - if (0 == cnt && (nc || MDOC_Li == tok) && - DELIM_CLOSE == d && ! scope) { - if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg)) - return(0); - if (MDOC_Ar == tok || MDOC_Li == tok || - MDOC_Fl == tok) - cnt++; + if ((d == DELIM_CLOSE || + (d == DELIM_MIDDLE && tok == MDOC_Fl)) && + !cnt && !scope && nc && mayopen) { + mdoc_elem_alloc(mdoc, line, ppos, tok, arg); scope = 1; + cnt++; + if (tok == MDOC_Nm) + mayopen = 0; } /* * Close out our scope, if one is open, before * any punctuation. */ - if (scope && ! rew_elem(m, tok)) - return(0); + if (scope) + rew_elem(mdoc, tok); scope = 0; - } else if ( ! scope) { - if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg)) - return(0); + if (tok == MDOC_Fn) + mayopen = 0; + } else if (mayopen && !scope) { + mdoc_elem_alloc(mdoc, line, ppos, tok, arg); scope = 1; + cnt++; } - if (DELIM_NONE == d) - cnt++; + dword(mdoc, line, la, p, d, + MDOC_JOIN & mdoc_macros[tok].flags); - if ( ! dword(m, line, la, p, d)) - return(0); + /* + * If the first argument is a closing delimiter, + * do not suppress spacing before it. + */ + if (firstarg && d == DELIM_CLOSE && !nc) + mdoc->last->flags &= ~MDOC_DELIMC; + firstarg = 0; + /* * `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(m, tok)) - return(0); + if (scope && tok == MDOC_Fl) { + rew_elem(mdoc, tok); scope = 0; } } - if (scope && ! rew_elem(m, tok)) - return(0); + if (scope) + rew_elem(mdoc, tok); /* * If no elements have been collected and we're allowed to have @@ -953,49 +876,118 @@ in_line(MACRO_PROT_ARGS) * raise a warning. */ - if (nc && 0 == cnt) { - if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg)) - return(0); - if ( ! rew_last(m, m->last)) - return(0); - } else if ( ! nc && 0 == cnt) { - mdoc_argv_free(arg); - mdoc_pmsg(m, line, ppos, MANDOCERR_MACROEMPTY); + if ( ! cnt) { + if (nc) { + mdoc_elem_alloc(mdoc, line, ppos, tok, arg); + rew_last(mdoc, mdoc->last); + } else { + mdoc_argv_free(arg); + mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse, + line, ppos, mdoc_macronames[tok]); + } } - - if ( ! nl) - return(1); - return(append_delims(m, line, pos, buf)); + if (nl) + append_delims(mdoc, line, pos, buf); } - -static int +static void blk_full(MACRO_PROT_ARGS) { - int la, nl; + int la, nl, parsed; struct mdoc_arg *arg; - struct mdoc_node *head; /* save of head macro */ - struct mdoc_node *body; /* save of body macro */ + struct mdoc_node *blk; /* Our own or a broken block. */ + struct mdoc_node *head; /* Our own head. */ + struct mdoc_node *body; /* Our own body. */ struct mdoc_node *n; - enum mdoc_type mtt; - enum mdoct ntok; enum margserr ac, lac; - enum margverr av; char *p; - nl = MDOC_NEWLINE & m->flags; + nl = MDOC_NEWLINE & mdoc->flags; - /* Close out prior implicit scope. */ + if (buf[*pos] == '\0' && (tok == MDOC_Sh || tok == MDOC_Ss)) { + mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse, + line, ppos, mdoc_macronames[tok]); + return; + } - if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) { - if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos)) - return(0); - if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos)) - return(0); + if ( ! (mdoc_macros[tok].flags & MDOC_EXPLICIT)) { + + /* Here, tok is one of Sh Ss Nm Nd It. */ + + blk = NULL; + for (n = mdoc->last; n != NULL; n = n->parent) { + if (n->flags & (MDOC_VALID | MDOC_BREAK) || + n->type != MDOC_BLOCK) + continue; + if (tok == MDOC_It && n->tok == MDOC_Bl) { + if (blk != NULL) { + mandoc_vmsg(MANDOCERR_BLK_BROKEN, + mdoc->parse, line, ppos, + "It breaks %s", + mdoc_macronames[blk->tok]); + rew_pending(mdoc, blk); + } + break; + } + + if (mdoc_macros[n->tok].flags & MDOC_EXPLICIT) { + switch (tok) { + case MDOC_Sh: + /* FALLTHROUGH */ + case MDOC_Ss: + mandoc_vmsg(MANDOCERR_BLK_BROKEN, + mdoc->parse, line, ppos, + "%s breaks %s", + mdoc_macronames[tok], + mdoc_macronames[n->tok]); + rew_pending(mdoc, n); + continue; + case MDOC_It: + /* Delay in case it's astray. */ + blk = n; + continue; + default: + break; + } + break; + } + + /* Here, n is one of Sh Ss Nm Nd It. */ + + if (tok != MDOC_Sh && (n->tok == MDOC_Sh || + (tok != MDOC_Ss && (n->tok == MDOC_Ss || + (tok != MDOC_It && n->tok == MDOC_It))))) + break; + + /* Item breaking an explicit block. */ + + if (blk != NULL) { + mandoc_vmsg(MANDOCERR_BLK_BROKEN, + mdoc->parse, line, ppos, + "It breaks %s", + mdoc_macronames[blk->tok]); + rew_pending(mdoc, blk); + blk = NULL; + } + + /* Close out prior implicit scopes. */ + + rew_last(mdoc, n); + } + + /* Skip items outside lists. */ + + if (tok == MDOC_It && (n == NULL || n->tok != MDOC_Bl)) { + mandoc_vmsg(MANDOCERR_IT_STRAY, mdoc->parse, + line, ppos, "It %s", buf + *pos); + mdoc_elem_alloc(mdoc, line, ppos, MDOC_br, NULL); + rew_elem(mdoc, MDOC_br); + return; + } } /* - * This routine accomodates implicitly- and explicitly-scoped + * 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 @@ -1003,61 +995,40 @@ blk_full(MACRO_PROT_ARGS) * regular child nodes. */ - for (arg = NULL;; ) { - la = *pos; - av = mdoc_argv(m, line, tok, &arg, pos, buf); + mdoc_argv(mdoc, line, tok, &arg, pos, buf); + blk = mdoc_block_alloc(mdoc, line, ppos, tok, arg); + head = body = NULL; - if (ARGV_WORD == av) { - *pos = la; - break; - } + /* + * Exception: Heads of `It' macros in `-diag' lists are not + * parsed, even though `It' macros in general are parsed. + */ - if (ARGV_EOLN == av) - break; - if (ARGV_ARG == av) - continue; + parsed = tok != MDOC_It || + mdoc->last->parent->tok != MDOC_Bl || + mdoc->last->parent->norm->Bl.type != LIST_diag; - mdoc_argv_free(arg); - return(0); - } - - if ( ! mdoc_block_alloc(m, line, ppos, tok, arg)) - return(0); - - 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); - head = m->last; - if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) - return(0); - if ( ! mdoc_body_alloc(m, line, ppos, tok)) - return(0); - body = m->last; - } + if (tok == MDOC_Nd) { + head = mdoc_head_alloc(mdoc, line, ppos, tok); + rew_last(mdoc, head); + body = mdoc_body_alloc(mdoc, line, ppos, tok); + } - ac = ARGS_ERROR; + if (tok == MDOC_Bk) + mdoc->flags |= MDOC_KEEP; - for ( ; ; ) { + ac = ARGS_PEND; + for (;;) { la = *pos; - /* Initialise last-phrase-type with ARGS_PEND. */ - lac = ARGS_ERROR == ac ? ARGS_PEND : ac; - ac = mdoc_args(m, line, pos, buf, tok, &p); - - if (ARGS_PUNCT == ac) - break; - - if (ARGS_ERROR == ac) - return(0); - - if (ARGS_EOLN == ac) { - if (ARGS_PPHRASE != lac && ARGS_PHRASE != lac) + lac = ac; + ac = mdoc_args(mdoc, line, pos, buf, tok, &p); + if (ac == ARGS_EOLN) { + if (lac != ARGS_PPHRASE && lac != ARGS_PHRASE) break; /* * This is necessary: if the last token on a @@ -1066,149 +1037,123 @@ blk_full(MACRO_PROT_ARGS) * reopen our scope if the last parse was a * phrase or partial phrase. */ - if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos)) - return(0); - if ( ! mdoc_body_alloc(m, line, ppos, tok)) - return(0); - body = m->last; + if (body != NULL) + rew_last(mdoc, body); + body = mdoc_body_alloc(mdoc, line, ppos, tok); break; } + if (tok == MDOC_Bd || tok == MDOC_Bk) { + mandoc_vmsg(MANDOCERR_ARG_EXCESS, + mdoc->parse, line, la, "%s ... %s", + mdoc_macronames[tok], buf + la); + break; + } + if (tok == MDOC_Rs) { + mandoc_vmsg(MANDOCERR_ARG_SKIP, mdoc->parse, + line, la, "Rs %s", buf + la); + break; + } + if (ac == ARGS_PUNCT) + break; - /* + /* * 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(m, line, la, p, DELIM_OPEN)) - return(0); + if (head == NULL && + ac != ARGS_PEND && + ac != ARGS_PHRASE && + ac != ARGS_PPHRASE && + ac != ARGS_QWORD && + mdoc_isdelim(p) == DELIM_OPEN) { + dword(mdoc, line, la, p, DELIM_OPEN, 0); continue; } /* Open a head if one hasn't been opened. */ - if (NULL == head) { - if ( ! mdoc_head_alloc(m, line, ppos, tok)) - return(0); - head = m->last; - } + if (head == NULL) + head = mdoc_head_alloc(mdoc, line, ppos, tok); - if (ARGS_PHRASE == ac || - ARGS_PEND == ac || - ARGS_PPHRASE == ac) { + if (ac == ARGS_PHRASE || + ac == ARGS_PEND || + ac == ARGS_PPHRASE) { + /* * If we haven't opened a body yet, rewind the * head; if we have, rewind that instead. */ - mtt = body ? MDOC_BODY : MDOC_HEAD; - if ( ! rew_sub(mtt, m, tok, line, ppos)) - return(0); - - /* Then allocate our body context. */ + rew_last(mdoc, body == NULL ? head : body); + body = mdoc_body_alloc(mdoc, line, ppos, tok); - if ( ! mdoc_body_alloc(m, line, ppos, tok)) - return(0); - body = m->last; - /* * 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) - m->flags |= MDOC_PPHRASE; - if (ARGS_PEND == ac && ARGS_PPHRASE == lac) - m->flags |= MDOC_PPHRASE; - - if ( ! phrase(m, line, la, buf)) - return(0); - - m->flags &= ~MDOC_PPHRASE; + if (ac == ARGS_PPHRASE) + mdoc->flags |= MDOC_PPHRASE; + if (ac == ARGS_PEND && lac == ARGS_PPHRASE) + mdoc->flags |= MDOC_PPHRASE; + parse_rest(mdoc, MDOC_MAX, line, &la, buf); + mdoc->flags &= ~MDOC_PPHRASE; continue; } - ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); - - if (MDOC_MAX == ntok) { - if ( ! dword(m, line, la, p, DELIM_MAX)) - return(0); - continue; - } - - if ( ! mdoc_macro(m, ntok, line, la, pos, buf)) - return(0); - break; + if (macro_or_word(mdoc, tok, line, la, pos, buf, parsed)) + break; } - if (NULL == head) { - if ( ! mdoc_head_alloc(m, line, ppos, tok)) - return(0); - head = m->last; - } - - if (nl && ! append_delims(m, line, pos, buf)) - return(0); - - /* If we've already opened our body, exit now. */ - - if (NULL != body) + if (blk->flags & MDOC_VALID) + return; + if (head == NULL) + head = mdoc_head_alloc(mdoc, line, ppos, tok); + if (nl && tok != MDOC_Bd && tok != MDOC_Bl && tok != MDOC_Rs) + append_delims(mdoc, line, pos, buf); + if (body != NULL) 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 + * head to body until the rew_pending() 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)) { + for (n = mdoc->last; n && n != head; n = n->parent) { + if (n->type == MDOC_BLOCK && + mdoc_macros[n->tok].flags & MDOC_EXPLICIT && + ! (n->flags & MDOC_VALID)) { n->pending = head; - return(1); + return; } } /* Close out scopes to remain in a consistent state. */ - if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) - return(0); - if ( ! mdoc_body_alloc(m, line, ppos, tok)) - return(0); - + rew_last(mdoc, head); + body = mdoc_body_alloc(mdoc, line, ppos, tok); out: - if ( ! (MDOC_FREECOL & m->flags)) - return(1); - - if ( ! rew_sub(MDOC_BODY, m, tok, line, ppos)) - return(0); - if ( ! rew_sub(MDOC_BLOCK, m, tok, line, ppos)) - return(0); - - m->flags &= ~MDOC_FREECOL; - return(1); + if (mdoc->flags & MDOC_FREECOL) { + rew_last(mdoc, body); + rew_last(mdoc, blk); + mdoc->flags &= ~MDOC_FREECOL; + } } - -static int +static void blk_part_imp(MACRO_PROT_ARGS) { int la, nl; - enum mdoct ntok; enum margserr ac; char *p; struct mdoc_node *blk; /* saved block context */ struct mdoc_node *body; /* saved body context */ struct mdoc_node *n; - nl = MDOC_NEWLINE & m->flags; + nl = MDOC_NEWLINE & mdoc->flags; /* * A macro that spans to the end of the line. This is generally @@ -1219,16 +1164,9 @@ blk_part_imp(MACRO_PROT_ARGS) * or more closing punctuation nodes. */ - if ( ! mdoc_block_alloc(m, line, ppos, tok, NULL)) - return(0); + blk = mdoc_block_alloc(mdoc, line, ppos, tok, NULL); + rew_last(mdoc, mdoc_head_alloc(mdoc, line, ppos, tok)); - blk = m->last; - - if ( ! mdoc_head_alloc(m, line, ppos, tok)) - return(0); - if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) - return(0); - /* * Open the body scope "on-demand", that is, after we've * processed all our the leading delimiters (open parenthesis, @@ -1237,123 +1175,65 @@ blk_part_imp(MACRO_PROT_ARGS) for (body = NULL; ; ) { la = *pos; - ac = mdoc_args(m, line, pos, buf, tok, &p); - - if (ARGS_ERROR == ac) - return(0); - if (ARGS_EOLN == ac) + ac = mdoc_args(mdoc, line, pos, buf, tok, &p); + if (ac == ARGS_EOLN || ac == ARGS_PUNCT) break; - if (ARGS_PUNCT == ac) - break; - if (NULL == body && ARGS_QWORD != ac && - DELIM_OPEN == mdoc_isdelim(p)) { - if ( ! dword(m, line, la, p, DELIM_OPEN)) - return(0); + if (body == NULL && ac != ARGS_QWORD && + mdoc_isdelim(p) == DELIM_OPEN) { + dword(mdoc, line, la, p, DELIM_OPEN, 0); continue; - } - - 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 (body == NULL) + body = mdoc_body_alloc(mdoc, line, ppos, tok); - if (MDOC_MAX == ntok) { - if ( ! dword(m, line, la, p, DELIM_MAX)) - return(0); - continue; - } - - if ( ! mdoc_macro(m, ntok, line, la, pos, buf)) - return(0); - break; + if (macro_or_word(mdoc, tok, line, la, pos, buf, 1)) + break; } + if (body == NULL) + body = mdoc_body_alloc(mdoc, line, ppos, tok); - /* Clean-ups to leave in a consistent state. */ - - if (NULL == body) { - if ( ! mdoc_body_alloc(m, line, ppos, tok)) - return(0); - body = m->last; - } - - for (n = body->child; n && n->next; n = n->next) - /* Do nothing. */ ; - - /* - * End of sentence spacing: if the last node is a text node and - * has a trailing period, then mark it as being end-of-sentence. - */ - - if (n && MDOC_TEXT == n->type && n->string) - if (mandoc_eos(n->string, strlen(n->string), 1)) - n->flags |= MDOC_EOS; - - /* Up-propogate the end-of-space flag. */ - - if (n && (MDOC_EOS & n->flags)) { - body->flags |= MDOC_EOS; - body->parent->flags |= MDOC_EOS; - } - /* * 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. + * postpone closing out the current block until the + * rew_pending() call closing out the sub-block. */ - for (n = m->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, m, line, ppos); - if ( ! mdoc_endbody_alloc(m, line, ppos, - tok, body, ENDBODY_NOSPACE)) - return(0); - return(1); + + for (n = mdoc->last; n && n != body && n != blk->parent; + n = n->parent) { + if (n->type == MDOC_BLOCK && + mdoc_macros[n->tok].flags & MDOC_EXPLICIT && + ! (n->flags & MDOC_VALID)) { + make_pending(mdoc, blk, n, line, ppos); + mdoc_endbody_alloc(mdoc, line, ppos, + tok, body, ENDBODY_NOSPACE); + return; } } + assert(n == body); + rew_last(mdoc, body); + if (nl) + append_delims(mdoc, line, pos, buf); + rew_pending(mdoc, blk); - /* - * 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, m->parse, line, ppos, - "%s broken", mdoc_macronames[tok]); + /* Move trailing .Ns out of scope. */ - if (n && ! rew_sub(MDOC_BODY, m, tok, line, ppos)) - return(0); - - /* Standard appending of delimiters. */ - - if (nl && ! append_delims(m, line, pos, buf)) - return(0); - - /* Rewind scope, if applicable. */ - - if (n && ! rew_sub(MDOC_BLOCK, m, tok, line, ppos)) - return(0); - - return(1); + for (n = body->child; n && n->next; n = n->next) + /* Do nothing. */ ; + if (n && n->tok == MDOC_Ns) + mdoc_node_relink(mdoc, n); } - -static int +static void blk_part_exp(MACRO_PROT_ARGS) { 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; - nl = MDOC_NEWLINE & m->flags; + nl = MDOC_NEWLINE & mdoc->flags; /* * The opening of an explicit macro having zero or more leading @@ -1361,110 +1241,56 @@ blk_part_exp(MACRO_PROT_ARGS) * case of `Eo'); and a body that may be empty. */ - if ( ! mdoc_block_alloc(m, line, ppos, tok, NULL)) - return(0); - - for (head = body = NULL; ; ) { + mdoc_block_alloc(mdoc, line, ppos, tok, NULL); + head = NULL; + for (;;) { la = *pos; - ac = mdoc_args(m, line, pos, buf, tok, &p); - - if (ARGS_ERROR == ac) - return(0); - if (ARGS_PUNCT == ac) + ac = mdoc_args(mdoc, line, pos, buf, tok, &p); + if (ac == ARGS_PUNCT || ac == ARGS_EOLN) break; - if (ARGS_EOLN == ac) - break; /* Flush out leading punctuation. */ - if (NULL == head && ARGS_QWORD != ac && - DELIM_OPEN == mdoc_isdelim(p)) { - assert(NULL == body); - if ( ! dword(m, line, la, p, DELIM_OPEN)) - return(0); + if (head == NULL && ac != ARGS_QWORD && + mdoc_isdelim(p) == DELIM_OPEN) { + dword(mdoc, line, la, p, DELIM_OPEN, 0); continue; - } - - if (NULL == head) { - assert(NULL == body); - if ( ! mdoc_head_alloc(m, line, ppos, tok)) - return(0); - head = m->last; } - /* - * `Eo' gobbles any data into the head, but most other - * macros just immediately close out and begin the body. - */ - - if (NULL == body) { - assert(head); - /* No check whether it's a macro! */ - if (MDOC_Eo == tok) - if ( ! dword(m, line, la, p, DELIM_MAX)) - return(0); - - if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) - return(0); - if ( ! mdoc_body_alloc(m, line, ppos, tok)) - return(0); - body = m->last; - - if (MDOC_Eo == tok) + if (head == NULL) { + head = mdoc_head_alloc(mdoc, line, ppos, tok); + if (tok == MDOC_Eo) /* Not parsed. */ + dword(mdoc, line, la, p, DELIM_MAX, 0); + rew_last(mdoc, head); + mdoc_body_alloc(mdoc, line, ppos, tok); + if (tok == MDOC_Eo) continue; } - assert(NULL != head && NULL != body); - - ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); - - if (MDOC_MAX == ntok) { - if ( ! dword(m, line, la, p, DELIM_MAX)) - return(0); - continue; - } - - if ( ! mdoc_macro(m, ntok, line, la, pos, buf)) - return(0); - break; + if (macro_or_word(mdoc, tok, line, la, pos, buf, 1)) + break; } /* Clean-up to leave in a consistent state. */ - if (NULL == head) { - if ( ! mdoc_head_alloc(m, line, ppos, tok)) - return(0); - head = m->last; + if (head == NULL) { + rew_last(mdoc, mdoc_head_alloc(mdoc, line, ppos, tok)); + mdoc_body_alloc(mdoc, line, ppos, tok); } - - if (NULL == body) { - if ( ! rew_sub(MDOC_HEAD, m, tok, line, ppos)) - return(0); - if ( ! mdoc_body_alloc(m, line, ppos, tok)) - return(0); - body = m->last; - } - - /* Standard appending of delimiters. */ - - if ( ! nl) - return(1); - return(append_delims(m, line, pos, buf)); + if (nl) + append_delims(mdoc, line, pos, buf); } - -/* ARGSUSED */ -static int +static void in_line_argn(MACRO_PROT_ARGS) { int la, flushed, j, maxargs, nl; enum margserr ac; - enum margverr av; struct mdoc_arg *arg; char *p; enum mdoct ntok; - nl = MDOC_NEWLINE & m->flags; + nl = mdoc->flags & MDOC_NEWLINE; /* * A line macro that has a fixed number of arguments (maxargs). @@ -1475,18 +1301,18 @@ in_line_argn(MACRO_PROT_ARGS) */ switch (tok) { - case (MDOC_Ap): + case MDOC_Ap: /* FALLTHROUGH */ - case (MDOC_No): + case MDOC_Ns: /* FALLTHROUGH */ - case (MDOC_Ns): - /* FALLTHROUGH */ - case (MDOC_Ux): + case MDOC_Ux: maxargs = 0; break; - case (MDOC_Bx): + case MDOC_Bx: /* FALLTHROUGH */ - case (MDOC_Xr): + case MDOC_Es: + /* FALLTHROUGH */ + case MDOC_Xr: maxargs = 2; break; default: @@ -1494,293 +1320,160 @@ in_line_argn(MACRO_PROT_ARGS) break; } - for (arg = NULL; ; ) { - la = *pos; - av = mdoc_argv(m, line, tok, &arg, pos, buf); + mdoc_argv(mdoc, line, tok, &arg, pos, buf); - if (ARGV_WORD == av) { - *pos = la; - break; - } - - if (ARGV_EOLN == av) - break; - if (ARGV_ARG == av) - continue; - - mdoc_argv_free(arg); - return(0); - } - - for (flushed = j = 0; ; ) { + p = NULL; + flushed = j = 0; + for (;;) { la = *pos; - ac = mdoc_args(m, line, pos, buf, tok, &p); - - if (ARGS_ERROR == ac) - return(0); - if (ARGS_PUNCT == ac) + ac = mdoc_args(mdoc, line, pos, buf, tok, &p); + if (ac == ARGS_PUNCT || ac == ARGS_EOLN) { + if (j < 2 && tok == MDOC_Pf) + mandoc_vmsg(MANDOCERR_PF_SKIP, + mdoc->parse, line, ppos, "Pf %s", + p == NULL ? "at eol" : p); 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(m, line, la, p, DELIM_OPEN)) - return(0); + if ( ! (mdoc_macros[tok].flags & MDOC_IGNDELIM) && + ac != ARGS_QWORD && j == 0 && + mdoc_isdelim(p) == DELIM_OPEN) { + dword(mdoc, line, la, p, DELIM_OPEN, 0); continue; - } else if (0 == j) - if ( ! mdoc_elem_alloc(m, line, la, tok, arg)) - return(0); + } else if (j == 0) + mdoc_elem_alloc(mdoc, line, ppos, tok, arg); if (j == maxargs && ! flushed) { - if ( ! rew_elem(m, tok)) - return(0); + rew_elem(mdoc, tok); flushed = 1; } - ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); + ntok = (ac == ARGS_QWORD || (tok == MDOC_Pf && j == 0)) ? + MDOC_MAX : lookup(mdoc, tok, line, la, p); - if (MDOC_MAX != ntok) { - if ( ! flushed && ! rew_elem(m, tok)) - return(0); + if (ntok != MDOC_MAX) { + if ( ! flushed) + rew_elem(mdoc, tok); flushed = 1; - if ( ! mdoc_macro(m, ntok, line, la, pos, buf)) - return(0); + mdoc_macro(mdoc, ntok, line, la, pos, buf); j++; break; } - if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) && - ARGS_QWORD != ac && - ! flushed && - DELIM_NONE != mdoc_isdelim(p)) { - if ( ! rew_elem(m, tok)) - return(0); + if ( ! (mdoc_macros[tok].flags & MDOC_IGNDELIM) && + ac != ARGS_QWORD && ! flushed && + mdoc_isdelim(p) != DELIM_NONE) { + rew_elem(mdoc, tok); flushed = 1; } - /* - * 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. - */ + dword(mdoc, line, la, p, DELIM_MAX, + MDOC_JOIN & mdoc_macros[tok].flags); + j++; + } -#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); + if (j == 0) { + if (tok == MDOC_In || tok == MDOC_St || tok == MDOC_Xr) { + mandoc_msg(MANDOCERR_MACRO_EMPTY, mdoc->parse, + line, ppos, mdoc_macronames[tok]); + return; } -#endif - - if ( ! dword(m, line, la, p, DELIM_MAX)) - return(0); - j++; + mdoc_elem_alloc(mdoc, line, ppos, tok, arg); + if (ac == ARGS_PUNCT && tok == MDOC_Pf) + append_delims(mdoc, line, pos, buf); } + if ( ! flushed) + rew_elem(mdoc, tok); + if (nl) + append_delims(mdoc, line, pos, buf); +} - if (0 == j && ! mdoc_elem_alloc(m, line, la, tok, arg)) - return(0); +static void +in_line_eoln(MACRO_PROT_ARGS) +{ + struct mdoc_node *n; + struct mdoc_arg *arg; - /* Close out in a consistent state. */ + if ((tok == MDOC_Pp || tok == MDOC_Lp) && + ! (mdoc->flags & MDOC_SYNOPSIS)) { + n = mdoc->last; + if (mdoc->next == MDOC_NEXT_SIBLING) + n = n->parent; + if (n->tok == MDOC_Nm) + rew_last(mdoc, mdoc->last->parent); + } - if ( ! flushed && ! rew_elem(m, tok)) - return(0); - if ( ! nl) - return(1); - return(append_delims(m, line, pos, buf)); + mdoc_argv(mdoc, line, tok, &arg, pos, buf); + mdoc_elem_alloc(mdoc, line, ppos, tok, arg); + if (parse_rest(mdoc, tok, line, pos, buf)) + return; + rew_elem(mdoc, tok); } - +/* + * The simplest argument parser available: Parse the remaining + * words until the end of the phrase or line and return 0 + * or until the next macro, call that macro, and return 1. + */ static int -in_line_eoln(MACRO_PROT_ARGS) +parse_rest(struct mdoc *mdoc, enum mdoct tok, int line, int *pos, char *buf) { int la; - enum margserr ac; - enum margverr av; - struct mdoc_arg *arg; - char *p; - enum mdoct ntok; - assert( ! (MDOC_PARSED & mdoc_macros[tok].flags)); - - if (tok == MDOC_Pp) - rew_sub(MDOC_BLOCK, m, MDOC_Nm, line, ppos); - - /* Parse macro arguments. */ - - for (arg = NULL; ; ) { - la = *pos; - av = mdoc_argv(m, line, tok, &arg, pos, buf); - - if (ARGV_WORD == av) { - *pos = la; - break; - } - if (ARGV_EOLN == av) - break; - if (ARGV_ARG == av) - continue; - - mdoc_argv_free(arg); - return(0); - } - - /* Open element scope. */ - - if ( ! mdoc_elem_alloc(m, line, ppos, tok, arg)) - return(0); - - /* Parse argument terms. */ - for (;;) { la = *pos; - ac = mdoc_args(m, line, pos, buf, tok, &p); - - if (ARGS_ERROR == ac) + if (mdoc_args(mdoc, line, pos, buf, tok, NULL) == ARGS_EOLN) return(0); - if (ARGS_EOLN == ac) - break; - - ntok = ARGS_QWORD == ac ? MDOC_MAX : lookup(tok, p); - - if (MDOC_MAX == ntok) { - if ( ! dword(m, line, la, p, DELIM_MAX)) - return(0); - continue; - } - - if ( ! rew_elem(m, tok)) - return(0); - return(mdoc_macro(m, ntok, line, la, pos, buf)); + if (macro_or_word(mdoc, tok, line, la, pos, buf, 1)) + return(1); } - - /* Close out (no delimiters). */ - - return(rew_elem(m, tok)); } - -/* ARGSUSED */ -static int +static void ctx_synopsis(MACRO_PROT_ARGS) { - int nl; - nl = MDOC_NEWLINE & m->flags; - - /* If we're not in the SYNOPSIS, go straight to in-line. */ - if ( ! (MDOC_SYNOPSIS & m->flags)) - return(in_line(m, tok, line, ppos, pos, buf)); - - /* If we're a nested call, same place. */ - if ( ! nl) - return(in_line(m, 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(m, tok, line, ppos, pos, buf)); - assert(MDOC_Vt == tok); - return(blk_part_imp(m, tok, line, ppos, pos, buf)); + if (~mdoc->flags & (MDOC_SYNOPSIS | MDOC_NEWLINE)) + in_line(mdoc, tok, line, ppos, pos, buf); + else if (tok == MDOC_Nm) + blk_full(mdoc, tok, line, ppos, pos, buf); + else { + assert(tok == MDOC_Vt); + blk_part_imp(mdoc, tok, line, ppos, pos, buf); + } } - -/* ARGSUSED */ -static int -obsolete(MACRO_PROT_ARGS) -{ - - mdoc_pmsg(m, 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 *m, int line, int ppos, char *buf) +static void +phrase_ta(MACRO_PROT_ARGS) { - int la, pos; - enum margserr ac; - enum mdoct ntok; - char *p; + struct mdoc_node *body, *n; - for (pos = ppos; ; ) { - la = pos; + /* Make sure we are in a column list or ignore this macro. */ - ac = mdoc_zargs(m, 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(m, line, la, p, DELIM_MAX)) - return(0); + body = NULL; + for (n = mdoc->last; n != NULL; n = n->parent) { + if (n->flags & (MDOC_VALID | MDOC_BREAK)) continue; - } - - if ( ! mdoc_macro(m, ntok, line, la, &pos, buf)) - return(0); - return(append_delims(m, line, &pos, buf)); + if (n->tok == MDOC_It && n->type == MDOC_BODY) + body = n; + if (n->tok == MDOC_Bl) + break; } - return(1); -} - - -/* ARGSUSED */ -static int -phrase_ta(MACRO_PROT_ARGS) -{ - int la; - enum mdoct ntok; - enum margserr ac; - char *p; - - /* - * FIXME: this is overly restrictive: if the `Ta' is unexpected, - * it should simply error out with ARGSLOST. - */ - - if ( ! rew_sub(MDOC_BODY, m, MDOC_It, line, ppos)) - return(0); - if ( ! mdoc_body_alloc(m, line, ppos, MDOC_It)) - return(0); - - for (;;) { - la = *pos; - ac = mdoc_zargs(m, 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(m, line, la, p, DELIM_MAX)) - return(0); - continue; - } - - if ( ! mdoc_macro(m, ntok, line, la, pos, buf)) - return(0); - return(append_delims(m, line, pos, buf)); + if (n == NULL || n->norm->Bl.type != LIST_column) { + mandoc_msg(MANDOCERR_TA_STRAY, mdoc->parse, + line, ppos, "Ta"); + return; } - return(1); + /* Advance to the next column. */ + + rew_last(mdoc, body); + mdoc_body_alloc(mdoc, line, ppos, MDOC_It); + parse_rest(mdoc, MDOC_MAX, line, pos, buf); }