]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_man.c
For -man -Thtml, ignore author-specified .HP widths because they
[mandoc.git] / mdoc_man.c
index 19e37f7bc9d0a2b32fc79da4ced923c774cfc4e7..bcf9207f79cc5a07cd707e58f8b257de418a02a0 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_man.c,v 1.107 2017/04/17 12:53:29 schwarze Exp $ */
+/*     $Id: mdoc_man.c,v 1.126 2018/04/11 17:11:13 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
@@ -20,6 +20,7 @@
 
 #include <assert.h>
 #include <stdio.h>
+#include <stdlib.h>
 #include <string.h>
 
 #include "mandoc_aux.h"
 
 #define        DECL_ARGS const struct roff_meta *meta, struct roff_node *n
 
+typedef        int     (*int_fp)(DECL_ARGS);
+typedef        void    (*void_fp)(DECL_ARGS);
+
 struct manact {
-       int             (*cond)(DECL_ARGS); /* DON'T run actions */
-       int             (*pre)(DECL_ARGS); /* pre-node action */
-       void            (*post)(DECL_ARGS); /* post-node action */
+       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 */
 };
@@ -44,6 +48,7 @@ static        int       cond_body(DECL_ARGS);
 static int       cond_head(DECL_ARGS);
 static  void     font_push(char);
 static void      font_pop(void);
+static int       man_strlen(const char *);
 static void      mid_it(void);
 static void      post__t(DECL_ARGS);
 static void      post_aq(DECL_ARGS);
@@ -68,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);
@@ -78,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);
@@ -91,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 *);
@@ -118,8 +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 + 1] = {
-       { NULL, pre_ap, NULL, NULL, NULL }, /* Ap */
+static const void_fp roff_manacts[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 manact __manacts[MDOC_MAX - MDOC_Dd] = {
        { NULL, NULL, NULL, NULL, NULL }, /* Dd */
        { NULL, NULL, NULL, NULL, NULL }, /* Dt */
        { NULL, NULL, NULL, NULL, NULL }, /* Os */
@@ -135,6 +153,7 @@ static      const struct manact manacts[MDOC_MAX + 1] = {
        { NULL, pre_it, post_it, NULL, NULL }, /* It */
        { NULL, pre_em, post_font, NULL, NULL }, /* Ad */
        { NULL, pre_an, NULL, NULL, NULL }, /* An */
+       { NULL, pre_ap, NULL, NULL, NULL }, /* Ap */
        { NULL, pre_em, post_font, NULL, NULL }, /* Ar */
        { NULL, pre_sy, post_font, NULL, NULL }, /* Cd */
        { NULL, pre_sy, post_font, NULL, NULL }, /* Cm */
@@ -146,14 +165,14 @@ static    const struct manact manacts[MDOC_MAX + 1] = {
        { 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 */
@@ -179,22 +198,22 @@ static    const struct manact manacts[MDOC_MAX + 1] = {
        { 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 */
@@ -235,15 +254,12 @@ static    const struct manact manacts[MDOC_MAX + 1] = {
        { 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_br, NULL, NULL, NULL }, /* br */
-       { 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 */
-       { NULL, NULL, NULL, NULL, NULL }, /* ROOT */
 };
+static const struct manact *const manacts = __manacts - MDOC_Dd;
 
 static int             outflags;
 #define        MMAN_spc        (1 << 0)  /* blank character before next word */
@@ -274,6 +290,49 @@ static     struct {
 }      fontqueue;
 
 
+static int
+man_strlen(const char *cp)
+{
+       size_t   rsz;
+       int      skip, sz;
+
+       sz = 0;
+       skip = 0;
+       for (;;) {
+               rsz = strcspn(cp, "\\");
+               if (rsz) {
+                       cp += rsz;
+                       if (skip) {
+                               skip = 0;
+                               rsz--;
+                       }
+                       sz += rsz;
+               }
+               if ('\0' == *cp)
+                       break;
+               cp++;
+               switch (mandoc_escape(&cp, NULL, NULL)) {
+               case ESCAPE_ERROR:
+                       return sz;
+               case ESCAPE_UNICODE:
+               case ESCAPE_NUMBERED:
+               case ESCAPE_SPECIAL:
+               case ESCAPE_OVERSTRIKE:
+                       if (skip)
+                               skip = 0;
+                       else
+                               sz++;
+                       break;
+               case ESCAPE_SKIPCHAR:
+                       skip = 1;
+                       break;
+               default:
+                       break;
+               }
+       }
+       return sz;
+}
+
 static void
 font_push(char newfont)
 {
@@ -391,7 +450,6 @@ static void
 print_line(const char *s, int newflags)
 {
 
-       outflags &= ~MMAN_br;
        outflags |= MMAN_nl;
        print_word(s);
        outflags |= newflags;
@@ -420,6 +478,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);
@@ -431,8 +490,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 {
                        /*
@@ -446,8 +508,7 @@ print_offs(const char *v, int keywords)
                        outflags |= MMAN_nl;
                        return;
                }
-       } else
-               sz = strlen(v);
+       }
 
        /*
         * We are inside an enclosing list.
@@ -469,6 +530,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;
@@ -477,21 +539,23 @@ 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 = strlen(bl->width);
+       }
 
        /* XXX Rough estimation, might have multiple parts. */
        if (bl->type == LIST_enum)
                chsz = (bl->count > 8) + 1;
        else if (child != NULL && child->type == ROFFT_TEXT)
-               chsz = strlen(child->string);
+               chsz = man_strlen(child->string);
        else
                chsz = 0;
 
@@ -546,6 +610,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),
@@ -560,7 +632,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');
 }
@@ -607,7 +679,11 @@ 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.
@@ -924,11 +1000,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:
@@ -939,9 +1015,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
@@ -1011,12 +1096,10 @@ post_bl(DECL_ARGS)
 
 }
 
-static int
+static void
 pre_br(DECL_ARGS)
 {
-
        outflags |= MMAN_br;
-       return 0;
 }
 
 static int
@@ -1261,7 +1344,7 @@ post_fo(DECL_ARGS)
 }
 
 static int
-pre_ft(DECL_ARGS)
+pre_Ft(DECL_ARGS)
 {
 
        pre_syn(n);
@@ -1269,6 +1352,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)
 {
@@ -1325,7 +1416,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:
@@ -1463,15 +1554,21 @@ post_lb(DECL_ARGS)
 static int
 pre_lk(DECL_ARGS)
 {
-       const struct roff_node *link, *descr;
+       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;
                }
@@ -1485,19 +1582,26 @@ pre_lk(DECL_ARGS)
        font_pop();
 
        /* Trailing punctuation. */
-       while (descr != NULL) {
-               print_word(descr->string);
-               descr = descr->next;
+       while (punct != NULL) {
+               print_word(punct->string);
+               punct = punct->next;
        }
        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
@@ -1526,7 +1630,7 @@ pre_nm(DECL_ARGS)
                if (NULL == n->parent->prev)
                        outflags |= MMAN_sp;
                print_block(".HP", 0);
-               printf(" %zun", strlen(name) + 1);
+               printf(" %dn", man_strlen(name) + 1);
                outflags |= MMAN_nl;
        }
        font_push('B');
@@ -1621,22 +1725,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;
 }
 
@@ -1648,6 +1747,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)
 {