]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_html.c
Only sort the result array if it contains more than one element,
[mandoc.git] / mdoc_html.c
index 65bd8e0359466f8dfef10bf75e8b073bf636bab6..c0a0a6a5697876c5197a357fc834be7f245cd0b7 100644 (file)
@@ -1,7 +1,7 @@
-/*     $Id: mdoc_html.c,v 1.335 2020/02/27 22:28:13 schwarze Exp $ */
+/* $Id: mdoc_html.c,v 1.342 2021/03/30 19:26:20 schwarze Exp $ */
 /*
+ * Copyright (c) 2014-2021 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2014-2020 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
@@ -14,6 +14,8 @@
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ *
+ * HTML formatter for mdoc(7) used by mandoc(1).
  */
 #include "config.h"
 
@@ -47,7 +49,6 @@ struct        mdoc_html_act {
        void            (*post)(MDOC_ARGS);
 };
 
-static char             *cond_id(const struct roff_node *);
 static void              print_mdoc_head(const struct roff_meta *,
                                struct html *);
 static void              print_mdoc_node(MDOC_ARGS);
@@ -72,9 +73,8 @@ static        void              mdoc_bk_post(MDOC_ARGS);
 static int               mdoc_bk_pre(MDOC_ARGS);
 static int               mdoc_bl_pre(MDOC_ARGS);
 static int               mdoc_cd_pre(MDOC_ARGS);
-static int               mdoc_cm_pre(MDOC_ARGS);
+static int               mdoc_code_pre(MDOC_ARGS);
 static int               mdoc_d1_pre(MDOC_ARGS);
-static int               mdoc_dv_pre(MDOC_ARGS);
 static int               mdoc_fa_pre(MDOC_ARGS);
 static int               mdoc_fd_pre(MDOC_ARGS);
 static int               mdoc_fl_pre(MDOC_ARGS);
@@ -83,20 +83,15 @@ static      int               mdoc_ft_pre(MDOC_ARGS);
 static int               mdoc_em_pre(MDOC_ARGS);
 static void              mdoc_eo_post(MDOC_ARGS);
 static int               mdoc_eo_pre(MDOC_ARGS);
-static int               mdoc_er_pre(MDOC_ARGS);
-static int               mdoc_ev_pre(MDOC_ARGS);
 static int               mdoc_ex_pre(MDOC_ARGS);
 static void              mdoc_fo_post(MDOC_ARGS);
 static int               mdoc_fo_pre(MDOC_ARGS);
-static int               mdoc_ic_pre(MDOC_ARGS);
 static int               mdoc_igndelim_pre(MDOC_ARGS);
 static int               mdoc_in_pre(MDOC_ARGS);
 static int               mdoc_it_pre(MDOC_ARGS);
 static int               mdoc_lb_pre(MDOC_ARGS);
-static int               mdoc_li_pre(MDOC_ARGS);
 static int               mdoc_lk_pre(MDOC_ARGS);
 static int               mdoc_mt_pre(MDOC_ARGS);
-static int               mdoc_ms_pre(MDOC_ARGS);
 static int               mdoc_nd_pre(MDOC_ARGS);
 static int               mdoc_nm_pre(MDOC_ARGS);
 static int               mdoc_no_pre(MDOC_ARGS);
