]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_term.c
Fix following the first: `Ft' is given special treatment if specified before
[mandoc.git] / mdoc_term.c
index b0e3a68f3ac1e410d0ef2de636b24404f4014b7e..fec3bf483642edf869fb8525450ade1e42ffe1d5 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_term.c,v 1.124 2010/05/15 16:24:38 kristaps Exp $ */
+/*     $Id: mdoc_term.c,v 1.140 2010/06/04 22:26:13 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -27,6 +27,7 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "mandoc.h"
 #include "out.h"
 #include "term.h"
 #include "mdoc.h"
@@ -60,7 +61,6 @@ static        int       arg_getattrs(const int *, int *, size_t,
                        const struct mdoc_node *);
 static int       arg_getattr(int, const struct mdoc_node *);
 static int       arg_disptype(const struct mdoc_node *);
-static int       arg_listtype(const struct mdoc_node *);
 static void      print_bvspace(struct termp *,
                        const struct mdoc_node *,
                        const struct mdoc_node *);
@@ -260,6 +260,7 @@ static      const struct termact termacts[MDOC_MAX] = {
        { termp_sp_pre, NULL }, /* br */
        { termp_sp_pre, NULL }, /* sp */ 
        { termp_under_pre, termp____post }, /* %U */ 
+       { NULL, NULL }, /* Ta */ 
 };
 
 
@@ -274,6 +275,7 @@ terminal_mdoc(void *arg, const struct mdoc *mdoc)
 
        p->overstep = 0;
        p->maxrmargin = p->defrmargin;
+       p->tabwidth = 5;
 
        if (NULL == p->symtab)
                switch (p->enc) {
@@ -511,47 +513,6 @@ arg_disptype(const struct mdoc_node *n)
 }
 
 
-static int
-arg_listtype(const struct mdoc_node *n)
-{
-       int              i, len;
-
-       assert(MDOC_BLOCK == n->type);
-
-       len = (int)(n->args ? n->args->argc : 0);
-
-       for (i = 0; i < len; i++) 
-               switch (n->args->argv[i].arg) {
-               case (MDOC_Bullet):
-                       /* FALLTHROUGH */
-               case (MDOC_Dash):
-                       /* FALLTHROUGH */
-               case (MDOC_Enum):
-                       /* FALLTHROUGH */
-               case (MDOC_Hyphen):
-                       /* FALLTHROUGH */
-               case (MDOC_Tag):
-                       /* FALLTHROUGH */
-               case (MDOC_Inset):
-                       /* FALLTHROUGH */
-               case (MDOC_Diag):
-                       /* FALLTHROUGH */
-               case (MDOC_Item):
-                       /* FALLTHROUGH */
-               case (MDOC_Column):
-                       /* FALLTHROUGH */
-               case (MDOC_Hang):
-                       /* FALLTHROUGH */
-               case (MDOC_Ohang):
-                       return(n->args->argv[i].arg);
-               default:
-                       break;
-               }
-
-       return(-1);
-}
-
-
 static size_t
 a2offs(const struct mdoc_argv *arg)
 {
@@ -654,13 +615,13 @@ print_bvspace(struct termp *p,
 
        /* A `-column' does not assert vspace within the list. */
 
-       if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Column, bl))
+       if (MDOC_Bl == bl->tok && LIST_column == bl->data.list)
                if (n->prev && MDOC_It == n->prev->tok)
                        return;
 
        /* A `-diag' without body does not vspace. */
 
