]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_man.c
Do not allocate a column for decimal points if all numbers are integers.
[mandoc.git] / mdoc_man.c
index 38fb57e6ea52249176f700bfeee7cb437f236adb..17711700c2db1c70c16589ff71203182f09f826e 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_man.c,v 1.110 2017/05/04 17:48:29 schwarze Exp $ */
+/*     $Id: mdoc_man.c,v 1.127 2018/08/17 20:33:37 schwarze Exp $ */
 /*
- * Copyright (c) 2011-2017 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011-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
 
 #define        DECL_ARGS const struct roff_meta *meta, struct roff_node *n
 
-struct manact {
-       int             (*cond)(DECL_ARGS); /* DON'T run actions */
-       int             (*pre)(DECL_ARGS); /* pre-node action */
-       void            (*post)(DECL_ARGS); /* post-node action */
+typedef        int     (*int_fp)(DECL_ARGS);
+typedef        void    (*void_fp)(DECL_ARGS);
+
+struct mdoc_man_act {
+       int_fp            cond; /* DON'T run actions */
+       int_fp            pre; /* pre-node action */
+       void_fp           post; /* post-node action */
        const char       *prefix; /* pre-node string constant */
        const char       *suffix; /* post-node string constant */
 };
@@ -70,7 +73,6 @@ static        void      post_nm(DECL_ARGS);
 static void      post_percent(DECL_ARGS);
 static void      post_pf(DECL_ARGS);
 static void      post_sect(DECL_ARGS);
-static void      post_sp(DECL_ARGS);
 static void      post_vt(DECL_ARGS);
 static int       pre__t(DECL_ARGS);
 static int       pre_an(DECL_ARGS);
@@ -80,7 +82,7 @@ static        int       pre_bd(DECL_ARGS);
 static int       pre_bf(DECL_ARGS);
 static int       pre_bk(DECL_ARGS);
 static int       pre_bl(DECL_ARGS);
-static int       pre_br(DECL_ARGS);
+static void      pre_br(DECL_ARGS);
 static int       pre_dl(DECL_ARGS);
 static int       pre_en(DECL_ARGS);
 static int       pre_enc(DECL_ARGS);
@@ -93,22 +95,24 @@ static      int       pre_fd(DECL_ARGS);
 static int       pre_fl(DECL_ARGS);
 static int       pre_fn(DECL_ARGS);
 static int       pre_fo(DECL_ARGS);
-static int       pre_ft(DECL_ARGS);
+static void      pre_ft(DECL_ARGS);
+static int       pre_Ft(DECL_ARGS);
 static int       pre_in(DECL_ARGS);
 static int       pre_it(DECL_ARGS);
 static int       pre_lk(DECL_ARGS);
 static int       pre_li(DECL_ARGS);
-static int       pre_ll(DECL_ARGS);
 static int       pre_nm(DECL_ARGS);
 static int       pre_no(DECL_ARGS);
 static int       pre_ns(DECL_ARGS);
+static void      pre_onearg(DECL_ARGS);
 static int       pre_pp(DECL_ARGS);
 static int       pre_rs(DECL_ARGS);
 static int       pre_sm(DECL_ARGS);
