The semantics of .Bk was described incorrectly

[mandoc.git] / mdoc_term.c

diff --git a/mdoc_term.c b/mdoc_term.c
index 91954258546c6546261d230936f5e4ae25328830..47c212489d331c17f154fb3eca1b09719d838404 100644 (file)
--- a/mdoc_term.c
+++ b/mdoc_term.c
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_term.c,v 1.210 2011/01/25 10:37:49 kristaps Exp $ */
+/*     $Id: mdoc_term.c,v 1.226 2011/04/04 16:27:03 kristaps Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>

  * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any


@@ -32,7 +32,6 @@
 #include "out.h"
 #include "term.h"
 #include "mdoc.h"
 #include "out.h"
 #include "term.h"
 #include "mdoc.h"

-#include "chars.h"

 #include "main.h"
 
 #define        INDENT            5
 #include "main.h"
 
 #define        INDENT            5


@@ -73,7 +72,6 @@ static        void      termp_an_post(DECL_ARGS);
 static void      termp_bd_post(DECL_ARGS);
 static void      termp_bk_post(DECL_ARGS);
 static void      termp_bl_post(DECL_ARGS);
 static void      termp_bd_post(DECL_ARGS);
 static void      termp_bk_post(DECL_ARGS);
 static void      termp_bl_post(DECL_ARGS);

-static void      termp_bx_post(DECL_ARGS);

 static void      termp_d1_post(DECL_ARGS);
 static void      termp_fo_post(DECL_ARGS);
 static void      termp_in_post(DECL_ARGS);
 static void      termp_d1_post(DECL_ARGS);
 static void      termp_fo_post(DECL_ARGS);
 static void      termp_in_post(DECL_ARGS);


@@ -95,6 +93,7 @@ static        int       termp_bk_pre(DECL_ARGS);
 static int       termp_bl_pre(DECL_ARGS);
 static int       termp_bold_pre(DECL_ARGS);
 static int       termp_bt_pre(DECL_ARGS);
 static int       termp_bl_pre(DECL_ARGS);
 static int       termp_bold_pre(DECL_ARGS);
 static int       termp_bt_pre(DECL_ARGS);

+static int       termp_bx_pre(DECL_ARGS);

 static int       termp_cd_pre(DECL_ARGS);
 static int       termp_d1_pre(DECL_ARGS);
 static int       termp_ex_pre(DECL_ARGS);
 static int       termp_cd_pre(DECL_ARGS);
 static int       termp_d1_pre(DECL_ARGS);
 static int       termp_ex_pre(DECL_ARGS);


@@ -187,7 +186,7 @@ static      const struct termact termacts[MDOC_MAX] = {
        { termp_quote_pre, termp_quote_post }, /* Bo */
        { termp_quote_pre, termp_quote_post }, /* Bq */
        { termp_xx_pre, NULL }, /* Bsx */
        { termp_quote_pre, termp_quote_post }, /* Bo */
        { termp_quote_pre, termp_quote_post }, /* Bq */
        { termp_xx_pre, NULL }, /* Bsx */

-       { NULL, termp_bx_post }, /* Bx */
+       { termp_bx_pre, NULL }, /* Bx */

        { NULL, NULL }, /* Db */
        { NULL, NULL }, /* Dc */
        { termp_quote_pre, termp_quote_post }, /* Do */
        { NULL, NULL }, /* Db */
        { NULL, NULL }, /* Dc */
        { termp_quote_pre, termp_quote_post }, /* Do */


@@ -312,22 +311,6 @@ print_mdoc_node(DECL_ARGS)
 
        memset(&npair, 0, sizeof(struct termpair));
        npair.ppair = pair;
 
        memset(&npair, 0, sizeof(struct termpair));
        npair.ppair = pair;

