X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/00b1408577108687d502b7b56de8e3399986a349..e3f5a8b682834250b701507005165a1355655312:/mdoc.c?ds=inline

diff --git a/mdoc.c b/mdoc.c
index a1e27576..bee01503 100644
--- a/mdoc.c
+++ b/mdoc.c
@@ -1,6 +1,7 @@
-/*	$Id: mdoc.c,v 1.140 2010/05/30 11:00:53 kristaps Exp $ */
+/*	$Id: mdoc.c,v 1.164 2010/08/29 11:29:51 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -21,7 +22,6 @@
 #include <sys/types.h>
 
 #include <assert.h>
-#include <ctype.h>
 #include <stdarg.h>
 #include <stdio.h>
 #include <stdlib.h>
@@ -69,7 +69,7 @@ const	char *const __mdoc_macronames[MDOC_MAX] = {
 	/* LINTED */
 	"Dx",		"%Q",		"br",		"sp",
 	/* LINTED */
-	"%U"
+	"%U",		"Ta"
 	};
 
 const	char *const __mdoc_argnames[MDOC_ARG_MAX] = {		 
@@ -98,8 +98,6 @@ static	int		  node_append(struct mdoc *,
 				struct mdoc_node *);
 static	int		  mdoc_ptext(struct mdoc *, int, char *, int);
 static	int		  mdoc_pmacro(struct mdoc *, int, char *, int);
-static	int		  macrowarn(struct mdoc *, int, 
-				const char *, int);
 
 
 const struct mdoc_node *
@@ -191,7 +189,7 @@ mdoc_free(struct mdoc *mdoc)
  * Allocate volatile and non-volatile parse resources.  
  */
 struct mdoc *
-mdoc_alloc(void *data, int pflags, mandocmsg msg)
+mdoc_alloc(struct regset *regs, void *data, mandocmsg msg)
 {
 	struct mdoc	*p;
 
@@ -199,7 +197,7 @@ mdoc_alloc(void *data, int pflags, mandocmsg msg)
 
 	p->msg = msg;
 	p->data = data;
-	p->pflags = pflags;
+	p->regs = regs;
 
 	mdoc_hash_init();
 	mdoc_alloc1(p);
@@ -236,6 +234,20 @@ mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs)
 		return(0);
 
 	m->flags |= MDOC_NEWLINE;
+
+	/*
+	 * Let the roff nS register switch SYNOPSIS mode early,
+	 * such that the parser knows at all times
+	 * whether this mode is on or off.
+	 * Note that this mode is also switched by the Sh macro.
+	 */
+	if (m->regs->regs[(int)REG_nS].set) {
+		if (m->regs->regs[(int)REG_nS].v.u)
+			m->flags |= MDOC_SYNOPSIS;
+		else
+			m->flags &= ~MDOC_SYNOPSIS;
+	}
+
 	return(('.' == buf[offs] || '\'' == buf[offs]) ? 
 			mdoc_pmacro(m, ln, buf, offs) :
 			mdoc_ptext(m, ln, buf, offs));
@@ -258,8 +270,7 @@ mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t,
 
 
 int
-mdoc_macro(struct mdoc *m, enum mdoct tok, 
-		int ln, int pp, int *pos, char *buf)
+mdoc_macro(MACRO_PROT_ARGS)
 {
 	assert(tok < MDOC_MAX);
 
@@ -267,13 +278,13 @@ mdoc_macro(struct mdoc *m, enum mdoct tok,
 
 	if (MDOC_PROLOGUE & mdoc_macros[tok].flags && 
 			MDOC_PBODY & m->flags)
-		return(mdoc_pmsg(m, ln, pp, MANDOCERR_BADBODY));
+		return(mdoc_pmsg(m, line, ppos, MANDOCERR_BADBODY));
 
 	/* If we're in the prologue, deny "body" macros.  */
 
 	if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) && 
 			! (MDOC_PBODY & m->flags)) {
-		if ( ! mdoc_pmsg(m, ln, pp, MANDOCERR_BADPROLOG))
+		if ( ! mdoc_pmsg(m, line, ppos, MANDOCERR_BADPROLOG))
 			return(0);
 		if (NULL == m->meta.title)
 			m->meta.title = mandoc_strdup("UNKNOWN");
@@ -286,7 +297,7 @@ mdoc_macro(struct mdoc *m, enum mdoct tok,
 		m->flags |= MDOC_PBODY;
 	}
 
-	return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
+	return((*mdoc_macros[tok].fp)(m, tok, line, ppos, pos, buf));
 }
 
 
@@ -330,6 +341,8 @@ node_append(struct mdoc *mdoc, struct mdoc_node *p)
 		p->parent->tail = p;
 		break;
 	case (MDOC_BODY):
+		if (p->end)
+			break;
 		assert(MDOC_BLOCK == p->parent->type);
 		p->parent->body = p;
 		break;
@@ -366,9 +379,17 @@ node_alloc(struct mdoc *m, int line, int pos,
 	p->pos = pos;
 	p->tok = tok;
 	p->type = type;
+
+	/* Flag analysis. */
+
+	if (MDOC_SYNOPSIS & m->flags)
+		p->flags |= MDOC_SYNPRETTY;
+	else
+		p->flags &= ~MDOC_SYNPRETTY;
 	if (MDOC_NEWLINE & m->flags)
 		p->flags |= MDOC_LINE;
 	m->flags &= ~MDOC_NEWLINE;
+
 	return(p);
 }
 
@@ -415,6 +436,22 @@ mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
 }
 
 
