===================================================================
RCS file: /cvs/mandoc/Attic/validate.c,v
retrieving revision 1.27
retrieving revision 1.33
diff -u -p -r1.27 -r1.33
--- mandoc/Attic/validate.c	2009/01/12 17:26:42	1.27
+++ mandoc/Attic/validate.c	2009/01/16 14:04:26	1.33
@@ -1,4 +1,4 @@
-/* $Id: validate.c,v 1.27 2009/01/12 17:26:42 kristaps Exp $ */
+/* $Id: validate.c,v 1.33 2009/01/16 14:04:26 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -31,11 +31,20 @@ struct	valids {
 	v_post	*post;
 };
 
+static	int	pre_check_parent(struct mdoc *, struct mdoc_node *, 
+			int, enum mdoc_type);
+static	int	pre_check_msecs(struct mdoc *, struct mdoc_node *, 
+			int, enum mdoc_msec *);
 
 static	int	pre_display(struct mdoc *, struct mdoc_node *);
+static	int	pre_sh(struct mdoc *, struct mdoc_node *);
+static	int	pre_ss(struct mdoc *, struct mdoc_node *);
 static	int	pre_bd(struct mdoc *, struct mdoc_node *);
 static	int	pre_bl(struct mdoc *, struct mdoc_node *);
 static	int	pre_it(struct mdoc *, struct mdoc_node *);
+static	int	pre_cd(struct mdoc *, struct mdoc_node *);
+static	int	pre_er(struct mdoc *, struct mdoc_node *);
+static	int	pre_ex(struct mdoc *, struct mdoc_node *);
 static	int	pre_prologue(struct mdoc *, struct mdoc_node *);
 static	int	pre_prologue(struct mdoc *, struct mdoc_node *);
 static	int	pre_prologue(struct mdoc *, struct mdoc_node *);
@@ -58,6 +67,11 @@ static	v_pre	pres_d1[] = { pre_display, NULL };
 static	v_pre	pres_bd[] = { pre_display, pre_bd, NULL };
 static	v_pre	pres_bl[] = { pre_bl, NULL };
 static	v_pre	pres_it[] = { pre_it, NULL };
+static	v_pre	pres_ss[] = { pre_ss, NULL };
+static	v_pre	pres_sh[] = { pre_sh, NULL };
+static	v_pre	pres_cd[] = { pre_cd, NULL };
+static	v_pre	pres_er[] = { pre_er, NULL };
+static	v_pre	pres_ex[] = { pre_ex, NULL };
 
 static	v_post	posts_bd[] = { headchild_err_eq0, bodychild_warn_ge1, NULL };
 static	v_post	posts_text[] = { elemchild_err_ge1, NULL };
@@ -79,9 +93,9 @@ const	struct valids mdoc_valids[MDOC_MAX] = {
 	{ pres_prologue, NULL }, /* Os */
 	/* FIXME: preceding Pp. */ 
 	/* FIXME: NAME section internal ordering. */
-	{ NULL, posts_sh }, /* Sh */ 
+	{ pres_sh, posts_sh }, /* Sh */ 
 	/* FIXME: preceding Pp. */
-	{ NULL, posts_ss }, /* Ss */ 
+	{ pres_ss, posts_ss }, /* Ss */ 
 	/* FIXME: proceeding... */
 	{ NULL, posts_pp }, /* Pp */ 
 	{ pres_d1, posts_d1 }, /* D1 */
