warning about unknown .Lb arguments; inspired by mdoclint(1)

[mandoc.git] / mdoc_term.c

diff --git a/mdoc_term.c b/mdoc_term.c
index e4c0b92cc2fedcab3b58a7d01a4f0b3292285b15..27d6d9388cae24c9cd0275b3a099555833e6539c 100644 (file)
--- a/mdoc_term.c
+++ b/mdoc_term.c
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_term.c,v 1.357 2017/05/09 14:10:01 schwarze Exp $ */
+/*     $Id: mdoc_term.c,v 1.362 2017/06/07 17:38:26 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010, 2012-2017 Ingo Schwarze <schwarze@openbsd.org>
@@ -259,8 +259,7 @@ terminal_mdoc(void *arg, const struct roff_man *mdoc)
        size_t                   save_defindent;
 
        p = (struct termp *)arg;
-       p->overstep = 0;
-       p->rmargin = p->maxrmargin = p->defrmargin;
+       p->tcol->rmargin = p->maxrmargin = p->defrmargin;
        term_tab_set(p, NULL);
        term_tab_set(p, "T");
        term_tab_set(p, ".5i");
@@ -317,8 +316,8 @@ print_mdoc_node(DECL_ARGS)
                return;
 
        chld = 1;
-       offset = p->offset;
-       rmargin = p->rmargin;
+       offset = p->tcol->offset;
+       rmargin = p->tcol->rmargin;
        n->flags &= ~NODE_ENDED;
        n->prev_font = p->fonti;
 
@@ -407,8 +406,9 @@ print_mdoc_node(DECL_ARGS)
        if (NODE_EOS & n->flags)
                p->flags |= TERMP_SENTENCE;
 
-       p->offset = offset;
-       p->rmargin = rmargin;
+       if (n->type != ROFFT_TEXT)
+               p->tcol->offset = offset;
+       p->tcol->rmargin = rmargin;
 }
 
 static void
@@ -428,9 +428,9 @@ print_mdoc_foot(struct termp *p, const struct roff_meta *meta)
 
        term_vspace(p);
 
-       p->offset = 0;
+       p->tcol->offset = 0;
        sz = term_strlen(p, meta->date);
-       p->rmargin = p->maxrmargin > sz ?
+       p->tcol->rmargin = p->maxrmargin > sz ?
            (p->maxrmargin + term_len(p, 1) - sz) / 2 : 0;
        p->trailspace = 1;
        p->flags |= TERMP_NOSPACE | TERMP_NOBREAK;
@@ -438,16 +438,16 @@ print_mdoc_foot(struct termp *p, const struct roff_meta *meta)
        term_word(p, meta->os);
        term_flushln(p);
 
-       p->offset = p->rmargin;
+       p->tcol->offset = p->tcol->rmargin;
        sz = term_strlen(p, meta->os);
-       p->rmargin = p->maxrmargin > sz ? p->maxrmargin - sz : 0;
+       p->tcol->rmargin = p->maxrmargin > sz ? p->maxrmargin - sz : 0;
        p->flags |= TERMP_NOSPACE;
 
        term_word(p, meta->date);
        term_flushln(p);
 
-       p->offset = p->rmargin;
-       p->rmargin = p->maxrmargin;
+       p->tcol->offset = p->tcol->rmargin;
+       p->tcol->rmargin = p->maxrmargin;
        p->trailspace = 0;
        p->flags &= ~TERMP_NOBREAK;
        p->flags |= TERMP_NOSPACE;
@@ -455,8 +455,8 @@ print_mdoc_foot(struct termp *p, const struct roff_meta *meta)
        term_word(p, meta->os);
        term_flushln(p);
 
-       p->offset = 0;
-       p->rmargin = p->maxrmargin;
+       p->tcol->offset = 0;
+       p->tcol->rmargin = p->maxrmargin;
        p->flags = 0;
 }
 
@@ -496,8 +496,8 @@ print_mdoc_head(struct termp *p, const struct roff_meta *meta)
 
        p->flags |= TERMP_NOBREAK | TERMP_NOSPACE;
        p->trailspace = 1;
-       p->offset = 0;
-       p->rmargin = 2 * (titlen+1) + vollen < p->maxrmargin ?
+       p->tcol->offset = 0;
+       p->tcol->rmargin = 2 * (titlen+1) + vollen < p->maxrmargin ?
            (p->maxrmargin - vollen + term_len(p, 1)) / 2 :
            vollen < p->maxrmargin ?  p->maxrmargin - vollen : 0;
 
@@ -505,26 +505,26 @@ print_mdoc_head(struct termp *p, const struct roff_meta *meta)
        term_flushln(p);
 
        p->flags |= TERMP_NOSPACE;
-       p->offset = p->rmargin;
-       p->rmargin = p->offset + vollen + titlen < p->maxrmargin ?
-           p->maxrmargin - titlen : p->maxrmargin;
+       p->tcol->offset = p->tcol->rmargin;
+       p->tcol->rmargin = p->tcol->offset + vollen + titlen <
+           p->maxrmargin ? p->maxrmargin - titlen : p->maxrmargin;
 
        term_word(p, volume);
        term_flushln(p);
 
        p->flags &= ~TERMP_NOBREAK;
        p->trailspace = 0;
-       if (p->rmargin + titlen <= p->maxrmargin) {
+       if (p->tcol->rmargin + titlen <= p->maxrmargin) {
                p->flags |= TERMP_NOSPACE;
-               p->offset = p->rmargin;
-               p->rmargin = p->maxrmargin;
+               p->tcol->offset = p->tcol->rmargin;
+               p->tcol->rmargin = p->maxrmargin;
                term_word(p, title);
                term_flushln(p);
        }
 
        p->flags &= ~TERMP_NOSPACE;
-       p->offset = 0;
-       p->rmargin = p->maxrmargin;
+       p->tcol->offset = 0;
+       p->tcol->rmargin = p->maxrmargin;
        free(title);
        free(volume);
 }
@@ -649,8 +649,8 @@ termp_it_pre(DECL_ARGS)
 
        if (bl->norm->Bl.offs != NULL) {
                offset = a2width(p, bl->norm->Bl.offs);
-               if (offset < 0 && (size_t)(-offset) > p->offset)
-                       offset = -p->offset;
+               if (offset < 0 && (size_t)(-offset) > p->tcol->offset)
+                       offset = -p->tcol->offset;
                else if (offset > SHRT_MAX)
                        offset = 0;
        }
@@ -714,8 +714,8 @@ termp_it_pre(DECL_ARGS)
                 * handling for column for how this changes.
                 */
                width = a2width(p, bl->norm->Bl.width) + term_len(p, 2);
