-/* $Id: man_macro.c,v 1.37 2010/03/25 07:39:25 kristaps Exp $ */
+/* $Id: man_macro.c,v 1.64 2011/07/07 05:42:32 kristaps Exp $ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
#include <stdlib.h>
#include <string.h>
+#include "man.h"
+#include "mandoc.h"
+#include "libmandoc.h"
#include "libman.h"
enum rew {
REW_REWIND,
REW_NOHALT,
- REW_HALT,
+ REW_HALT
};
static int blk_close(MACRO_PROT_ARGS);
-static int blk_dotted(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 int man_args(struct man *, int,
+ int *, char *, char **);
static int rew_scope(enum man_type,
struct man *, enum mant);
const struct man_node *);
static enum rew rew_block(enum mant, enum man_type,
const struct man_node *);
+static void rew_warn(struct man *,
+ struct man_node *, enum mandocerr);
const struct man_macro __man_macros[MAN_MAX] = {
{ in_line_eoln, MAN_NSCOPED }, /* br */
{ in_line_eoln, 0 }, /* IR */
{ in_line_eoln, 0 }, /* RI */
{ in_line_eoln, MAN_NSCOPED }, /* na */
- { in_line_eoln, 0 }, /* i */
{ in_line_eoln, MAN_NSCOPED }, /* sp */
{ in_line_eoln, 0 }, /* nf */
{ in_line_eoln, 0 }, /* fi */
- { in_line_eoln, 0 }, /* r */
{ blk_close, 0 }, /* RE */
{ blk_exp, MAN_EXPLICIT }, /* RS */
{ in_line_eoln, 0 }, /* DT */
{ in_line_eoln, 0 }, /* UC */
{ in_line_eoln, 0 }, /* PD */
- { in_line_eoln, MAN_NSCOPED }, /* Sp */
- { in_line_eoln, 0 }, /* Vb */
- { in_line_eoln, 0 }, /* Ve */
- { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* de */
- { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* dei */
- { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* am */
- { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ami */
- { blk_exp, MAN_EXPLICIT | MAN_NOCLOSE}, /* ig */
- { blk_dotted, 0 }, /* . */
+ { in_line_eoln, 0 }, /* AT */
+ { in_line_eoln, 0 }, /* in */
+ { in_line_eoln, 0 }, /* ft */
};
const struct man_macro * const man_macros = __man_macros;
+/*
+ * Warn when "n" is an explicit non-roff macro.
+ */
+static void
+rew_warn(struct man *m, struct man_node *n, enum mandocerr er)
+{
+
+ if (er == MANDOCERR_MAX || MAN_BLOCK != n->type)
+ return;
+ if (MAN_VALID & n->flags)
+ return;
+ if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
+ return;
+
+ assert(er < MANDOCERR_FATAL);
+ man_nmsg(m, n, er);
+}
+
+
+/*
+ * Rewind scope. If a code "er" != MANDOCERR_MAX has been provided, it
+ * will be used if an explicit block scope is being closed out.
+ */
int
-man_unscope(struct man *m, const struct man_node *n)
+man_unscope(struct man *m, const struct man_node *to,
+ enum mandocerr er)
{
+ struct man_node *n;
- assert(n);
+ assert(to);
+
+ assert(MAN_ROOT != m->last->type);
+ m->next = MAN_NEXT_SIBLING;
/* LINTED */
- while (m->last != n) {
+ while (m->last != to) {
+ /*
+ * Save the parent here, because we may delete the
+ * m->last node in the post-validation phase and reset
+ * it to m->last->parent, causing a step in the closing
+ * out to be lost.
+ */
+ n = m->last->parent;
+ rew_warn(m, m->last, er);
if ( ! man_valid_post(m))
return(0);
- if ( ! man_action_post(m))
- return(0);
- m->last = m->last->parent;
+ m->last = n;
assert(m->last);
}
+ rew_warn(m, m->last, er);
if ( ! man_valid_post(m))
return(0);
- if ( ! man_action_post(m))
- return(0);
-
- m->next = MAN_ROOT == m->last->type ?
- MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
return(1);
}
{
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. */
+ /* First: rewind to ourselves. */
if (type == n->type && tok == n->tok)
return(REW_REWIND);
+ /*
+ * Next follow the implicit scope-smashings as defined by man.7:
+ * section, sub-section, etc.
+ */
+
switch (tok) {
case (MAN_SH):
break;
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));
-}
-
-
-/*
- * Closure for dotted macros (de, dei, am, ami, ign). This must handle
- * any of these as the parent node, so it needs special handling.
- * Beyond this, it's the same as blk_close().
- */
-/* ARGSUSED */
-int
-blk_dotted(MACRO_PROT_ARGS)
-{
- enum mant ntok;
- struct man_node *nn;
-
- for (nn = m->last->parent; nn; nn = nn->parent)
- if (nn->tok == MAN_de || nn->tok == MAN_dei ||
- nn->tok == MAN_am ||
- nn->tok == MAN_ami ||
- nn->tok == MAN_ig) {
- ntok = nn->tok;
- break;
- }
-
- if (NULL == nn) {
- if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
- return(0);
- return(1);
- }
-
- if ( ! rew_scope(MAN_BODY, m, ntok))
- return(0);
- if ( ! rew_scope(MAN_BLOCK, m, ntok))
- return(0);
- return(1);
+ return(man_unscope(m, n, MANDOCERR_MAX));
}
break;
if (NULL == nn)
- if ( ! man_pwarn(m, line, ppos, WNOSCOPE))
- return(0);
+ man_pmsg(m, line, ppos, MANDOCERR_NOSCOPE);
if ( ! rew_scope(MAN_BODY, m, ntok))
return(0);
}
+/* ARGSUSED */
int
blk_exp(MACRO_PROT_ARGS)
{
- int w, la;
+ int la;
char *p;
/*
* anywhere.
*/
- if ( ! (MAN_NOCLOSE & man_macros[tok].flags)) {
- if ( ! rew_scope(MAN_BODY, m, tok))
- return(0);
- if ( ! rew_scope(MAN_BLOCK, m, tok))
- return(0);
- }
-
if ( ! man_block_alloc(m, line, ppos, tok))
return(0);
if ( ! man_head_alloc(m, line, ppos, tok))
for (;;) {
la = *pos;
- w = man_args(m, line, pos, buf, &p);
-
- if (-1 == w)
- return(0);
- if (0 == w)
+ if ( ! man_args(m, line, pos, buf, &p))
break;
-
if ( ! man_word_alloc(m, line, la, p))
return(0);
}
* scopes, such as `SH' closing out an `SS', are defined in the rew
* routines.
*/
+/* ARGSUSED */
int
blk_imp(MACRO_PROT_ARGS)
{
- int w, la;
+ int la;
char *p;
struct man_node *n;
for (;;) {
la = *pos;
- w = man_args(m, line, pos, buf, &p);
-
- if (-1 == w)
- return(0);
- if (0 == w)
+ if ( ! man_args(m, line, pos, buf, &p))
break;
-
if ( ! man_word_alloc(m, line, la, p))
return(0);
}
}
+/* ARGSUSED */
int
in_line_eoln(MACRO_PROT_ARGS)
{
- int w, la;
+ int la;
char *p;
struct man_node *n;
for (;;) {
la = *pos;
- w = man_args(m, line, pos, buf, &p);
-
- if (-1 == w)
- return(0);
- if (0 == w)
+ if ( ! man_args(m, line, pos, buf, &p))
break;
if ( ! man_word_alloc(m, line, la, p))
return(0);
assert( ! (MAN_SCOPED & man_macros[tok].flags));
m->flags |= MAN_ILINE;
}
+
+ assert(MAN_ROOT != m->last->type);
+ m->next = MAN_NEXT_SIBLING;
/*
* Rewind our element scope. Note that when TH is pruned, we'll
break;
if ( ! man_valid_post(m))
return(0);
- if ( ! man_action_post(m))
- return(0);
}
assert(m->last);
if (m->last->type != MAN_ROOT && ! man_valid_post(m))
return(0);
- if (m->last->type != MAN_ROOT && ! man_action_post(m))
- return(0);
-
- m->next = MAN_ROOT == m->last->type ?
- MAN_NEXT_CHILD : MAN_NEXT_SIBLING;
return(1);
}
int
man_macroend(struct man *m)
{
- struct man_node *n;
- n = MAN_VALID & m->last->flags ?
- m->last->parent : m->last;
+ return(man_unscope(m, m->first, MANDOCERR_SCOPEEXIT));
+}
- for ( ; n; n = n->parent) {
- if (MAN_BLOCK != n->type)
- continue;
- if ( ! (MAN_EXPLICIT & man_macros[n->tok].flags))
- continue;
- if ( ! man_nwarn(m, n, WEXITSCOPE))
- return(0);
- }
+static int
+man_args(struct man *m, int line, int *pos, char *buf, char **v)
+{
+ char *start;
- return(man_unscope(m, m->first));
-}
+ assert(*pos);
+ *v = start = buf + *pos;
+ assert(' ' != *start);
+
+ if ('\0' == *start)
+ return(0);
+ *v = mandoc_getarg(m->parse, v, line, pos);
+ return(1);
+}