@@ -94,16 +108,15 @@ const	struct valids mdoc_valids[MDOC_MAX] = {
 	{ NULL, NULL }, /* El */
 	{ pres_it, posts_it }, /* It */
 	{ NULL, posts_text }, /* Ad */ 
-	/* FIXME */
+	/* FIXME: argument OR parameters. */
 	{ NULL, NULL }, /* An */ 
 	{ NULL, NULL }, /* Ar */
-
-	{ NULL, posts_text }, /* Cd */ /* FIXME: section 4 only. */
+	{ pres_cd, posts_text }, /* Cd */ 
 	{ NULL, NULL }, /* Cm */
 	{ NULL, posts_text }, /* Dv */ 
-	{ NULL, posts_text }, /* Er */ /* FIXME: section 2 only. */
+	{ pres_er, posts_text }, /* Er */ 
 	{ NULL, posts_text }, /* Ev */ 
-	{ NULL, posts_notext }, /* Ex */ /* FIXME: sections 1,6,8 only. */ /* -std required */
+	{ pres_ex, posts_notext }, /* Ex */ /* FIXME: -std required */
 	{ NULL, posts_text }, /* Fa */ 
 	{ NULL, NULL }, /* Fd */ /* FIXME: SYNOPSIS section. */
 	{ NULL, NULL }, /* Fl */
@@ -158,7 +171,7 @@ const	struct valids mdoc_valids[MDOC_MAX] = {
 	{ NULL, NULL }, /* Nx */
 	{ NULL, NULL }, /* Ox */
 	{ NULL, NULL }, /* Pc */
-	{ NULL, NULL }, /* Pf */ /* FIXME: 2 or more arguments */
+	{ NULL, NULL }, /* Pf */ /* FIXME: 2 or more arguments */ /* First should be text. */
 	{ NULL, NULL }, /* Po */
 	{ NULL, posts_wline }, /* Pq */ /* FIXME: ignore following Sh/Ss */
 	{ NULL, NULL }, /* Qc */
@@ -191,6 +204,37 @@ const	struct valids mdoc_valids[MDOC_MAX] = {
 
 
 static int
+pre_check_msecs(struct mdoc *mdoc, struct mdoc_node *node, 
+		int sz, enum mdoc_msec *msecs)
+{
+	int		 i;
+
+	for (i = 0; i < sz; i++)
+		if (msecs[i] == mdoc->meta.msec)
+			return(1);
+	return(mdoc_nwarn(mdoc, node, WARN_COMPAT,
+				"macro is not appropriate for this manual section"));
+}
+
+
+static int
+pre_check_parent(struct mdoc *mdoc, struct mdoc_node *node, 
+		int tok, enum mdoc_type type)
+{
+
+	if (type != mdoc->last->parent->type) 
+		return(mdoc_nerr(mdoc, node, "invalid macro parent class %s, expected %s", 
+					mdoc_type2a(mdoc->last->parent->type),
+					mdoc_type2a(type)));
+	if (MDOC_ROOT != type && tok == mdoc->last->parent->tok)
+		return(mdoc_nerr(mdoc, node, "invalid macro parent `%s', expected `%s'", 
+					mdoc_macronames[mdoc->last->parent->tok],
+					mdoc_macronames[tok]));
+	return(1);
+}
+
+
+static int
 bodychild_err_eq0(struct mdoc *mdoc)
 {
 
@@ -198,7 +242,7 @@ bodychild_err_eq0(struct mdoc *mdoc)
 		return(1);
 	if (NULL == mdoc->last->child)
 		return(1);
-	return(mdoc_warn(mdoc, WARN_ARGS_EQ0));
+	return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no body children"));
 }
 
 
@@ -210,7 +254,7 @@ bodychild_warn_ge1(struct mdoc *mdoc)
 		return(1);
 	if (mdoc->last->child)
 		return(1);
-	return(mdoc_warn(mdoc, WARN_ARGS_GE1));
+	return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more body children"));
 }
 
 
@@ -222,7 +266,7 @@ elemchild_warn_eq0(struct mdoc *mdoc)
 	if (NULL == mdoc->last->child)
 		return(1);
 	return(mdoc_pwarn(mdoc, mdoc->last->child->line,
-			mdoc->last->child->pos, WARN_ARGS_EQ0));
+			mdoc->last->child->pos, WARN_SYNTAX, "macro suggests no parameters"));
 }
 
 