-               if (width < 0 && (size_t)(-width) > p->offset)
-                       width = -p->offset;
+               if (width < 0 && (size_t)(-width) > p->tcol->offset)
+                       width = -p->tcol->offset;
                else if (width > SHRT_MAX)
                        width = 0;
                break;
@@ -764,33 +764,15 @@ termp_it_pre(DECL_ARGS)
        case LIST_bullet:
        case LIST_dash:
        case LIST_hyphen:
-               /*
-                * Weird special case.
-                * Some very narrow lists actually hang.
-                */
-               if (width <= (int)term_len(p, 2))
-                       p->flags |= TERMP_HANG;
-               if (n->type != ROFFT_HEAD)
-                       break;
-               p->flags |= TERMP_NOBREAK;
-               p->trailspace = 1;
+               if (n->type == ROFFT_HEAD) {
+                       p->flags |= TERMP_NOBREAK | TERMP_HANG;
+                       p->trailspace = 1;
+               } else if (width <= (int)term_len(p, 2))
+                       p->flags |= TERMP_NOPAD;
                break;
        case LIST_hang:
                if (n->type != ROFFT_HEAD)
                        break;
-
-               /*
-                * This is ugly.  If `-hang' is specified and the body
-                * is a `Bl' or `Bd', then we want basically to nullify
-                * the "overstep" effect in term_flushln() and treat
-                * this as a `-ohang' list instead.
-                */
-               if (NULL != n->next &&
-                   NULL != n->next->child &&
-                   (MDOC_Bl == n->next->child->tok ||
-                    MDOC_Bd == n->next->child->tok))
-                       break;
-
                p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG;
                p->trailspace = 1;
                break;
@@ -802,7 +784,7 @@ termp_it_pre(DECL_ARGS)
                p->trailspace = 2;
 
                if (NULL == n->next || NULL == n->next->child)
-                       p->flags |= TERMP_DANGLE;
+                       p->flags |= TERMP_HANG;
                break;
        case LIST_column:
                if (n->type == ROFFT_HEAD)
@@ -833,43 +815,31 @@ termp_it_pre(DECL_ARGS)
         * necessarily lengthened.  Everybody gets the offset.
         */
 
