===================================================================
RCS file: /cvs/mandoc/mdoc.c,v
retrieving revision 1.52
retrieving revision 1.72
diff -u -p -r1.52 -r1.72
--- mandoc/mdoc.c	2009/03/06 14:13:47	1.52
+++ mandoc/mdoc.c	2009/03/23 15:41:09	1.72
@@ -1,6 +1,6 @@
-/* $Id: mdoc.c,v 1.52 2009/03/06 14:13:47 kristaps Exp $ */
+/* $Id: mdoc.c,v 1.72 2009/03/23 15:41:09 kristaps Exp $ */
 /*
- * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the
@@ -24,26 +24,14 @@
 #include <stdio.h>
 #include <string.h>
 
-#include "private.h"
+#include "libmdoc.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.
+ * in macro.c, validate.c and action.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",
@@ -74,7 +62,12 @@ const	char *const __mdoc_macronames[MDOC_MAX] = {		 
 	"Tn",		"Ux",		"Xc",		"Xo",
 	"Fo",		"Fc",		"Oo",		"Oc",
 	"Bk",		"Ek",		"Bt",		"Hf",
-	"Fr",		"Ud",		"Lb",
+	"Fr",		"Ud",		"Lb",		"Ap",
+	"Lp",		"Lk",		"Mt",		"Brq",
+	/* LINTED */
+	"Bro",		"Brc",		"\%C",		"Es",
+	/* LINTED */
+	"En",		"Dx",		"\%Q"
 	};
 
 const	char *const __mdoc_argnames[MDOC_ARG_MAX] = {		 
@@ -86,37 +79,85 @@ const	char *const __mdoc_argnames[MDOC_ARG_MAX] = {		 
 	"ohang",		"inset",		"column",	 
 	"width",		"compact",		"std",	 
 	"filled",		"words",		"emphasis",
-	"symbolic"
+	"symbolic",		"nested"
 	};
 
 const	char * const *mdoc_macronames = __mdoc_macronames;
 const	char * const *mdoc_argnames = __mdoc_argnames;
 
+/* FIXME: have this accept line/pos/tok. */
+/* FIXME: mdoc_alloc1 and mdoc_free1 like in man.c. */
+static	struct mdoc_node *mdoc_node_alloc(const struct mdoc *);
+static	int		  mdoc_node_append(struct mdoc *, 
+				struct mdoc_node *);
 
+static	int		  parsetext(struct mdoc *, int, char *);
+static	int		  parsemacro(struct mdoc *, int, char *);
+static	int		  macrowarn(struct mdoc *, int, const char *);
+
+
+/*
+ * Get the first (root) node of the parse tree.
+ */
 const struct mdoc_node *
-mdoc_node(const 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(const struct mdoc *mdoc)
+mdoc_meta(const struct mdoc *m)
 {
 
-	return(&mdoc->meta);
+	return(MDOC_HALT & m->flags ? NULL : &m->meta);
 }
 
 
+/*
+ * Free up all resources contributed by a parse:  the node tree,
+ * meta-data and so on.  Then reallocate the root node for another
+ * parse.
+ */
 void
+mdoc_reset(struct mdoc *mdoc)
+{
+
+	if (mdoc->first)
+		mdoc_node_freelist(mdoc->first);
+	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);
+
+	bzero(&mdoc->meta, sizeof(struct mdoc_meta));
+	mdoc->flags = 0;
+	mdoc->lastnamed = mdoc->lastsec = 0;
+	mdoc->last = calloc(1, sizeof(struct mdoc_node));
+	if (NULL == mdoc->last)
+		err(1, "calloc");
+	mdoc->first = mdoc->last;
+	mdoc->last->type = MDOC_ROOT;
+	mdoc->next = MDOC_NEXT_CHILD;
+}
+
+
+/*
+ * Completely free up all resources.
+ */
+void
 mdoc_free(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)
@@ -128,121 +169,68 @@ mdoc_free(struct mdoc *mdoc)
 	if (mdoc->meta.vol)
 		free(mdoc->meta.vol);
 
+	if (mdoc->htab)
+		mdoc_tokhash_free(mdoc->htab);
+
 	free(mdoc);
 }
 
 
 struct mdoc *
