]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_term.c
merge OpenBSD commit by jmc@:
[mandoc.git] / man_term.c
index c463d56f85264c2aa6acc86a7e26245bf6eb66a9..d289f2d12bfb5f3d6416a24e588cb4dd6b31eacf 100644 (file)
@@ -1,7 +1,7 @@
-/*     $Id: man_term.c,v 1.225 2018/12/31 11:01:37 schwarze Exp $ */
+/* $Id: man_term.c,v 1.236 2021/06/28 19:50:15 schwarze Exp $ */
 /*
+ * Copyright (c) 2010-2015, 2017-2020 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2010-2015, 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -14,6 +14,9 @@
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ *
+ * Plain text formatter for man(7), used by mandoc(1)
+ * for ASCII, UTF-8, PostScript, and PDF output.
  */
 #include "config.h"
 
 #include <string.h>
 
 #include "mandoc_aux.h"
+#include "mandoc.h"
 #include "roff.h"
 #include "man.h"
 #include "out.h"
 #include "term.h"
+#include "term_tag.h"
 #include "main.h"
 
 #define        MAXMARGINS        64 /* maximum number of indented scopes */
@@ -62,7 +67,7 @@ static        void              print_man_head(struct termp *,
 static void              print_man_foot(struct termp *,
                                const struct roff_meta *);
 static void              print_bvspace(struct termp *,
-                               const struct roff_node *, int);
+                               struct roff_node *, int);
 
 static int               pre_B(DECL_ARGS);
 static int               pre_DT(DECL_ARGS);
@@ -88,7 +93,6 @@ 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_SY(DECL_ARGS);
 static void              post_TP(DECL_ARGS);
 static void              post_UR(DECL_ARGS);
