]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_term.c
First, properly escape periods with \&. Then consistently refer to
[mandoc.git] / mdoc_term.c
index 87ec8df86af21092621484456d9906c8ac7c12fa..47c212489d331c17f154fb3eca1b09719d838404 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_term.c,v 1.202 2010/12/24 14:00:40 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
@@ -32,7 +32,6 @@
 #include "out.h"
 #include "term.h"
 #include "mdoc.h"
-#include "chars.h"
 #include "main.h"
 
 #define        INDENT            5
@@ -68,11 +67,11 @@ static      void      synopsis_pre(struct termp *,
                        const struct mdoc_node *);
 
 static void      termp____post(DECL_ARGS);
+static void      termp__t_post(DECL_ARGS);
 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_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);
@@ -85,6 +84,7 @@ static        void      termp_sh_post(DECL_ARGS);
 static void      termp_ss_post(DECL_ARGS);
 
 static int       termp__a_pre(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_bd_pre(DECL_ARGS);
@@ -93,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_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);
@@ -174,7 +175,7 @@ static      const struct termact termacts[MDOC_MAX] = {
        { NULL, termp____post }, /* %O */
        { NULL, termp____post }, /* %P */
        { NULL, termp____post }, /* %R */
-       { termp_under_pre, termp____post }, /* %T */
+       { termp__t_pre, termp__t_post }, /* %T */
        { NULL, termp____post }, /* %V */
        { NULL, NULL }, /* Ac */
        { termp_quote_pre, termp_quote_post }, /* Ao */
@@ -185,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 */
-       { NULL, termp_bx_post }, /* Bx */
+       { termp_bx_pre, NULL }, /* Bx */
        { NULL, NULL }, /* Db */
        { NULL, NULL }, /* Dc */
        { termp_quote_pre, termp_quote_post }, /* Do */
@@ -311,11 +312,6 @@ print_mdoc_node(DECL_ARGS)
        memset(&npair, 0, sizeof(struct termpair));
        npair.ppair = pair;
 
-       if (MDOC_TEXT == n->type)
-               term_word(p, n->string); 
-       else if (termacts[n->tok].pre && ENDBODY_NOT == n->end)
-               chld = (*termacts[n->tok].pre)(p, &npair, m, n);
-
        /*
         * Keeps only work until the end of a line.  If a keep was
         * invoked in a prior line, revert it to PREKEEP.
@@ -346,13 +342,49 @@ print_mdoc_node(DECL_ARGS)
             (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);
 
        term_fontpopq(p, font);
 
-       if (MDOC_TEXT != n->type && termacts[n->tok].post && 
-                       ! (MDOC_ENDED & n->flags)) {
+       switch (n->type) {
+       case (MDOC_TEXT):
+               break;
+       case (MDOC_TBL):
+               break;
+       case (MDOC_EQN):
+               break;
+       default:
+               if ( ! termacts[n->tok].post || MDOC_ENDED & n->flags)
+                       break;
                (void)(*termacts[n->tok].post)(p, &npair, m, n);
 
                /*
@@ -370,6 +402,7 @@ print_mdoc_node(DECL_ARGS)
                 */
                if (ENDBODY_NOSPACE == n->end)
                        p->flags |= TERMP_NOSPACE;
+               break;
        }
 
        if (MDOC_EOS & n->flags)
@@ -383,7 +416,6 @@ print_mdoc_node(DECL_ARGS)
 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;
@@ -398,24 +430,21 @@ print_mdoc_foot(struct termp *p, const void *arg)
         * SYSTEM                  DATE                    SYSTEM
         */
 
-       time2a(m->date, buf, DATESIZ);
-       strlcpy(os, m->os, BUFSIZ);
-
        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;
 
-       term_word(p, os);
+       term_word(p, m->os);
        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;
 
-       term_word(p, buf);
+       term_word(p, m->date);
        term_flushln(p);
 
        p->offset = p->rmargin;
@@ -423,7 +452,7 @@ print_mdoc_foot(struct termp *p, const void *arg)
        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;
@@ -1131,7 +1160,8 @@ static int
 termp_ns_pre(DECL_ARGS)
 {
 
-       p->flags |= TERMP_NOSPACE;
+       if ( ! (MDOC_LINE & n->flags))
+               p->flags |= TERMP_NOSPACE;
        return(1);
 }
 
@@ -1153,25 +1183,30 @@ termp_rs_pre(DECL_ARGS)
 static int
 termp_rv_pre(DECL_ARGS)
 {
-       const struct mdoc_node  *nn;
+       int              nchild;
 
        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_word(p, nn->string);
+               term_word(p, n->string);
                term_fontpop(p);
+
                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");
@@ -1194,31 +1229,34 @@ termp_rv_pre(DECL_ARGS)
 static int
 termp_ex_pre(DECL_ARGS)
 {
-       const struct mdoc_node  *nn;
+       int              nchild;
 
+       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_word(p, nn->string);
+               term_word(p, n->string);
                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, ",");
-               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.");
-       p->flags |= TERMP_SENTENCE;
 
+       p->flags |= TERMP_SENTENCE;
        return(0);
 }
 
@@ -1258,31 +1296,33 @@ termp_bl_post(DECL_ARGS)
                term_newln(p);
 }
 
-
 /* ARGSUSED */
 static int
 termp_xr_pre(DECL_ARGS)
 {
-       const struct mdoc_node *nn;
 
-       if (NULL == n->child)
+       if (NULL == (n = n->child))
                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);
