-/* $Id: action.c,v 1.9 2009/01/16 12:23:25 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"
-typedef int (*a_pre)(struct mdoc *, struct mdoc_node *);
-typedef int (*a_post)(struct mdoc *);
-
+/*
+ * 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 {
- a_pre pre;
- a_post post;
+ 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_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. */
const struct actions mdoc_actions[MDOC_MAX] = {
- { NULL, NULL }, /* \" */
- { NULL, post_dd }, /* Dd */
- { NULL, post_dt }, /* Dt */
- { NULL, post_os }, /* Os */
- { NULL, post_sh }, /* Sh */
- { NULL, NULL }, /* Ss */
- { NULL, NULL }, /* Pp */
- { NULL, NULL }, /* D1 */
- { NULL, NULL }, /* Dl */
- { NULL, NULL }, /* Bd */
- { NULL, NULL }, /* Ed */
- { NULL, NULL }, /* Bl */
- { NULL, NULL }, /* El */
- { NULL, NULL }, /* It */
- { NULL, NULL }, /* Ad */
- { NULL, NULL }, /* An */
- { NULL, NULL }, /* Ar */
- { NULL, NULL }, /* Cd */
- { NULL, NULL }, /* Cm */
- { NULL, NULL }, /* Dv */
- { NULL, NULL }, /* Er */
- { NULL, NULL }, /* Ev */
- { NULL, NULL }, /* Ex */
- { NULL, NULL }, /* Fa */
- { NULL, NULL }, /* Fd */
- { NULL, NULL }, /* Fl */
- { NULL, NULL }, /* Fn */
- { NULL, NULL }, /* Ft */
- { NULL, NULL }, /* Ic */
- { NULL, NULL }, /* In */
- { NULL, NULL }, /* Li */
- { NULL, NULL }, /* Nd */
- { NULL, NULL }, /* Nm */
- { NULL, NULL }, /* Op */
- { NULL, NULL }, /* Ot */
- { NULL, NULL }, /* Pa */
- { NULL, NULL }, /* Rv */
- { NULL, NULL }, /* St */
- { NULL, NULL }, /* Va */
- { NULL, NULL }, /* Vt */
- { NULL, NULL }, /* Xr */
- { NULL, NULL }, /* %A */
- { NULL, NULL }, /* %B */
- { NULL, NULL }, /* %D */
- { NULL, NULL }, /* %I */
- { NULL, NULL }, /* %J */
- { NULL, NULL }, /* %N */
- { NULL, NULL }, /* %O */
- { NULL, NULL }, /* %P */
- { NULL, NULL }, /* %R */
- { NULL, NULL }, /* %T */
- { NULL, NULL }, /* %V */
- { NULL, NULL }, /* Ac */
- { NULL, NULL }, /* Ao */
- { NULL, NULL }, /* Aq */
- { NULL, NULL }, /* At */
- { NULL, NULL }, /* Bc */
- { NULL, NULL }, /* Bf */
- { NULL, NULL }, /* Bo */
- { NULL, NULL }, /* Bq */
- { NULL, NULL }, /* Bsx */
- { NULL, NULL }, /* Bx */
- { NULL, NULL }, /* Db */
- { NULL, NULL }, /* Dc */
- { NULL, NULL }, /* Do */
- { NULL, NULL }, /* Dq */
- { NULL, NULL }, /* Ec */
- { NULL, NULL }, /* Ef */
- { NULL, NULL }, /* Em */
- { NULL, NULL }, /* Eo */
- { NULL, NULL }, /* Fx */
- { NULL, NULL }, /* Ms */
- { NULL, NULL }, /* No */
- { NULL, NULL }, /* Ns */
- { NULL, NULL }, /* Nx */
- { NULL, NULL }, /* Ox */
- { NULL, NULL }, /* Pc */
- { NULL, NULL }, /* Pf */
- { NULL, NULL }, /* Po */
- { NULL, NULL }, /* Pq */
- { NULL, NULL }, /* Qc */
- { NULL, NULL }, /* Ql */
- { NULL, NULL }, /* Qo */
- { NULL, NULL }, /* Qq */
- { NULL, NULL }, /* Re */
- { NULL, NULL }, /* Rs */
- { NULL, NULL }, /* Sc */
- { NULL, NULL }, /* So */
- { NULL, NULL }, /* Sq */
- { NULL, NULL }, /* Sm */
- { NULL, NULL }, /* Sx */
- { NULL, NULL }, /* Sy */
- { NULL, NULL }, /* Tn */
- { NULL, NULL }, /* Ux */
- { NULL, NULL }, /* Xc */
- { NULL, NULL }, /* Xo */
- { NULL, NULL }, /* Fo */
- { NULL, NULL }, /* Fc */
- { NULL, NULL }, /* Oo */
- { NULL, NULL }, /* Oc */
- { NULL, NULL }, /* Bk */
- { NULL, NULL }, /* Ek */
- { NULL, NULL }, /* Bt */
- { NULL, NULL }, /* Hf */
- { NULL, NULL }, /* Fr */
- { NULL, NULL }, /* Ud */
+ { NULL }, /* \" */
+ { post_dd }, /* Dd */
+ { post_dt }, /* Dt */
+ { post_os }, /* Os */
+ { post_sh }, /* Sh */
+ { NULL }, /* Ss */
+ { NULL }, /* Pp */
+ { NULL }, /* D1 */
+ { NULL }, /* Dl */
+ { NULL }, /* Bd */
+ { NULL }, /* Ed */
+ { post_bl }, /* Bl */
+ { NULL }, /* El */
+ { NULL }, /* It */
+ { NULL }, /* Ad */
+ { NULL }, /* An */
+ { NULL }, /* Ar */
+ { NULL }, /* Cd */
+ { NULL }, /* Cm */
+ { NULL }, /* Dv */
+ { NULL }, /* Er */
+ { NULL }, /* Ev */
+ { NULL }, /* Ex */
+ { NULL }, /* Fa */
+ { NULL }, /* Fd */
+ { NULL }, /* Fl */
+ { NULL }, /* Fn */
+ { NULL }, /* Ft */
+ { NULL }, /* Ic */
+ { NULL }, /* In */
+ { NULL }, /* Li */
+ { NULL }, /* Nd */
+ { post_nm }, /* Nm */
+ { NULL }, /* Op */
+ { NULL }, /* Ot */
+ { NULL }, /* Pa */
+ { NULL }, /* Rv */
+ { NULL }, /* St */
+ { NULL }, /* Va */
+ { NULL }, /* Vt */
+ { NULL }, /* Xr */
+ { NULL }, /* %A */
+ { NULL }, /* %B */
+ { NULL }, /* %D */
+ { NULL }, /* %I */
+ { NULL }, /* %J */
+ { NULL }, /* %N */
+ { NULL }, /* %O */
+ { NULL }, /* %P */
+ { NULL }, /* %R */
+ { NULL }, /* %T */
+ { NULL }, /* %V */
+ { NULL }, /* Ac */
+ { NULL }, /* Ao */
+ { NULL }, /* Aq */
+ { NULL }, /* At */
+ { NULL }, /* Bc */
+ { NULL }, /* Bf */
+ { NULL }, /* Bo */
+ { NULL }, /* Bq */
+ { NULL }, /* Bsx */
+ { NULL }, /* Bx */
+ { NULL }, /* Db */
+ { NULL }, /* Dc */
+ { NULL }, /* Do */
+ { NULL }, /* Dq */
+ { NULL }, /* Ec */
+ { NULL }, /* Ef */
+ { NULL }, /* Em */
+ { NULL }, /* Eo */
+ { NULL }, /* Fx */
+ { NULL }, /* Ms */
+ { NULL }, /* No */
+ { NULL }, /* Ns */
+ { NULL }, /* Nx */
+ { NULL }, /* Ox */
+ { NULL }, /* Pc */
+ { NULL }, /* Pf */
+ { NULL }, /* Po */
+ { NULL }, /* Pq */
+ { NULL }, /* Qc */
+ { NULL }, /* Ql */
+ { NULL }, /* Qo */
+ { NULL }, /* Qq */
+ { NULL }, /* Re */
+ { NULL }, /* Rs */
+ { NULL }, /* Sc */
+ { NULL }, /* So */
+ { NULL }, /* Sq */
+ { NULL }, /* Sm */
+ { NULL }, /* Sx */
+ { NULL }, /* Sy */
+ { NULL }, /* Tn */
+ { NULL }, /* Ux */
+ { NULL }, /* Xc */
+ { NULL }, /* Xo */
+ { NULL }, /* Fo */
+ { NULL }, /* Fc */
+ { NULL }, /* Oo */
+ { NULL }, /* Oc */
+ { NULL }, /* Bk */
+ { NULL }, /* Ek */
+ { NULL }, /* Bt */
+ { NULL }, /* Hf */
+ { NULL }, /* Fr */
+ { NULL }, /* Ud */
};
static int
-post_sh(struct mdoc *mdoc)
+post_nm(struct mdoc *mdoc)
{
- enum mdoc_sec sec;
- int i;
- struct mdoc_node *n;
- char *args[MDOC_LINEARG_MAX];
+ char buf[64];
- if (MDOC_HEAD != mdoc->last->type)
- return(1);
-
- assert(MDOC_Sh == mdoc->last->tok);
+ assert(MDOC_ELEM == mdoc->last->type);
+ assert(MDOC_Nm == mdoc->last->tok);
- n = mdoc->last->child;
- assert(n);
+ /*
+ * 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.
+ */
- for (i = 0; n && i < MDOC_LINEARG_MAX; n = n->next, i++) {
- assert(MDOC_TEXT == n->type);
- assert(NULL == n->child);
- assert(n->data.text.string);
- args[i] = n->data.text.string;
+ if (mdoc->meta.name)
+ return(1);
+
+ if (xstrlcats(buf, mdoc->last->child, 64)) {
+ mdoc->meta.name = xstrdup(buf);
+ return(1);
}
- sec = mdoc_atosec((size_t)i, (const char **)args);
- if (SEC_CUSTOM != sec)
- mdoc->sec_lastn = sec;
- mdoc->sec_last = sec;
+ return(mdoc_err(mdoc, "macro parameters too long"));
+}
+
+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;
+ } 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(1);
}
{
int i;
char *p;
- size_t sz;
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(0 == mdoc->meta.title[0]);
- sz = META_TITLE_SZ;
- (void)xstrlcpy(mdoc->meta.title, "UNTITLED", sz);
+ 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;
switch (i) {
case (0):
- if (xstrlcpy(mdoc->meta.title, p, sz))
- break;
- return(mdoc_nerr(mdoc, n, "badly-formed manual title parameter"));
+ mdoc->meta.title = xstrdup(p);
+ break;
case (1):
mdoc->meta.msec = mdoc_atomsec(p);
if (MSEC_DEFAULT != mdoc->meta.msec)
break;
- return(mdoc_nerr(mdoc, n, "badly-formed manual section parameter"));
+ 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, "badly-formed manual volume parameter"));
+ 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"));
}
}
- mdoc_msg(mdoc, "parsed title: %s", mdoc->meta.title);
- /* TODO: print vol2a functions. */
- return(1);
+ if (NULL == mdoc->meta.title)
+ mdoc->meta.title = xstrdup("UNTITLED");
+
+ mdoc_msg(mdoc, "title: %s", mdoc->meta.title);
+
+ return(post_prologue(mdoc));
}
static int
post_os(struct mdoc *mdoc)
{
- char *p;
- size_t sz;
- struct mdoc_node *n;
+ 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(0 == mdoc->meta.os[0]);
+ assert(NULL == mdoc->meta.os);
- sz = META_OS_SZ;
+ if ( ! xstrlcats(buf, mdoc->last->child, 64))
+ return(mdoc_err(mdoc, "macro parameters too long"));
- for (n = mdoc->last->child; n; n = n->next) {
- assert(MDOC_TEXT == n->type);
- p = n->data.text.string;
+ mdoc->meta.os = xstrdup(buf[0] ? buf : "LOCAL");
+ mdoc->lastnamed = SEC_BODY;
+
+ return(post_prologue(mdoc));
+}
- if ( ! xstrlcat(mdoc->meta.os, p, sz))
- return(mdoc_nerr(mdoc, n, "badly-formed manual system parameter"));
- if ( ! xstrlcat(mdoc->meta.os, " ", sz))
- return(mdoc_nerr(mdoc, n, "badly-formed manual system parameter"));
+
+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;
}
- if (0 == mdoc->meta.os[0])
- (void)xstrlcpy(mdoc->meta.os, "LOCAL", sz);
+ (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);
- mdoc_msg(mdoc, "parsed operating system: %s", mdoc->meta.os);
- mdoc->sec_lastn = mdoc->sec_last = SEC_BODY;
return(1);
}
static int
-post_dd(struct mdoc *mdoc)
+post_bl_width(struct mdoc *mdoc)
{
- char date[64];
- size_t sz;
- char *p;
- struct mdoc_node *n;
+ 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]));
- assert(MDOC_ELEM == mdoc->last->type);
- assert(MDOC_Dd == mdoc->last->tok);
+ mdoc_msg(mdoc, "re-writing %s argument: %s -> %zun",
+ mdoc_argnames[MDOC_Width], *p, width);
- n = mdoc->last->child;
- assert(0 == mdoc->meta.date);
- date[0] = 0;
+ /* The value already exists: free and reallocate it. */
- sz = 64;
+ (void)snprintf(buf, sizeof(buf), "%zun", width);
- for ( ; 0 == mdoc->meta.date && n; n = n->next) {
- assert(MDOC_TEXT == n->type);
- p = n->data.text.string;
+ free(*p);
+ *p = strdup(buf);
- if (xstrcmp(p, "$Mdocdate: January 16 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, "badly-formed manual date parameter"));
- if (n->next && ! xstrlcat(date, " ", sz))
- return(mdoc_nerr(mdoc, n, "badly-formed manual date parameter"));
- }
+ return(1);
+}
- if (mdoc->meta.date && NULL == n) {
- mdoc_msg(mdoc, "parsed time: %u since epoch",
- mdoc->meta.date);
- return(1);
- } else if (n)
- return(mdoc_err(mdoc, "badly-formed manual date"));
- if ((mdoc->meta.date = mdoc_atotime(date))) {
- mdoc_msg(mdoc, "parsed time: %u since epoch",
- mdoc->meta.date);
+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;
}
- return(mdoc_err(mdoc, "badly-formed manual date"));
+ 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);
}
-int
-mdoc_action_pre(struct mdoc *mdoc, struct mdoc_node *node)
+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);
+
+ assert(0 == mdoc->meta.date);
+
+ 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));
+}
+
+
+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;
+ }
+
+ 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)
return(1);
-
if (NULL == mdoc_actions[mdoc->last->tok].post)
return(1);
- /* TODO: MDOC_Nm... ? */
return((*mdoc_actions[mdoc->last->tok].post)(mdoc));
}
git.ckatri.com / mandoc.git / blobdiff