@@ -139,19 +134,19 @@ static const struct mdoc_html_act mdoc_html_acts[MDOC_MAX - MDOC_Dd] = {
        {mdoc_ap_pre, NULL}, /* Ap */
        {mdoc_ar_pre, NULL}, /* Ar */
        {mdoc_cd_pre, NULL}, /* Cd */
-       {mdoc_cm_pre, NULL}, /* Cm */
-       {mdoc_dv_pre, NULL}, /* Dv */
-       {mdoc_er_pre, NULL}, /* Er */
-       {mdoc_ev_pre, NULL}, /* Ev */
+       {mdoc_code_pre, NULL}, /* Cm */
+       {mdoc_code_pre, NULL}, /* Dv */
+       {mdoc_code_pre, NULL}, /* Er */
+       {mdoc_code_pre, NULL}, /* Ev */
        {mdoc_ex_pre, NULL}, /* Ex */
        {mdoc_fa_pre, NULL}, /* Fa */
        {mdoc_fd_pre, NULL}, /* Fd */
        {mdoc_fl_pre, NULL}, /* Fl */
        {mdoc_fn_pre, NULL}, /* Fn */
        {mdoc_ft_pre, NULL}, /* Ft */
-       {mdoc_ic_pre, NULL}, /* Ic */
+       {mdoc_code_pre, NULL}, /* Ic */
        {mdoc_in_pre, NULL}, /* In */
-       {mdoc_li_pre, NULL}, /* Li */
+       {mdoc_code_pre, NULL}, /* Li */
        {mdoc_nd_pre, NULL}, /* Nd */
        {mdoc_nm_pre, NULL}, /* Nm */
        {mdoc_quote_pre, mdoc_quote_post}, /* Op */
@@ -192,7 +187,7 @@ static const struct mdoc_html_act mdoc_html_acts[MDOC_MAX - MDOC_Dd] = {
        {mdoc_em_pre, NULL}, /* Em */
        {mdoc_eo_pre, mdoc_eo_post}, /* Eo */
        {mdoc_xx_pre, NULL}, /* Fx */
-       {mdoc_ms_pre, NULL}, /* Ms */
+       {mdoc_no_pre, NULL}, /* Ms */
        {mdoc_no_pre, NULL}, /* No */
        {mdoc_ns_pre, NULL}, /* Ns */
        {mdoc_xx_pre, NULL}, /* Nx */
@@ -354,12 +349,11 @@ print_mdoc_node(MDOC_ARGS)
        if (n->type == ROFFT_COMMENT || n->flags & NODE_NOPRT)
                return;
 
-       if (n->flags & NODE_NOFILL) {
-               html_fillmode(h, ROFF_nf);
-               if (n->flags & NODE_LINE)
-                       print_endline(h);
-       } else
+       if ((n->flags & NODE_NOFILL) == 0)
                html_fillmode(h, ROFF_fi);
+       else if (html_fillmode(h, ROFF_nf) == ROFF_nf &&
+           n->tok != ROFF_fi && n->flags & NODE_LINE)
+               print_endline(h);
 
        child = 1;
        n->flags &= ~NODE_ENDED;
@@ -382,10 +376,13 @@ print_mdoc_node(MDOC_ARGS)
                }
                t = h->tag;
                t->refcnt++;
-               if (NODE_DELIMC & n->flags)
+               if (n->flags & NODE_DELIMC)
                        h->flags |= HTML_NOSPACE;
-               print_text(h, n->string);
-               if (NODE_DELIMO & n->flags)
+               if (n->flags & NODE_HREF)
+                       print_tagged_text(h, n->string, n);
+               else
+                       print_text(h, n->string);
+               if (n->flags & NODE_DELIMO)
                        h->flags |= HTML_NOSPACE;
                break;
        case ROFFT_EQN:
@@ -507,20 +504,11 @@ mdoc_root_pre(const struct roff_meta *meta, struct html *h)
        return 1;
 }
 
-static char *
-cond_id(const struct roff_node *n)
+static int
+mdoc_code_pre(MDOC_ARGS)
 {
-       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, 1);
-       return NULL;
+       print_otag_id(h, TAG_CODE, roff_name[n->tok], n);
+       return 1;
 }
 
 static int
@@ -583,10 +571,7 @@ mdoc_sh_pre(MDOC_ARGS)
                print_otag(h, TAG_SECTION, "c", "Sh");
                break;
        case ROFFT_HEAD:
-               id = html_make_id(n, 1);
-               print_otag(h, TAG_H1, "ci", "Sh", id);
-               if (id != NULL)
-                       print_otag(h, TAG_A, "chR", "permalink", id);
+               print_otag_id(h, TAG_H1, "Sh", n);
                break;
        case ROFFT_BODY:
                if (n->sec == SEC_AUTHORS)
@@ -601,25 +586,19 @@ mdoc_sh_pre(MDOC_ARGS)
 static int
 mdoc_ss_pre(MDOC_ARGS)
 {
-       char    *id;
-
        switch (n->type) {
        case ROFFT_BLOCK:
                html_close_paragraph(h);
                print_otag(h, TAG_SECTION, "c", "Ss");
-               return 1;
+               break;
        case ROFFT_HEAD:
+               print_otag_id(h, TAG_H2, "Ss", n);
                break;
        case ROFFT_BODY:
-               return 1;
+               break;
        default:
                abort();
        }
-
-       id = html_make_id(n, 1);
-       print_otag(h, TAG_H2, "ci", "Ss", id);
-       if (id != NULL)
-               print_otag(h, TAG_A, "chR", "permalink", id);
        return 1;
 }
 