-mdoc_alloc(void *data, const struct mdoc_cb *cb)
+mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)
 {
 	struct mdoc	*p;
 
-	p = xcalloc(1, sizeof(struct mdoc));
+	if (NULL == (p = calloc(1, sizeof(struct mdoc))))
+		err(1, "calloc");
 
 	p->data = data;
 	if (cb)
 		(void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
 
-	p->last = xcalloc(1, sizeof(struct mdoc_node));
+	if (NULL == (p->first = calloc(1, sizeof(struct mdoc_node))))
+		err(1, "calloc");
+	p->last = p->first;
 	p->last->type = MDOC_ROOT;
-	p->first = p->last;
-
+	p->pflags = pflags;
 	p->next = MDOC_NEXT_CHILD;
 	p->htab = mdoc_tokhash_alloc();
-
 	return(p);
 }
 
 
+/*
+ * Climb back up the parse tree, validating open scopes.  Mostly calls
+ * through to macro_end in macro.c.
+ */
 int
-mdoc_endparse(struct mdoc *mdoc)
+mdoc_endparse(struct mdoc *m)
 {
 
-	if (MDOC_HALT & mdoc->flags)
+	if (MDOC_HALT & m->flags)
 		return(0);
-	if (NULL == mdoc->first)
+	else if (mdoc_macroend(m))
 		return(1);
-
-	assert(mdoc->last);
-	if ( ! macro_end(mdoc)) {
-		mdoc->flags |= MDOC_HALT;
-		return(0);
-	}
-	return(1);
+	m->flags |= MDOC_HALT;
+	return(0);
 }
 
 
 /*
- * 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.
+ * Main parse routine.  Parses a single line -- really just hands off to
+ * the macro or text parser.
  */
 int
-mdoc_parseln(struct mdoc *mdoc, int line, char *buf)
+mdoc_parseln(struct mdoc *m, int ln, char *buf)
 {
-	int		  c, i;
-	char		  tmp[5];
 
-	if (MDOC_HALT & mdoc->flags)
-		return(0);
+	/* If in error-mode, then we parse no more. */
 
-	mdoc->linetok = 0;
-
-	if ('.' != *buf) {
-		/*
-		 * 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((u_char)buf[i]) && 
-			i < (int)sizeof(tmp))
-		i++;
-
-	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"));
-	}
-
-	i--;
-
-	(void)memcpy(tmp, buf + 1, (size_t)i);
-	tmp[i++] = 0;
-
-	if (MDOC_MAX == (c = mdoc_find(mdoc, tmp))) {
-		mdoc->flags |= MDOC_HALT;
-		return(mdoc_perr(mdoc, line, 1, "unknown macro"));
-	}
-
-	while (buf[i] && isspace((u_char)buf[i]))
-		i++;
-
-	if ( ! mdoc_macro(mdoc, c, line, 1, &i, buf)) {
-		mdoc->flags |= MDOC_HALT;
+	if (MDOC_HALT & m->flags)
 		return(0);
-	}
 
-	return(1);
+	return('.' == *buf ? parsemacro(m, ln, buf) :
+			parsetext(m, ln, buf));
 }
 
 
@@ -297,21 +285,27 @@ mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, 
 
 
 int
-mdoc_macro(struct mdoc *mdoc, int tok, 
-		int ln, int ppos, int *pos, char *buf)
+mdoc_macro(struct mdoc *m, int tok, 
+		int ln, int pp, int *pos, char *buf)
 {
 
-	assert(mdoc_macros[tok].fp);
+	/* FIXME - these should happen during validation. */
 
 	if (MDOC_PROLOGUE & mdoc_macros[tok].flags && 
-			SEC_PROLOGUE != mdoc->lastnamed)
-		return(mdoc_perr(mdoc, ln, ppos, "macro disallowed in document body"));
+			SEC_PROLOGUE != m->lastnamed)
+		return(mdoc_perr(m, ln, pp, 
+				"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, "macro not callable"));
-	return((*mdoc_macros[tok].fp)(mdoc, tok, ln, ppos, pos, buf));
+			SEC_PROLOGUE == m->lastnamed)
+		return(mdoc_perr(m, ln, pp, 
+				"disallowed in prologue"));
+
+	if (1 != pp && ! (MDOC_CALLABLE & mdoc_macros[tok].flags))
+		return(mdoc_perr(m, ln, pp, "%s not callable",
+					mdoc_macronames[tok]));
+
+	return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
 }
 
 
@@ -323,27 +317,6 @@ mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *
 	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);
-
 	switch (mdoc->next) {
 	case (MDOC_NEXT_SIBLING):
 		mdoc->last->next = p;
@@ -361,25 +334,39 @@ mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *
 
 	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;
+
+	switch (p->type) {
+	case (MDOC_TEXT):
+		if ( ! mdoc_valid_post(mdoc))
+			return(0);
+		if ( ! mdoc_action_post(mdoc))
+			return(0);
+		break;
+	default:
+		break;
+	}
+
 	return(1);
 }
 
@@ -389,7 +376,8 @@ mdoc_node_alloc(const struct mdoc *mdoc)
 {
 	struct mdoc_node *p;
 
-	p = xcalloc(1, sizeof(struct mdoc_node));
+	if (NULL == (p = calloc(1, sizeof(struct mdoc_node))))
+		err(1, "calloc");
 	p->sec = mdoc->lastsec;
 
 	return(p);
@@ -454,21 +442,8 @@ mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, 
 
 
 int
-mdoc_root_alloc(struct mdoc *mdoc)
-{
-	struct mdoc_node *p;
-
-	p = mdoc_node_alloc(mdoc);
-
-	p->type = MDOC_ROOT;
-
-	return(mdoc_node_append(mdoc, p));
-}
-
-
-int
 mdoc_block_alloc(struct mdoc *mdoc, int line, int pos, 
-		int tok, size_t argsz, const struct mdoc_arg *args)
+		int tok, struct mdoc_arg *args)
 {
 	struct mdoc_node *p;
 
@@ -478,16 +453,18 @@ mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
 	p->line = line;
 	p->type = MDOC_BLOCK;
 	p->tok = tok;
-	p->data.block.argc = argsz;
-	p->data.block.argv = argdup(argsz, args);
+	p->args = args;
 
+	if (args)
+		(args->refcnt)++;
+
 	return(mdoc_node_append(mdoc, p));
 }
 
 
 int
 mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, 
-		int tok, size_t argsz, const struct mdoc_arg *args)
+		int tok, struct mdoc_arg *args)
 {
 	struct mdoc_node *p;
 
@@ -497,9 +474,11 @@ mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos, 
 	p->pos = pos;
 	p->type = MDOC_ELEM;
 	p->tok = tok;
-	p->data.elem.argc = argsz;
-	p->data.elem.argv = argdup(argsz, args);
+	p->args = args;
 
+	if (args)
+		(args->refcnt)++;
+
 	return(mdoc_node_append(mdoc, p));
 }
 
