=================================================================== RCS file: /cvs/mandoc/man_macro.c,v retrieving revision 1.25 retrieving revision 1.135 diff -u -p -r1.25 -r1.135 --- mandoc/man_macro.c 2009/08/20 13:55:19 1.25 +++ mandoc/man_macro.c 2018/12/14 05:18:02 1.135 @@ -1,365 +1,461 @@ -/* $Id: man_macro.c,v 1.25 2009/08/20 13:55:19 kristaps Exp $ */ +/* $Id: man_macro.c,v 1.135 2018/12/14 05:18:02 schwarze Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2012-2015, 2017, 2018 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 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +#include "config.h" + +#include + #include #include +#include #include #include +#include "mandoc.h" +#include "roff.h" +#include "man.h" +#include "libmandoc.h" +#include "roff_int.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(). */ +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 roff_man *, int, + int *, char *, char **); +static void rew_scope(struct roff_man *, enum roff_tok); -static int in_line_eoln(MACRO_PROT_ARGS); -static int blk_imp(MACRO_PROT_ARGS); -static int blk_close(MACRO_PROT_ARGS); - -static int rew_scope(enum man_type, struct man *, int); -static int rew_dohalt(int, enum man_type, - const struct man_node *); -static int rew_block(int, 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, MAN_SCOPED }, /* SH */ - { blk_imp, MAN_SCOPED }, /* 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 */ +static const struct man_macro man_macros[MAN_MAX - MAN_TH] = { + { in_line_eoln, MAN_XSCOPE }, /* TH */ + { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SH */ + { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* SS */ + { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TP */ + { blk_imp, MAN_XSCOPE | MAN_BSCOPED }, /* TQ */ + { blk_imp, MAN_XSCOPE }, /* LP */ + { blk_imp, MAN_XSCOPE }, /* PP */ + { blk_imp, MAN_XSCOPE }, /* P */ + { blk_imp, MAN_XSCOPE }, /* IP */ + { blk_imp, MAN_XSCOPE }, /* HP */ + { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* SM */ + { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | 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_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* R */ + { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | MAN_JOIN }, /* B */ + { in_line_eoln, MAN_NSCOPED | MAN_ESCOPED | 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, MAN_EXPLICIT }, /* RS */ + { in_line_eoln, MAN_NSCOPED }, /* nf */ + { in_line_eoln, MAN_NSCOPED }, /* fi */ + { blk_close, MAN_XSCOPE }, /* RE */ + { blk_exp, MAN_XSCOPE }, /* RS */ { in_line_eoln, 0 }, /* DT */ + { in_line_eoln, 0 }, /* UC */ + { in_line_eoln, MAN_NSCOPED }, /* PD */ + { in_line_eoln, 0 }, /* AT */ + { in_line_eoln, MAN_NSCOPED }, /* in */ + { blk_imp, MAN_XSCOPE }, /* SY */ + { blk_close, MAN_XSCOPE }, /* YS */ + { in_line_eoln, 0 }, /* OP */ + { in_line_eoln, MAN_XSCOPE }, /* EX */ + { in_line_eoln, MAN_XSCOPE }, /* EE */ + { blk_exp, MAN_XSCOPE }, /* UR */ + { blk_close, MAN_XSCOPE }, /* UE */ + { blk_exp, MAN_XSCOPE }, /* MT */ + { blk_close, MAN_XSCOPE }, /* ME */ }; -const struct man_macro * const man_macros = __man_macros; - -int -man_unscope(struct man *m, const struct man_node *n) +const struct man_macro * +man_macro(enum roff_tok tok) { - - assert(n); - m->next = MAN_NEXT_SIBLING; - - /* 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); - } - - if ( ! man_valid_post(m)) - return(0); - return(man_action_post(m)); + assert(tok >= MAN_TH && tok <= MAN_MAX); + return man_macros + (tok - MAN_TH); } - -static int -rew_block(int ntok, enum man_type type, const struct man_node *n) +void +man_unscope(struct roff_man *man, const struct roff_node *to) { + struct roff_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); -} + to = to->parent; + n = man->last; + while (n != to) { + /* Reached the end of the document? */ -/* - * 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) -{ - int c; + if (to == NULL && ! (n->flags & NODE_VALID)) { + if (man->flags & (MAN_BLINE | MAN_ELINE) && + man_macro(n->tok)->flags & + (MAN_BSCOPED | MAN_NSCOPED)) { + mandoc_msg(MANDOCERR_BLK_LINE, + n->line, n->pos, + "EOF breaks %s", roff_name[n->tok]); + if (man->flags & MAN_ELINE) + man->flags &= ~MAN_ELINE; + else { + assert(n->type == ROFFT_HEAD); + n = n->parent; + man->flags &= ~MAN_BLINE; + } + man->last = n; + n = n->parent; + roff_node_delete(man, man->last); + continue; + } + if (n->type == ROFFT_BLOCK && + man_macro(n->tok)->fp == blk_exp) + mandoc_msg(MANDOCERR_BLK_NOEND, + n->line, n->pos, "%s", + roff_name[n->tok]); + } - if (MAN_ROOT == n->type) - return(REW_HALT); - assert(n->parent); - if (MAN_ROOT == n->parent->type) - return(REW_REWIND); - if (MAN_VALID & n->flags) - return(REW_NOHALT); + /* + * 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. + */ - /* Rewind to ourselves, first. */ - if (type == n->type && tok == n->tok) - return(REW_REWIND); - - 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): - /* 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; + man->last = n; + n = n->parent; + man->last->flags |= NODE_VALID; } - return(REW_NOHALT); + /* + * 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) ? + ROFF_NEXT_CHILD : ROFF_NEXT_SIBLING; } - /* * 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(struct roff_man *man, enum roff_tok tok) { - struct man_node *n; - int c; + struct roff_node *n; - /* LINTED */ - for (n = m->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); - if (REW_REWIND == c) - break; - } + /* Preserve empty paragraphs before RS. */ - /* Rewind until the current point. */ + n = man->last; + if (tok == MAN_RS && n->child == NULL && + (n->tok == MAN_P || n->tok == MAN_PP || n->tok == MAN_LP)) + return; - assert(n); - return(man_unscope(m, n)); + for (;;) { + if (n->type == ROFFT_ROOT) + return; + if (n->flags & NODE_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_macro(n->tok)->fp == blk_exp)))) + return; + man_unscope(man, n); + n = man->last; + } } -/* ARGSUSED */ -int +/* + * Close out a generic explicit macro. + */ +void blk_close(MACRO_PROT_ARGS) { - int ntok; - const struct man_node *nn; + enum roff_tok ctok, ntok; + const struct roff_node *nn; + char *p; + int cline, cpos, 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 == ROFFT_BLOCK) + nrew++; + target = strtol(p, &p, 10); + if (*p != '\0') + mandoc_msg(MANDOCERR_ARG_EXCESS, line, + (int)(p - buf), "RE ... %s", p); + if (target == 0) + target = 1; + nrew -= target; + if (nrew < 1) { + mandoc_msg(MANDOCERR_RE_NOTOPEN, + line, ppos, "RE %d", target); + return; + } break; + case MAN_YS: + ntok = MAN_SY; + break; + case MAN_UE: + ntok = MAN_UR; + break; + case MAN_ME: + ntok = MAN_MT; + 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 == ROFFT_BLOCK && ! --nrew) break; - if (NULL == nn) - if ( ! man_pwarn(m, line, ppos, WNOSCOPE)) - return(0); + if (nn == NULL) { + mandoc_msg(MANDOCERR_BLK_NOTOPEN, + line, ppos, "%s", roff_name[tok]); + rew_scope(man, MAN_PP); + if (tok == MAN_RE) { + roff_elem_alloc(man, line, ppos, ROFF_br); + man->last->flags |= NODE_LINE | + NODE_VALID | NODE_ENDED; + man->next = ROFF_NEXT_SIBLING; + } + return; + } - 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); + cline = man->last->line; + cpos = man->last->pos; + ctok = man->last->tok; + man_unscope(man, nn); + + if (tok == MAN_RE && nn->head->aux > 0) + roff_setreg(man->roff, "an-margin", nn->head->aux, '-'); + + /* Trailing text. */ + + if (buf[*pos] != '\0') { + roff_word_alloc(man, line, ppos, buf + *pos); + man->last->flags |= NODE_DELIMC; + if (mandoc_eos(man->last->string, strlen(man->last->string))) + man->last->flags |= NODE_EOS; + } + + /* Move a trailing paragraph behind the block. */ + + if (ctok == MAN_LP || ctok == MAN_PP || ctok == MAN_P) { + *pos = strlen(buf); + blk_imp(man, ctok, cline, cpos, pos, buf); + } + + /* Synopsis blocks need an explicit end marker for spacing. */ + + if (tok == MAN_YS && man->last == nn) { + roff_elem_alloc(man, line, ppos, tok); + man_unscope(man, man->last); + } } +void +blk_exp(MACRO_PROT_ARGS) +{ + struct roff_node *head; + char *p; + int la; + if (tok == MAN_RS) + rew_scope(man, tok); + roff_block_alloc(man, line, ppos, tok); + head = roff_head_alloc(man, line, ppos, tok); + + la = *pos; + if (man_args(man, line, pos, buf, &p)) { + roff_word_alloc(man, line, la, p); + if (tok == MAN_RS) { + if (roff_getreg(man->roff, "an-margin") == 0) + roff_setreg(man->roff, "an-margin", + 7 * 24, '='); + if ((head->aux = strtod(p, NULL) * 24.0) > 0) + roff_setreg(man->roff, "an-margin", + head->aux, '+'); + } + } + + if (buf[*pos] != '\0') + mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos, + "%s ... %s", roff_name[tok], buf + *pos); + + man_unscope(man, head); + roff_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 w, la; + int la; char *p; - struct man_node *n; + struct roff_node *n; - /* Close out prior scopes. */ + rew_scope(man, tok); + n = roff_block_alloc(man, line, ppos, tok); + if (n->tok == MAN_SH || n->tok == MAN_SS) + man->flags &= ~MAN_LITERAL; + n = roff_head_alloc(man, line, ppos, tok); - 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); - - n = m->last; - /* 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); + roff_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' and `TQ', always keep the head open. + */ - if (n == m->last && MAN_SCOPED & man_macros[tok].flags) { - m->flags |= MAN_BLINE; - return(1); - } else if ( ! rew_scope(MAN_HEAD, m, tok)) - return(0); + if (man_macro(tok)->flags & MAN_BSCOPED && + (tok == MAN_TP || tok == MAN_TQ || n == man->last)) { + man->flags |= MAN_BLINE; + return; + } - return(man_body_alloc(m, line, ppos, tok)); + /* Close out the head and open the body. */ + + man_unscope(man, n); + roff_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; + struct roff_node *n; - if ( ! man_elem_alloc(m, line, ppos, tok)) - return(0); + roff_elem_alloc(man, line, ppos, tok); + n = man->last; - n = m->last; - for (;;) { + if (buf[*pos] != '\0' && (tok == MAN_fi || tok == MAN_nf)) { + mandoc_msg(MANDOCERR_ARG_SKIP, line, *pos, + "%s %s", roff_name[tok], buf + *pos); + break; + } + if (buf[*pos] != '\0' && man->last != n && tok == MAN_PD) { + mandoc_msg(MANDOCERR_ARG_EXCESS, line, *pos, + "%s ... %s", roff_name[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_macro(tok)->flags & MAN_JOIN && + man->last->type == ROFFT_TEXT) + roff_word_append(man, p); + else + roff_word_alloc(man, line, la, p); } - if (n == m->last && MAN_SCOPED & man_macros[tok].flags) { - m->flags |= MAN_ELINE; - return(1); - } + /* + * Append NODE_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 |= NODE_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_ESCOPED (i.e., + * next-line scoped), then set our mode to indicate that we're + * waiting for terms to load into our context. */ - for ( ; m->last; m->last = m->last->parent) { - if (m->last == n) - break; - if (m->last->type == MAN_ROOT) - break; - if ( ! man_valid_post(m)) - return(0); - if ( ! man_action_post(m)) - return(0); + if (n == man->last && man_macro(tok)->flags & MAN_ESCOPED) { + man->flags |= MAN_ELINE; + return; } - assert(m->last); + assert(man->last->type != ROFFT_ROOT); + man->next = ROFF_NEXT_SIBLING; - /* - * Same here regarding whether we're back at the root. - */ + /* Rewind our element scope. */ - 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; + for ( ; man->last; man->last = man->last->parent) { + man_state(man, man->last); + if (man->last == n) + break; + } - return(1); + /* Rewind next-line scoped ancestors, if any. */ + + if (man_macro(tok)->flags & MAN_ESCOPED) + man_descope(man, line, ppos, NULL); } +void +man_endparse(struct roff_man *man) +{ -int -man_macroend(struct man *m) + man_unscope(man, man->first); + man->flags &= ~MAN_LITERAL; +} + +static int +man_args(struct roff_man *man, int line, int *pos, char *buf, char **v) { - struct man_node *n; + char *start; - n = MAN_VALID & m->last->flags ? - m->last->parent : m->last; + assert(*pos); + *v = start = buf + *pos; + assert(' ' != *start); - for ( ; n; n = n->parent) { - if (MAN_BLOCK != n->type) - continue; - if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags)) - continue; - return(man_nerr(m, n, WEXITSCOPE)); - } + if ('\0' == *start) + return 0; - return(man_unscope(m, m->first)); + *v = mandoc_getarg(man->parse, v, line, pos); + return 1; } -