basic support for -Tman .In; OpenBSD rev. 1.12

[mandoc.git] / mdoc_term.c

diff --git a/mdoc_term.c b/mdoc_term.c
index d48e2396d8979bb3d323edf5aba9edc0e368248d..533356644448ea56e6bf227e8bf7b69203454ede 100644 (file)
--- a/mdoc_term.c
+++ b/mdoc_term.c
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_term.c,v 1.223 2011/04/04 16:05:36 kristaps Exp $ */
+/*     $Id: mdoc_term.c,v 1.238 2011/11/13 13:15:14 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org>
@@ -34,9 +34,6 @@
 #include "mdoc.h"
 #include "main.h"
 
-#define        INDENT            5
-#define        HALFINDENT        3
-
 struct termpair {
        struct termpair  *ppair;
        int               count;
@@ -194,7 +191,7 @@ static      const struct termact termacts[MDOC_MAX] = {
        { NULL, NULL }, /* Ec */ /* FIXME: no space */
        { NULL, NULL }, /* Ef */
        { termp_under_pre, NULL }, /* Em */ 
-       { NULL, NULL }, /* Eo */
+       { termp_quote_pre, termp_quote_post }, /* Eo */
        { termp_xx_pre, NULL }, /* Fx */
        { termp_bold_pre, NULL }, /* Ms */
        { termp_igndelim_pre, NULL }, /* No */
@@ -259,19 +256,15 @@ terminal_mdoc(void *arg, const struct mdoc *mdoc)
 
        p = (struct termp *)arg;
 
+       if (0 == p->defindent)
+               p->defindent = 5;
+
        p->overstep = 0;
        p->maxrmargin = p->defrmargin;
        p->tabwidth = term_len(p, 5);
 
        if (NULL == p->symtab)
-               switch (p->enc) {
-               case (TERMENC_ASCII):
-                       p->symtab = chars_init(CHARS_ASCII);
-                       break;
-               default:
-                       abort();
-                       /* NOTREACHED */
-               }
+               p->symtab = mchars_alloc();
 
        n = mdoc_node(mdoc);
        m = mdoc_meta(mdoc);
@@ -358,7 +351,7 @@ print_mdoc_node(DECL_ARGS)
                        p->flags |= TERMP_NOSPACE;
                break;
        case (MDOC_EQN):
-               term_word(p, n->eqn->data);
+               term_eqn(p, n->eqn);
                break;
        case (MDOC_TBL):
                term_tbl(p, n->span);
@@ -442,7 +435,7 @@ print_mdoc_foot(struct termp *p, const void *arg)
 
        p->offset = p->rmargin;
        p->rmargin = p->maxrmargin - term_strlen(p, m->os);
-       p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
+       p->flags |= TERMP_NOSPACE;
 
        term_word(p, m->date);
        term_flushln(p);
@@ -450,7 +443,7 @@ print_mdoc_foot(struct termp *p, const void *arg)
        p->offset = p->rmargin;
        p->rmargin = p->maxrmargin;
        p->flags &= ~TERMP_NOBREAK;
-       p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
+       p->flags |= TERMP_NOSPACE;
 
        term_word(p, m->os);
        term_flushln(p);
