]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_html.c
When finding a bogus database entry,
[mandoc.git] / mdoc_html.c
index 6d0d89bf50664bfc2c17a0cd5c3d3ed7d8de602e..0b4b9adf34f286d045f8ddf32ca21e1abc910c1d 100644 (file)
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_html.c,v 1.274 2017/03/13 19:01:38 schwarze Exp $ */
+/*     $Id: mdoc_html.c,v 1.294 2017/07/15 17:57:51 schwarze Exp $ */
 /*
  * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2014, 2015, 2016, 2017 Ingo Schwarze <schwarze@openbsd.org>
@@ -27,6 +27,7 @@
 #include <unistd.h>
 
 #include "mandoc_aux.h"
+#include "mandoc.h"
 #include "roff.h"
 #include "mdoc.h"
 #include "out.h"
@@ -48,7 +49,7 @@ struct        htmlmdoc {
        void            (*post)(MDOC_ARGS);
 };
 
-static char             *make_id(const struct roff_node *);
+static char             *cond_id(const struct roff_node *);
 static void              print_mdoc_head(MDOC_ARGS);
 static void              print_mdoc_node(MDOC_ARGS);
 static void              print_mdoc_nodelist(MDOC_ARGS);
@@ -108,7 +109,6 @@ static      int               mdoc_rs_pre(MDOC_ARGS);
 static int               mdoc_sh_pre(MDOC_ARGS);
 static int               mdoc_skip_pre(MDOC_ARGS);
 static int               mdoc_sm_pre(MDOC_ARGS);
-static int               mdoc_sp_pre(MDOC_ARGS);
 static int               mdoc_ss_pre(MDOC_ARGS);
 static int               mdoc_st_pre(MDOC_ARGS);
 static int               mdoc_sx_pre(MDOC_ARGS);
@@ -118,8 +118,7 @@ static      int               mdoc_vt_pre(MDOC_ARGS);
 static int               mdoc_xr_pre(MDOC_ARGS);
 static int               mdoc_xx_pre(MDOC_ARGS);
 
-static const struct htmlmdoc mdocs[MDOC_MAX] = {
-       {mdoc_ap_pre, NULL}, /* Ap */
+static const struct htmlmdoc __mdocs[MDOC_MAX - MDOC_Dd] = {
        {NULL, NULL}, /* Dd */
        {NULL, NULL}, /* Dt */
        {NULL, NULL}, /* Os */
@@ -135,6 +134,7 @@ static      const struct htmlmdoc mdocs[MDOC_MAX] = {
        {mdoc_it_pre, NULL}, /* It */
        {mdoc_ad_pre, NULL}, /* Ad */
        {mdoc_an_pre, NULL}, /* An */
+       {mdoc_ap_pre, NULL}, /* Ap */
        {mdoc_ar_pre, NULL}, /* Ar */
        {mdoc_cd_pre, NULL}, /* Cd */
        {mdoc_cm_pre, NULL}, /* Cm */
@@ -237,12 +237,10 @@ static    const struct htmlmdoc mdocs[MDOC_MAX] = {
        {mdoc_quote_pre, mdoc_quote_post}, /* En */
        {mdoc_xx_pre, NULL}, /* Dx */
        {mdoc__x_pre, mdoc__x_post}, /* %Q */
-       {mdoc_sp_pre, NULL}, /* br */
-       {mdoc_sp_pre, NULL}, /* sp */
        {mdoc__x_pre, mdoc__x_post}, /* %U */
        {NULL, NULL}, /* Ta */
-       {mdoc_skip_pre, NULL}, /* ll */
 };
+static const struct htmlmdoc *const mdocs = __mdocs - MDOC_Dd;
 
 
 /*
@@ -362,9 +360,9 @@ print_mdoc_node(MDOC_ARGS)
                 * Make sure that if we're in a literal mode already
                 * (i.e., within a <PRE>) don't print the newline.
                 */
-               if (' ' == *n->string && NODE_LINE & n->flags)
-                       if ( ! (HTML_LITERAL & h->flags))
-                               print_otag(h, TAG_BR, "");
+               if (*n->string == ' ' && n->flags & NODE_LINE &&
+                   (h->flags & (HTML_LITERAL | HTML_NONEWLINE)) == 0)
+                       print_otag(h, TAG_BR, "");
                if (NODE_DELIMC & n->flags)
                        h->flags |= HTML_NOSPACE;
                print_text(h, n->string);
@@ -393,7 +391,14 @@ print_mdoc_node(MDOC_ARGS)
                        t = h->tag;
                }
                assert(h->tblt == NULL);
-               if (mdocs[n->tok].pre && (n->end == ENDBODY_NOT || n->child))
+               if (n->tok < ROFF_MAX) {
+                       roff_html_pre(h, n);
+                       child = 0;
+                       break;
+               }
+               assert(n->tok >= MDOC_Dd && n->tok < MDOC_MAX);
+               if (mdocs[n->tok].pre != NULL &&
+                   (n->end == ENDBODY_NOT || n->child != NULL))
                        child = (*mdocs[n->tok].pre)(meta, n, h);
                break;
        }
