=================================================================== RCS file: /cvs/mandoc/man_macro.c,v retrieving revision 1.20 retrieving revision 1.35 diff -u -p -r1.20 -r1.35 --- mandoc/man_macro.c 2009/08/18 08:48:30 1.20 +++ mandoc/man_macro.c 2010/03/24 20:10:53 1.35 @@ -1,4 +1,4 @@ -/* $Id: man_macro.c,v 1.20 2009/08/18 08:48:30 kristaps Exp $ */ +/* $Id: man_macro.c,v 1.35 2010/03/24 20:10:53 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,23 +25,31 @@ #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_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 enum rew rew_block(enum mant, enum man_type, + const struct man_node *); 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 */ @@ -54,12 +66,26 @@ 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_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; @@ -70,7 +96,6 @@ man_unscope(struct man *m, const struct man_node *n) { assert(n); - m->next = MAN_NEXT_SIBLING; /* LINTED */ while (m->last != n) { @@ -84,18 +109,36 @@ man_unscope(struct man *m, const struct man_node *n) 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 enum rew +rew_block(enum mant ntok, enum man_type type, const struct man_node *n) +{ + + if (MAN_BLOCK == type && ntok == n->parent->tok && + MAN_BODY == n->parent->type) + return(REW_REWIND); + return(ntok == n->tok ? REW_HALT : REW_NOHALT); +} + + /* * There are three scope levels: scoped to the root (all), scoped to the * 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) { + enum rew c; if (MAN_ROOT == n->type) return(REW_HALT); @@ -105,42 +148,36 @@ rew_dohalt(int tok, enum man_type type, const struct m if (MAN_VALID & n->flags) return(REW_NOHALT); + /* Rewind to ourselves, first. */ + if (type == n->type && tok == n->tok) + return(REW_REWIND); + switch (tok) { case (MAN_SH): - /* Rewind to ourselves. */ - if (type == n->type && tok == n->tok) - return(REW_REWIND); break; case (MAN_SS): - /* Rewind to ourselves. */ - if (type == n->type && tok == n->tok) - return(REW_REWIND); /* Rewind to a section, if a block. */ - if (MAN_BLOCK == type && MAN_SH == n->parent->tok && - MAN_BODY == n->parent->type) - return(REW_REWIND); - /* Don't go beyond a section. */ - if (MAN_SH == n->tok) - return(REW_HALT); + if (REW_NOHALT != (c = rew_block(MAN_SH, type, n))) + return(c); break; + case (MAN_RS): + /* Rewind to a subsection, if a block. */ + if (REW_NOHALT != (c = rew_block(MAN_SS, type, n))) + return(c); + /* Rewind to a section, if a block. */ + if (REW_NOHALT != (c = rew_block(MAN_SH, type, n))) + return(c); + break; default: - /* Rewind to ourselves. */ - if (type == n->type && tok == n->tok) - return(REW_REWIND); + /* Rewind to an offsetter, if a block. */ + if (REW_NOHALT != (c = rew_block(MAN_RS, type, n))) + return(c); /* Rewind to a subsection, if a block. */ - if (MAN_BLOCK == type && MAN_SS == n->parent->tok && - MAN_BODY == n->parent->type) - return(REW_REWIND); - /* Don't go beyond a subsection. */ - if (MAN_SS == n->tok) - return(REW_HALT); + if (REW_NOHALT != (c = rew_block(MAN_SS, type, n))) + return(c); /* Rewind to a section, if a block. */ - if (MAN_BLOCK == type && MAN_SH == n->parent->tok && - MAN_BODY == n->parent->type) - return(REW_REWIND); - /* Don't go beyond a section. */ - if (MAN_SH == n->tok) - return(REW_HALT); + if (REW_NOHALT != (c = rew_block(MAN_SH, type, n))) + return(c); break; } @@ -154,10 +191,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) { @@ -180,6 +217,120 @@ rew_scope(enum man_type type, struct man *m, int tok) } +/* ARGSUSED */ +int +blk_dotted(MACRO_PROT_ARGS) +{ + enum mant ntok; + struct man_node *nn; + + 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); + + return(1); +} + + +/* ARGSUSED */ +int +blk_close(MACRO_PROT_ARGS) +{ + enum mant ntok; + const struct man_node *nn; + + switch (tok) { + case (MAN_RE): + ntok = MAN_RS; + break; + default: + abort(); + /* NOTREACHED */ + } + + for (nn = m->last->parent; nn; nn = nn->parent) + if (ntok == nn->tok) + break; + + if (NULL == nn) + if ( ! man_pwarn(m, line, ppos, WNOSCOPE)) + return(0); + + if ( ! rew_scope(MAN_BODY, m, ntok)) + return(0); + if ( ! rew_scope(MAN_BLOCK, m, ntok)) + return(0); + + return(1); +} + + +int +blk_exp(MACRO_PROT_ARGS) +{ + int w, la; + char *p; + struct man_node *n; + + /* + * 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); + } + + if ( ! man_block_alloc(m, line, ppos, tok)) + return(0); + if ( ! man_head_alloc(m, line, ppos, tok)) + return(0); + + n = m->last; + + 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 @@ -191,6 +342,7 @@ blk_imp(MACRO_PROT_ARGS) { int w, la; char *p; + struct man_node *n; /* Close out prior scopes. */ @@ -206,6 +358,8 @@ blk_imp(MACRO_PROT_ARGS) if ( ! man_head_alloc(m, line, ppos, tok)) return(0); + n = m->last; + /* Add line arguments. */ for (;;) { @@ -219,17 +373,23 @@ blk_imp(MACRO_PROT_ARGS) if ( ! man_word_alloc(m, line, la, p)) return(0); - m->next = MAN_NEXT_SIBLING; } /* 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)); } @@ -245,7 +405,6 @@ in_line_eoln(MACRO_PROT_ARGS) return(0); n = m->last; - m->next = MAN_NEXT_CHILD; for (;;) { la = *pos; @@ -255,24 +414,35 @@ in_line_eoln(MACRO_PROT_ARGS) return(0); if (0 == w) break; - if ( ! man_word_alloc(m, line, la, p)) return(0); - m->next = MAN_NEXT_SIBLING; } - 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; @@ -294,9 +464,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); } @@ -304,6 +475,19 @@ in_line_eoln(MACRO_PROT_ARGS) int man_macroend(struct man *m) { + struct man_node *n; + + n = MAN_VALID & m->last->flags ? + m->last->parent : m->last; + + for ( ; n; n = n->parent) { + if (MAN_BLOCK != n->type) + continue; + if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags)) + continue; + if ( ! man_nwarn(m, n, WEXITSCOPE)) + return(0); + } return(man_unscope(m, m->first)); }