]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_term.c
End-of-sentence spacing for -man -Tascii.
[mandoc.git] / man_term.c
index d2ea41614301ec52099e89acc4e349b438c9bf79..fd88e2df7d9f3a1f5988737173ba9bd4f2744d75 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: man_term.c,v 1.46 2009/10/27 08:49:44 kristaps Exp $ */
+/*     $Id: man_term.c,v 1.63 2010/05/12 16:46:28 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
 #include <sys/types.h>
 
 #include <assert.h>
 #include <ctype.h>
-#include <err.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
@@ -62,19 +65,16 @@ struct      mtermp {
 struct termact {
        int             (*pre)(DECL_ARGS);
        void            (*post)(DECL_ARGS);
+       int               flags;
+#define        MAN_NOTEXT       (1 << 0) /* Never has text children. */
 };
 
-#ifdef __linux__
-extern size_t            strlcpy(char *, const char *, size_t);
-extern size_t            strlcat(char *, const char *, size_t);
-#endif
-
 static int               a2width(const struct man_node *);
 static int               a2height(const struct man_node *);
 
 static void              print_man_head(struct termp *, 
                                const struct man_meta *);
-static void              print_man_body(DECL_ARGS);
+static void              print_man_nodelist(DECL_ARGS);
 static void              print_man_node(DECL_ARGS);
 static void              print_man_foot(struct termp *, 
                                const struct man_meta *);
@@ -86,7 +86,6 @@ static        int               pre_BI(DECL_ARGS);
 static int               pre_HP(DECL_ARGS);
 static int               pre_I(DECL_ARGS);
 static int               pre_IP(DECL_ARGS);
-static int               pre_IR(DECL_ARGS);
 static int               pre_PP(DECL_ARGS);
 static int               pre_RB(DECL_ARGS);
 static int               pre_RI(DECL_ARGS);
@@ -98,52 +97,57 @@ static      int               pre_br(DECL_ARGS);
 static int               pre_fi(DECL_ARGS);
 static int               pre_ign(DECL_ARGS);
 static int               pre_nf(DECL_ARGS);
-static int               pre_r(DECL_ARGS);
 static int               pre_sp(DECL_ARGS);
 
-static void              post_B(DECL_ARGS);
-static void              post_I(DECL_ARGS);
 static void              post_IP(DECL_ARGS);
 static void              post_HP(DECL_ARGS);
 static void              post_RS(DECL_ARGS);
 static void              post_SH(DECL_ARGS);
 static void              post_SS(DECL_ARGS);
 static void              post_TP(DECL_ARGS);