@@ -627,12 +606,8 @@ static int
 mdoc_fl_pre(MDOC_ARGS)
 {
        struct roff_node        *nn;
-       char                    *id;
-
-       if ((id = cond_id(n)) != NULL)
-               print_otag(h, TAG_A, "chR", "permalink", id);
-       print_otag(h, TAG_CODE, "ci", "Fl", id);
 
+       print_otag_id(h, TAG_CODE, "Fl", n);
        print_text(h, "\\-");
        if (n->child != NULL ||
            ((nn = roff_node_next(n)) != NULL &&
@@ -643,17 +618,6 @@ mdoc_fl_pre(MDOC_ARGS)
        return 1;
 }
 
-static int
-mdoc_cm_pre(MDOC_ARGS)
-{
-       char    *id;
-
-       if ((id = cond_id(n)) != NULL)
-               print_otag(h, TAG_A, "chR", "permalink", id);
-       print_otag(h, TAG_CODE, "ci", "Cm", id);
-       return 1;
-}
-
 static int
 mdoc_nd_pre(MDOC_ARGS)
 {
@@ -730,8 +694,10 @@ mdoc_tg_pre(MDOC_ARGS)
 {
        char    *id;
 
-       if ((id = html_make_id(n, 1)) != NULL)
+       if ((id = html_make_id(n, 1)) != NULL) {
                print_tagq(h, print_otag(h, TAG_MARK, "i", id));
+               free(id);
+       }
        return 0;
 }
 
@@ -779,7 +745,7 @@ mdoc_it_pre(MDOC_ARGS)
                case ROFFT_HEAD:
                        return 0;
                case ROFFT_BODY:
-                       print_otag(h, TAG_LI, "");
+                       print_otag_id(h, TAG_LI, NULL, n);
                        break;
                default:
                        break;
@@ -791,7 +757,7 @@ mdoc_it_pre(MDOC_ARGS)
        case LIST_ohang:
                switch (n->type) {
                case ROFFT_HEAD:
-                       print_otag(h, TAG_DT, "");
+                       print_otag_id(h, TAG_DT, NULL, n);
                        break;
                case ROFFT_BODY:
                        print_otag(h, TAG_DD, "");
@@ -803,7 +769,7 @@ mdoc_it_pre(MDOC_ARGS)
        case LIST_tag:
                switch (n->type) {
                case ROFFT_HEAD:
-                       print_otag(h, TAG_DT, "");
+                       print_otag_id(h, TAG_DT, NULL, n);
                        break;
                case ROFFT_BODY:
                        if (n->child == NULL) {
@@ -824,7 +790,7 @@ mdoc_it_pre(MDOC_ARGS)
                        print_otag(h, TAG_TD, "");
                        break;
                default:
-                       print_otag(h, TAG_TR, "");
+                       print_otag_id(h, TAG_TR, NULL, n);
                }
        default:
                break;
@@ -890,8 +856,8 @@ mdoc_bl_pre(MDOC_ARGS)
        case LIST_tag:
                if (bl->offs)
                        print_otag(h, TAG_DIV, "c", "Bd-indent");
-               print_otag(h, TAG_DL, "c", bl->comp ?
-                   "Bl-tag Bl-compact" : "Bl-tag");
+               print_otag_id(h, TAG_DL,
+                   bl->comp ? "Bl-tag Bl-compact" : "Bl-tag", n->body);
                return 1;
        case LIST_column:
                elemtype = TAG_TABLE;
@@ -904,7 +870,7 @@ mdoc_bl_pre(MDOC_ARGS)
                (void)strlcat(cattr, " Bd-indent", sizeof(cattr));
        if (bl->comp)
                (void)strlcat(cattr, " Bl-compact", sizeof(cattr));
-       print_otag(h, elemtype, "c", cattr);
+       print_otag_id(h, elemtype, cattr, n->body);
        return 1;
 }
 
@@ -926,7 +892,7 @@ mdoc_st_pre(MDOC_ARGS)
 static int
 mdoc_em_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_I, "c", "Em");
+       print_otag_id(h, TAG_I, "Em", n);
        return 1;
 }
 
@@ -936,15 +902,15 @@ mdoc_d1_pre(MDOC_ARGS)
        switch (n->type) {
        case ROFFT_BLOCK:
                html_close_paragraph(h);
-               break;
+               return 1;
        case ROFFT_HEAD:
                return 0;
        case ROFFT_BODY:
-               return 1;
+               break;
        default:
                abort();
        }
-       print_otag(h, TAG_DIV, "c", "Bd Bd-indent");
+       print_otag_id(h, TAG_DIV, "Bd Bd-indent", n);
        if (n->tok == MDOC_Dl)
                print_otag(h, TAG_CODE, "c", "Li");
        return 1;
@@ -964,7 +930,7 @@ mdoc_sx_pre(MDOC_ARGS)
 static int
 mdoc_bd_pre(MDOC_ARGS)
 {
-       char                     buf[16];
+       char                     buf[20];
        struct roff_node        *nn;
        int                      comp;
 
@@ -1001,7 +967,10 @@ mdoc_bd_pre(MDOC_ARGS)
            strcmp(n->norm->Bd.offs, "left") != 0)
                (void)strlcat(buf, " Bd-indent", sizeof(buf));
 
-       print_otag(h, TAG_DIV, "c", buf);
+       if (n->norm->Bd.type == DISP_literal)
+               (void)strlcat(buf, " Li", sizeof(buf));
+
+       print_otag_id(h, TAG_DIV, buf, n);
        return 1;
 }
 
@@ -1051,45 +1020,6 @@ mdoc_cd_pre(MDOC_ARGS)
        return 1;
 }
 
