Make the "make depend" maintainer target more convenient

[mandoc.git] / html.c

diff --git a/html.c b/html.c
index 28be30152e7ccf93e12eb70ad7a036be41bedb6f..769acce8d39bb3383afb082a066e3d9a849a83a9 100644 (file)
--- a/html.c
+++ b/html.c
@@ -1,7 +1,7 @@
-/*     $Id: html.c,v 1.262 2020/01/19 18:02:00 schwarze Exp $ */
+/* $Id: html.c,v 1.264 2020/03/13 15:32:28 schwarze Exp $ */
 /*
+ * Copyright (c) 2011-2015, 2017-2020 Ingo Schwarze <schwarze@openbsd.org>
  * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2011-2015, 2017-2019 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,9 @@
  * 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.
+ *
+ * Common functions for mandoc(1) HTML formatters.
+ * For use by individual formatters and by the main program.
  */
 #include "config.h"
 
@@ -88,7 +91,7 @@ static        const struct htmldata htmltags[TAG_MAX] = {
        {"span",        HTML_INPHRASE | HTML_TOPHRASE},
        {"var",         HTML_INPHRASE | HTML_TOPHRASE},
        {"br",          HTML_INPHRASE | HTML_NOSTACK | HTML_NLALL},
-       {"mark",        HTML_INPHRASE | HTML_NOSTACK },
+       {"mark",        HTML_INPHRASE },
        {"math",        HTML_INPHRASE | HTML_NLALL | HTML_INDENT},
        {"mrow",        0},
        {"mi",          0},
@@ -321,6 +324,18 @@ html_fillmode(struct html *h, enum roff_tok want)
        return had;
 }
 
+/*
+ * Allocate a string to be used for the "id=" attribute of an HTML
+ * element and/or as a segment identifier for a URI in an <a> element.
+ * The function may fail and return NULL if the node lacks text data
+ * to create the attribute from.
+ * If the "unique" argument is 0, the caller is responsible for
+ * free(3)ing the returned string after using it.
+ * If the "unique" argument is non-zero, the "id_unique" ohash table
+ * is used for de-duplication and owns the returned string, so the
+ * caller must not free(3) it.  In this case, it will be freed
+ * automatically by html_reset() or html_free().
+ */
 char *
 html_make_id(const struct roff_node *n, int unique)
 {
@@ -329,14 +344,30 @@ html_make_id(const struct roff_node *n, int unique)
        unsigned int             slot;
        int                      suffix;
 
-       for (nch = n->child; nch != NULL; nch = nch->next)
-               if (nch->type != ROFFT_TEXT)
-                       return NULL;
-
-       buf = NULL;
-       deroff(&buf, n);
-       if (buf == NULL)
-               return NULL;
+       if (n->string != NULL)
+               buf = mandoc_strdup(n->string);
+       else {
+               switch (n->tok) {
+               case MDOC_Sh:
+               case MDOC_Ss:
+               case MDOC_Sx:
+               case MAN_SH:
+               case MAN_SS:
+                       for (nch = n->child; nch != NULL; nch = nch->next)
+                               if (nch->type != ROFFT_TEXT)
+                                       return NULL;
+                       buf = NULL;
+                       deroff(&buf, n);
+                       if (buf == NULL)
+                               return NULL;
+                       break;
+               default:
+                       if (n->child->type != ROFFT_TEXT)
+                               return NULL;
+                       buf = mandoc_strdup(n->child->string);
+                       break;
+               }
+       }
 
        /*
         * In ID attributes, only use ASCII characters that are
@@ -736,6 +767,33 @@ print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
        return t;
 }
 
+/*
+ * Print an element with an optional "id=" attribute.
+ * If there is an "id=" attribute, also add a permalink:
+ * outside if it's a phrasing element, or inside otherwise.
+ */
+struct tag *
+print_otag_id(struct html *h, enum htmltag elemtype, const char *cattr,
+    struct roff_node *n)
+{
+       struct tag      *ret, *t;
+       const char      *id;
+
+       ret = NULL;
+       id = NULL;
+       if (n->flags & NODE_ID)
+               id = html_make_id(n, 1);
+       if (id != NULL && htmltags[elemtype].flags & HTML_INPHRASE)
+               ret = print_otag(h, TAG_A, "chR", "permalink", id);
+       t = print_otag(h, elemtype, "ci", cattr, id);
+       if (ret == NULL) {
+               ret = t;
+               if (id != NULL)
+                       print_otag(h, TAG_A, "chR", "permalink", id);
+       }
+       return ret;
+}
+
 static void
 print_ctag(struct html *h, struct tag *tag)
 {