-/* $Id: action.c,v 1.11 2009/01/17 16:47:02 kristaps Exp $ */
+/* $Id: action.c,v 1.28 2009/03/01 23:14:15 kristaps Exp $ */
/*
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
*
* PERFORMANCE OF THIS SOFTWARE.
*/
#include <assert.h>
+#include <stdio.h>
#include <stdlib.h>
+#include <string.h>
#include <time.h>
#include "private.h"
+/*
+ * Actions are executed on macros after they've been post-validated: in
+ * other words, a macro will not be "acted upon" until all of its
+ * children have been filled in (post-fix order).
+ */
struct actions {
int (*post)(struct mdoc *);
/* Per-macro action routines. */
-static int post_sh(struct mdoc *);
-static int post_os(struct mdoc *);
-static int post_dt(struct mdoc *);
-static int post_dd(struct mdoc *);
-static int post_nm(struct mdoc *);
+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 *);
+static int post_dd(struct mdoc *);
+static int post_nm(struct mdoc *);
+
+static int post_prologue(struct mdoc *);
/* Array of macro action routines. */
{ NULL }, /* Dl */
{ NULL }, /* Bd */
{ NULL }, /* Ed */
- { NULL }, /* Bl */
+ { post_bl }, /* Bl */
{ NULL }, /* El */
{ NULL }, /* It */
{ NULL }, /* Ad */
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);
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->sec_lastn = sec;
- mdoc->sec_last = sec;
- return(1);
+ mdoc->lastnamed = sec;
+ mdoc->lastsec = sec;
+ } 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);
}
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);
assert(NULL == mdoc->meta.title);
+ /* LINTED */
for (i = 0, n = mdoc->last->child; n; n = n->next, i++) {
assert(MDOC_TEXT == n->type);
p = n->data.text.string;
mdoc->meta.msec = mdoc_atomsec(p);
if (MSEC_DEFAULT != mdoc->meta.msec)
break;
- return(mdoc_nerr(mdoc, n, "invalid parameter syntax"));
+ return(mdoc_nerr(mdoc, n,
+ "invalid parameter syntax"));
case (2):
mdoc->meta.vol = mdoc_atovol(p);
if (VOL_DEFAULT != mdoc->meta.vol)
mdoc->meta.arch = mdoc_atoarch(p);
if (ARCH_DEFAULT != mdoc->meta.arch)
break;
- return(mdoc_nerr(mdoc, n, "invalid parameter syntax"));
+ return(mdoc_nerr(mdoc, n,
+ "invalid parameter syntax"));
default:
- return(mdoc_nerr(mdoc, n, "too many parameters"));
+ return(mdoc_nerr(mdoc, n,
+ "too many parameters"));
}
}
if (NULL == mdoc->meta.title)
- mdoc->meta.title = xstrdup("untitled");
- return(1);
+ mdoc->meta.title = xstrdup("UNTITLED");
+
+ mdoc_msg(mdoc, "title: %s", mdoc->meta.title);
+
+ return(post_prologue(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);
if ( ! xstrlcats(buf, mdoc->last->child, 64))
return(mdoc_err(mdoc, "macro parameters too long"));
- mdoc->meta.os = xstrdup(buf[0] ? buf : "local");
- mdoc->sec_lastn = mdoc->sec_last = SEC_BODY;
+ mdoc->meta.os = xstrdup(buf[0] ? buf : "LOCAL");
+ mdoc->lastnamed = SEC_BODY;
+
+ return(post_prologue(mdoc));
+}
+
+
+static int
+post_bl_tagwidth(struct mdoc *mdoc)
+{
+ struct mdoc_node *n;
+ struct mdoc_block *b;
+ int sz;
+ char buf[32];
+
+ /*
+ * 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);
+
+ return(1);
+}
+
+
+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;
+
+ 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];
+
+ /*
+ * 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 (xstrcmp(*p, "Ds"))
+ width = 8;
+ else if (MDOC_MAX == (tok = mdoc_find(mdoc, *p)))
+ return(1);
+ else if (0 == (width = mdoc_macro2len(tok)))
+ return(mdoc_warn(mdoc, WARN_SYNTAX,
+ "%s macro has no length",
+ mdoc_argnames[MDOC_Width]));
+
+ mdoc_msg(mdoc, "re-writing %s argument: %s -> %zun",
+ mdoc_argnames[MDOC_Width], *p, width);
+
+ /* The value already exists: free and reallocate it. */
+
+ (void)snprintf(buf, sizeof(buf), "%zun", width);
+
+ 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);
}
static int
post_dd(struct mdoc *mdoc)
{
- char date[64];
- size_t sz;
- char *p;
- struct mdoc_node *n;
+ 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);
- n = mdoc->last->child;
assert(0 == mdoc->meta.date);
- date[0] = 0;
- sz = 64;
+ if ( ! xstrlcats(buf, mdoc->last->child, 64))
+ return(mdoc_err(mdoc, "macro parameters too long"));
+ if (0 == (mdoc->meta.date = mdoc_atotime(buf)))
+ return(mdoc_err(mdoc, "invalid parameter syntax"));
+
+ mdoc_msg(mdoc, "date: %u", mdoc->meta.date);
+
+ return(post_prologue(mdoc));
+}
- for ( ; 0 == mdoc->meta.date && n; n = n->next) {
- assert(MDOC_TEXT == n->type);
- p = n->data.text.string;
- if (xstrcmp(p, "$Mdocdate: January 17 2009 $")) {
- mdoc->meta.date = time(NULL);
- continue;
- } else if (xstrcmp(p, "$")) {
- mdoc->meta.date = mdoc_atotime(date);
- continue;
- } else if (xstrcmp(p, "$Mdocdate:"))
- continue;
-
- if ( ! xstrlcat(date, n->data.text.string, sz))
- return(mdoc_nerr(mdoc, n, "invalid parameter syntax"));
- if (n->next && ! xstrlcat(date, " ", sz))
- return(mdoc_nerr(mdoc, n, "invalid parameter syntax"));
+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)
+ mdoc->last->prev->next = NULL;
+
+ n = mdoc->last;
+ assert(NULL == mdoc->last->next);
+
+ if (mdoc->last->prev) {
+ mdoc->last = mdoc->last->prev;
+ mdoc->next = MDOC_NEXT_SIBLING;
+ } else {
+ mdoc->last = mdoc->last->parent;
+ mdoc->next = MDOC_NEXT_CHILD;
}
- if (mdoc->meta.date && NULL == n)
- return(1);
- else if (n)
- return(mdoc_err(mdoc, "invalid parameter syntax"));
- if ((mdoc->meta.date = mdoc_atotime(date)))
- return(1);
- return(mdoc_err(mdoc, "invalid parameter syntax"));
+ mdoc_node_freelist(n);
+ return(1);
}
mdoc_action_post(struct mdoc *mdoc)
{
+ if (MDOC_ACTED & mdoc->last->flags)
+ return(1);
+ mdoc->last->flags |= MDOC_ACTED;
+
if (MDOC_TEXT == mdoc->last->type)
return(1);
if (MDOC_ROOT == mdoc->last->type)
git.ckatri.com / mandoc.git / blobdiff