-       
-       switch (n->type) {
-       case (MDOC_TEXT):
-               if (' ' == *n->string && MDOC_LINE & n->flags)
-                       term_newln(p);
-               term_word(p, n->string);
-               break;
-       case (MDOC_TBL):
-               term_tbl(p, n->span);
-               break;
-       default:
-               if (termacts[n->tok].pre && ENDBODY_NOT == n->end)
-                       chld = (*termacts[n->tok].pre)
-                               (p, &npair, m, n);
-               break;
-       }

 
        /*
         * Keeps only work until the end of a line.  If a keep was
 
        /*
         * Keeps only work until the end of a line.  If a keep was


@@ -359,6 +342,34 @@ print_mdoc_node(DECL_ARGS)
             (n->parent && MDOC_SYNPRETTY & n->parent->flags)))
                p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
 
             (n->parent && MDOC_SYNPRETTY & n->parent->flags)))
                p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
 

+       /*
+        * After the keep flags have been set up, we may now
+        * produce output.  Note that some pre-handlers do so.
+        */
+
+       switch (n->type) {
+       case (MDOC_TEXT):
+               if (' ' == *n->string && MDOC_LINE & n->flags)
+                       term_newln(p);
+               if (MDOC_DELIMC & n->flags)
+                       p->flags |= TERMP_NOSPACE;
+               term_word(p, n->string);
+               if (MDOC_DELIMO & n->flags)
+                       p->flags |= TERMP_NOSPACE;
+               break;
+       case (MDOC_EQN):
+               term_word(p, n->eqn->data);
+               break;
+       case (MDOC_TBL):
+               term_tbl(p, n->span);
+               break;
+       default:
+               if (termacts[n->tok].pre && ENDBODY_NOT == n->end)
+                       chld = (*termacts[n->tok].pre)
+                               (p, &npair, m, n);
+               break;
+       }
+

        if (chld && n->child)
                print_mdoc_nodelist(p, &npair, m, n->child);
 
        if (chld && n->child)
                print_mdoc_nodelist(p, &npair, m, n->child);
 


@@ -369,6 +380,8 @@ print_mdoc_node(DECL_ARGS)
                break;
        case (MDOC_TBL):
                break;
                break;
        case (MDOC_TBL):
                break;

+       case (MDOC_EQN):
+               break;

        default:
                if ( ! termacts[n->tok].post || MDOC_ENDED & n->flags)
                        break;
        default:
                if ( ! termacts[n->tok].post || MDOC_ENDED & n->flags)
                        break;


