]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_term.c
Fix a regression that crept in in man_term.c 1.73 and mdoc_term.c 1.144.
[mandoc.git] / mdoc_term.c
index 98ce0bbe797f1811f39c2fdf79e25aab32da0ea4..7b590ed78313d7b96f3a4609001e7579fd79c1ac 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_term.c,v 1.137 2010/06/04 21:05:39 kristaps 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 */
@@ -290,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);
 }
 
 
@@ -347,11 +348,13 @@ 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);
 
@@ -396,11 +399,13 @@ 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;
@@ -1056,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);
 }
 
@@ -1314,32 +1316,78 @@ termp_xr_pre(DECL_ARGS)
 }
 
 
-static int
-termp_vt_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 (MDOC_ELEM == n->type)
-               return(termp_under_pre(p, pair, m, n));
-       else if (MDOC_HEAD == n->type)
-               return(0);
-       else if (MDOC_BLOCK == n->type)
-               return(1);
+       /*
+        * 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;
+       }
 
-       return(termp_under_pre(p, pair, m, n));
+       /*
+        * 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;
+       }
 }
 
 
-/* ARGSUSED */
-static void
-termp_vt_post(DECL_ARGS)
+static int
+termp_vt_pre(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);
+       if (MDOC_ELEM == n->type) {
+               synopsis_pre(p, n);
+               return(termp_under_pre(p, pair, m, n));
+       } 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));
 }
 
 
@@ -1354,11 +1402,12 @@ termp_bold_pre(DECL_ARGS)
 
 
 /* ARGSUSED */
-static void
-termp_fd_post(DECL_ARGS)
+static int
+termp_fd_pre(DECL_ARGS)
 {
 
-       term_newln(p);
+       synopsis_pre(p, n);
+       return(termp_bold_pre(p, pair, m, n));
 }
 
 
@@ -1511,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);
@@ -1561,16 +1600,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)
@@ -1836,8 +1865,8 @@ static int
 termp_cd_pre(DECL_ARGS)
 {
 
+       synopsis_pre(p, n);
        term_fontpush(p, TERMFONT_BOLD);
-       term_newln(p);
        return(1);
 }
 
@@ -1847,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);
 }
@@ -1862,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);
 }
 
 
@@ -1987,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);
 }
 
@@ -2013,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, ";");
+       }
 }