@@ -412,7 +417,9 @@ print_mdoc_node(MDOC_ARGS)
        case ROFFT_EQN:
                break;
        default:
-               if ( ! mdocs[n->tok].post || n->flags & NODE_ENDED)
+               if (n->tok < ROFF_MAX ||
+                   mdocs[n->tok].post == NULL ||
+                   n->flags & NODE_ENDED)
                        break;
                (*mdocs[n->tok].post)(meta, n, h);
                if (n->end != ENDBODY_NOT)
@@ -477,25 +484,19 @@ mdoc_root_pre(MDOC_ARGS)
 }
 
 static char *
-make_id(const struct roff_node *n)
+cond_id(const struct roff_node *n)
 {
-       const struct roff_node  *nch;
-       char                    *buf, *cp;
-
-       for (nch = n->child; nch != NULL; nch = nch->next)
-               if (nch->type != ROFFT_TEXT)
-                       return NULL;
-
-       buf = NULL;
-       deroff(&buf, n);
-
-       /* http://www.w3.org/TR/html5/dom.html#the-id-attribute */
-
-       for (cp = buf; *cp != '\0'; cp++)
-               if (*cp == ' ')
-                       *cp = '_';
-
-       return buf;
+       if (n->child != NULL &&
+           n->child->type == ROFFT_TEXT &&
+           (n->prev == NULL ||
+            (n->prev->type == ROFFT_TEXT &&
+             strcmp(n->prev->string, "|") == 0)) &&
+           (n->parent->tok == MDOC_It ||
+            (n->parent->tok == MDOC_Xo &&
+             n->parent->parent->prev == NULL &&
+             n->parent->parent->parent->tok == MDOC_It)))
+               return html_make_id(n);
+       return NULL;
 }
 
 static int
@@ -505,8 +506,10 @@ mdoc_sh_pre(MDOC_ARGS)
 
        switch (n->type) {
        case ROFFT_HEAD:
-               id = make_id(n);
+               id = html_make_id(n);
                print_otag(h, TAG_H1, "cTi", "Sh", id);
+               if (id != NULL)
+                       print_otag(h, TAG_A, "chR", "selflink", id);
                free(id);
                break;
        case ROFFT_BODY:
@@ -527,8 +530,10 @@ mdoc_ss_pre(MDOC_ARGS)
        if (n->type != ROFFT_HEAD)
                return 1;
 
-       id = make_id(n);
+       id = html_make_id(n);
        print_otag(h, TAG_H2, "cTi", "Ss", id);
+       if (id != NULL)
+               print_otag(h, TAG_A, "chR", "selflink", id);
        free(id);
        return 1;
 }
@@ -536,9 +541,14 @@ mdoc_ss_pre(MDOC_ARGS)
 static int
 mdoc_fl_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_B, "cT", "Fl");
-       print_text(h, "\\-");
+       char    *id;
 
