Fixed `Bd' prior vertical space (was ignoring -compact).

[mandoc.git] / mdoc_term.c

diff --git a/mdoc_term.c b/mdoc_term.c
index 998607c12d3ba74d9beae3739c33e93a1f84f9cd..4c0c8af632c1e5e734d98b431daec8dc31f0d193 100644 (file)
--- a/mdoc_term.c
+++ b/mdoc_term.c
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_term.c,v 1.79 2009/09/24 09:20:02 kristaps Exp $ */
+/*     $Id: mdoc_term.c,v 1.85 2009/09/26 17:35:49 kristaps Exp $ */

 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *


@@ -106,6 +106,7 @@ static      void      termp_sq_post(DECL_ARGS);
 static void      termp_ss_post(DECL_ARGS);
 static void      termp_vt_post(DECL_ARGS);
 
 static void      termp_ss_post(DECL_ARGS);
 static void      termp_vt_post(DECL_ARGS);
 

+static int       termp__t_pre(DECL_ARGS);

 static int       termp_an_pre(DECL_ARGS);
 static int       termp_ap_pre(DECL_ARGS);
 static int       termp_aq_pre(DECL_ARGS);
 static int       termp_an_pre(DECL_ARGS);
 static int       termp_ap_pre(DECL_ARGS);
 static int       termp_aq_pre(DECL_ARGS);


@@ -189,15 +190,15 @@ static    const struct termact termacts[MDOC_MAX] = {
        { termp_under_pre, termp_vt_post }, /* Vt */
        { termp_xr_pre, NULL }, /* Xr */
        { NULL, termp____post }, /* %A */
        { termp_under_pre, termp_vt_post }, /* Vt */
        { termp_xr_pre, NULL }, /* Xr */
        { NULL, termp____post }, /* %A */

-       { NULL, termp____post }, /* %B */
+       { termp_under_pre, termp____post }, /* %B */

        { NULL, termp____post }, /* %D */
        { NULL, termp____post }, /* %D */

-       { NULL, termp____post }, /* %I */
+       { termp_under_pre, termp____post }, /* %I */

        { termp_under_pre, termp____post }, /* %J */
        { NULL, termp____post }, /* %N */
        { NULL, termp____post }, /* %O */
        { NULL, termp____post }, /* %P */
        { NULL, termp____post }, /* %R */
        { termp_under_pre, termp____post }, /* %J */
        { NULL, termp____post }, /* %N */
        { NULL, termp____post }, /* %O */
        { NULL, termp____post }, /* %P */
        { NULL, termp____post }, /* %R */

-       { termp_under_pre, termp____post }, /* %T */
+       { termp__t_pre, termp____post }, /* %T */

        { NULL, termp____post }, /* %V */
        { NULL, NULL }, /* Ac */
        { termp_aq_pre, termp_aq_post }, /* Ao */
        { NULL, termp____post }, /* %V */
        { NULL, NULL }, /* Ac */
        { termp_aq_pre, termp_aq_post }, /* Ao */


@@ -218,7 +219,7 @@ static      const struct termact termacts[MDOC_MAX] = {
        { termp_under_pre, NULL }, /* Em */ 
        { NULL, NULL }, /* Eo */
        { termp_xx_pre, NULL }, /* Fx */
        { termp_under_pre, NULL }, /* Em */ 
        { NULL, NULL }, /* Eo */
        { termp_xx_pre, NULL }, /* Fx */

-       { termp_bold_pre, NULL }, /* Ms */
+       { termp_bold_pre, NULL }, /* Ms */ /* FIXME: convert to symbol? */

        { NULL, NULL }, /* No */
        { termp_ns_pre, NULL }, /* Ns */
        { termp_xx_pre, NULL }, /* Nx */
        { NULL, NULL }, /* No */
        { termp_ns_pre, NULL }, /* Ns */
        { termp_xx_pre, NULL }, /* Nx */


@@ -260,11 +261,11 @@ static    const struct termact termacts[MDOC_MAX] = {
        { termp_brq_pre, termp_brq_post }, /* Brq */ 
        { termp_brq_pre, termp_brq_post }, /* Bro */ 
        { NULL, NULL }, /* Brc */ 
        { termp_brq_pre, termp_brq_post }, /* Brq */ 
        { termp_brq_pre, termp_brq_post }, /* Bro */ 
        { NULL, NULL }, /* Brc */ 

-       { NULL, NULL }, /* %C */ 
-       { NULL, NULL }, /* Es */ 
-       { NULL, NULL }, /* En */ 
+       { NULL, termp____post }, /* %C */ 
+       { NULL, NULL }, /* Es */ /* TODO */
+       { NULL, NULL }, /* En */ /* TODO */

        { termp_xx_pre, NULL }, /* Dx */ 
        { termp_xx_pre, NULL }, /* Dx */ 

-       { NULL, NULL }, /* %Q */ 
+       { NULL, termp____post }, /* %Q */ 

        { termp_sp_pre, NULL }, /* br */
        { termp_sp_pre, NULL }, /* sp */ 
 };
        { termp_sp_pre, NULL }, /* br */
        { termp_sp_pre, NULL }, /* sp */ 
 };


@@ -638,15 +639,10 @@ fmt_block_vspace(struct termp *p,
        const struct mdoc_node *n;
 
        term_newln(p);
        const struct mdoc_node *n;
 
        term_newln(p);

-
-       if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Compact, bl))
+       if (arg_hasattr(MDOC_Compact, bl))

                return;
                return;

-       assert(node);

 
 

-       /*
-        * Search through our prior nodes.  If we follow a `Ss' or `Sh',
-        * then don't vspace.
-        */
+       /* Do not vspace directly after Ss/Sh. */

 
        for (n = node; n; n = n->parent) {
                if (MDOC_BLOCK != n->type)
 
        for (n = node; n; n = n->parent) {
                if (MDOC_BLOCK != n->type)


@@ -660,19 +656,14 @@ fmt_block_vspace(struct termp *p,
                break;
        }
 
                break;
        }
 

-       /* 
-        * XXX - not documented: a `-column' does not ever assert vspace
-        * within the list.
-        */
+       /* A `-column' does not assert vspace within the list. */

 
        if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Column, bl))
                if (node->prev && MDOC_It == node->prev->tok)
                        return;
 
 
        if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Column, bl))
                if (node->prev && MDOC_It == node->prev->tok)
                        return;
 

