X-Git-Url: https://git.cameronkatri.com/mandoc.git/blobdiff_plain/dc95dcaff23f7235529d0b5d9866a252ca3f8c06..90b416207a9708302ecc3333c3f3aa4c660122b1:/man.c?ds=sidebyside

diff --git a/man.c b/man.c
index 1d320706..61f2a5eb 100644
--- a/man.c
+++ b/man.c
@@ -1,6 +1,6 @@
-/*	$Id: man.c,v 1.80 2010/06/27 16:18:13 kristaps Exp $ */
+/*	$Id: man.c,v 1.114 2011/11/16 22:39:05 joerg Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -21,14 +21,13 @@
 #include <sys/types.h>
 
 #include <assert.h>
-#include <ctype.h>
 #include <stdarg.h>
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
 
+#include "man.h"
 #include "mandoc.h"
-#include "regs.h"
 #include "libman.h"
 #include "libmandoc.h"
 
@@ -38,15 +37,15 @@ const	char *const __man_macronames[MAN_MAX] = {
 	"IP",		"HP",		"SM",		"SB",
 	"BI",		"IB",		"BR",		"RB",
 	"R",		"B",		"I",		"IR",
-	"RI",		"na",		"i",		"sp",
-	"nf",		"fi",		"r",		"RE",
-	"RS",		"DT",		"UC",		"PD",
-	"Sp",		"Vb",		"Ve",		"AT",
+	"RI",		"na",		"sp",		"nf",
+	"fi",		"RE",		"RS",		"DT",
+	"UC",		"PD",		"AT",		"in",
+	"ft"
 	};
 
 const	char * const *man_macronames = __man_macronames;
 
-static	struct man_node	*man_node_alloc(int, int, 
+static	struct man_node	*man_node_alloc(struct man *, int, int, 
 				enum man_type, enum mant);
 static	int		 man_node_append(struct man *, 
 				struct man_node *);
@@ -57,14 +56,15 @@ static	int		 man_ptext(struct man *, int, char *, int);
 static	int		 man_pmacro(struct man *, int, char *, int);
 static	void		 man_free1(struct man *);
 static	void		 man_alloc1(struct man *);
-static	int		 macrowarn(struct man *, int, const char *, int);
+static	int		 man_descope(struct man *, int, int);
 
 
 const struct man_node *
 man_node(const struct man *m)
 {
 
-	return(MAN_HALT & m->flags ? NULL : m->first);
+	assert( ! (MAN_HALT & m->flags));
+	return(m->first);
 }
 
 
@@ -72,7 +72,8 @@ const struct man_meta *
 man_meta(const struct man *m)
 {
 
-	return(MAN_HALT & m->flags ? NULL : &m->meta);
+	assert( ! (MAN_HALT & m->flags));
+	return(&m->meta);
 }
 
 
@@ -95,18 +96,15 @@ man_free(struct man *man)
 
 
 struct man *
-man_alloc(struct regset *regs, void *data, 
-		int pflags, mandocmsg msg)
+man_alloc(struct roff *roff, struct mparse *parse)
 {
 	struct man	*p;
 
 	p = mandoc_calloc(1, sizeof(struct man));
 
 	man_hash_init();
-	p->data = data;
-	p->pflags = pflags;
-	p->msg = msg;
-	p->regs = regs;
+	p->parse = parse;
+	p->roff = roff;
 
 	man_alloc1(p);
 	return(p);
@@ -117,9 +115,8 @@ int
 man_endparse(struct man *m)
 {
 
-	if (MAN_HALT & m->flags)
-		return(0);
-	else if (man_macroend(m))
+	assert( ! (MAN_HALT & m->flags));
+	if (man_macroend(m))
 		return(1);
 	m->flags |= MAN_HALT;
 	return(0);
@@ -130,10 +127,11 @@ int
 man_parseln(struct man *m, int ln, char *buf, int offs)
 {
 
-	if (MAN_HALT & m->flags)
-		return(0);
+	m->flags |= MAN_NEWLINE;
+
+	assert( ! (MAN_HALT & m->flags));
 
-	return(('.' == buf[offs] || '\'' == buf[offs]) ? 
+	return (mandoc_getcontrol(buf, &offs) ?
 			man_pmacro(m, ln, buf, offs) : 
 			man_ptext(m, ln, buf, offs));
 }
@@ -149,8 +147,8 @@ man_free1(struct man *man)
 		free(man->meta.title);
 	if (man->meta.source)
 		free(man->meta.source);
-	if (man->meta.rawdate)
-		free(man->meta.rawdate);
+	if (man->meta.date)
+		free(man->meta.date);
 	if (man->meta.vol)
 		free(man->meta.vol);
 	if (man->meta.msec)
@@ -206,6 +204,10 @@ man_node_append(struct man *man, struct man_node *p)
 		assert(MAN_BLOCK == p->parent->type);
 		p->parent->head = p;
 		break;
+	case (MAN_TAIL):
+		assert(MAN_BLOCK == p->parent->type);
+		p->parent->tail = p;
+		break;
 	case (MAN_BODY):
 		assert(MAN_BLOCK == p->parent->type);
 		p->parent->body = p;
@@ -217,11 +219,11 @@ man_node_append(struct man *man, struct man_node *p)
 	man->last = p;
 
 	switch (p->type) {
+	case (MAN_TBL):
+		/* FALLTHROUGH */
 	case (MAN_TEXT):
 		if ( ! man_valid_post(man))
 			return(0);