@@ -233,7 +277,7 @@ elemchild_warn_ge1(struct mdoc *mdoc)
 	assert(MDOC_ELEM == mdoc->last->type);
 	if (mdoc->last->child)
 		return(1);
-	return(mdoc_warn(mdoc, WARN_ARGS_GE1));
+	return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));
 }
 
 
@@ -244,7 +288,7 @@ elemchild_err_eq0(struct mdoc *mdoc)
 	assert(MDOC_ELEM == mdoc->last->type);
 	if (NULL == mdoc->last->child)
 		return(1);
-	return(mdoc_err(mdoc, ERR_ARGS_EQ0));
+	return(mdoc_err(mdoc, "macro expects no parameters"));
 }
 
 
@@ -255,7 +299,7 @@ elemchild_err_ge1(struct mdoc *mdoc)
 	assert(MDOC_ELEM == mdoc->last->type);
 	if (mdoc->last->child)
 		return(1);
-	return(mdoc_err(mdoc, ERR_ARGS_GE1));
+	return(mdoc_err(mdoc, "macro expects one or more parameters"));
 }
 
 
@@ -268,7 +312,7 @@ headchild_err_eq0(struct mdoc *mdoc)
 	if (NULL == mdoc->last->child)
 		return(1);
 	return(mdoc_perr(mdoc, mdoc->last->child->line,
-			mdoc->last->child->pos, ERR_ARGS_EQ0));
+			mdoc->last->child->pos, "macro expects no parameters"));
 }
 
 
@@ -280,7 +324,7 @@ headchild_warn_ge1(struct mdoc *mdoc)
 		return(1);
 	if (mdoc->last->child)
 		return(1);
-	return(mdoc_warn(mdoc, WARN_ARGS_GE1));
+	return(mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests one or more parameters"));
 }
 
 
@@ -292,7 +336,7 @@ headchild_err_ge1(struct mdoc *mdoc)
 		return(1);
 	if (mdoc->last->child)
 		return(1);
-	return(mdoc_err(mdoc, ERR_ARGS_GE1));
+	return(mdoc_err(mdoc, "macro expects one or more parameters"));
 }
 
 
@@ -304,13 +348,14 @@ pre_display(struct mdoc *mdoc, struct mdoc_node *node)
 	if (MDOC_BLOCK != node->type)
 		return(1);
 
-	for (n = mdoc->last; n; n = n->parent) 
+	assert(mdoc->last);
+	for (n = mdoc->last->parent; n; n = n->parent) 
 		if (MDOC_BLOCK == n->type)
 			if (MDOC_Bd == n->tok)
 				break;
 	if (NULL == n)
 		return(1);
-	return(mdoc_verr(mdoc, node, ERR_SCOPE_NONEST));
+	return(mdoc_nerr(mdoc, node, "displays may not be nested"));
 }
 
 
@@ -362,12 +407,12 @@ pre_bl(struct mdoc *mdoc, struct mdoc_node *node)
 		}
 	}
 	if (0 == type)
-		return(mdoc_err(mdoc, ERR_SYNTAX_ARGMISS));
+		return(mdoc_err(mdoc, "no list type specified"));
 	if (0 == err)
 		return(1);
 	assert(argv);
 	return(mdoc_perr(mdoc, argv->line, 
-			argv->pos, ERR_SYNTAX_ARGBAD));
+			argv->pos, "only one list type possible"));
 }
 
 
@@ -393,6 +438,8 @@ pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
 			/* FALLTHROUGH */
 		case (MDOC_Unfilled):
 			/* FALLTHROUGH */
+		case (MDOC_Filled):
+			/* FALLTHROUGH */
 		case (MDOC_Literal):
 			/* FALLTHROUGH */
 		case (MDOC_File):
@@ -405,38 +452,86 @@ pre_bd(struct mdoc *mdoc, struct mdoc_node *node)
 		}
 	}
 	if (0 == type)
