]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_term.c
bugfix: .Tg must be ignored completely in these output modes
[mandoc.git] / mdoc_term.c
index 471c52ca804d2a7d01fe1d39a516abb7382d865e..e50f5423e26c9f1f91f9d5eec8c8122a10bec711 100644 (file)
@@ -1,7 +1,7 @@
-/*     $Id: mdoc_term.c,v 1.363 2017/06/08 12:54:58 schwarze Exp $ */
+/*     $Id: mdoc_term.c,v 1.376 2020/01/20 10:37:15 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010, 2012-2017 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2010, 2012-2020 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2013 Franco Fichtner <franco@lastsummer.de>
  *
  * Permission to use, copy, modify, and distribute this software for any
@@ -29,7 +29,6 @@
 #include <string.h>
 
 #include "mandoc_aux.h"
-#include "mandoc.h"
 #include "roff.h"
 #include "mdoc.h"
 #include "out.h"
@@ -47,7 +46,7 @@ struct        termpair {
                  const struct roff_meta *meta, \
                  struct roff_node *n
 
-struct termact {
+struct mdoc_term_act {
        int     (*pre)(DECL_ARGS);
        void    (*post)(DECL_ARGS);
 };
@@ -84,6 +83,7 @@ static        void      termp_xx_post(DECL_ARGS);
 
 static int       termp__a_pre(DECL_ARGS);
 static int       termp__t_pre(DECL_ARGS);
+static int       termp_abort_pre(DECL_ARGS);
 static int       termp_an_pre(DECL_ARGS);
 static int       termp_ap_pre(DECL_ARGS);
 static int       termp_bd_pre(DECL_ARGS);
@@ -119,12 +119,13 @@ static    int       termp_pp_pre(DECL_ARGS);
 static int       termp_ss_pre(DECL_ARGS);
 static int       termp_sy_pre(DECL_ARGS);
 static int       termp_tag_pre(DECL_ARGS);
+static int       termp_tg_pre(DECL_ARGS);
 static int       termp_under_pre(DECL_ARGS);
 static int       termp_vt_pre(DECL_ARGS);
 static int       termp_xr_pre(DECL_ARGS);
 static int       termp_xx_pre(DECL_ARGS);
 
-static const struct termact __termacts[MDOC_MAX - MDOC_Dd] = {
+static const struct mdoc_term_act mdoc_term_acts[MDOC_MAX - MDOC_Dd] = {
        { NULL, NULL }, /* Dd */
        { NULL, NULL }, /* Dt */
        { NULL, NULL }, /* Os */
