-/* $Id: mdoc_action.c,v 1.36 2009/09/16 14:40:56 kristaps Exp $ */
+/* $Id: mdoc_action.c,v 1.50 2010/01/01 17:14:29 kristaps Exp $ */
/*
* Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#ifndef OSNAME
#include <sys/utsname.h>
+#endif
#include <assert.h>
-#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
+#include <time.h>
#include "libmdoc.h"
+#include "libmandoc.h"
#define POST_ARGS struct mdoc *m, struct mdoc_node *n
#define PRE_ARGS struct mdoc *m, const struct mdoc_node *n
+#define NUMSIZ 32
+#define DATESIZ 32
+
struct actions {
int (*pre)(PRE_ARGS);
int (*post)(POST_ARGS);
};
+static int concat(struct mdoc *, char *,
+ const struct mdoc_node *, size_t);
+static inline int order_rs(int);
+
static int post_ar(POST_ARGS);
static int post_at(POST_ARGS);
static int post_bl(POST_ARGS);
static int post_lb(POST_ARGS);
static int post_nm(POST_ARGS);
static int post_os(POST_ARGS);
+static int post_pa(POST_ARGS);
static int post_prol(POST_ARGS);
+static int post_rs(POST_ARGS);
static int post_sh(POST_ARGS);
static int post_st(POST_ARGS);
static int post_std(POST_ARGS);
-static int post_tilde(POST_ARGS);
static int pre_bd(PRE_ARGS);
+static int pre_bl(PRE_ARGS);
static int pre_dl(PRE_ARGS);
+static int pre_offset(PRE_ARGS);
-const struct actions mdoc_actions[MDOC_MAX] = {
+static const struct actions mdoc_actions[MDOC_MAX] = {
{ NULL, NULL }, /* Ap */
{ NULL, post_dd }, /* Dd */
{ NULL, post_dt }, /* Dt */
{ pre_dl, post_display }, /* Dl */
{ pre_bd, post_display }, /* Bd */
{ NULL, NULL }, /* Ed */
- { NULL, post_bl }, /* Bl */
+ { pre_bl, post_bl }, /* Bl */
{ NULL, NULL }, /* El */
{ NULL, NULL }, /* It */
{ NULL, NULL }, /* Ad */
{ NULL, post_nm }, /* Nm */
{ NULL, NULL }, /* Op */
{ NULL, NULL }, /* Ot */
- { NULL, post_tilde }, /* Pa */
+ { NULL, post_pa }, /* Pa */
{ NULL, post_std }, /* Rv */
{ NULL, post_st }, /* St */
{ NULL, NULL }, /* Va */
{ NULL, NULL }, /* Qo */
{ NULL, NULL }, /* Qq */
{ NULL, NULL }, /* Re */
- { NULL, NULL }, /* Rs */
+ { NULL, post_rs }, /* Rs */
{ NULL, NULL }, /* Sc */
{ NULL, NULL }, /* So */
{ NULL, NULL }, /* Sq */
{ NULL, NULL }, /* Ud */
{ NULL, post_lb }, /* Lb */
{ NULL, NULL }, /* Lp */
- { NULL, post_tilde }, /* Lk */
+ { NULL, NULL }, /* Lk */
{ NULL, NULL }, /* Mt */
{ NULL, NULL }, /* Brq */
{ NULL, NULL }, /* Bro */
{ NULL, NULL }, /* %Q */
{ NULL, NULL }, /* br */
{ NULL, NULL }, /* sp */
+ { NULL, NULL }, /* %U */
};
-static int concat(struct mdoc *, const struct mdoc_node *,
- char *, size_t);
-
-#ifdef __linux__
-extern size_t strlcat(char *, const char *, size_t);
-#endif
+#define RSORD_MAX 14
+
+static const int rsord[RSORD_MAX] = {
+ MDOC__A,
+ MDOC__T,
+ MDOC__B,
+ MDOC__I,
+ MDOC__J,
+ MDOC__R,
+ MDOC__N,
+ MDOC__V,
+ MDOC__P,
+ MDOC__Q,
+ MDOC__D,
+ MDOC__O,
+ MDOC__C,
+ MDOC__U
+};
int
}
+/*
+ * Concatenate sibling nodes together. All siblings must be of type
+ * MDOC_TEXT or an assertion is raised. Concatenation is separated by a
+ * single whitespace.
+ */
static int
-concat(struct mdoc *m, const struct mdoc_node *n,
- char *buf, size_t sz)
+concat(struct mdoc *m, char *p, const struct mdoc_node *n, size_t sz)
{
+ assert(sz);
+ p[0] = '\0';
for ( ; n; n = n->next) {
assert(MDOC_TEXT == n->type);
- if (strlcat(buf, n->string, sz) >= sz)
+ if (strlcat(p, n->string, sz) >= sz)
return(mdoc_nerr(m, n, ETOOLONG));
if (NULL == n->next)
continue;
- if (strlcat(buf, " ", sz) >= sz)
+ if (strlcat(p, " ", sz) >= sz)
return(mdoc_nerr(m, n, ETOOLONG));
}
}
+/*
+ * Macros accepting `-std' as an argument have the name of the current
+ * document (`Nm') filled in as the argument if it's not provided.
+ */
static int
post_std(POST_ARGS)
{
if ( ! mdoc_word_alloc(m, n->line, n->pos, m->meta.name))
return(0);
m->last = nn;
-
return(1);
}
+/*
+ * The `Nm' macro's first use sets the name of the document. See also
+ * post_std(), etc.
+ */
static int
post_nm(POST_ARGS)
{
- char buf[64];
+ char buf[BUFSIZ];
if (m->meta.name)
return(1);
-
- buf[0] = 0;
- if ( ! concat(m, n->child, buf, sizeof(buf)))
+ if ( ! concat(m, buf, n->child, BUFSIZ))
return(0);
- if (NULL == (m->meta.name = strdup(buf)))
- return(mdoc_nerr(m, n, EMALLOC));
-
+ m->meta.name = mandoc_strdup(buf);
return(1);
}
+/*
+ * Look up the value of `Lb' for matching predefined strings. If it has
+ * one, then substitute the current value for the formatted value. Note
+ * that the lookup may fail (we can provide arbitrary strings).
+ */
+/* ARGSUSED */
static int
post_lb(POST_ARGS)
{
assert(MDOC_TEXT == n->child->type);
p = mdoc_a2lib(n->child->string);
- if (NULL == p) {
- sz = strlen(n->child->string) +
- 2 + strlen("\\(lqlibrary\\(rq");
- buf = malloc(sz);
- if (NULL == buf)
- return(mdoc_nerr(m, n, EMALLOC));
- (void)snprintf(buf, sz, "library \\(lq%s\\(rq",
- n->child->string);
+
+ if (p) {
free(n->child->string);
- n->child->string = buf;
+ n->child->string = mandoc_strdup(p);
return(1);
}
+ sz = strlen(n->child->string) +
+ 2 + strlen("\\(lqlibrary\\(rq");
+ buf = mandoc_malloc(sz);
+ snprintf(buf, sz, "library \\(lq%s\\(rq", n->child->string);
free(n->child->string);
- n->child->string = strdup(p);
- if (NULL == n->child->string)
- return(mdoc_nerr(m, n, EMALLOC));
-
+ n->child->string = buf;
return(1);
}
+/*
+ * Substitute the value of `St' for the corresponding formatted string.
+ * We're guaranteed that this exists (it's been verified during the
+ * validation phase).
+ */
+/* ARGSUSED */
static int
post_st(POST_ARGS)
{
p = mdoc_a2st(n->child->string);
assert(p);
free(n->child->string);
- n->child->string = strdup(p);
- if (NULL == n->child->string)
- return(mdoc_nerr(m, n, EMALLOC));
-
+ n->child->string = mandoc_strdup(p);
return(1);
}
+/*
+ * Look up the standard string in a table. We know that it exists from
+ * the validation phase, so assert on failure. If a standard key wasn't
+ * supplied, supply the default ``AT&T UNIX''.
+ */
static int
post_at(POST_ARGS)
{
p = mdoc_a2att(n->child->string);
assert(p);
free(n->child->string);
- n->child->string = strdup(p);
- if (NULL == n->child->string)
- return(mdoc_nerr(m, n, EMALLOC));
+ n->child->string = mandoc_strdup(p);
return(1);
}
nn = n;
m->next = MDOC_NEXT_CHILD;
-
if ( ! mdoc_word_alloc(m, nn->line, nn->pos, "AT&T UNIX"))
return(0);
m->last = nn;
-
return(1);
}
+/*
+ * Mark the current section. The ``named'' section (lastnamed) is set
+ * whenever the current section isn't a custom section--we use this to
+ * keep track of section ordering. Also check that the section is
+ * allowed within the document's manual section.
+ */
static int
post_sh(POST_ARGS)
{
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.
- */
+ char buf[BUFSIZ];
if (MDOC_HEAD != n->type)
return(1);
- buf[0] = 0;
- if ( ! concat(m, n->child, buf, sizeof(buf)))
+ if ( ! concat(m, buf, n->child, BUFSIZ))
return(0);
- if (SEC_CUSTOM != (sec = mdoc_atosec(buf)))
+ sec = mdoc_atosec(buf);
+ if (SEC_CUSTOM != sec)
m->lastnamed = sec;
+ /* Some sections only live in certain manual sections. */
+
switch ((m->lastsec = sec)) {
case (SEC_RETURN_VALUES):
/* FALLTHROUGH */
}
+/*
+ * Parse out the contents of `Dt'. See in-line documentation for how we
+ * handle the various fields of this macro.
+ */
static int
post_dt(POST_ARGS)
{
*/
if (NULL == (nn = n->child)) {
- if (NULL == (m->meta.title = strdup("unknown")))
- return(mdoc_nerr(m, n, EMALLOC));
- if (NULL == (m->meta.vol = strdup("local")))
- return(mdoc_nerr(m, n, EMALLOC));
+ /* XXX: make these macro values. */
+ m->meta.title = mandoc_strdup("unknown");
+ m->meta.vol = mandoc_strdup("local");
return(post_prol(m, n));
}
* --> title = TITLE, volume = local, msec = 0, arch = NULL
*/
- if (NULL == (m->meta.title = strdup(nn->string)))
- return(mdoc_nerr(m, n, EMALLOC));
+ m->meta.title = mandoc_strdup(nn->string);
if (NULL == (nn = nn->next)) {
- if (NULL == (m->meta.vol = strdup("local")))
- return(mdoc_nerr(m, n, EMALLOC));
+ /* XXX: make this a macro value. */
+ m->meta.vol = mandoc_strdup("local");
return(post_prol(m, n));
}
cp = mdoc_a2msec(nn->string);
if (cp) {
- if (NULL == (m->meta.vol = strdup(cp)))
- return(mdoc_nerr(m, n, EMALLOC));
- errno = 0;
+ /* FIXME: where is strtonum!? */
+ m->meta.vol = mandoc_strdup(cp);
lval = strtol(nn->string, &ep, 10);
if (nn->string[0] != '\0' && *ep == '\0')
m->meta.msec = (int)lval;
- } else if (NULL == (m->meta.vol = strdup(nn->string)))
- return(mdoc_nerr(m, n, EMALLOC));
+ } else
+ m->meta.vol = mandoc_strdup(nn->string);
if (NULL == (nn = nn->next))
return(post_prol(m, n));
cp = mdoc_a2vol(nn->string);
if (cp) {
free(m->meta.vol);
- if (NULL == (m->meta.vol = strdup(cp)))
- return(mdoc_nerr(m, n, EMALLOC));
+ m->meta.vol = mandoc_strdup(cp);
} else {
cp = mdoc_a2arch(nn->string);
if (NULL == cp) {
free(m->meta.vol);
- if (NULL == (m->meta.vol = strdup(nn->string)))
- return(mdoc_nerr(m, n, EMALLOC));
- } else if (NULL == (m->meta.arch = strdup(cp)))
- return(mdoc_nerr(m, n, EMALLOC));
+ m->meta.vol = mandoc_strdup(nn->string);
+ } else
+ m->meta.arch = mandoc_strdup(cp);
}
/* Ignore any subsequent parameters... */
+ /* FIXME: warn about subsequent parameters. */
return(post_prol(m, n));
}
+/*
+ * Set the operating system by way of the `Os' macro. Note that if an
+ * argument isn't provided and -DOSNAME="\"foo\"" is provided during
+ * compilation, this value will be used instead of filling in "sysname
+ * release" from uname().
+ */
static int
post_os(POST_ARGS)
{
- char buf[64];
+ char buf[BUFSIZ];
+#ifndef OSNAME
struct utsname utsname;
+#endif
if (m->meta.os)
free(m->meta.os);
- buf[0] = 0;
- if ( ! concat(m, n->child, buf, sizeof(buf)))
+ if ( ! concat(m, buf, n->child, BUFSIZ))
return(0);
- if (0 == buf[0]) {
+ if ('\0' == buf[0]) {
+#ifdef OSNAME
+ if (strlcat(buf, OSNAME, BUFSIZ) >= BUFSIZ)
+ return(mdoc_nerr(m, n, EUTSNAME));
+#else /*!OSNAME */
if (-1 == uname(&utsname))
return(mdoc_nerr(m, n, EUTSNAME));
- if (strlcat(buf, utsname.sysname, 64) >= 64)
+ if (strlcat(buf, utsname.sysname, BUFSIZ) >= BUFSIZ)
return(mdoc_nerr(m, n, ETOOLONG));
- if (strlcat(buf, " ", 64) >= 64)
+ if (strlcat(buf, " ", 64) >= BUFSIZ)
return(mdoc_nerr(m, n, ETOOLONG));
- if (strlcat(buf, utsname.release, 64) >= 64)
+ if (strlcat(buf, utsname.release, BUFSIZ) >= BUFSIZ)
return(mdoc_nerr(m, n, ETOOLONG));
+#endif /*!OSNAME*/
}
- if (NULL == (m->meta.os = strdup(buf)))
- return(mdoc_nerr(m, n, EMALLOC));
-
+ m->meta.os = mandoc_strdup(buf);
return(post_prol(m, n));
}
/*
* Calculate the -width for a `Bl -tag' list if it hasn't been provided.
- * Uses the first head macro.
+ * Uses the first head macro. NOTE AGAIN: this is ONLY if the -width
+ * argument has NOT been provided. See post_bl_width() for converting
+ * the -width string.
*/
static int
post_bl_tagwidth(POST_ARGS)
{
- struct mdoc_node *nn;
- int sz;
- char buf[32];
+ struct mdoc_node *nn;
+ size_t sz;
+ int i;
+ char buf[NUMSIZ];
- /*
- * Use the text width, if a text node, or the default macro
- * width if a macro.
- */
+ /* Defaults to ten ens. */
+ sz = 10; /* XXX: make this a macro value. */
nn = n->body->child;
+
if (nn) {
assert(MDOC_BLOCK == nn->type);
assert(MDOC_It == nn->tok);
nn = nn->head->child;
- }
-
- sz = 10; /* Default size. */
-
- if (nn) {
if (MDOC_TEXT != nn->type) {
- if (0 == (sz = (int)mdoc_macro2len(nn->tok)))
+ sz = mdoc_macro2len(nn->tok);
+ if (sz == 0) {
if ( ! mdoc_nwarn(m, n, ENOWIDTH))
return(0);
+ sz = 10;
+ }
} else
- sz = (int)strlen(nn->string) + 1;
+ sz = strlen(nn->string) + 1;
}
- if (-1 == snprintf(buf, sizeof(buf), "%dn", sz))
- return(mdoc_nerr(m, n, ENUMFMT));
+ snprintf(buf, NUMSIZ, "%zun", sz);
/*
* We have to dynamically add this to the macro's argument list.
nn = n;
assert(nn->args);
- sz = (int)(nn->args->argc)++;
+ i = (int)(nn->args->argc)++;
- nn->args->argv = realloc(nn->args->argv,
+ nn->args->argv = mandoc_realloc(nn->args->argv,
nn->args->argc * sizeof(struct mdoc_argv));
- if (NULL == nn->args->argv)
- return(mdoc_nerr(m, n, EMALLOC));
-
- nn->args->argv[sz].arg = MDOC_Width;
- nn->args->argv[sz].line = n->line;
- nn->args->argv[sz].pos = n->pos;
- nn->args->argv[sz].sz = 1;
- nn->args->argv[sz].value = calloc(1, sizeof(char *));
-
- if (NULL == nn->args->argv[sz].value)
- return(mdoc_nerr(m, n, EMALLOC));
- if (NULL == (nn->args->argv[sz].value[0] = strdup(buf)))
- return(mdoc_nerr(m, n, EMALLOC));
-
+ nn->args->argv[i].arg = MDOC_Width;
+ nn->args->argv[i].line = n->line;
+ nn->args->argv[i].pos = n->pos;
+ nn->args->argv[i].sz = 1;
+ nn->args->argv[i].value = mandoc_malloc(sizeof(char *));
+ nn->args->argv[i].value[0] = mandoc_strdup(buf);
return(1);
}
+/*
+ * Calculate the real width of a list from the -width string, which may
+ * contain a macro (with a known default width), a literal string, or a
+ * scaling width.
+ */
static int
post_bl_width(POST_ARGS)
{
size_t width;
int i, tok;
- char buf[32];
+ char buf[NUMSIZ];
char *p;
if (NULL == n->args)
*/
if (0 == strcmp(p, "Ds"))
+ /* XXX: make into a macro. */
width = 6;
else if (MDOC_MAX == (tok = mdoc_hash_find(p)))
return(1);
/* The value already exists: free and reallocate it. */
- if (-1 == snprintf(buf, sizeof(buf), "%zun", width))
- return(mdoc_nerr(m, n, ENUMFMT));
-
+ snprintf(buf, NUMSIZ, "%zun", width);
free(n->args->argv[i].value[0]);
- n->args->argv[i].value[0] = strdup(buf);
- if (NULL == n->args->argv[i].value[0])
- return(mdoc_nerr(m, n, EMALLOC));
-
+ n->args->argv[i].value[0] = mandoc_strdup(buf);
return(1);
}
+/*
+ * Do processing for -column lists, which can have two distinct styles
+ * of invocation. Merge this two styles into a consistent form.
+ */
/* ARGSUSED */
static int
post_bl_head(POST_ARGS)
if (MDOC_Column == np->args->argv[c].arg)
break;
- /* Only process -column. */
-
if (c == (int)np->args->argc)
return(1);
-
assert(0 == np->args->argv[c].sz);
/*
*/
np->args->argv[c].sz = (size_t)n->nchild;
- np->args->argv[c].value = malloc
+ np->args->argv[c].value = mandoc_malloc
((size_t)n->nchild * sizeof(char *));
for (i = 0, nn = n->child; nn; i++) {
n->nchild = 0;
n->child = NULL;
-
return(1);
}
}
+/*
+ * The `Pa' macro defaults to a tilde if no value is provided as an
+ * argument.
+ */
static int
-post_tilde(POST_ARGS)
+post_pa(POST_ARGS)
{
struct mdoc_node *np;
np = n;
m->next = MDOC_NEXT_CHILD;
-
- /* XXX: not documented for `Lk'. */
+ /* XXX: make into macro value. */
if ( ! mdoc_word_alloc(m, n->line, n->pos, "~"))
return(0);
m->last = np;
-
return(1);
}
+/*
+ * The `Ar' macro defaults to two strings "file ..." if no value is
+ * provided as an argument.
+ */
static int
post_ar(POST_ARGS)
{
np = n;
m->next = MDOC_NEXT_CHILD;
+ /* XXX: make into macro values. */
if ( ! mdoc_word_alloc(m, n->line, n->pos, "file"))
return(0);
if ( ! mdoc_word_alloc(m, n->line, n->pos, "..."))
return(0);
m->last = np;
-
return(1);
}
+/*
+ * Parse the date field in `Dd'.
+ */
static int
post_dd(POST_ARGS)
{
- char buf[64];
+ char buf[DATESIZ];
- buf[0] = 0;
- if ( ! concat(m, n->child, buf, sizeof(buf)))
+ if ( ! concat(m, buf, n->child, DATESIZ))
return(0);
- if (0 == (m->meta.date = mdoc_atotime(buf))) {
+ m->meta.date = mandoc_a2time
+ (MTIME_MDOCDATE | MTIME_CANONICAL, buf);
+
+ if (0 == m->meta.date) {
if ( ! mdoc_nwarn(m, n, EBADDATE))
return(0);
m->meta.date = time(NULL);
}
+/*
+ * Remove prologue macros from the document after they're processed.
+ * The final document uses mdoc_meta for these values and discards the
+ * originals.
+ */
static int
post_prol(POST_ARGS)
{
struct mdoc_node *np;
- /* Remove prologue macros from AST. */
-
if (n->parent->child == n)
n->parent->child = n->prev;
if (n->prev)
}
+/*
+ * Trigger a literal context.
+ */
static int
pre_dl(PRE_ARGS)
{
}
+/* ARGSUSED */
+static int
+pre_offset(PRE_ARGS)
+{
+ int i;
+
+ /*
+ * Make sure that an empty offset produces an 8n length space as
+ * stipulated by mdoc.samples.
+ */
+
+ assert(n->args);
+ for (i = 0; i < (int)n->args->argc; i++) {
+ if (MDOC_Offset != n->args->argv[i].arg)
+ continue;
+ if (n->args->argv[i].sz)
+ break;
+ assert(1 == n->args->refcnt);
+ /* If no value set, length of <string>. */
+ n->args->argv[i].sz++;
+ n->args->argv[i].value = mandoc_malloc(sizeof(char *));
+ n->args->argv[i].value[0] = mandoc_strdup("8n");
+ break;
+ }
+
+ return(1);
+}
+
+
+static int
+pre_bl(PRE_ARGS)
+{
+
+ return(MDOC_BLOCK == n->type ? pre_offset(m, n) : 1);
+}
+
+
static int
pre_bd(PRE_ARGS)
{
int i;
+ if (MDOC_BLOCK == n->type)
+ return(pre_offset(m, n));
if (MDOC_BODY != n->type)
return(1);
/* Enter literal context if `Bd -literal' or `-unfilled'. */
- /*
- * TODO: `-offset' without an argument should be the width of
- * the literal "<string>".
- */
-
for (n = n->parent, i = 0; i < (int)n->args->argc; i++)
if (MDOC_Literal == n->args->argv[i].arg)
- break;
+ m->flags |= MDOC_LITERAL;
else if (MDOC_Unfilled == n->args->argv[i].arg)
- break;
-
- if (i < (int)n->args->argc)
- m->flags |= MDOC_LITERAL;
+ m->flags |= MDOC_LITERAL;
return(1);
}
}
+static inline int
+order_rs(int t)
+{
+ int i;
+
+ for (i = 0; i < RSORD_MAX; i++)
+ if (rsord[i] == t)
+ return(i);
+
+ abort();
+ /* NOTREACHED */
+}
+
+
+/* ARGSUSED */
+static int
+post_rs(POST_ARGS)
+{
+ struct mdoc_node *nn, *next, *prev;
+ int o;
+
+ if (MDOC_BLOCK != n->type)
+ return(1);
+
+ assert(n->body->child);
+ for (next = NULL, nn = n->body->child->next; nn; nn = next) {
+ o = order_rs(nn->tok);
+
+ /* Remove `nn' from the chain. */
+ next = nn->next;
+ if (next)
+ next->prev = nn->prev;
+
+ prev = nn->prev;
+ if (prev)
+ prev->next = nn->next;
+
+ nn->prev = nn->next = NULL;
+
+ /*
+ * Scan back until we reach a node that's ordered before
+ * us, then set ourselves as being the next.
+ */
+ for ( ; prev; prev = prev->prev)
+ if (order_rs(prev->tok) <= o)
+ break;
+
+ nn->prev = prev;
+ if (prev) {
+ if (prev->next)
+ prev->next->prev = nn;
+ nn->next = prev->next;
+ prev->next = nn;
+ continue;
+ }
+
+ n->body->child->prev = nn;
+ nn->next = n->body->child;
+ n->body->child = nn;
+ }
+ return(1);
+}
git.ckatri.com / mandoc.git / blobdiff