===================================================================
RCS file: /cvs/mandoc/mdoc_term.c,v
retrieving revision 1.127
retrieving revision 1.146
diff -u -p -r1.127 -r1.146
--- mandoc/mdoc_term.c	2010/05/22 20:41:48	1.127
+++ mandoc/mdoc_term.c	2010/06/10 23:24:37	1.146
@@ -1,4 +1,4 @@
-/*	$Id: mdoc_term.c,v 1.127 2010/05/22 20:41:48 joerg Exp $ */
+/*	$Id: mdoc_term.c,v 1.146 2010/06/10 23:24:37 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -65,9 +65,11 @@ static	void	  print_bvspace(struct termp *,
 			const struct mdoc_node *,
 			const struct mdoc_node *);
 static	void  	  print_mdoc_node(DECL_ARGS);
-static	void	  print_mdoc_head(DECL_ARGS);
 static	void	  print_mdoc_nodelist(DECL_ARGS);
-static	void	  print_foot(DECL_ARGS);
+static	void	  print_mdoc_head(struct termp *, const void *);
+static	void	  print_mdoc_foot(struct termp *, const void *);
+static	void	  synopsis_pre(struct termp *, 
+			const struct mdoc_node *);
 
 static	void	  termp____post(DECL_ARGS);
 static	void	  termp_an_post(DECL_ARGS);
@@ -79,10 +81,8 @@ static	void	  termp_brq_post(DECL_ARGS);
 static	void	  termp_bx_post(DECL_ARGS);
 static	void	  termp_d1_post(DECL_ARGS);
 static	void	  termp_dq_post(DECL_ARGS);
-static	void	  termp_fd_post(DECL_ARGS);
-static	void	  termp_fn_post(DECL_ARGS);
+static	int	  termp_fd_pre(DECL_ARGS);
 static	void	  termp_fo_post(DECL_ARGS);
-static	void	  termp_ft_post(DECL_ARGS);
 static	void	  termp_in_post(DECL_ARGS);
 static	void	  termp_it_post(DECL_ARGS);
 static	void	  termp_lb_post(DECL_ARGS);
@@ -93,7 +93,6 @@ static	void	  termp_qq_post(DECL_ARGS);
 static	void	  termp_sh_post(DECL_ARGS);
 static	void	  termp_sq_post(DECL_ARGS);
 static	void	  termp_ss_post(DECL_ARGS);
-static	void	  termp_vt_post(DECL_ARGS);
 
 static	int	  termp_an_pre(DECL_ARGS);
 static	int	  termp_ap_pre(DECL_ARGS);
@@ -163,10 +162,10 @@ static	const struct termact termacts[MDOC_MAX] = {
 	{ NULL, NULL }, /* Ev */ 
 	{ termp_ex_pre, NULL }, /* Ex */
 	{ termp_fa_pre, NULL }, /* Fa */ 
-	{ termp_bold_pre, termp_fd_post }, /* Fd */ 
+	{ termp_fd_pre, NULL }, /* Fd */ 
 	{ termp_fl_pre, NULL }, /* Fl */
-	{ termp_fn_pre, termp_fn_post }, /* Fn */ 
-	{ termp_ft_pre, termp_ft_post }, /* Ft */ 
+	{ termp_fn_pre, NULL }, /* Fn */ 
+	{ termp_ft_pre, NULL }, /* Ft */ 
 	{ termp_bold_pre, NULL }, /* Ic */ 
 	{ termp_in_pre, termp_in_post }, /* In */ 
 	{ termp_li_pre, NULL }, /* Li */
