Minimal support for deep linking into man(7) pages.

[mandoc.git] / mdoc_html.c

diff --git a/mdoc_html.c b/mdoc_html.c
index d3b63b96826003a22ffeed69a1118a90c2934dcb..0f71a16b0f5403e9011f437773ecce25eb43f829 100644 (file)
--- a/mdoc_html.c
+++ b/mdoc_html.c
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_html.c,v 1.272 2017/02/22 08:54:41 schwarze Exp $ */
+/*     $Id: mdoc_html.c,v 1.277 2017/03/15 11:29:53 schwarze Exp $ */
 /*
  * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2014, 2015, 2016, 2017 Ingo Schwarze <schwarze@openbsd.org>
@@ -48,7 +48,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);
@@ -477,25 +477,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 +499,9 @@ mdoc_sh_pre(MDOC_ARGS)
 
        switch (n->type) {
        case ROFFT_HEAD:
-               id = make_id(n);
-               print_otag(h, TAG_H1, "ci", "Sh", id);
+               id = html_make_id(n);
+               print_otag(h, TAG_H1, "cTi", "Sh", id);
+               print_otag(h, TAG_A, "chR", "selflink", id);
                free(id);
                break;
        case ROFFT_BODY:
@@ -527,8 +522,9 @@ mdoc_ss_pre(MDOC_ARGS)
        if (n->type != ROFFT_HEAD)
                return 1;
 
-       id = make_id(n);
-       print_otag(h, TAG_H2, "ci", "Ss", id);
+       id = html_make_id(n);
+       print_otag(h, TAG_H2, "cTi", "Ss", id);
+       print_otag(h, TAG_A, "chR", "selflink", id);
        free(id);
        return 1;
 }
@@ -536,9 +532,14 @@ mdoc_ss_pre(MDOC_ARGS)
 static int
 mdoc_fl_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_B, "c", "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 +552,12 @@ mdoc_fl_pre(MDOC_ARGS)
 static int
 mdoc_cm_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_B, "c", "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;
 }
 
@@ -564,7 +570,7 @@ mdoc_nd_pre(MDOC_ARGS)
        /* XXX: this tag in theory can contain block elements. */
 
        print_text(h, "\\(em");
-       print_otag(h, TAG_SPAN, "c", "Nd");
+       print_otag(h, TAG_SPAN, "cT", "Nd");
        return 1;
 }
 
@@ -579,7 +585,7 @@ mdoc_nm_pre(MDOC_ARGS)
                print_otag(h, TAG_TD, "");
                /* FALLTHROUGH */
        case ROFFT_ELEM:
-               print_otag(h, TAG_B, "c", "Nm");
+               print_otag(h, TAG_B, "cT", "Nm");
                return 1;
        case ROFFT_BODY:
                print_otag(h, TAG_TD, "");
@@ -599,7 +605,8 @@ mdoc_nm_pre(MDOC_ARGS)
                len = html_strlen(meta->name);
 
        t = print_otag(h, TAG_COLGROUP, "");
-       print_otag(h, TAG_COL, "shw", len);
+       /* Increase width to make even bold text fit. */
+       print_otag(h, TAG_COL, "shw", len + 2);
        print_otag(h, TAG_COL, "");
        print_tagq(h, t);
        print_otag(h, TAG_TR, "");
@@ -613,11 +620,11 @@ mdoc_xr_pre(MDOC_ARGS)
                return 0;
 
        if (h->base_man)
-               print_otag(h, TAG_A, "chM", "Xr",
+               print_otag(h, TAG_A, "cThM", "Xr",
                    n->child->string, n->child->next == NULL ?
                    NULL : n->child->next->string);
        else
-               print_otag(h, TAG_A, "c", "Xr");
+               print_otag(h, TAG_A, "cT", "Xr");
 
        n = n->child;
        print_text(h, n->string);
@@ -646,7 +653,7 @@ mdoc_ns_pre(MDOC_ARGS)
 static int
 mdoc_ar_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_VAR, "c", "Ar");
+       print_otag(h, TAG_VAR, "cT", "Ar");
        return 1;
 }
 
@@ -666,7 +673,7 @@ mdoc_it_pre(MDOC_ARGS)
        enum mdoc_list           type;
 
        bl = n->parent;
-       while (bl != NULL && bl->tok != MDOC_Bl)
+       while (bl->tok != MDOC_Bl)
                bl = bl->parent;
        type = bl->norm->Bl.type;
 
@@ -895,14 +902,14 @@ mdoc_ex_pre(MDOC_ARGS)
 static int
 mdoc_st_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_SPAN, "c", "St");