-static void              post_i(DECL_ARGS);
 
 static const struct termact termacts[MAN_MAX] = {
-       { pre_br, NULL }, /* br */
-       { NULL, NULL }, /* TH */
-       { pre_SH, post_SH }, /* SH */
-       { pre_SS, post_SS }, /* SS */
-       { pre_TP, post_TP }, /* TP */
-       { pre_PP, NULL }, /* LP */
-       { pre_PP, NULL }, /* PP */
-       { pre_PP, NULL }, /* P */
-       { pre_IP, post_IP }, /* IP */
-       { pre_HP, post_HP }, /* HP */ 
-       { NULL, NULL }, /* SM */
-       { pre_B, post_B }, /* SB */
-       { pre_BI, NULL }, /* BI */
-       { pre_BI, NULL }, /* IB */
-       { pre_RB, NULL }, /* BR */
-       { pre_RB, NULL }, /* RB */
-       { NULL, NULL }, /* R */
-       { pre_B, post_B }, /* B */
-       { pre_I, post_I }, /* I */
-       { pre_IR, NULL }, /* IR */
-       { pre_RI, NULL }, /* RI */
-       { NULL, NULL }, /* na */
-       { pre_I, post_i }, /* i */
-       { pre_sp, NULL }, /* sp */
-       { pre_nf, NULL }, /* nf */
-       { pre_fi, NULL }, /* fi */
-       { pre_r, NULL }, /* r */
-       { NULL, NULL }, /* RE */
-       { pre_RS, post_RS }, /* RS */
-       { pre_ign, NULL }, /* DT */
-       { pre_ign, NULL }, /* UC */
-       { pre_ign, NULL }, /* PD */
+       { pre_br, NULL, MAN_NOTEXT }, /* br */
+       { NULL, NULL, 0 }, /* TH */
+       { pre_SH, post_SH, 0 }, /* SH */
+       { pre_SS, post_SS, 0 }, /* SS */
+       { pre_TP, post_TP, 0 }, /* TP */
+       { pre_PP, NULL, 0 }, /* LP */
+       { pre_PP, NULL, 0 }, /* PP */
+       { pre_PP, NULL, 0 }, /* P */
+       { pre_IP, post_IP, 0 }, /* IP */
+       { pre_HP, post_HP, 0 }, /* HP */ 
+       { NULL, NULL, 0 }, /* SM */
+       { pre_B, NULL, 0 }, /* SB */
+       { pre_BI, NULL, 0 }, /* BI */
+       { pre_BI, NULL, 0 }, /* IB */
+       { pre_RB, NULL, 0 }, /* BR */
+       { pre_RB, NULL, 0 }, /* RB */
+       { NULL, NULL, 0 }, /* R */
+       { pre_B, NULL, 0 }, /* B */
+       { pre_I, NULL, 0 }, /* I */
+       { pre_RI, NULL, 0 }, /* IR */
+       { pre_RI, NULL, 0 }, /* RI */
+       { NULL, NULL, MAN_NOTEXT }, /* na */
+       { pre_I, NULL, 0 }, /* i */
+       { pre_sp, NULL, MAN_NOTEXT }, /* sp */
+       { pre_nf, NULL, 0 }, /* nf */
+       { pre_fi, NULL, 0 }, /* fi */
+       { NULL, NULL, 0 }, /* r */
+       { NULL, NULL, 0 }, /* RE */
+       { pre_RS, post_RS, 0 }, /* RS */
+       { pre_ign, NULL, 0 }, /* DT */
+       { pre_ign, NULL, 0 }, /* UC */
+       { pre_ign, NULL, 0 }, /* PD */
+       { pre_sp, NULL, MAN_NOTEXT }, /* Sp */
+       { pre_nf, NULL, 0 }, /* Vb */
+       { pre_fi, NULL, 0 }, /* Ve */
+       { pre_ign, NULL, MAN_NOTEXT }, /* de */
+       { pre_ign, NULL, MAN_NOTEXT }, /* dei */
+       { pre_ign, NULL, MAN_NOTEXT }, /* am */
+       { pre_ign, NULL, MAN_NOTEXT }, /* ami */
+       { pre_ign, NULL, MAN_NOTEXT }, /* ig */
+       { NULL, NULL, 0 }, /* . */
 };
 
 
@@ -158,6 +162,9 @@ terminal_man(void *arg, const struct man *man)
 
        p = (struct termp *)arg;
 
+       p->overstep = 0;
+       p->maxrmargin = 65;
+
        if (NULL == p->symtab)
                switch (p->enc) {
                case (TERMENC_ASCII):
@@ -179,7 +186,7 @@ terminal_man(void *arg, const struct man *man)
        mt.offset = INDENT;
 
        if (n->child)
-               print_man_body(p, &mt, n->child, m);
+               print_man_nodelist(p, &mt, n->child, m);
        print_man_foot(p, m);
 }
 
@@ -243,40 +250,11 @@ static int
 pre_I(DECL_ARGS)
 {
 
-       p->under++;
+       term_fontrepl(p, TERMFONT_UNDER);
        return(1);
 }
 
 
-/* ARGSUSED */
-static int
-pre_r(DECL_ARGS)
-{
-
-       p->bold = p->under = 0;
-       return(1);
-}
-
-
-/* ARGSUSED */
-static void
-post_i(DECL_ARGS)
-{
-
-       if (n->nchild)
-               p->under--;
-}
-
-
-/* ARGSUSED */
-static void
-post_I(DECL_ARGS)
-{
-
-       p->under--;
-}
-
-
 /* ARGSUSED */
 static int
 pre_fi(DECL_ARGS)
@@ -292,29 +270,8 @@ static int
 pre_nf(DECL_ARGS)
 {
 
-       term_newln(p);
        mt->fl |= MANT_LITERAL;
-       return(1);
-}
-
-
-/* ARGSUSED */
-static int
-pre_IR(DECL_ARGS)
-{
-       const struct man_node *nn;
-       int              i;
-
-       for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
-               if ( ! (i % 2))
-                       p->under++;
-               if (i > 0)
-                       p->flags |= TERMP_NOSPACE;
-               print_man_node(p, mt, nn, m);
-               if ( ! (i % 2))
-                       p->under--;
-       }
-       return(0);
+       return(MAN_Vb != n->tok);
 }
 
 
@@ -327,19 +284,16 @@ pre_RB(DECL_ARGS)
 
        for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
                if (i % 2 && MAN_RB == n->tok)
-                       p->bold++;
+                       term_fontrepl(p, TERMFONT_BOLD);
                else if ( ! (i % 2) && MAN_RB != n->tok)
-                       p->bold++;
+                       term_fontrepl(p, TERMFONT_BOLD);
+               else
+                       term_fontrepl(p, TERMFONT_NONE);
 
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;
 
                print_man_node(p, mt, nn, m);