-static int
-mdoc_dv_pre(MDOC_ARGS)
-{
-       char    *id;
-
-       if ((id = cond_id(n)) != NULL)
-               print_otag(h, TAG_A, "chR", "permalink", id);
-       print_otag(h, TAG_CODE, "ci", "Dv", id);
-       return 1;
-}
-
-static int
-mdoc_ev_pre(MDOC_ARGS)
-{
-       char    *id;
-
-       if ((id = cond_id(n)) != NULL)
-               print_otag(h, TAG_A, "chR", "permalink", id);
-       print_otag(h, TAG_CODE, "ci", "Ev", id);
-       return 1;
-}
-
-static int
-mdoc_er_pre(MDOC_ARGS)
-{
-       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, 1) : NULL;
-
-       if (id != NULL)
-               print_otag(h, TAG_A, "chR", "permalink", id);
-       print_otag(h, TAG_CODE, "ci", "Er", id);
-       return 1;
-}
-
 static int
 mdoc_fa_pre(MDOC_ARGS)
 {
@@ -1222,7 +1152,7 @@ mdoc_fn_pre(MDOC_ARGS)
                print_tagq(h, t);
        }
 
-       t = print_otag(h, TAG_CODE, "c", "Fn");
+       t = print_otag_id(h, TAG_CODE, "Fn", n);
 
        if (sp)
                print_text(h, sp);
@@ -1285,13 +1215,21 @@ mdoc_skip_pre(MDOC_ARGS)
 static int
 mdoc_pp_pre(MDOC_ARGS)
 {
+       char    *id;
+
        if (n->flags & NODE_NOFILL) {
                print_endline(h);
-               h->col = 1;
-               print_endline(h);
+               if (n->flags & NODE_ID)
+                       mdoc_tg_pre(meta, n, h);
+               else {
+                       h->col = 1;
+                       print_endline(h);
+               }
        } else {
                html_close_paragraph(h);
-               print_otag(h, TAG_P, "c", "Pp");
+               id = n->flags & NODE_ID ? html_make_id(n, 1) : NULL;
+               print_otag(h, TAG_P, "ci", "Pp", id);
+               free(id);
        }
        return 0;
 }
@@ -1341,14 +1279,12 @@ mdoc_mt_pre(MDOC_ARGS)
 
        for (n = n->child; n; n = n->next) {
                assert(n->type == ROFFT_TEXT);
-
                mandoc_asprintf(&cp, "mailto:%s", n->string);
                t = print_otag(h, TAG_A, "ch", "Mt", cp);
                print_text(h, n->string);
                print_tagq(h, t);
                free(cp);
        }