@@ -403,7 +416,6 @@ print_mdoc_node(DECL_ARGS)
 static void
 print_mdoc_foot(struct termp *p, const void *arg)
 {
 static void
 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;
        const struct mdoc_meta *m;
 
        m = (const struct mdoc_meta *)arg;


@@ -418,24 +430,21 @@ print_mdoc_foot(struct termp *p, const void *arg)
         * SYSTEM                  DATE                    SYSTEM
         */
 
         * SYSTEM                  DATE                    SYSTEM
         */
 

-       time2a(m->date, buf, DATESIZ);
-       strlcpy(os, m->os, BUFSIZ);
-

        term_vspace(p);
 
        p->offset = 0;
        p->rmargin = (p->maxrmargin - 
        term_vspace(p);
 
        p->offset = 0;
        p->rmargin = (p->maxrmargin - 

-                       term_strlen(p, buf) + term_len(p, 1)) / 2;
+                       term_strlen(p, m->date) + term_len(p, 1)) / 2;

        p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
 
        p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
 

-       term_word(p, os);
+       term_word(p, m->os);

        term_flushln(p);
 
        p->offset = p->rmargin;
        term_flushln(p);
 
        p->offset = p->rmargin;

-       p->rmargin = p->maxrmargin - term_strlen(p, os);
+       p->rmargin = p->maxrmargin - term_strlen(p, m->os);

        p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
 
        p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
 

-       term_word(p, buf);
+       term_word(p, m->date);

        term_flushln(p);
 
        p->offset = p->rmargin;
        term_flushln(p);
 
        p->offset = p->rmargin;


@@ -443,7 +452,7 @@ print_mdoc_foot(struct termp *p, const void *arg)
        p->flags &= ~TERMP_NOBREAK;
        p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
 
        p->flags &= ~TERMP_NOBREAK;
        p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
 

-       term_word(p, os);
+       term_word(p, m->os);

        term_flushln(p);
 
        p->offset = 0;
        term_flushln(p);
 
        p->offset = 0;


@@ -1151,7 +1160,8 @@ static int
 termp_ns_pre(DECL_ARGS)
 {
 
 termp_ns_pre(DECL_ARGS)
 {
 

-       p->flags |= TERMP_NOSPACE;
+       if ( ! (MDOC_LINE & n->flags))
+               p->flags |= TERMP_NOSPACE;

        return(1);
 }
 
        return(1);
 }
 


@@ -1173,25 +1183,30 @@ termp_rs_pre(DECL_ARGS)
 static int
 termp_rv_pre(DECL_ARGS)
 {
 static int
 termp_rv_pre(DECL_ARGS)
 {

-       const struct mdoc_node  *nn;
+       int              nchild;

 
        term_newln(p);
        term_word(p, "The");
 
 
        term_newln(p);
        term_word(p, "The");
 

-       for (nn = n->child; nn; nn = nn->next) {
+       nchild = n->nchild;
+       for (n = n->child; n; n = n->next) {

                term_fontpush(p, TERMFONT_BOLD);
                term_fontpush(p, TERMFONT_BOLD);

-               term_word(p, nn->string);
+               term_word(p, n->string);

                term_fontpop(p);
                term_fontpop(p);

+

                p->flags |= TERMP_NOSPACE;
                p->flags |= TERMP_NOSPACE;

-               if (nn->next && NULL == nn->next->next)
-                       term_word(p, "(), and");
-               else if (nn->next)
-                       term_word(p, "(),");
-               else
-                       term_word(p, "()");
+               term_word(p, "()");
+
+               if (nchild > 2 && n->next) {
+                       p->flags |= TERMP_NOSPACE;
+                       term_word(p, ",");
+               }
+
+               if (n->next && NULL == n->next->next)
+                       term_word(p, "and");

        }
 
        }
 

-       if (n->child && n->child->next)
+       if (nchild > 1)

                term_word(p, "functions return");
        else
                term_word(p, "function returns");
                term_word(p, "functions return");
        else
                term_word(p, "function returns");


@@ -1214,31 +1229,34 @@ termp_rv_pre(DECL_ARGS)
 static int
 termp_ex_pre(DECL_ARGS)
 {
 static int
 termp_ex_pre(DECL_ARGS)
 {

-       const struct mdoc_node  *nn;
+       int              nchild;

 
 

+       term_newln(p);

        term_word(p, "The");
 
        term_word(p, "The");
 

-       for (nn = n->child; nn; nn = nn->next) {
+       nchild = n->nchild;
+       for (n = n->child; n; n = n->next) {

                term_fontpush(p, TERMFONT_BOLD);
                term_fontpush(p, TERMFONT_BOLD);

-               term_word(p, nn->string);
+               term_word(p, n->string);

                term_fontpop(p);
                term_fontpop(p);

-               p->flags |= TERMP_NOSPACE;
-               if (nn->next && NULL == nn->next->next)
-                       term_word(p, ", and");
-               else if (nn->next)
+
+               if (nchild > 2 && n->next) {
+                       p->flags |= TERMP_NOSPACE;

                        term_word(p, ",");
                        term_word(p, ",");

-               else
-                       p->flags &= ~TERMP_NOSPACE;
+               }
+
+               if (n->next && NULL == n->next->next)
+                       term_word(p, "and");

        }
 
        }
 

-       if (n->child && n->child->next)
+       if (nchild > 1)

                term_word(p, "utilities exit");
        else
                term_word(p, "utility exits");
 
                term_word(p, "0 on success, and >0 if an error occurs.");
                term_word(p, "utilities exit");
        else
                term_word(p, "utility exits");
 
                term_word(p, "0 on success, and >0 if an error occurs.");

-       p->flags |= TERMP_SENTENCE;

 
 

+       p->flags |= TERMP_SENTENCE;

        return(0);
 }
 
        return(0);
 }
 


@@ -1278,31 +1296,33 @@ termp_bl_post(DECL_ARGS)
                term_newln(p);
 }
 
                term_newln(p);
 }
 

-

 /* ARGSUSED */
 static int
 termp_xr_pre(DECL_ARGS)
 {
 /* ARGSUSED */
 static int
 termp_xr_pre(DECL_ARGS)
 {

-       const struct mdoc_node *nn;

 
 

-       if (NULL == n->child)
+       if (NULL == (n = n->child))

                return(0);
 
                return(0);
 

-       assert(MDOC_TEXT == n->child->type);
-       nn = n->child;
+       assert(MDOC_TEXT == n->type);
+       term_word(p, n->string);

 
 

-       term_word(p, nn->string);
-       if (NULL == (nn = nn->next)) 
+       if (NULL == (n = n->next)) 

                return(0);
                return(0);

+

        p->flags |= TERMP_NOSPACE;
        term_word(p, "(");
        p->flags |= TERMP_NOSPACE;
        term_word(p, "(");

-       term_word(p, nn->string);
+       p->flags |= TERMP_NOSPACE;
+
+       assert(MDOC_TEXT == n->type);
+       term_word(p, n->string);
+
+       p->flags |= TERMP_NOSPACE;

        term_word(p, ")");
 
        return(0);
 }
 
        term_word(p, ")");
 
        return(0);
 }
 

-

 /*
  * 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
 /*
  * 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


@@ -1516,30 +1536,43 @@ termp_ft_pre(DECL_ARGS)
 static int
 termp_fn_pre(DECL_ARGS)
 {
 static int
 termp_fn_pre(DECL_ARGS)
 {

-       const struct mdoc_node  *nn;
+       int              pretty;
+
+       pretty = MDOC_SYNPRETTY & n->flags;

 
        synopsis_pre(p, n);
 
 
        synopsis_pre(p, n);
 

+       if (NULL == (n = n->child))
+               return(0);
+
+       assert(MDOC_TEXT == n->type);

        term_fontpush(p, TERMFONT_BOLD);
        term_fontpush(p, TERMFONT_BOLD);

-       term_word(p, n->child->string);
+       term_word(p, n->string);

        term_fontpop(p);
 
        p->flags |= TERMP_NOSPACE;
        term_word(p, "(");
        term_fontpop(p);
 
        p->flags |= TERMP_NOSPACE;
        term_word(p, "(");

+       p->flags |= TERMP_NOSPACE;

 
 

-       for (nn = n->child->next; nn; nn = nn->next) {
+       for (n = n->next; n; n = n->next) {
+               assert(MDOC_TEXT == n->type);

                term_fontpush(p, TERMFONT_UNDER);
                term_fontpush(p, TERMFONT_UNDER);

-               term_word(p, nn->string);
+               term_word(p, n->string);

                term_fontpop(p);
 
                term_fontpop(p);
 

-               if (nn->next)
+               if (n->next) {
+                       p->flags |= TERMP_NOSPACE;

                        term_word(p, ",");
                        term_word(p, ",");

+               }

        }
 
        }
 

+       p->flags |= TERMP_NOSPACE;

        term_word(p, ")");
 
        term_word(p, ")");
 

-       if (MDOC_SYNPRETTY & n->flags)
+       if (pretty) {
+               p->flags |= TERMP_NOSPACE;

                term_word(p, ";");
                term_word(p, ";");

+       }

 
        return(0);
 }
 
        return(0);
 }


@@ -1561,12 +1594,16 @@ termp_fa_pre(DECL_ARGS)
                term_word(p, nn->string);
                term_fontpop(p);
 
                term_word(p, nn->string);
                term_fontpop(p);
 

-               if (nn->next)
+               if (nn->next) {
+                       p->flags |= TERMP_NOSPACE;

                        term_word(p, ",");
                        term_word(p, ",");

+               }

        }
 
        }
 

-       if (n->child && n->next && n->next->tok == MDOC_Fa)
+       if (n->child && n->next && n->next->tok == MDOC_Fa) {
+               p->flags |= TERMP_NOSPACE;

                term_word(p, ",");
                term_word(p, ",");

+       }

 
        return(0);
 }
 
        return(0);
 }


@@ -1674,13 +1711,27 @@ termp_bd_post(DECL_ARGS)
 
 
 /* ARGSUSED */
 
 
 /* ARGSUSED */

-static void
-termp_bx_post(DECL_ARGS)
+static int
+termp_bx_pre(DECL_ARGS)

 {
 
 {
 

-       if (n->child)
+       if (NULL != (n = n->child)) {
+               term_word(p, n->string);

                p->flags |= TERMP_NOSPACE;
                p->flags |= TERMP_NOSPACE;

-       term_word(p, "BSD");
+               term_word(p, "BSD");
+       } else {
+               term_word(p, "BSD");
+               return(0);
+       }
+
+       if (NULL != (n = n->next)) {
+               p->flags |= TERMP_NOSPACE;
+               term_word(p, "-");
+               p->flags |= TERMP_NOSPACE;
+               term_word(p, n->string);
+       }
+
+       return(0);

 }
 
 
 }
 
 


@@ -1689,6 +1740,7 @@ static int
 termp_xx_pre(DECL_ARGS)
 {
        const char      *pp;
 termp_xx_pre(DECL_ARGS)
 {
        const char      *pp;

+       int              flags;

 
        pp = NULL;
        switch (n->tok) {
 
        pp = NULL;
        switch (n->tok) {


@@ -1714,9 +1766,14 @@ termp_xx_pre(DECL_ARGS)
                break;
        }
 
                break;
        }
 

-       assert(pp);

        term_word(p, pp);
        term_word(p, pp);

-       return(1);
+       if (n->child) {
+               flags = p->flags;
+               p->flags |= TERMP_KEEP;
+               term_word(p, n->child->string);
+               p->flags = flags;
+       }
+       return(0);

 }
 
 
 }
 
 


@@ -1981,6 +2038,7 @@ termp_fo_pre(DECL_ARGS)
        } else if (MDOC_BODY == n->type) {
                p->flags |= TERMP_NOSPACE;
                term_word(p, "(");
        } else if (MDOC_BODY == n->type) {
                p->flags |= TERMP_NOSPACE;
                term_word(p, "(");

+               p->flags |= TERMP_NOSPACE;

                return(1);
        } 
 
                return(1);
        } 
 