+       print_otag(h, TAG_SPAN, "cT", "St");
        return 1;
 }
 
 static int
 mdoc_em_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_I, "c", "Em");
+       print_otag(h, TAG_I, "cT", "Em");
        return 1;
 }
 
@@ -925,8 +932,8 @@ mdoc_sx_pre(MDOC_ARGS)
 {
        char    *id;
 
-       id = make_id(n);
-       print_otag(h, TAG_A, "chR", "Sx", id);
+       id = html_make_id(n);
+       print_otag(h, TAG_A, "cThR", "Sx", id);
        free(id);
        return 1;
 }
@@ -1022,7 +1029,7 @@ mdoc_bd_pre(MDOC_ARGS)
 static int
 mdoc_pa_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_I, "c", "Pa");
+       print_otag(h, TAG_I, "cT", "Pa");
        return 1;
 }
 
@@ -1053,7 +1060,7 @@ mdoc_an_pre(MDOC_ARGS)
        if (n->sec == SEC_AUTHORS && ! (h->flags & HTML_NOSPLIT))
                h->flags |= HTML_SPLIT;
 
-       print_otag(h, TAG_SPAN, "c", "An");
+       print_otag(h, TAG_SPAN, "cT", "An");
        return 1;
 }
 
@@ -1061,28 +1068,49 @@ static int
 mdoc_cd_pre(MDOC_ARGS)
 {
        synopsis_pre(h, n);
-       print_otag(h, TAG_B, "c", "Cd");
+       print_otag(h, TAG_B, "cT", "Cd");
        return 1;
 }
 
 static int
 mdoc_dv_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_CODE, "c", "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, "c", "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, "c", "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;
 }
 
@@ -1093,12 +1121,12 @@ mdoc_fa_pre(MDOC_ARGS)
        struct tag              *t;
 
        if (n->parent->tok != MDOC_Fo) {
-               print_otag(h, TAG_VAR, "c", "Fa");
+               print_otag(h, TAG_VAR, "cT", "Fa");
                return 1;
        }
 
        for (nn = n->child; nn; nn = nn->next) {
-               t = print_otag(h, TAG_VAR, "c", "Fa");
+               t = print_otag(h, TAG_VAR, "cT", "Fa");
                print_text(h, nn->string);
                print_tagq(h, t);
                if (nn->next) {
@@ -1129,11 +1157,11 @@ mdoc_fd_pre(MDOC_ARGS)
        assert(n->type == ROFFT_TEXT);
 
        if (strcmp(n->string, "#include")) {
-               print_otag(h, TAG_B, "c", "Fd");
+               print_otag(h, TAG_B, "cT", "Fd");
                return 1;
        }
 
-       print_otag(h, TAG_B, "c", "In");
+       print_otag(h, TAG_B, "cT", "In");
        print_text(h, n->string);
 
        if (NULL != (n = n->next)) {
@@ -1147,10 +1175,10 @@ mdoc_fd_pre(MDOC_ARGS)
                        cp = strchr(buf, '\0') - 1;
                        if (cp >= buf && (*cp == '>' || *cp == '"'))
                                *cp = '\0';
-                       t = print_otag(h, TAG_A, "chI", "In", buf);
+                       t = print_otag(h, TAG_A, "cThI", "In", buf);
                        free(buf);
                } else
-                       t = print_otag(h, TAG_A, "c", "In");
+                       t = print_otag(h, TAG_A, "cT", "In");
 
                print_text(h, n->string);
                print_tagq(h, t);
@@ -1177,7 +1205,7 @@ mdoc_vt_pre(MDOC_ARGS)
        } else if (n->type == ROFFT_HEAD)
                return 0;
 
-       print_otag(h, TAG_VAR, "c", "Vt");
+       print_otag(h, TAG_VAR, "cT", "Vt");
        return 1;
 }
 
@@ -1185,7 +1213,7 @@ static int
 mdoc_ft_pre(MDOC_ARGS)
 {
        synopsis_pre(h, n);
-       print_otag(h, TAG_VAR, "c", "Ft");
+       print_otag(h, TAG_VAR, "cT", "Ft");
        return 1;
 }
 