@@ -465,13 +458,11 @@ static void
 print_mdoc_head(struct termp *p, const void *arg)
 {
        char            buf[BUFSIZ], title[BUFSIZ];
+       size_t          buflen, titlen;
        const struct mdoc_meta *m;
 
        m = (const struct mdoc_meta *)arg;
 
-       p->rmargin = p->maxrmargin;
-       p->offset = 0;
-
        /*
         * The header is strange.  It has three components, which are
         * really two with the first duplicated.  It goes like this:
@@ -485,8 +476,12 @@ print_mdoc_head(struct termp *p, const void *arg)
         * switches on the manual section.
         */
 
+       p->offset = 0;
+       p->rmargin = p->maxrmargin;
+
        assert(m->vol);
        strlcpy(buf, m->vol, BUFSIZ);
+       buflen = term_strlen(p, buf);
 
        if (m->arch) {
                strlcat(buf, " (", BUFSIZ);
@@ -495,33 +490,38 @@ print_mdoc_head(struct termp *p, const void *arg)
        }
 
        snprintf(title, BUFSIZ, "%s(%s)", m->title, m->msec);
+       titlen = term_strlen(p, title);
 
-       p->offset = 0;
-       p->rmargin = (p->maxrmargin - 
-                       term_strlen(p, buf) + term_len(p, 1)) / 2;
        p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
+       p->offset = 0;
+       p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ?
+           (p->maxrmargin -
+            term_strlen(p, buf) + term_len(p, 1)) / 2 :
+           p->maxrmargin - buflen;
 
        term_word(p, title);
        term_flushln(p);
 
+       p->flags |= TERMP_NOSPACE;
        p->offset = p->rmargin;
-       p->rmargin = p->maxrmargin - term_strlen(p, title);
-       p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
+       p->rmargin = p->offset + buflen + titlen < p->maxrmargin ?
+           p->maxrmargin - titlen : p->maxrmargin;
 
        term_word(p, buf);
        term_flushln(p);
 
-       p->offset = p->rmargin;
-       p->rmargin = p->maxrmargin;
        p->flags &= ~TERMP_NOBREAK;
-       p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
-
-       term_word(p, title);
-       term_flushln(p);
+       if (p->rmargin + titlen <= p->maxrmargin) {
+               p->flags |= TERMP_NOSPACE;
+               p->offset = p->rmargin;
+               p->rmargin = p->maxrmargin;
+               term_word(p, title);
+               term_flushln(p);
+       }
 
+       p->flags &= ~TERMP_NOSPACE;
        p->offset = 0;
        p->rmargin = p->maxrmargin;
-       p->flags &= ~TERMP_NOSPACE;
 }
 
 
@@ -530,9 +530,10 @@ a2height(const struct termp *p, const char *v)
 {
        struct roffsu    su;
 
+
        assert(v);
        if ( ! a2roffsu(v, &su, SCALE_VS))
-               SCALE_VS_INIT(&su, term_len(p, 1));
+               SCALE_VS_INIT(&su, atoi(v));
 
        return(term_vspan(p, &su));
 }
@@ -561,9 +562,9 @@ a2offs(const struct termp *p, const char *v)
        else if (0 == strcmp(v, "left"))
                return(0);
        else if (0 == strcmp(v, "indent"))
-               return(term_len(p, INDENT + 1));
+               return(term_len(p, p->defindent + 1));
        else if (0 == strcmp(v, "indent-two"))
-               return(term_len(p, (INDENT + 1) * 2));
+               return(term_len(p, (p->defindent + 1) * 2));
        else if ( ! a2roffsu(v, &su, SCALE_MAX))
                SCALE_HS_INIT(&su, term_strlen(p, v));
 
@@ -583,6 +584,8 @@ print_bvspace(struct termp *p,
 {
        const struct mdoc_node  *nn;
 
+       assert(n);
+
        term_newln(p);
 
        if (MDOC_Bd == bl->tok && bl->norm->Bd.comp)
@@ -793,16 +796,11 @@ termp_it_pre(DECL_ARGS)
        case (LIST_hyphen):
                if (MDOC_HEAD == n->type)
                        p->flags |= TERMP_NOBREAK;
-               else
-                       p->flags |= TERMP_NOLPAD;
                break;
        case (LIST_hang):
                if (MDOC_HEAD == n->type)
                        p->flags |= TERMP_NOBREAK;
                else
-                       p->flags |= TERMP_NOLPAD;
-
-               if (MDOC_HEAD != n->type)
                        break;
 
                /*
@@ -813,17 +811,14 @@ termp_it_pre(DECL_ARGS)
                 */
                if (n->next->child && 
                                (MDOC_Bl == n->next->child->tok ||
-                                MDOC_Bd == n->next->child->tok)) {
+                                MDOC_Bd == n->next->child->tok))
                        p->flags &= ~TERMP_NOBREAK;
-                       p->flags &= ~TERMP_NOLPAD;
-               } else
+               else
                        p->flags |= TERMP_HANG;
                break;
        case (LIST_tag):
                if (MDOC_HEAD == n->type)
                        p->flags |= TERMP_NOBREAK | TERMP_TWOSPACE;