+int
+mdoc_endbody_alloc(struct mdoc *m, int line, int pos, enum mdoct tok,
+		struct mdoc_node *body, enum mdoc_endbody end)
+{
+	struct mdoc_node *p;
+
+	p = node_alloc(m, line, pos, tok, MDOC_BODY);
+	p->pending = body;
+	p->end = end;
+	if ( ! node_append(m, p))
+		return(0);
+	m->next = MDOC_NEXT_SIBLING;
+	return(1);
+}
+
+
 int
 mdoc_block_alloc(struct mdoc *m, int line, int pos, 
 		enum mdoct tok, struct mdoc_arg *args)
@@ -472,10 +509,26 @@ mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
 }
 
 
-void
+static void
 mdoc_node_free(struct mdoc_node *p)
 {
 
+	/*
+	 * XXX: if these end up being problematic in terms of memory
+	 * management and dereferencing freed blocks, then make them
+	 * into reference-counted double-pointers.
+	 */
+
+	if (MDOC_Bd == p->tok && MDOC_BLOCK == p->type)
+		if (p->data.Bd)
+			free(p->data.Bd);
+	if (MDOC_Bl == p->tok && MDOC_BLOCK == p->type)
+		if (p->data.Bl)
+			free(p->data.Bl);
+	if (MDOC_Bf == p->tok && MDOC_HEAD == p->type)
+		if (p->data.Bf)
+			free(p->data.Bf);
+
 	if (p->string)
 		free(p->string);
 	if (p->args)
@@ -542,7 +595,8 @@ mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
 static int
 mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
 {
-	char		*c, *ws, *end;
+	char		 *c, *ws, *end;
+	struct mdoc_node *n;
 
 	/* Ignore bogus comments. */
 
@@ -556,6 +610,32 @@ mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
 	if (SEC_NONE == m->lastnamed)
 		return(mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT));
 
+	assert(m->last);
+	n = m->last;
+
+	/*
+	 * Divert directly to list processing if we're encountering a
+	 * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
+	 * (a MDOC_BODY means it's already open, in which case we should
+	 * process within its context in the normal way).
+	 */
+
+	if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
+			LIST_column == n->data.Bl->type) {
+		/* `Bl' is open without any children. */
+		m->flags |= MDOC_FREECOL;
+		return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
+	}
+
+	if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
+			NULL != n->parent &&
+			MDOC_Bl == n->parent->tok &&
+			LIST_column == n->parent->data.Bl->type) {
+		/* `Bl' has block-level `It' children. */
+		m->flags |= MDOC_FREECOL;
+		return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
+	}
+
 	/*
 	 * Search for the beginning of unescaped trailing whitespace (ws)
 	 * and for the first character not to be output (end).
@@ -568,6 +648,7 @@ mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
 		case '-':
 			if (mandoc_hyph(buf + offs, c))
 				*c = ASCII_HYPH;
+			ws = NULL;
 			break;
 		case ' ':
 			if (NULL == ws)
@@ -635,37 +716,24 @@ mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
 
 	assert(buf < end);
 
-	if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
+	if (mandoc_eos(buf+offs, (size_t)(end-buf-offs), 0))
 		m->last->flags |= MDOC_EOS;
 
 	return(1);
 }
 
 
-static int
-macrowarn(struct mdoc *m, int ln, const char *buf, int offs)
-{
-	int		 rc;
-
-	rc = mdoc_vmsg(m, MANDOCERR_MACRO, ln, offs, 
-			"unknown macro: %s%s", 
-			buf, strlen(buf) > 3 ? "..." : "");
-
-	/* FIXME: logic should be in driver. */
-	return(MDOC_IGN_MACRO & m->pflags ? rc : 0);
-}
-
-
 /*
  * Parse a macro line, that is, a line beginning with the control
  * character.
  */
