-/* $Id: man_macro.c,v 1.11 2009/03/31 13:50:19 kristaps Exp $ */
+/* $Id: man_macro.c,v 1.102 2015/04/02 22:48:17 schwarze Exp $ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2012, 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
*
* 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.
+ * 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 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR 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.
+ * 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 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 <sys/types.h>
+
#include <assert.h>
#include <ctype.h>
#include <stdlib.h>
#include <string.h>
+#include "mandoc.h"
+#include "roff.h"
+#include "man.h"
+#include "libmandoc.h"
#include "libman.h"
-#define FL_NLINE (1 << 0)
-#define FL_TLINE (1 << 1)
+enum rew {
+ REW_REWIND,
+ REW_NOHALT,
+ REW_HALT
+};
-static int man_args(struct man *, int,
+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 man_flags[MAN_MAX] = {
- 0, /* __ */
- 0, /* TH */
- 0, /* SH */
- 0, /* SS */
- FL_TLINE, /* TP */
- 0, /* LP */
- 0, /* PP */
- 0, /* P */
- 0, /* IP */
- 0, /* HP */
- FL_NLINE, /* SM */
- FL_NLINE, /* SB */
- FL_NLINE, /* BI */
- FL_NLINE, /* IB */
- FL_NLINE, /* BR */
- FL_NLINE, /* RB */
- FL_NLINE, /* R */
- FL_NLINE, /* B */
- FL_NLINE, /* I */
- FL_NLINE, /* IR */
- FL_NLINE, /* RI */
- 0, /* br */
+static void rew_scope(enum roff_type, struct man *, int);
+static enum rew rew_dohalt(int, enum roff_type,
+ const struct roff_node *);
+static enum rew rew_block(int, enum roff_type,
+ const struct roff_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 }, /* 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 | 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 }, /* sp */
+ { in_line_eoln, MAN_BSCOPE }, /* nf */
+ { in_line_eoln, MAN_BSCOPE }, /* fi */
+ { blk_close, MAN_BSCOPE }, /* RE */
+ { blk_exp, MAN_BSCOPE }, /* 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, 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 }, /* UR */
+ { blk_close, MAN_BSCOPE }, /* UE */
+ { in_line_eoln, 0 }, /* ll */
};
-int
-man_macro(struct man *man, int tok, int line,
- int ppos, int *pos, char *buf)
+const struct man_macro * const man_macros = __man_macros;
+
+
+void
+man_unscope(struct man *man, const struct roff_node *to)
{
- int w, la;
- char *p;
- struct man_node *n;
+ struct roff_node *n;
- if ( ! man_elem_alloc(man, line, ppos, tok))
- return(0);
+ to = to->parent;
n = man->last;
- man->next = MAN_NEXT_CHILD;
-
- for (;;) {
- la = *pos;
- w = man_args(man, line, pos, buf, &p);
+ while (n != to) {
+
+ /* 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 == ROFFT_HEAD);
+ n = n->parent;
+ man->flags &= ~MAN_BLINE;
+ }
+ man->last = n;
+ n = n->parent;
+ man_node_delete(man, man->last);
+ continue;
+ }
+ 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]);
+ }
- if (-1 == w)
- return(0);
- if (0 == w)
- break;
+ /*
+ * 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.
+ */
- if ( ! man_word_alloc(man, line, la, p))
- return(0);
- man->next = MAN_NEXT_SIBLING;
+ man->last = n;
+ n = n->parent;
+ man_valid_post(man);
}
- if (n == man->last && (FL_NLINE & man_flags[tok])) {
- if (MAN_NLINE & man->flags)
- return(man_verr(man, line, ppos,
- "next-line scope already open"));
- man->flags |= MAN_NLINE;
- 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(int ntok, enum roff_type type, const struct roff_node *n)
+{
+
+ if (type == ROFFT_BLOCK && n->parent->tok == ntok &&
+ n->parent->type == ROFFT_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(int tok, enum roff_type type, const struct roff_node *n)
+{
+ enum rew c;
+
+ /* We cannot progress beyond the root ever. */
+ if (n->type == ROFFT_ROOT)
+ return(REW_HALT);
+
+ assert(n->parent);
+
+ /* Normal nodes shouldn't go to the level of the root. */
+ if (n->parent->type == ROFFT_ROOT)
+ return(REW_REWIND);
+
+ /* Already-validated nodes should be closed out. */
+ if (MAN_VALID & n->flags)
+ return(REW_NOHALT);
- if (FL_TLINE & man_flags[tok]) {
- if (MAN_NLINE & man->flags)
- return(man_verr(man, line, ppos,
- "next-line scope already open"));
- man->flags |= MAN_NLINE;
- return(1);
+ /* First: rewind to ourselves. */
+ if (type == n->type && tok == n->tok) {
+ if (man_macros[n->tok].fp == blk_exp)
+ return(REW_HALT);
+ else
+ return(REW_REWIND);
}
/*
- * Note that when TH is pruned, we'll be back at the root, so
- * make sure that we don't clobber as its sibling.
+ * Next follow the implicit scope-smashings as defined by man.7:
+ * section, sub-section, etc.
*/
- for ( ; man->last; man->last = man->last->parent) {
- if (man->last == n)
- break;
- if (man->last->type == MAN_ROOT)
- break;
- if ( ! man_valid_post(man))
- return(0);
- if ( ! man_action_post(man))
- return(0);
+ 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;
}
- assert(man->last);
+ 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 roff_type type, struct man *man, int tok)
+{
+ struct roff_node *n;
+ enum rew c;
+
+ 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;
+ }
/*
- * Same here regarding whether we're back at the root.
+ * Rewind until the current point. Warn if we're a roff
+ * instruction that's mowing over explicit scopes.
*/
- if (man->last->type != MAN_ROOT && ! man_valid_post(man))
- return(0);
- if (man->last->type != MAN_ROOT && ! man_action_post(man))
- return(0);
- if (man->last->type != MAN_ROOT)
- man->next = MAN_NEXT_SIBLING;
-
- return(1);
+ man_unscope(man, n);
}
-int
-man_macroend(struct man *m)
+/*
+ * Close out a generic explicit macro.
+ */
+void
+blk_close(MACRO_PROT_ARGS)
{
-
- for ( ; m->last && m->last != m->first;
- m->last = m->last->parent) {
- if ( ! man_valid_post(m))
- return(0);
- if ( ! man_action_post(m))
- return(0);
+ int ntok;
+ const struct roff_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;
+ break;
+ default:
+ abort();
+ /* NOTREACHED */
}
- assert(m->last == m->first);
- if ( ! man_valid_post(m))
- return(0);
- if ( ! man_action_post(m))
- return(0);
+ for (nn = man->last->parent; nn; nn = nn->parent)
+ if (nn->tok == ntok && nn->type == ROFFT_BLOCK && ! --nrew)
+ break;
- return(1);
+ if (nn == NULL) {
+ mandoc_msg(MANDOCERR_BLK_NOTOPEN, man->parse,
+ line, ppos, man_macronames[tok]);
+ rew_scope(ROFFT_BLOCK, 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 roff_node *head;
+ char *p;
+ int la;
+
+ rew_scope(ROFFT_BLOCK, man, tok);
+ man_block_alloc(man, line, ppos, tok);
+ man_head_alloc(man, line, ppos, tok);
+ head = man->last;
-/* ARGSUSED */
-static int
-man_args(struct man *m, int line,
- int *pos, char *buf, char **v)
+ la = *pos;
+ if (man_args(man, line, pos, buf, &p))
+ man_word_alloc(man, line, la, p);
+
+ if (buf[*pos] != '\0')
+ mandoc_vmsg(MANDOCERR_ARG_EXCESS,
+ man->parse, line, *pos, "%s ... %s",
+ man_macronames[tok], buf + *pos);
+
+ man_unscope(man, head);
+ man_body_alloc(man, line, ppos, tok);
+}
+
+/*
+ * 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.
+ */
+void
+blk_imp(MACRO_PROT_ARGS)
{
+ int la;
+ char *p;
+ struct roff_node *n;
- if (0 == buf[*pos])
- 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;
- /* First parse non-quoted strings. */
+ /* Add line arguments. */
- if ('\"' != buf[*pos]) {
- *v = &buf[*pos];
+ for (;;) {
+ la = *pos;
+ if ( ! man_args(man, line, pos, buf, &p))
+ break;
+ man_word_alloc(man, line, la, p);
+ }
+
+ /*
+ * 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 &&
+ (tok == MAN_TP || n == man->last)) {
+ man->flags |= MAN_BLINE;
+ return;
+ }
+
+ /* Close out the head and open the body. */
+
+ rew_scope(ROFFT_HEAD, man, tok);
+ man_body_alloc(man, line, ppos, tok);
+}
+
+void
+in_line_eoln(MACRO_PROT_ARGS)
+{
+ int la;
+ char *p;
+ struct roff_node *n;
+
+ man_elem_alloc(man, line, ppos, tok);
+ n = man->last;
- while (buf[*pos]) {
- if (' ' == buf[*pos])
- if ('\\' != buf[*pos - 1])
- break;
- (*pos)++;
+ 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 == ROFFT_TEXT)
+ man_word_append(man, p);
+ else
+ man_word_alloc(man, line, la, p);
+ }
- if (0 == buf[*pos])
- return(1);
+ /*
+ * Append MAN_EOS in case the last snipped argument
+ * ends with a dot, e.g. `.IR syslog (3).'
+ */
- buf[(*pos)++] = 0;
+ if (n != man->last &&
+ mandoc_eos(man->last->string, strlen(man->last->string)))
+ man->last->flags |= MAN_EOS;
- if (0 == buf[*pos])
- return(1);
+ /*
+ * 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.
+ */
- while (buf[*pos] && ' ' == buf[*pos])
- (*pos)++;
+ if (n == man->last && man_macros[tok].flags & MAN_SCOPED) {
+ assert( ! (man_macros[tok].flags & MAN_NSCOPED));
+ man->flags |= MAN_ELINE;
+ return;
+ }
- if (buf[*pos])
- return(1);
+ assert(man->last->type != ROFFT_ROOT);
+ man->next = MAN_NEXT_SIBLING;
- if ( ! man_vwarn(m, line, *pos, "trailing spaces"))
- return(-1);
+ /*
+ * 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.
+ */
- return(1);
+ for ( ; man->last; man->last = man->last->parent) {
+ if (man->last == n)
+ break;
+ if (man->last->type == ROFFT_ROOT)
+ break;
+ man_valid_post(man);
}
+ assert(man->last);
+
/*
- * If we're a quoted string (and quoted strings are allowed),
- * then parse ahead to the next quote. If none's found, it's an
- * error. After, parse to the next word.
+ * Same here regarding whether we're back at the root.
*/
- *v = &buf[++(*pos)];
+ if (man->last->type != ROFFT_ROOT)
+ man_valid_post(man);
+}
+
- while (buf[*pos] && '\"' != buf[*pos])
- (*pos)++;
+void
+man_macroend(struct man *man)
+{
- if (0 == buf[*pos]) {
- if ( ! man_vwarn(m, line, *pos, "unterminated quote"))
- return(-1);
- return(1);
- }
+ man_unscope(man, man->first);
+}
- buf[(*pos)++] = 0;
- if (0 == buf[*pos])
- return(1);
+static int
+man_args(struct man *man, int line, int *pos, char *buf, char **v)
+{
+ char *start;
- while (buf[*pos] && ' ' == buf[*pos])
- (*pos)++;
+ assert(*pos);
+ *v = start = buf + *pos;
+ assert(' ' != *start);
- if (buf[*pos])
- return(1);
+ if ('\0' == *start)
+ return(0);
- if ( ! man_vwarn(m, line, *pos, "trailing spaces"))
- return(-1);
+ *v = mandoc_getarg(man->parse, v, line, pos);
return(1);
}
git.ckatri.com / mandoc.git / blobdiff