-
-               if (i % 2 && MAN_RB == n->tok)
-                       p->bold--;
-               else if ( ! (i % 2) && MAN_RB != n->tok)
-                       p->bold--;
        }
        return(0);
 }
@@ -353,13 +307,17 @@ pre_RI(DECL_ARGS)
        int              i;
 
        for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
-               if ( ! (i % 2))
-                       p->under++;
+               if (i % 2 && MAN_RI == n->tok)
+                       term_fontrepl(p, TERMFONT_UNDER);
+               else if ( ! (i % 2) && MAN_RI != n->tok)
+                       term_fontrepl(p, TERMFONT_UNDER);
+               else
+                       term_fontrepl(p, TERMFONT_NONE);
+
                if (i > 0)
                        p->flags |= TERMP_NOSPACE;
+
                print_man_node(p, mt, nn, m);
-               if ( ! (i % 2))
-                       p->under--;
        }
        return(0);
 }
@@ -374,26 +332,18 @@ pre_BI(DECL_ARGS)
 
        for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
                if (i % 2 && MAN_BI == n->tok)
-                       p->under++;
+                       term_fontrepl(p, TERMFONT_UNDER);
                else if (i % 2)
-                       p->bold++;
+                       term_fontrepl(p, TERMFONT_BOLD);
                else if (MAN_BI == n->tok)
-                       p->bold++;
+                       term_fontrepl(p, TERMFONT_BOLD);
                else
-                       p->under++;
+                       term_fontrepl(p, TERMFONT_UNDER);
 
                if (i)
                        p->flags |= TERMP_NOSPACE;
-               print_man_node(p, mt, nn, m);
 
-               if (i % 2 && MAN_BI == n->tok)
-                       p->under--;
-               else if (i % 2)
-                       p->bold--;
-               else if (MAN_BI == n->tok)
-                       p->bold--;
-               else
-                       p->under--;
+               print_man_node(p, mt, nn, m);
        }
        return(0);
 }
@@ -404,20 +354,11 @@ static int
 pre_B(DECL_ARGS)
 {
 
-       p->bold++;
+       term_fontrepl(p, TERMFONT_BOLD);
        return(1);
 }
 
 
-/* ARGSUSED */
-static void
-post_B(DECL_ARGS)
-{
-
-       p->bold--;
-}
-
-
 /* ARGSUSED */
 static int
 pre_sp(DECL_ARGS)
@@ -428,7 +369,7 @@ pre_sp(DECL_ARGS)
 
        if (0 == len)
                term_newln(p);
-       for (i = 0; i < len; i++)
+       for (i = 0; i <= len; i++)
                term_vspace(p);
 
        return(0);
@@ -646,10 +587,13 @@ pre_TP(DECL_ARGS)
 
        /* Calculate offset. */
 