@@ -515,131 +494,140 @@ mdoc_word_alloc(struct mdoc *mdoc, 
 	p->line = line;
 	p->pos = pos;
 	p->type = MDOC_TEXT;
-	p->data.text.string = xstrdup(word);
+	if (NULL == (p->string = strdup(word)))
+		err(1, "strdup");
 
 	return(mdoc_node_append(mdoc, p));
 }
 
 
-static void
-argfree(size_t sz, struct mdoc_arg *p)
+void
+mdoc_node_free(struct mdoc_node *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);
-		}
+	if (p->string)
+		free(p->string);
+	if (p->args)
+		mdoc_argv_free(p->args);
 	free(p);
 }
 
 
-static void
-mdoc_elem_free(struct mdoc_elem *p)
+void
+mdoc_node_freelist(struct mdoc_node *p)
 {
 
-	argfree(p->argc, p->argv);
+	if (p->child)
+		mdoc_node_freelist(p->child);
+	if (p->next)
+		mdoc_node_freelist(p->next);
+
+	mdoc_node_free(p);
 }
 
 
-static void
-mdoc_block_free(struct mdoc_block *p)
+/*
+ * 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)
 {
 
-	argfree(p->argc, p->argv);
-}
+	if (SEC_PROLOGUE == m->lastnamed)
+		return(mdoc_perr(m, line, 0,
+			"text disallowed in prologue"));
 
+	if (0 == buf[0] && ! (MDOC_LITERAL & m->flags))
+		return(mdoc_perr(m, line, 0,
+			"blank lines only in literal context"));
 
-static void
-mdoc_text_free(struct mdoc_text *p)
-{
+	if ( ! mdoc_word_alloc(m, line, 0, buf))
+		return(0);
 
-	if (p->string)
-		free(p->string);
+	m->next = MDOC_NEXT_SIBLING;
+	return(1);
 }
 
 
-void
-mdoc_node_free(struct mdoc_node *p)
+static int
+macrowarn(struct mdoc *m, int ln, const char *buf)
 {
-
-	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;
-	}
-
-	free(p);
+	if ( ! (MDOC_IGN_MACRO & m->pflags))
+		return(mdoc_perr(m, ln, 1, "unknown macro: %s%s", 
+				buf, strlen(buf) > 3 ? "..." : ""));
+	return(mdoc_pwarn(m, ln, 1, WARN_SYNTAX,
+				"unknown macro: %s%s",
+				buf, strlen(buf) > 3 ? "..." : ""));
 }
 
 
-void
-mdoc_node_freelist(struct mdoc_node *p)
+
+/*
+ * Parse a macro line, that is, a line beginning with the control
+ * character.
+ */
+int
+parsemacro(struct mdoc *m, int ln, char *buf)
 {
+	int		  i, c;
+	char		  mac[5];
 
-	if (p->child)
-		mdoc_node_freelist(p->child);
-	if (p->next)
-		mdoc_node_freelist(p->next);
+	/* Comments and empties are quickly ignored. */
 
-	mdoc_node_free(p);
-}
+	if (0 == buf[1])
+		return(1);
 