@@ -2004,10 +2062,13 @@ termp_fo_post(DECL_ARGS)
        if (MDOC_BODY != n->type) 
                return;
 
        if (MDOC_BODY != n->type) 
                return;
 

+       p->flags |= TERMP_NOSPACE;

        term_word(p, ")");
 
        term_word(p, ")");
 

-       if (MDOC_SYNPRETTY & n->flags)
+       if (MDOC_SYNPRETTY & n->flags) {
+               p->flags |= TERMP_NOSPACE;

                term_word(p, ";");
                term_word(p, ";");

+       }

 }
 
 
 }
 
 


@@ -2081,6 +2142,7 @@ termp____post(DECL_ARGS)
        if (NULL == n->parent || MDOC_Rs != n->parent->tok)
                return;
 
        if (NULL == n->parent || MDOC_Rs != n->parent->tok)
                return;
 

+       p->flags |= TERMP_NOSPACE;

        if (NULL == n->next) {
                term_word(p, ".");
                p->flags |= TERMP_SENTENCE;
        if (NULL == n->next) {
                term_word(p, ".");
                p->flags |= TERMP_SENTENCE;


@@ -2117,6 +2179,7 @@ termp_lk_pre(DECL_ARGS)
 
        term_fontpop(p);
 
 
        term_fontpop(p);
 

+       p->flags |= TERMP_NOSPACE;

        term_word(p, ":");
 
        term_fontpush(p, TERMFONT_BOLD);
        term_word(p, ":");
 
        term_fontpush(p, TERMFONT_BOLD);


@@ -2168,7 +2231,7 @@ termp__t_post(DECL_ARGS)
         * If we're in an `Rs' and there's a journal present, then quote
         * us instead of underlining us (for disambiguation).
         */
         * If we're in an `Rs' and there's a journal present, then quote
         * us instead of underlining us (for disambiguation).
         */

-       if (n->parent && MDOC_Rs == n->parent->tok && 
+       if (n->parent && MDOC_Rs == n->parent->tok &&

                        n->parent->norm->Rs.quote_T)
                termp_quote_post(p, pair, m, n);
 
                        n->parent->norm->Rs.quote_T)
                termp_quote_post(p, pair, m, n);