+       if ((id = cond_id(n)) != NULL)
+               print_otag(h, TAG_A, "chR", "selflink", id);
+       print_otag(h, TAG_B, "cTi", "Fl", id);
+       free(id);
+
+       print_text(h, "\\-");
        if (!(n->child == NULL &&
            (n->next == NULL ||
             n->next->type == ROFFT_TEXT ||
@@ -551,7 +561,12 @@ mdoc_fl_pre(MDOC_ARGS)
 static int
 mdoc_cm_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_B, "cT", "Cm");
+       char    *id;
+
+       if ((id = cond_id(n)) != NULL)
+               print_otag(h, TAG_A, "chR", "selflink", id);
+       print_otag(h, TAG_B, "cTi", "Cm", id);
+       free(id);
        return 1;
 }
 
@@ -571,9 +586,6 @@ mdoc_nd_pre(MDOC_ARGS)
 static int
 mdoc_nm_pre(MDOC_ARGS)
 {
-       struct tag      *t;
-       int              len;
-
        switch (n->type) {
        case ROFFT_HEAD:
                print_otag(h, TAG_TD, "");
@@ -587,21 +599,8 @@ mdoc_nm_pre(MDOC_ARGS)
        default:
                break;
        }
-
        synopsis_pre(h, n);
        print_otag(h, TAG_TABLE, "c", "Nm");
-
-       for (len = 0, n = n->head->child; n; n = n->next)
-               if (n->type == ROFFT_TEXT)
-                       len += html_strlen(n->string);
-
-       if (len == 0 && meta->name != NULL)
-               len = html_strlen(meta->name);
-
-       t = print_otag(h, TAG_COLGROUP, "");
-       print_otag(h, TAG_COL, "shw", len);
-       print_otag(h, TAG_COL, "");
-       print_tagq(h, t);
        print_otag(h, TAG_TR, "");
        return 1;
 }
@@ -716,10 +715,7 @@ mdoc_it_pre(MDOC_ARGS)
                case ROFFT_HEAD:
                        return 0;
                case ROFFT_BODY:
-                       if (bl->norm->Bl.comp)
-                               print_otag(h, TAG_LI, "csvt", cattr, 0);
-                       else
-                               print_otag(h, TAG_LI, "c", cattr);
+                       print_otag(h, TAG_LI, "c", cattr);
                        break;
                default:
                        break;
@@ -731,15 +727,12 @@ mdoc_it_pre(MDOC_ARGS)
        case LIST_ohang:
                switch (n->type) {
                case ROFFT_HEAD:
-                       if (bl->norm->Bl.comp)
-                               print_otag(h, TAG_DT, "csvt", cattr, 0);
-                       else
-                               print_otag(h, TAG_DT, "c", cattr);
+                       print_otag(h, TAG_DT, "c", cattr);
                        if (type == LIST_diag)
                                print_otag(h, TAG_B, "c", cattr);
                        break;
                case ROFFT_BODY:
-                       print_otag(h, TAG_DD, "cswl", cattr,
+                       print_otag(h, TAG_DD, "csw*+l", cattr,
                            bl->norm->Bl.width);
                        break;
                default:
@@ -753,7 +746,7 @@ mdoc_it_pre(MDOC_ARGS)
                            (n->parent->prev == NULL ||
                             n->parent->prev->body == NULL ||
                             n->parent->prev->body->child != NULL)) {
-                               t = print_otag(h, TAG_DT, "csWl",
+                               t = print_otag(h, TAG_DT, "csw*+-l",
                                    cattr, bl->norm->Bl.width);
                                print_text(h, "\\ ");
                                print_tagq(h, t);
@@ -761,7 +754,7 @@ mdoc_it_pre(MDOC_ARGS)
                                print_text(h, "\\ ");
                                print_tagq(h, t);
                        }
-                       print_otag(h, TAG_DT, "csWl", cattr,
+                       print_otag(h, TAG_DT, "csw*+-l", cattr,
                            bl->norm->Bl.width);
                        break;
                case ROFFT_BODY:
@@ -781,10 +774,7 @@ mdoc_it_pre(MDOC_ARGS)
                case ROFFT_HEAD:
                        break;
                case ROFFT_BODY:
-                       if (bl->norm->Bl.comp)
-                               print_otag(h, TAG_TD, "csvt", cattr, 0);
-                       else
-                               print_otag(h, TAG_TD, "c", cattr);
+                       print_otag(h, TAG_TD, "c", cattr);
                        break;
                default:
                        print_otag(h, TAG_TR, "c", cattr);
@@ -799,9 +789,9 @@ mdoc_it_pre(MDOC_ARGS)
 static int
 mdoc_bl_pre(MDOC_ARGS)
 {
+       char             cattr[21];
        struct tag      *t;
        struct mdoc_bl  *bl;
-       const char      *cattr;
        size_t           i;
        enum htmltag     elemtype;
 
@@ -824,7 +814,7 @@ mdoc_bl_pre(MDOC_ARGS)
 
                t = print_otag(h, TAG_COLGROUP, "");
                for (i = 0; i < bl->ncols - 1; i++)
-                       print_otag(h, TAG_COL, "sww", bl->cols[i]);
+                       print_otag(h, TAG_COL, "sw+w", bl->cols[i]);
                print_otag(h, TAG_COL, "swW", bl->cols[i]);
                print_tagq(h, t);
                return 0;
@@ -836,50 +826,52 @@ mdoc_bl_pre(MDOC_ARGS)
        switch (bl->type) {
        case LIST_bullet:
                elemtype = TAG_UL;
-               cattr = "Bl-bullet";
+               (void)strlcpy(cattr, "Bl-bullet", sizeof(cattr));
                break;
        case LIST_dash:
        case LIST_hyphen:
                elemtype = TAG_UL;
-               cattr = "Bl-dash";
+               (void)strlcpy(cattr, "Bl-dash", sizeof(cattr));
                break;
        case LIST_item:
                elemtype = TAG_UL;
-               cattr = "Bl-item";
+               (void)strlcpy(cattr, "Bl-item", sizeof(cattr));
                break;
        case LIST_enum:
                elemtype = TAG_OL;
-               cattr = "Bl-enum";
+               (void)strlcpy(cattr, "Bl-enum", sizeof(cattr));
                break;
        case LIST_diag:
                elemtype = TAG_DL;
-               cattr = "Bl-diag";
+               (void)strlcpy(cattr, "Bl-diag", sizeof(cattr));
                break;
        case LIST_hang:
                elemtype = TAG_DL;
-               cattr = "Bl-hang";
+               (void)strlcpy(cattr, "Bl-hang", sizeof(cattr));
                break;
        case LIST_inset:
                elemtype = TAG_DL;
-               cattr = "Bl-inset";
+               (void)strlcpy(cattr, "Bl-inset", sizeof(cattr));
                break;
        case LIST_ohang:
                elemtype = TAG_DL;
-               cattr = "Bl-ohang";
+               (void)strlcpy(cattr, "Bl-ohang", sizeof(cattr));
                break;
        case LIST_tag:
-               cattr = "Bl-tag";
                if (bl->offs)
-                       print_otag(h, TAG_DIV, "cswl", cattr, bl->offs);
-               print_otag(h, TAG_DL, "cswl", cattr, bl->width);
+                       print_otag(h, TAG_DIV, "cswl", "Bl-tag", bl->offs);
+               print_otag(h, TAG_DL, "csw*+l", bl->comp ?
+                   "Bl-tag Bl-compact" : "Bl-tag", bl->width);
                return 1;
        case LIST_column:
                elemtype = TAG_TABLE;
-               cattr = "Bl-column";
+               (void)strlcpy(cattr, "Bl-column", sizeof(cattr));
                break;
        default:
                abort();
        }
+       if (bl->comp)
+               (void)strlcat(cattr, " Bl-compact", sizeof(cattr));
        print_otag(h, elemtype, "cswl", cattr, bl->offs);
        return 1;
 }
@@ -925,7 +917,7 @@ mdoc_sx_pre(MDOC_ARGS)
 {
        char    *id;
 
-       id = make_id(n);
+       id = html_make_id(n);
        print_otag(h, TAG_A, "cThR", "Sx", id);
        free(id);
        return 1;
@@ -992,9 +984,9 @@ mdoc_bd_pre(MDOC_ARGS)
                 * anyway, so don't sweat it.
                 */
                switch (nn->tok) {
+               case ROFF_br:
+               case ROFF_sp:
                case MDOC_Sm:
-               case MDOC_br:
-               case MDOC_sp:
                case MDOC_Bl:
                case MDOC_D1:
                case MDOC_Dl:
@@ -1068,21 +1060,42 @@ mdoc_cd_pre(MDOC_ARGS)
 static int
 mdoc_dv_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_CODE, "cT", "Dv");
+       char    *id;
+
+       if ((id = cond_id(n)) != NULL)
+               print_otag(h, TAG_A, "chR", "selflink", id);
+       print_otag(h, TAG_CODE, "cTi", "Dv", id);
+       free(id);
        return 1;
 }
 
 static int
 mdoc_ev_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_CODE, "cT", "Ev");
+       char    *id;
+
+       if ((id = cond_id(n)) != NULL)
+               print_otag(h, TAG_A, "chR", "selflink", id);
+       print_otag(h, TAG_CODE, "cTi", "Ev", id);
+       free(id);
        return 1;
 }
 
 static int
 mdoc_er_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_CODE, "cT", "Er");
+       char    *id;
+
+       id = n->sec == SEC_ERRORS &&
+           (n->parent->tok == MDOC_It ||
+            (n->parent->tok == MDOC_Bq &&
+             n->parent->parent->parent->tok == MDOC_It)) ?
+           html_make_id(n) : NULL;
+
+       if (id != NULL)
+               print_otag(h, TAG_A, "chR", "selflink", id);
+       print_otag(h, TAG_CODE, "cTi", "Er", id);
+       free(id);
        return 1;
 }
 
