=================================================================== RCS file: /cvs/mandoc/man_macro.c,v retrieving revision 1.93 retrieving revision 1.105 diff -u -p -r1.93 -r1.105 --- mandoc/man_macro.c 2015/01/24 01:58:33 1.93 +++ mandoc/man_macro.c 2015/04/18 16:06:40 1.105 @@ -1,4 +1,4 @@ -/* $Id: man_macro.c,v 1.93 2015/01/24 01:58:33 schwarze Exp $ */ +/* $Id: man_macro.c,v 1.105 2015/04/18 16:06:40 schwarze Exp $ */ /* * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons * Copyright (c) 2012, 2013, 2014, 2015 Ingo Schwarze @@ -8,9 +8,9 @@ * 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 + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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 @@ -25,37 +25,26 @@ #include #include -#include "man.h" #include "mandoc.h" +#include "roff.h" +#include "man.h" #include "libmandoc.h" #include "libman.h" -enum rew { - REW_REWIND, - REW_NOHALT, - REW_HALT -}; - 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, +static int man_args(struct roff_man *, int, int *, char *, char **); +static void rew_scope(struct roff_man *, int); -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 enum rew rew_block(enum mant, enum man_type, - const struct man_node *); - const struct man_macro __man_macros[MAN_MAX] = { { 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 | MAN_SCOPED }, /* TP */ { blk_imp, MAN_BSCOPE }, /* LP */ { blk_imp, MAN_BSCOPE }, /* PP */ { blk_imp, MAN_BSCOPE }, /* P */ @@ -72,22 +61,21 @@ const struct man_macro __man_macros[MAN_MAX] = { { in_line_eoln, MAN_SCOPED | MAN_JOIN }, /* I */ { in_line_eoln, 0 }, /* IR */ { in_line_eoln, 0 }, /* RI */ - { in_line_eoln, MAN_NSCOPED }, /* na */ { 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 */ + { blk_exp, MAN_BSCOPE }, /* RS */ { in_line_eoln, 0 }, /* DT */ { in_line_eoln, 0 }, /* UC */ - { in_line_eoln, 0 }, /* PD */ + { in_line_eoln, MAN_NSCOPED }, /* 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_exp, MAN_BSCOPE }, /* UR */ { blk_close, MAN_BSCOPE }, /* UE */ { in_line_eoln, 0 }, /* ll */ }; @@ -96,9 +84,9 @@ const struct man_macro * const man_macros = __man_macr void -man_unscope(struct man *man, const struct man_node *to) +man_unscope(struct roff_man *man, const struct roff_node *to) { - struct man_node *n; + struct roff_node *n; to = to->parent; n = man->last; @@ -116,7 +104,7 @@ man_unscope(struct man *man, const struct man_node *to if (man->flags & MAN_ELINE) man->flags &= ~MAN_ELINE; else { - assert(n->type == MAN_HEAD); + assert(n->type == ROFFT_HEAD); n = n->parent; man->flags &= ~MAN_BLINE; } @@ -125,8 +113,8 @@ man_unscope(struct man *man, const struct man_node *to man_node_delete(man, man->last); continue; } - if (n->type == MAN_BLOCK && - man_macros[n->tok].flags & MAN_EXPLICIT) + if (n->type == ROFFT_BLOCK && + man_macros[n->tok].fp == blk_exp) mandoc_msg(MANDOCERR_BLK_NOEND, man->parse, n->line, n->pos, man_macronames[n->tok]); @@ -152,122 +140,49 @@ man_unscope(struct man *man, const struct man_node *to */ man->next = (man->last == to) ? - MAN_NEXT_CHILD : MAN_NEXT_SIBLING; + ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING; } -static enum rew -rew_block(enum mant ntok, enum man_type type, const struct man_node *n) -{ - - 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 enum rew -rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n) -{ - 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); - - /* 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: - break; - 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: - /* 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); - /* Rewind to a section, if a block. */ - if (REW_NOHALT != (c = rew_block(MAN_SH, type, n))) - return(c); - break; - default: - /* 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 (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; - } - - 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 void -rew_scope(enum man_type type, struct man *man, enum mant tok) +rew_scope(struct roff_man *man, int tok) { - struct man_node *n; - enum rew c; + struct roff_node *n; - 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; - if (REW_REWIND == c) - break; - } + /* Preserve empty paragraphs before RS. */ - /* - * Rewind until the current point. Warn if we're a roff - * instruction that's mowing over explicit scopes. - */ + n = man->last; + if (tok == MAN_RS && n->nchild == 0 && + (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP)) + return; - man_unscope(man, n); + for (;;) { + if (n->type == ROFFT_ROOT) + return; + if (n->flags & MAN_VALID) { + n = n->parent; + continue; + } + if (n->type != ROFFT_BLOCK) { + if (n->parent->type == ROFFT_ROOT) { + man_unscope(man, n); + return; + } else { + n = n->parent; + continue; + } + } + if (tok != MAN_SH && (n->tok == MAN_SH || + (tok != MAN_SS && (n->tok == MAN_SS || + man_macros[n->tok].fp == blk_exp)))) + return; + man_unscope(man, n); + n = man->last; + } } @@ -277,8 +192,8 @@ rew_scope(enum man_type type, struct man *man, enum ma void blk_close(MACRO_PROT_ARGS) { - enum mant ntok; - const struct man_node *nn; + int ntok; + const struct roff_node *nn; char *p; int nrew, target; @@ -289,7 +204,7 @@ blk_close(MACRO_PROT_ARGS) 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) + if (nn->tok == ntok && nn->type == ROFFT_BLOCK) nrew++; target = strtol(p, &p, 10); if (*p != '\0') @@ -313,51 +228,56 @@ blk_close(MACRO_PROT_ARGS) } for (nn = man->last->parent; nn; nn = nn->parent) - if (nn->tok == ntok && nn->type == MAN_BLOCK && ! --nrew) + if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew) break; if (nn == NULL) { mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse, line, ppos, man_macronames[tok]); - rew_scope(MAN_BLOCK, man, MAN_PP); - } else + rew_scope(man, MAN_PP); + } else { + line = man->last->line; + ppos = man->last->pos; + ntok = man->last->tok; man_unscope(man, nn); + + /* 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; + struct roff_node *head; char *p; + int la; - rew_scope(MAN_BLOCK, man, tok); + rew_scope(man, tok); man_block_alloc(man, line, ppos, tok); man_head_alloc(man, line, ppos, tok); + head = man->last; - for (;;) { - la = *pos; - if ( ! man_args(man, line, pos, buf, &p)) - break; + la = *pos; + if (man_args(man, line, pos, buf, &p)) man_word_alloc(man, line, la, p); - } - assert(man); - assert(tok != MAN_MAX); + if (buf[*pos] != '\0') + mandoc_vmsg(MANDOCERR_ARG_EXCESS, + man->parse, line, *pos, "%s ... %s", + man_macronames[tok], buf + *pos); - for (n = man->last; n; n = n->parent) - if (n->tok == tok) { - assert(n->type == MAN_HEAD); - man_unscope(man, n); - break; - } - + man_unscope(man, head); 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 + * Parse an implicit-block macro. These contain a ROFFT_HEAD and a + * ROFFT_BODY contained within a ROFFT_BLOCK. Rules for closing out other * scopes, such as `SH' closing out an `SS', are defined in the rew * routines. */ @@ -366,10 +286,9 @@ blk_imp(MACRO_PROT_ARGS) { int la; char *p; - struct man_node *n; + struct roff_node *n; - rew_scope(MAN_BODY, man, tok); - rew_scope(MAN_BLOCK, man, tok); + rew_scope(man, tok); man_block_alloc(man, line, ppos, tok); man_head_alloc(man, line, ppos, tok); n = man->last; @@ -383,19 +302,21 @@ blk_imp(MACRO_PROT_ARGS) man_word_alloc(man, line, la, p); } - /* Close out head and open body (unless MAN_SCOPE). */ + /* + * For macros having optional next-line scope, + * keep the head open if there were no arguments. + * For `TP', always keep the head open. + */ - 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; - } + if (man_macros[tok].flags & MAN_SCOPED && + (tok == MAN_TP || n == man->last)) { + man->flags |= MAN_BLINE; + return; } - rew_scope(MAN_HEAD, man, tok); + + /* Close out the head and open the body. */ + + man_unscope(man, n); man_body_alloc(man, line, ppos, tok); } @@ -404,17 +325,31 @@ in_line_eoln(MACRO_PROT_ARGS) { int la; char *p; - struct man_node *n; + struct roff_node *n; man_elem_alloc(man, line, ppos, tok); n = man->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; if ( ! man_args(man, line, pos, buf, &p)) break; if (man_macros[tok].flags & MAN_JOIN && - man->last->type == MAN_TEXT) + man->last->type == ROFFT_TEXT) man_word_append(man, p); else man_word_alloc(man, line, la, p); @@ -441,8 +376,8 @@ in_line_eoln(MACRO_PROT_ARGS) return; } - assert(man->last->type != MAN_ROOT); - man->next = MAN_NEXT_SIBLING; + assert(man->last->type != ROFFT_ROOT); + man->next = ROFF_NEXT_SIBLING; /* * Rewind our element scope. Note that when TH is pruned, we'll @@ -453,7 +388,7 @@ in_line_eoln(MACRO_PROT_ARGS) for ( ; man->last; man->last = man->last->parent) { if (man->last == n) break; - if (man->last->type == MAN_ROOT) + if (man->last->type == ROFFT_ROOT) break; man_valid_post(man); } @@ -464,20 +399,20 @@ in_line_eoln(MACRO_PROT_ARGS) * Same here regarding whether we're back at the root. */ - if (man->last->type != MAN_ROOT) + if (man->last->type != ROFFT_ROOT) man_valid_post(man); } void -man_macroend(struct man *man) +man_macroend(struct roff_man *man) { man_unscope(man, man->first); } static int -man_args(struct man *man, int line, int *pos, char *buf, char **v) +man_args(struct roff_man *man, int line, int *pos, char *buf, char **v) { char *start;