@@ -96,7 +100,7 @@ static       void              post_UR(DECL_ARGS);
 static const struct man_term_act man_term_acts[MAN_MAX - MAN_TH] = {
        { NULL, NULL, 0 }, /* TH */
        { pre_SH, post_SH, 0 }, /* SH */
-       { pre_SS, post_SS, 0 }, /* SS */
+       { pre_SS, post_SH, 0 }, /* SS */
        { pre_TP, post_TP, 0 }, /* TP */
        { pre_TP, post_TP, 0 }, /* TQ */
        { pre_abort, NULL, 0 }, /* LP */
@@ -145,9 +149,9 @@ man_term_act(enum roff_tok tok)
 void
 terminal_man(void *arg, const struct roff_meta *man)
 {
-       struct termp            *p;
-       struct roff_node        *n;
        struct mtermp            mt;
+       struct termp            *p;
+       struct roff_node        *n, *nc, *nn;
        size_t                   save_defindent;
 
        p = (struct termp *)arg;
@@ -159,25 +163,30 @@ terminal_man(void *arg, const struct roff_meta *man)
        term_tab_set(p, "T");
        term_tab_set(p, ".5i");
 
-       memset(&mt, 0, sizeof(struct mtermp));
+       memset(&mt, 0, sizeof(mt));
        mt.lmargin[mt.lmargincur] = term_len(p, p->defindent);
        mt.offset = term_len(p, p->defindent);
        mt.pardist = 1;
 
        n = man->first->child;
        if (p->synopsisonly) {
-               while (n != NULL) {
-                       if (n->tok == MAN_SH &&
-                           n->child->child->type == ROFFT_TEXT &&
-                           !strcmp(n->child->child->string, "SYNOPSIS")) {
-                               if (n->child->next->child != NULL)
-                                       print_man_nodelist(p, &mt,
-                                           n->child->next->child, man);
-                               term_newln(p);
+               for (nn = NULL; n != NULL; n = n->next) {
+                       if (n->tok != MAN_SH)
+                               continue;
+                       nc = n->child->child;
+                       if (nc->type != ROFFT_TEXT)
+                               continue;
+                       if (strcmp(nc->string, "SYNOPSIS") == 0)
                                break;
-                       }
-                       n = n->next;
+                       if (nn == NULL && strcmp(nc->string, "NAME") == 0)
+                               nn = n;
                }
+               if (n == NULL)
+                       n = nn;
+               p->flags |= TERMP_NOSPACE;
+               if (n != NULL && (n = n->child->next->child) != NULL)
+                       print_man_nodelist(p, &mt, n, man);
+               term_newln(p);
        } else {
                term_begin(p, print_man_head, print_man_foot, man);
                p->flags |= TERMP_NOSPACE;
@@ -197,19 +206,20 @@ terminal_man(void *arg, const struct roff_meta *man)
  * first, print it.
  */
 static void
-print_bvspace(struct termp *p, const struct roff_node *n, int pardist)
+print_bvspace(struct termp *p, struct roff_node *n, int pardist)
 {
-       int      i;
+       struct roff_node        *nch;
+       int                      i;
 
        term_newln(p);
 
-       if (n->body && n->body->child)
-               if (n->body->child->type == ROFFT_TBL)
-                       return;
+       if (n->body != NULL &&
+           (nch = roff_node_child(n->body)) != NULL &&
+           nch->type == ROFFT_TBL)
+               return;
 
-       if (n->parent->type == ROFFT_ROOT || n->parent->tok != MAN_RS)
-               if (NULL == n->prev)
-                       return;
+       if (n->parent->tok != MAN_RS && roff_node_prev(n) == NULL)
+               return;
 
        for (i = 0; i < pardist; i++)
                term_vspace(p);
@@ -225,14 +235,12 @@ pre_abort(DECL_ARGS)
 static int
 pre_ign(DECL_ARGS)
 {
-
        return 0;
 }
 
 static int
 pre_I(DECL_ARGS)
 {
-
        term_fontrepl(p, TERMFONT_UNDER);
        return 1;
 }
@@ -313,8 +321,8 @@ pre_alternate(DECL_ARGS)
                assert(nn->type == ROFFT_TEXT);
                term_word(p, nn->string);
                if (nn->flags & NODE_EOS)
-                       p->flags |= TERMP_SENTENCE;
-               if (nn->next)
+                       p->flags |= TERMP_SENTENCE;
+               if (nn->next != NULL)
                        p->flags |= TERMP_NOSPACE;
        }
        return 0;
@@ -323,7 +331,6 @@ pre_alternate(DECL_ARGS)
 static int
 pre_B(DECL_ARGS)
 {
-
        term_fontrepl(p, TERMFONT_BOLD);
        return 1;
 }
@@ -331,19 +338,17 @@ pre_B(DECL_ARGS)
 static int
 pre_OP(DECL_ARGS)
 {
-
        term_word(p, "[");
        p->flags |= TERMP_KEEP | TERMP_NOSPACE;
 
-       if (NULL != (n = n->child)) {
+       if ((n = n->child) != NULL) {
                term_fontrepl(p, TERMFONT_BOLD);
                term_word(p, n->string);
        }
-       if (NULL != n && NULL != n->next) {
+       if (n != NULL && n->next != NULL) {
                term_fontrepl(p, TERMFONT_UNDER);
                term_word(p, n->next->string);
        }
-
        term_fontrepl(p, TERMFONT_NONE);
        p->flags &= ~TERMP_KEEP;
        p->flags |= TERMP_NOSPACE;
@@ -369,9 +374,9 @@ pre_in(DECL_ARGS)
        cp = n->child->string;
        less = 0;
 
-       if ('-' == *cp)
+       if (*cp == '-')
                less = -1;
-       else if ('+' == *cp)
+       else if (*cp == '+')
                less = 1;
        else
                cp--;
@@ -413,13 +418,18 @@ pre_HP(DECL_ARGS)
        case ROFFT_BLOCK:
                print_bvspace(p, n, mt->pardist);
                return 1;
+       case ROFFT_HEAD:
+               return 0;
        case ROFFT_BODY:
                break;
        default:
-               return 0;
+               abort();
        }
 
-       if ((n->flags & NODE_NOFILL) == 0) {
+       if (n->child == NULL)
+               return 0;
+
+       if ((n->child->flags & NODE_NOFILL) == 0) {
                p->flags |= TERMP_NOBREAK | TERMP_BRIND;
                p->trailspace = 2;
        }
@@ -445,8 +455,10 @@ pre_HP(DECL_ARGS)
 static void
 post_HP(DECL_ARGS)
 {
-
        switch (n->type) {
+       case ROFFT_BLOCK:
+       case ROFFT_HEAD:
+               break;
        case ROFFT_BODY:
                term_newln(p);
 
@@ -466,25 +478,27 @@ post_HP(DECL_ARGS)
                p->tcol->rmargin = p->maxrmargin;
                break;
        default:
-               break;
+               abort();
        }
 }
 
 static int
 pre_PP(DECL_ARGS)
 {
-
        switch (n->type) {
        case ROFFT_BLOCK:
                mt->lmargin[mt->lmargincur] = term_len(p, p->defindent);
                print_bvspace(p, n, mt->pardist);
                break;
-       default:
+       case ROFFT_HEAD:
+               return 0;
+       case ROFFT_BODY:
                p->tcol->offset = mt->offset;
                break;
+       default:
+               abort();
        }
-
-       return n->type != ROFFT_HEAD;
+       return 1;
 }
 
 static int
@@ -495,18 +509,18 @@ pre_IP(DECL_ARGS)
        int                      len;
 
        switch (n->type) {
-       case ROFFT_BODY:
-               p->flags |= TERMP_NOSPACE;
-               break;
+       case ROFFT_BLOCK:
+               print_bvspace(p, n, mt->pardist);
+               return 1;
        case ROFFT_HEAD:
                p->flags |= TERMP_NOBREAK;
                p->trailspace = 1;
                break;
-       case ROFFT_BLOCK:
-               print_bvspace(p, n, mt->pardist);
-               /* FALLTHROUGH */
+       case ROFFT_BODY:
+               p->flags |= TERMP_NOSPACE;
+               break;
        default:
-               return 1;
+               abort();
        }
 
        /* Calculate the offset from the optional second argument. */
@@ -526,7 +540,7 @@ pre_IP(DECL_ARGS)
        case ROFFT_HEAD:
                p->tcol->offset = mt->offset;
                p->tcol->rmargin = mt->offset + len;
-               if (n->child)
+               if (n->child != NULL)
                        print_man_node(p, mt, n->child, meta);
                return 0;
        case ROFFT_BODY:
@@ -534,7 +548,7 @@ pre_IP(DECL_ARGS)
                p->tcol->rmargin = p->maxrmargin;
                break;
        default:
-               break;
+               abort();
        }
        return 1;
 }
@@ -543,6 +557,8 @@ static void
 post_IP(DECL_ARGS)
 {
        switch (n->type) {
+       case ROFFT_BLOCK:
+               break;
        case ROFFT_HEAD:
                term_flushln(p);
                p->flags &= ~TERMP_NOBREAK;
@@ -554,7 +570,7 @@ post_IP(DECL_ARGS)
                p->tcol->offset = mt->offset;
                break;
        default:
-               break;
+               abort();
        }
 }
 
@@ -566,6 +582,10 @@ pre_TP(DECL_ARGS)
        int                      len;
 
        switch (n->type) {
+       case ROFFT_BLOCK:
+               if (n->tok == MAN_TP)
+                       print_bvspace(p, n, mt->pardist);
+               return 1;
        case ROFFT_HEAD:
                p->flags |= TERMP_NOBREAK | TERMP_BRTRSP;
                p->trailspace = 1;
@@ -573,12 +593,8 @@ pre_TP(DECL_ARGS)
        case ROFFT_BODY:
                p->flags |= TERMP_NOSPACE;
                break;
-       case ROFFT_BLOCK:
-               if (n->tok == MAN_TP)
-                       print_bvspace(p, n, mt->pardist);
-               /* FALLTHROUGH */
        default:
-               return 1;
+               abort();
        }
 
        /* Calculate offset. */
@@ -602,10 +618,10 @@ pre_TP(DECL_ARGS)
 
                /* Don't print same-line elements. */
                nn = n->child;
-               while (NULL != nn && 0 == (NODE_LINE & nn->flags))
+               while (nn != NULL && (nn->flags & NODE_LINE) == 0)
                        nn = nn->next;
 
-               while (NULL != nn) {
+               while (nn != NULL) {
                        print_man_node(p, mt, nn, meta);
                        nn = nn->next;
                }
@@ -617,7 +633,7 @@ pre_TP(DECL_ARGS)
                p->flags &= ~(TERMP_NOBREAK | TERMP_BRTRSP);
                break;
        default:
-               break;
+               abort();
        }
        return 1;
 }
@@ -626,6 +642,8 @@ static void
 post_TP(DECL_ARGS)
 {
        switch (n->type) {
+       case ROFFT_BLOCK:
+               break;
        case ROFFT_HEAD:
                term_flushln(p);
                break;
@@ -634,7 +652,7 @@ post_TP(DECL_ARGS)
                p->tcol->offset = mt->offset;
                break;
        default:
-               break;
+               abort();
        }
 }
 
@@ -653,12 +671,8 @@ pre_SS(DECL_ARGS)
                 * and after an empty subsection.
                 */
 
-               do {
-                       n = n->prev;
-               } while (n != NULL && n->tok >= MAN_TH &&
-                   man_term_act(n->tok)->flags & MAN_NOTEXT);
-               if (n == NULL || n->type == ROFFT_COMMENT ||
-                   (n->tok == MAN_SS && n->body->child == NULL))
+               if ((n = roff_node_prev(n)) == NULL ||
+                   (n->tok == MAN_SS && roff_node_child(n->body) == NULL))
                        break;
 
                for (i = 0; i < mt->pardist; i++)
@@ -680,26 +694,9 @@ pre_SS(DECL_ARGS)
        default:
                break;
        }
-
        return 1;
 }
 
-static void
-post_SS(DECL_ARGS)
-{
-
-       switch (n->type) {
-       case ROFFT_HEAD:
-               term_newln(p);
-               break;
-       case ROFFT_BODY:
-               term_newln(p);
-               break;
-       default:
-               break;
-       }
-}
-
 static int
 pre_SH(DECL_ARGS)
 {
@@ -715,12 +712,8 @@ pre_SH(DECL_ARGS)
                 * and after an empty section.
                 */
 
-               do {
-                       n = n->prev;
-               } while (n != NULL && n->tok >= MAN_TH &&
-                   man_term_act(n->tok)->flags & MAN_NOTEXT);
-               if (n == NULL || n->type == ROFFT_COMMENT ||
-                   (n->tok == MAN_SH && n->body->child == NULL))
+               if ((n = roff_node_prev(n)) == NULL ||
+                   (n->tok == MAN_SH && roff_node_child(n->body) == NULL))
                        break;
 
                for (i = 0; i < mt->pardist; i++)
@@ -740,25 +733,23 @@ pre_SH(DECL_ARGS)
                p->flags &= ~(TERMP_NOBREAK | TERMP_BRIND);
                break;
        default:
-               break;
+               abort();
        }
-
        return 1;
 }
 
 static void
 post_SH(DECL_ARGS)
 {
-
        switch (n->type) {
-       case ROFFT_HEAD:
-               term_newln(p);
+       case ROFFT_BLOCK:
                break;
+       case ROFFT_HEAD:
        case ROFFT_BODY:
                term_newln(p);
                break;
        default:
-               break;
+               abort();
        }
 }
 
@@ -773,8 +764,10 @@ pre_RS(DECL_ARGS)
                return 1;
        case ROFFT_HEAD:
                return 0;
-       default:
+       case ROFFT_BODY:
                break;
+       default:
+               abort();
        }
 
        n = n->parent->head;