-               else
-                       p->flags |= TERMP_NOLPAD;
 
                if (MDOC_HEAD != n->type)
                        break;
@@ -839,10 +834,6 @@ termp_it_pre(DECL_ARGS)
                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)
@@ -999,7 +990,6 @@ termp_it_post(DECL_ARGS)
        p->flags &= ~TERMP_DANGLE;
        p->flags &= ~TERMP_NOBREAK;
        p->flags &= ~TERMP_TWOSPACE;
-       p->flags &= ~TERMP_NOLPAD;
        p->flags &= ~TERMP_HANG;
 }
 
@@ -1015,7 +1005,7 @@ termp_nm_pre(DECL_ARGS)
        if (MDOC_BODY == n->type) {
                if (NULL == n->child)
                        return(0);
-               p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
+               p->flags |= TERMP_NOSPACE;
                p->offset += term_len(p, 1) +
                    (NULL == n->prev->child ? term_strlen(p, m->name) :
                     MDOC_TEXT == n->prev->child->type ?
@@ -1060,10 +1050,8 @@ termp_nm_post(DECL_ARGS)
        if (MDOC_HEAD == n->type && n->next->child) {
                term_flushln(p);
                p->flags &= ~(TERMP_NOBREAK | TERMP_HANG);
-       } else if (MDOC_BODY == n->type && n->child) {
+       } else if (MDOC_BODY == n->type && n->child)
                term_flushln(p);
-               p->flags &= ~TERMP_NOLPAD;
-       }
 }
 
                
@@ -1189,11 +1177,11 @@ termp_rv_pre(DECL_ARGS)
        term_word(p, "The");
 
        nchild = n->nchild;
-
        for (n = n->child; n; n = n->next) {
                term_fontpush(p, TERMFONT_BOLD);
                term_word(p, n->string);
                term_fontpop(p);
+
                p->flags |= TERMP_NOSPACE;
                term_word(p, "()");
 
@@ -1229,31 +1217,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);
 }
 
@@ -1293,33 +1284,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, "(");
        p->flags |= TERMP_NOSPACE;
-       term_word(p, nn->string);
+
+       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
@@ -1433,7 +1424,7 @@ termp_sh_pre(DECL_ARGS)
                term_fontpush(p, TERMFONT_BOLD);
                break;
        case (MDOC_BODY):
-               p->offset = term_len(p, INDENT);
+               p->offset = term_len(p, p->defindent);
                break;
        default:
                break;
@@ -1501,7 +1492,7 @@ termp_d1_pre(DECL_ARGS)
        if (MDOC_BLOCK != n->type)
                return(1);
        term_newln(p);
-       p->offset += term_len(p, (INDENT + 1));
+       p->offset += term_len(p, p->defindent + 1);
        return(1);
 }
 
@@ -1533,24 +1524,31 @@ 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, ",");
                }
@@ -1559,7 +1557,7 @@ termp_fn_pre(DECL_ARGS)
        p->flags |= TERMP_NOSPACE;
        term_word(p, ")");
 
-       if (MDOC_SYNPRETTY & n->flags) {
+       if (pretty) {
                p->flags |= TERMP_NOSPACE;
                term_word(p, ";");
        }
@@ -1799,7 +1797,7 @@ termp_ss_pre(DECL_ARGS)
                break;
        case (MDOC_HEAD):
                term_fontpush(p, TERMFONT_BOLD);
-               p->offset = term_len(p, HALFINDENT);
+               p->offset = term_len(p, (p->defindent+1)/2);
                break;
        default:
                break;
@@ -1927,6 +1925,8 @@ termp_quote_pre(DECL_ARGS)
        case (MDOC_Dq):
                term_word(p, "``");
                break;
+       case (MDOC_Eo):
+               break;
        case (MDOC_Po):
                /* FALLTHROUGH */
        case (MDOC_Pq):
@@ -1991,6 +1991,8 @@ termp_quote_post(DECL_ARGS)
        case (MDOC_Dq):
                term_word(p, "''");
                break;
+       case (MDOC_Eo):
+               break;
        case (MDOC_Po):
                /* FALLTHROUGH */
        case (MDOC_Pq):