@@ -178,7 +177,7 @@ static	const struct termact termacts[MDOC_MAX] = {
 	{ termp_rv_pre, NULL }, /* Rv */
 	{ NULL, NULL }, /* St */ 
 	{ termp_under_pre, NULL }, /* Va */
-	{ termp_vt_pre, termp_vt_post }, /* Vt */
+	{ termp_vt_pre, NULL }, /* Vt */
 	{ termp_xr_pre, NULL }, /* Xr */
 	{ NULL, termp____post }, /* %A */
 	{ termp_under_pre, termp____post }, /* %B */
@@ -260,6 +259,7 @@ static	const struct termact termacts[MDOC_MAX] = {
 	{ termp_sp_pre, NULL }, /* br */
 	{ termp_sp_pre, NULL }, /* sp */ 
 	{ termp_under_pre, termp____post }, /* %U */ 
+	{ NULL, NULL }, /* Ta */ 
 };
 
 
@@ -274,6 +274,7 @@ terminal_mdoc(void *arg, const struct mdoc *mdoc)
 
 	p->overstep = 0;
 	p->maxrmargin = p->defrmargin;
+	p->tabwidth = 5;
 
 	if (NULL == p->symtab)
 		switch (p->enc) {
@@ -288,10 +289,12 @@ terminal_mdoc(void *arg, const struct mdoc *mdoc)
 	n = mdoc_node(mdoc);
 	m = mdoc_meta(mdoc);
 
-	print_mdoc_head(p, NULL, m, n);
+	term_begin(p, print_mdoc_head, print_mdoc_foot, m);
+
 	if (n->child)
 		print_mdoc_nodelist(p, NULL, m, n->child);
-	print_foot(p, NULL, m, n);
+
+	term_end(p);
 }
 
 
@@ -345,12 +348,14 @@ print_mdoc_node(DECL_ARGS)
 }
 
 
-/* ARGSUSED */
 static void
-print_foot(DECL_ARGS)
+print_mdoc_foot(struct termp *p, const void *arg)
 {
 	char		buf[DATESIZ], os[BUFSIZ];
+	const struct mdoc_meta *m;
 
+	m = (const struct mdoc_meta *)arg;
+
 	term_fontrepl(p, TERMFONT_NONE);
 
 	/* 
@@ -394,12 +399,14 @@ print_foot(DECL_ARGS)
 }
 
 
-/* ARGSUSED */
 static void
-print_mdoc_head(DECL_ARGS)
+print_mdoc_head(struct termp *p, const void *arg)
 {
 	char		buf[BUFSIZ], title[BUFSIZ];
+	const struct mdoc_meta *m;
 
+	m = (const struct mdoc_meta *)arg;
+
 	p->rmargin = p->maxrmargin;
 	p->offset = 0;
 
@@ -613,7 +620,7 @@ print_bvspace(struct termp *p, 
 
 	/* A `-column' does not assert vspace within the list. */
 
-	if (MDOC_Bl == bl->tok && LIST_diag == bl->data.list)
+	if (MDOC_Bl == bl->tok && LIST_column == bl->data.list)
 		if (n->prev && MDOC_It == n->prev->tok)
 			return;
 
@@ -699,7 +706,7 @@ termp_it_pre(DECL_ARGS)
 
 	switch (type) {
 	case (LIST_column):
-		if (MDOC_BODY == n->type)
+		if (MDOC_HEAD == n->type)
 			break;
 		/*
 		 * Imitate groff's column handling:
@@ -714,8 +721,13 @@ termp_it_pre(DECL_ARGS)
 		/* LINTED */
 		dcol = ncols < 5 ? 4 : ncols == 5 ? 3 : 1;
 
+		/*
+		 * Calculate the offset by applying all prior MDOC_BODY,
+		 * so we stop at the MDOC_HEAD (NULL == nn->prev).
+		 */
+
 		for (i = 0, nn = n->prev; 
-				nn && i < (int)ncols; 
+				nn->prev && i < (int)ncols; 
 				nn = nn->prev, i++)
 			offset += dcol + a2width
 				(&bl->args->argv[vals[2]], i);
@@ -868,15 +880,18 @@ termp_it_pre(DECL_ARGS)
 			p->flags |= TERMP_DANGLE;
 		break;
 	case (LIST_column):
-		if (MDOC_HEAD == n->type) {
-			assert(n->next);
-			if (MDOC_BODY == n->next->type)
-				p->flags &= ~TERMP_NOBREAK;
-			else
-				p->flags |= TERMP_NOBREAK;
-			if (n->prev) 
-				p->flags |= TERMP_NOLPAD;
-		}
+		if (MDOC_HEAD == n->type)
+			break;
+
+		if (NULL == n->next)
+			p->flags &= ~TERMP_NOBREAK;
+		else
+			p->flags |= TERMP_NOBREAK;
+
+		assert(n->prev);
+		if (MDOC_BODY == n->prev->type) 
+			p->flags |= TERMP_NOLPAD;
+
 		break;
 	case (LIST_diag):
 		if (MDOC_HEAD == n->type)
@@ -928,9 +943,9 @@ termp_it_pre(DECL_ARGS)
 		 * XXX - this behaviour is not documented: the
 		 * right-most column is filled to the right margin.
 		 */
-		if (MDOC_HEAD == n->type &&
-				MDOC_BODY == n->next->type &&
-				p->rmargin < p->maxrmargin)
+		if (MDOC_HEAD == n->type)
+			break;
+		if (NULL == n->next && p->rmargin < p->maxrmargin)
 			p->rmargin = p->maxrmargin;
 		break;
 	default:
@@ -984,7 +999,7 @@ termp_it_pre(DECL_ARGS)
 			return(0);
 		break;
 	case (LIST_column):
-		if (MDOC_BODY == n->type)
+		if (MDOC_HEAD == n->type)
 			return(0);
 		break;
 	default:
@@ -1013,14 +1028,14 @@ termp_it_post(DECL_ARGS)
 		/* FALLTHROUGH */
 	case (LIST_inset):
 		if (MDOC_BODY == n->type)
-			term_flushln(p);
+			term_newln(p);
 		break;
 	case (LIST_column):
-		if (MDOC_HEAD == n->type)
+		if (MDOC_BODY == n->type)
 			term_flushln(p);
 		break;
 	default:
-		term_flushln(p);
+		term_newln(p);
 		break;
 	}
 
@@ -1046,14 +1061,11 @@ termp_nm_pre(DECL_ARGS)
 	if (NULL == n->child && NULL == m->name)
 		return(1);
 
-	if (SEC_SYNOPSIS == n->sec && MDOC_LINE & n->flags)
-		term_newln(p);
+	synopsis_pre(p, n);
 
 	term_fontpush(p, TERMFONT_BOLD);
-
 	if (NULL == n->child)
 		term_word(p, m->name);
-
 	return(1);
 }
 
@@ -1191,6 +1203,7 @@ termp_rv_pre(DECL_ARGS)
 	term_fontpop(p);
 
        	term_word(p, "is set to indicate the error.");
+	p->flags |= TERMP_SENTENCE;
 
 	return(0);
 }
@@ -1223,6 +1236,7 @@ termp_ex_pre(DECL_ARGS)
 		term_word(p, "utility exits");
 
        	term_word(p, "0 on success, and >0 if an error occurs.");
+	p->flags |= TERMP_SENTENCE;
 
 	return(0);
 }