-       p->offset += offset;
+       p->tcol->offset += offset;
 
        switch (type) {
-       case LIST_hang:
-               /*
-                * Same stipulation as above, regarding `-hang'.  We
-                * don't want to recalculate rmargin and offsets when
-                * using `Bd' or `Bl' within `-hang' overstep lists.
-                */
-               if (n->type == ROFFT_HEAD &&
-                   NULL != n->next &&
-                   NULL != n->next->child &&
-                   (MDOC_Bl == n->next->child->tok ||
-                    MDOC_Bd == n->next->child->tok))
-                       break;
-               /* FALLTHROUGH */
        case LIST_bullet:
        case LIST_dash:
        case LIST_enum:
        case LIST_hyphen:
+       case LIST_hang:
        case LIST_tag:
                if (n->type == ROFFT_HEAD)
-                       p->rmargin = p->offset + width;
+                       p->tcol->rmargin = p->tcol->offset + width;
                else
-                       p->offset += width;
+                       p->tcol->offset += width;
                break;
        case LIST_column:
                assert(width);
-               p->rmargin = p->offset + width;
+               p->tcol->rmargin = p->tcol->offset + width;
                /*
                 * XXX - this behaviour is not documented: the
                 * right-most column is filled to the right margin.
                 */
                if (n->type == ROFFT_HEAD)
                        break;
-               if (NULL == n->next && p->rmargin < p->maxrmargin)
-                       p->rmargin = p->maxrmargin;
+               if (n->next == NULL && p->tcol->rmargin < p->maxrmargin)
+                       p->tcol->rmargin = p->maxrmargin;
                break;
        default:
                break;
@@ -919,6 +889,7 @@ termp_it_pre(DECL_ARGS)
        case LIST_column:
                if (n->type == ROFFT_HEAD)
                        return 0;
+               p->minbl = 0;
                break;
        default:
                break;
@@ -959,8 +930,7 @@ termp_it_post(DECL_ARGS)
         * has munged them in the meanwhile.
         */
 
-       p->flags &= ~(TERMP_NOBREAK | TERMP_BRTRSP | TERMP_BRIND |
-                       TERMP_DANGLE | TERMP_HANG);
+       p->flags &= ~(TERMP_NOBREAK | TERMP_BRTRSP | TERMP_BRIND | TERMP_HANG);
        p->trailspace = 0;
 }
 
@@ -975,7 +945,7 @@ termp_nm_pre(DECL_ARGS)
        }
 
        if (n->type == ROFFT_BODY) {
-               if (NULL == n->child)
+               if (n->child == NULL)
                        return 0;
                p->flags |= TERMP_NOSPACE;
                cp = NULL;
@@ -984,9 +954,10 @@ termp_nm_pre(DECL_ARGS)
                if (cp == NULL)
                        cp = meta->name;
                if (cp == NULL)
-                       p->offset += term_len(p, 6);
+                       p->tcol->offset += term_len(p, 6);
                else
-                       p->offset += term_len(p, 1) + term_strlen(p, cp);
+                       p->tcol->offset += term_len(p, 1) +
+                           term_strlen(p, cp);
                return 1;
        }
 
@@ -997,18 +968,18 @@ termp_nm_pre(DECL_ARGS)
                synopsis_pre(p, n->parent);
 
        if (n->type == ROFFT_HEAD &&
-           NULL != n->next && NULL != n->next->child) {
+           n->next != NULL && n->next->child != NULL) {
                p->flags |= TERMP_NOSPACE | TERMP_NOBREAK | TERMP_BRIND;
                p->trailspace = 1;
-               p->rmargin = p->offset + term_len(p, 1);
-               if (NULL == n->child) {
-                       p->rmargin += term_strlen(p, meta->name);
-               } else if (n->child->type == ROFFT_TEXT) {
-                       p->rmargin += term_strlen(p, n->child->string);
-                       if (n->child->next)
+               p->tcol->rmargin = p->tcol->offset + term_len(p, 1);
+               if (n->child == NULL)
+                       p->tcol->rmargin += term_strlen(p, meta->name);
+               else if (n->child->type == ROFFT_TEXT) {
+                       p->tcol->rmargin += term_strlen(p, n->child->string);
+                       if (n->child->next != NULL)
                                p->flags |= TERMP_HANG;
                } else {
-                       p->rmargin += term_len(p, 5);
+                       p->tcol->rmargin += term_len(p, 5);
                        p->flags |= TERMP_HANG;
                }
        }
@@ -1280,7 +1251,7 @@ termp_sh_pre(DECL_ARGS)
                term_fontpush(p, TERMFONT_BOLD);
                break;
        case ROFFT_BODY:
-               p->offset = term_len(p, p->defindent);
+               p->tcol->offset = term_len(p, p->defindent);
                term_tab_set(p, NULL);
                term_tab_set(p, "T");
                term_tab_set(p, ".5i");
@@ -1311,7 +1282,7 @@ termp_sh_post(DECL_ARGS)
                break;
        case ROFFT_BODY:
                term_newln(p);
-               p->offset = 0;
+               p->tcol->offset = 0;
                break;
        default:
                break;
@@ -1333,7 +1304,7 @@ termp_d1_pre(DECL_ARGS)
        if (n->type != ROFFT_BLOCK)
                return 1;
        term_newln(p);
-       p->offset += term_len(p, p->defindent + 1);
+       p->tcol->offset += term_len(p, p->defindent + 1);
        term_tab_set(p, NULL);
        term_tab_set(p, "T");
        term_tab_set(p, ".5i");
@@ -1364,8 +1335,8 @@ termp_fn_pre(DECL_ARGS)
                return 0;
 
        if (pretty) {
-               rmargin = p->rmargin;
-               p->rmargin = p->offset + term_len(p, 4);
+               rmargin = p->tcol->rmargin;
+               p->tcol->rmargin = p->tcol->offset + term_len(p, 4);
                p->flags |= TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG;
        }
 
@@ -1380,8 +1351,9 @@ termp_fn_pre(DECL_ARGS)
        if (pretty) {
                term_flushln(p);
                p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND | TERMP_HANG);
-               p->offset = p->rmargin;
-               p->rmargin = rmargin;
+               p->flags |= TERMP_NOPAD;
+               p->tcol->offset = p->tcol->rmargin;
+               p->tcol->rmargin = rmargin;
        }
 
        p->flags |= TERMP_NOSPACE;