@@ -1287,48 +1300,40 @@ mdoc_pp_pre(MDOC_ARGS)
        return 0;
 }
 
-static int
-mdoc_sp_pre(MDOC_ARGS)
-{
-       struct roffsu    su;
-
-       SCALE_VS_INIT(&su, 1);
-
-       if (MDOC_sp == n->tok) {
-               if (NULL != (n = n->child)) {
-                       if ( ! a2roffsu(n->string, &su, SCALE_VS))
-                               su.scale = 1.0;
-                       else if (su.scale < 0.0)
-                               su.scale = 0.0;
-               }
-       } else
-               su.scale = 0.0;
-
-       print_otag(h, TAG_DIV, "suh", &su);
-
-       /* So the div isn't empty: */
-       print_text(h, "\\~");
-
-       return 0;
-
-}
-
 static int
 mdoc_lk_pre(MDOC_ARGS)
 {
-       if (NULL == (n = n->child))
-               return 0;
-
-       assert(n->type == ROFFT_TEXT);
-
-       print_otag(h, TAG_A, "cTh", "Lk", n->string);
+       const struct roff_node *link, *descr, *punct;
+       struct tag      *t;
 
-       if (NULL == n->next)
-               print_text(h, n->string);
+       if ((link = n->child) == NULL)
+               return 0;
 
-       for (n = n->next; n; n = n->next)
-               print_text(h, n->string);
+       /* Find beginning of trailing punctuation. */
+       punct = n->last;
+       while (punct != link && punct->flags & NODE_DELIMC)
+               punct = punct->prev;
+       punct = punct->next;
+
+       /* Link target and link text. */
+       descr = link->next;
+       if (descr == punct)
+               descr = link;  /* no text */
+       t = print_otag(h, TAG_A, "cTh", "Lk", link->string);
+       do {
+               if (descr->flags & (NODE_DELIMC | NODE_DELIMO))
+                       h->flags |= HTML_NOSPACE;
+               print_text(h, descr->string);
+               descr = descr->next;
+       } while (descr != punct);
+       print_tagq(h, t);
 
+       /* Trailing punctuation. */
+       while (punct != NULL) {
+               h->flags |= HTML_NOSPACE;
+               print_text(h, punct->string);
+               punct = punct->next;
+       }
        return 0;
 }
 