@@ -1302,36 +1316,82 @@ termp_xr_pre(DECL_ARGS)
 }
 
 
+/*
+ * This decides how to assert whitespace before any of the SYNOPSIS set
+ * of macros (which, as in the case of Ft/Fo and Ft/Fn, may contain
+ * macro combos).
+ */
+static void
+synopsis_pre(struct termp *p, const struct mdoc_node *n)
+{
+	/* 
+	 * Obviously, if we're not in a SYNOPSIS or no prior macros
+	 * exist, do nothing.
+	 */
+	if (NULL == n->prev || SEC_SYNOPSIS != n->sec)
+		return;
+
+	/*
+	 * If we're the second in a pair of like elements, emit our
+	 * newline and return.  UNLESS we're `Fo', `Fn', `Fn', in which
+	 * case we soldier on.
+	 */
+	if (n->prev->tok == n->tok && 
+			MDOC_Ft != n->tok && 
+			MDOC_Fo != n->tok && 
+			MDOC_Fn != n->tok) {
+		term_newln(p);
+		return;
+	}
+
+	/*
+	 * If we're one of the SYNOPSIS set and non-like pair-wise after
+	 * another (or Fn/Fo, which we've let slip through) then assert
+	 * vertical space, else only newline and move on.
+	 */
+	switch (n->prev->tok) {
+	case (MDOC_Fd):
+		/* FALLTHROUGH */
+	case (MDOC_Fn):
+		/* FALLTHROUGH */
+	case (MDOC_Fo):
+		/* FALLTHROUGH */
+	case (MDOC_In):
+		/* FALLTHROUGH */
+	case (MDOC_Vt):
+		term_vspace(p);
+		break;
+	case (MDOC_Ft):
+		if (MDOC_Fn != n->tok && MDOC_Fo != n->tok) {
+			term_vspace(p);
+			break;
+		}
+		/* FALLTHROUGH */
+	default:
+		term_newln(p);
+		break;
+	}
+}
+
+
 static int
 termp_vt_pre(DECL_ARGS)
 {
 
-	if (MDOC_ELEM == n->type)
+	if (MDOC_ELEM == n->type) {
+		synopsis_pre(p, n);
 		return(termp_under_pre(p, pair, m, n));
-	else if (MDOC_HEAD == n->type)
-		return(0);
-	else if (MDOC_BLOCK == n->type)
+	} else if (MDOC_BLOCK == n->type) {
+		synopsis_pre(p, n);
 		return(1);
+	} else if (MDOC_HEAD == n->type)
+		return(0);
 
 	return(termp_under_pre(p, pair, m, n));
 }
 
 
 /* ARGSUSED */
