]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_term.c
Enable the unified error/warning enumeration in mandoc.h that's
[mandoc.git] / man_term.c
index 704511b4b5111580aa006d377f7ae6605bd80c9a..c6b3dc06c01f9cfeda52360c6f833a37e12e3f8c 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: man_term.c,v 1.53 2009/11/12 08:00:21 kristaps Exp $ */
+/*     $Id: man_term.c,v 1.71 2010/05/17 22:11:42 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>
@@ -22,6 +26,7 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "mandoc.h"
 #include "out.h"
 #include "man.h"
 #include "term.h"
@@ -61,13 +66,10 @@ 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 *);
 
@@ -106,38 +108,42 @@ static    void              post_SS(DECL_ARGS);
 static void              post_TP(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, NULL }, /* SB */
-       { pre_BI, NULL }, /* BI */
-       { pre_BI, NULL }, /* IB */
-       { pre_RB, NULL }, /* BR */
-       { pre_RB, NULL }, /* RB */
-       { NULL, NULL }, /* R */
-       { pre_B, NULL }, /* B */
-       { pre_I, NULL }, /* I */
-       { pre_RI, NULL }, /* IR */
-       { pre_RI, NULL }, /* RI */
-       { NULL, NULL }, /* na */
-       { pre_I, NULL }, /* i */
-       { pre_sp, NULL }, /* sp */
-       { pre_nf, NULL }, /* nf */
-       { pre_fi, NULL }, /* fi */
-       { NULL, 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, 0 }, /* AT */
 };
 
 
@@ -152,6 +158,9 @@ terminal_man(void *arg, const struct man *man)
 
        p = (struct termp *)arg;
 
+       p->overstep = 0;
+       p->maxrmargin = p->defrmargin;
+
        if (NULL == p->symtab)
                switch (p->enc) {
                case (TERMENC_ASCII):
@@ -257,9 +266,8 @@ static int
 pre_nf(DECL_ARGS)
 {
 
-       term_newln(p);
        mt->fl |= MANT_LITERAL;
-       return(1);
+       return(MAN_Vb != n->tok);
 }
 
 
@@ -357,7 +365,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);
@@ -472,7 +480,6 @@ pre_IP(DECL_ARGS)
                break;
        case (MAN_HEAD):
                p->flags |= TERMP_NOBREAK;
-               p->flags |= TERMP_TWOSPACE;
                break;
        case (MAN_BLOCK):
                print_bvspace(p, n);
@@ -533,7 +540,6 @@ post_IP(DECL_ARGS)
        case (MAN_HEAD):
                term_flushln(p);
                p->flags &= ~TERMP_NOBREAK;
-               p->flags &= ~TERMP_TWOSPACE;
                p->rmargin = p->maxrmargin;
                break;
        case (MAN_BODY):
@@ -575,10 +581,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):
@@ -695,6 +704,9 @@ 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):
@@ -772,6 +784,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;
@@ -783,7 +797,8 @@ post_RS(DECL_ARGS)
 static void
 print_man_node(DECL_ARGS)
 {
-       int              c, sz;
+       size_t           rm, rmax;
+       int              c;
 
        c = 1;
 
@@ -793,27 +808,24 @@ 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) {
+                       rm = p->rmargin;
+                       rmax = p->maxrmargin;
+                       p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
                        p->flags |= TERMP_NOSPACE;
                        term_flushln(p);
+                       p->rmargin = rm;
+                       p->maxrmargin = rmax;
                }
                break;
        default:
-               term_fontrepl(p, TERMFONT_NONE);
+               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;
@@ -825,8 +837,12 @@ print_man_node(DECL_ARGS)
        if (MAN_TEXT != n->type) {
                if (termacts[n->tok].post)
                        (*termacts[n->tok].post)(p, mt, n, m);
-               term_fontrepl(p, TERMFONT_NONE);
+               if ( ! (MAN_NOTEXT & termacts[n->tok].flags))
+                       term_fontrepl(p, TERMFONT_NONE);
        }
+
+       if (MAN_EOS & n->flags)
+               p->flags |= TERMP_SENTENCE;
 }
 
 
@@ -850,6 +866,8 @@ print_man_foot(struct termp *p, const struct man_meta *meta)
 
        time2a(meta->date, buf, DATESIZ);
 
+       term_vspace(p);
+       term_vspace(p);
        term_vspace(p);
 
        p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
@@ -876,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);
+       snprintf(title, BUFSIZ, "%s(%s)", 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);
@@ -895,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);
 }