-       if (NULL != (nn = n->parent->head->child))
-               if (NULL != nn->next)
+       if (NULL != (nn = n->parent->head->child)) {
+               while (nn && MAN_TEXT != nn->type)
+                       nn = nn->next;
+               if (nn && nn->next)
                        if ((ival = a2width(nn)) >= 0)
                                len = (size_t)ival;
+       }
 
        switch (n->type) {
        case (MAN_HEAD):
@@ -721,7 +665,7 @@ pre_SS(DECL_ARGS)
                term_vspace(p);
                break;
        case (MAN_HEAD):
-               p->bold++;
+               term_fontrepl(p, TERMFONT_BOLD);
                p->offset = HALFINDENT;
                break;
        case (MAN_BODY):
@@ -743,7 +687,6 @@ post_SS(DECL_ARGS)
        switch (n->type) {
        case (MAN_HEAD):
                term_newln(p);
-               p->bold--;
                break;
        case (MAN_BODY):
                term_newln(p);
@@ -767,10 +710,13 @@ pre_SH(DECL_ARGS)
                if (n->prev && MAN_SH == n->prev->tok)
                        if (NULL == n->prev->body->child)
                                break;
+               /* If the first macro, no vspae. */
+               if (NULL == n->prev)
+                       break;
                term_vspace(p);
                break;
        case (MAN_HEAD):
-               p->bold++;
+               term_fontrepl(p, TERMFONT_BOLD);
                p->offset = 0;
                break;
        case (MAN_BODY):
@@ -792,7 +738,6 @@ post_SH(DECL_ARGS)
        switch (n->type) {
        case (MAN_HEAD):
                term_newln(p);
-               p->bold--;
                break;
        case (MAN_BODY):
                term_newln(p);
@@ -845,6 +790,8 @@ post_RS(DECL_ARGS)
        case (MAN_BLOCK):
                mt->offset = mt->lmargin = INDENT;
                break;
+       case (MAN_HEAD):
+               break;
        default:
                term_newln(p);
                p->offset = INDENT;
@@ -856,7 +803,7 @@ post_RS(DECL_ARGS)
 static void
 print_man_node(DECL_ARGS)
 {
-       int              c, sz;
+       int              c;
 
        c = 1;
 
@@ -866,46 +813,49 @@ print_man_node(DECL_ARGS)
                        term_vspace(p);
                        break;
                }
-               /*
-                * Note!  This is hacky.  Here, we recognise the `\c'
-                * escape embedded in so many -man pages.  It's supposed
-                * to remove the subsequent space, so we mark NOSPACE if
-                * it's encountered in the string.
-                */
-               sz = (int)strlen(n->string);
+
                term_word(p, n->string);
-               if (sz >= 2 && n->string[sz - 1] == 'c' &&
-                               n->string[sz - 2] == '\\')
-                       p->flags |= TERMP_NOSPACE;
+
                /* FIXME: this means that macro lines are munged!  */
+
                if (MANT_LITERAL & mt->fl) {
+                       p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
                        p->flags |= TERMP_NOSPACE;
                        term_flushln(p);
+                       p->rmargin = p->maxrmargin = 65;
                }
                break;
        default:
+               if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
+                       term_fontrepl(p, TERMFONT_NONE);
                if (termacts[n->tok].pre)
                        c = (*termacts[n->tok].pre)(p, mt, n, m);
                break;
        }
 
        if (c && n->child)
-               print_man_body(p, mt, n->child, m);
+               print_man_nodelist(p, mt, n->child, m);
 
-       if (MAN_TEXT != n->type)
+       if (MAN_TEXT != n->type) {
                if (termacts[n->tok].post)
                        (*termacts[n->tok].post)(p, mt, n, m);
+               if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
+                       term_fontrepl(p, TERMFONT_NONE);
+       }
+
+       if (MAN_EOS & n->flags)
+               p->flags |= TERMP_SENTENCE;
 }
 
 
 static void
-print_man_body(DECL_ARGS)
+print_man_nodelist(DECL_ARGS)
 {
 
        print_man_node(p, mt, n, m);
        if ( ! n->next)
                return;
-       print_man_body(p, mt, n->next, m);
+       print_man_nodelist(p, mt, n->next, m);
 }
 
 
@@ -914,6 +864,8 @@ print_man_foot(struct termp *p, const struct man_meta *meta)
 {
        char            buf[DATESIZ];
 
+       term_fontrepl(p, TERMFONT_NONE);
+
        time2a(meta->date, buf, DATESIZ);
 
        term_vspace(p);
@@ -942,18 +894,30 @@ static void
 print_man_head(struct termp *p, const struct man_meta *m)
 {
        char            buf[BUFSIZ], title[BUFSIZ];
+       size_t          buflen, titlen;
+
+       /*
+        * Note that old groff would spit out some spaces before the
+        * header.  We discontinue this strange behaviour, but at one
+        * point we did so here.
+        */
 
        p->rmargin = p->maxrmargin;
+
        p->offset = 0;
        buf[0] = title[0] = '\0';
 
        if (m->vol)
                strlcpy(buf, m->vol, BUFSIZ);
+       buflen = strlen(buf);
 
        snprintf(title, BUFSIZ, "%s(%d)", m->title, m->msec);
+       titlen = strlen(title);
 
        p->offset = 0;
-       p->rmargin = (p->maxrmargin - strlen(buf) + 1) / 2;
+       p->rmargin = 2 * (titlen+1) + buflen < p->maxrmargin ?
+           (p->maxrmargin - strlen(buf) + 1) / 2 :
+           p->maxrmargin - buflen;
        p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
 
        term_word(p, title);
@@ -961,20 +925,31 @@ print_man_head(struct termp *p, const struct man_meta *m)
 
        p->flags |= TERMP_NOLPAD | TERMP_NOSPACE;
        p->offset = p->rmargin;
-       p->rmargin = p->maxrmargin - strlen(title);
+       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_NOLPAD | TERMP_NOSPACE;
+               p->offset = p->rmargin;
+               p->rmargin = p->maxrmargin;
+               term_word(p, title);
+               term_flushln(p);
+       }
 
        p->rmargin = p->maxrmargin;
        p->offset = 0;
        p->flags &= ~TERMP_NOSPACE;
+
+       /* 
+        * Groff likes to have some leading spaces before content.  Well
+        * that's fine by me.
+        */
+
+       term_vspace(p);
+       term_vspace(p);
+       term_vspace(p);
 }