=================================================================== RCS file: /cvs/mandoc/mdoc_macro.c,v retrieving revision 1.3 retrieving revision 1.163 diff -u -p -r1.3 -r1.163 --- mandoc/mdoc_macro.c 2009/03/27 13:44:24 1.3 +++ mandoc/mdoc_macro.c 2015/02/01 17:30:45 1.163 @@ -1,601 +1,453 @@ -/* $Id: mdoc_macro.c,v 1.3 2009/03/27 13:44:24 kristaps Exp $ */ +/* $Id: mdoc_macro.c,v 1.163 2015/02/01 17:30:45 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * 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 copyright notice and this permission notice appear in all - * copies. + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL - * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED - * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE - * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL - * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR - * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER - * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - * PERFORMANCE OF THIS SOFTWARE. + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +#include "config.h" + +#include + #include #include #include #include #include +#include +#include "mdoc.h" +#include "mandoc.h" #include "libmdoc.h" +#include "libmandoc.h" -/* - * This has scanning/parsing routines, each of which extract a macro and - * its arguments and parameters, then know how to progress to the next - * macro. - */ - -/* FIXME: .Fl, .Ar, .Cd handling of `|'. */ - -enum mwarn { - 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 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); -#define REWIND_REWIND (1 << 0) -#define REWIND_NOHALT (1 << 1) -#define REWIND_HALT (1 << 2) +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 int make_pending(struct mdoc_node *, enum mdoct, + struct mdoc *, int, int); +static int parse_rest(struct mdoc *, enum mdoct, + 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 void rew_elem(struct mdoc *, enum mdoct); +static void rew_last(struct mdoc *, const struct mdoc_node *); +static void 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] = { - { NULL, 0 }, /* \" */ + { 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_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_PARSED }, /* Ft */ - { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */ - { in_line_eoln, 0 }, /* In */ - { 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 }, /* 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_PARSED }, /* Ms */ - { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* No */ - { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */ + { in_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ms */ + { 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 */ - { 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 */ - { 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_eoln, 0 }, /* Lb */ - { in_line_argn, MDOC_CALLABLE | MDOC_PARSED }, /* Ap */ - { in_line, 0 }, /* Lp */ - { in_line, MDOC_PARSED }, /* Lk */ - { in_line, MDOC_PARSED }, /* Mt */ - { 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, 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 */ + { 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 | MDOC_JOIN }, /* Ta */ + { in_line_eoln, MDOC_PROLOGUE }, /* ll */ }; 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 (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 * are errors. */ -int +void mdoc_macroend(struct mdoc *mdoc) { struct mdoc_node *n; /* Scan for open explicit scopes. */ - n = MDOC_VALID & mdoc->last->flags ? - mdoc->last->parent : mdoc->last; + n = mdoc->last->flags & MDOC_VALID ? + 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 (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]); - return(rew_last(mdoc, mdoc->first)); + /* Rewind to the first. */ + + rew_last(mdoc, mdoc->first); } -static int -lookup(struct mdoc *mdoc, int line, int pos, int from, const char *p) +/* + * Look up the macro at *p called by "from", + * or as a line macro if from == MDOC_MAX. + */ +static enum mdoct +lookup(struct mdoc *mdoc, enum mdoct from, int line, int ppos, const char *p) { - int res; + enum mdoct res; - res = mdoc_tokhash_find(mdoc->htab, p); - if (MDOC_PARSED & mdoc_macros[from].flags) - return(res); - if (MDOC_MAX == res) - return(res); - if ( ! pwarn(mdoc, line, pos, WMACPARM)) - return(-1); + 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 -rew_last(struct mdoc *mdoc, struct mdoc_node *to) +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) { - if ( ! mdoc_valid_post(mdoc)) - return(0); - if ( ! mdoc_action_post(mdoc)) - return(0); - mdoc->last = mdoc->last->parent; + /* + * 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; + mdoc_valid_post(mdoc); + 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)); + 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): + 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: - 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); - 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); - 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); - 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 */ - case (MDOC_Oo): - /* FALLTHROUGH */ - case (MDOC_Po): - /* FALLTHROUGH */ - case (MDOC_Qo): - /* FALLTHROUGH */ - case (MDOC_Rs): - /* FALLTHROUGH */ - case (MDOC_So): - /* FALLTHROUGH */ - case (MDOC_Xo): - if (type == p->type && tok == p->tok) - return(REWIND_REWIND); - break; + /* + * When starting to rewind, skip plain text + * and nodes that have already been rewound. + */ + if (p->type == MDOC_TEXT || p->flags & (MDOC_VALID | MDOC_BREAK)) + return(REWIND_MORE); - /* Multi-line explicit scope close. */ - case (MDOC_Ac): - /* FALLTHROUGH */ - case (MDOC_Bc): - /* FALLTHROUGH */ - case (MDOC_Brc): - /* FALLTHROUGH */ - case (MDOC_Dc): - /* FALLTHROUGH */ - case (MDOC_Ec): - /* FALLTHROUGH */ - case (MDOC_Ed): - /* FALLTHROUGH */ - case (MDOC_Ek): - /* FALLTHROUGH */ - case (MDOC_El): - /* FALLTHROUGH */ - case (MDOC_Fc): - /* FALLTHROUGH */ - case (MDOC_Ef): - /* FALLTHROUGH */ - case (MDOC_Oc): - /* FALLTHROUGH */ - case (MDOC_Pc): - /* FALLTHROUGH */ - case (MDOC_Qc): - /* FALLTHROUGH */ - case (MDOC_Re): - /* FALLTHROUGH */ - case (MDOC_Sc): - /* FALLTHROUGH */ - case (MDOC_Xc): - if (type == p->type && rew_alt(tok) == p->tok) - return(REWIND_REWIND); - break; - default: - abort(); - /* NOTREACHED */ - } + /* + * 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); - 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); + /* + * While elements do require rewinding for themselves, + * they never affect rewinding of other nodes. + */ if (MDOC_ELEM == p->type) - return(1); - if (MDOC_TEXT == p->type) - return(1); - if (MDOC_VALID & p->flags) - return(1); + return(REWIND_MORE); + /* + * Blocks delimited by our target token get REWIND_MORE. + * Blocks delimiting our target token get REWIND_NONE. + */ switch (tok) { - case (MDOC_It): - return(MDOC_It == p->tok); - case (MDOC_Ss): - return(MDOC_Ss == p->tok); - case (MDOC_Sh): - if (MDOC_Ss == p->tok) - return(1); - return(MDOC_Sh == p->tok); - case (MDOC_El): + case MDOC_Bl: if (MDOC_It == p->tok) - return(1); + return(REWIND_MORE); break; - case (MDOC_Oc): - /* XXX - experimental! */ + 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(1); + 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_ROOT == p->parent->type) + return(REWIND_THIS); + if (MDOC_Nd == p->tok || MDOC_Ss == p->tok || + MDOC_Sh == p->tok) + return(REWIND_MORE); + 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. + * Do not warn again when closing a block, + * since closing the body already warned. + */ + if (ENDBODY_NOT != p->end || MDOC_Nm == p->tok || + MDOC_BLOCK == type || (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) +static void +rew_elem(struct mdoc *mdoc, enum mdoct tok) { struct mdoc_node *n; @@ -604,852 +456,1115 @@ rew_elem(struct mdoc *mdoc, int 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, + * 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 (Z) is already broken and we + * encounter its breaker (B), make the tok block (A) + * pending on that inner breaker (B). + * Graphically, [A breaker=[B! broken=[Z->B B] tok=A] Z] + * becomes breaker=[A broken=[B! [Z->B B] tok=A] Z] + * and finally [A! [B!->A [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!). + */ + 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 (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! breaker=[A broken=[B->X X] tok=A] B] + * becomes [X! breaker=[A->X broken=[B X] tok=A] B] + * and finally [X! [A!->X [B->A X] A] B]. + */ + if (broken->pending) { + struct mdoc_node *taker; + + /* + * 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): + * [X! [Y! breaker=[A->Y Y] broken=[B->X X] tok=A] B] + * [X! take=[Y!->X brea=[A->Y Y] brok=[B X] tok=A] B] + * and finally [X! [Y!->X [A!->Y Y] [B->A X] A] B]. + */ + taker = breaker; + while (taker->pending) + taker = taker->pending; + taker->pending = broken->pending; + } + + /* + * Now we have reduced the situation to the simplest + * case, which is just breaker=[A broken=[B tok=A] B] + * and becomes [A! [B->A A] B]. + */ + broken->pending = breaker; + breaker->flags |= MDOC_BREAK; + mandoc_vmsg(MANDOCERR_BLK_NEST, 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) +static void +rew_sub(enum mdoc_type t, struct mdoc *mdoc, + enum mdoct tok, int line, int ppos) { - struct mdoc_node *n; - int c; + struct mdoc_node *n, *to; - /* 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) + to = NULL; + n = mdoc->last; + while (n) { + switch (rew_dohalt(tok, t, n)) { + case REWIND_NONE: + if (to == NULL) + return; + n = to; break; - else if (rew_dobreak(tok, n)) + case REWIND_THIS: + n->lastline = line - + (mdoc->flags & MDOC_NEWLINE && + ! (mdoc_macros[tok].flags & MDOC_EXPLICIT)); + break; + case REWIND_FORCE: + mandoc_vmsg(MANDOCERR_BLK_BROKEN, mdoc->parse, + line, ppos, "%s breaks %s", + mdoc_macronames[tok], + mdoc_macronames[n->tok]); + /* FALLTHROUGH */ + case REWIND_MORE: + n->lastline = line - + (mdoc->flags & MDOC_NEWLINE ? 1 : 0); + to = n; + 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) || + t != MDOC_BLOCK) + return; + /* FALLTHROUGH */ + case REWIND_ERROR: + mandoc_msg(MANDOCERR_BLK_NOTOPEN, + mdoc->parse, line, ppos, + mdoc_macronames[tok]); + return; + } + break; } - assert(n); - return(rew_last(mdoc, n)); + rew_last(mdoc, n); + + /* + * The current block extends an enclosing block. + * Now that the current block ends, close the enclosing block, too. + */ + while ((n = n->pending) != NULL) { + rew_last(mdoc, n); + if (n->type == MDOC_HEAD) + mdoc_body_alloc(mdoc, n->line, n->pos, n->tok); + } } - -static int -rew_impblock(struct mdoc *mdoc, int tok, int line, int ppos) +/* + * Allocate a word and check whether it's punctuation or not. + * Punctuation consists of those tokens found in mdoc_isdelim(). + */ +static void +dword(struct mdoc *mdoc, int line, int col, const char *p, + enum mdelim d, int may_append) { - struct mdoc_node *n; - int c; - /* LINTED */ - for (n = mdoc->last; n; n = n->parent) { - c = rew_dohalt(tok, MDOC_BLOCK, n); - if (REWIND_HALT == c) - return(1); - else if (REWIND_REWIND == c) - break; - else if (rew_dobreak(tok, n)) - continue; - if ( ! swarn(mdoc, MDOC_BLOCK, line, ppos, n)) - return(0); + if (d == DELIM_MAX) + d = mdoc_isdelim(p); + + 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; } - assert(n); - return(rew_last(mdoc, n)); -} + mdoc_word_alloc(mdoc, line, col, p); + /* + * 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. + */ -static int + 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 void append_delims(struct mdoc *mdoc, int line, int *pos, char *buf) { - int c, lastarg; char *p; + int la; - if (0 == buf[*pos]) - return(1); + if (buf[*pos] == '\0') + return; for (;;) { - lastarg = *pos; - c = mdoc_args(mdoc, line, pos, buf, 0, &p); - assert(ARGS_PHRASE != c); - - if (ARGS_ERROR == c) - return(0); - else if (ARGS_EOLN == c) + la = *pos; + if (mdoc_args(mdoc, line, pos, buf, MDOC_MAX, &p) == ARGS_EOLN) 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); - return(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; + } } - /* - * 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) { - int j, c, lastarg, maxargs, flushed; + struct mdoc_node *body; /* Our own body. */ + struct mdoc_node *endbody; /* Our own end marker. */ + struct mdoc_node *later; /* A sub-block starting later. */ + struct mdoc_node *n; /* For searching backwards. */ + + int flushed, have_it, j, lastarg, maxargs, nl; + enum margserr ac; + enum mdoct atok, ntok; char *p; + 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; } - if ( ! (MDOC_CALLABLE & mdoc_macros[tok].flags)) { - if (0 == buf[*pos]) { - if ( ! rew_subblock(MDOC_BODY, mdoc, - tok, line, ppos)) - return(0); - return(rew_expblock(mdoc, tok, line, ppos)); + /* + * Search backwards for beginnings of blocks, + * both of our own and of pending sub-blocks. + */ + + have_it = 0; + atok = rew_alt(tok); + body = endbody = 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 (n->type == MDOC_BODY && atok == n->tok) { + if (n->end == ENDBODY_NOT) + body = n; + continue; } - return(perr(mdoc, line, ppos, ENOPARMS)); + + if (n->type != MDOC_BLOCK || n->tok == MDOC_Nm) + continue; + + if (n->tok == MDOC_It) { + have_it = 1; + 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 (later == NULL || + (tok == MDOC_El && !have_it)) + 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. + */ + + 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 and remeber the + * end marker in order to close it out. + */ + + if (maxargs) { + endbody = mdoc->last; + mdoc->next = MDOC_NEXT_CHILD; + } + break; + } + + /* + * 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 == NULL || + ! (mdoc_macros[later->tok].flags & MDOC_EXPLICIT)) + later = n; } + rew_sub(MDOC_BODY, mdoc, tok, line, ppos); - if ( ! rew_subblock(MDOC_BODY, mdoc, tok, line, ppos)) - return(0); + 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); + rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos); + return; + } - if (maxargs > 0) { - if ( ! mdoc_tail_alloc(mdoc, line, - ppos, rew_alt(tok))) - return(0); - mdoc->next = MDOC_NEXT_CHILD; + if (maxargs && endbody == NULL) { + if (n == NULL) { + /* + * Stray .Ec without previous .Eo: + * Break the output line, ignore any arguments. + */ + mdoc_elem_alloc(mdoc, line, ppos, MDOC_br, NULL); + rew_elem(mdoc, MDOC_br); + } else + mdoc_tail_alloc(mdoc, line, ppos, atok); } - for (lastarg = ppos, flushed = j = 0; ; j++) { + flushed = n == NULL; + for (j = 0; ; j++) { lastarg = *pos; if (j == maxargs && ! flushed) { - if ( ! rew_expblock(mdoc, tok, line, ppos)) - return(0); + if (endbody == NULL) + rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos); + else + rew_last(mdoc, endbody); flushed = 1; } - c = mdoc_args(mdoc, line, pos, buf, tok, &p); - - if (ARGS_ERROR == c) - return(0); - if (ARGS_PUNCT == c) + ac = mdoc_args(mdoc, line, pos, buf, tok, &p); + if (ac == ARGS_PUNCT || ac == ARGS_EOLN) 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_expblock(mdoc, tok, - line, ppos)) - return(0); - flushed = 1; - } - if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) - return(0); - break; - } + ntok = ac == ARGS_QWORD ? MDOC_MAX : + lookup(mdoc, tok, line, lastarg, p); - if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) - return(0); - mdoc->next = MDOC_NEXT_SIBLING; + if (ntok == MDOC_MAX) { + dword(mdoc, line, lastarg, p, DELIM_MAX, + MDOC_JOIN & mdoc_macros[tok].flags); + continue; + } + + if ( ! flushed) { + if (endbody == NULL) + rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos); + else + rew_last(mdoc, endbody); + flushed = 1; + } + mdoc->flags &= ~MDOC_NEWLINE; + mdoc_macro(mdoc, ntok, line, lastarg, pos, buf); + break; } - if ( ! flushed && ! rew_expblock(mdoc, tok, line, ppos)) - return(0); - - if (ppos > 1) - return(1); - return(append_delims(mdoc, line, pos, buf)); + if ( ! flushed) { + if (endbody == NULL) + rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos); + else + rew_last(mdoc, endbody); + } + if (nl) + append_delims(mdoc, line, pos, buf); } - -/* - * In-line macros where reserved words cause scope close-reopen. - */ -static int +static void in_line(MACRO_PROT_ARGS) { - int la, lastpunct, c, w, cnt, d, call; - struct mdoc_arg *arg; - char *p; + int la, scope, cnt, firstarg, mayopen, nc, nl; + enum mdoct ntok; + enum margserr ac; + enum mdelim d; + struct mdoc_arg *arg; + char *p; - for (la = ppos, arg = NULL;; ) { - la = *pos; - c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); + nl = MDOC_NEWLINE & mdoc->flags; - if (ARGV_WORD == c) { - *pos = la; - break; - } - if (ARGV_EOLN == c) - break; - if (ARGV_ARG == c) - continue; + /* + * Whether we allow ignored elements (those without content, + * usually because of reserved words) to squeak by. + */ - mdoc_argv_free(arg); - return(0); + switch (tok) { + case MDOC_An: + /* FALLTHROUGH */ + case MDOC_Ar: + /* FALLTHROUGH */ + case MDOC_Fl: + /* FALLTHROUGH */ + case MDOC_Mt: + /* FALLTHROUGH */ + case MDOC_Nm: + /* FALLTHROUGH */ + case MDOC_Pa: + nc = 1; + break; + default: + nc = 0; + break; } - for (call = cnt = 0, lastpunct = 1;; ) { + mdoc_argv(mdoc, line, tok, &arg, pos, buf); + + d = DELIM_NONE; + firstarg = 1; + mayopen = 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) - return(0); - if (ARGS_EOLN == w) + /* + * 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 (ARGS_PUNCT == w) - break; + } - /* Quoted words shouldn't be looked-up. */ + /* + * 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. + */ - c = ARGS_QWORD == w ? MDOC_MAX : - lookup(mdoc, line, la, tok, p); + if (ac == ARGS_PUNCT) { + if (cnt == 0 && nc == 0) + mdoc->flags |= MDOC_NODELIMC; + break; + } - /* MDOC_MAX (not a macro) or -1 (error). */ + ntok = (ac == ARGS_QWORD || (tok == MDOC_Fn && !cnt)) ? + MDOC_MAX : lookup(mdoc, tok, line, la, p); - if (MDOC_MAX != c && -1 != c) { - if (0 == lastpunct && ! rew_elem(mdoc, tok)) - return(0); - if (0 == cnt) { - if ( ! mdoc_elem_alloc(mdoc, line, ppos, - tok, arg)) - return(0); - if ( ! rew_elem(mdoc, tok)) - return(0); - mdoc->next = MDOC_NEXT_SIBLING; + /* + * 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 (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); + mandoc_msg(MANDOCERR_MACRO_EMPTY, + mdoc->parse, line, ppos, + mdoc_macronames[tok]); } - c = mdoc_macro(mdoc, c, line, la, pos, buf); - if (0 == c) - return(0); - if (ppos > 1) - return(1); - return(append_delims(mdoc, line, pos, buf)); - } else if (-1 == c) - return(0); + mdoc_macro(mdoc, ntok, line, la, pos, buf); + if (nl) + append_delims(mdoc, line, pos, buf); + return; + } - /* Non-quote-enclosed punctuation. */ + /* + * Non-quote-enclosed punctuation. Set up our scope, if + * a word; rewind the scope, if a delimiter; then append + * the word. + */ - d = mdoc_isdelim(p); + d = ac == ARGS_QWORD ? DELIM_NONE : mdoc_isdelim(p); - if (ARGS_QWORD != w && d) { - if (0 == lastpunct && ! rew_elem(mdoc, tok)) - return(0); - lastpunct = 1; - } else if (lastpunct) { - c = mdoc_elem_alloc(mdoc, line, ppos, tok, arg); - if (0 == c) - return(0); - mdoc->next = MDOC_NEXT_CHILD; - lastpunct = 0; + if (DELIM_NONE != d) { + /* + * If we encounter closing punctuation, no word + * has been emitted, no scope is open, and we're + * allowed to have an empty element, then start + * a new scope. + */ + 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(mdoc, tok); + scope = 0; + if (tok == MDOC_Fn) + mayopen = 0; + } else if (mayopen && !scope) { + mdoc_elem_alloc(mdoc, line, ppos, tok, arg); + scope = 1; + cnt++; } - if ( ! d) - cnt++; - if ( ! mdoc_word_alloc(mdoc, line, la, p)) - return(0); - mdoc->next = MDOC_NEXT_SIBLING; + dword(mdoc, line, la, p, d, + MDOC_JOIN & mdoc_macros[tok].flags); + + /* + * 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 && tok == MDOC_Fl) { + rew_elem(mdoc, tok); + scope = 0; + } } - if (0 == lastpunct && ! rew_elem(mdoc, tok)) - return(0); - if (0 == cnt) { - c = mdoc_elem_alloc(mdoc, line, ppos, tok, arg); - if (0 == c) - return(0); - if ( ! rew_elem(mdoc, tok)) - return(0); + if (scope) + rew_elem(mdoc, tok); + + /* + * 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 ( ! 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 (ppos > 1) - return(1); - return(append_delims(mdoc, line, pos, buf)); + if (nl) + append_delims(mdoc, line, pos, buf); } - -/* - * Block full-explicit and full-implicit. - */ -static int +static void blk_full(MACRO_PROT_ARGS) { - int c, lastarg, reopen; + 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 *n; + enum margserr ac, lac; char *p; - if ( ! (MDOC_EXPLICIT & mdoc_macros[tok].flags)) { - if ( ! rew_subblock(MDOC_BODY, mdoc, - tok, line, ppos)) - return(0); - if ( ! rew_impblock(mdoc, tok, line, ppos)) - return(0); - } + nl = MDOC_NEWLINE & mdoc->flags; - for (arg = NULL;; ) { - lastarg = *pos; - c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); + /* Skip items outside lists. */ - if (ARGV_WORD == c) { - *pos = lastarg; - break; - } + if (tok == MDOC_It) { + for (n = mdoc->last; n; n = n->parent) + if (n->tok == MDOC_Bl && n->type == MDOC_BLOCK && + ! (n->flags & (MDOC_VALID | MDOC_BREAK))) + break; + if (n == NULL) { + 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; + } + } - if (ARGV_EOLN == c) - break; - if (ARGV_ARG == c) - continue; + /* Close out prior implicit scope. */ - mdoc_argv_free(arg); - return(0); + if ( ! (mdoc_macros[tok].flags & MDOC_EXPLICIT)) { + rew_sub(MDOC_BODY, mdoc, tok, line, ppos); + rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos); } - if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, arg)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; + /* + * 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. + */ - if (0 == buf[*pos]) { - if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) - return(0); - if ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) - return(0); - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; - return(1); - } + mdoc_argv(mdoc, line, tok, &arg, pos, buf); + mdoc_block_alloc(mdoc, line, ppos, tok, arg); + head = body = NULL; - if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; + /* + * Exception: Heads of `It' macros in `-diag' lists are not + * parsed, even though `It' macros in general are parsed. + */ - for (reopen = 0;; ) { - lastarg = *pos; - c = mdoc_args(mdoc, line, pos, buf, tok, &p); + parsed = tok != MDOC_It || + mdoc->last->parent->tok != MDOC_Bl || + mdoc->last->parent->norm->Bl.type != LIST_diag; - if (ARGS_ERROR == c) - return(0); - if (ARGS_EOLN == c) + /* + * The `Nd' macro has all arguments in its body: it's a hybrid + * of block partial-explicit and full-implicit. Stupid. + */ + + if (tok == MDOC_Nd) { + head = mdoc_head_alloc(mdoc, line, ppos, tok); + rew_last(mdoc, head); + body = mdoc_body_alloc(mdoc, line, ppos, tok); + } + + if (tok == MDOC_Bk) + mdoc->flags |= MDOC_KEEP; + + ac = ARGS_PEND; + for (;;) { + la = *pos; + lac = ac; + ac = mdoc_args(mdoc, line, pos, buf, tok, &p); + if (ac == ARGS_PUNCT) break; - if (ARGS_PHRASE == c) { - if (reopen && ! mdoc_head_alloc - (mdoc, line, ppos, tok)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; + if (ac == ARGS_EOLN) { + if (lac != ARGS_PPHRASE && lac != ARGS_PHRASE) + break; /* - * Phrases are self-contained macro phrases used - * in the columnar output of a macro. They need - * special handling. + * 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 ( ! phrase(mdoc, line, lastarg, buf)) - return(0); - if ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) - return(0); + rew_sub(MDOC_BODY, mdoc, tok, line, ppos); + body = mdoc_body_alloc(mdoc, line, ppos, tok); + break; + } - reopen = 1; + /* + * Emit leading punctuation (i.e., punctuation before + * the MDOC_HEAD) for non-phrase types. + */ + + 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; } - if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) - return(0); + /* Open a head if one hasn't been opened. */ - if (MDOC_MAX == c) { - if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) - return(0); - mdoc->next = MDOC_NEXT_SIBLING; + if (head == NULL) + head = mdoc_head_alloc(mdoc, line, ppos, tok); + + 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. + */ + + rew_sub(body ? MDOC_BODY : MDOC_HEAD, + mdoc, tok, line, ppos); + body = mdoc_body_alloc(mdoc, line, ppos, tok); + + /* + * Process phrases: set whether we're in a + * partial-phrase (this effects line handling) + * then call down into the phrase parser. + */ + + 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; - } + } - if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) - return(0); - break; + if (macro_or_word(mdoc, tok, line, la, pos, buf, parsed)) + break; } - - if (1 == ppos && ! append_delims(mdoc, line, pos, buf)) - return(0); - if ( ! rew_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) - return(0); - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; + if (head == NULL) + head = mdoc_head_alloc(mdoc, line, ppos, tok); + if (nl) + append_delims(mdoc, line, pos, buf); + if (body != NULL) + goto out; - return(1); -} + /* + * 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 (n->type == MDOC_BLOCK && + mdoc_macros[n->tok].flags & MDOC_EXPLICIT && + ! (n->flags & MDOC_VALID)) { + n->pending = head; + return; + } + } + /* Close out scopes to remain in a consistent state. */ -/* - * Block partial-imnplicit scope. - */ -static int + rew_sub(MDOC_HEAD, mdoc, tok, line, ppos); + mdoc_body_alloc(mdoc, line, ppos, tok); +out: + if (mdoc->flags & MDOC_FREECOL) { + rew_sub(MDOC_BODY, mdoc, tok, line, ppos); + rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos); + mdoc->flags &= ~MDOC_FREECOL; + } +} + +static void blk_part_imp(MACRO_PROT_ARGS) { - int lastarg, c; + int la, nl; + 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; - if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; - blk = mdoc->last; + nl = MDOC_NEWLINE & mdoc->flags; - if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) - return(0); - mdoc->next = MDOC_NEXT_SIBLING; + /* + * 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_body_alloc(mdoc, line, ppos, tok)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; - body = mdoc->last; + blk = mdoc_block_alloc(mdoc, line, ppos, tok, NULL); + rew_last(mdoc, mdoc_head_alloc(mdoc, line, ppos, tok)); - /* 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); - - if (ARGS_ERROR == c) - return(0); - if (ARGS_PUNCT == c) + for (body = NULL; ; ) { + la = *pos; + ac = mdoc_args(mdoc, line, pos, buf, tok, &p); + if (ac == ARGS_EOLN || ac == ARGS_PUNCT) break; - if (ARGS_EOLN == c) - 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)) - return(0); - mdoc->next = MDOC_NEXT_SIBLING; + if (body == NULL && ac != ARGS_QWORD && + mdoc_isdelim(p) == DELIM_OPEN) { + dword(mdoc, line, la, p, DELIM_OPEN, 0); continue; - } + } - if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) - return(0); - break; + if (body == NULL) + body = mdoc_body_alloc(mdoc, line, ppos, tok); + + if (macro_or_word(mdoc, tok, line, la, pos, buf, 1)) + break; } + if (body == NULL) + body = mdoc_body_alloc(mdoc, line, ppos, tok); /* - * 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 = n->parent) - if (body == n) - break; + 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(n, tok, mdoc, line, ppos); + mdoc_endbody_alloc(mdoc, line, ppos, + tok, body, ENDBODY_NOSPACE); + return; + } + } + assert(n == body); + rew_sub(MDOC_BODY, mdoc, tok, line, ppos); + if (nl) + append_delims(mdoc, line, pos, buf); + rew_sub(MDOC_BLOCK, mdoc, tok, line, ppos); - if (NULL == n && ! pwarn(mdoc, body->line, body->pos, WIMPBRK)) - return(0); + /* Move trailing .Ns out of scope. */ - if (n && ! rew_last(mdoc, body)) - return(0); - - if (1 == ppos && ! append_delims(mdoc, line, pos, buf)) - return(0); - - if (n && ! rew_last(mdoc, blk)) - 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); } - -/* - * Block partial-explicit macros. - */ -static int +static void 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 */ char *p; - 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; - } + mdoc_block_alloc(mdoc, line, ppos, tok, NULL); + head = NULL; + for (;;) { + la = *pos; + ac = mdoc_args(mdoc, line, pos, buf, tok, &p); + if (ac == ARGS_PUNCT || ac == ARGS_EOLN) + break; - if ( ! mdoc_block_alloc(mdoc, line, ppos, tok, NULL)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; + /* Flush out leading punctuation. */ - if (0 == maxargs) { - if ( ! mdoc_head_alloc(mdoc, line, ppos, tok)) - 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); - - mdoc->next = MDOC_NEXT_CHILD; - - for (j = 0; ; j++) { - lastarg = *pos; - if (j == maxargs && ! flushed) { - if ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) - return(0); - flushed = 1; - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; + if (head == NULL && ac != ARGS_QWORD && + mdoc_isdelim(p) == DELIM_OPEN) { + dword(mdoc, line, la, p, DELIM_OPEN, 0); + continue; } - c = mdoc_args(mdoc, line, pos, buf, tok, &p); - assert(ARGS_PHRASE != c); - - if (ARGS_ERROR == c) - return(0); - if (ARGS_PUNCT == c) - break; - if (ARGS_EOLN == c) - break; - - if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) - return(0); - else if (MDOC_MAX != c) { - if ( ! flushed) { - if ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) - return(0); - flushed = 1; - if ( ! mdoc_body_alloc(mdoc, line, - ppos, tok)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; - } - if ( ! mdoc_macro(mdoc, c, line, lastarg, - pos, buf)) - return(0); - break; + if (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; } - if ( ! flushed && mdoc_isdelim(p)) { - if ( ! rew_subblock(MDOC_HEAD, mdoc, - tok, line, ppos)) - return(0); - flushed = 1; - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; - } - - if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) - return(0); - mdoc->next = MDOC_NEXT_SIBLING; + if (macro_or_word(mdoc, tok, line, la, pos, buf, 1)) + break; } - if ( ! flushed) { - if ( ! rew_subblock(MDOC_HEAD, mdoc, tok, line, ppos)) - return(0); - if ( ! mdoc_body_alloc(mdoc, line, ppos, tok)) - return(0); - mdoc->next = MDOC_NEXT_CHILD; - } + /* Clean-up to leave in a consistent state. */ - if (ppos > 1) - return(1); - return(append_delims(mdoc, line, pos, buf)); + if (head == NULL) { + rew_last(mdoc, mdoc_head_alloc(mdoc, line, ppos, tok)); + mdoc_body_alloc(mdoc, line, ppos, tok); + } + if (nl) + 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. - */ -static int +static void 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; + 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->flags & MDOC_NEWLINE; + + /* + * 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) { - 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: + /* FALLTHROUGH */ + case MDOC_Es: + /* 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); + mdoc_argv(mdoc, line, tok, &arg, pos, buf); - if (ARGV_WORD == c) { - *pos = lastarg; + p = NULL; + flushed = j = 0; + for (;;) { + la = *pos; + 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 (ARGV_EOLN == c) - break; - if (ARGV_ARG == c) + 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 (j == 0) + mdoc_elem_alloc(mdoc, line, ppos, tok, arg); - 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; ; j++) { - lastarg = *pos; - if (j == maxargs && ! flushed) { - if ( ! rew_elem(mdoc, tok)) - return(0); + rew_elem(mdoc, tok); flushed = 1; } - c = mdoc_args(mdoc, line, pos, buf, tok, &p); + ntok = (ac == ARGS_QWORD || (tok == MDOC_Pf && j == 0)) ? + MDOC_MAX : lookup(mdoc, tok, line, la, p); - if (ARGS_ERROR == c) - return(0); - if (ARGS_PUNCT == c) - break; - if (ARGS_EOLN == c) - break; - - if (-1 == (c = lookup(mdoc, line, lastarg, tok, p))) - return(0); - else if (MDOC_MAX != c) { - if ( ! flushed && ! rew_elem(mdoc, tok)) - return(0); + if (ntok != MDOC_MAX) { + if ( ! flushed) + rew_elem(mdoc, tok); flushed = 1; - if ( ! mdoc_macro(mdoc, c, line, lastarg, pos, buf)) - return(0); + mdoc_macro(mdoc, ntok, line, la, pos, buf); + j++; break; } - if ( ! (MDOC_IGNDELIM & mdoc_macros[tok].flags) && - ! flushed && mdoc_isdelim(p)) { - if ( ! rew_elem(mdoc, 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; } - - if ( ! mdoc_word_alloc(mdoc, line, lastarg, p)) - return(0); - mdoc->next = MDOC_NEXT_SIBLING; + + dword(mdoc, line, la, p, DELIM_MAX, + MDOC_JOIN & mdoc_macros[tok].flags); + j++; } - if ( ! flushed && ! rew_elem(mdoc, tok)) - return(0); - - if (ppos > 1) - return(1); - return(append_delims(mdoc, line, pos, buf)); + if (j == 0) { + 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); } +static void +in_line_eoln(MACRO_PROT_ARGS) +{ + struct mdoc_arg *arg; + if (tok == MDOC_Pp) + rew_sub(MDOC_BLOCK, mdoc, MDOC_Nm, line, ppos); + + 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); +} + /* - * In-line macro that spans an entire line. May be callable, but has no - * subsequent parsed arguments. + * 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 c, w, la; - struct mdoc_arg *arg; - char *p; + int la; - assert( ! (MDOC_PARSED & mdoc_macros[tok].flags)); - - arg = NULL; - for (;;) { la = *pos; - c = mdoc_argv(mdoc, line, tok, &arg, pos, buf); - - if (ARGV_WORD == c) { - *pos = la; - break; - } - if (ARGV_EOLN == c) - break; - if (ARGV_ARG == c) - continue; - - mdoc_argv_free(arg); - return(0); - } - - if ( ! mdoc_elem_alloc(mdoc, line, ppos, tok, arg)) - return(0); - - mdoc->next = MDOC_NEXT_CHILD; - - for (;;) { - la = *pos; - w = mdoc_args(mdoc, line, pos, buf, tok, &p); - - if (ARGS_ERROR == w) + if (mdoc_args(mdoc, line, pos, buf, tok, NULL) == ARGS_EOLN) return(0); - if (ARGS_EOLN == w) - break; - - c = ARGS_QWORD == w ? MDOC_MAX : - lookup(mdoc, line, la, tok, p); - - if (MDOC_MAX != c && -1 != c) { - if ( ! rew_elem(mdoc, tok)) - return(0); - return(mdoc_macro(mdoc, c, line, la, pos, buf)); - } else if (-1 == c) - return(0); - - if ( ! mdoc_word_alloc(mdoc, line, la, p)) - return(0); - mdoc->next = MDOC_NEXT_SIBLING; + if (macro_or_word(mdoc, tok, line, la, pos, buf, 1)) + return(1); } - - return(rew_elem(mdoc, tok)); } - -/* ARGSUSED */ -static int -obsolete(MACRO_PROT_ARGS) +static void +ctx_synopsis(MACRO_PROT_ARGS) { - return(pwarn(mdoc, line, ppos, WOBS)); + 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); + } } - -static int -phrase(struct mdoc *mdoc, int line, int ppos, char *buf) +/* + * 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 void +phrase_ta(MACRO_PROT_ARGS) { - int i, la, c, quoted; + struct mdoc_node *n; - /* - * 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. - */ + /* Make sure we are in a column list or ignore this macro. */ - for (i = ppos; buf[i]; ) { - assert(' ' != buf[i]); - la = i; - quoted = 0; - - /* - * Read to next token. If quoted (check not escaped), - * scan ahead to next unescaped quote. If not quoted or - * escape-quoted, then scan ahead to next space. - */ - - if ((i && '\"' == buf[i] && '\\' != buf[i - 1]) || - (0 == i && '\"' == buf[i])) { - for (la = ++i; buf[i]; i++) - if ('\"' != buf[i]) - continue; - else if ('\\' != buf[i - 1]) - break; - if (0 == buf[i]) - return(perr(mdoc, line, la, EQUOT)); - quoted = 1; - } else - for ( ; buf[i]; i++) - if (i && ' ' == buf[i]) { - if ('\\' != buf[i - 1]) - break; - } else if (' ' == buf[i]) - break; - - /* If not end-of-line, terminate argument. */ - - if (buf[i]) - buf[i++] = 0; - - /* Read to next argument. */ - - 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. - */ - - c = quoted ? MDOC_MAX : - mdoc_tokhash_find(mdoc->htab, &buf[la]); - - if (MDOC_MAX != c) { - if ( ! mdoc_macro(mdoc, c, line, la, &i, buf)) - return(0); - return(append_delims(mdoc, line, &i, buf)); - } - - /* A regular word or quoted string. */ - - if ( ! mdoc_word_alloc(mdoc, line, la, &buf[la])) - return(0); - mdoc->next = MDOC_NEXT_SIBLING; + n = mdoc->last; + while (n != NULL && + (n->tok != MDOC_Bl || n->flags & (MDOC_VALID | MDOC_BREAK))) + n = n->parent; + 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_sub(MDOC_BODY, mdoc, MDOC_It, line, ppos); + mdoc_body_alloc(mdoc, line, ppos, MDOC_It); + parse_rest(mdoc, MDOC_MAX, line, pos, buf); }