-int
+static int
 mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
 {
-	enum mdoct	tok;
-	int		i, j, sv;
-	char		mac[5];
+	enum mdoct	  tok;
+	int		  i, j, sv;
+	char		  mac[5];
+	struct mdoc_node *n;
 
 	/* Empty lines are ignored. */
 
@@ -676,11 +744,11 @@ mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
 
 	i = offs;
 
-	/* Accept whitespace after the initial control char. */
+	/* Accept tabs/whitespace after the initial control char. */
 
-	if (' ' == buf[i]) {
+	if (' ' == buf[i] || '\t' == buf[i]) {
 		i++;
-		while (buf[i] && ' ' == buf[i])
+		while (buf[i] && (' ' == buf[i] || '\t' == buf[i]))
 			i++;
 		if ('\0' == buf[i])
 			return(1);
@@ -688,38 +756,33 @@ mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
 
 	sv = i;
 
-	/* 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;
-		if ( ! mdoc_pmsg(m, ln, i, MANDOCERR_BADCHAR))
-			return(0);
-		i--;
-	}
+	/* 
+	 * Copy the first word into a nil-terminated buffer.
+	 * Stop copying when a tab, space, backslash, or eoln is encountered.
+	 */
 
+	j = 0;
+	while (j < 4 && '\0' != buf[i] && 
+			' ' != buf[i] && 
+			'\t' != buf[i] && 
+			'\\' != buf[i])
+		mac[j++] = buf[i++];
 	mac[j] = '\0';
 
-	if (j == 4 || j < 2) {
-		if ( ! macrowarn(m, ln, mac, sv))
-			goto err;
-		return(1);
-	} 
-	
-	if (MDOC_MAX == (tok = mdoc_hash_find(mac))) {
-		if ( ! macrowarn(m, ln, mac, sv))
-			goto err;
+	tok = (j > 1 || j < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
+	if (MDOC_MAX == tok) {
+		mdoc_vmsg(m, MANDOCERR_MACRO, ln, sv, 
+		    "unknown macro: %s%s", 
+		    buf, strlen(buf) > 3 ? "..." : "");
 		return(1);
 	}
 
-	/* The macro is sane.  Jump to the next word. */
+	/* Disregard the first trailing tab, if applicable. */
+
+	if ('\t' == buf[i])
+		i++;
+
+	/* Jump to the next non-whitespace word. */
 
 	while (buf[i] && ' ' == buf[i])
 		i++;
@@ -733,10 +796,51 @@ mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
 		if ( ! mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE))
 			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 an initial macro or a list invocation, divert directly
+	 * into macro processing.
 	 */
+
+	if (NULL == m->last || MDOC_It == tok || MDOC_El == tok) {
+		if ( ! mdoc_macro(m, tok, ln, sv, &i, buf)) 
+			goto err;
+		return(1);
+	}
+
+	n = m->last;
+	assert(m->last);
+
+	/*
+	 * If the first macro of a `Bl -column', open an `It' block
+	 * context around the parsed macro.
+	 */
+
+	if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
+			LIST_column == n->data.Bl->type) {
+		m->flags |= MDOC_FREECOL;
+		if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
+			goto err;
+		return(1);
+	}
+
+	/*
+	 * If we're following a block-level `It' within a `Bl -column'
+	 * context (perhaps opened in the above block or in ptext()),
+	 * then open an `It' block context around the parsed macro.
+	 */
+
+	if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
+			NULL != n->parent &&
+			MDOC_Bl == n->parent->tok &&
+			LIST_column == n->parent->data.Bl->type) {
+		m->flags |= MDOC_FREECOL;
+		if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf)) 
+			goto err;
+		return(1);
+	}
+
+	/* Normal processing of a macro. */
+
 	if ( ! mdoc_macro(m, tok, ln, sv, &i, buf)) 
 		goto err;