-		return(mdoc_err(mdoc, ERR_SYNTAX_ARGMISS));
+		return(mdoc_err(mdoc, "no display type specified"));
 	if (0 == err)
 		return(1);
 	assert(argv);
 	return(mdoc_perr(mdoc, argv->line, 
-			argv->pos, ERR_SYNTAX_ARGBAD));
+			argv->pos, "only one display type possible"));
 }
 
 
 static int
-pre_it(struct mdoc *mdoc, struct mdoc_node *node)
+pre_ss(struct mdoc *mdoc, struct mdoc_node *node)
 {
 
 	if (MDOC_BLOCK != mdoc->last->type)
 		return(1);
-	assert(MDOC_It == mdoc->last->tok);
+	assert(MDOC_Sh == mdoc->last->tok);
+	return(pre_check_parent(mdoc, node, MDOC_Sh, MDOC_BODY));
+}
 
-	if (MDOC_BODY != mdoc->last->parent->type) 
-		return(mdoc_verr(mdoc, node, ERR_SYNTAX_PARENTBAD));
-	if (MDOC_Bl != mdoc->last->parent->tok)
-		return(mdoc_verr(mdoc, node, ERR_SYNTAX_PARENTBAD));
 
-	return(1);
+static int
+pre_sh(struct mdoc *mdoc, struct mdoc_node *node)
+{
+
+	if (MDOC_BLOCK != mdoc->last->type)
+		return(1);
+	assert(MDOC_Sh == mdoc->last->tok);
+	return(pre_check_parent(mdoc, node, -1, MDOC_ROOT));
 }
 
 
 static int
+pre_ex(struct mdoc *mdoc, struct mdoc_node *node)
+{
+	enum mdoc_msec	 msecs[3];
+
+	msecs[0] = MSEC_1;
+	msecs[1] = MSEC_6;
+	msecs[2] = MSEC_8;
+	return(pre_check_msecs(mdoc, node, 3, msecs));
+}
+
+
+static int
+pre_er(struct mdoc *mdoc, struct mdoc_node *node)
+{
+	enum mdoc_msec	 msecs[1];
+
+	msecs[0] = MSEC_2;
+	return(pre_check_msecs(mdoc, node, 1, msecs));
+}
+
+
+static int
+pre_cd(struct mdoc *mdoc, struct mdoc_node *node)
+{
+	enum mdoc_msec	 msecs[1];
+
+	msecs[0] = MSEC_4;
+	return(pre_check_msecs(mdoc, node, 1, msecs));
+}
+
+
+static int
+pre_it(struct mdoc *mdoc, struct mdoc_node *node)
+{
+
+	if (MDOC_BLOCK != mdoc->last->type)
+		return(1);
+	assert(MDOC_It == mdoc->last->tok);
+	return(pre_check_parent(mdoc, node, MDOC_Bl, MDOC_BODY));
+}
+
+
+static int
 pre_prologue(struct mdoc *mdoc, struct mdoc_node *node)
 {
 
 	if (SEC_PROLOGUE != mdoc->sec_lastn)
-		return(mdoc_verr(mdoc, node, ERR_SEC_NPROLOGUE));
+		return(mdoc_nerr(mdoc, node, "macro may only be invoked in the prologue"));
 	assert(MDOC_ELEM == node->type);
 
 	/* Check for ordering. */
@@ -445,15 +540,15 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
 	case (MDOC_Os):
 		if (mdoc->meta.title[0] && mdoc->meta.date)
 			break;
-		return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));
+		return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
 	case (MDOC_Dt):
 		if (0 == mdoc->meta.title[0] && mdoc->meta.date)
 			break;
-		return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));
+		return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
 	case (MDOC_Dd):
 		if (0 == mdoc->meta.title[0] && 0 == mdoc->meta.date)
 			break;
-		return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_OO));
+		return(mdoc_nerr(mdoc, node, "prologue macro out-of-order"));
 	default:
 		abort();
 		/* NOTREACHED */