-       if (MDOC_Bl == bl->tok && arg_hasattr(MDOC_Diag, bl)) 
+       if (MDOC_Bl == bl->tok && LIST_diag == bl->data.list)
                if (n->prev && MDOC_It == n->prev->tok) {
                        assert(n->prev->body);
                        if (NULL == n->prev->body->child)
@@ -704,8 +665,9 @@ termp_it_pre(DECL_ARGS)
 {
        const struct mdoc_node *bl, *nn;
        char                    buf[7];
-       int                     i, type, keys[3], vals[3];
+       int                     i, keys[3], vals[3];
        size_t                  width, offset, ncols, dcol;
+       enum mdoc_list          type;
 
        if (MDOC_BLOCK == n->type) {
                print_bvspace(p, n->parent->parent, n);
@@ -724,8 +686,7 @@ termp_it_pre(DECL_ARGS)
 
        arg_getattrs(keys, vals, 3, bl);
 
-       type = arg_listtype(bl);
-       assert(-1 != type);
+       type = bl->data.list;
 
        /* 
         * First calculate width and offset.  This is pretty easy unless
@@ -739,8 +700,8 @@ termp_it_pre(DECL_ARGS)
                offset = a2offs(&bl->args->argv[vals[1]]);
 
        switch (type) {
-       case (MDOC_Column):
-               if (MDOC_BODY == n->type)
+       case (LIST_column):
+               if (MDOC_HEAD == n->type)
                        break;
                /*
                 * Imitate groff's column handling:
@@ -755,8 +716,13 @@ termp_it_pre(DECL_ARGS)
                /* LINTED */
                dcol = ncols < 5 ? 4 : ncols == 5 ? 3 : 1;
 
+               /*
+                * Calculate the offset by applying all prior MDOC_BODY,
+                * so we stop at the MDOC_HEAD (NULL == nn->prev).
+                */
+
                for (i = 0, nn = n->prev; 
-                               nn && i < (int)ncols; 
+                               nn->prev && i < (int)ncols; 
                                nn = nn->prev, i++)
                        offset += dcol + a2width
                                (&bl->args->argv[vals[2]], i);
@@ -797,25 +763,25 @@ termp_it_pre(DECL_ARGS)
         */
 
        switch (type) {
-       case (MDOC_Bullet):
+       case (LIST_bullet):
                /* FALLTHROUGH */
-       case (MDOC_Dash):
+       case (LIST_dash):
                /* FALLTHROUGH */
-       case (MDOC_Hyphen):
+       case (LIST_hyphen):
                if (width < 4)
                        width = 4;
                break;
-       case (MDOC_Enum):
+       case (LIST_enum):
                if (width < 5)
                        width = 5;
                break;
-       case (MDOC_Hang):
+       case (LIST_hang):
                if (0 == width)
                        width = 8;
                break;
-       case (MDOC_Column):
+       case (LIST_column):
                /* FALLTHROUGH */
-       case (MDOC_Tag):
+       case (LIST_tag):
                if (0 == width)
                        width = 10;
                break;
@@ -831,11 +797,11 @@ termp_it_pre(DECL_ARGS)
        p->flags |= TERMP_NOSPACE;
 
        switch (type) {
-       case (MDOC_Diag):
+       case (LIST_diag):
                if (MDOC_BODY == n->type)
                        term_word(p, "\\ \\ ");
                break;
-       case (MDOC_Inset):
+       case (LIST_inset):
                if (MDOC_BODY == n->type) 
                        term_word(p, "\\ ");
                break;
@@ -846,7 +812,7 @@ termp_it_pre(DECL_ARGS)
        p->flags |= TERMP_NOSPACE;
 
        switch (type) {
-       case (MDOC_Diag):
+       case (LIST_diag):
                if (MDOC_HEAD == n->type)
                        term_fontpush(p, TERMFONT_BOLD);
                break;
@@ -862,19 +828,19 @@ termp_it_pre(DECL_ARGS)
         */
 
        switch (type) {
-       case (MDOC_Bullet):
+       case (LIST_bullet):
                /* FALLTHROUGH */
-       case (MDOC_Dash):
+       case (LIST_dash):
                /* FALLTHROUGH */
-       case (MDOC_Enum):
+       case (LIST_enum):
                /* FALLTHROUGH */
-       case (MDOC_Hyphen):
+       case (LIST_hyphen):
                if (MDOC_HEAD == n->type)
                        p->flags |= TERMP_NOBREAK;
                else
                        p->flags |= TERMP_NOLPAD;
                break;
-       case (MDOC_Hang):
+       case (LIST_hang):
                if (MDOC_HEAD == n->type)
                        p->flags |= TERMP_NOBREAK;
                else
@@ -897,7 +863,7 @@ termp_it_pre(DECL_ARGS)
                } else
                        p->flags |= TERMP_HANG;
                break;
-       case (MDOC_Tag):
+       case (LIST_tag):
                if (MDOC_HEAD == n->type)
                        p->flags |= TERMP_NOBREAK | TERMP_TWOSPACE;
                else
@@ -908,18 +874,21 @@ termp_it_pre(DECL_ARGS)
                if (NULL == n->next || NULL == n->next->child)
                        p->flags |= TERMP_DANGLE;
                break;
-       case (MDOC_Column):
-               if (MDOC_HEAD == n->type) {
-                       assert(n->next);
-                       if (MDOC_BODY == n->next->type)
-                               p->flags &= ~TERMP_NOBREAK;
-                       else
-                               p->flags |= TERMP_NOBREAK;
-                       if (n->prev) 
-                               p->flags |= TERMP_NOLPAD;
-               }
+       case (LIST_column):
+               if (MDOC_HEAD == n->type)
+                       break;
+
+               if (NULL == n->next)
+                       p->flags &= ~TERMP_NOBREAK;
+               else
+                       p->flags |= TERMP_NOBREAK;
+
+               assert(n->prev);
+               if (MDOC_BODY == n->prev->type) 
+                       p->flags |= TERMP_NOLPAD;
+
                break;
-       case (MDOC_Diag):
+       case (LIST_diag):
                if (MDOC_HEAD == n->type)
                        p->flags |= TERMP_NOBREAK;
                break;
@@ -936,7 +905,7 @@ termp_it_pre(DECL_ARGS)
        p->offset += offset;
 
        switch (type) {
-       case (MDOC_Hang):
+       case (LIST_hang):
                /*
                 * Same stipulation as above, regarding `-hang'.  We
                 * don't want to recalculate rmargin and offsets when
@@ -947,31 +916,31 @@ termp_it_pre(DECL_ARGS)
                                 MDOC_Bd == n->next->child->tok))
                        break;
                /* FALLTHROUGH */
-       case (MDOC_Bullet):
+       case (LIST_bullet):
                /* FALLTHROUGH */
-       case (MDOC_Dash):
+       case (LIST_dash):
                /* FALLTHROUGH */
-       case (MDOC_Enum):
+       case (LIST_enum):
                /* FALLTHROUGH */
-       case (MDOC_Hyphen):
+       case (LIST_hyphen):
                /* FALLTHROUGH */
-       case (MDOC_Tag):
+       case (LIST_tag):
                assert(width);
                if (MDOC_HEAD == n->type)
                        p->rmargin = p->offset + width;
                else 
                        p->offset += width;
                break;
-       case (MDOC_Column):
+       case (LIST_column):
                assert(width);
                p->rmargin = p->offset + width;
                /* 
                 * XXX - this behaviour is not documented: the
                 * right-most column is filled to the right margin.
                 */
-               if (MDOC_HEAD == n->type &&
-                               MDOC_BODY == n->next->type &&
-                               p->rmargin < p->maxrmargin)
+               if (MDOC_HEAD == n->type)
+                       break;
+               if (NULL == n->next && p->rmargin < p->maxrmargin)
                        p->rmargin = p->maxrmargin;
                break;
        default:
@@ -985,19 +954,19 @@ termp_it_pre(DECL_ARGS)
 
        if (MDOC_HEAD == n->type)
                switch (type) {
-               case (MDOC_Bullet):
+               case (LIST_bullet):
                        term_fontpush(p, TERMFONT_BOLD);
                        term_word(p, "\\[bu]");
                        term_fontpop(p);
                        break;
-               case (MDOC_Dash):
+               case (LIST_dash):
                        /* FALLTHROUGH */
-               case (MDOC_Hyphen):
+               case (LIST_hyphen):
                        term_fontpush(p, TERMFONT_BOLD);
                        term_word(p, "\\(hy");
                        term_fontpop(p);
                        break;
-               case (MDOC_Enum):
+               case (LIST_enum):
                        (pair->ppair->ppair->count)++;
                        snprintf(buf, sizeof(buf), "%d.", 
                                        pair->ppair->ppair->count);
@@ -1012,20 +981,20 @@ termp_it_pre(DECL_ARGS)
         */
 
        switch (type) {
-       case (MDOC_Bullet):
+       case (LIST_bullet):
                /* FALLTHROUGH */
-       case (MDOC_Item):
+       case (LIST_item):
                /* FALLTHROUGH */
-       case (MDOC_Dash):
+       case (LIST_dash):
                /* FALLTHROUGH */
-       case (MDOC_Hyphen):
+       case (LIST_hyphen):
                /* FALLTHROUGH */
-       case (MDOC_Enum):
+       case (LIST_enum):
                if (MDOC_HEAD == n->type)
                        return(0);
                break;
-       case (MDOC_Column):
-               if (MDOC_BODY == n->type)
+       case (LIST_column):
+               if (MDOC_HEAD == n->type)
                        return(0);
                break;
        default:
@@ -1040,29 +1009,28 @@ termp_it_pre(DECL_ARGS)
 static void
 termp_it_post(DECL_ARGS)
 {
-       int                type;
+       enum mdoc_list     type;
 
        if (MDOC_BLOCK == n->type)
                return;
 
-       type = arg_listtype(n->parent->parent->parent);
-       assert(-1 != type);
+       type = n->parent->parent->parent->data.list;
 
        switch (type) {
-       case (MDOC_Item):
+       case (LIST_item):
                /* FALLTHROUGH */
-       case (MDOC_Diag):
+       case (LIST_diag):
                /* FALLTHROUGH */
-       case (MDOC_Inset):
+       case (LIST_inset):
                if (MDOC_BODY == n->type)
-                       term_flushln(p);
+                       term_newln(p);
                break;
-       case (MDOC_Column):
-               if (MDOC_HEAD == n->type)
+       case (LIST_column):
+               if (MDOC_BODY == n->type)
                        term_flushln(p);
                break;
        default:
-               term_flushln(p);
+               term_newln(p);
                break;
        }
 
@@ -1085,6 +1053,9 @@ static int
 termp_nm_pre(DECL_ARGS)
 {
 
+       if (NULL == n->child && NULL == m->name)
+               return(1);
+
        if (SEC_SYNOPSIS == n->sec && MDOC_LINE & n->flags)
                term_newln(p);
 
@@ -1092,6 +1063,7 @@ termp_nm_pre(DECL_ARGS)
 
        if (NULL == n->child)
                term_word(p, m->name);
+
        return(1);
 }
 
@@ -1216,7 +1188,7 @@ termp_rv_pre(DECL_ARGS)
                        term_word(p, "()");
        }
 
-       if (n->child->next)
+       if (n->child && n->child->next)
                term_word(p, "functions return");
        else
                term_word(p, "function returns");
@@ -1229,6 +1201,7 @@ termp_rv_pre(DECL_ARGS)
        term_fontpop(p);
 
                term_word(p, "is set to indicate the error.");
+       p->flags |= TERMP_SENTENCE;
 
        return(0);
 }
@@ -1255,12 +1228,13 @@ termp_ex_pre(DECL_ARGS)
                        p->flags &= ~TERMP_NOSPACE;
        }
 
-       if (n->child->next)
+       if (n->child && n->child->next)
                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;
 
        return(0);
 }
@@ -1384,12 +1358,7 @@ static void
 termp_fd_post(DECL_ARGS)
 {
 
-       if (n->sec != SEC_SYNOPSIS || ! (MDOC_LINE & n->flags))
-               return;
-
        term_newln(p);
-       if (n->next && MDOC_Fd != n->next->tok)
-               term_vspace(p);
 }
 
 
@@ -1462,6 +1431,7 @@ termp_bt_pre(DECL_ARGS)
 {
 
        term_word(p, "is currently in beta test.");
+       p->flags |= TERMP_SENTENCE;
        return(0);
 }
 
@@ -1482,6 +1452,7 @@ termp_ud_pre(DECL_ARGS)
 {
 
        term_word(p, "currently under development.");
+       p->flags |= TERMP_SENTENCE;
        return(0);
 }
 
@@ -1565,6 +1536,14 @@ termp_fn_pre(DECL_ARGS)
 {
        const struct mdoc_node  *nn;
 
+       /* NB: MDOC_LINE has no effect on this macro! */
+       if (SEC_SYNOPSIS == n->sec) {
+               if (n->prev && MDOC_Ft == n->prev->tok)
+                       term_newln(p);
+               else if (n->prev)
+                       term_vspace(p);
+       }
+
        term_fontpush(p, TERMFONT_BOLD);
        term_word(p, n->child->string);
        term_fontpop(p);
@@ -1595,8 +1574,9 @@ static void
 termp_fn_post(DECL_ARGS)
 {
 
-       if (n->sec == SEC_SYNOPSIS && n->next && MDOC_LINE & n->flags)
-               term_vspace(p);
+       /* NB: MDOC_LINE has no effect on this macro! */
+       if (SEC_SYNOPSIS == n->sec)
+               term_newln(p);
 }
 
 
@@ -1631,6 +1611,7 @@ termp_fa_pre(DECL_ARGS)
 static int
 termp_bd_pre(DECL_ARGS)
 {
+       size_t                   tabwidth;
        int                      i, type;
        size_t                   rm, rmax;
        const struct mdoc_node  *nn;
@@ -1660,6 +1641,8 @@ termp_bd_pre(DECL_ARGS)
        if (MDOC_Literal != type && MDOC_Unfilled != type)
                return(1);
 
+       tabwidth = p->tabwidth;
+       p->tabwidth = 8;
        rm = p->rmargin;
        rmax = p->maxrmargin;
        p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
@@ -1667,13 +1650,12 @@ termp_bd_pre(DECL_ARGS)
        for (nn = n->child; nn; nn = nn->next) {
                p->flags |= TERMP_NOSPACE;
                print_mdoc_node(p, pair, m, nn);
-               if (NULL == nn->next)
-                       continue;
-               if (nn->prev && nn->prev->line < nn->line)
-                       term_flushln(p);
-               else if (NULL == nn->prev)
+               if (NULL == nn->prev ||
+                   nn->prev->line < nn->line ||
+                   NULL == nn->next)
                        term_flushln(p);
        }
+       p->tabwidth = tabwidth;
 
        p->rmargin = rm;
        p->maxrmargin = rmax;
@@ -1701,7 +1683,7 @@ termp_bd_post(DECL_ARGS)
                p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
 
        p->flags |= TERMP_NOSPACE;
-       term_flushln(p);
+       term_newln(p);
 
        p->rmargin = rm;
        p->maxrmargin = rmax;
@@ -1874,11 +1856,15 @@ static int
 termp_in_pre(DECL_ARGS)
 {
 
-       term_fontpush(p, TERMFONT_BOLD);
-       if (SEC_SYNOPSIS == n->sec)
+       if (SEC_SYNOPSIS == n->sec && MDOC_LINE & n->flags) {
+               term_fontpush(p, TERMFONT_BOLD);
                term_word(p, "#include");
+               term_word(p, "<");
+       } else {
+               term_word(p, "<");
+               term_fontpush(p, TERMFONT_UNDER);
+       }
 
-       term_word(p, "<");
        p->flags |= TERMP_NOSPACE;
        return(1);
 }
@@ -1889,23 +1875,16 @@ static void
 termp_in_post(DECL_ARGS)
 {
 
-       term_fontpush(p, TERMFONT_BOLD);
+       if (SEC_SYNOPSIS == n->sec && MDOC_LINE & n->flags)
+               term_fontpush(p, TERMFONT_BOLD);
+
        p->flags |= TERMP_NOSPACE;
        term_word(p, ">");
-       term_fontpop(p);
-
-       if (SEC_SYNOPSIS != n->sec && ! (MDOC_LINE & n->flags))
-               return;
 
-       term_newln(p);
-       /* 
-        * XXX Not entirely correct.  If `.In foo bar' is specified in
-        * the SYNOPSIS section, then it produces a single break after
-        * the <foo>; mandoc asserts a vertical space.  Since this
-        * construction is rarely used, I think it's fine.
-        */
-       if (n->next && MDOC_In != n->next->tok)
-               term_vspace(p);
+       if (SEC_SYNOPSIS == n->sec && MDOC_LINE & n->flags) {
+               term_fontpop(p);
+               term_newln(p);
+       }
 }