-/* $Id: mdoc.c,v 1.23 2009/01/08 14:55:59 kristaps Exp $ */
+/* $Id: mdoc.c,v 1.39 2009/01/20 12:51:28 kristaps Exp $ */
/*
* Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
*
const struct mdoc_macro __mdoc_macros[MDOC_MAX] = {
{ NULL, 0 }, /* \" */
- { macro_prologue, MDOC_PROLOGUE }, /* Dd */
- { macro_prologue, MDOC_PROLOGUE }, /* Dt */
- { macro_prologue, MDOC_PROLOGUE }, /* Os */
+ { 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_close, MDOC_EXPLICIT }, /* Ed */
{ macro_scoped, MDOC_EXPLICIT }, /* Bl */
- { macro_close_explicit, 0 }, /* El */
- { macro_scoped, MDOC_NESTED | MDOC_PARSED }, /* It */
+ { macro_scoped_close, MDOC_EXPLICIT }, /* El */
+ { macro_scoped, MDOC_PARSED | MDOC_TABSEP}, /* It */
{ macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */
- { macro_constant, MDOC_PARSED }, /* An */
+ { macro_text, MDOC_PARSED }, /* An */
{ macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ar */
{ macro_constant, MDOC_QUOTABLE }, /* Cd */
{ macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Cm */
{ 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_PARSED | MDOC_QUOTABLE }, /* Ft */
{ macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ic */
{ macro_constant, 0 }, /* In */
{ macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Li */
{ 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_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ac */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Ao */
{ macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Aq */
- { macro_constant, 0 }, /* At */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Bc */
+ { macro_constant_delimited, 0 }, /* At */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Bc */
{ macro_scoped, MDOC_EXPLICIT }, /* Bf */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Bo */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* 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_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Dc */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Do */
{ macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Dq */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Ec */
- { macro_close_explicit, 0 }, /* Ef */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Ec */
+ { macro_scoped_close, MDOC_EXPLICIT }, /* Ef */
{ macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Em */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Eo */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* 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_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Pc */
+ { macro_constant_delimited, MDOC_PARSED }, /* Pf */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Po */
{ macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Pq */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Qc */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Qc */
{ macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ql */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* Qo */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Qo */
{ macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Qq */
- { macro_close_explicit, 0 }, /* Re */
+ { macro_scoped_close, MDOC_EXPLICIT }, /* Re */
{ macro_scoped, MDOC_EXPLICIT }, /* Rs */
- { macro_close_explicit, MDOC_CALLABLE | MDOC_PARSED }, /* Sc */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED }, /* So */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Sc */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* 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 */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Xc */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* 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_close, MDOC_EXPLICIT | MDOC_PARSED }, /* Fc */
+ { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Oo */
+ { macro_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Oc */
{ macro_scoped, MDOC_EXPLICIT }, /* Bk */
- { macro_close_explicit, 0 }, /* Ek */
+ { macro_scoped_close, MDOC_EXPLICIT }, /* Ek */
{ macro_constant, 0 }, /* Bt */
{ macro_constant, 0 }, /* Hf */
{ macro_obsolete, 0 }, /* Fr */
static void argcpy(struct mdoc_arg *,
const struct mdoc_arg *);
-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 *);
const struct mdoc_node *
-mdoc_result(struct mdoc *mdoc)
+mdoc_node(struct mdoc *mdoc)
{
return(mdoc->first);
}
+const struct mdoc_meta *
+mdoc_meta(struct mdoc *mdoc)
+{
+
+ return(&mdoc->meta);
+}
+
+
void
mdoc_free(struct mdoc *mdoc)
{
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);
+
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;
+ p->first = p->last;
+
+ p->next = MDOC_NEXT_CHILD;
p->htab = mdoc_tokhash_alloc();
+
return(p);
}
if (MDOC_HALT & mdoc->flags)
return(0);
+ mdoc->linetok = 0;
+
if ('.' != *buf) {
- if (SEC_PROLOGUE != mdoc->sec_lastn) {
- mdoc_word_alloc(mdoc, line, 0, buf);
- mdoc->next = MDOC_NEXT_SIBLING;
- return(1);
- }
- return(mdoc_perr(mdoc, line, 0, ERR_SYNTAX_NOTEXT));
+ if ( ! (MDOC_BODYPARSE & mdoc->flags))
+ return(mdoc_perr(mdoc, line, 0, "text disallowed"));
+ if ( ! mdoc_word_alloc(mdoc, line, 0, buf))
+ return(0);
+ mdoc->next = MDOC_NEXT_SIBLING;
+ return(1);
}
if (buf[1] && '\\' == buf[1])
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]))
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) &&
+ ! (MDOC_BODYPARSE & mdoc->flags))
+ return(mdoc_perr(mdoc, ln, ppos, "macro disallowed: not in document body"));
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 *nn, *on, *nt, *ot, *act;
+ const char *nn, *nt, *on, *ot, *act;
+
+ assert(mdoc->last);
+ assert(mdoc->first);
+ assert(MDOC_ROOT != p->type);
+
+ /* See if we exceed the suggest line-max. */
switch (p->type) {
case (MDOC_TEXT):
- nn = p->data.text.string;
- nt = "text";
- break;
- case (MDOC_BODY):
- nn = mdoc_macronames[p->data.body.tok];
- nt = "body";
- break;
+ /* FALLTHROUGH */
case (MDOC_ELEM):
- nn = mdoc_macronames[p->data.elem.tok];
- nt = "elem";
- break;
- case (MDOC_HEAD):
- nn = mdoc_macronames[p->data.head.tok];
- nt = "head";
- break;
- case (MDOC_TAIL):
- nn = mdoc_macronames[p->data.tail.tok];
- nt = "tail";
- break;
+ /* FALLTHROUGH */
case (MDOC_BLOCK):
- nn = mdoc_macronames[p->data.block.tok];
- nt = "block";
+ mdoc->linetok++;
break;
default:
- abort();
- /* NOTREACHED */
+ break;
}
- if (NULL == mdoc->first) {
- assert(NULL == mdoc->last);
- if ( ! mdoc_valid_pre(mdoc, p))
+ 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);
- if ( ! mdoc_action_pre(mdoc, p))
- return(0);
- mdoc->first = p;
- mdoc->last = p;
- mdoc_msg(mdoc, "parse: root %s `%s'", nt, nn);
- return(1);
- }
- switch (mdoc->last->type) {
- case (MDOC_TEXT):
+ if (MDOC_TEXT == mdoc->last->type)
on = "<text>";
- ot = "text";
- break;
- case (MDOC_BODY):
- on = mdoc_macronames[mdoc->last->data.body.tok];
- ot = "body";
- break;
- case (MDOC_ELEM):
- on = mdoc_macronames[mdoc->last->data.elem.tok];
- ot = "elem";
- break;
- case (MDOC_HEAD):
- on = mdoc_macronames[mdoc->last->data.head.tok];
- ot = "head";
- break;
- case (MDOC_TAIL):
- on = mdoc_macronames[mdoc->last->data.tail.tok];
- ot = "tail";
- break;
- case (MDOC_BLOCK):
- on = mdoc_macronames[mdoc->last->data.block.tok];
- ot = "block";
- break;
- default:
- abort();
- /* NOTREACHED */
- }
+ else if (MDOC_ROOT == mdoc->last->type)
+ on = "<root>";
+ else
+ on = mdoc_macronames[mdoc->last->tok];
+
+ if (MDOC_TEXT == p->type)
+ nn = "<text>";
+ else if (MDOC_ROOT == p->type)
+ nn = "<root>";
+ else
+ nn = mdoc_macronames[p->tok];
+
+ ot = mdoc_type2a(mdoc->last->type);
+ nt = mdoc_type2a(p->type);
switch (mdoc->next) {
case (MDOC_NEXT_SIBLING):
if ( ! mdoc_valid_pre(mdoc, p))
return(0);
- if ( ! mdoc_action_pre(mdoc, p))
- return(0);
+
+ switch (p->type) {
+ case (MDOC_HEAD):
+ assert(MDOC_BLOCK == p->parent->type);
+ p->parent->data.block.head = p;
+ break;
+ case (MDOC_TAIL):
+ assert(MDOC_BLOCK == p->parent->type);
+ p->parent->data.block.tail = p;
+ break;
+ case (MDOC_BODY):
+ assert(MDOC_BLOCK == p->parent->type);
+ p->parent->data.block.body = p;
+ break;
+ default:
+ break;
+ }
+
mdoc->last = p;
- mdoc_msg(mdoc, "parse: %s of %s `%s'", act, ot, on);
+ mdoc_msg(mdoc, "parse: %s `%s' %s of %s `%s'",
+ nt, nn, act, ot, on);
return(1);
}
p->line = line;
p->pos = pos;
p->type = MDOC_TAIL;
- p->data.tail.tok = tok;
+ p->tok = tok;
return(mdoc_node_append(mdoc, p));
}
p->line = line;
p->pos = pos;
p->type = MDOC_HEAD;
- p->data.head.tok = tok;
+ p->tok = tok;
return(mdoc_node_append(mdoc, p));
}
p->line = line;
p->pos = pos;
p->type = MDOC_BODY;
- p->data.body.tok = tok;
+ p->tok = tok;
+
+ return(mdoc_node_append(mdoc, p));
+}
+
+
+int
+mdoc_root_alloc(struct mdoc *mdoc)
+{
+ struct mdoc_node *p;
+
+ p = xcalloc(1, sizeof(struct mdoc_node));
+
+ p->type = MDOC_ROOT;
return(mdoc_node_append(mdoc, p));
}
p->pos = pos;
p->line = line;
p->type = MDOC_BLOCK;
- p->data.block.tok = tok;
+ p->tok = tok;
p->data.block.argc = argsz;
p->data.block.argv = argdup(argsz, args);
p->line = line;
p->pos = pos;
p->type = MDOC_ELEM;
- p->data.elem.tok = tok;
+ p->tok = tok;
p->data.elem.argc = argsz;
p->data.elem.argv = argdup(argsz, args);
}
-static void
+void
mdoc_node_freelist(struct mdoc_node *p)
{
{
int i;
+ dst->line = src->line;
+ dst->pos = src->pos;
dst->arg = src->arg;
if (0 == (dst->sz = src->sz))
return;
return(pp);
}
+
+/* FIXME: deprecate. */
+char *
+mdoc_node2a(struct mdoc_node *node)
+{
+ static char buf[64];
+
+ assert(node);
+
+ buf[0] = 0;
+ (void)xstrlcat(buf, mdoc_type2a(node->type), 64);
+ if (MDOC_ROOT == node->type)
+ return(buf);
+ (void)xstrlcat(buf, " `", 64);
+ if (MDOC_TEXT == node->type)
+ (void)xstrlcat(buf, node->data.text.string, 64);
+ else
+ (void)xstrlcat(buf, mdoc_macronames[node->tok], 64);
+ (void)xstrlcat(buf, "'", 64);
+
+ return(buf);
+}
+
+