]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_man.c
If the layout or data of an individual cell in a tbl(7) contains
[mandoc.git] / mdoc_man.c
index cf552ce902bbae42347a6ff07103a3f20dc3be1b..0964cc6160a1725cf006b05e48b6ce92328933c3 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_man.c,v 1.122 2017/06/14 22:51:25 schwarze Exp $ */
+/*     $Id: mdoc_man.c,v 1.137 2021/07/04 15:38:26 schwarze Exp $ */
 /*
- * Copyright (c) 2011-2017 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011-2021 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
@@ -36,7 +36,7 @@
 typedef        int     (*int_fp)(DECL_ARGS);
 typedef        void    (*void_fp)(DECL_ARGS);
 
-struct manact {
+struct mdoc_man_act {
        int_fp            cond; /* DON'T run actions */
        int_fp            pre; /* pre-node action */
        void_fp           post; /* post-node action */
@@ -75,6 +75,7 @@ static        void      post_pf(DECL_ARGS);
 static void      post_sect(DECL_ARGS);
 static void      post_vt(DECL_ARGS);
 static int       pre__t(DECL_ARGS);
+static int       pre_abort(DECL_ARGS);
 static int       pre_an(DECL_ARGS);
 static int       pre_ap(DECL_ARGS);
 static int       pre_aq(DECL_ARGS);
@@ -103,6 +104,7 @@ static      int       pre_lk(DECL_ARGS);
 static int       pre_li(DECL_ARGS);
 static int       pre_nm(DECL_ARGS);
 static int       pre_no(DECL_ARGS);
+static void      pre_noarg(DECL_ARGS);
 static int       pre_ns(DECL_ARGS);
 static void      pre_onearg(DECL_ARGS);
 static int       pre_pp(DECL_ARGS);
@@ -111,7 +113,7 @@ static      int       pre_sm(DECL_ARGS);
 static void      pre_sp(DECL_ARGS);
 static int       pre_sect(DECL_ARGS);
 static int       pre_sy(DECL_ARGS);
-static void      pre_syn(const struct roff_node *);
+static void      pre_syn(struct roff_node *);
 static void      pre_ta(DECL_ARGS);
 static int       pre_vt(DECL_ARGS);
 static int       pre_xr(DECL_ARGS);