-       /*
-        * XXX - not documented: a `-diag' without a body does not
-        * assert a vspace prior to the next element. 
-        */
+       /* A `-diag' without body does not vspace. */
+

        if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Diag, bl)) 
                if (node->prev && MDOC_It == node->prev->tok) {
                        assert(node->prev->body);
        if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Diag, bl)) 
                if (node->prev && MDOC_It == node->prev->tok) {
                        assert(node->prev->body);


@@ -1099,13 +1090,12 @@ termp_an_pre(DECL_ARGS)
                return(1);
 
        /*
                return(1);
 
        /*

-        * XXX: this is poorly documented.  If not in the AUTHORS
-        * section, `An -split' will cause newlines to occur before the
-        * author name.  If in the AUTHORS section, by default, the
-        * first `An' invocation is nosplit, then all subsequent ones,
-        * regardless of whether interspersed with other macros/text,
-        * are split.  -split, in this case, will override the condition
-        * of the implied first -nosplit.
+        * If not in the AUTHORS section, `An -split' will cause
+        * newlines to occur before the author name.  If in the AUTHORS
+        * section, by default, the first `An' invocation is nosplit,
+        * then all subsequent ones, regardless of whether interspersed
+        * with other macros/text, are split.  -split, in this case,
+        * will override the condition of the implied first -nosplit.

         */
        
        if (node->sec == SEC_AUTHORS) {
         */
        
        if (node->sec == SEC_AUTHORS) {


@@ -1164,6 +1154,8 @@ static int
 termp_rs_pre(DECL_ARGS)
 {
 
 termp_rs_pre(DECL_ARGS)
 {
 

+       if (SEC_SEE_ALSO != node->sec)
+               return(1);

        if (MDOC_BLOCK == node->type && node->prev)
                term_vspace(p);
        return(1);
        if (MDOC_BLOCK == node->type && node->prev)
                term_vspace(p);
        return(1);


@@ -1349,10 +1341,9 @@ termp_fd_post(DECL_ARGS)
 static int
 termp_sh_pre(DECL_ARGS)
 {
 static int
 termp_sh_pre(DECL_ARGS)
 {

-       /* 
-        * XXX: undocumented: using two `Sh' macros in sequence has no
-        * vspace between calls, only a newline.
-        */
+
+       /* No vspace between consecutive `Sh' calls. */
+

        switch (node->type) {
        case (MDOC_BLOCK):
                if (node->prev && MDOC_Sh == node->prev->tok)
        switch (node->type) {
        case (MDOC_BLOCK):
                if (node->prev && MDOC_Sh == node->prev->tok)


@@ -1415,7 +1406,7 @@ termp_bt_pre(DECL_ARGS)
 {
 
        term_word(p, "is currently in beta test.");
 {
 
        term_word(p, "is currently in beta test.");

-       return(1);
+       return(0);

 }
 
 
 }
 
 


@@ -1424,7 +1415,8 @@ static void
 termp_lb_post(DECL_ARGS)
 {
 
 termp_lb_post(DECL_ARGS)
 {
 

-       term_newln(p);
+       if (SEC_LIBRARY == node->sec)
+               term_newln(p);

 }
 
 
 }
 
 


@@ -1516,10 +1508,6 @@ termp_fn_pre(DECL_ARGS)
 {
        const struct mdoc_node *n;
 
 {
        const struct mdoc_node *n;
 

-       assert(node->child && MDOC_TEXT == node->child->type);
-
-       /* FIXME: can be "type funcname" "type varname"... */
-

        p->bold++;
        term_word(p, node->child->string);
        p->bold--;
        p->bold++;
        term_word(p, node->child->string);
        p->bold--;


@@ -1584,18 +1572,8 @@ termp_fa_pre(DECL_ARGS)
 static int
 termp_bd_pre(DECL_ARGS)
 {
 static int
 termp_bd_pre(DECL_ARGS)
 {

-       int              i, type;
-
-       /*
-        * This is fairly tricky due primarily to crappy documentation.
-        * If -ragged or -filled are specified, the block does nothing
-        * but change the indentation.
-        *
-        * If, on the other hand, -unfilled or -literal are specified,
-        * then the game changes.  Text is printed exactly as entered in
-        * the display: if a macro line, a newline is appended to the
-        * line.  Blank lines are allowed.
-        */
+       int                      i, type;
+       const struct mdoc_node  *nn;

 
        if (MDOC_BLOCK == node->type) {
                fmt_block_vspace(p, node, node);
 
        if (MDOC_BLOCK == node->type) {
                fmt_block_vspace(p, node, node);


@@ -1603,11 +1581,10 @@ termp_bd_pre(DECL_ARGS)
        } else if (MDOC_BODY != node->type)
                return(1);
 
        } else if (MDOC_BODY != node->type)
                return(1);
 

-       assert(node->parent->args);
+       nn = node->parent;

 
 

-       for (type = -1, i = 0; -1 == type && 
-                       i < (int)node->parent->args->argc; i++) {
-               switch (node->parent->args->argv[i].arg) {
+       for (type = -1, i = 0; i < (int)nn->args->argc; i++) {
+               switch (nn->args->argv[i].arg) {

                case (MDOC_Ragged):
                        /* FALLTHROUGH */
                case (MDOC_Filled):
                case (MDOC_Ragged):
                        /* FALLTHROUGH */
                case (MDOC_Filled):


@@ -1615,32 +1592,33 @@ termp_bd_pre(DECL_ARGS)
                case (MDOC_Unfilled):
                        /* FALLTHROUGH */
                case (MDOC_Literal):
                case (MDOC_Unfilled):
                        /* FALLTHROUGH */
                case (MDOC_Literal):

-                       type = node->parent->args->argv[i].arg;
+                       type = nn->args->argv[i].arg;
+                       break;
+               case (MDOC_Offset):
+                       p->offset += arg_offset(&nn->args->argv[i]);

                        break;
                default:
                        break;
                }
        }
                        break;
                default:
                        break;
                }
        }

+
+       /*
+        * If -ragged or -filled are specified, the block does nothing
+        * but change the indentation.  If -unfilled or -literal are
+        * specified, text is printed exactly as entered in the display:
+        * for macro lines, a newline is appended to the line.  Blank
+        * lines are allowed.
+        */

        
        assert(type > -1);
        
        assert(type > -1);

-
-       i = arg_getattr(MDOC_Offset, node->parent);
-       if (-1 != i)
-               p->offset += arg_offset(&node->parent->args->argv[i]);
-
-       switch (type) {
-       case (MDOC_Literal):
-               /* FALLTHROUGH */
-       case (MDOC_Unfilled):
-               break;
-       default:
+       if (MDOC_Literal != type && MDOC_Unfilled != type)

                return(1);
                return(1);

-       }

 
 

-       for (node = node->child; node; node = node->next) {
-               p->flags |= TERMP_NOSPACE;
-               print_node(p, pair, meta, node);
-               if (node->next)
+       for (nn = node->child; nn; nn = nn->next) {
+               print_node(p, pair, meta, nn);
+               if (NULL == nn->next)
+                       continue;
+               if (nn->prev && nn->prev->line < nn->line)

                        term_flushln(p);
        }
 
                        term_flushln(p);
        }
 


@@ -2066,6 +2044,14 @@ termp____post(DECL_ARGS)
 {
 
        p->flags |= TERMP_NOSPACE;
 {
 
        p->flags |= TERMP_NOSPACE;

+       switch (node->tok) {
+       case (MDOC__T):
+               term_word(p, "\\(rq");
+               p->flags |= TERMP_NOSPACE;
+               break;
+       default:
+               break;
+       }

        term_word(p, node->next ? "," : ".");
 }
 
        term_word(p, node->next ? "," : ".");
 }
 


@@ -2107,3 +2093,14 @@ termp_under_pre(DECL_ARGS)
        p->under++;
        return(1);
 }
        p->under++;
        return(1);
 }

+
+
+/* ARGSUSED */
+static int
+termp__t_pre(DECL_ARGS)
+{
+
+       term_word(p, "\\(lq");
+       p->flags |= TERMP_NOSPACE;
+       return(1);
+}