+
        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);
 }
 
-
 /*
  * 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
@@ -1496,30 +1536,43 @@ termp_ft_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);
 
+       if (NULL == (n = n->child))
+               return(0);
+
+       assert(MDOC_TEXT == n->type);
        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, "(");
+       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_word(p, nn->string);
+               term_word(p, n->string);
                term_fontpop(p);
 
-               if (nn->next)
+               if (n->next) {
+                       p->flags |= TERMP_NOSPACE;
                        term_word(p, ",");
+               }
        }
 
+       p->flags |= TERMP_NOSPACE;
        term_word(p, ")");
 
-       if (MDOC_SYNPRETTY & n->flags)
+       if (pretty) {
+               p->flags |= TERMP_NOSPACE;
                term_word(p, ";");
+       }
 
        return(0);
 }
@@ -1541,12 +1594,16 @@ termp_fa_pre(DECL_ARGS)
                term_word(p, nn->string);
                term_fontpop(p);
 
-               if (nn->next)
+               if (nn->next) {
+                       p->flags |= TERMP_NOSPACE;
                        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, ",");
+       }
 
        return(0);
 }
@@ -1581,7 +1638,9 @@ termp_bd_pre(DECL_ARGS)
                return(1);
 
        tabwidth = p->tabwidth;
-       p->tabwidth = term_len(p, 8);
+       if (DISP_literal == n->norm->Bd.type)
+               p->tabwidth = term_len(p, 8);
+
        rm = p->rmargin;
        rmax = p->maxrmargin;
        p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
@@ -1652,13 +1711,27 @@ termp_bd_post(DECL_ARGS)
 
 
 /* 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;
+               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, "BSD");
+               term_word(p, n->string);
+       }
+
+       return(0);
 }
 
 
@@ -1667,6 +1740,7 @@ static int
 termp_xx_pre(DECL_ARGS)
 {
        const char      *pp;
+       int              flags;
 
        pp = NULL;
        switch (n->tok) {
@@ -1692,9 +1766,14 @@ termp_xx_pre(DECL_ARGS)
                break;
        }
 
-       assert(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);
 }
 
 
@@ -1830,7 +1909,7 @@ static int
 termp_quote_pre(DECL_ARGS)
 {
 
-       if (MDOC_BODY != n->type)
+       if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
                return(1);
 
        switch (n->tok) {
@@ -1863,6 +1942,8 @@ termp_quote_pre(DECL_ARGS)
        case (MDOC_Pq):
                term_word(p, "(");
                break;
+       case (MDOC__T):
+               /* FALLTHROUGH */
        case (MDOC_Qo):
                /* FALLTHROUGH */
        case (MDOC_Qq):
@@ -1890,7 +1971,7 @@ static void
 termp_quote_post(DECL_ARGS)
 {
 
-       if (MDOC_BODY != n->type)
+       if (MDOC_BODY != n->type && MDOC_ELEM != n->type)
                return;
 
        p->flags |= TERMP_NOSPACE;
@@ -1925,6 +2006,8 @@ termp_quote_post(DECL_ARGS)
        case (MDOC_Pq):
                term_word(p, ")");
                break;
+       case (MDOC__T):
+               /* FALLTHROUGH */
        case (MDOC_Qo):
                /* FALLTHROUGH */
        case (MDOC_Qq):
@@ -1955,6 +2038,7 @@ termp_fo_pre(DECL_ARGS)
        } else if (MDOC_BODY == n->type) {
                p->flags |= TERMP_NOSPACE;
                term_word(p, "(");
+               p->flags |= TERMP_NOSPACE;
                return(1);
        } 
 
@@ -1978,10 +2062,13 @@ termp_fo_post(DECL_ARGS)
        if (MDOC_BODY != n->type) 
                return;
 
+       p->flags |= TERMP_NOSPACE;
        term_word(p, ")");
 
-       if (MDOC_SYNPRETTY & n->flags)
+       if (MDOC_SYNPRETTY & n->flags) {
+               p->flags |= TERMP_NOSPACE;
                term_word(p, ";");
+       }
 }
 
 
@@ -2055,6 +2142,7 @@ termp____post(DECL_ARGS)
        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;
@@ -2091,6 +2179,7 @@ termp_lk_pre(DECL_ARGS)
 
        term_fontpop(p);
 
+       p->flags |= TERMP_NOSPACE;
        term_word(p, ":");
 
        term_fontpush(p, TERMFONT_BOLD);
@@ -2133,6 +2222,39 @@ termp_bk_post(DECL_ARGS)
                p->flags &= ~(TERMP_KEEP | TERMP_PREKEEP);
 }
 
+/* ARGSUSED */
+static void
+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 (n->parent && MDOC_Rs == n->parent->tok &&
+                       n->parent->norm->Rs.quote_T)
+               termp_quote_post(p, pair, m, n);
+
+       termp____post(p, pair, m, n);
+}
+
+/* ARGSUSED */
+static int
+termp__t_pre(DECL_ARGS)
+{
+
+       /*
+        * 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 &&
+                       n->parent->norm->Rs.quote_T)
+               return(termp_quote_pre(p, pair, m, n));
+
+       term_fontpush(p, TERMFONT_UNDER);
+       return(1);
+}
+
 /* ARGSUSED */
 static int
 termp_under_pre(DECL_ARGS)