@@ -1442,7 +1414,7 @@ termp_fa_pre(DECL_ARGS)
 static int
 termp_bd_pre(DECL_ARGS)
 {
-       size_t                   lm, len, rm, rmax;
+       size_t                   lm, len;
        struct roff_node        *nn;
        int                      offset;
 
@@ -1458,15 +1430,15 @@ termp_bd_pre(DECL_ARGS)
            ! strcmp(n->norm->Bd.offs, "left"))
                /* nothing */;
        else if ( ! strcmp(n->norm->Bd.offs, "indent"))
-               p->offset += term_len(p, p->defindent + 1);
+               p->tcol->offset += term_len(p, p->defindent + 1);
        else if ( ! strcmp(n->norm->Bd.offs, "indent-two"))
-               p->offset += term_len(p, (p->defindent + 1) * 2);
+               p->tcol->offset += term_len(p, (p->defindent + 1) * 2);
        else {
                offset = a2width(p, n->norm->Bd.offs);
-               if (offset < 0 && (size_t)(-offset) > p->offset)
-                       p->offset = 0;
+               if (offset < 0 && (size_t)(-offset) > p->tcol->offset)
+                       p->tcol->offset = 0;
                else if (offset < SHRT_MAX)
-                       p->offset += offset;
+                       p->tcol->offset += offset;
        }
 
        /*
@@ -1477,9 +1449,9 @@ termp_bd_pre(DECL_ARGS)
         * lines are allowed.
         */
 
-       if (DISP_literal != n->norm->Bd.type &&
-           DISP_unfilled != n->norm->Bd.type &&
-           DISP_centered != n->norm->Bd.type)
+       if (n->norm->Bd.type != DISP_literal &&
+           n->norm->Bd.type != DISP_unfilled &&
+           n->norm->Bd.type != DISP_centered)
                return 1;
 
        if (n->norm->Bd.type == DISP_literal) {
@@ -1488,20 +1460,18 @@ termp_bd_pre(DECL_ARGS)
                term_tab_set(p, "8n");
        }
 