-		if ( ! man_action_post(man))
-			return(0);
 		break;
 	default:
 		break;
@@ -232,7 +234,8 @@ man_node_append(struct man *man, struct man_node *p)
 
 
 static struct man_node *
-man_node_alloc(int line, int pos, enum man_type type, enum mant tok)
+man_node_alloc(struct man *m, int line, int pos, 
+		enum man_type type, enum mant tok)
 {
 	struct man_node *p;
 
@@ -241,6 +244,10 @@ man_node_alloc(int line, int pos, enum man_type type, enum mant tok)
 	p->pos = pos;
 	p->type = type;
 	p->tok = tok;
+
+	if (MAN_NEWLINE & m->flags)
+		p->flags |= MAN_LINE;
+	m->flags &= ~MAN_NEWLINE;
 	return(p);
 }
 
@@ -250,7 +257,20 @@ man_elem_alloc(struct man *m, int line, int pos, enum mant tok)
 {
 	struct man_node *p;
 
-	p = man_node_alloc(line, pos, MAN_ELEM, tok);
+	p = man_node_alloc(m, line, pos, MAN_ELEM, tok);
+	if ( ! man_node_append(m, p))
+		return(0);
+	m->next = MAN_NEXT_CHILD;
+	return(1);
+}
+
+
+int
+man_tail_alloc(struct man *m, int line, int pos, enum mant tok)
+{
+	struct man_node *p;
+
+	p = man_node_alloc(m, line, pos, MAN_TAIL, tok);
 	if ( ! man_node_append(m, p))
 		return(0);
 	m->next = MAN_NEXT_CHILD;
@@ -263,7 +283,7 @@ man_head_alloc(struct man *m, int line, int pos, enum mant tok)
 {
 	struct man_node *p;
 
-	p = man_node_alloc(line, pos, MAN_HEAD, tok);
+	p = man_node_alloc(m, line, pos, MAN_HEAD, tok);
 	if ( ! man_node_append(m, p))
 		return(0);
 	m->next = MAN_NEXT_CHILD;
@@ -276,7 +296,7 @@ man_body_alloc(struct man *m, int line, int pos, enum mant tok)
 {
 	struct man_node *p;
 
-	p = man_node_alloc(line, pos, MAN_BODY, tok);
+	p = man_node_alloc(m, line, pos, MAN_BODY, tok);
 	if ( ! man_node_append(m, p))
 		return(0);
 	m->next = MAN_NEXT_CHILD;
@@ -289,28 +309,20 @@ man_block_alloc(struct man *m, int line, int pos, enum mant tok)
 {
 	struct man_node *p;
 
-	p = man_node_alloc(line, pos, MAN_BLOCK, tok);
+	p = man_node_alloc(m, line, pos, MAN_BLOCK, tok);
 	if ( ! man_node_append(m, p))
 		return(0);
 	m->next = MAN_NEXT_CHILD;
 	return(1);
 }
 
-
 int
 man_word_alloc(struct man *m, int line, int pos, const char *word)
 {
 	struct man_node	*n;
-	size_t		 sv, len;
-
-	len = strlen(word);
-
-	n = man_node_alloc(line, pos, MAN_TEXT, MAN_MAX);
-	n->string = mandoc_malloc(len + 1);
-	sv = strlcpy(n->string, word, len + 1);
 
-	/* Prohibit truncation. */
-	assert(sv < len + 1);
+	n = man_node_alloc(m, line, pos, MAN_TEXT, MAN_MAX);
+	n->string = roff_strdup(m->roff, word);
 
 	if ( ! man_node_append(m, n))
 		return(0);
@@ -345,25 +357,75 @@ man_node_delete(struct man *m, struct man_node *p)
 	man_node_free(p);
 }
 
+int
+man_addeqn(struct man *m, const struct eqn *ep)
+{
+	struct man_node	*n;
+
+	assert( ! (MAN_HALT & m->flags));
+
+	n = man_node_alloc(m, ep->ln, ep->pos, MAN_EQN, MAN_MAX);
+	n->eqn = ep;
+
+	if ( ! man_node_append(m, n))
+		return(0);
+
+	m->next = MAN_NEXT_SIBLING;
+	return(man_descope(m, ep->ln, ep->pos));
+}
+
+int
+man_addspan(struct man *m, const struct tbl_span *sp)
+{
+	struct man_node	*n;
+
+	assert( ! (MAN_HALT & m->flags));
+
+	n = man_node_alloc(m, sp->line, 0, MAN_TBL, MAN_MAX);
+	n->span = sp;
+
+	if ( ! man_node_append(m, n))
+		return(0);
+
+	m->next = MAN_NEXT_SIBLING;
+	return(man_descope(m, sp->line, 0));
+}
 
 static int
-man_ptext(struct man *m, int line, char *buf, int offs)
+man_descope(struct man *m, int line, int offs)
 {
-	int		 i;
+	/*
+	 * Co-ordinate what happens with having a next-line scope open:
+	 * first close out the element scope (if applicable), then close
+	 * out the block scope (also if applicable).
+	 */
+
+	if (MAN_ELINE & m->flags) {
+		m->flags &= ~MAN_ELINE;
+		if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
+			return(0);
+	}
 
-	/* Ignore bogus comments. */
+	if ( ! (MAN_BLINE & m->flags))
+		return(1);
+	m->flags &= ~MAN_BLINE;
 
-	if ('\\' == buf[offs] && 
-			'.' == buf[offs + 1] && 
-			'"' == buf[offs + 2])
-		return(man_pmsg(m, line, offs, MANDOCERR_BADCOMMENT));
+	if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
+		return(0);
+	return(man_body_alloc(m, line, offs, m->last->tok));
+}
+
+static int
+man_ptext(struct man *m, int line, char *buf, int offs)
+{
+	int		 i;
 
 	/* Literal free-form text whitespace is preserved. */
 
 	if (MAN_LITERAL & m->flags) {
 		if ( ! man_word_alloc(m, line, offs, buf + offs))
 			return(0);
-		goto descope;
+		return(man_descope(m, line, offs));
 	}
 
 	/* Pump blank lines directly into the backend. */
@@ -375,7 +437,7 @@ man_ptext(struct man *m, int line, char *buf, int offs)
 		/* Allocate a blank entry. */
 		if ( ! man_word_alloc(m, line, offs, ""))
 			return(0);
-		goto descope;
+		return(man_descope(m, line, offs));
 	}
 
 	/* 
@@ -388,8 +450,7 @@ man_ptext(struct man *m, int line, char *buf, int offs)
 
 	if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
 		if (i > 1 && '\\' != buf[i - 2])
-			if ( ! man_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE))
-				return(0);
+			man_pmsg(m, line, i - 1, MANDOCERR_EOLNSPACE);
 
 		for (--i; i && ' ' == buf[i]; i--)
 			/* Spin back to non-space. */ ;
@@ -410,159 +471,116 @@ man_ptext(struct man *m, int line, char *buf, int offs)
 	 */
 
 	assert(i);
-	if (mandoc_eos(buf, (size_t)i))
+	if (mandoc_eos(buf, (size_t)i, 0))
 		m->last->flags |= MAN_EOS;
 
-descope:
-	/*
-	 * Co-ordinate what happens with having a next-line scope open:
-	 * first close out the element scope (if applicable), then close
-	 * out the block scope (also if applicable).
-	 */
-
-	if (MAN_ELINE & m->flags) {
-		m->flags &= ~MAN_ELINE;
-		if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
-			return(0);
-	}
-
-	if ( ! (MAN_BLINE & m->flags))
-		return(1);
-	m->flags &= ~MAN_BLINE;
-
-	if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
-		return(0);
-	return(man_body_alloc(m, line, offs, m->last->tok));
+	return(man_descope(m, line, offs));
 }
 
-
 static int
-macrowarn(struct man *m, int ln, const char *buf, int offs)
-{
-	int		 rc;
-
-	rc = man_vmsg(m, MANDOCERR_MACRO, ln, offs, 
-			"unknown macro: %s%s",
-			buf, strlen(buf) > 3 ? "..." : "");
-
-	return(MAN_IGN_MACRO & m->pflags ? rc : 0);
-}
-
-
-int
 man_pmacro(struct man *m, int ln, char *buf, int offs)
 {
-	int		 i, j, ppos;
+	int		 i, ppos;
 	enum mant	 tok;
 	char		 mac[5];
 	struct man_node	*n;
 
-	/* Comments and empties are quickly ignored. */
-
-	offs++;
-
-	if ('\0' == buf[offs])
+	if ('"' == buf[offs]) {
+		man_pmsg(m, ln, offs, MANDOCERR_BADCOMMENT);
+		return(1);
+	} else if ('\0' == buf[offs])
 		return(1);
 
-	i = offs;
+	ppos = offs;
 
 	/*
-	 * Skip whitespace between the control character and initial
-	 * text.  "Whitespace" is both spaces and tabs.
+	 * Copy the first word into a nil-terminated buffer.
+	 * Stop copying when a tab, space, or eoln is encountered.
 	 */
 
-	if (' ' == buf[i] || '\t' == buf[i]) {
-		i++;
-		while (buf[i] && (' ' == buf[i] || '\t' == buf[i]))
-			i++;
-		if ('\0' == buf[i])
-			goto out;
-	}
-
-	ppos = i;
-
-	/* Copy the first word into a nil-terminated buffer. */
+	i = 0;
+	while (i < 4 && '\0' != buf[offs] && 
+			' ' != buf[offs] && '\t' != buf[offs])
+		mac[i++] = buf[offs++];
 
-	for (j = 0; j < 4; j++, i++) {
-		if ('\0' == (mac[j] = buf[i]))
-			break;
-		else if (' ' == buf[i])
-			break;
+	mac[i] = '\0';
 
-		/* Check for invalid characters. */
+	tok = (i > 0 && i < 4) ? man_hash_find(mac) : MAN_MAX;
 
-		if (isgraph((u_char)buf[i]))
-			continue;
-		if ( ! man_pmsg(m, ln, i, MANDOCERR_BADCHAR))
-			return(0);
-		i--;
-	}
-
-	mac[j] = '\0';
-
-	if (j == 4 || j < 1) {
-		if ( ! macrowarn(m, ln, mac, ppos))
-			goto err;
-		return(1);
-	}
-	
-	if (MAN_MAX == (tok = man_hash_find(mac))) {
-		if ( ! macrowarn(m, ln, mac, ppos))
-			goto err;
+	if (MAN_MAX == tok) {
+		mandoc_vmsg(MANDOCERR_MACRO, m->parse, ln, 
+				ppos, "%s", buf + ppos - 1);
 		return(1);
 	}
 
 	/* The macro is sane.  Jump to the next word. */
 
-	while (buf[i] && ' ' == buf[i])
-		i++;
+	while (buf[offs] && ' ' == buf[offs])
+		offs++;
 
 	/* 
 	 * Trailing whitespace.  Note that tabs are allowed to be passed
 	 * into the parser as "text", so we only warn about spaces here.
 	 */
 
-	if ('\0' == buf[i] && ' ' == buf[i - 1])
-		if ( ! man_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE))
-			goto err;
+	if ('\0' == buf[offs] && ' ' == buf[offs - 1])
+		man_pmsg(m, ln, offs - 1, MANDOCERR_EOLNSPACE);
 
 	/* 
-	 * Remove prior ELINE macro, as it's being clobbering by a new
+	 * Remove prior ELINE macro, as it's being clobbered by a new
 	 * macro.  Note that NSCOPED macros do not close out ELINE
 	 * macros---they don't print text---so we let those slip by.
 	 */
 
 	if ( ! (MAN_NSCOPED & man_macros[tok].flags) &&
 			m->flags & MAN_ELINE) {
-		assert(MAN_TEXT != m->last->type);
-
-		/*
-		 * This occurs in the following construction:
-		 *   .B
-		 *   .br
-		 *   .B
-		 *   .br
-		 *   I hate man macros.
-		 * Flat-out disallow this madness.
-		 */
-		if (MAN_NSCOPED & man_macros[m->last->tok].flags) {
-			man_pmsg(m, ln, ppos, MANDOCERR_SYNTLINESCOPE);
-			return(0);
-		}
-
 		n = m->last;
+		assert(MAN_TEXT != n->type);
 
-		assert(n);
-		assert(NULL == n->child);
-		assert(0 == n->nchild);
+		/* Remove repeated NSCOPED macros causing ELINE. */
 
-		if ( ! man_nmsg(m, n, MANDOCERR_LINESCOPE))
-			return(0);
+		if (MAN_NSCOPED & man_macros[n->tok].flags)
+			n = n->parent;
+
+		mandoc_vmsg(MANDOCERR_LINESCOPE, m->parse, n->line, 
+		    n->pos, "%s breaks %s", man_macronames[tok],
+		    man_macronames[n->tok]);
 
 		man_node_delete(m, n);
 		m->flags &= ~MAN_ELINE;
 	}
 
+	/*
+	 * Remove prior BLINE macro that is being clobbered.
+	 */
+	if ((m->flags & MAN_BLINE) &&
+	    (MAN_BSCOPE & man_macros[tok].flags)) {
+		n = m->last;
+
+		/* Might be a text node like 8 in
+		 * .TP 8
+		 * .SH foo
+		 */
+		if (MAN_TEXT == n->type)
+			n = n->parent;
+
+		/* Remove element that didn't end BLINE, if any. */
+		if ( ! (MAN_BSCOPE & man_macros[n->tok].flags))
+			n = n->parent;
+
+		assert(MAN_HEAD == n->type);
+		n = n->parent;
+		assert(MAN_BLOCK == n->type);
+		assert(MAN_SCOPED & man_macros[n->tok].flags);
+
+		mandoc_vmsg(MANDOCERR_LINESCOPE, m->parse, n->line, 
+		    n->pos, "%s breaks %s", man_macronames[tok],
+		    man_macronames[n->tok]);
+
+		man_node_delete(m, n);
+		m->flags &= ~MAN_BLINE;
+	}
+
 	/*
 	 * Save the fact that we're in the next-line for a block.  In
 	 * this way, embedded roff instructions can "remember" state
@@ -575,10 +593,9 @@ man_pmacro(struct man *m, int ln, char *buf, int offs)
 	/* Call to handler... */
 
 	assert(man_macros[tok].fp);
-	if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &i, buf))
+	if ( ! (*man_macros[tok].fp)(m, tok, ln, ppos, &offs, buf))
 		goto err;
 
-out:
 	/* 
 	 * We weren't in a block-line scope when entering the
 	 * above-parsed macro, so return.
@@ -615,7 +632,7 @@ out:
 
 	if ( ! man_unscope(m, m->last->parent, MANDOCERR_MAX))
 		return(0);
-	return(man_body_alloc(m, ln, offs, m->last->tok));
+	return(man_body_alloc(m, ln, ppos, m->last->tok));
 
 err:	/* Error out. */
 
@@ -623,21 +640,6 @@ err:	/* Error out. */
 	return(0);
 }
 
-
-int
-man_vmsg(struct man *man, enum mandocerr t, 
-		int ln, int pos, const char *fmt, ...)
-{
-	char		 buf[256];
-	va_list		 ap;
-
-	va_start(ap, fmt);
-	vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
-	va_end(ap);
-	return((*man->msg)(t, man->data, ln, pos, buf));
-}
-
-
 /*
  * Unlink a node from its context.  If "m" is provided, the last parse
  * point will also be adjusted accordingly.
@@ -678,3 +680,11 @@ man_node_unlink(struct man *m, struct man_node *n)
 	if (m && m->first == n)
 		m->first = NULL;
 }
+
+const struct mparse *
+man_mparse(const struct man *m)
+{
+
+	assert(m && m->parse);
+	return(m->parse);
+}