-/* $Id: action.c,v 1.22 2009/02/27 10:55:16 kristaps Exp $ */
+/* $Id: action.c,v 1.23 2009/02/28 13:47:36 kristaps Exp $ */
/*
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
*
/* Per-macro action routines. */
static int post_bl(struct mdoc *);
+static int post_bl_width(struct mdoc *);
+static int post_bl_tagwidth(struct mdoc *);
static int post_sh(struct mdoc *);
static int post_os(struct mdoc *);
static int post_dt(struct mdoc *);
};
-/*
- * The `Nm' macro sets the document's name when used the first time with
- * an argument. Subsequent calls without a value will result in the
- * name value being used.
- */
static int
post_nm(struct mdoc *mdoc)
{
assert(MDOC_ELEM == mdoc->last->type);
assert(MDOC_Nm == mdoc->last->tok);
+ /*
+ * The `Nm' macro sets the document's name when used the first
+ * time with an argument. Subsequent calls without a value will
+ * result in the name value being used.
+ */
+
if (mdoc->meta.name)
return(1);
}
-/*
- * We keep track of the current section in order to provide warnings on
- * section ordering, per-section macros, and so on.
- */
static int
post_sh(struct mdoc *mdoc)
{
enum mdoc_sec sec;
char buf[64];
+ /*
+ * We keep track of the current section /and/ the "named"
+ * section, which is one of the conventional ones, in order to
+ * check ordering.
+ */
+
if (MDOC_HEAD != mdoc->last->type)
return(1);
if (xstrlcats(buf, mdoc->last->child, 64)) {
if (SEC_CUSTOM != (sec = mdoc_atosec(buf)))
mdoc->lastnamed = sec;
mdoc->lastsec = sec;
- return(1);
+ } else
+ return(mdoc_err(mdoc, "parameters too long"));
+
+ switch (mdoc->lastsec) {
+ case (SEC_RETURN_VALUES):
+ /* FALLTHROUGH */
+ case (SEC_ERRORS):
+ switch (mdoc->meta.msec) {
+ case (MSEC_2):
+ /* FALLTHROUGH */
+ case (MSEC_3):
+ /* FALLTHROUGH */
+ case (MSEC_9):
+ break;
+ default:
+ return(mdoc_warn(mdoc, WARN_COMPAT,
+ "inappropriate section for "
+ "manual section"));
+ }
+ break;
+ default:
+ break;
}
-
- return(mdoc_err(mdoc, "macro parameters too long"));
+ return(1);
}
-/*
- * Prologue title must be parsed into document meta-data.
- */
static int
post_dt(struct mdoc *mdoc)
{
char *p;
struct mdoc_node *n;
+ /*
+ * Prologue title must be parsed into document meta-data.
+ */
+
assert(MDOC_ELEM == mdoc->last->type);
assert(MDOC_Dt == mdoc->last->tok);
}
-/*
- * Prologue operating system must be parsed into document meta-data.
- */
static int
post_os(struct mdoc *mdoc)
{
char buf[64];
+ /*
+ * Prologue operating system must be parsed into document
+ * meta-data.
+ */
+
assert(MDOC_ELEM == mdoc->last->type);
assert(MDOC_Os == mdoc->last->tok);
assert(NULL == mdoc->meta.os);
}
-/*
- * Transform -width MACRO values into real widths.
- */
static int
-post_bl(struct mdoc *mdoc)
+post_bl_tagwidth(struct mdoc *mdoc)
{
- struct mdoc_block *bl;
- size_t width;
- int tok, i;
+ struct mdoc_node *n;
+ struct mdoc_block *b;
+ int sz;
char buf[32];
- if (MDOC_BLOCK != mdoc->last->type)
+ /*
+ * If -tag has been specified and -width has not been, then try
+ * to intuit our width from the first body element.
+ */
+
+ b = &mdoc->last->data.block;
+
+ if (NULL == (n = b->body->child))
return(1);
+ assert(MDOC_It == n->tok);
+
+ /*
+ * Use the text width, if a text node, or the default macro
+ * width if a macro.
+ */
+
+ if ((n = n->data.block.head->child)) {
+ if (MDOC_TEXT != n->type) {
+ if (0 == (sz = mdoc_macro2len(n->tok)))
+ sz = -1;
+ } else
+ sz = (int)strlen(n->data.text.string) + 1;
+ } else
+ sz = -1;
+
+ if (-1 == sz) {
+ if ( ! mdoc_warn(mdoc, WARN_SYNTAX,
+ "cannot determine default %s",
+ mdoc_argnames[MDOC_Width]))
+ return(0);
+ sz = 10;
+ }
+
+ (void)snprintf(buf, sizeof(buf), "%dn", sz);
+
+ /*
+ * We have to dynamically add this to the macro's argument list.
+ * We're guaranteed that a MDOC_Width doesn't already exist.
+ */
+
+ (b->argc)++;
+ b->argv = xrealloc(b->argv, b->argc * sizeof(struct mdoc_arg));
+
+ b->argv[b->argc - 1].arg = MDOC_Width;
+ b->argv[b->argc - 1].line = mdoc->last->line;
+ b->argv[b->argc - 1].pos = mdoc->last->pos;
+ b->argv[b->argc - 1].sz = 1;
+ b->argv[b->argc - 1].value = xcalloc(1, sizeof(char *));
+ b->argv[b->argc - 1].value[0] = xstrdup(buf);
+
+ mdoc_msg(mdoc, "adding %s argument: %dn",
+ mdoc_argnames[MDOC_Width], sz);
- bl = &mdoc->last->data.block;
+ return(1);
+}
- for (i = 0; i < (int)bl->argc; i++)
- if (MDOC_Width == bl->argv[i].arg)
+
+static int
+post_bl_width(struct mdoc *mdoc)
+{
+ size_t width;
+ int i, tok;
+ char buf[32];
+ char **p;
+
+ for (i = 0; i < (int)mdoc->last->data.block.argc; i++)
+ if (MDOC_Width == mdoc->last->data.block.argv[i].arg)
break;
- if (i == (int)bl->argc)
- return(1);
+ assert(i < (int)mdoc->last->data.block.argc);
+ assert(1 == mdoc->last->data.block.argv[i].sz);
+ p = &mdoc->last->data.block.argv[i].value[0];
- assert(1 == bl->argv[i].sz);
- if (MDOC_MAX == (tok = mdoc_find(mdoc, *bl->argv[i].value)))
+ /*
+ * If the value to -width is a macro, then we re-write it to be
+ * the macro's width as set in share/tmac/mdoc/doc-common.
+ */
+
+ if (MDOC_MAX == (tok = mdoc_find(mdoc, *p)))
return(1);
if (0 == (width = mdoc_macro2len(tok)))
mdoc_argnames[MDOC_Width]));
mdoc_msg(mdoc, "re-writing %s argument: %s -> %zun",
- mdoc_argnames[MDOC_Width],
- *bl->argv[i].value, width);
+ mdoc_argnames[MDOC_Width], *p, width);
+
+ /* The value already exists: free and reallocate it. */
- /* FIXME: silently truncates. */
(void)snprintf(buf, sizeof(buf), "%zun", width);
- free(*bl->argv[i].value);
- *bl->argv[i].value = strdup(buf);
+ free(*p);
+ *p = strdup(buf);
+
+ return(1);
+}
+
+
+static int
+post_bl(struct mdoc *mdoc)
+{
+ int i, r;
+
+ if (MDOC_BLOCK != mdoc->last->type)
+ return(1);
+
+ /*
+ * These are fairly complicated, so we've broken them into two
+ * functions. post_bl_tagwidth() is called when a -tag is
+ * specified, but no -width (it must be guessed). The second
+ * when a -width is specified (macro indicators must be
+ * rewritten into real lengths).
+ */
+
+ for (r = i = 0; i < (int)mdoc->last->data.block.argc; i++) {
+ if (MDOC_Tag == mdoc->last->data.block.argv[i].arg)
+ r |= 1 << 0;
+ if (MDOC_Width == mdoc->last->data.block.argv[i].arg)
+ r |= 1 << 1;
+ }
+
+ if (r & (1 << 0) && ! (r & (1 << 1))) {
+ if ( ! post_bl_tagwidth(mdoc))
+ return(0);
+ } else if (r & (1 << 1))
+ if ( ! post_bl_width(mdoc))
+ return(0);
return(1);
}
-/*
- * Prologue date must be parsed into document meta-data.
- */
static int
post_dd(struct mdoc *mdoc)
{
char buf[64];
+ /*
+ * Prologue date must be parsed into document meta-data. We
+ * accept multiple kinds of dates, described mostly in
+ * mdoc_atotime().
+ */
+
assert(MDOC_ELEM == mdoc->last->type);
assert(MDOC_Dd == mdoc->last->tok);
}
-/*
- * The end document shouldn't have the prologue macros as part of the
- * syntax tree (they encompass only meta-data).
- */
static int
post_prologue(struct mdoc *mdoc)
{
struct mdoc_node *n;
+ /*
+ * The end document shouldn't have the prologue macros as part
+ * of the syntax tree (they encompass only meta-data).
+ */
+
if (mdoc->last->parent->child == mdoc->last)
mdoc->last->parent->child = mdoc->last->prev;
if (mdoc->last->prev)
-/* $Id: validate.c,v 1.63 2009/02/27 09:39:40 kristaps Exp $ */
+/* $Id: validate.c,v 1.64 2009/02/28 13:47:36 kristaps Exp $ */
/*
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
*
typedef int (*v_pre)(PRE_ARGS);
typedef int (*v_post)(POST_ARGS);
-/* FIXME: some sections should only occur in specific msecs. */
-/* FIXME: ignoring Pp. */
-/* FIXME: math symbols. */
+/* TODO: ignoring Pp (it's superfluous in some invocations). */
struct valids {
v_pre *pre;
"superfluous -%s argument",
mdoc_argnames[MDOC_Width]));
case (MDOC_Tag):
- if (-1 != width)
- break;
- return(mdoc_nwarn(mdoc, n, WARN_SYNTAX,
- "suggest -%s argument",
- mdoc_argnames[MDOC_Width]));
+ if (-1 == width && ! mdoc_nwarn(mdoc, n, WARN_SYNTAX,
+ "suggest -%s argument",
+ mdoc_argnames[MDOC_Width]))
+ return(0);
+ break;
default:
break;
}
pre_it(PRE_ARGS)
{
- /* TODO: children too big for -width? */
-
if (MDOC_BLOCK != n->type)
return(1);
return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
if (MDOC_BODY != mdoc->last->type)
return(1);
+ if (NULL == (mdoc->last->child))
+ return(1);
+
+ /*
+ * Only allow `It' macros to be the immediate descendants of the
+ * `Bl' list.
+ */
/* LINTED */
for (n = mdoc->last->child; n; n = n->next) {
if (MDOC_BLOCK == n->type)
if (MDOC_It == n->tok)
continue;
- break;
- }
- if (NULL == n)
- return(1);
+ return(mdoc_nerr(mdoc, n, "bad child of parent %s",
+ mdoc_macronames[mdoc->last->tok]));
+ }
- return(mdoc_nerr(mdoc, n, "bad child of parent list"));
+ return(1);
}
git.ckatri.com / mandoc.git / commitdiff