=================================================================== RCS file: /cvs/mandoc/man_macro.c,v retrieving revision 1.21 retrieving revision 1.97 diff -u -p -r1.21 -r1.97 --- mandoc/man_macro.c 2009/08/19 09:14:50 1.21 +++ mandoc/man_macro.c 2015/02/06 09:38:43 1.97 @@ -1,6 +1,8 @@ -/* $Id: man_macro.c,v 1.21 2009/08/19 09:14:50 kristaps Exp $ */ +/* $Id: man_macro.c,v 1.97 2015/02/06 09:38:43 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2012, 2013, 2014, 2015 Ingo Schwarze + * Copyright (c) 2013 Franco Fichtner * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -14,127 +16,204 @@ * 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 "man.h" +#include "mandoc.h" +#include "libmandoc.h" #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 void blk_close(MACRO_PROT_ARGS); +static void blk_exp(MACRO_PROT_ARGS); +static void blk_imp(MACRO_PROT_ARGS); +static void in_line_eoln(MACRO_PROT_ARGS); +static int man_args(struct man *, int, + int *, char *, char **); -static int rew_scope(enum man_type, struct man *, int); -static int rew_dohalt(int, enum man_type, +static void 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 *); const struct man_macro __man_macros[MAN_MAX] = { - { in_line_eoln, 0 }, /* br */ - { in_line_eoln, 0 }, /* TH */ - { blk_imp, 0 }, /* SH */ - { blk_imp, 0 }, /* SS */ - { blk_imp, MAN_SCOPED }, /* TP */ - { blk_imp, 0 }, /* LP */ - { blk_imp, 0 }, /* PP */ - { blk_imp, 0 }, /* P */ - { blk_imp, 0 }, /* IP */ - { blk_imp, 0 }, /* HP */ - { in_line_eoln, MAN_SCOPED }, /* SM */ - { in_line_eoln, MAN_SCOPED }, /* SB */ + { in_line_eoln, MAN_NSCOPED }, /* br */ + { in_line_eoln, MAN_BSCOPE }, /* TH */ + { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SH */ + { blk_imp, MAN_BSCOPE | MAN_SCOPED }, /* SS */ + { blk_imp, MAN_BSCOPE | MAN_SCOPED | MAN_FSCOPED }, /* TP */ + { blk_imp, MAN_BSCOPE }, /* LP */ + { blk_imp, MAN_BSCOPE }, /* PP */ + { blk_imp, MAN_BSCOPE }, /* P */ + { blk_imp, MAN_BSCOPE }, /* IP */ + { blk_imp, MAN_BSCOPE }, /* HP */ + { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SM */ + { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* SB */ { in_line_eoln, 0 }, /* BI */ { in_line_eoln, 0 }, /* IB */ { in_line_eoln, 0 }, /* BR */ { in_line_eoln, 0 }, /* RB */ - { in_line_eoln, MAN_SCOPED }, /* R */ - { in_line_eoln, MAN_SCOPED }, /* B */ - { in_line_eoln, MAN_SCOPED }, /* I */ + { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* R */ + { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* B */ + { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */ { in_line_eoln, 0 }, /* IR */ { in_line_eoln, 0 }, /* RI */ - { in_line_eoln, 0 }, /* na */ - { in_line_eoln, 0 }, /* i */ - { in_line_eoln, 0 }, /* sp */ - { in_line_eoln, 0 }, /* nf */ - { in_line_eoln, 0 }, /* fi */ - { in_line_eoln, 0 }, /* r */ - { blk_close, 0 }, /* RE */ - { blk_imp, 0 }, /* RS */ + { in_line_eoln, MAN_NSCOPED }, /* sp */ + { in_line_eoln, MAN_BSCOPE }, /* nf */ + { in_line_eoln, MAN_BSCOPE }, /* fi */ + { blk_close, MAN_BSCOPE }, /* RE */ + { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* RS */ + { in_line_eoln, 0 }, /* DT */ + { in_line_eoln, 0 }, /* UC */ + { in_line_eoln, 0 }, /* PD */ + { in_line_eoln, 0 }, /* AT */ + { in_line_eoln, 0 }, /* in */ + { in_line_eoln, 0 }, /* ft */ + { in_line_eoln, 0 }, /* OP */ + { in_line_eoln, MAN_BSCOPE }, /* EX */ + { in_line_eoln, MAN_BSCOPE }, /* EE */ + { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* UR */ + { blk_close, MAN_BSCOPE }, /* UE */ + { in_line_eoln, 0 }, /* ll */ }; const struct man_macro * const man_macros = __man_macros; -int -man_unscope(struct man *m, const struct man_node *n) +void +man_unscope(struct man *man, const struct man_node *to) { + struct man_node *n; - assert(n); - m->next = MAN_NEXT_SIBLING; + to = to->parent; + n = man->last; + while (n != to) { - /* LINTED */ - while (m->last != n) { - if ( ! man_valid_post(m)) - return(0); - if ( ! man_action_post(m)) - return(0); - m->last = m->last->parent; - assert(m->last); + /* Reached the end of the document? */ + + if (to == NULL && ! (n->flags & MAN_VALID)) { + if (man->flags & (MAN_BLINE | MAN_ELINE) && + man_macros[n->tok].flags & MAN_SCOPED) { + mandoc_vmsg(MANDOCERR_BLK_LINE, + man->parse, n->line, n->pos, + "EOF breaks %s", + man_macronames[n->tok]); + if (man->flags & MAN_ELINE) + man->flags &= ~MAN_ELINE; + else { + assert(n->type == MAN_HEAD); + n = n->parent; + man->flags &= ~MAN_BLINE; + } + man->last = n; + n = n->parent; + man_node_delete(man, man->last); + continue; + } + if (n->type == MAN_BLOCK && + man_macros[n->tok].flags & MAN_EXPLICIT) + mandoc_msg(MANDOCERR_BLK_NOEND, + man->parse, n->line, n->pos, + man_macronames[n->tok]); + } + + /* + * We might delete the man->last node + * in the post-validation phase. + * Save a pointer to the parent such that + * we know where to continue the iteration. + */ + + man->last = n; + n = n->parent; + man_valid_post(man); } - if ( ! man_valid_post(m)) - return(0); - return(man_action_post(m)); + /* + * If we ended up at the parent of the node we were + * supposed to rewind to, that means the target node + * got deleted, so add the next node we parse as a child + * of the parent instead of as a sibling of the target. + */ + + man->next = (man->last == to) ? + MAN_NEXT_CHILD : MAN_NEXT_SIBLING; } - -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 && - MAN_BODY == n->parent->type) + if (type == MAN_BLOCK && ntok == n->parent->tok && + n->parent->type == MAN_BODY) 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) { - 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. */ - if (type == n->type && tok == n->tok) - return(REW_REWIND); + /* First: rewind to ourselves. */ + if (type == n->type && tok == n->tok) { + if (MAN_EXPLICIT & man_macros[n->tok].flags) + return(REW_HALT); + else + return(REW_REWIND); + } + /* + * Next follow the implicit scope-smashings as defined by man.7: + * section, sub-section, etc. + */ + switch (tok) { - case (MAN_SH): + case MAN_SH: break; - case (MAN_SS): + case MAN_SS: /* Rewind to a section, if a block. */ if (REW_NOHALT != (c = rew_block(MAN_SH, type, n))) return(c); break; - case (MAN_RS): + case MAN_RS: + /* Preserve empty paragraphs before RS. */ + if (0 == n->nchild && (MAN_P == n->tok || + MAN_PP == n->tok || MAN_LP == n->tok)) + return(REW_HALT); /* Rewind to a subsection, if a block. */ if (REW_NOHALT != (c = rew_block(MAN_SS, type, n))) return(c); @@ -158,194 +237,281 @@ rew_dohalt(int tok, enum man_type type, const struct m return(REW_NOHALT); } - /* * Rewinding entails ascending the parse tree until a coherent point, * for example, the `SH' macro will close out any intervening `SS' * 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) +static void +rew_scope(enum man_type type, struct man *man, enum mant tok) { struct man_node *n; - int c; + enum rew c; - /* LINTED */ - for (n = m->last; n; n = n->parent) { - /* + for (n = man->last; n; n = n->parent) { + /* * Whether we should stop immediately (REW_HALT), stop * and rewind until this point (REW_REWIND), or keep * rewinding (REW_NOHALT). */ c = rew_dohalt(tok, type, n); if (REW_HALT == c) - return(1); + return; if (REW_REWIND == c) 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)); + man_unscope(man, n); } -/* ARGSUSED */ -int +/* + * Close out a generic explicit macro. + */ +void blk_close(MACRO_PROT_ARGS) { - int ntok; + enum mant ntok; const struct man_node *nn; + char *p; + int nrew, target; + nrew = 1; switch (tok) { - case (MAN_RE): + case MAN_RE: ntok = MAN_RS; + if ( ! man_args(man, line, pos, buf, &p)) + break; + for (nn = man->last->parent; nn; nn = nn->parent) + if (nn->tok == ntok && nn->type == MAN_BLOCK) + nrew++; + target = strtol(p, &p, 10); + if (*p != '\0') + mandoc_vmsg(MANDOCERR_ARG_EXCESS, man->parse, + line, p - buf, "RE ... %s", p); + if (target == 0) + target = 1; + nrew -= target; + if (nrew < 1) { + mandoc_vmsg(MANDOCERR_RE_NOTOPEN, man->parse, + line, ppos, "RE %d", target); + return; + } break; + case MAN_UE: + ntok = MAN_UR; + break; default: abort(); /* NOTREACHED */ } - for (nn = m->last->parent; nn; nn = nn->parent) - if (ntok == nn->tok) + for (nn = man->last->parent; nn; nn = nn->parent) + if (nn->tok == ntok && nn->type == MAN_BLOCK && ! --nrew) break; - if (NULL == nn) - if ( ! man_pwarn(m, line, ppos, WNOSCOPE)) - return(0); + if (nn == NULL) { + mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse, + line, ppos, man_macronames[tok]); + rew_scope(MAN_BLOCK, man, MAN_PP); + } else { + line = man->last->line; + ppos = man->last->pos; + ntok = man->last->tok; + man_unscope(man, nn); - if ( ! rew_scope(MAN_BODY, m, ntok)) - return(0); - if ( ! rew_scope(MAN_BLOCK, m, ntok)) - return(0); - m->next = MAN_NEXT_SIBLING; - return(1); + /* Move a trailing paragraph behind the block. */ + + if (ntok == MAN_LP || ntok == MAN_PP || ntok == MAN_P) { + *pos = strlen(buf); + blk_imp(man, ntok, line, ppos, pos, buf); + } + } } +void +blk_exp(MACRO_PROT_ARGS) +{ + struct man_node *n; + int la; + char *p; + rew_scope(MAN_BLOCK, man, tok); + man_block_alloc(man, line, ppos, tok); + man_head_alloc(man, line, ppos, tok); + + for (;;) { + la = *pos; + if ( ! man_args(man, line, pos, buf, &p)) + break; + man_word_alloc(man, line, la, p); + } + + assert(man); + assert(tok != MAN_MAX); + + for (n = man->last; n; n = n->parent) + if (n->tok == tok) { + assert(n->type == MAN_HEAD); + man_unscope(man, n); + break; + } + + man_body_alloc(man, 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 * scopes, such as `SH' closing out an `SS', are defined in the rew * routines. */ -int +void blk_imp(MACRO_PROT_ARGS) { - int w, la; + int la; char *p; + struct man_node *n; - /* Close out prior scopes. */ + rew_scope(MAN_BODY, man, tok); + rew_scope(MAN_BLOCK, man, tok); + man_block_alloc(man, line, ppos, tok); + man_head_alloc(man, line, ppos, tok); + n = man->last; - if ( ! rew_scope(MAN_BODY, m, tok)) - return(0); - if ( ! rew_scope(MAN_BLOCK, m, tok)) - return(0); - - /* Allocate new block & head scope. */ - - if ( ! man_block_alloc(m, line, ppos, tok)) - return(0); - if ( ! man_head_alloc(m, line, ppos, tok)) - return(0); - /* Add line arguments. */ for (;;) { la = *pos; - w = man_args(m, line, pos, buf, &p); - - if (-1 == w) - return(0); - if (0 == w) + if ( ! man_args(man, line, pos, buf, &p)) break; - - if ( ! man_word_alloc(m, line, la, p)) - return(0); + man_word_alloc(man, line, la, p); } /* 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); - - return(man_body_alloc(m, line, ppos, tok)); + if (man_macros[tok].flags & MAN_SCOPED) { + /* If we're forcing scope (`TP'), keep it open. */ + if (man_macros[tok].flags & MAN_FSCOPED) { + man->flags |= MAN_BLINE; + return; + } else if (n == man->last) { + man->flags |= MAN_BLINE; + return; + } + } + rew_scope(MAN_HEAD, man, tok); + man_body_alloc(man, line, ppos, tok); } - -int +void in_line_eoln(MACRO_PROT_ARGS) { - int w, la; + int la; char *p; struct man_node *n; - if ( ! man_elem_alloc(m, line, ppos, tok)) - return(0); + man_elem_alloc(man, line, ppos, tok); + n = man->last; - n = m->last; - for (;;) { + if (buf[*pos] != '\0' && (tok == MAN_br || + tok == MAN_fi || tok == MAN_nf)) { + mandoc_vmsg(MANDOCERR_ARG_SKIP, + man->parse, line, *pos, "%s %s", + man_macronames[tok], buf + *pos); + break; + } + if (buf[*pos] != '\0' && man->last != n && + (tok == MAN_PD || tok == MAN_ft || tok == MAN_sp)) { + mandoc_vmsg(MANDOCERR_ARG_EXCESS, + man->parse, line, *pos, "%s ... %s", + man_macronames[tok], buf + *pos); + break; + } la = *pos; - w = man_args(m, line, pos, buf, &p); - - if (-1 == w) - return(0); - if (0 == w) + if ( ! man_args(man, line, pos, buf, &p)) break; - - if ( ! man_word_alloc(m, line, la, p)) - return(0); + if (man_macros[tok].flags & MAN_JOIN && + man->last->type == MAN_TEXT) + man_word_append(man, p); + else + man_word_alloc(man, line, la, p); } - if (n == m->last && (MAN_SCOPED & man_macros[tok].flags)) { - m->flags |= MAN_ELINE; - return(1); - } + /* + * Append MAN_EOS in case the last snipped argument + * ends with a dot, e.g. `.IR syslog (3).' + */ + if (n != man->last && + mandoc_eos(man->last->string, strlen(man->last->string))) + man->last->flags |= MAN_EOS; + /* - * Note that when TH is pruned, we'll be back at the root, so - * make sure that we don't clobber as its sibling. + * 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. */ - /* FIXME: clean this to use man_unscope(). */ + if (n == man->last && man_macros[tok].flags & MAN_SCOPED) { + assert( ! (man_macros[tok].flags & MAN_NSCOPED)); + man->flags |= MAN_ELINE; + return; + } - for ( ; m->last; m->last = m->last->parent) { - if (m->last == n) + assert(man->last->type != MAN_ROOT); + man->next = MAN_NEXT_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. + */ + + for ( ; man->last; man->last = man->last->parent) { + if (man->last == n) break; - if (m->last->type == MAN_ROOT) + if (man->last->type == MAN_ROOT) break; - if ( ! man_valid_post(m)) - return(0); - if ( ! man_action_post(m)) - return(0); + man_valid_post(man); } - assert(m->last); + assert(man->last); /* - * Same here regarding whether we're back at the root. + * Same here regarding whether we're back at the root. */ - if (m->last->type != MAN_ROOT && ! man_valid_post(m)) - 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; - - return(1); + if (man->last->type != MAN_ROOT) + man_valid_post(man); } -int -man_macroend(struct man *m) +void +man_macroend(struct man *man) { - return(man_unscope(m, m->first)); + man_unscope(man, man->first); } +static int +man_args(struct man *man, int line, int *pos, char *buf, char **v) +{ + char *start; + + assert(*pos); + *v = start = buf + *pos; + assert(' ' != *start); + + if ('\0' == *start) + return(0); + + *v = mandoc_getarg(man->parse, v, line, pos); + return(1); +}