-
        return 0;
 }
 
@@ -1357,30 +1293,30 @@ mdoc_fo_pre(MDOC_ARGS)
 {
        struct tag      *t;
 
-       if (n->type == ROFFT_BODY) {
+       switch (n->type) {
+       case ROFFT_BLOCK:
+               synopsis_pre(h, n);
+               return 1;
+       case ROFFT_HEAD:
+               if (n->child != NULL) {
+                       t = print_otag_id(h, TAG_CODE, "Fn", n);
+                       print_text(h, n->child->string);
+                       print_tagq(h, t);
+               }
+               return 0;
+       case ROFFT_BODY:
                h->flags |= HTML_NOSPACE;
                print_text(h, "(");
                h->flags |= HTML_NOSPACE;
                return 1;
-       } else if (n->type == ROFFT_BLOCK) {
-               synopsis_pre(h, n);
-               return 1;
+       default:
+               abort();
        }
-
-       if (n->child == NULL)
-               return 0;
-
-       assert(n->child->string);
-       t = print_otag(h, TAG_CODE, "c", "Fn");
-       print_text(h, n->child->string);
-       print_tagq(h, t);
-       return 0;
 }
 
 static void
 mdoc_fo_post(MDOC_ARGS)
 {
-
        if (n->type != ROFFT_BODY)
                return;
        h->flags |= HTML_NOSPACE;
@@ -1430,21 +1366,9 @@ mdoc_in_pre(MDOC_ARGS)
                assert(n->type == ROFFT_TEXT);
                print_text(h, n->string);
        }
-
        return 0;
 }
 
-static int
-mdoc_ic_pre(MDOC_ARGS)
-{
-       char    *id;
-
-       if ((id = cond_id(n)) != NULL)
-               print_otag(h, TAG_A, "chR", "permalink", id);
-       print_otag(h, TAG_CODE, "ci", "Ic", id);
-       return 1;
-}
-
 static int
 mdoc_va_pre(MDOC_ARGS)
 {
@@ -1455,7 +1379,6 @@ mdoc_va_pre(MDOC_ARGS)
 static int
 mdoc_ap_pre(MDOC_ARGS)
 {
-
        h->flags |= HTML_NOSPACE;
        print_text(h, "\\(aq");
        h->flags |= HTML_NOSPACE;
@@ -1493,21 +1416,9 @@ mdoc_bf_pre(MDOC_ARGS)
        return 1;
 }
 
-static int
-mdoc_ms_pre(MDOC_ARGS)
-{
-       char *id;
-
-       if ((id = cond_id(n)) != NULL)
-               print_otag(h, TAG_A, "chR", "permalink", id);
-       print_otag(h, TAG_SPAN, "ci", "Ms", id);
-       return 1;
-}
-
 static int
 mdoc_igndelim_pre(MDOC_ARGS)
 {
-
        h->flags |= HTML_IGNDELIM;
        return 1;
 }
@@ -1515,7 +1426,6 @@ mdoc_igndelim_pre(MDOC_ARGS)
 static void
 mdoc_pf_post(MDOC_ARGS)
 {
-
        if ( ! (n->next == NULL || n->next->flags & NODE_LINE))
                h->flags |= HTML_NOSPACE;
 }
@@ -1544,29 +1454,14 @@ mdoc_rs_pre(MDOC_ARGS)
 static int
 mdoc_no_pre(MDOC_ARGS)
 {
-       char *id;
-
-       if ((id = cond_id(n)) != NULL)
-               print_otag(h, TAG_A, "chR", "permalink", id);
-       print_otag(h, TAG_SPAN, "ci", "No", id);
-       return 1;
-}
-
-static int
-mdoc_li_pre(MDOC_ARGS)
-{
-       char    *id;
-
-       if ((id = cond_id(n)) != NULL)
-               print_otag(h, TAG_A, "chR", "permalink", id);
-       print_otag(h, TAG_CODE, "ci", "Li", id);
+       print_otag_id(h, TAG_SPAN, roff_name[n->tok], n);
        return 1;
 }
 
 static int
 mdoc_sy_pre(MDOC_ARGS)
 {
-       print_otag(h, TAG_B, "c", "Sy");
+       print_otag_id(h, TAG_B, "Sy", n);
        return 1;
 }