@@ -124,12 +126,14 @@ static    void      print_width(const struct mdoc_bl *,
 static void      print_count(int *);
 static void      print_node(DECL_ARGS);
 
-static const void_fp roff_manacts[ROFF_MAX] = {
+static const void_fp roff_man_acts[ROFF_MAX] = {
        pre_br,         /* br */
        pre_onearg,     /* ce */
+       pre_noarg,      /* fi */
        pre_ft,         /* ft */
        pre_onearg,     /* ll */
        pre_onearg,     /* mc */
+       pre_noarg,      /* nf */
        pre_onearg,     /* po */
        pre_onearg,     /* rj */
        pre_sp,         /* sp */
@@ -137,7 +141,7 @@ static      const void_fp roff_manacts[ROFF_MAX] = {
        pre_onearg,     /* ti */
 };
 
-static const struct manact __manacts[MDOC_MAX - MDOC_Dd] = {
+static const struct mdoc_man_act mdoc_man_acts[MDOC_MAX - MDOC_Dd] = {
        { NULL, NULL, NULL, NULL, NULL }, /* Dd */
        { NULL, NULL, NULL, NULL, NULL }, /* Dt */
        { NULL, NULL, NULL, NULL, NULL }, /* Os */
@@ -172,7 +176,7 @@ static      const struct manact __manacts[MDOC_MAX - MDOC_Dd] = {
        { cond_head, pre_enc, NULL, "\\- ", NULL }, /* Nd */
        { NULL, pre_nm, post_nm, NULL, NULL }, /* Nm */
        { cond_body, pre_enc, post_enc, "[", "]" }, /* Op */
-       { NULL, pre_Ft, post_font, NULL, NULL }, /* Ot */
+       { NULL, pre_abort, NULL, NULL, NULL }, /* Ot */
        { NULL, pre_em, post_font, NULL, NULL }, /* Pa */
        { NULL, pre_ex, NULL, NULL, NULL }, /* Rv */
        { NULL, NULL, NULL, NULL, NULL }, /* St */
@@ -202,8 +206,8 @@ static      const struct manact __manacts[MDOC_MAX - MDOC_Dd] = {
        { NULL, pre_bk, post_bk, NULL, NULL }, /* Bx */
        { NULL, pre_skip, NULL, NULL, NULL }, /* Db */
        { NULL, NULL, NULL, NULL, NULL }, /* Dc */
-       { cond_body, pre_enc, post_enc, "\\(Lq", "\\(Rq" }, /* Do */
-       { cond_body, pre_enc, post_enc, "\\(Lq", "\\(Rq" }, /* Dq */
+       { cond_body, pre_enc, post_enc, "\\(lq", "\\(rq" }, /* Do */
+       { cond_body, pre_enc, post_enc, "\\(lq", "\\(rq" }, /* Dq */
        { NULL, NULL, NULL, NULL, NULL }, /* Ec */
        { NULL, NULL, NULL, NULL, NULL }, /* Ef */
        { NULL, pre_em, post_font, NULL, NULL }, /* Em */
@@ -245,7 +249,7 @@ static      const struct manact __manacts[MDOC_MAX - MDOC_Dd] = {
        { NULL, pre_em, post_font, NULL, NULL }, /* Fr */
        { NULL, NULL, NULL, NULL, NULL }, /* Ud */
        { NULL, NULL, post_lb, NULL, NULL }, /* Lb */
-       { NULL, pre_pp, NULL, NULL, NULL }, /* Lp */
+       { NULL, pre_abort, NULL, NULL, NULL }, /* Lp */
        { NULL, pre_lk, NULL, NULL, NULL }, /* Lk */
        { NULL, pre_em, post_font, NULL, NULL }, /* Mt */
        { cond_body, pre_enc, post_enc, "{", "}" }, /* Brq */
@@ -258,8 +262,9 @@ static      const struct manact __manacts[MDOC_MAX - MDOC_Dd] = {
        { NULL, NULL, post_percent, NULL, NULL }, /* %Q */
        { NULL, NULL, post_percent, NULL, NULL }, /* %U */
        { NULL, NULL, NULL, NULL, NULL }, /* Ta */
+       { NULL, pre_skip, NULL, NULL, NULL }, /* Tg */
 };
-static const struct manact *const manacts = __manacts - MDOC_Dd;
+static const struct mdoc_man_act *mdoc_man_act(enum roff_tok);
 
 static int             outflags;
 #define        MMAN_spc        (1 << 0)  /* blank character before next word */
@@ -290,6 +295,13 @@ static     struct {
 }      fontqueue;
 
 
+static const struct mdoc_man_act *
+mdoc_man_act(enum roff_tok tok)
+{
+       assert(tok >= MDOC_Dd && tok <= MDOC_MAX);
+       return mdoc_man_acts + (tok - MDOC_Dd);
+}
+
 static int
 man_strlen(const char *cp)
 {
@@ -317,6 +329,7 @@ man_strlen(const char *cp)
                case ESCAPE_UNICODE:
                case ESCAPE_NUMBERED:
                case ESCAPE_SPECIAL:
+               case ESCAPE_UNDEF:
                case ESCAPE_OVERSTRIKE:
                        if (skip)
                                skip = 0;
@@ -570,9 +583,9 @@ print_width(const struct mdoc_bl *bl, const struct roff_node *child)
 
        /* Set up the current list. */
        if (chsz > sz && bl->type != LIST_tag)
-               print_block(".HP", 0);
+               print_block(".HP", MMAN_spc);
        else {
-               print_block(".TP", 0);
+               print_block(".TP", MMAN_spc);
                remain = sz + 2;
        }
        if (numeric) {
@@ -593,27 +606,21 @@ print_count(int *count)
 }
 
 void
-man_man(void *arg, const struct roff_man *man)
-{
-
-       /*
-        * Dump the keep buffer.
-        * We're guaranteed by now that this exists (is non-NULL).
-        * Flush stdout afterward, just in case.
-        */
-       fputs(mparse_getkeep(man_mparse(man)), stdout);
-       fflush(stdout);
-}
-
-void
-man_mdoc(void *arg, const struct roff_man *mdoc)
+man_mdoc(void *arg, const struct roff_meta *mdoc)
 {
        struct roff_node *n;
 
+       printf(".\\\" Automatically generated from an mdoc input file."
+           "  Do not edit.\n");
+       for (n = mdoc->first->child; n != NULL; n = n->next) {
+               if (n->type != ROFFT_COMMENT)
+                       break;
+               printf(".\\\"%s\n", n->string);
+       }
+
        printf(".TH \"%s\" \"%s\" \"%s\" \"%s\" \"%s\"\n",
-           mdoc->meta.title,
-           (mdoc->meta.msec == NULL ? "" : mdoc->meta.msec),
-           mdoc->meta.date, mdoc->meta.os, mdoc->meta.vol);
+           mdoc->title, (mdoc->msec == NULL ? "" : mdoc->msec),
+           mdoc->date, mdoc->os, mdoc->vol);
 
        /* Disable hyphenation and if nroff, disable justification. */
        printf(".nh\n.if n .ad l");
@@ -624,17 +631,17 @@ man_mdoc(void *arg, const struct roff_man *mdoc)
                fontqueue.head = fontqueue.tail = mandoc_malloc(8);
                *fontqueue.tail = 'R';
        }
-       for (n = mdoc->first->child; n != NULL; n = n->next)
-               print_node(&mdoc->meta, n);
+       for (; n != NULL; n = n->next)
+               print_node(mdoc, n);
        putchar('\n');
 }
 
 static void
 print_node(DECL_ARGS)
 {
-       const struct manact     *act;
-       struct roff_node        *sub;
-       int                      cond, do_sub;
+       const struct mdoc_man_act       *act;
+       struct roff_node                *sub;
+       int                              cond, do_sub;
 
        if (n->flags & NODE_NOPRT)
                return;
@@ -643,7 +650,9 @@ print_node(DECL_ARGS)
         * Break the line if we were parsed subsequent the current node.
         * This makes the page structure be more consistent.
         */
-       if (MMAN_spc & outflags && NODE_LINE & n->flags)
+       if (outflags & MMAN_spc &&
+           n->flags & NODE_LINE &&
+           !roff_node_transparent(n))
                outflags |= MMAN_nl;
 
        act = NULL;
@@ -651,7 +660,20 @@ print_node(DECL_ARGS)
        do_sub = 1;
        n->flags &= ~NODE_ENDED;
 
-       if (n->type == ROFFT_TEXT) {
+       switch (n->type) {
+       case ROFFT_EQN:
+       case ROFFT_TBL:
+               mandoc_msg(n->type == ROFFT_EQN ? MANDOCERR_EQN_TMAN :
+                   MANDOCERR_TBL_TMAN, n->line, n->pos, NULL);
+               outflags |= MMAN_PP | MMAN_sp | MMAN_nl;
+               print_word("The");
+               print_line(".B \\-T man", MMAN_nl);
+               print_word("output mode does not support");
+               print_word(n->type == ROFFT_EQN ? "eqn(7)" : "tbl(7)");
+               print_word("input.");
+               outflags |= MMAN_PP | MMAN_sp | MMAN_nl;
+               return;
+       case ROFFT_TEXT:
                /*
                 * Make sure that we don't happen to start with a
                 * control character at the start of a line.
@@ -671,20 +693,18 @@ print_node(DECL_ARGS)
                        outflags &= ~(MMAN_spc | MMAN_spc_force);
                else if (outflags & MMAN_Sm)
                        outflags |= MMAN_spc;
-       } else if (n->tok < ROFF_MAX) {
-               (*roff_manacts[n->tok])(meta, n);
-               return;
-       } else {
-               assert(n->tok >= MDOC_Dd && n->tok < MDOC_MAX);
-               /*
-                * Conditionally run the pre-node action handler for a
-                * node.
-                */
-               act = manacts + n->tok;
+               break;
+       default:
+               if (n->tok < ROFF_MAX) {
+                       (*roff_man_acts[n->tok])(meta, n);
+                       return;
+               }
+               act = mdoc_man_act(n->tok);
                cond = act->cond == NULL || (*act->cond)(meta, n);
                if (cond && act->pre != NULL &&
                    (n->end == ENDBODY_NOT || n->child != NULL))
                        do_sub = (*act->pre)(meta, n);
+               break;
        }
 
        /*
@@ -723,12 +743,18 @@ cond_body(DECL_ARGS)
        return n->type == ROFFT_BODY;
 }
 
+static int
+pre_abort(DECL_ARGS)
+{
+       abort();
+}
+
 static int
 pre_enc(DECL_ARGS)
 {
        const char      *prefix;
 
-       prefix = manacts[n->tok].prefix;
+       prefix = mdoc_man_act(n->tok)->prefix;
        if (NULL == prefix)
                return 1;
        print_word(prefix);
@@ -741,7 +767,7 @@ post_enc(DECL_ARGS)
 {
        const char *suffix;
 
-       suffix = manacts[n->tok].suffix;
+       suffix = mdoc_man_act(n->tok)->suffix;
        if (NULL == suffix)
                return;
        outflags &= ~(MMAN_spc | MMAN_nl);
@@ -765,13 +791,20 @@ post_font(DECL_ARGS)
 static void
 post_percent(DECL_ARGS)
 {
+       struct roff_node *np, *nn, *nnn;
 
-       if (pre_em == manacts[n->tok].pre)
+       if (mdoc_man_act(n->tok)->pre == pre_em)
                font_pop();
-       if (n->next) {
-               print_word(",");
-               if (n->prev &&  n->prev->tok == n->tok &&
-                               n->next->tok == n->tok)
+
+       if ((nn = roff_node_next(n)) != NULL) {
+               np = roff_node_prev(n);
+               nnn = nn == NULL ? NULL : roff_node_next(nn);
+               if (nn->tok != n->tok ||
+                   (np != NULL && np->tok == n->tok) ||
+                   (nnn != NULL && nnn->tok == n->tok))
+                       print_word(",");
+               if (nn->tok == n->tok &&
+                   (nnn == NULL || nnn->tok != n->tok))
                        print_word("and");
        } else {
                print_word(".");
@@ -812,7 +845,7 @@ pre_sect(DECL_ARGS)
 
        if (n->type == ROFFT_HEAD) {
                outflags |= MMAN_sp;
-               print_block(manacts[n->tok].prefix, 0);
+               print_block(mdoc_man_act(n->tok)->prefix, 0);
                print_word("");
                putchar('\"');
                outflags &= ~MMAN_spc;
@@ -839,13 +872,15 @@ post_sect(DECL_ARGS)
 
 /* See mdoc_term.c, synopsis_pre() for comments. */
 static void
-pre_syn(const struct roff_node *n)
+pre_syn(struct roff_node *n)
 {
+       struct roff_node *np;
 
-       if (NULL == n->prev || ! (NODE_SYNPRETTY & n->flags))
+       if ((n->flags & NODE_SYNPRETTY) == 0 ||
+           (np = roff_node_prev(n)) == NULL)
                return;
 
-       if (n->prev->tok == n->tok &&
+       if (np->tok == n->tok &&
            MDOC_Ft != n->tok &&
            MDOC_Fo != n->tok &&
            MDOC_Fn != n->tok) {
@@ -853,7 +888,7 @@ pre_syn(const struct roff_node *n)
                return;
        }
 
-       switch (n->prev->tok) {
+       switch (np->tok) {
        case MDOC_Fd:
        case MDOC_Fn:
        case MDOC_Fo:
@@ -928,13 +963,11 @@ post_aq(DECL_ARGS)
 static int
 pre_bd(DECL_ARGS)
 {
-
        outflags &= ~(MMAN_PP | MMAN_sp | MMAN_br);
-
-       if (DISP_unfilled == n->norm->Bd.type ||
-           DISP_literal  == n->norm->Bd.type)
+       if (n->norm->Bd.type == DISP_unfilled ||
+           n->norm->Bd.type == DISP_literal)
                print_line(".nf", 0);
-       if (0 == n->norm->Bd.comp && NULL != n->parent->prev)
+       if (n->norm->Bd.comp == 0 && roff_node_prev(n->parent) != NULL)
                outflags |= MMAN_sp;
        print_offs(n->norm->Bd.offs, 1);
        return 1;
@@ -943,15 +976,30 @@ pre_bd(DECL_ARGS)
 static void
 post_bd(DECL_ARGS)
 {
+       enum roff_tok    bef, now;
 
        /* Close out this display. */
        print_line(".RE", MMAN_nl);
-       if (DISP_unfilled == n->norm->Bd.type ||
-           DISP_literal  == n->norm->Bd.type)
-               print_line(".fi", MMAN_nl);
+       bef = n->flags & NODE_NOFILL ? ROFF_nf : ROFF_fi;
+       if (n->last == NULL)
+               now = n->norm->Bd.type == DISP_unfilled ||
+                   n->norm->Bd.type == DISP_literal ? ROFF_nf : ROFF_fi;
+       else if (n->last->tok == ROFF_nf)
+               now = ROFF_nf;
+       else if (n->last->tok == ROFF_fi)
+               now = ROFF_fi;
+       else
+               now = n->last->flags & NODE_NOFILL ? ROFF_nf : ROFF_fi;
+       if (bef != now) {
+               outflags |= MMAN_nl;
+               print_word(".");
+               outflags &= ~MMAN_spc;
+               print_word(roff_name[bef]);
+               outflags |= MMAN_nl;
+       }
 
        /* Maybe we are inside an enclosing list? */
-       if (NULL != n->parent->next)
+       if (roff_node_next(n->parent) != NULL)
                mid_it();
 }
 
@@ -1076,16 +1124,15 @@ post_bl(DECL_ARGS)
                print_line(".RE", MMAN_nl);
                assert(Bl_stack_len);
                Bl_stack_len--;
-               assert(0 == Bl_stack[Bl_stack_len]);
+               assert(Bl_stack[Bl_stack_len] == 0);
        } else {
                outflags |= MMAN_PP | MMAN_nl;
                outflags &= ~(MMAN_sp | MMAN_br);
        }
 
        /* Maybe we are inside an enclosing list? */
-       if (NULL != n->parent->next)
+       if (roff_node_next(n->parent) != NULL)
                mid_it();
-
 }
 
 static void
@@ -1097,7 +1144,6 @@ pre_br(DECL_ARGS)
 static int
 pre_dl(DECL_ARGS)
 {
-
        print_offs("6n", 0);
        return 1;
 }
@@ -1105,11 +1151,10 @@ pre_dl(DECL_ARGS)
 static void
 post_dl(DECL_ARGS)
 {
-
        print_line(".RE", MMAN_nl);
 
        /* Maybe we are inside an enclosing list? */
-       if (NULL != n->parent->next)
+       if (roff_node_next(n->parent) != NULL)
                mid_it();
 }
 
@@ -1210,15 +1255,15 @@ pre_fa(DECL_ARGS)
 static void
 post_fa(DECL_ARGS)
 {
+       struct roff_node *nn;
 
-       if (NULL != n->next && MDOC_Fa == n->next->tok)
+       if ((nn = roff_node_next(n)) != NULL && nn->tok == MDOC_Fa)
                print_word(",");
 }
 
 static int
 pre_fd(DECL_ARGS)
 {
-
        pre_syn(n);
        font_push('B');
        return 1;
@@ -1227,7 +1272,6 @@ pre_fd(DECL_ARGS)
 static void
 post_fd(DECL_ARGS)
 {
-
        font_pop();
        outflags |= MMAN_br;
 }
@@ -1235,7 +1279,6 @@ post_fd(DECL_ARGS)
 static int
 pre_fl(DECL_ARGS)
 {
-
        font_push('B');
        print_word("\\-");
        if (n->child != NULL)
@@ -1246,12 +1289,13 @@ pre_fl(DECL_ARGS)
 static void
 post_fl(DECL_ARGS)
 {
+       struct roff_node *nn;
 
        font_pop();
-       if (!(n->child != NULL ||
-           n->next == NULL ||
-           n->next->type == ROFFT_TEXT ||
-           n->next->flags & NODE_LINE))
+       if (n->child == NULL &&
+           ((nn = roff_node_next(n)) != NULL &&
+           nn->type != ROFFT_TEXT &&
+           (nn->flags & NODE_LINE) == 0))
                outflags &= ~MMAN_spc;
 }
 
@@ -1394,9 +1438,9 @@ pre_it(DECL_ARGS)
        case ROFFT_HEAD:
                outflags |= MMAN_PP | MMAN_nl;
                bln = n->parent->parent;
-               if (0 == bln->norm->Bl.comp ||
-                   (NULL == n->parent->prev &&
-                    NULL == bln->parent->prev))
+               if (bln->norm->Bl.comp == 0 ||
+                   (n->parent->prev == NULL &&
+                    roff_node_prev(bln->parent) == NULL))
                        outflags |= MMAN_sp;
                outflags &= ~MMAN_br;
                switch (bln->norm->Bl.type) {
@@ -1408,7 +1452,7 @@ pre_it(DECL_ARGS)
                        if (bln->norm->Bl.type == LIST_diag)
                                print_line(".B \"", 0);
                        else
-                               print_line(".R \"", 0);
+                               print_line(".BR \\& \"", 0);
                        outflags &= ~MMAN_spc;
                        return 1;
                case LIST_bullet:
@@ -1547,7 +1591,6 @@ static int
 pre_lk(DECL_ARGS)
 {
        const struct roff_node *link, *descr, *punct;
-       int display;
 
        if ((link = n->child) == NULL)
                return 0;
@@ -1570,12 +1613,6 @@ pre_lk(DECL_ARGS)
        }
 
        /* Link target. */
-       display = man_strlen(link->string) >= 26;
-       if (display) {
-               print_line(".RS", MMAN_Bk_susp);
-               print_word("6n");
-               outflags |= MMAN_nl;
-       }
        font_push('B');
        print_word(link->string);
        font_pop();
@@ -1585,8 +1622,6 @@ pre_lk(DECL_ARGS)
                print_word(punct->string);
                punct = punct->next;
        }
-       if (display)
-               print_line(".RE", MMAN_nl);
        return 0;
 }
 
@@ -1608,7 +1643,6 @@ pre_onearg(DECL_ARGS)
 static int
 pre_li(DECL_ARGS)
 {
-
        font_push('R');
        return 1;
 }
@@ -1618,17 +1652,22 @@ pre_nm(DECL_ARGS)
 {
        char    *name;
 
-       if (n->type == ROFFT_BLOCK) {
+       switch (n->type) {
+       case ROFFT_BLOCK:
                outflags |= MMAN_Bk;
                pre_syn(n);
-       }
-       if (n->type != ROFFT_ELEM && n->type != ROFFT_HEAD)
                return 1;
+       case ROFFT_HEAD:
+       case ROFFT_ELEM:
+               break;
+       default:
+               return 1;
+       }
        name = n->child == NULL ? NULL : n->child->string;
-       if (NULL == name)
+       if (name == NULL)
                return 0;
        if (n->type == ROFFT_HEAD) {
-               if (NULL == n->parent->prev)
+               if (roff_node_prev(n->parent) == NULL)
                        outflags |= MMAN_sp;
                print_block(".HP", 0);
                printf(" %dn", man_strlen(name) + 1);
@@ -1641,7 +1680,6 @@ pre_nm(DECL_ARGS)
 static void
 post_nm(DECL_ARGS)
 {
-
        switch (n->type) {
        case ROFFT_BLOCK:
                outflags &= ~MMAN_Bk;
@@ -1659,15 +1697,23 @@ post_nm(DECL_ARGS)
 static int
 pre_no(DECL_ARGS)
 {
-
        outflags |= MMAN_spc_force;
        return 1;
 }
 
+static void
+pre_noarg(DECL_ARGS)
+{
+       outflags |= MMAN_nl;
+       print_word(".");
+       outflags &= ~MMAN_spc;
+       print_word(roff_name[n->tok]);
+       outflags |= MMAN_nl;
+}
+
 static int
 pre_ns(DECL_ARGS)
 {
-
        outflags &= ~MMAN_spc;
        return 0;
 }