=================================================================== RCS file: /cvs/mandoc/man_macro.c,v retrieving revision 1.88 retrieving revision 1.101 diff -u -p -r1.88 -r1.101 --- mandoc/man_macro.c 2014/08/10 23:54:41 1.88 +++ mandoc/man_macro.c 2015/04/02 21:36:50 1.101 @@ -1,16 +1,16 @@ -/* $Id: man_macro.c,v 1.88 2014/08/10 23:54:41 schwarze Exp $ */ +/* $Id: man_macro.c,v 1.101 2015/04/02 21:36:50 schwarze Exp $ */ /* * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons - * Copyright (c) 2012, 2013 Ingo Schwarze + * 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 * 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,8 +25,9 @@ #include #include -#include "man.h" #include "mandoc.h" +#include "roff.h" +#include "man.h" #include "libmandoc.h" #include "libman.h" @@ -36,18 +37,18 @@ enum rew { REW_HALT }; -static int blk_close(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 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, +static void rew_scope(enum roff_type, struct man *, enum mant); -static enum rew rew_dohalt(enum mant, enum man_type, +static enum rew rew_dohalt(enum mant, enum roff_type, const struct man_node *); -static enum rew rew_block(enum mant, enum man_type, +static enum rew rew_block(enum mant, enum roff_type, const struct man_node *); const struct man_macro __man_macros[MAN_MAX] = { @@ -55,52 +56,50 @@ const struct man_macro __man_macros[MAN_MAX] = { { 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 */ { blk_imp, MAN_BSCOPE }, /* IP */ { blk_imp, MAN_BSCOPE }, /* HP */ - { in_line_eoln, MAN_SCOPED }, /* SM */ - { in_line_eoln, MAN_SCOPED }, /* SB */ + { 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, MAN_NSCOPED }, /* na */ { in_line_eoln, MAN_NSCOPED }, /* sp */ { in_line_eoln, MAN_BSCOPE }, /* nf */ { in_line_eoln, MAN_BSCOPE }, /* fi */ - { blk_close, 0 }, /* RE */ - { blk_exp, MAN_BSCOPE | MAN_EXPLICIT }, /* RS */ + { blk_close, MAN_BSCOPE }, /* RE */ + { 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_close, 0 }, /* UE */ + { blk_exp, MAN_BSCOPE }, /* UR */ + { blk_close, MAN_BSCOPE }, /* UE */ { in_line_eoln, 0 }, /* ll */ }; const struct man_macro * const man_macros = __man_macros; -int +void man_unscope(struct man *man, const struct man_node *to) { struct man_node *n; - man->next = MAN_NEXT_SIBLING; to = to->parent; n = man->last; while (n != to) { @@ -117,7 +116,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; } @@ -126,8 +125,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]); @@ -139,20 +138,29 @@ man_unscope(struct man *man, const struct man_node *to * Save a pointer to the parent such that * we know where to continue the iteration. */ + man->last = n; n = n->parent; - if ( ! man_valid_post(man)) - return(0); + man_valid_post(man); } - return(1); + + /* + * 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 enum rew -rew_block(enum mant ntok, enum man_type type, const struct man_node *n) +rew_block(enum mant ntok, enum roff_type type, const struct man_node *n) { - if (MAN_BLOCK == type && ntok == n->parent->tok && - MAN_BODY == n->parent->type) + if (type == ROFFT_BLOCK && n->parent->tok == ntok && + n->parent->type == ROFFT_BODY) return(REW_REWIND); return(ntok == n->tok ? REW_HALT : REW_NOHALT); } @@ -163,18 +171,18 @@ rew_block(enum mant ntok, enum man_type type, const st * sections and subsections). */ static enum rew -rew_dohalt(enum mant tok, enum man_type type, const struct man_node *n) +rew_dohalt(enum mant tok, enum roff_type type, const struct man_node *n) { enum rew c; /* We cannot progress beyond the root ever. */ - if (MAN_ROOT == n->type) + if (n->type == ROFFT_ROOT) return(REW_HALT); assert(n->parent); /* Normal nodes shouldn't go to the level of the root. */ - if (MAN_ROOT == n->parent->type) + if (n->parent->type == ROFFT_ROOT) return(REW_REWIND); /* Already-validated nodes should be closed out. */ @@ -183,7 +191,7 @@ rew_dohalt(enum mant tok, enum man_type type, const st /* First: rewind to ourselves. */ if (type == n->type && tok == n->tok) { - if (MAN_EXPLICIT & man_macros[n->tok].flags) + if (man_macros[n->tok].fp == blk_exp) return(REW_HALT); else return(REW_REWIND); @@ -235,8 +243,8 @@ rew_dohalt(enum mant tok, enum man_type type, const st * 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 *man, enum mant tok) +static void +rew_scope(enum roff_type type, struct man *man, enum mant tok) { struct man_node *n; enum rew c; @@ -249,7 +257,7 @@ rew_scope(enum man_type type, struct man *man, enum ma */ c = rew_dohalt(tok, type, n); if (REW_HALT == c) - return(1); + return; if (REW_REWIND == c) break; } @@ -258,24 +266,43 @@ rew_scope(enum man_type type, struct man *man, enum ma * Rewind until the current point. Warn if we're a roff * instruction that's mowing over explicit scopes. */ - assert(n); - return(man_unscope(man, n)); + man_unscope(man, n); } /* * Close out a generic explicit macro. */ -int +void blk_close(MACRO_PROT_ARGS) { enum mant ntok; const struct man_node *nn; + char *p; + int nrew, target; + nrew = 1; switch (tok) { 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 == ROFFT_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; @@ -286,86 +313,70 @@ blk_close(MACRO_PROT_ARGS) } for (nn = man->last->parent; nn; nn = nn->parent) - if (ntok == nn->tok && MAN_BLOCK == nn->type) + if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew) break; - if (NULL == nn) { + if (nn == NULL) { mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse, line, ppos, man_macronames[tok]); - if ( ! rew_scope(MAN_BLOCK, man, MAN_PP)) - return(0); - } else + rew_scope(ROFFT_BLOCK, man, MAN_PP); + } else { + line = man->last->line; + ppos = man->last->pos; + ntok = man->last->tok; man_unscope(man, nn); - 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); + } + } } -int +void blk_exp(MACRO_PROT_ARGS) { - struct man_node *n; - int la; + struct man_node *head; char *p; + int la; - /* Close out prior implicit scopes. */ + rew_scope(ROFFT_BLOCK, man, tok); + man_block_alloc(man, line, ppos, tok); + man_head_alloc(man, line, ppos, tok); + head = man->last; - if ( ! rew_scope(MAN_BLOCK, man, tok)) - return(0); + la = *pos; + if (man_args(man, line, pos, buf, &p)) + man_word_alloc(man, line, la, p); - if ( ! man_block_alloc(man, line, ppos, tok)) - return(0); - if ( ! man_head_alloc(man, line, ppos, tok)) - return(0); + if (buf[*pos] != '\0') + mandoc_vmsg(MANDOCERR_ARG_EXCESS, + man->parse, line, *pos, "%s ... %s", + man_macronames[tok], buf + *pos); - for (;;) { - la = *pos; - if ( ! man_args(man, line, pos, buf, &p)) - break; - if ( ! man_word_alloc(man, line, la, p)) - return(0); - } - - assert(man); - assert(tok != MAN_MAX); - - for (n = man->last; n; n = n->parent) { - if (n->tok != tok) - continue; - assert(MAN_HEAD == n->type); - man_unscope(man, n); - break; - } - - return(man_body_alloc(man, line, ppos, tok)); + 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. */ -int +void blk_imp(MACRO_PROT_ARGS) { int la; char *p; struct man_node *n; - /* Close out prior scopes. */ - - if ( ! rew_scope(MAN_BODY, man, tok)) - return(0); - if ( ! rew_scope(MAN_BLOCK, man, tok)) - return(0); - - /* Allocate new block & head scope. */ - - if ( ! man_block_alloc(man, line, ppos, tok)) - return(0); - if ( ! man_head_alloc(man, line, ppos, tok)) - return(0); - + rew_scope(ROFFT_BODY, man, tok); + rew_scope(ROFFT_BLOCK, man, tok); + man_block_alloc(man, line, ppos, tok); + man_head_alloc(man, line, ppos, tok); n = man->last; /* Add line arguments. */ @@ -374,46 +385,60 @@ blk_imp(MACRO_PROT_ARGS) la = *pos; if ( ! man_args(man, line, pos, buf, &p)) break; - if ( ! man_word_alloc(man, line, la, p)) - return(0); + 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_SCOPED & man_macros[tok].flags) { - /* If we're forcing scope (`TP'), keep it open. */ - if (MAN_FSCOPED & man_macros[tok].flags) { - man->flags |= MAN_BLINE; - return(1); - } else if (n == man->last) { - man->flags |= MAN_BLINE; - return(1); - } + if (man_macros[tok].flags & MAN_SCOPED && + (tok == MAN_TP || n == man->last)) { + man->flags |= MAN_BLINE; + return; } - if ( ! rew_scope(MAN_HEAD, man, tok)) - return(0); - return(man_body_alloc(man, line, ppos, tok)); + /* Close out the head and open the body. */ + + rew_scope(ROFFT_HEAD, man, tok); + man_body_alloc(man, line, ppos, tok); } -int +void in_line_eoln(MACRO_PROT_ARGS) { int la; char *p; struct man_node *n; - if ( ! man_elem_alloc(man, line, ppos, tok)) - return(0); - + 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_word_alloc(man, line, la, p)) - return(0); + if (man_macros[tok].flags & MAN_JOIN && + man->last->type == ROFFT_TEXT) + man_word_append(man, p); + else + man_word_alloc(man, line, la, p); } /* @@ -431,13 +456,13 @@ in_line_eoln(MACRO_PROT_ARGS) * waiting for terms to load into our context. */ - if (n == man->last && MAN_SCOPED & man_macros[tok].flags) { - assert( ! (MAN_NSCOPED & man_macros[tok].flags)); + if (n == man->last && man_macros[tok].flags & MAN_SCOPED) { + assert( ! (man_macros[tok].flags & MAN_NSCOPED)); man->flags |= MAN_ELINE; - return(1); + return; } - assert(MAN_ROOT != man->last->type); + assert(man->last->type != ROFFT_ROOT); man->next = MAN_NEXT_SIBLING; /* @@ -449,10 +474,9 @@ 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; - if ( ! man_valid_post(man)) - return(0); + man_valid_post(man); } assert(man->last); @@ -461,18 +485,16 @@ in_line_eoln(MACRO_PROT_ARGS) * Same here regarding whether we're back at the root. */ - if (man->last->type != MAN_ROOT && ! man_valid_post(man)) - return(0); - - return(1); + if (man->last->type != ROFFT_ROOT) + man_valid_post(man); } -int +void man_macroend(struct man *man) { - return(man_unscope(man, man->first)); + man_unscope(man, man->first); } static int