-static int       pre_sp(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_ta(DECL_ARGS);
 static int       pre_vt(DECL_ARGS);
 static int       pre_xr(DECL_ARGS);
 static void      print_word(const char *);
@@ -120,7 +124,20 @@ static     void      print_width(const struct mdoc_bl *,
 static void      print_count(int *);
 static void      print_node(DECL_ARGS);
 
-static const struct manact __manacts[MDOC_MAX - MDOC_Dd] = {
+static const void_fp roff_man_acts[ROFF_MAX] = {
+       pre_br,         /* br */
+       pre_onearg,     /* ce */
+       pre_ft,         /* ft */
+       pre_onearg,     /* ll */
+       pre_onearg,     /* mc */
+       pre_onearg,     /* po */
+       pre_onearg,     /* rj */
+       pre_sp,         /* sp */
+       pre_ta,         /* ta */
+       pre_onearg,     /* ti */
+};
+
+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 */
@@ -148,14 +165,14 @@ static    const struct manact __manacts[MDOC_MAX - MDOC_Dd] = {
        { NULL, pre_fd, post_fd, NULL, NULL }, /* Fd */
        { NULL, pre_fl, post_fl, NULL, NULL }, /* Fl */
        { NULL, pre_fn, post_fn, NULL, NULL }, /* Fn */
-       { NULL, pre_ft, post_font, NULL, NULL }, /* Ft */
+       { NULL, pre_Ft, post_font, NULL, NULL }, /* Ft */
        { NULL, pre_sy, post_font, NULL, NULL }, /* Ic */
        { NULL, pre_in, post_in, NULL, NULL }, /* In */
        { NULL, pre_li, post_font, NULL, NULL }, /* Li */
        { 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_Ft, post_font, NULL, NULL }, /* Ot */
        { NULL, pre_em, post_font, NULL, NULL }, /* Pa */
        { NULL, pre_ex, NULL, NULL, NULL }, /* Rv */
        { NULL, NULL, NULL, NULL, NULL }, /* St */
@@ -181,22 +198,22 @@ static    const struct manact __manacts[MDOC_MAX - MDOC_Dd] = {
        { NULL, pre_bf, post_bf, NULL, NULL }, /* Bf */
        { cond_body, pre_enc, post_enc, "[", "]" }, /* Bo */
        { cond_body, pre_enc, post_enc, "[", "]" }, /* Bq */
-       { NULL, NULL, NULL, NULL, NULL }, /* Bsx */
-       { NULL, NULL, NULL, NULL, NULL }, /* Bx */
+       { NULL, pre_bk, post_bk, NULL, NULL }, /* Bsx */
+       { 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 */
        { cond_body, pre_eo, post_eo, NULL, NULL }, /* Eo */
-       { NULL, NULL, NULL, NULL, NULL }, /* Fx */
+       { NULL, pre_bk, post_bk, NULL, NULL }, /* Fx */
        { NULL, pre_sy, post_font, NULL, NULL }, /* Ms */
        { NULL, pre_no, NULL, NULL, NULL }, /* No */
        { NULL, pre_ns, NULL, NULL, NULL }, /* Ns */
-       { NULL, NULL, NULL, NULL, NULL }, /* Nx */
-       { NULL, NULL, NULL, NULL, NULL }, /* Ox */
+       { NULL, pre_bk, post_bk, NULL, NULL }, /* Nx */
+       { NULL, pre_bk, post_bk, NULL, NULL }, /* Ox */
        { NULL, NULL, NULL, NULL, NULL }, /* Pc */
        { NULL, NULL, post_pf, NULL, NULL }, /* Pf */
        { cond_body, pre_enc, post_enc, "(", ")" }, /* Po */
@@ -237,14 +254,12 @@ static    const struct manact __manacts[MDOC_MAX - MDOC_Dd] = {
        { NULL, NULL, post_percent, NULL, NULL }, /* %C */
        { NULL, pre_skip, NULL, NULL, NULL }, /* Es */
        { cond_body, pre_en, post_en, NULL, NULL }, /* En */
-       { NULL, NULL, NULL, NULL, NULL }, /* Dx */
+       { NULL, pre_bk, post_bk, NULL, NULL }, /* Dx */
        { NULL, NULL, post_percent, NULL, NULL }, /* %Q */
-       { NULL, pre_sp, post_sp, NULL, NULL }, /* sp */
        { NULL, NULL, post_percent, NULL, NULL }, /* %U */
        { NULL, NULL, NULL, NULL, NULL }, /* Ta */
-       { NULL, pre_ll, post_sp, NULL, NULL }, /* ll */
 };
-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 */
@@ -275,6 +290,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)
 {
@@ -435,7 +457,6 @@ static void
 print_line(const char *s, int newflags)
 {
 
-       outflags &= ~MMAN_br;
        outflags |= MMAN_nl;
        print_word(s);
        outflags |= newflags;
@@ -464,6 +485,7 @@ print_offs(const char *v, int keywords)
 {
        char              buf[24];
        struct roffsu     su;
+       const char       *end;
        int               sz;
 
        print_line(".RS", MMAN_Bk_susp);
@@ -475,8 +497,11 @@ print_offs(const char *v, int keywords)
                sz = 6;
        else if (keywords && !strcmp(v, "indent-two"))
                sz = 12;
-       else if (a2roffsu(v, &su, SCALE_EN) > 1) {
-               if (SCALE_EN == su.unit)
+       else {
+               end = a2roffsu(v, &su, SCALE_EN);
+               if (end == NULL || *end != '\0')
+                       sz = man_strlen(v);
+               else if (SCALE_EN == su.unit)
                        sz = su.scale;
                else {
                        /*
@@ -490,8 +515,7 @@ print_offs(const char *v, int keywords)
                        outflags |= MMAN_nl;
                        return;
                }
-       } else
-               sz = man_strlen(v);
+       }
 
        /*
         * We are inside an enclosing list.
@@ -513,6 +537,7 @@ print_width(const struct mdoc_bl *bl, const struct roff_node *child)
 {
        char              buf[24];
        struct roffsu     su;
+       const char       *end;
        int               numeric, remain, sz, chsz;
 
        numeric = 1;
@@ -521,15 +546,17 @@ print_width(const struct mdoc_bl *bl, const struct roff_node *child)
        /* Convert the width into a number (of characters). */
        if (bl->width == NULL)
                sz = (bl->type == LIST_hang) ? 6 : 0;
-       else if (a2roffsu(bl->width, &su, SCALE_MAX) > 1) {
-               if (SCALE_EN == su.unit)
+       else {
+               end = a2roffsu(bl->width, &su, SCALE_MAX);
+               if (end == NULL || *end != '\0')
+                       sz = man_strlen(bl->width);
+               else if (SCALE_EN == su.unit)
                        sz = su.scale;
                else {
                        sz = 0;
                        numeric = 0;
                }
-       } else
-               sz = man_strlen(bl->width);
+       }
 
        /* XXX Rough estimation, might have multiple parts. */
        if (bl->type == LIST_enum)
@@ -590,6 +617,14 @@ man_mdoc(void *arg, const struct roff_man *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),
@@ -604,7 +639,7 @@ 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)
+       for (; n != NULL; n = n->next)
                print_node(&mdoc->meta, n);
        putchar('\n');
 }
@@ -612,9 +647,9 @@ man_mdoc(void *arg, const struct roff_man *mdoc)
 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;
@@ -652,20 +687,14 @@ print_node(DECL_ARGS)
                else if (outflags & MMAN_Sm)
                        outflags |= MMAN_spc;
        } else if (n->tok < ROFF_MAX) {
-               switch (n->tok) {
-               case ROFF_br:
-                       pre_br(meta, n);
-                       break;
-               default:
-                       abort();
-               }
+               (*roff_man_acts[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;
+               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))
@@ -713,7 +742,7 @@ 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);
@@ -726,7 +755,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);
@@ -751,7 +780,7 @@ static void
 post_percent(DECL_ARGS)
 {
 
-       if (pre_em == manacts[n->tok].pre)
+       if (mdoc_man_act(n->tok)->pre == pre_em)
                font_pop();
        if (n->next) {
                print_word(",");
@@ -797,7 +826,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;
@@ -977,11 +1006,11 @@ post_bf(DECL_ARGS)
 static int
 pre_bk(DECL_ARGS)
 {
-
        switch (n->type) {
        case ROFFT_BLOCK:
                return 1;
        case ROFFT_BODY:
+       case ROFFT_ELEM:
                outflags |= MMAN_Bk;
                return 1;
        default:
@@ -992,9 +1021,18 @@ pre_bk(DECL_ARGS)
 static void
 post_bk(DECL_ARGS)
 {
-
-       if (n->type == ROFFT_BODY)
+       switch (n->type) {
+       case ROFFT_ELEM:
+               while ((n = n->parent) != NULL)
+                        if (n->tok == MDOC_Bk)
+                               return;
+               /* FALLTHROUGH */
+       case ROFFT_BODY:
                outflags &= ~MMAN_Bk;
+               break;
+       default:
+               break;
+       }
 }
 
 static int
@@ -1064,12 +1102,10 @@ post_bl(DECL_ARGS)
 
 }
 
-static int
+static void
 pre_br(DECL_ARGS)
 {
-
        outflags |= MMAN_br;
-       return 0;
 }
 
 static int
@@ -1314,7 +1350,7 @@ post_fo(DECL_ARGS)
 }
 
 static int
-pre_ft(DECL_ARGS)
+pre_Ft(DECL_ARGS)
 {
 
        pre_syn(n);
@@ -1322,6 +1358,14 @@ pre_ft(DECL_ARGS)
        return 1;
 }
 
+static void
+pre_ft(DECL_ARGS)
+{
+       print_line(".ft", 0);
+       print_word(n->child->string);
+       outflags |= MMAN_nl;
+}
+
 static int
 pre_in(DECL_ARGS)
 {
@@ -1378,7 +1422,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:
@@ -1516,16 +1560,21 @@ post_lb(DECL_ARGS)
 static int
 pre_lk(DECL_ARGS)
 {
-       const struct roff_node *link, *descr;
-       int display;
+       const struct roff_node *link, *descr, *punct;
 
        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) {
                font_push('I');
-               while (descr != NULL && !(descr->flags & NODE_DELIMC)) {
+               while (descr != punct) {
                        print_word(descr->string);
                        descr = descr->next;
                }
@@ -1534,32 +1583,31 @@ 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();
 
        /* Trailing punctuation. */
-       while (descr != NULL) {
-               print_word(descr->string);
-               descr = descr->next;
+       while (punct != NULL) {
+               print_word(punct->string);
+               punct = punct->next;
        }
-       if (display)
-               print_line(".RE", MMAN_nl);
        return 0;
 }
 
-static int
-pre_ll(DECL_ARGS)
+static void
+pre_onearg(DECL_ARGS)
 {
-
-       print_line(".ll", 0);
-       return 1;
+       outflags |= MMAN_nl;
+       print_word(".");
+       outflags &= ~MMAN_spc;
+       print_word(roff_name[n->tok]);
+       if (n->child != NULL)
+               print_word(n->child->string);
+       outflags |= MMAN_nl;
+       if (n->tok == ROFF_ce)
+               for (n = n->child->next; n != NULL; n = n->next)
+                       print_node(meta, n);
 }
 
 static int
@@ -1683,22 +1731,17 @@ pre_sm(DECL_ARGS)
        return 0;
 }
 
-static int
+static void
 pre_sp(DECL_ARGS)
 {
-
-       if (MMAN_PP & outflags) {
+       if (outflags & MMAN_PP) {
                outflags &= ~MMAN_PP;
                print_line(".PP", 0);
-       } else
+       } else {
                print_line(".sp", 0);
-       return 1;
-}
-
-static void
-post_sp(DECL_ARGS)
-{
-
+               if (n->child != NULL)
+                       print_word(n->child->string);
+       }
        outflags |= MMAN_nl;
 }
 
@@ -1710,6 +1753,15 @@ pre_sy(DECL_ARGS)
        return 1;
 }
 
+static void
+pre_ta(DECL_ARGS)
+{
+       print_line(".ta", 0);
+       for (n = n->child; n != NULL; n = n->next)
+               print_word(n->string);
+       outflags |= MMAN_nl;
+}
+
 static int
 pre_vt(DECL_ARGS)
 {