@@ -159,7 +160,7 @@ static      const struct termact __termacts[MDOC_MAX - MDOC_Dd] = {
        { termp_nd_pre, NULL }, /* Nd */
        { termp_nm_pre, termp_nm_post }, /* Nm */
        { termp_quote_pre, termp_quote_post }, /* Op */
-       { termp_ft_pre, NULL }, /* Ot */
+       { termp_abort_pre, NULL }, /* Ot */
        { termp_under_pre, NULL }, /* Pa */
        { termp_ex_pre, NULL }, /* Rv */
        { NULL, NULL }, /* St */
@@ -232,7 +233,7 @@ static      const struct termact __termacts[MDOC_MAX - MDOC_Dd] = {
        { termp_under_pre, NULL }, /* Fr */
        { NULL, NULL }, /* Ud */
        { NULL, termp_lb_post }, /* Lb */
-       { termp_pp_pre, NULL }, /* Lp */
+       { termp_abort_pre, NULL }, /* Lp */
        { termp_lk_pre, NULL }, /* Lk */
        { termp_under_pre, NULL }, /* Mt */
        { termp_quote_pre, termp_quote_post }, /* Brq */
@@ -245,16 +246,16 @@ static    const struct termact __termacts[MDOC_MAX - MDOC_Dd] = {
        { NULL, termp____post }, /* %Q */
        { NULL, termp____post }, /* %U */
        { NULL, NULL }, /* Ta */
+       { termp_tg_pre, NULL }, /* Tg */
 };
-static const struct termact *const termacts = __termacts - MDOC_Dd;
 
-static int      fn_prio;
+static int      fn_prio = TAG_STRONG;
 
 
 void
-terminal_mdoc(void *arg, const struct roff_man *mdoc)
+terminal_mdoc(void *arg, const struct roff_meta *mdoc)
 {
-       struct roff_node        *n;
+       struct roff_node        *n, *nn;
        struct termp            *p;
        size_t                   save_defindent;
 
@@ -266,29 +267,33 @@ terminal_mdoc(void *arg, const struct roff_man *mdoc)
 
        n = mdoc->first->child;
        if (p->synopsisonly) {
-               while (n != NULL) {
-                       if (n->tok == MDOC_Sh && n->sec == SEC_SYNOPSIS) {
-                               if (n->child->next->child != NULL)
-                                       print_mdoc_nodelist(p, NULL,
-                                           &mdoc->meta,
-                                           n->child->next->child);
-                               term_newln(p);
+               for (nn = NULL; n != NULL; n = n->next) {
+                       if (n->tok != MDOC_Sh)
+                               continue;
+                       if (n->sec == SEC_SYNOPSIS)
                                break;
-                       }
-                       n = n->next;
+                       if (nn == NULL && n->sec == SEC_NAME)
+                               nn = n;
                }
+               if (n == NULL)
+                       n = nn;
+               p->flags |= TERMP_NOSPACE;
+               if (n != NULL && (n = n->child->next->child) != NULL)
+                       print_mdoc_nodelist(p, NULL, mdoc, n);
+               term_newln(p);
        } else {
                save_defindent = p->defindent;
                if (p->defindent == 0)
                        p->defindent = 5;
-               term_begin(p, print_mdoc_head, print_mdoc_foot,
-                   &mdoc->meta);
-               while (n != NULL && n->flags & NODE_NOPRT)
+               term_begin(p, print_mdoc_head, print_mdoc_foot, mdoc);
+               while (n != NULL &&
+                   (n->type == ROFFT_COMMENT ||
+                    n->flags & NODE_NOPRT))
                        n = n->next;
                if (n != NULL) {
                        if (n->tok != MDOC_Sh)
                                term_vspace(p);
-                       print_mdoc_nodelist(p, NULL, &mdoc->meta, n);
+                       print_mdoc_nodelist(p, NULL, mdoc, n);
                }
                term_end(p);
                p->defindent = save_defindent;
@@ -308,11 +313,25 @@ print_mdoc_nodelist(DECL_ARGS)
 static void
 print_mdoc_node(DECL_ARGS)
 {
-       int              chld;
+       const struct mdoc_term_act *act;
        struct termpair  npair;
        size_t           offset, rmargin;
+       int              chld;
+
+       /*
+        * In no-fill mode, break the output line at the beginning
+        * of new input lines except after \c, and nowhere else.
+        */
+
+       if (n->flags & NODE_NOFILL) {
+               if (n->flags & NODE_LINE &&
+                   (p->flags & TERMP_NONEWLINE) == 0)
+                       term_newln(p);
+               p->flags |= TERMP_BRNEVER;
+       } else
+               p->flags &= ~TERMP_BRNEVER;
 
-       if (n->flags & NODE_NOPRT)
+       if (n->type == ROFFT_COMMENT || n->flags & NODE_NOPRT)
                return;
 
        chld = 1;
@@ -339,11 +358,25 @@ print_mdoc_node(DECL_ARGS)
         * produce output.  Note that some pre-handlers do so.
         */
 
+       act = NULL;
        switch (n->type) {
        case ROFFT_TEXT:
-               if (*n->string == ' ' && n->flags & NODE_LINE &&
-                   (p->flags & TERMP_NONEWLINE) == 0)
-                       term_newln(p);
+               if (n->flags & NODE_LINE) {
+                       switch (*n->string) {
+                       case '\0':
+                               if (p->flags & TERMP_NONEWLINE)
+                                       term_newln(p);
+                               else
+                                       term_vspace(p);
+                               return;
+                       case ' ':
+                               if ((p->flags & TERMP_NONEWLINE) == 0)
+                                       term_newln(p);
+                               break;
+                       default:
+                               break;
+                       }
+               }
                if (NODE_DELIMC & n->flags)
                        p->flags |= TERMP_NOSPACE;
                term_word(p, n->string);
@@ -368,10 +401,10 @@ print_mdoc_node(DECL_ARGS)
                        return;
                }
                assert(n->tok >= MDOC_Dd && n->tok < MDOC_MAX);
-               if (termacts[n->tok].pre != NULL &&
+               act = mdoc_term_acts + (n->tok - MDOC_Dd);
+               if (act->pre != NULL &&
                    (n->end == ENDBODY_NOT || n->child != NULL))
-                       chld = (*termacts[n->tok].pre)
-                               (p, &npair, meta, n);
+                       chld = (*act->pre)(p, &npair, meta, n);
                break;
        }
 
@@ -389,9 +422,9 @@ print_mdoc_node(DECL_ARGS)
        case ROFFT_EQN:
                break;
        default:
-               if (termacts[n->tok].post == NULL || n->flags & NODE_ENDED)
+               if (act->post == NULL || n->flags & NODE_ENDED)
                        break;
-               (void)(*termacts[n->tok].post)(p, &npair, meta, n);
+               (void)(*act->post)(p, &npair, meta, n);
 
                /*
                 * Explicit end tokens not only call the post
@@ -540,7 +573,7 @@ a2width(const struct termp *p, const char *v)
                SCALE_HS_INIT(&su, term_strlen(p, v));
                su.scale /= term_strlen(p, "0");
        }
-       return term_hspan(p, &su) / 24;
+       return term_hen(p, &su);
 }
 
 /*
@@ -567,7 +600,9 @@ print_bvspace(struct termp *p,
        /* Do not vspace directly after Ss/Sh. */
 
        nn = n;
-       while (nn->prev != NULL && nn->prev->flags & NODE_NOPRT)
+       while (nn->prev != NULL &&
+           (nn->prev->type == ROFFT_COMMENT ||
+            nn->prev->flags & NODE_NOPRT))
                nn = nn->prev;
        while (nn->prev == NULL) {
                do {
@@ -686,7 +721,7 @@ termp_it_pre(DECL_ARGS)
                        SCALE_HS_INIT(&su,
                            term_strlen(p, bl->norm->Bl.cols[i]));
                        su.scale /= term_strlen(p, "0");
-                       offset += term_hspan(p, &su) / 24 + dcol;
+                       offset += term_hen(p, &su) + dcol;
                }
 
                /*
@@ -704,7 +739,7 @@ termp_it_pre(DECL_ARGS)
                 */
                SCALE_HS_INIT(&su, term_strlen(p, bl->norm->Bl.cols[i]));
                su.scale /= term_strlen(p, "0");
-               width = term_hspan(p, &su) / 24 + dcol;
+               width = term_hen(p, &su) + dcol;
                break;
        default:
                if (NULL == bl->norm->Bl.width)
@@ -1259,7 +1294,7 @@ termp_sh_pre(DECL_ARGS)
                term_tab_set(p, ".5i");
                switch (n->sec) {
                case SEC_DESCRIPTION:
-                       fn_prio = 0;
+                       fn_prio = TAG_STRONG;
                        break;
                case SEC_AUTHORS:
                        p->flags &= ~(TERMP_SPLIT|TERMP_NOSPLIT);
@@ -1348,7 +1383,7 @@ termp_fn_pre(DECL_ARGS)
        term_fontpop(p);
 
        if (n->sec == SEC_DESCRIPTION || n->sec == SEC_CUSTOM)
-               tag_put(n->string, ++fn_prio, p->line);
+               tag_put(n->string, fn_prio++, p->line);
 
        if (pretty) {
                term_flushln(p);
@@ -1416,8 +1451,6 @@ termp_fa_pre(DECL_ARGS)
 static int
 termp_bd_pre(DECL_ARGS)
 {
-       size_t                   lm, len;
-       struct roff_node        *nn;
        int                      offset;
 
        if (n->type == ROFFT_BLOCK) {
@@ -1443,66 +1476,19 @@ termp_bd_pre(DECL_ARGS)
                        p->tcol->offset += offset;
        }
 
-       /*
-        * If -ragged or -filled are specified, the block does nothing
-        * but change the indentation.  If -unfilled or -literal are
-        * specified, text is printed exactly as entered in the display:
-        * for macro lines, a newline is appended to the line.  Blank
-        * lines are allowed.
-        */
-
-       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) {
+       switch (n->norm->Bd.type) {
+       case DISP_literal:
                term_tab_set(p, NULL);
                term_tab_set(p, "T");
                term_tab_set(p, "8n");
+               break;
+       case DISP_centered:
+               p->flags |= TERMP_CENTER;
+               break;
+       default:
+               break;
        }
-
-       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->tcol->offset = len >= p->tcol->rmargin ?
-                                   0 : lm + len >= p->tcol->rmargin ?
-                                   p->tcol->rmargin - len :
-                                   (lm + p->tcol->rmargin - len) / 2;
-                       } else
-                               p->tcol->offset = lm;
-               }
-               print_mdoc_node(p, pair, meta, nn);
-               /*
-                * If the printed node flushes its own line, then we
-                * needn't do it here as well.  This is hacky, but the
-                * notion of selective eoln whitespace is pretty dumb
-                * anyway, so don't sweat it.
-                */
-               if (nn->tok < ROFF_MAX)
-                       continue;
-               switch (nn->tok) {
-               case MDOC_Sm:
-               case MDOC_Bl:
-               case MDOC_D1:
-               case MDOC_Dl:
-               case MDOC_Lp:
-               case MDOC_Pp:
-                       continue;
-               default:
-                       break;
-               }
-               if (p->flags & TERMP_NONEWLINE ||
-                   (nn->next && ! (nn->next->flags & NODE_LINE)))
-                       continue;
-               term_flushln(p);
-               p->flags |= TERMP_NOSPACE;
-       }
-       p->flags &= ~TERMP_BRNEVER;
-       return 0;
+       return 1;
 }
 
 static void
@@ -1510,12 +1496,14 @@ termp_bd_post(DECL_ARGS)
 {
        if (n->type != ROFFT_BODY)
                return;
-       if (DISP_literal == n->norm->Bd.type ||
-           DISP_unfilled == n->norm->Bd.type)
+       if (n->norm->Bd.type == DISP_unfilled ||
+           n->norm->Bd.type == DISP_literal)
                p->flags |= TERMP_BRNEVER;
        p->flags |= TERMP_NOSPACE;
        term_newln(p);
        p->flags &= ~TERMP_BRNEVER;
+       if (n->norm->Bd.type == DISP_centered)
+               p->flags &= ~TERMP_CENTER;
 }
 
 static int
@@ -1550,7 +1538,8 @@ termp_ss_pre(DECL_ARGS)
        case ROFFT_BLOCK:
                term_newln(p);
                for (nn = n->prev; nn != NULL; nn = nn->prev)
-                       if ((nn->flags & NODE_NOPRT) == 0)
+                       if (nn->type != ROFFT_COMMENT &&
+                           (nn->flags & NODE_NOPRT) == 0)
                                break;
                if (nn != NULL)
                        term_vspace(p);
@@ -1625,7 +1614,7 @@ termp_in_post(DECL_ARGS)
 static int
 termp_pp_pre(DECL_ARGS)
 {
-       fn_prio = 0;
+       fn_prio = TAG_STRONG;
        term_vspace(p);
        return 0;
 }
@@ -1664,7 +1653,7 @@ termp_quote_pre(DECL_ARGS)
                /* FALLTHROUGH */
        case MDOC_Do:
        case MDOC_Dq:
-               term_word(p, "\\(Lq");
+               term_word(p, "\\(lq");
                break;
        case MDOC_En:
                if (NULL == n->norm->Es ||
@@ -1722,7 +1711,7 @@ termp_quote_post(DECL_ARGS)
                /* FALLTHROUGH */
        case MDOC_Do:
        case MDOC_Dq:
-               term_word(p, "\\(Rq");
+               term_word(p, "\\(rq");
                break;
        case MDOC_En:
                if (n->norm->Es == NULL ||
@@ -1940,7 +1929,6 @@ static int
 termp_lk_pre(DECL_ARGS)
 {
        const struct roff_node *link, *descr, *punct;
-       int display;
 
        if ((link = n->child) == NULL)
                return 0;
@@ -1966,11 +1954,6 @@ termp_lk_pre(DECL_ARGS)
        }
 
        /* Link target. */
-       display = term_strlen(p, link->string) >= 26;
-       if (display) {
-               term_newln(p);
-               p->tcol->offset += term_len(p, p->defindent + 1);
-       }
        term_fontpush(p, TERMFONT_BOLD);
        term_word(p, link->string);
        term_fontpop(p);
@@ -1981,8 +1964,6 @@ termp_lk_pre(DECL_ARGS)
                term_word(p, punct->string);
                punct = punct->next;
        }
-       if (display)
-               term_newln(p);
        return 0;
 }
 
@@ -2058,7 +2039,7 @@ termp_em_pre(DECL_ARGS)
 {
        if (n->child != NULL &&
            n->child->type == ROFFT_TEXT)
-               tag_put(n->child->string, 0, p->line);
+               tag_put(n->child->string, TAG_FALLBACK, p->line);
        term_fontpush(p, TERMFONT_UNDER);
        return 1;
 }
@@ -2068,7 +2049,7 @@ termp_sy_pre(DECL_ARGS)
 {
        if (n->child != NULL &&
            n->child->type == ROFFT_TEXT)
-               tag_put(n->child->string, 0, p->line);
+               tag_put(n->child->string, TAG_FALLBACK, p->line);
        term_fontpush(p, TERMFONT_BOLD);
        return 1;
 }
@@ -2081,7 +2062,7 @@ termp_er_pre(DECL_ARGS)
            (n->parent->tok == MDOC_It ||
             (n->parent->tok == MDOC_Bq &&
              n->parent->parent->parent->tok == MDOC_It)))
-               tag_put(n->child->string, 1, p->line);
+               tag_put(n->child->string, TAG_STRONG, p->line);
        return 1;
 }
 
@@ -2098,6 +2079,19 @@ termp_tag_pre(DECL_ARGS)
             (n->parent->tok == MDOC_Xo &&
              n->parent->parent->prev == NULL &&
              n->parent->parent->parent->tok == MDOC_It)))
-               tag_put(n->child->string, 1, p->line);
+               tag_put(n->child->string, TAG_STRONG, p->line);
        return 1;
 }
+
+static int
+termp_tg_pre(DECL_ARGS)
+{
+       tag_put(n->child->string, TAG_MANUAL, p->line);
+       return 0;
+}
+
+static int
+termp_abort_pre(DECL_ARGS)
+{
+       abort();
+}