-/* $Id: mdoc.c,v 1.40 2009/01/20 13:05:28 kristaps Exp $ */
+/* $Id: mdoc.c,v 1.116 2010/01/07 10:24:43 kristaps Exp $ */
/*
- * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
+ * 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.
*/
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <sys/types.h>
+
#include <assert.h>
#include <ctype.h>
-#include <err.h>
#include <stdarg.h>
-#include <stdlib.h>
#include <stdio.h>
+#include <stdlib.h>
#include <string.h>
-#include "private.h"
+#include "libmdoc.h"
+#include "libmandoc.h"
+
+const char *const __mdoc_merrnames[MERRMAX] = {
+ "trailing whitespace", /* ETAILWS */
+ "unexpected quoted parameter", /* EQUOTPARM */
+ "unterminated quoted parameter", /* EQUOTTERM */
+ "argument parameter suggested", /* EARGVAL */
+ "macro disallowed in prologue", /* EBODYPROL */
+ "macro disallowed in body", /* EPROLBODY */
+ "text disallowed in prologue", /* ETEXTPROL */
+ "blank line disallowed", /* ENOBLANK */
+ "text parameter too long", /* ETOOLONG */
+ "invalid escape sequence", /* EESCAPE */
+ "invalid character", /* EPRINT */
+ "document has no body", /* ENODAT */
+ "document has no prologue", /* ENOPROLOGUE */
+ "expected line arguments", /* ELINE */
+ "invalid AT&T argument", /* EATT */
+ "default name not yet set", /* ENAME */
+ "missing list type", /* ELISTTYPE */
+ "missing display type", /* EDISPTYPE */
+ "too many display types", /* EMULTIDISP */
+ "too many list types", /* EMULTILIST */
+ "NAME section must be first", /* ESECNAME */
+ "badly-formed NAME section", /* ENAMESECINC */
+ "argument repeated", /* EARGREP */
+ "expected boolean parameter", /* EBOOL */
+ "inconsistent column syntax", /* ECOLMIS */
+ "nested display invalid", /* ENESTDISP */
+ "width argument missing", /* EMISSWIDTH */
+ "invalid section for this manual section", /* EWRONGMSEC */
+ "section out of conventional order", /* ESECOOO */
+ "section repeated", /* ESECREP */
+ "invalid standard argument", /* EBADSTAND */
+ "multi-line arguments discouraged", /* ENOMULTILINE */
+ "multi-line arguments suggested", /* EMULTILINE */
+ "line arguments discouraged", /* ENOLINE */
+ "prologue macro out of conventional order", /* EPROLOOO */
+ "prologue macro repeated", /* EPROLREP */
+ "invalid manual section", /* EBADMSEC */
+ "invalid section", /* EBADSEC */
+ "invalid font mode", /* EFONT */
+ "invalid date syntax", /* EBADDATE */
+ "invalid number format", /* ENUMFMT */
+ "superfluous width argument", /* ENOWIDTH */
+ "system: utsname error", /* EUTSNAME */
+ "obsolete macro", /* EOBS */
+ "end-of-line scope violation", /* EIMPBRK */
+ "empty macro ignored", /* EIGNE */
+ "unclosed explicit scope", /* EOPEN */
+ "unterminated quoted phrase", /* EQUOTPHR */
+ "closure macro without prior context", /* ENOCTX */
+ "no description found for library", /* ELIB */
+ "bad child for parent context", /* EBADCHILD */
+ "list arguments preceding type", /* ENOTYPE */
+};
const char *const __mdoc_macronames[MDOC_MAX] = {
- "\\\"", "Dd", "Dt", "Os",
+ "Ap", "Dd", "Dt", "Os",
"Sh", "Ss", "Pp", "D1",
"Dl", "Bd", "Ed", "Bl",
"El", "It", "Ad", "An",
"Nm", "Op", "Ot", "Pa",
"Rv", "St", "Va", "Vt",
/* LINTED */
- "Xr", "\%A", "\%B", "\%D",
+ "Xr", "%A", "%B", "%D",
/* LINTED */
- "\%I", "\%J", "\%N", "\%O",
+ "%I", "%J", "%N", "%O",
/* LINTED */
- "\%P", "\%R", "\%T", "\%V",
+ "%P", "%R", "%T", "%V",
"Ac", "Ao", "Aq", "At",
"Bc", "Bf", "Bo", "Bq",
"Bsx", "Bx", "Db", "Dc",
"Tn", "Ux", "Xc", "Xo",
"Fo", "Fc", "Oo", "Oc",
"Bk", "Ek", "Bt", "Hf",
- "Fr", "Ud",
+ "Fr", "Ud", "Lb", "Lp",
+ "Lk", "Mt", "Brq", "Bro",
+ /* LINTED */
+ "Brc", "%C", "Es", "En",
+ /* LINTED */
+ "Dx", "%Q", "br", "sp",
+ /* LINTED */
+ "%U"
};
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", "nested", "centered"
};
-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_scoped_close, MDOC_EXPLICIT }, /* Ed */
- { macro_scoped, MDOC_EXPLICIT }, /* Bl */
- { macro_scoped_close, MDOC_EXPLICIT }, /* El */
- { macro_scoped, MDOC_PARSED | MDOC_TABSEP}, /* It */
- { macro_text, MDOC_CALLABLE | MDOC_PARSED }, /* Ad */
- { 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_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 | MDOC_QUOTABLE }, /* 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_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_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 | 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_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_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 | 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_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_scoped_close, MDOC_EXPLICIT | MDOC_CALLABLE | MDOC_PARSED }, /* Qc */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Ql */
- { macro_constant_scoped, MDOC_CALLABLE | MDOC_PARSED | MDOC_EXPLICIT }, /* Qo */
- { macro_scoped_line, MDOC_CALLABLE | MDOC_PARSED }, /* Qq */
- { macro_scoped_close, MDOC_EXPLICIT }, /* Re */
- { macro_scoped, MDOC_EXPLICIT }, /* Rs */
- { 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_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_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_scoped_close, MDOC_EXPLICIT }, /* 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 *);
-
-static int mdoc_node_append(struct mdoc *,
+static void mdoc_free1(struct mdoc *);
+static void mdoc_alloc1(struct mdoc *);
+static struct mdoc_node *node_alloc(struct mdoc *, int, int,
+ int, enum mdoc_type);
+static int node_append(struct mdoc *,
struct mdoc_node *);
-static void mdoc_elem_free(struct mdoc_elem *);
-static void mdoc_text_free(struct mdoc_text *);
-
+static int parsetext(struct mdoc *, int, char *);
+static int parsemacro(struct mdoc *, int, char *);
+static int macrowarn(struct mdoc *, int, const char *);
+static int pstring(struct mdoc *, int, int,
+ const char *, size_t);
const struct mdoc_node *
-mdoc_node(struct mdoc *mdoc)
+mdoc_node(const struct mdoc *m)
{
- return(mdoc->first);
+ return(MDOC_HALT & m->flags ? NULL : m->first);
}
const struct mdoc_meta *
-mdoc_meta(struct mdoc *mdoc)
+mdoc_meta(const struct mdoc *m)
{
- return(&mdoc->meta);
+ return(MDOC_HALT & m->flags ? NULL : &m->meta);
}
-void
-mdoc_free(struct mdoc *mdoc)
+/*
+ * Frees volatile resources (parse tree, meta-data, fields).
+ */
+static void
+mdoc_free1(struct mdoc *mdoc)
{
if (mdoc->first)
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);
+ if (mdoc->meta.arch)
+ free(mdoc->meta.arch);
+ if (mdoc->meta.vol)
+ free(mdoc->meta.vol);
}
-struct mdoc *
-mdoc_alloc(void *data, const struct mdoc_cb *cb)
+/*
+ * Allocate all volatile resources (parse tree, meta-data, fields).
+ */
+static void
+mdoc_alloc1(struct mdoc *mdoc)
{
- struct mdoc *p;
- p = xcalloc(1, sizeof(struct mdoc));
-
- p->data = data;
- 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);
+ memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));
+ mdoc->flags = 0;
+ mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
+ mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
+ mdoc->first = mdoc->last;
+ mdoc->last->type = MDOC_ROOT;
+ mdoc->next = MDOC_NEXT_CHILD;
}
-int
-mdoc_endparse(struct mdoc *mdoc)
+/*
+ * Free up volatile resources (see mdoc_free1()) then re-initialises the
+ * data with mdoc_alloc1(). After invocation, parse data has been reset
+ * and the parser is ready for re-invocation on a new tree; however,
+ * cross-parse non-volatile data is kept intact.
+ */
+void
+mdoc_reset(struct mdoc *mdoc)
{
- if (MDOC_HALT & mdoc->flags)
- return(0);
- if (NULL == mdoc->first)
- return(1);
-
- assert(mdoc->last);
- if ( ! macro_end(mdoc)) {
- mdoc->flags |= MDOC_HALT;
- return(0);
- }
- return(1);
+ mdoc_free1(mdoc);
+ mdoc_alloc1(mdoc);
}
-int
-mdoc_parseln(struct mdoc *mdoc, int line, char *buf)
+/*
+ * Completely free up all volatile and non-volatile parse resources.
+ * After invocation, the pointer is no longer usable.
+ */
+void
+mdoc_free(struct mdoc *mdoc)
{
- int c, i;
- char tmp[5];
-
- if (MDOC_HALT & mdoc->flags)
- return(0);
- mdoc->linetok = 0;
+ mdoc_free1(mdoc);
+ free(mdoc);
+}
- if ('.' != *buf) {
- 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 (buf[2] && '\"' == buf[2])
- return(1);
+/*
+ * Allocate volatile and non-volatile parse resources.
+ */
+struct mdoc *
+mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)
+{
+ struct mdoc *p;
- i = 1;
- while (buf[i] && ! isspace(buf[i]) && i < (int)sizeof(tmp))
- i++;
+ p = mandoc_calloc(1, sizeof(struct mdoc));
- if (i == (int)sizeof(tmp)) {
- mdoc->flags |= MDOC_HALT;
- return(mdoc_perr(mdoc, line, 1, "unknown macro"));
- } else if (i <= 2) {
- mdoc->flags |= MDOC_HALT;
- return(mdoc_perr(mdoc, line, 1, "unknown macro"));
- }
+ if (cb)
+ memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
- i--;
+ p->data = data;
+ p->pflags = pflags;
- (void)memcpy(tmp, buf + 1, (size_t)i);
- tmp[i++] = 0;
+ mdoc_hash_init();
+ mdoc_alloc1(p);
+ return(p);
+}
- if (MDOC_MAX == (c = mdoc_find(mdoc, tmp))) {
- mdoc->flags |= MDOC_HALT;
- return(mdoc_perr(mdoc, line, 1, "unknown macro"));
- }
- while (buf[i] && isspace(buf[i]))
- i++;
+/*
+ * Climb back up the parse tree, validating open scopes. Mostly calls
+ * through to macro_end() in macro.c.
+ */
+int
+mdoc_endparse(struct mdoc *m)
+{
- if ( ! mdoc_macro(mdoc, c, line, 1, &i, buf)) {
- mdoc->flags |= MDOC_HALT;
+ if (MDOC_HALT & m->flags)
return(0);
- }
- return(1);
+ else if (mdoc_macroend(m))
+ return(1);
+ m->flags |= MDOC_HALT;
+ return(0);
}
-void
-mdoc_vmsg(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
+/*
+ * Main parse routine. Parses a single line -- really just hands off to
+ * the macro (parsemacro()) or text parser (parsetext()).
+ */
+int
+mdoc_parseln(struct mdoc *m, int ln, char *buf)
{
- char buf[256];
- va_list ap;
- if (NULL == mdoc->cb.mdoc_msg)
- return;
+ if (MDOC_HALT & m->flags)
+ return(0);
- va_start(ap, fmt);
- (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
- va_end(ap);
- (*mdoc->cb.mdoc_msg)(mdoc->data, ln, pos, buf);
+ return('.' == *buf ? parsemacro(m, ln, buf) :
+ parsetext(m, ln, buf));
}
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_vwarn(struct mdoc *mdoc, int ln, int pos,
- enum mdoc_warn type, const char *fmt, ...)
+mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
{
char buf[256];
va_list ap;
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));
+
+ return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf));
}
int
-mdoc_macro(struct mdoc *mdoc, int tok,
- int ln, int ppos, int *pos, char *buf)
+mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type)
{
+ const char *p;
+
+ p = __mdoc_merrnames[(int)type];
+ assert(p);
+
+ if (iserr)
+ return(mdoc_verr(m, line, pos, p));
+
+ return(mdoc_vwarn(m, line, pos, p));
+}
- 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, "macro not callable"));
- return((*mdoc_macros[tok].fp)(mdoc, tok, ln, ppos, pos, buf));
+int
+mdoc_macro(struct mdoc *m, int tok,
+ int ln, int pp, int *pos, char *buf)
+{
+ /*
+ * If we're in the prologue, deny "body" macros. Similarly, if
+ * we're in the body, deny prologue calls.
+ */
+ if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
+ MDOC_PBODY & m->flags)
+ return(mdoc_perr(m, ln, pp, EPROLBODY));
+ if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
+ ! (MDOC_PBODY & m->flags))
+ return(mdoc_perr(m, ln, pp, EBODYPROL));
+
+ return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
}
static int
-mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p)
+node_append(struct mdoc *mdoc, struct mdoc_node *p)
{
- 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):
- /* FALLTHROUGH */
- case (MDOC_ELEM):
- /* FALLTHROUGH */
- case (MDOC_BLOCK):
- mdoc->linetok++;
- break;
- default:
- 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);
-
- if (MDOC_TEXT == mdoc->last->type)
- on = "<text>";
- 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):
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();
/* NOTREACHED */
}
+ p->parent->nchild++;
+
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;
+ p->parent->head = p;
break;
case (MDOC_TAIL):
assert(MDOC_BLOCK == p->parent->type);
- p->parent->data.block.tail = p;
+ p->parent->tail = p;
break;
case (MDOC_BODY):
assert(MDOC_BLOCK == p->parent->type);
- p->parent->data.block.body = p;
+ p->parent->body = p;
break;
default:
break;
}
mdoc->last = p;
- mdoc_msg(mdoc, "parse: %s `%s' %s of %s `%s'",
- nt, nn, act, ot, on);
- return(1);
-}
-
-
-int
-mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok)
-{
- struct mdoc_node *p;
- assert(mdoc->first);
- assert(mdoc->last);
-
- p = xcalloc(1, sizeof(struct mdoc_node));
-
- p->line = line;
- p->pos = pos;
- p->type = MDOC_TAIL;
- p->tok = tok;
+ switch (p->type) {
+ case (MDOC_TEXT):
+ if ( ! mdoc_valid_post(mdoc))
+ return(0);
+ if ( ! mdoc_action_post(mdoc))
+ return(0);
+ break;
+ default:
+ break;
+ }
- return(mdoc_node_append(mdoc, p));
+ return(1);
}
-int
-mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok)
+static struct mdoc_node *
+node_alloc(struct mdoc *m, int line,
+ int pos, int tok, enum mdoc_type type)
{
struct mdoc_node *p;
- assert(mdoc->first);
- assert(mdoc->last);
-
- p = xcalloc(1, sizeof(struct mdoc_node));
-
+ p = mandoc_calloc(1, sizeof(struct mdoc_node));
+ p->sec = m->lastsec;
p->line = line;
p->pos = pos;
- p->type = MDOC_HEAD;
p->tok = tok;
+ if (MDOC_TEXT != (p->type = type))
+ assert(p->tok >= 0);
- return(mdoc_node_append(mdoc, p));
+ return(p);
}
int
-mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok)
+mdoc_tail_alloc(struct mdoc *m, int line, int pos, int tok)
{
struct mdoc_node *p;
- assert(mdoc->first);
- assert(mdoc->last);
-
- p = xcalloc(1, sizeof(struct mdoc_node));
-
- p->line = line;
- p->pos = pos;
- p->type = MDOC_BODY;
- p->tok = tok;
-
- return(mdoc_node_append(mdoc, p));
+ p = node_alloc(m, line, pos, tok, MDOC_TAIL);
+ if ( ! node_append(m, p))
+ return(0);
+ m->next = MDOC_NEXT_CHILD;
+ return(1);
}
int
-mdoc_root_alloc(struct mdoc *mdoc)
+mdoc_head_alloc(struct mdoc *m, int line, int pos, int tok)
{
struct mdoc_node *p;
- p = xcalloc(1, sizeof(struct mdoc_node));
-
- p->type = MDOC_ROOT;
+ assert(m->first);
+ assert(m->last);
- return(mdoc_node_append(mdoc, p));
+ p = node_alloc(m, line, pos, tok, MDOC_HEAD);
+ if ( ! node_append(m, p))
+ return(0);
+ m->next = MDOC_NEXT_CHILD;
+ return(1);
}
int
-mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
- int tok, size_t argsz, const struct mdoc_arg *args)
+mdoc_body_alloc(struct mdoc *m, int line, int pos, int tok)
{
struct mdoc_node *p;
- p = xcalloc(1, sizeof(struct mdoc_node));
-
- p->pos = pos;
- p->line = line;
- p->type = MDOC_BLOCK;
- p->tok = tok;
- p->data.block.argc = argsz;
- p->data.block.argv = argdup(argsz, args);
-
- return(mdoc_node_append(mdoc, p));
+ p = node_alloc(m, line, pos, tok, MDOC_BODY);
+ if ( ! node_append(m, p))
+ return(0);
+ m->next = MDOC_NEXT_CHILD;
+ return(1);
}
int
-mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
- int tok, size_t argsz, const struct mdoc_arg *args)
+mdoc_block_alloc(struct mdoc *m, int line, int pos,
+ int tok, struct mdoc_arg *args)
{
struct mdoc_node *p;
- p = xcalloc(1, sizeof(struct mdoc_node));
-
- p->line = line;
- p->pos = pos;
- p->type = MDOC_ELEM;
- p->tok = tok;
- p->data.elem.argc = argsz;
- p->data.elem.argv = argdup(argsz, args);
-
- return(mdoc_node_append(mdoc, p));
+ p = node_alloc(m, line, pos, tok, MDOC_BLOCK);
+ p->args = args;
+ if (p->args)
+ (args->refcnt)++;
+ if ( ! node_append(m, p))
+ return(0);
+ m->next = MDOC_NEXT_CHILD;
+ return(1);
}
int
-mdoc_word_alloc(struct mdoc *mdoc,
- int line, int pos, const char *word)
+mdoc_elem_alloc(struct mdoc *m, int line, int pos,
+ int tok, struct mdoc_arg *args)
{
struct mdoc_node *p;
- p = xcalloc(1, sizeof(struct mdoc_node));
- p->line = line;
- p->pos = pos;
- p->type = MDOC_TEXT;
- p->data.text.string = xstrdup(word);
-
- return(mdoc_node_append(mdoc, p));
-}
-
-
-static void
-argfree(size_t sz, struct mdoc_arg *p)
-{
- int i, j;
-
- if (0 == sz)
- return;
-
- assert(p);
- /* LINTED */
- for (i = 0; i < (int)sz; i++)
- if (p[i].sz > 0) {
- assert(p[i].value);
- /* LINTED */
- for (j = 0; j < (int)p[i].sz; j++)
- free(p[i].value[j]);
- free(p[i].value);
- }
- free(p);
+ p = node_alloc(m, line, pos, tok, MDOC_ELEM);
+ p->args = args;
+ if (p->args)
+ (args->refcnt)++;
+ if ( ! node_append(m, p))
+ return(0);
+ m->next = MDOC_NEXT_CHILD;
+ return(1);
}
-static void
-mdoc_elem_free(struct mdoc_elem *p)
+static int
+pstring(struct mdoc *m, int line, int pos, const char *p, size_t len)
{
+ struct mdoc_node *n;
+ size_t sv;
- argfree(p->argc, p->argv);
-}
-
+ n = node_alloc(m, line, pos, -1, MDOC_TEXT);
+ n->string = mandoc_malloc(len + 1);
+ sv = strlcpy(n->string, p, len + 1);
-static void
-mdoc_block_free(struct mdoc_block *p)
-{
+ /* Prohibit truncation. */
+ assert(sv < len + 1);
- argfree(p->argc, p->argv);
+ if ( ! node_append(m, n))
+ return(0);
+ m->next = MDOC_NEXT_SIBLING;
+ return(1);
}
-static void
-mdoc_text_free(struct mdoc_text *p)
+int
+mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
{
- if (p->string)
- free(p->string);
+ return(pstring(m, line, pos, p, strlen(p)));
}
mdoc_node_free(struct mdoc_node *p)
{
- switch (p->type) {
- case (MDOC_TEXT):
- mdoc_text_free(&p->data.text);
- break;
- case (MDOC_ELEM):
- mdoc_elem_free(&p->data.elem);
- break;
- case (MDOC_BLOCK):
- mdoc_block_free(&p->data.block);
- break;
- default:
- break;
- }
-
+ if (p->parent)
+ p->parent->nchild--;
+ if (p->string)
+ free(p->string);
+ if (p->args)
+ mdoc_argv_free(p->args);
free(p);
}
if (p->next)
mdoc_node_freelist(p->next);
+ assert(0 == p->nchild);
mdoc_node_free(p);
}
-int
-mdoc_find(const struct mdoc *mdoc, const char *key)
+/*
+ * Parse free-form text, that is, a line that does not begin with the
+ * control character.
+ */
+static int
+parsetext(struct mdoc *m, int line, char *buf)
{
+ int i, j;
+ char sv;
+
+ if (SEC_NONE == m->lastnamed)
+ return(mdoc_perr(m, line, 0, ETEXTPROL));
+
+ /*
+ * If in literal mode, then pass the buffer directly to the
+ * back-end, as it should be preserved as a single term.
+ */
+
+ if (MDOC_LITERAL & m->flags)
+ return(mdoc_word_alloc(m, line, 0, buf));
+
+ /* Disallow blank/white-space lines in non-literal mode. */
+
+ for (i = 0; ' ' == buf[i]; i++)
+ /* Skip leading whitespace. */ ;
+
+ if ('\0' == buf[i])
+ return(mdoc_perr(m, line, 0, ENOBLANK));
+
+ /*
+ * Break apart a free-form line into tokens. Spaces are
+ * stripped out of the input.
+ */
- return(mdoc_tokhash_find(mdoc->htab, key));
+ for (j = i; buf[i]; i++) {
+ if (' ' != buf[i])
+ continue;
+
+ /* Escaped whitespace. */
+ if (i && ' ' == buf[i] && '\\' == buf[i - 1])
+ continue;
+
+ sv = buf[i];
+ buf[i++] = '\0';
+
+ if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
+ return(0);
+
+ /* Trailing whitespace? Check at overwritten byte. */
+
+ if (' ' == sv && '\0' == buf[i])
+ if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS))
+ return(0);
+
+ for ( ; ' ' == buf[i]; i++)
+ /* Skip trailing whitespace. */ ;
+
+ j = i;
+
+ /* Trailing whitespace? */
+
+ if (' ' == buf[i - 1] && '\0' == buf[i])
+ if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS))
+ return(0);
+
+ if ('\0' == buf[i])
+ break;
+ }
+
+ if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
+ return(0);
+
+ m->next = MDOC_NEXT_SIBLING;
+ return(1);
}
-static void
-argcpy(struct mdoc_arg *dst, const struct mdoc_arg *src)
+
+static int
+macrowarn(struct mdoc *m, int ln, const char *buf)
{
- int i;
-
- dst->line = src->line;
- dst->pos = src->pos;
- dst->arg = src->arg;
- if (0 == (dst->sz = src->sz))
- return;
- dst->value = xcalloc(dst->sz, sizeof(char *));
- for (i = 0; i < (int)dst->sz; i++)
- dst->value[i] = xstrdup(src->value[i]);
+ if ( ! (MDOC_IGN_MACRO & m->pflags))
+ return(mdoc_verr(m, ln, 0,
+ "unknown macro: %s%s",
+ buf, strlen(buf) > 3 ? "..." : ""));
+ return(mdoc_vwarn(m, ln, 0, "unknown macro: %s%s",
+ buf, strlen(buf) > 3 ? "..." : ""));
}
-static struct mdoc_arg *
-argdup(size_t argsz, const struct mdoc_arg *args)
+/*
+ * Parse a macro line, that is, a line beginning with the control
+ * character.
+ */
+int
+parsemacro(struct mdoc *m, int ln, char *buf)
{
- struct mdoc_arg *pp;
- int i;
+ int i, j, c;
+ char mac[5];
- if (0 == argsz)
- return(NULL);
+ /* Empty lines are ignored. */
- pp = xcalloc((size_t)argsz, sizeof(struct mdoc_arg));
- for (i = 0; i < (int)argsz; i++)
- argcpy(&pp[i], &args[i]);
+ if ('\0' == buf[1])
+ return(1);
- return(pp);
-}
+ i = 1;
+ /* Accept whitespace after the initial control char. */
-/* 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);
+ if (' ' == buf[i]) {
+ i++;
+ while (buf[i] && ' ' == buf[i])
+ i++;
+ if ('\0' == buf[i])
+ return(1);
+ }
+
+ /* Copy the first word into a nil-terminated buffer. */
+
+ for (j = 0; j < 4; j++, i++) {
+ if ('\0' == (mac[j] = buf[i]))
+ break;
+ else if (' ' == buf[i])
+ break;
+
+ /* Check for invalid characters. */
+
+ if (isgraph((u_char)buf[i]))
+ continue;
+ return(mdoc_perr(m, ln, i, EPRINT));
+ }
+
+ mac[j] = 0;
+
+ if (j == 4 || j < 2) {
+ if ( ! macrowarn(m, ln, mac))
+ goto err;
+ return(1);
+ }
+
+ if (MDOC_MAX == (c = mdoc_hash_find(mac))) {
+ if ( ! macrowarn(m, ln, mac))
+ goto err;
+ return(1);
+ }
+
+ /* The macro is sane. Jump to the next word. */
+
+ while (buf[i] && ' ' == buf[i])
+ i++;
+
+ /* Trailing whitespace? */
+
+ if ('\0' == buf[i] && ' ' == buf[i - 1])
+ if ( ! mdoc_pwarn(m, ln, i - 1, ETAILWS))
+ goto err;
+
+ /*
+ * Begin recursive parse sequence. Since we're at the start of
+ * the line, we don't need to do callable/parseable checks.
+ */
+ if ( ! mdoc_macro(m, c, ln, 1, &i, buf))
+ goto err;
+
+ return(1);
+
+err: /* Error out. */
+
+ m->flags |= MDOC_HALT;
+ return(0);
}
git.ckatri.com / mandoc.git / blobdiff