@@ -479,7 +574,7 @@ pre_prologue(struct mdoc *mdoc, struct mdoc_node *node
 		/* NOTREACHED */
 	}
 
-	return(mdoc_verr(mdoc, node, ERR_SEC_PROLOGUE_REP));
+	return(mdoc_nerr(mdoc, node, "prologue macro repeated"));
 }
 
 
@@ -547,32 +642,34 @@ post_it(struct mdoc *mdoc)
 	assert(TYPE_NONE != type);
 
 	if (TYPE_HEAD == type) {
-		if (NULL == (n = mdoc->last->data.block.head)) {
-			if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYHEAD))
+		n = mdoc->last->data.block.head;
+		assert(n);
+		if (NULL == n->child)
+			if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests line parameters"))
 				return(0);
-		} else if (NULL == n->child)
-			if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYHEAD))
-				return(0);
 
-		if (NULL == (n = mdoc->last->data.block.body)) {
-			if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYBODY))
+		n = mdoc->last->data.block.body;
+		assert(n);
+		if (NULL == n->child)
+			if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))
 				return(0);
-		} else if (NULL == n->child)
-			if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYBODY))
-				return(0);
 
 		return(1);
 	}
 
-	if (NULL == (n = mdoc->last->data.block.head)) {
-		if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYHEAD))
+	assert(TYPE_BODY == type);
+	assert(mdoc->last->data.block.head);
+
+	n = mdoc->last->data.block.head;
+	assert(n);
+	if (n->child)
+		if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests no line parameters"))
 			return(0);
-	} else if (NULL == n->child)
-		if ( ! mdoc_warn(mdoc, WARN_SYNTAX_EMPTYHEAD))
-			return(0);
 
-	if ((n = mdoc->last->data.block.body) && n->child)
-		if ( ! mdoc_warn(mdoc, WARN_SYNTAX_NOBODY))
+	n = mdoc->last->data.block.body;
+	assert(n);
+	if (NULL == n->child)
+		if ( ! mdoc_warn(mdoc, WARN_SYNTAX, "macro suggests body children"))
 			return(0);
 
 	if (MDOC_Column != sv) 
@@ -588,7 +685,7 @@ post_it(struct mdoc *mdoc)
 
 	if (i == (size_t)sv)
 		return(1);
-	return(mdoc_err(mdoc, ERR_SYNTAX_ARGFORM));
+	return(mdoc_err(mdoc, "expected %d list columns, have %d", sv, (int)i));
 
 #undef	TYPE_NONE
 #undef	TYPE_BODY
@@ -614,7 +711,7 @@ post_bl(struct mdoc *mdoc)
 	}
 	if (NULL == n)
 		return(1);
-	return(mdoc_verr(mdoc, n, ERR_SYNTAX_CHILDBAD));
+	return(mdoc_nerr(mdoc, n, "invalid child of parent macro `Bl'"));
 }
 
 
@@ -649,8 +746,8 @@ post_sh(struct mdoc *mdoc)
 		return(1);
 
 	if (sec == mdoc->sec_lastn)
-		return(mdoc_warn(mdoc, WARN_SEC_REP));
-	return(mdoc_warn(mdoc, WARN_SEC_OO));
+		return(mdoc_warn(mdoc, WARN_SYNTAX, "section repeated"));
+	return(mdoc_warn(mdoc, WARN_SYNTAX, "section out of conventional order"));
 }
 
 
@@ -681,8 +778,10 @@ mdoc_valid_post(struct mdoc *mdoc)
 
 	if (MDOC_TEXT == mdoc->last->type)
 		return(1);
-	if (MDOC_ROOT == mdoc->last->type)
+	if (MDOC_ROOT == mdoc->last->type) {
+		/* TODO: make sure prologue is complete. */
 		return(1);
+	}
 
 	if (NULL == mdoc_valids[mdoc->last->tok].post)
 		return(1);