-/* $Id: mdoc.c,v 1.28 2009/01/12 16:39:57 kristaps Exp $ */
+/* $Id: mdoc.c,v 1.52 2009/03/06 14:13:47 kristaps Exp $ */
/*
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
*
#include "private.h"
+/*
+ * Main caller in the libmdoc library. This begins the parsing routine,
+ * handles allocation of data, and so forth. Most of the "work" is done
+ * in macro.c and validate.c.
+ */
+
+static struct mdoc_arg *argdup(size_t, const struct mdoc_arg *);
+static void argfree(size_t, struct mdoc_arg *);
+static void argcpy(struct mdoc_arg *,
+ const struct mdoc_arg *);
+
+static struct mdoc_node *mdoc_node_alloc(const struct mdoc *);
+static int mdoc_node_append(struct mdoc *,
+ struct mdoc_node *);
+static void mdoc_elem_free(struct mdoc_elem *);
+static void mdoc_text_free(struct mdoc_text *);
+
+
const char *const __mdoc_macronames[MDOC_MAX] = {
"\\\"", "Dd", "Dt", "Os",
"Sh", "Ss", "Pp", "D1",
"Tn", "Ux", "Xc", "Xo",
"Fo", "Fc", "Oo", "Oc",
"Bk", "Ek", "Bt", "Hf",
- "Fr", "Ud",
+ "Fr", "Ud", "Lb",
};
const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
"tag", "diag", "hang",
"ohang", "inset", "column",
"width", "compact", "std",
- "p1003.1-88", "p1003.1-90", "p1003.1-96",
- "p1003.1-2001", "p1003.1-2004", "p1003.1",
- "p1003.1b", "p1003.1b-93", "p1003.1c-95",
- "p1003.1g-2000", "p1003.2-92", "p1387.2-95",
- "p1003.2", "p1387.2", "isoC-90",
- "isoC-amd1", "isoC-tcor1", "isoC-tcor2",
- "isoC-99", "ansiC", "ansiC-89",
- "ansiC-99", "ieee754", "iso8802-3",
- "xpg3", "xpg4", "xpg4.2",
- "xpg4.3", "xbd5", "xcu5",
- "xsh5", "xns5", "xns5.2d2.0",
- "xcurses4.2", "susv2", "susv3",
- "svid4", "filled", "words",
- "emphasis", "symbolic",
+ "filled", "words", "emphasis",
+ "symbolic"
};
-const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
- { NULL, 0 }, /* \" */
- { macro_constant, MDOC_PROLOGUE }, /* Dd */
- { macro_constant, MDOC_PROLOGUE }, /* Dt */
- { macro_constant, MDOC_PROLOGUE }, /* Os */
- { macro_scoped, 0 }, /* Sh */
- { macro_scoped, 0 }, /* Ss */
- { macro_text, 0 }, /* Pp */
- { macro_scoped_line, MDOC_PARSED }, /* D1 */
- { macro_scoped_line, MDOC_PARSED }, /* Dl */
- { macro_scoped, MDOC_EXPLICIT }, /* Bd */
- { macro_close_explicit, 0 }, /* Ed */
- { macro_scoped, MDOC_EXPLICIT }, /* Bl */
- { macro_close_explicit, 0 }, /* El */
- { macro_scoped, MDOC_NESTED | MDOC_PARSED | MDOC_TABSEP}, /* It */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */
- { macro_constant, MDOC_PARSED }, /* An */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
- { macro_constant, MDOC_QUOTABLE }, /* Cd */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Dv */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Er */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ev */
- { macro_constant, 0 }, /* Ex */
- { macro_text, MDOC_CALLABLE | MDOC_QUOTABLE | MDOC_PARSED }, /* Fa */
- { macro_constant, 0 }, /* Fd */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Fl */
- { macro_text, MDOC_CALLABLE | MDOC_QUOTABLE | MDOC_PARSED }, /* Fn */
- { macro_text, MDOC_PARSED }, /* Ft */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */
- { macro_constant, 0 }, /* In */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Li */
- { macro_constant, 0 }, /* Nd */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Nm */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Op */
- { macro_obsolete, 0 }, /* Ot */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Pa */
- { macro_constant, 0 }, /* Rv */
- /* XXX - .St supposed to be (but isn't) callable. */
- { macro_constant_delimited, MDOC_PARSED }, /* St */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Va */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Vt */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Xr */
- { macro_constant, MDOC_QUOTABLE }, /* %A */
- { macro_constant, MDOC_QUOTABLE }, /* %B */
- { macro_constant, MDOC_QUOTABLE }, /* %D */
- { macro_constant, MDOC_QUOTABLE }, /* %I */
- { macro_constant, MDOC_QUOTABLE }, /* %J */
- { macro_constant, MDOC_QUOTABLE }, /* %N */
- { macro_constant, MDOC_QUOTABLE }, /* %O */
- { macro_constant, MDOC_QUOTABLE }, /* %P */
- { macro_constant, MDOC_QUOTABLE }, /* %R */
- { macro_constant, MDOC_QUOTABLE }, /* %T */
- { macro_constant, MDOC_QUOTABLE }, /* %V */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Ac */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Ao */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */
- { macro_constant, 0 }, /* At */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Bc */
- { macro_scoped, MDOC_EXPLICIT }, /* Bf */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Bo */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Bq */
- { macro_constant_delimited, MDOC_PARSED }, /* Bsx */
- { macro_constant_delimited, MDOC_PARSED }, /* Bx */
- { macro_constant, 0 }, /* Db */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Dc */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Do */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dq */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Ec */
- { macro_close_explicit, 0 }, /* Ef */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Em */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Eo */
- { macro_constant_delimited, MDOC_PARSED }, /* Fx */
- { macro_text, MDOC_PARSED }, /* Ms */
- { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* No */
- { macro_constant_delimited, MDOC_CALLABLE | MDOC_PARSED }, /* Ns */
- { macro_constant_delimited, MDOC_PARSED }, /* Nx */
- { macro_constant_delimited, MDOC_PARSED }, /* Ox */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Pc */
- { macro_constant, MDOC_PARSED }, /* Pf */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Po */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Qc */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ql */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Qo */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Qq */
- { macro_close_explicit, 0 }, /* Re */
- { macro_scoped, MDOC_EXPLICIT }, /* Rs */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Sc */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* So */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Sq */
- { macro_constant, 0 }, /* Sm */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sx */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Sy */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Tn */
- { macro_constant_delimited, MDOC_PARSED }, /* Ux */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Xo */
- /* XXX - .Fo supposed to be (but isn't) callable. */
- { macro_scoped, MDOC_EXPLICIT | MDOC_PARSED }, /* Fo */
- /* XXX - .Fc supposed to be (but isn't) callable. */
- { macro_close_explicit, MDOC_PARSED }, /* Fc */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Oo */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Oc */
- { macro_scoped, MDOC_EXPLICIT }, /* Bk */
- { macro_close_explicit, 0 }, /* Ek */
- { macro_constant, 0 }, /* Bt */
- { macro_constant, 0 }, /* Hf */
- { macro_obsolete, 0 }, /* Fr */
- { macro_constant, 0 }, /* Ud */
-};
-
const char * const *mdoc_macronames = __mdoc_macronames;
const char * const *mdoc_argnames = __mdoc_argnames;
-const struct mdoc_macro * const mdoc_macros = __mdoc_macros;
-static struct mdoc_arg *argdup(size_t, const struct mdoc_arg *);
-static void argfree(size_t, struct mdoc_arg *);
-static void argcpy(struct mdoc_arg *,
- const struct mdoc_arg *);
+const struct mdoc_node *
+mdoc_node(const struct mdoc *mdoc)
+{
-static void mdoc_node_freelist(struct mdoc_node *);
-static int mdoc_node_append(struct mdoc *,
- struct mdoc_node *);
-static void mdoc_elem_free(struct mdoc_elem *);
-static void mdoc_text_free(struct mdoc_text *);
+ return(mdoc->first);
+}
-const struct mdoc_node *
-mdoc_result(struct mdoc *mdoc)
+const struct mdoc_meta *
+mdoc_meta(const struct mdoc *mdoc)
{
- return(mdoc->first);
+ return(&mdoc->meta);
}
mdoc_node_freelist(mdoc->first);
if (mdoc->htab)
mdoc_tokhash_free(mdoc->htab);
-
+ if (mdoc->meta.title)
+ free(mdoc->meta.title);
+ if (mdoc->meta.os)
+ free(mdoc->meta.os);
+ if (mdoc->meta.name)
+ free(mdoc->meta.name);
+ if (mdoc->meta.arch)
+ free(mdoc->meta.arch);
+ if (mdoc->meta.vol)
+ free(mdoc->meta.vol);
+
free(mdoc);
}
p = xcalloc(1, sizeof(struct mdoc));
p->data = data;
- (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
+ if (cb)
+ (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
p->last = xcalloc(1, sizeof(struct mdoc_node));
p->last->type = MDOC_ROOT;
}
+/*
+ * Main line-parsing routine. If the line is a macro-line (started with
+ * a '.' control character), then pass along to the parser, which parses
+ * subsequent macros until the end of line. If normal text, simply
+ * append the entire line to the chain.
+ */
int
mdoc_parseln(struct mdoc *mdoc, int line, char *buf)
{
if (MDOC_HALT & mdoc->flags)
return(0);
+ mdoc->linetok = 0;
+
if ('.' != *buf) {
- if (SEC_PROLOGUE != mdoc->sec_lastn) {
- if ( ! mdoc_word_alloc(mdoc, line, 0, buf))
- return(0);
- mdoc->next = MDOC_NEXT_SIBLING;
- return(1);
- }
- return(mdoc_perr(mdoc, line, 0, ERR_SYNTAX_NOTEXT));
+ /*
+ * Free-form text. Not allowed in the prologue.
+ */
+ if (SEC_PROLOGUE == mdoc->lastnamed)
+ return(mdoc_perr(mdoc, line, 0,
+ "no text in prologue"));
+
+ if ( ! mdoc_word_alloc(mdoc, line, 0, buf))
+ return(0);
+ mdoc->next = MDOC_NEXT_SIBLING;
+ return(1);
}
+ /*
+ * Control-character detected. Begin the parsing sequence.
+ */
+
if (buf[1] && '\\' == buf[1])
if (buf[2] && '\"' == buf[2])
return(1);
i = 1;
- while (buf[i] && ! isspace(buf[i]) && i < (int)sizeof(tmp))
+ while (buf[i] && ! isspace((u_char)buf[i]) &&
+ i < (int)sizeof(tmp))
i++;
if (i == (int)sizeof(tmp)) {
mdoc->flags |= MDOC_HALT;
- return(mdoc_perr(mdoc, line, 1, ERR_MACRO_NOTSUP));
+ return(mdoc_perr(mdoc, line, 1, "unknown macro"));
} else if (i <= 2) {
mdoc->flags |= MDOC_HALT;
- return(mdoc_perr(mdoc, line, 1, ERR_MACRO_NOTSUP));
+ return(mdoc_perr(mdoc, line, 1, "unknown macro"));
}
i--;
if (MDOC_MAX == (c = mdoc_find(mdoc, tmp))) {
mdoc->flags |= MDOC_HALT;
- return(mdoc_perr(mdoc, line, 1, ERR_MACRO_NOTSUP));
+ return(mdoc_perr(mdoc, line, 1, "unknown macro"));
}
- while (buf[i] && isspace(buf[i]))
+ while (buf[i] && isspace((u_char)buf[i]))
i++;
if ( ! mdoc_macro(mdoc, c, line, 1, &i, buf)) {
mdoc->flags |= MDOC_HALT;
return(0);
}
+
return(1);
}
void
-mdoc_msg(struct mdoc *mdoc, const char *fmt, ...)
+mdoc_vmsg(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
{
- struct mdoc_node *n;
- va_list ap;
char buf[256];
+ va_list ap;
if (NULL == mdoc->cb.mdoc_msg)
return;
- n = mdoc->last;
- assert(n);
-
va_start(ap, fmt);
- (void)vsnprintf(buf, sizeof(buf), fmt, ap);
+ (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
va_end(ap);
-
- (*mdoc->cb.mdoc_msg)(mdoc->data, n->line, n->pos, buf);
+ (*mdoc->cb.mdoc_msg)(mdoc->data, ln, pos, buf);
}
int
-mdoc_perr(struct mdoc *mdoc,
- int line, int pos, enum mdoc_err type)
+mdoc_verr(struct mdoc *mdoc, int ln, int pos,
+ const char *fmt, ...)
{
+ char buf[256];
+ va_list ap;
if (NULL == mdoc->cb.mdoc_err)
return(0);
- return((*mdoc->cb.mdoc_err)(mdoc->data, line, pos, type));
+
+ va_start(ap, fmt);
+ (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
+ va_end(ap);
+ return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));
}
int
-mdoc_pwarn(struct mdoc *mdoc,
- int line, int pos, enum mdoc_warn type)
+mdoc_vwarn(struct mdoc *mdoc, int ln, int pos,
+ enum mdoc_warn type, const char *fmt, ...)
{
+ char buf[256];
+ va_list ap;
if (NULL == mdoc->cb.mdoc_warn)
return(0);
- return((*mdoc->cb.mdoc_warn)(mdoc->data, line, pos, type));
+
+ va_start(ap, fmt);
+ (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
+ va_end(ap);
+ return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, type, buf));
}
int ln, int ppos, int *pos, char *buf)
{
- if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
- SEC_PROLOGUE == mdoc->sec_lastn)
- return(mdoc_perr(mdoc, ln, ppos, ERR_SEC_PROLOGUE));
-
- if (NULL == (mdoc_macros[tok].fp))
- return(mdoc_perr(mdoc, ln, ppos, ERR_MACRO_NOTSUP));
+ assert(mdoc_macros[tok].fp);
+ if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
+ SEC_PROLOGUE != mdoc->lastnamed)
+ return(mdoc_perr(mdoc, ln, ppos, "macro disallowed in document body"));
+ if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
+ SEC_PROLOGUE == mdoc->lastnamed)
+ return(mdoc_perr(mdoc, ln, ppos, "macro disallowed in document prologue"));
if (1 != ppos && ! (MDOC_CALLABLE & mdoc_macros[tok].flags))
- return(mdoc_perr(mdoc, ln, ppos, ERR_MACRO_NOTCALL));
-
+ return(mdoc_perr(mdoc, ln, ppos, "macro not callable"));
return((*mdoc_macros[tok].fp)(mdoc, tok, ln, ppos, pos, buf));
}
static int
mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p)
{
- const char *on, *ot, *act;
assert(mdoc->last);
assert(mdoc->first);
assert(MDOC_ROOT != p->type);
- if (MDOC_TEXT == mdoc->last->type)
- on = "<text>";
- else if (MDOC_ROOT == mdoc->last->type)
- on = "<root>";
- else
- on = mdoc_macronames[mdoc->last->tok];
+ /* See if we exceed the suggest line-max. */
- /* FIXME: put this into util.c. */
- switch (mdoc->last->type) {
+ switch (p->type) {
case (MDOC_TEXT):
- ot = "text";
- break;
- case (MDOC_BODY):
- ot = "body";
- break;
+ /* FALLTHROUGH */
case (MDOC_ELEM):
- ot = "elem";
- break;
- case (MDOC_HEAD):
- ot = "head";
- break;
- case (MDOC_TAIL):
- ot = "tail";
- break;
+ /* FALLTHROUGH */
case (MDOC_BLOCK):
- ot = "block";
- break;
- case (MDOC_ROOT):
- ot = "root";
+ mdoc->linetok++;
break;
default:
- abort();
- /* NOTREACHED */
+ break;
}
+ /* This sort-of works (re-opening of text macros...). */
+ if (mdoc->linetok > MDOC_LINEARG_SOFTMAX)
+ if ( ! mdoc_nwarn(mdoc, p, WARN_COMPAT,
+ "suggested %d tokens per line exceeded (has %d)",
+ MDOC_LINEARG_SOFTMAX, mdoc->linetok))
+ return(0);
+
switch (mdoc->next) {
case (MDOC_NEXT_SIBLING):
mdoc->last->next = p;
p->prev = mdoc->last;
p->parent = mdoc->last->parent;
- act = "sibling";
break;
case (MDOC_NEXT_CHILD):
mdoc->last->child = p;
p->parent = mdoc->last;
- act = "child";
break;
default:
abort();
if ( ! mdoc_valid_pre(mdoc, p))
return(0);
- if ( ! mdoc_action_pre(mdoc, p))
- return(0);
switch (p->type) {
case (MDOC_HEAD):
}
mdoc->last = p;
- mdoc_msg(mdoc, "parse: %s of %s `%s'", act, ot, on);
return(1);
}
+static struct mdoc_node *
+mdoc_node_alloc(const struct mdoc *mdoc)
+{
+ struct mdoc_node *p;
+
+ p = xcalloc(1, sizeof(struct mdoc_node));
+ p->sec = mdoc->lastsec;
+
+ return(p);
+}
+
+
int
mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok)
{
assert(mdoc->first);
assert(mdoc->last);
- p = xcalloc(1, sizeof(struct mdoc_node));
+ p = mdoc_node_alloc(mdoc);
p->line = line;
p->pos = pos;
assert(mdoc->first);
assert(mdoc->last);
- p = xcalloc(1, sizeof(struct mdoc_node));
+ p = mdoc_node_alloc(mdoc);
p->line = line;
p->pos = pos;
assert(mdoc->first);
assert(mdoc->last);
- p = xcalloc(1, sizeof(struct mdoc_node));
+ p = mdoc_node_alloc(mdoc);
p->line = line;
p->pos = pos;
{
struct mdoc_node *p;
- p = xcalloc(1, sizeof(struct mdoc_node));
+ p = mdoc_node_alloc(mdoc);
p->type = MDOC_ROOT;
{
struct mdoc_node *p;
- p = xcalloc(1, sizeof(struct mdoc_node));
+ p = mdoc_node_alloc(mdoc);
p->pos = pos;
p->line = line;
{
struct mdoc_node *p;
- p = xcalloc(1, sizeof(struct mdoc_node));
+ p = mdoc_node_alloc(mdoc);
p->line = line;
p->pos = pos;
{
struct mdoc_node *p;
- p = xcalloc(1, sizeof(struct mdoc_node));
+ p = mdoc_node_alloc(mdoc);
+
p->line = line;
p->pos = pos;
p->type = MDOC_TEXT;
}
-static void
+void
mdoc_node_freelist(struct mdoc_node *p)
{
git.ckatri.com / mandoc.git / blobdiff