+	if (' ' == buf[1]) {
+		i = 2;
+		while (buf[i] && ' ' == buf[i])
+			i++;
+		if (0 == buf[i])
+			return(1);
+		return(mdoc_perr(m, ln, 1, "invalid syntax"));
+	}
 
-int
-mdoc_find(const struct mdoc *mdoc, const char *key)
-{
+	if (buf[1] && '\\' == buf[1])
+		if (buf[2] && '\"' == buf[2])
+			return(1);
 
-	return(mdoc_tokhash_find(mdoc->htab, key));
-}
+	/* Copy the first word into a nil-terminated buffer. */
 
+	for (i = 1; i < 5; i++) {
+		if (0 == (mac[i - 1] = buf[i]))
+			break;
+		else if (' ' == buf[i])
+			break;
+	}
 
-static void
-argcpy(struct mdoc_arg *dst, const struct mdoc_arg *src)
-{
-	int		 i;
+	mac[i - 1] = 0;
 
-	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 (i == 5 || i <= 2) {
+		if ( ! macrowarn(m, ln, mac))
+			goto err;
+		return(1);
+	} 
+	
+	if (MDOC_MAX == (c = mdoc_tokhash_find(m->htab, mac))) {
+		if ( ! macrowarn(m, ln, mac))
+			goto err;
+		return(1);
+	}
 
+	/* The macro is sane.  Jump to the next word. */
 
-static struct mdoc_arg *
-argdup(size_t argsz, const struct mdoc_arg *args)
-{
-	struct mdoc_arg	*pp;
-	int		 i;
+	while (buf[i] && ' ' == buf[i])
+		i++;
 
-	if (0 == argsz)
-		return(NULL);
+	/* Begin recursive parse sequence. */
 
-	pp = xcalloc((size_t)argsz, sizeof(struct mdoc_arg));
-	for (i = 0; i < (int)argsz; i++)
-		argcpy(&pp[i], &args[i]);
+	if ( ! mdoc_macro(m, c, ln, 1, &i, buf)) 
+		goto err;
 
-	return(pp);
-}
+	return(1);
 
+err:	/* Error out. */
+
+	m->flags |= MDOC_HALT;
+	return(0);
+}