@@ -802,20 +795,18 @@ pre_RS(DECL_ARGS)
 static void
 post_RS(DECL_ARGS)
 {
-
        switch (n->type) {
        case ROFFT_BLOCK:
-               return;
        case ROFFT_HEAD:
                return;
-       default:
-               term_newln(p);
+       case ROFFT_BODY:
                break;
+       default:
+               abort();
        }
-
+       term_newln(p);
        mt->offset -= n->parent->head->aux;
        p->tcol->offset = mt->offset;
-
        if (--mt->lmarginsz < MAXMARGINS)
                mt->lmargincur = mt->lmarginsz;
 }
@@ -828,7 +819,7 @@ pre_SY(DECL_ARGS)
 
        switch (n->type) {
        case ROFFT_BLOCK:
-               if (n->prev == NULL || n->prev->tok != MAN_SY)
+               if ((nn = roff_node_prev(n)) == NULL || nn->tok != MAN_SY)
                        print_bvspace(p, n, mt->pardist);
                return 1;
        case ROFFT_HEAD:
@@ -845,7 +836,9 @@ pre_SY(DECL_ARGS)
        case ROFFT_HEAD:
                p->tcol->offset = mt->offset;
                p->tcol->rmargin = mt->offset + len;
-               p->flags |= TERMP_NOBREAK;
+               if (n->next->child == NULL ||
+                   (n->next->child->flags & NODE_NOFILL) == 0)
+                       p->flags |= TERMP_NOBREAK;
                term_fontrepl(p, TERMFONT_BOLD);
                break;
        case ROFFT_BODY:
@@ -864,6 +857,8 @@ static void
 post_SY(DECL_ARGS)
 {
        switch (n->type) {
+       case ROFFT_BLOCK:
+               break;
        case ROFFT_HEAD:
                term_flushln(p);
                p->flags &= ~TERMP_NOBREAK;
@@ -873,28 +868,26 @@ post_SY(DECL_ARGS)
                p->tcol->offset = mt->offset;
                break;
        default:
-               break;
+               abort();
        }
 }
 
 static int
 pre_UR(DECL_ARGS)
 {
-
        return n->type != ROFFT_HEAD;
 }
 
 static void
 post_UR(DECL_ARGS)
 {
-
        if (n->type != ROFFT_BLOCK)
                return;
 
        term_word(p, "<");
        p->flags |= TERMP_NOSPACE;
 
-       if (NULL != n->child->child)
+       if (n->child->child != NULL)
                print_man_node(p, mt, n->child->child, meta);
 
        p->flags |= TERMP_NOSPACE;
@@ -907,6 +900,9 @@ print_man_node(DECL_ARGS)
        const struct man_term_act *act;
        int c;
 
+       if (n->flags & NODE_ID)
+               term_tag_write(n, p->line);
+
        switch (n->type) {
        case ROFFT_TEXT:
                /*
@@ -959,7 +955,7 @@ print_man_node(DECL_ARGS)
        if (act->pre != NULL)
                c = (*act->pre)(p, mt, n, meta);
 
-       if (c && n->child)
+       if (c && n->child != NULL)
                print_man_nodelist(p, mt, n->child, meta);
 
        if (act->post != NULL)
@@ -990,15 +986,13 @@ out:
                        p->tcol->rmargin = p->maxrmargin;
                }
        }
-       if (NODE_EOS & n->flags)
+       if (n->flags & NODE_EOS)
                p->flags |= TERMP_SENTENCE;
 }
 
-
 static void
 print_man_nodelist(DECL_ARGS)
 {
-
        while (n != NULL) {
                print_man_node(p, mt, n, meta);
                n = n->next;
@@ -1027,13 +1021,9 @@ print_man_foot(struct termp *p, const struct roff_meta *meta)
         */
 
        if ( ! p->mdocstyle) {
-               if (meta->hasbody) {
-                       term_vspace(p);
-                       term_vspace(p);
-               }
                mandoc_asprintf(&title, "%s(%s)",
                    meta->title, meta->msec);
-       } else if (meta->os) {
+       } else if (meta->os != NULL) {
                title = mandoc_strdup(meta->os);
        } else {
                title = mandoc_strdup("");
@@ -1149,9 +1139,5 @@ print_man_head(struct termp *p, const struct roff_meta *meta)
         */
 
        term_vspace(p);
-       if ( ! p->mdocstyle) {
-               term_vspace(p);
-               term_vspace(p);
-       }
        free(title);
 }