-static void
-termp_vt_post(DECL_ARGS)
-{
-
-	if (MDOC_BLOCK != n->type)
-		return;
-	if (n->next && MDOC_Vt == n->next->tok)
-		term_newln(p);
-	else if (n->next)
-		term_vspace(p);
-}
-
-
-/* ARGSUSED */
 static int
 termp_bold_pre(DECL_ARGS)
 {
@@ -1342,16 +1402,12 @@ termp_bold_pre(DECL_ARGS)
 
 
 /* ARGSUSED */
-static void
-termp_fd_post(DECL_ARGS)
+static int
+termp_fd_pre(DECL_ARGS)
 {
 
-	if (n->sec != SEC_SYNOPSIS || ! (MDOC_LINE & n->flags))
-		return;
-
-	term_newln(p);
-	if (n->next && MDOC_Fd != n->next->tok)
-		term_vspace(p);
+	synopsis_pre(p, n);
+	return(termp_bold_pre(p, pair, m, n));
 }
 
 
@@ -1424,6 +1480,7 @@ termp_bt_pre(DECL_ARGS)
 {
 
 	term_word(p, "is currently in beta test.");
+	p->flags |= TERMP_SENTENCE;
 	return(0);
 }
 
@@ -1444,6 +1501,7 @@ termp_ud_pre(DECL_ARGS)
 {
 
 	term_word(p, "currently under development.");
+	p->flags |= TERMP_SENTENCE;
 	return(0);
 }
 
@@ -1502,31 +1560,21 @@ static int
 termp_ft_pre(DECL_ARGS)
 {
 
-	if (SEC_SYNOPSIS == n->sec && MDOC_LINE & n->flags)
-		if (n->prev && MDOC_Fo == n->prev->tok)
-			term_vspace(p);
-
+	/* NB: MDOC_LINE does not effect this! */
+	synopsis_pre(p, n);
 	term_fontpush(p, TERMFONT_UNDER);
 	return(1);
 }
 
 
 /* ARGSUSED */
-static void
-termp_ft_post(DECL_ARGS)
-{
-
-	if (SEC_SYNOPSIS == n->sec && MDOC_LINE & n->flags)
-		term_newln(p);
-}
-
-
-/* ARGSUSED */
 static int
 termp_fn_pre(DECL_ARGS)
 {
 	const struct mdoc_node	*nn;
 
+	synopsis_pre(p, n);
+
 	term_fontpush(p, TERMFONT_BOLD);
 	term_word(p, n->child->string);
 	term_fontpop(p);
@@ -1553,16 +1601,6 @@ termp_fn_pre(DECL_ARGS)
 
 
 /* ARGSUSED */
-static void
-termp_fn_post(DECL_ARGS)
-{
-
-	if (n->sec == SEC_SYNOPSIS && n->next && MDOC_LINE & n->flags)
-		term_vspace(p);
-}
-
-
-/* ARGSUSED */
 static int
 termp_fa_pre(DECL_ARGS)
 {
@@ -1593,6 +1631,7 @@ termp_fa_pre(DECL_ARGS)
 static int
 termp_bd_pre(DECL_ARGS)
 {
+	size_t			 tabwidth;
 	int	         	 i, type;
 	size_t			 rm, rmax;
 	const struct mdoc_node	*nn;
@@ -1622,6 +1661,8 @@ termp_bd_pre(DECL_ARGS)
 	if (MDOC_Literal != type && MDOC_Unfilled != type)
 		return(1);
 
+	tabwidth = p->tabwidth;
+	p->tabwidth = 8;
 	rm = p->rmargin;
 	rmax = p->maxrmargin;
 	p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
@@ -1629,13 +1670,12 @@ termp_bd_pre(DECL_ARGS)
 	for (nn = n->child; nn; nn = nn->next) {
 		p->flags |= TERMP_NOSPACE;
 		print_mdoc_node(p, pair, m, nn);
-		if (NULL == nn->next)
-			continue;
-		if (nn->prev && nn->prev->line < nn->line)
+		if (NULL == nn->prev ||
+		    nn->prev->line < nn->line ||
+		    NULL == nn->next)
 			term_flushln(p);
-		else if (NULL == nn->prev)
-			term_flushln(p);
 	}
+	p->tabwidth = tabwidth;
 
 	p->rmargin = rm;
 	p->maxrmargin = rmax;
@@ -1663,7 +1703,7 @@ termp_bd_post(DECL_ARGS)
 		p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
 
 	p->flags |= TERMP_NOSPACE;
-	term_flushln(p);
+	term_newln(p);
 
 	p->rmargin = rm;
 	p->maxrmargin = rmax;
@@ -1825,8 +1865,8 @@ static int
 termp_cd_pre(DECL_ARGS)
 {
 
+	synopsis_pre(p, n);
 	term_fontpush(p, TERMFONT_BOLD);
-	term_newln(p);
 	return(1);
 }
 
@@ -1836,11 +1876,17 @@ static int
 termp_in_pre(DECL_ARGS)
 {
 
-	term_fontpush(p, TERMFONT_BOLD);
-	if (SEC_SYNOPSIS == n->sec)
+	synopsis_pre(p, n);
+
+	if (SEC_SYNOPSIS == n->sec && MDOC_LINE & n->flags) {
+		term_fontpush(p, TERMFONT_BOLD);
 		term_word(p, "#include");
+		term_word(p, "<");
+	} else {
+		term_word(p, "<");
+		term_fontpush(p, TERMFONT_UNDER);
+	}
 
-	term_word(p, "<");
 	p->flags |= TERMP_NOSPACE;
 	return(1);
 }
@@ -1851,23 +1897,14 @@ static void
 termp_in_post(DECL_ARGS)
 {
 
-	term_fontpush(p, TERMFONT_BOLD);
+	if (SEC_SYNOPSIS == n->sec)
+		term_fontpush(p, TERMFONT_BOLD);
+
 	p->flags |= TERMP_NOSPACE;
 	term_word(p, ">");
-	term_fontpop(p);
 
-	if (SEC_SYNOPSIS != n->sec && ! (MDOC_LINE & n->flags))
-		return;
-
-	term_newln(p);
-	/* 
-	 * XXX Not entirely correct.  If `.In foo bar' is specified in
-	 * the SYNOPSIS section, then it produces a single break after
-	 * the <foo>; mandoc asserts a vertical space.  Since this
-	 * construction is rarely used, I think it's fine.
-	 */
-	if (n->next && MDOC_In != n->next->tok)
-		term_vspace(p);
+	if (SEC_SYNOPSIS == n->sec)
+		term_fontpop(p);
 }
 
 
@@ -1976,23 +2013,23 @@ termp_pq_post(DECL_ARGS)
 static int
 termp_fo_pre(DECL_ARGS)
 {
-	const struct mdoc_node *nn;
 
-	if (MDOC_BODY == n->type) {
+	if (MDOC_BLOCK == n->type) {
+		synopsis_pre(p, n);
+		return(1);
+	} else if (MDOC_BODY == n->type) {
 		p->flags |= TERMP_NOSPACE;
 		term_word(p, "(");
 		p->flags |= TERMP_NOSPACE;
 		return(1);
-	} else if (MDOC_HEAD != n->type) 
-		return(1);
+	} 
 
-	term_fontpush(p, TERMFONT_BOLD);
-	for (nn = n->child; nn; nn = nn->next) {
-		assert(MDOC_TEXT == nn->type);
-		term_word(p, nn->string);
-	}
-	term_fontpop(p);
+	/* XXX: we drop non-initial arguments as per groff. */
 
+	assert(n->child);
+	assert(n->child->string);
+	term_fontpush(p, TERMFONT_BOLD);
+	term_word(p, n->child->string);
 	return(0);
 }
 
@@ -2002,13 +2039,16 @@ static void
 termp_fo_post(DECL_ARGS)
 {
 
-	if (MDOC_BODY != n->type)
+	if (MDOC_BODY != n->type) 
 		return;
+
 	p->flags |= TERMP_NOSPACE;
 	term_word(p, ")");
-	p->flags |= TERMP_NOSPACE;
-	term_word(p, ";");
-	term_newln(p);
+
+	if (SEC_SYNOPSIS == n->sec) {
+		p->flags |= TERMP_NOSPACE;
+		term_word(p, ";");
+	}
 }