@@ -1436,7 +1441,12 @@ mdoc_in_pre(MDOC_ARGS)
 static int
 mdoc_ic_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_B, "cT", "Ic");
+       char    *id;
+
+       if ((id = cond_id(n)) != NULL)
+               print_otag(h, TAG_A, "chR", "selflink", id);
+       print_otag(h, TAG_B, "cTi", "Ic", id);
+       free(id);
        return 1;
 }
 
@@ -1488,7 +1498,12 @@ mdoc_bf_pre(MDOC_ARGS)
 static int
 mdoc_ms_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_B, "cT", "Ms");
+       char *id;
+
+       if ((id = cond_id(n)) != NULL)
+               print_otag(h, TAG_A, "chR", "selflink", id);
+       print_otag(h, TAG_B, "cTi", "Ms", id);
+       free(id);
        return 1;
 }
 
@@ -1524,14 +1539,24 @@ mdoc_rs_pre(MDOC_ARGS)
 static int
 mdoc_no_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_SPAN, "c", "No");
+       char *id;
+
+       if ((id = cond_id(n)) != NULL)
+               print_otag(h, TAG_A, "chR", "selflink", id);
+       print_otag(h, TAG_SPAN, "ci", "No", id);
+       free(id);
        return 1;
 }
 
 static int
 mdoc_li_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_CODE, "c", "Li");
+       char    *id;
+
+       if ((id = cond_id(n)) != NULL)
+               print_otag(h, TAG_A, "chR", "selflink", id);
+       print_otag(h, TAG_CODE, "ci", "Li", id);
+       free(id);
        return 1;
 }