@@ -1206,7 +1234,7 @@ mdoc_fn_pre(MDOC_ARGS)
 
        ep = strchr(sp, ' ');
        if (NULL != ep) {
-               t = print_otag(h, TAG_VAR, "c", "Ft");
+               t = print_otag(h, TAG_VAR, "cT", "Ft");
 
                while (ep) {
                        sz = MIN((int)(ep - sp), BUFSIZ - 1);
@@ -1219,7 +1247,7 @@ mdoc_fn_pre(MDOC_ARGS)
                print_tagq(h, t);
        }
 
-       t = print_otag(h, TAG_B, "c", "Fn");
+       t = print_otag(h, TAG_B, "cT", "Fn");
 
        if (sp)
                print_text(h, sp);
@@ -1232,10 +1260,10 @@ mdoc_fn_pre(MDOC_ARGS)
 
        for (n = n->child->next; n; n = n->next) {
                if (NODE_SYNPRETTY & n->flags)
-                       t = print_otag(h, TAG_VAR, "css?", "Fa",
+                       t = print_otag(h, TAG_VAR, "cTss?", "Fa",
                            "white-space", "nowrap");
                else
-                       t = print_otag(h, TAG_VAR, "c", "Fa");
+                       t = print_otag(h, TAG_VAR, "cT", "Fa");
                print_text(h, n->string);
                print_tagq(h, t);
                if (n->next) {
@@ -1321,7 +1349,7 @@ mdoc_lk_pre(MDOC_ARGS)
 
        assert(n->type == ROFFT_TEXT);
 
-       print_otag(h, TAG_A, "ch", "Lk", n->string);
+       print_otag(h, TAG_A, "cTh", "Lk", n->string);
 
        if (NULL == n->next)
                print_text(h, n->string);
@@ -1342,7 +1370,7 @@ mdoc_mt_pre(MDOC_ARGS)
                assert(n->type == ROFFT_TEXT);
 
                mandoc_asprintf(&cp, "mailto:%s", n->string);
-               t = print_otag(h, TAG_A, "ch", "Mt", cp);
+               t = print_otag(h, TAG_A, "cTh", "Mt", cp);
                print_text(h, n->string);
                print_tagq(h, t);
                free(cp);
@@ -1370,7 +1398,7 @@ mdoc_fo_pre(MDOC_ARGS)
                return 0;
 
        assert(n->child->string);
-       t = print_otag(h, TAG_B, "c", "Fn");
+       t = print_otag(h, TAG_B, "cT", "Fn");
        print_text(h, n->child->string);
        print_tagq(h, t);
        return 0;
@@ -1394,7 +1422,7 @@ mdoc_in_pre(MDOC_ARGS)
        struct tag      *t;
 
        synopsis_pre(h, n);
-       print_otag(h, TAG_B, "c", "In");
+       print_otag(h, TAG_B, "cT", "In");
 
        /*
         * The first argument of the `In' gets special treatment as
@@ -1413,9 +1441,9 @@ mdoc_in_pre(MDOC_ARGS)
                assert(n->type == ROFFT_TEXT);
 
                if (h->base_includes)
-                       t = print_otag(h, TAG_A, "chI", "In", n->string);
+                       t = print_otag(h, TAG_A, "cThI", "In", n->string);
                else
-                       t = print_otag(h, TAG_A, "c", "In");
+                       t = print_otag(h, TAG_A, "cT", "In");
                print_text(h, n->string);
                print_tagq(h, t);
 
@@ -1436,14 +1464,19 @@ mdoc_in_pre(MDOC_ARGS)
 static int
 mdoc_ic_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_B, "c", "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;
 }
 
 static int
 mdoc_va_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_VAR, "c", "Va");
+       print_otag(h, TAG_VAR, "cT", "Va");
        return 1;
 }
 
@@ -1488,7 +1521,12 @@ mdoc_bf_pre(MDOC_ARGS)
 static int
 mdoc_ms_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_B, "c", "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;
 }
 
@@ -1517,28 +1555,38 @@ mdoc_rs_pre(MDOC_ARGS)
        if (n->prev && SEC_SEE_ALSO == n->sec)
                print_paragraph(h);
 
-       print_otag(h, TAG_CITE, "c", "Rs");
+       print_otag(h, TAG_CITE, "cT", "Rs");
        return 1;
 }
 
 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;
 }
 
 static int
 mdoc_sy_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_B, "c", "Sy");
+       print_otag(h, TAG_B, "cT", "Sy");
        return 1;
 }
 
@@ -1548,7 +1596,7 @@ mdoc_lb_pre(MDOC_ARGS)
        if (SEC_LIBRARY == n->sec && NODE_LINE & n->flags && n->prev)
                print_otag(h, TAG_BR, "");
 
-       print_otag(h, TAG_SPAN, "c", "Lb");
+       print_otag(h, TAG_SPAN, "cT", "Lb");
        return 1;
 }