-/* $Id: mdoc_action.c,v 1.1 2009/03/25 15:36:05 kristaps Exp $ */
+/* $Id: mdoc_action.c,v 1.30 2009/07/17 10:56:57 kristaps Exp $ */
/*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
+ * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
*
* Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the
- * above copyright notice and this permission notice appear in all
- * copies.
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
*
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
- * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
- * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
- * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
- * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- * PERFORMANCE OF THIS SOFTWARE.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#include <sys/utsname.h>
#include <assert.h>
-#include <err.h>
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include "libmdoc.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).
- */
-
-enum mwarn {
- WBADSEC,
- WNOWIDTH,
- WBADDATE
-};
-
#define PRE_ARGS struct mdoc *m, const struct mdoc_node *n
#define POST_ARGS struct mdoc *m
int (*post)(POST_ARGS);
};
-static int pwarn(struct mdoc *, int, int, enum mwarn);
-
static int post_ar(POST_ARGS);
+static int post_at(POST_ARGS);
static int post_bl(POST_ARGS);
-static int post_bl_width(POST_ARGS);
+static int post_bl_head(POST_ARGS);
static int post_bl_tagwidth(POST_ARGS);
+static int post_bl_width(POST_ARGS);
static int post_dd(POST_ARGS);
static int post_display(POST_ARGS);
static int post_dt(POST_ARGS);
+static int post_lb(POST_ARGS);
+static int post_lk(POST_ARGS);
static int post_nm(POST_ARGS);
static int post_os(POST_ARGS);
static int post_prol(POST_ARGS);
static int post_sh(POST_ARGS);
+static int post_st(POST_ARGS);
static int post_std(POST_ARGS);
static int pre_bd(PRE_ARGS);
static int pre_dl(PRE_ARGS);
-#define mwarn(m, t) pwarn((m), (m)->last->line, (m)->last->pos, (t))
-
const struct actions mdoc_actions[MDOC_MAX] = {
- { NULL, NULL }, /* \" */
+ { NULL, NULL }, /* Ap */
{ NULL, post_dd }, /* Dd */
{ NULL, post_dt }, /* Dt */
{ NULL, post_os }, /* Os */
{ NULL, NULL }, /* Ad */
{ NULL, NULL }, /* An */
{ NULL, post_ar }, /* Ar */
- { NULL, NULL }, /* Cd */
+ { NULL, NULL }, /* Cd */ /* FIXME: tabs are accepted! */
{ NULL, NULL }, /* Cm */
{ NULL, NULL }, /* Dv */
{ NULL, NULL }, /* Er */
{ NULL, NULL }, /* Ot */
{ NULL, NULL }, /* Pa */
{ NULL, post_std }, /* Rv */
- { NULL, NULL }, /* St */
+ { NULL, post_st }, /* St */
{ NULL, NULL }, /* Va */
{ NULL, NULL }, /* Vt */
{ NULL, NULL }, /* Xr */
{ NULL, NULL }, /* Ac */
{ NULL, NULL }, /* Ao */
{ NULL, NULL }, /* Aq */
- { NULL, NULL }, /* At */
+ { NULL, post_at }, /* At */
{ NULL, NULL }, /* Bc */
{ NULL, NULL }, /* Bf */
{ NULL, NULL }, /* Bo */
{ NULL, NULL }, /* Hf */
{ NULL, NULL }, /* Fr */
{ NULL, NULL }, /* Ud */
- { NULL, NULL }, /* Lb */
- { NULL, NULL }, /* Ap */
+ { NULL, post_lb }, /* Lb */
{ NULL, NULL }, /* Lp */
- { NULL, NULL }, /* Lk */
+ { NULL, post_lk }, /* Lk */
{ NULL, NULL }, /* Mt */
{ NULL, NULL }, /* Brq */
{ NULL, NULL }, /* Bro */
{ NULL, NULL }, /* En */
{ NULL, NULL }, /* Dx */
{ NULL, NULL }, /* %Q */
+ { NULL, NULL }, /* br */
+ { NULL, NULL }, /* sp */
};
+static int concat(struct mdoc *, const struct mdoc_node *,
+ char *, size_t);
+
+#ifdef __linux__
+extern size_t strlcat(char *, const char *, size_t);
+#endif
+
int
mdoc_action_pre(struct mdoc *m, const struct mdoc_node *n)
switch (n->type) {
case (MDOC_ROOT):
- break;
+ /* FALLTHROUGH */
case (MDOC_TEXT):
- break;
+ return(1);
default:
- if (NULL == mdoc_actions[m->last->tok].pre)
- break;
- return((*mdoc_actions[m->last->tok].pre)(m, n));
+ break;
}
- return(1);
+
+ if (NULL == mdoc_actions[n->tok].pre)
+ return(1);
+ return((*mdoc_actions[n->tok].pre)(m, n));
}
switch (m->last->type) {
case (MDOC_TEXT):
- break;
+ /* FALLTHROUGH */
case (MDOC_ROOT):
- break;
+ return(1);
default:
- if (NULL == mdoc_actions[m->last->tok].post)
- break;
- return((*mdoc_actions[m->last->tok].post)(m));
+ break;
}
- return(1);
+
+ if (NULL == mdoc_actions[m->last->tok].post)
+ return(1);
+ return((*mdoc_actions[m->last->tok].post)(m));
}
static int
-pwarn(struct mdoc *m, int line, int pos, enum mwarn type)
+concat(struct mdoc *m, const struct mdoc_node *n,
+ char *buf, size_t sz)
{
- char *p;
- int c;
- p = NULL;
- c = WARN_SYNTAX;
-
- switch (type) {
- case (WBADSEC):
- p = "inappropriate document section in manual section";
- c = WARN_COMPAT;
- break;
- case (WNOWIDTH):
- p = "cannot determine default width";
- break;
- case (WBADDATE):
- p = "malformed date syntax";
- break;
+ for ( ; n; n = n->next) {
+ assert(MDOC_TEXT == n->type);
+ if (strlcat(buf, n->string, sz) >= sz)
+ return(mdoc_nerr(m, n, ETOOLONG));
+ if (NULL == n->next)
+ continue;
+ if (strlcat(buf, " ", sz) >= sz)
+ return(mdoc_nerr(m, n, ETOOLONG));
}
- assert(p);
- return(mdoc_pwarn(m, line, pos, c, p));
+ return(1);
}
m->last->args->argv[0].value = calloc(1, sizeof(char *));
if (NULL == m->last->args->argv[0].value)
- err(1, "calloc");
+ return(mdoc_nerr(m, m->last, EMALLOC));
m->last->args->argv[0].sz = 1;
- m->last->args->argv[0].value[0] = xstrdup(m->meta.name);
+ m->last->args->argv[0].value[0] = strdup(m->meta.name);
+ if (NULL == m->last->args->argv[0].value[0])
+ return(mdoc_nerr(m, m->last, EMALLOC));
+
return(1);
}
if (m->meta.name)
return(1);
- (void)xstrlcpys(buf, m->last->child, sizeof(buf));
- m->meta.name = xstrdup(buf);
+ buf[0] = 0;
+ if ( ! concat(m, m->last->child, buf, sizeof(buf)))
+ return(0);
+
+ if (NULL == (m->meta.name = strdup(buf)))
+ return(mdoc_nerr(m, m->last, EMALLOC));
+
+ return(1);
+}
+
+
+static int
+post_lb(POST_ARGS)
+{
+ const char *p;
+ char *buf;
+ size_t sz;
+
+ assert(MDOC_TEXT == m->last->child->type);
+ p = mdoc_a2lib(m->last->child->string);
+ if (NULL == p) {
+ sz = strlen(m->last->child->string) +
+ 2 + strlen("\\(lqlibrary\\(rq");
+ buf = malloc(sz);
+ if (NULL == buf)
+ return(mdoc_nerr(m, m->last, EMALLOC));
+ (void)snprintf(buf, sz, "library \\(lq%s\\(rq",
+ m->last->child->string);
+ free(m->last->child->string);
+ m->last->child->string = buf;
+ return(1);
+ }
+
+ free(m->last->child->string);
+ m->last->child->string = strdup(p);
+ if (NULL == m->last->child->string)
+ return(mdoc_nerr(m, m->last, EMALLOC));
+ return(1);
+}
+
+
+static int
+post_st(POST_ARGS)
+{
+ const char *p;
+
+ assert(MDOC_TEXT == m->last->child->type);
+ p = mdoc_a2st(m->last->child->string);
+ assert(p);
+ free(m->last->child->string);
+ m->last->child->string = strdup(p);
+ if (NULL == m->last->child->string)
+ return(mdoc_nerr(m, m->last, EMALLOC));
+ return(1);
+}
+
+
+static int
+post_at(POST_ARGS)
+{
+ struct mdoc_node *n;
+ const char *p;
+
+ if (m->last->child) {
+ assert(MDOC_TEXT == m->last->child->type);
+ p = mdoc_a2att(m->last->child->string);
+ assert(p);
+ free(m->last->child->string);
+ m->last->child->string = strdup(p);
+ if (NULL == m->last->child->string)
+ return(mdoc_nerr(m, m->last, EMALLOC));
+ return(1);
+ }
+
+ n = m->last;
+ m->next = MDOC_NEXT_CHILD;
+ if ( ! mdoc_word_alloc(m, n->line, n->pos, "AT&T UNIX"))
+ return(0);
+
+ m->last = n;
+ m->next = MDOC_NEXT_SIBLING;
return(1);
}
if (MDOC_HEAD != m->last->type)
return(1);
- (void)xstrlcpys(buf, m->last->child, sizeof(buf));
+ buf[0] = 0;
+ if ( ! concat(m, m->last->child, buf, sizeof(buf)))
+ return(0);
if (SEC_CUSTOM != (sec = mdoc_atosec(buf)))
m->lastnamed = sec;
case (9):
break;
default:
- return(mwarn(m, WBADSEC));
+ return(mdoc_nwarn(m, m->last, EBADSEC));
}
break;
default:
*/
if (NULL == (n = m->last->child)) {
- m->meta.title = xstrdup("unknown");
- m->meta.vol = xstrdup("local");
+ if (NULL == (m->meta.title = strdup("unknown")))
+ return(mdoc_nerr(m, m->last, EMALLOC));
+ if (NULL == (m->meta.vol = strdup("local")))
+ return(mdoc_nerr(m, m->last, EMALLOC));
return(post_prol(m));
}
* --> title = TITLE, volume = local, msec = 0, arch = NULL
*/
- m->meta.title = xstrdup(n->string);
+ if (NULL == (m->meta.title = strdup(n->string)))
+ return(mdoc_nerr(m, m->last, EMALLOC));
if (NULL == (n = n->next)) {
- m->meta.vol = xstrdup("local");
+ if (NULL == (m->meta.vol = strdup("local")))
+ return(mdoc_nerr(m, m->last, EMALLOC));
return(post_prol(m));
}
cp = mdoc_a2msec(n->string);
if (cp) {
- m->meta.vol = xstrdup(cp);
+ if (NULL == (m->meta.vol = strdup(cp)))
+ return(mdoc_nerr(m, m->last, EMALLOC));
errno = 0;
lval = strtol(n->string, &ep, 10);
if (n->string[0] != '\0' && *ep == '\0')
m->meta.msec = (int)lval;
- } else
- m->meta.vol = xstrdup(n->string);
+ } else if (NULL == (m->meta.vol = strdup(n->string)))
+ return(mdoc_nerr(m, m->last, EMALLOC));
if (NULL == (n = n->next))
return(post_prol(m));
cp = mdoc_a2vol(n->string);
if (cp) {
free(m->meta.vol);
- m->meta.vol = xstrdup(cp);
+ if (NULL == (m->meta.vol = strdup(cp)))
+ return(mdoc_nerr(m, m->last, EMALLOC));
n = n->next;
} else {
cp = mdoc_a2arch(n->string);
if (NULL == cp) {
free(m->meta.vol);
- m->meta.vol = xstrdup(n->string);
- } else
- m->meta.arch = xstrdup(cp);
+ if (NULL == (m->meta.vol = strdup(n->string)))
+ return(mdoc_nerr(m, m->last, EMALLOC));
+ } else if (NULL == (m->meta.arch = strdup(cp)))
+ return(mdoc_nerr(m, m->last, EMALLOC));
}
/* Ignore any subsequent parameters... */
if (m->meta.os)
free(m->meta.os);
- (void)xstrlcpys(buf, m->last->child, sizeof(buf));
+ buf[0] = 0;
+ if ( ! concat(m, m->last->child, buf, sizeof(buf)))
+ return(0);
if (0 == buf[0]) {
if (-1 == uname(&utsname))
- return(mdoc_err(m, "utsname"));
- (void)xstrlcpy(buf, utsname.sysname, sizeof(buf));
- (void)xstrlcat(buf, " ", sizeof(buf));
- (void)xstrlcat(buf, utsname.release, sizeof(buf));
+ return(mdoc_nerr(m, m->last, EUTSNAME));
+ if (strlcat(buf, utsname.sysname, 64) >= 64)
+ return(mdoc_nerr(m, m->last, ETOOLONG));
+ if (strlcat(buf, " ", 64) >= 64)
+ return(mdoc_nerr(m, m->last, ETOOLONG));
+ if (strlcat(buf, utsname.release, 64) >= 64)
+ return(mdoc_nerr(m, m->last, ETOOLONG));
}
- m->meta.os = xstrdup(buf);
- m->lastnamed = m->lastsec = SEC_BODY;
+ if (NULL == (m->meta.os = strdup(buf)))
+ return(mdoc_nerr(m, m->last, EMALLOC));
+ m->flags |= MDOC_PBODY;
return(post_prol(m));
}
* width if a macro.
*/
- if ((n = m->last->body->child)) {
+ n = m->last->body->child;
+ if (n) {
assert(MDOC_BLOCK == n->type);
assert(MDOC_It == n->tok);
n = n->head->child;
if (n) {
if (MDOC_TEXT != n->type) {
if (0 == (sz = (int)mdoc_macro2len(n->tok)))
- if ( ! mwarn(m, WNOWIDTH))
+ if ( ! mdoc_nwarn(m, m->last, ENOWIDTH))
return(0);
} else
sz = (int)strlen(n->string) + 1;
}
- (void)snprintf(buf, sizeof(buf), "%dn", sz);
+ if (-1 == snprintf(buf, sizeof(buf), "%dn", sz))
+ return(mdoc_nerr(m, m->last, ENUMFMT));
/*
* We have to dynamically add this to the macro's argument list.
n = m->last;
assert(n->args);
-
sz = (int)(n->args->argc)++;
- n->args->argv = xrealloc(n->args->argv,
+
+ n->args->argv = realloc(n->args->argv,
n->args->argc * sizeof(struct mdoc_argv));
+ if (NULL == n->args->argv)
+ return(mdoc_nerr(m, m->last, EMALLOC));
+
n->args->argv[sz].arg = MDOC_Width;
n->args->argv[sz].line = m->last->line;
n->args->argv[sz].pos = m->last->pos;
n->args->argv[sz].sz = 1;
n->args->argv[sz].value = calloc(1, sizeof(char *));
+
if (NULL == n->args->argv[sz].value)
- err(1, "calloc");
- n->args->argv[sz].value[0] = xstrdup(buf);
+ return(mdoc_nerr(m, m->last, EMALLOC));
+ if (NULL == (n->args->argv[sz].value[0] = strdup(buf)))
+ return(mdoc_nerr(m, m->last, EMALLOC));
return(1);
}
if (i == (int)m->last->args->argc)
return(1);
-
p = m->last->args->argv[i].value[0];
/*
* the macro's width as set in share/tmac/mdoc/doc-common.
*/
- if (xstrcmp(p, "Ds"))
- width = 8;
- else if (MDOC_MAX == (tok = mdoc_tokhash_find(m->htab, p)))
+ if (0 == strcmp(p, "Ds"))
+ width = 6;
+ else if (MDOC_MAX == (tok = mdoc_hash_find(m->htab, p)))
return(1);
else if (0 == (width = mdoc_macro2len(tok)))
- return(mwarn(m, WNOWIDTH));
+ return(mdoc_nwarn(m, m->last, ENOWIDTH));
/* The value already exists: free and reallocate it. */
- (void)snprintf(buf, sizeof(buf), "%zun", width);
+ if (-1 == snprintf(buf, sizeof(buf), "%zun", width))
+ return(mdoc_nerr(m, m->last, ENUMFMT));
free(m->last->args->argv[i].value[0]);
- m->last->args->argv[i].value[0] = xstrdup(buf);
+ m->last->args->argv[i].value[0] = strdup(buf);
+ if (NULL == m->last->args->argv[i].value[0])
+ return(mdoc_nerr(m, m->last, EMALLOC));
+
+ return(1);
+}
+
+
+static int
+post_bl_head(POST_ARGS)
+{
+ int i, c;
+ struct mdoc_node *n, *nn, *nnp;
+
+ if (NULL == m->last->child)
+ return(1);
+
+ n = m->last->parent;
+ assert(n->args);
+
+ for (c = 0; c < (int)n->args->argc; c++)
+ if (MDOC_Column == n->args->argv[c].arg)
+ break;
+
+ /* Only process -column. */
+
+ if (c == (int)n->args->argc)
+ return(1);
+
+ assert(0 == n->args->argv[c].sz);
+
+ /*
+ * Accomodate for new-style groff column syntax. Shuffle the
+ * child nodes, all of which must be TEXT, as arguments for the
+ * column field. Then, delete the head children.
+ */
+
+ n->args->argv[c].sz = (size_t)m->last->nchild;
+ n->args->argv[c].value = malloc
+ ((size_t)m->last->nchild * sizeof(char *));
+
+ for (i = 0, nn = m->last->child; nn; i++) {
+ n->args->argv[c].value[i] = nn->string;
+ nn->string = NULL;
+ nnp = nn;
+ nn = nn->next;
+ mdoc_node_free(nnp);
+ }
+
+ m->last->nchild = 0;
+ m->last->child = NULL;
return(1);
}
{
int i, r, len;
+ if (MDOC_HEAD == m->last->type)
+ return(post_bl_head(m));
if (MDOC_BLOCK != m->last->type)
return(1);
}
+static int
+post_lk(POST_ARGS)
+{
+ struct mdoc_node *n;
+
+ if (m->last->child)
+ return(1);
+
+ n = m->last;
+ m->next = MDOC_NEXT_CHILD;
+
+ /* XXX: this isn't documented anywhere! */
+ if ( ! mdoc_word_alloc(m, m->last->line, m->last->pos, "~"))
+ return(0);
+
+ m->last = n;
+ m->next = MDOC_NEXT_SIBLING;
+ return(1);
+}
+
+
static int
post_ar(POST_ARGS)
{
n = m->last;
m->next = MDOC_NEXT_CHILD;
- if ( ! mdoc_word_alloc(m, m->last->line,
- m->last->pos, "file"))
+ if ( ! mdoc_word_alloc(m, m->last->line, m->last->pos, "file"))
return(0);
m->next = MDOC_NEXT_SIBLING;
- if ( ! mdoc_word_alloc(m, m->last->line,
- m->last->pos, "..."))
+ if ( ! mdoc_word_alloc(m, m->last->line, m->last->pos, "..."))
return(0);
m->last = n;
{
char buf[64];
- (void)xstrlcpys(buf, m->last->child, sizeof(buf));
+ buf[0] = 0;
+ if ( ! concat(m, m->last->child, buf, sizeof(buf)))
+ return(0);
if (0 == (m->meta.date = mdoc_atotime(buf))) {
- if ( ! mwarn(m, WBADDATE))
+ if ( ! mdoc_nwarn(m, m->last, EBADDATE))
return(0);
m->meta.date = time(NULL);
}
pre_dl(PRE_ARGS)
{
- if (MDOC_BODY != n->type)
- return(1);
- m->flags |= MDOC_LITERAL;
+ if (MDOC_BODY == n->type)
+ m->flags |= MDOC_LITERAL;
return(1);
}
if (MDOC_BODY != n->type)
return(1);
- /*
- * We ONLY enter a literal context if `Bd -literal' or `Bd
- * -unfilled'.
- */
-
- n = n->parent;
+ /* Enter literal context if `Bd -literal' or * -unfilled'. */
- for (i = 0; i < (int)n->args->argc; i++)
+ for (n = n->parent, i = 0; i < (int)n->args->argc; i++)
if (MDOC_Literal == n->args->argv[i].arg)
break;
else if (MDOC_Unfilled == n->args->argv[i].arg)