-       lm = p->offset;
-       rm = p->rmargin;
-       rmax = p->maxrmargin;
-       p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
-
-       for (nn = n->child; nn; nn = nn->next) {
-               if (DISP_centered == n->norm->Bd.type) {
+       lm = p->tcol->offset;
+       p->flags |= TERMP_BRNEVER;
+       for (nn = n->child; nn != NULL; nn = nn->next) {
+               if (n->norm->Bd.type == DISP_centered) {
                        if (nn->type == ROFFT_TEXT) {
                                len = term_strlen(p, nn->string);
-                               p->offset = len >= rm ? 0 :
-                                   lm + len >= rm ? rm - len :
-                                   (lm + rm - len) / 2;
+                               p->tcol->offset = len >= p->tcol->rmargin ?
+                                   0 : lm + len >= p->tcol->rmargin ?
+                                   p->tcol->rmargin - len :
+                                   (lm + p->tcol->rmargin - len) / 2;
                        } else
-                               p->offset = lm;
+                               p->tcol->offset = lm;
                }
                print_mdoc_node(p, pair, meta, nn);
                /*
@@ -1529,32 +1499,21 @@ termp_bd_pre(DECL_ARGS)
                term_flushln(p);
                p->flags |= TERMP_NOSPACE;
        }
-
-       p->rmargin = rm;
-       p->maxrmargin = rmax;
+       p->flags &= ~TERMP_BRNEVER;
        return 0;
 }
 
 static void
 termp_bd_post(DECL_ARGS)
 {
-       size_t           rm, rmax;
-
        if (n->type != ROFFT_BODY)
                return;
-
-       rm = p->rmargin;
-       rmax = p->maxrmargin;
-
        if (DISP_literal == n->norm->Bd.type ||
            DISP_unfilled == n->norm->Bd.type)
-               p->rmargin = p->maxrmargin = TERM_MAXMARGIN;
-
+               p->flags |= TERMP_BRNEVER;
        p->flags |= TERMP_NOSPACE;
        term_newln(p);
-
-       p->rmargin = rm;
-       p->maxrmargin = rmax;
+       p->flags &= ~TERMP_BRNEVER;
 }
 
 static int
@@ -1596,10 +1555,10 @@ termp_ss_pre(DECL_ARGS)
                break;
        case ROFFT_HEAD:
                term_fontpush(p, TERMFONT_BOLD);
-               p->offset = term_len(p, (p->defindent+1)/2);
+               p->tcol->offset = term_len(p, (p->defindent+1)/2);
                break;
        case ROFFT_BODY:
-               p->offset = term_len(p, p->defindent);
+               p->tcol->offset = term_len(p, p->defindent);
                term_tab_set(p, NULL);
                term_tab_set(p, "T");
                term_tab_set(p, ".5i");
@@ -1846,8 +1805,8 @@ termp_fo_pre(DECL_ARGS)
                return 1;
        } else if (n->type == ROFFT_BODY) {
                if (pretty) {
-                       rmargin = p->rmargin;
-                       p->rmargin = p->offset + term_len(p, 4);
+                       rmargin = p->tcol->rmargin;
+                       p->tcol->rmargin = p->tcol->offset + term_len(p, 4);
                        p->flags |= TERMP_NOBREAK | TERMP_BRIND |
                                        TERMP_HANG;
                }
@@ -1858,8 +1817,9 @@ termp_fo_pre(DECL_ARGS)
                        term_flushln(p);
                        p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND |
                                        TERMP_HANG);
-                       p->offset = p->rmargin;
-                       p->rmargin = rmargin;
+                       p->flags |= TERMP_NOPAD;
+                       p->tcol->offset = p->tcol->rmargin;
+                       p->tcol->rmargin = rmargin;
                }
                return 1;
        }
@@ -1977,16 +1937,24 @@ termp_li_pre(DECL_ARGS)
 static int
 termp_lk_pre(DECL_ARGS)
 {
-       const struct roff_node *link, *descr;
+       const struct roff_node *link, *descr, *punct;
        int display;
 
        if ((link = n->child) == NULL)
                return 0;
 
+       /* Find beginning of trailing punctuation. */
+       punct = n->last;
+       while (punct != link && punct->flags & NODE_DELIMC)
+               punct = punct->prev;
+       punct = punct->next;
+
        /* Link text. */
-       if ((descr = link->next) != NULL && !(descr->flags & NODE_DELIMC)) {
+       if ((descr = link->next) != NULL && descr != punct) {
                term_fontpush(p, TERMFONT_UNDER);
-               while (descr != NULL && !(descr->flags & NODE_DELIMC)) {
+               while (descr != punct) {
+                       if (descr->flags & (NODE_DELIMC | NODE_DELIMO))
+                               p->flags |= TERMP_NOSPACE;
                        term_word(p, descr->string);
                        descr = descr->next;
                }
@@ -1999,17 +1967,17 @@ termp_lk_pre(DECL_ARGS)
        display = term_strlen(p, link->string) >= 26;
        if (display) {
                term_newln(p);
-               p->offset += term_len(p, p->defindent + 1);
+               p->tcol->offset += term_len(p, p->defindent + 1);
        }
        term_fontpush(p, TERMFONT_BOLD);
        term_word(p, link->string);
        term_fontpop(p);
 
        /* Trailing punctuation. */
-       while (descr != NULL) {
+       while (punct != NULL) {
                p->flags |= TERMP_NOSPACE;
-               term_word(p, descr->string);
-               descr = descr->next;
+               term_word(p, punct->string);
+               punct = punct->next;
        }
        if (display)
                term_newln(p);