=================================================================== RCS file: /cvs/mandoc/man_macro.c,v retrieving revision 1.21 retrieving revision 1.41 diff -u -p -r1.21 -r1.41 --- mandoc/man_macro.c 2009/08/19 09:14:50 1.21 +++ mandoc/man_macro.c 2010/03/29 04:52:14 1.41 @@ -1,4 +1,4 @@ -/* $Id: man_macro.c,v 1.21 2009/08/19 09:14:50 kristaps Exp $ */ +/* $Id: man_macro.c,v 1.41 2010/03/29 04:52:14 kristaps Exp $ */ /* * Copyright (c) 2008, 2009 Kristaps Dzonsons * @@ -14,6 +14,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 @@ -21,26 +25,33 @@ #include "libman.h" -#define REW_REWIND (0) /* See rew_scope(). */ -#define REW_NOHALT (1) /* See rew_scope(). */ -#define REW_HALT (2) /* See rew_scope(). */ +enum rew { + REW_REWIND, + REW_NOHALT, + REW_HALT +}; -static int in_line_eoln(MACRO_PROT_ARGS); -static int blk_imp(MACRO_PROT_ARGS); static int blk_close(MACRO_PROT_ARGS); +static int blk_dotted(MACRO_PROT_ARGS); +static int blk_exp(MACRO_PROT_ARGS); +static int blk_imp(MACRO_PROT_ARGS); +static int in_line_eoln(MACRO_PROT_ARGS); -static int rew_scope(enum man_type, struct man *, int); -static int rew_dohalt(int, enum man_type, +static int rew_scope(enum man_type, + struct man *, enum mant); +static enum rew rew_dohalt(enum mant, enum man_type, const struct man_node *); -static int rew_block(int, enum man_type, +static enum rew rew_block(enum mant, enum man_type, const struct man_node *); +static int rew_warn(struct man *, + struct man_node *, enum merr); const struct man_macro __man_macros[MAN_MAX] = { - { in_line_eoln, 0 }, /* br */ + { in_line_eoln, MAN_NSCOPED }, /* br */ { in_line_eoln, 0 }, /* TH */ - { blk_imp, 0 }, /* SH */ - { blk_imp, 0 }, /* SS */ - { blk_imp, MAN_SCOPED }, /* TP */ + { blk_imp, MAN_SCOPED }, /* SH */ + { blk_imp, MAN_SCOPED }, /* SS */ + { blk_imp, MAN_SCOPED | MAN_FSCOPED }, /* TP */ { blk_imp, 0 }, /* LP */ { blk_imp, 0 }, /* PP */ { blk_imp, 0 }, /* P */ @@ -57,28 +68,64 @@ const struct man_macro __man_macros[MAN_MAX] = { { in_line_eoln, MAN_SCOPED }, /* I */ { in_line_eoln, 0 }, /* IR */ { in_line_eoln, 0 }, /* RI */ - { in_line_eoln, 0 }, /* na */ + { in_line_eoln, MAN_NSCOPED }, /* na */ { in_line_eoln, 0 }, /* i */ - { in_line_eoln, 0 }, /* sp */ + { in_line_eoln, MAN_NSCOPED }, /* sp */ { in_line_eoln, 0 }, /* nf */ { in_line_eoln, 0 }, /* fi */ { in_line_eoln, 0 }, /* r */ { blk_close, 0 }, /* RE */ - { blk_imp, 0 }, /* RS */ + { blk_exp, MAN_EXPLICIT }, /* RS */ + { in_line_eoln, 0 }, /* DT */ + { in_line_eoln, 0 }, /* UC */ + { in_line_eoln, 0 }, /* PD */ + { in_line_eoln, MAN_NSCOPED }, /* Sp */ + { in_line_eoln, 0 }, /* Vb */ + { in_line_eoln, 0 }, /* Ve */ + { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* de */ + { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* dei */ + { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* am */ + { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ami */ + { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ig */ + { blk_dotted, 0 }, /* . */ }; const struct man_macro * const man_macros = __man_macros; +/* + * Warn when "n" is an explicit non-roff macro. + */ +static int +rew_warn(struct man *m, struct man_node *n, enum merr er) +{ + + if (er == WERRMAX || MAN_BLOCK != n->type) + return(1); + if (MAN_VALID & n->flags) + return(1); + if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags)) + return(1); + if (MAN_NOCLOSE & man_macros[n->tok].flags) + return(1); + return(man_nwarn(m, n, er)); +} + + +/* + * Rewind scope. If a code "er" != WERRMAX has been provided, it will + * be used if an explicit block scope is being closed out. + */ int -man_unscope(struct man *m, const struct man_node *n) +man_unscope(struct man *m, const struct man_node *n, enum merr er) { assert(n); - m->next = MAN_NEXT_SIBLING; /* LINTED */ while (m->last != n) { + if ( ! rew_warn(m, m->last, er)) + return(0); if ( ! man_valid_post(m)) return(0); if ( ! man_action_post(m)) @@ -87,14 +134,22 @@ man_unscope(struct man *m, const struct man_node *n) assert(m->last); } + if ( ! rew_warn(m, m->last, er)) + return(0); if ( ! man_valid_post(m)) return(0); - return(man_action_post(m)); + if ( ! man_action_post(m)) + return(0); + + m->next = MAN_ROOT == m->last->type ? + MAN_NEXT_CHILD : MAN_NEXT_SIBLING; + + return(1); } -static int -rew_block(int ntok, enum man_type type, const struct man_node *n) +static enum rew +rew_block(enum mant ntok, enum man_type type, const struct man_node *n) { if (MAN_BLOCK == type && ntok == n->parent->tok && @@ -109,23 +164,52 @@ rew_block(int ntok, enum man_type type, const struct m * section (all less sections), and scoped to subsections (all less * sections and subsections). */ -static int -rew_dohalt(int tok, enum man_type type, const struct man_node *n) +static enum rew +rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n) { - int c; + enum rew c; + /* We cannot progress beyond the root ever. */ if (MAN_ROOT == n->type) return(REW_HALT); + assert(n->parent); + + /* Normal nodes shouldn't go to the level of the root. */ if (MAN_ROOT == n->parent->type) return(REW_REWIND); + + /* Already-validated nodes should be closed out. */ if (MAN_VALID & n->flags) return(REW_NOHALT); - /* Rewind to ourselves, first. */ + /* First: rewind to ourselves. */ if (type == n->type && tok == n->tok) return(REW_REWIND); + /* + * If we're a roff macro, then we can close out anything that + * stands between us and our parent context. + */ + if (MAN_NOCLOSE & man_macros[tok].flags) + return(REW_NOHALT); + + /* + * Don't clobber roff macros: this is a bit complicated. If the + * current macro is a roff macro, halt immediately and don't + * rewind. If it's not, and the parent is, then close out the + * current scope and halt at the parent. + */ + if (MAN_NOCLOSE & man_macros[n->tok].flags) + return(REW_HALT); + if (MAN_NOCLOSE & man_macros[n->parent->tok].flags) + return(REW_REWIND); + + /* + * Next follow the implicit scope-smashings as defined by man.7: + * section, sub-section, etc. + */ + switch (tok) { case (MAN_SH): break; @@ -165,10 +249,10 @@ rew_dohalt(int tok, enum man_type type, const struct m * scopes. When a scope is closed, it must be validated and actioned. */ static int -rew_scope(enum man_type type, struct man *m, int tok) +rew_scope(enum man_type type, struct man *m, enum mant tok) { struct man_node *n; - int c; + enum rew c; /* LINTED */ for (n = m->last; n; n = n->parent) { @@ -184,18 +268,86 @@ rew_scope(enum man_type type, struct man *m, int tok) break; } - /* Rewind until the current point. */ - + /* + * Rewind until the current point. Warn if we're a roff + * instruction that's mowing over explicit scopes. + */ assert(n); - return(man_unscope(m, n)); + if (MAN_NOCLOSE & man_macros[tok].flags) + return(man_unscope(m, n, WROFFSCOPE)); + + return(man_unscope(m, n, WERRMAX)); } +/* + * Closure for dotted macros (de, dei, am, ami, ign). This must handle + * any of these as the parent node, so it needs special handling. + * Beyond this, it's the same as blk_close(). + */ /* ARGSUSED */ int +blk_dotted(MACRO_PROT_ARGS) +{ + enum mant ntok; + struct man_node *nn; + + /* Check for any of the following parents... */ + + for (nn = m->last->parent; nn; nn = nn->parent) + if (nn->tok == MAN_de || nn->tok == MAN_dei || + nn->tok == MAN_am || + nn->tok == MAN_ami || + nn->tok == MAN_ig) { + ntok = nn->tok; + break; + } + + if (NULL == nn) { + if ( ! man_pwarn(m, line, ppos, WNOSCOPE)) + return(0); + return(1); + } + + if ( ! rew_scope(MAN_BODY, m, ntok)) + return(0); + if ( ! rew_scope(MAN_BLOCK, m, ntok)) + return(0); + + /* + * XXX: manually adjust our next-line status. roff macros are, + * for the moment, ignored, so we don't want to close out bodies + * and so on. + */ + + switch (m->last->type) { + case (MAN_BODY): + m->next = MAN_NEXT_CHILD; + break; + default: + break; + } + + /* + * Restore flags set when we got here and also stipulate that we + * don't post-process the line when exiting the macro op + * function in man_pmacro(). + */ + m->flags = m->svflags; + m->flags |= MAN_ILINE; + + return(1); +} + + +/* + * Close out a generic explicit macro. + */ +/* ARGSUSED */ +int blk_close(MACRO_PROT_ARGS) { - int ntok; + enum mant ntok; const struct man_node *nn; switch (tok) { @@ -219,11 +371,65 @@ blk_close(MACRO_PROT_ARGS) return(0); if ( ! rew_scope(MAN_BLOCK, m, ntok)) return(0); - m->next = MAN_NEXT_SIBLING; + return(1); } +int +blk_exp(MACRO_PROT_ARGS) +{ + int w, la; + char *p; + + /* + * Close out prior scopes. "Regular" explicit macros cannot be + * nested, but we allow roff macros to be placed just about + * anywhere. + */ + + if ( ! (MAN_NOCLOSE & man_macros[tok].flags)) { + if ( ! rew_scope(MAN_BODY, m, tok)) + return(0); + if ( ! rew_scope(MAN_BLOCK, m, tok)) + return(0); + } else { + /* + * Save our state; we restore it when exiting from the + * roff instruction block. + */ + m->svflags = m->flags; + m->flags = 0; + } + + if ( ! man_block_alloc(m, line, ppos, tok)) + return(0); + if ( ! man_head_alloc(m, line, ppos, tok)) + return(0); + + for (;;) { + la = *pos; + w = man_args(m, line, pos, buf, &p); + + if (-1 == w) + return(0); + if (0 == w) + break; + + if ( ! man_word_alloc(m, line, la, p)) + return(0); + } + + assert(m); + assert(tok != MAN_MAX); + + if ( ! rew_scope(MAN_HEAD, m, tok)) + return(0); + return(man_body_alloc(m, line, ppos, tok)); +} + + + /* * Parse an implicit-block macro. These contain a MAN_HEAD and a * MAN_BODY contained within a MAN_BLOCK. Rules for closing out other @@ -235,6 +441,7 @@ blk_imp(MACRO_PROT_ARGS) { int w, la; char *p; + struct man_node *n; /* Close out prior scopes. */ @@ -250,6 +457,8 @@ blk_imp(MACRO_PROT_ARGS) if ( ! man_head_alloc(m, line, ppos, tok)) return(0); + n = m->last; + /* Add line arguments. */ for (;;) { @@ -268,11 +477,18 @@ blk_imp(MACRO_PROT_ARGS) /* Close out head and open body (unless MAN_SCOPE). */ if (MAN_SCOPED & man_macros[tok].flags) { - m->flags |= MAN_BLINE; - return(1); - } else if ( ! rew_scope(MAN_HEAD, m, tok)) - return(0); + /* If we're forcing scope (`TP'), keep it open. */ + if (MAN_FSCOPED & man_macros[tok].flags) { + m->flags |= MAN_BLINE; + return(1); + } else if (n == m->last) { + m->flags |= MAN_BLINE; + return(1); + } + } + if ( ! rew_scope(MAN_HEAD, m, tok)) + return(0); return(man_body_alloc(m, line, ppos, tok)); } @@ -297,23 +513,35 @@ in_line_eoln(MACRO_PROT_ARGS) return(0); if (0 == w) break; - if ( ! man_word_alloc(m, line, la, p)) return(0); } - if (n == m->last && (MAN_SCOPED & man_macros[tok].flags)) { + /* + * If no arguments are specified and this is MAN_SCOPED (i.e., + * next-line scoped), then set our mode to indicate that we're + * waiting for terms to load into our context. + */ + + if (n == m->last && MAN_SCOPED & man_macros[tok].flags) { + assert( ! (MAN_NSCOPED & man_macros[tok].flags)); m->flags |= MAN_ELINE; return(1); } + /* Set ignorable context, if applicable. */ + + if (MAN_NSCOPED & man_macros[tok].flags) { + assert( ! (MAN_SCOPED & man_macros[tok].flags)); + m->flags |= MAN_ILINE; + } + /* - * Note that when TH is pruned, we'll be back at the root, so - * make sure that we don't clobber as its sibling. + * Rewind our element scope. Note that when TH is pruned, we'll + * be back at the root, so make sure that we don't clobber as + * its sibling. */ - /* FIXME: clean this to use man_unscope(). */ - for ( ; m->last; m->last = m->last->parent) { if (m->last == n) break; @@ -335,9 +563,10 @@ in_line_eoln(MACRO_PROT_ARGS) return(0); if (m->last->type != MAN_ROOT && ! man_action_post(m)) return(0); - if (m->last->type != MAN_ROOT) - m->next = MAN_NEXT_SIBLING; + m->next = MAN_ROOT == m->last->type ? + MAN_NEXT_CHILD : MAN_NEXT_SIBLING; + return(1); } @@ -346,6 +575,6 @@ int man_macroend(struct man *m) { - return(man_unscope(m, m->first)); + return(man_unscope(m, m->first, WEXITSCOPE)); }