mdocml: Macro lines now infer an `It' if they immediately follow a `Bl

mdocml: Macro lines now infer an `It' if they immediately follow a `Bl

[kristaps]

Log Message:
-----------
Macro lines now infer an `It' if they immediately follow a `Bl -column'
or a closed-out `It' block within a `Bl -column' (which only happens
when a macro or free-form text is encountered prior to an `It').

Added some regression tests for this behaviour.

Modified Files:
--------------
    mdocml:
        TODO
        mdoc.c

Added Files:
-----------
    mdocml/regress/mdoc/It:
        freecol-macro0.in
        freecol-macro1.in
        freecol-macro2.in

Revision Data
-------------
Index: TODO
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/TODO,v
retrieving revision 1.11
retrieving revision 1.12
diff -LTODO -LTODO -u -p -r1.11 -r1.12
--- TODO
+++ TODO
@@ -57,6 +57,8 @@
 
 - explicitly disallow nested `Bl -column', which would clobber internal
   flags defined for struct mdoc_macro
+
+- set a meaningful default if no `Bl' list type is assigned
   
 ************************************************************************
 * formatting issues: ugly output
Index: mdoc.c
===================================================================
RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mdoc.c,v
retrieving revision 1.143
retrieving revision 1.144
diff -Lmdoc.c -Lmdoc.c -u -p -r1.143 -r1.144
--- mdoc.c
+++ mdoc.c
@@ -1,6 +1,6 @@
 /*	$Id$ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009 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
@@ -561,14 +561,15 @@ mdoc_ptext(struct mdoc *m, int line, cha
 	n = m->last;
 
 	/*
-	 * Diver directly into list processing if we're encountering a
+	 * Divert directly to list processing if we're encountering a
 	 * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
-	 * (if it's a MDOC_BODY that means it's open, in which case we
-	 * should process within its context).
+	 * (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.list) {
+		/* `Bl' is open without any children. */
 		m->flags |= MDOC_FREECOL;
 		return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
 	}
@@ -577,6 +578,7 @@ mdoc_ptext(struct mdoc *m, int line, cha
 			NULL != n->parent &&
 			MDOC_Bl == n->parent->tok &&
 			LIST_column == n->parent->data.list) {
+		/* `Bl' has block-level `It' children. */
 		m->flags |= MDOC_FREECOL;
 		return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
 	}
@@ -677,6 +679,7 @@ macrowarn(struct mdoc *m, int ln, const 
 			buf, strlen(buf) > 3 ? "..." : "");
 
 	/* FIXME: logic should be in driver. */
+	/* FIXME: broken, will error out and not omit a message. */
 	return(MDOC_IGN_MACRO & m->pflags ? rc : 0);
 }
 
@@ -688,9 +691,10 @@ macrowarn(struct mdoc *m, int ln, const 
 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. */
 
@@ -758,10 +762,51 @@ mdoc_pmacro(struct mdoc *m, int ln, char
 		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.list) {
+		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.list) {
+		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;
 
--- /dev/null
+++ regress/mdoc/It/freecol-macro2.in
@@ -0,0 +1,18 @@
+.Dd $Mdocdate: May 31 2010 $
+.Dt FOO
+.Os
+.Sh NAME
+.Nm foo
+.Nd bar
+.Sh DESCRIPTION
+hello
+.Bl -column asdfasdfasdf asdfasdfasdf
+.Fl foo Ta bar
+.Ar foo Ta bar
+baz	xyzzy
+.It hello	there
+.It this should Ta
+not break
+.It another Ta
+.Fl try
+.El
--- /dev/null
+++ regress/mdoc/It/freecol-macro0.in
@@ -0,0 +1,12 @@
+.Dd $Mdocdate: May 31 2010 $
+.Dt FOO
+.Os
+.Sh NAME
+.Nm foo
+.Nd bar
+.Sh DESCRIPTION
+hello
+.Bl -column asdfasdf asdfasdf
+.Fl foo Ta bar
+baz	xyzzy
+.El
--- /dev/null
+++ regress/mdoc/It/freecol-macro1.in
@@ -0,0 +1,13 @@
+.Dd $Mdocdate: May 31 2010 $
+.Dt FOO
+.Os
+.Sh NAME
+.Nm foo
+.Nd bar
+.Sh DESCRIPTION
+hello
+.Bl -column asdfasdf asdfasdf
+.Fl foo Ta bar
+.Ar foo Ta bar
+baz	xyzzy
+.El
--
 To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv