Implement the \\$@ escape sequence (insert all macro arguments,

[mandoc.git] / html.c

diff --git a/html.c b/html.c
index 28f8cf98e04dcb46dce41e15335a2fd068383638..b97f357705e7367bff8f98b3b063d6e16185a105 100644 (file)
--- a/html.c
+++ b/html.c
@@ -1,7 +1,7 @@
-/*     $Id: html.c,v 1.218 2017/07/14 16:28:38 schwarze Exp $ */
+/*     $Id: html.c,v 1.239 2018/08/16 13:54:06 schwarze Exp $ */

 /*
  * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
 /*
  * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>

- * Copyright (c) 2011-2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011-2015, 2017, 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
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -22,6 +22,7 @@
 #include <assert.h>
 #include <ctype.h>
 #include <stdarg.h>
 #include <assert.h>
 #include <ctype.h>
 #include <stdarg.h>

+#include <stddef.h>

 #include <stdio.h>
 #include <stdint.h>
 #include <stdlib.h>
 #include <stdio.h>
 #include <stdint.h>
 #include <stdlib.h>


@@ -29,6 +30,7 @@
 #include <unistd.h>
 
 #include "mandoc_aux.h"
 #include <unistd.h>
 
 #include "mandoc_aux.h"

+#include "mandoc_ohash.h"

 #include "mandoc.h"
 #include "roff.h"
 #include "out.h"
 #include "mandoc.h"
 #include "roff.h"
 #include "out.h"


@@ -59,6 +61,7 @@ static        const struct htmldata htmltags[TAG_MAX] = {
        {"meta",        HTML_NOSTACK | HTML_AUTOCLOSE | HTML_NLALL},
        {"title",       HTML_NLAROUND},
        {"div",         HTML_NLAROUND},
        {"meta",        HTML_NOSTACK | HTML_AUTOCLOSE | HTML_NLALL},
        {"title",       HTML_NLAROUND},
        {"div",         HTML_NLAROUND},

+       {"div",         0},

        {"h1",          HTML_NLAROUND},
        {"h2",          HTML_NLAROUND},
        {"span",        0},
        {"h1",          HTML_NLAROUND},
        {"h2",          HTML_NLAROUND},
        {"span",        0},


@@ -66,8 +69,6 @@ static        const struct htmldata htmltags[TAG_MAX] = {
        {"br",          HTML_NOSTACK | HTML_AUTOCLOSE | HTML_NLALL},
        {"a",           0},
        {"table",       HTML_NLALL | HTML_INDENT},
        {"br",          HTML_NOSTACK | HTML_AUTOCLOSE | HTML_NLALL},
        {"a",           0},
        {"table",       HTML_NLALL | HTML_INDENT},

-       {"colgroup",    HTML_NLALL | HTML_INDENT},
-       {"col",         HTML_NOSTACK | HTML_AUTOCLOSE | HTML_NLALL},

        {"tr",          HTML_NLALL | HTML_INDENT},
        {"td",          HTML_NLAROUND},
        {"li",          HTML_NLAROUND | HTML_INDENT},
        {"tr",          HTML_NLALL | HTML_INDENT},
        {"td",          HTML_NLAROUND},
        {"li",          HTML_NLAROUND | HTML_INDENT},


@@ -103,20 +104,9 @@ static     const struct htmldata htmltags[TAG_MAX] = {
        {"mover",       0},
 };
 
        {"mover",       0},
 };
 

-static const char      *const roffscales[SCALE_MAX] = {
-       "cm", /* SCALE_CM */
-       "in", /* SCALE_IN */
-       "pc", /* SCALE_PC */
-       "pt", /* SCALE_PT */
-       "em", /* SCALE_EM */
-       "em", /* SCALE_MM */
-       "ex", /* SCALE_EN */
-       "ex", /* SCALE_BU */
-       "em", /* SCALE_VS */
-       "ex", /* SCALE_FS */
-};
+/* Avoid duplicate HTML id= attributes. */
+static struct ohash     id_unique;

 
 

-static void     a2width(const char *, struct roffsu *);

 static void     print_byte(struct html *, char);
 static void     print_endword(struct html *);
 static void     print_indent(struct html *);
 static void     print_byte(struct html *, char);
 static void     print_endword(struct html *);
 static void     print_indent(struct html *);


@@ -143,6 +133,8 @@ html_alloc(const struct manoutput *outopts)
        if (outopts->fragment)
                h->oflags |= HTML_FRAGMENT;
 
        if (outopts->fragment)
                h->oflags |= HTML_FRAGMENT;
 

+       mandoc_ohash_init(&id_unique, 4, 0);
+

        return h;
 }
 
        return h;
 }
 


@@ -151,15 +143,22 @@ html_free(void *p)
 {
        struct tag      *tag;
        struct html     *h;
 {
        struct tag      *tag;
        struct html     *h;

+       char            *cp;
+       unsigned int     slot;

 
        h = (struct html *)p;
 
        h = (struct html *)p;

-

        while ((tag = h->tag) != NULL) {
                h->tag = tag->next;
                free(tag);
        }
        while ((tag = h->tag) != NULL) {
                h->tag = tag->next;
                free(tag);
        }

-

        free(h);
        free(h);

+
+       cp = ohash_first(&id_unique, &slot);
+       while (cp != NULL) {
+               free(cp);
+               cp = ohash_next(&id_unique, &slot);
+       }
+       ohash_delete(&id_unique);

 }
 
 void
 }
 
 void


@@ -168,9 +167,14 @@ print_gen_head(struct html *h)
        struct tag      *t;
 
        print_otag(h, TAG_META, "?", "charset", "utf-8");
        struct tag      *t;
 
        print_otag(h, TAG_META, "?", "charset", "utf-8");

+       if (h->style != NULL) {
+               print_otag(h, TAG_LINK, "?h??", "rel", "stylesheet",
+                   h->style, "type", "text/css", "media", "all");
+               return;
+       }

 
        /*
 
        /*

-        * Print a default style-sheet.
+        * Print a minimal embedded style sheet.

         */
 
        t = print_otag(h, TAG_STYLE, "");
         */
 
        t = print_otag(h, TAG_STYLE, "");


@@ -181,11 +185,23 @@ print_gen_head(struct html *h)
        print_text(h, "td.head-vol { text-align: center; }");
        print_endline(h);
        print_text(h, "div.Pp { margin: 1ex 0ex; }");
        print_text(h, "td.head-vol { text-align: center; }");
        print_endline(h);
        print_text(h, "div.Pp { margin: 1ex 0ex; }");

+       print_endline(h);
+       print_text(h, "div.Nd, div.Bf, div.Op { display: inline; }");
+       print_endline(h);
+       print_text(h, "span.Pa, span.Ad { font-style: italic; }");
+       print_endline(h);
+       print_text(h, "span.Ms { font-weight: bold; }");
+       print_endline(h);
+       print_text(h, "dl.Bl-diag ");
+       print_byte(h, '>');
+       print_text(h, " dt { font-weight: bold; }");
+       print_endline(h);
+       print_text(h, "code.Nm, code.Fl, code.Cm, code.Ic, "
+           "code.In, code.Fd, code.Fn,");
+       print_endline(h);
+       print_text(h, "code.Cd { font-weight: bold; "
+           "font-family: inherit; }");

        print_tagq(h, t);
        print_tagq(h, t);

-
-       if (h->style)
-               print_otag(h, TAG_LINK, "?h??", "rel", "stylesheet",
-                   h->style, "type", "text/css", "media", "all");

 }
 
 static void
 }
 
 static void


@@ -239,10 +255,12 @@ print_metaf(struct html *h, enum mandoc_esc deco)
 }
 
 char *
 }
 
 char *

-html_make_id(const struct roff_node *n)
+html_make_id(const struct roff_node *n, int unique)

 {
        const struct roff_node  *nch;
 {
        const struct roff_node  *nch;

-       char                    *buf, *cp;
+       char                    *buf, *bufs, *cp;
+       unsigned int             slot;
+       int                      suffix;

 
        for (nch = n->child; nch != NULL; nch = nch->next)
                if (nch->type != ROFFT_TEXT)
 
        for (nch = n->child; nch != NULL; nch = nch->next)
                if (nch->type != ROFFT_TEXT)


@@ -250,65 +268,46 @@ html_make_id(const struct roff_node *n)
 
        buf = NULL;
        deroff(&buf, n);
 
        buf = NULL;
        deroff(&buf, n);

+       if (buf == NULL)
+               return NULL;

 
 

-       /* http://www.w3.org/TR/html5/dom.html#the-id-attribute */
+       /*
+        * In ID attributes, only use ASCII characters that are
+        * permitted in URL-fragment strings according to the
+        * explicit list at:
+        * https://url.spec.whatwg.org/#url-fragment-string
+        */

 
        for (cp = buf; *cp != '\0'; cp++)
 
        for (cp = buf; *cp != '\0'; cp++)

-               if (*cp == ' ')
+               if (isalnum((unsigned char)*cp) == 0 &&
+                   strchr("!$&'()*+,-./:;=?@_~", *cp) == NULL)

                        *cp = '_';
 
                        *cp = '_';
 

-       return buf;
-}
-
-int
-html_strlen(const char *cp)
-{
-       size_t           rsz;
-       int              skip, sz;
-
-       /*
-        * Account for escaped sequences within string length
-        * calculations.  This follows the logic in term_strlen() as we
-        * must calculate the width of produced strings.
-        * Assume that characters are always width of "1".  This is
-        * hacky, but it gets the job done for approximation of widths.
-        */
-
-       sz = 0;
-       skip = 0;
-       while (1) {
-               rsz = strcspn(cp, "\\");
-               if (rsz) {
-                       cp += rsz;
-                       if (skip) {
-                               skip = 0;
-                               rsz--;
+       if (unique == 0)
+               return buf;
+
+       /* Avoid duplicate HTML id= attributes. */
+
+       bufs = NULL;
+       suffix = 1;
+       slot = ohash_qlookup(&id_unique, buf);
+       cp = ohash_find(&id_unique, slot);
+       if (cp != NULL) {
+               while (cp != NULL) {
+                       free(bufs);
+                       if (++suffix > 127) {
+                               free(buf);
+                               return NULL;

                        }
                        }

-                       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;
+                       mandoc_asprintf(&bufs, "%s_%d", buf, suffix);
+                       slot = ohash_qlookup(&id_unique, bufs);
+                       cp = ohash_find(&id_unique, slot);

                }
                }

+               free(buf);
+               buf = bufs;

        }
        }

-       return sz;
+       ohash_insert(&id_unique, slot, buf);
+       return buf;

 }
 
 static int
 }
 
 static int


@@ -434,6 +433,9 @@ print_encode(struct html *h, const char *p, const char *pend, int norecurse)
                        if (c <= 0)
                                continue;
                        break;
                        if (c <= 0)
                                continue;
                        break;

+               case ESCAPE_DEVICE:
+                       print_word(h, "html");
+                       continue;

                case ESCAPE_BREAK:
                        breakline = 1;
                        continue;
                case ESCAPE_BREAK:
                        breakline = 1;
                        continue;


@@ -490,13 +492,10 @@ struct tag *
 print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
 {
        va_list          ap;
 print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
 {
        va_list          ap;

-       struct roffsu    mysu, *su;
-       char             numbuf[16];

        struct tag      *t;
        const char      *attr;
        char            *arg1, *arg2;
        struct tag      *t;
        const char      *attr;
        char            *arg1, *arg2;

-       double           v;
-       int              i, have_style, tflags;
+       int              tflags;

 
        tflags = htmltags[tag].flags;
 
 
        tflags = htmltags[tag].flags;
 


@@ -536,17 +535,12 @@ print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
 
        va_start(ap, fmt);
 
 
        va_start(ap, fmt);
 

-       have_style = 0;

        while (*fmt != '\0') {
        while (*fmt != '\0') {

-               if (*fmt == 's') {
-                       have_style = 1;
-                       fmt++;
-                       break;
-               }

 
 

-               /* Parse a non-style attribute and its arguments. */
+               /* Parse attributes and arguments. */

 
                arg1 = va_arg(ap, char *);
 
                arg1 = va_arg(ap, char *);

+               arg2 = NULL;

                switch (*fmt++) {
                case 'c':
                        attr = "class";
                switch (*fmt++) {
                case 'c':
                        attr = "class";


@@ -557,6 +551,10 @@ print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
                case 'i':
                        attr = "id";
                        break;
                case 'i':
                        attr = "id";
                        break;

+               case 's':
+                       attr = "style";
+                       arg2 = va_arg(ap, char *);
+                       break;

                case '?':
                        attr = arg1;
                        arg1 = va_arg(ap, char *);
                case '?':
                        attr = arg1;
                        arg1 = va_arg(ap, char *);


@@ -564,13 +562,12 @@ print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
                default:
                        abort();
                }
                default:
                        abort();
                }

-               arg2 = NULL;

                if (*fmt == 'M')
                        arg2 = va_arg(ap, char *);
                if (arg1 == NULL)
                        continue;
 
                if (*fmt == 'M')
                        arg2 = va_arg(ap, char *);
                if (arg1 == NULL)
                        continue;
 

-               /* Print the non-style attributes. */
+               /* Print the attributes. */

 
                print_byte(h, ' ');
                print_word(h, attr);
 
                print_byte(h, ' ');
                print_word(h, attr);


@@ -597,110 +594,19 @@ print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
                        fmt++;
                        break;
                default:
                        fmt++;
                        break;
                default:

-                       print_encode(h, arg1, NULL, 1);
-                       break;
-               }
-               print_byte(h, '"');
-       }
-
-       /* Print out styles. */
-
-       while (*fmt != '\0') {
-               arg1 = NULL;
-               su = NULL;
-
-               /* First letter: input argument type. */
-
-               switch (*fmt++) {
-               case 'h':
-                       i = va_arg(ap, int);
-                       su = &mysu;
-                       SCALE_HS_INIT(su, i);
-                       break;
-               case 's':
-                       arg1 = va_arg(ap, char *);
-                       break;
-               case 'u':
-                       su = va_arg(ap, struct roffsu *);
-                       break;
-               case 'w':
-                       if ((arg2 = va_arg(ap, char *)) == NULL) {
-                               if (*fmt == '+')
-                                       fmt++;
-                               if (*fmt == '-')
-                                       fmt++;
-                               break;
-                       }
-                       su = &mysu;
-                       a2width(arg2, su);
-                       if (*fmt == '+') {
-                               /* Increase to make even bold text fit. */
-                               su->scale *= 1.2;
-                               /* Add padding. */
-                               su->scale += 3.0;
-                               fmt++;
-                       }
-                       if (*fmt == '-') {
-                               su->scale *= -1.0;
-                               fmt++;
+                       if (arg2 == NULL)
+                               print_encode(h, arg1, NULL, 1);
+                       else {
+                               print_word(h, arg1);
+                               print_byte(h, ':');
+                               print_byte(h, ' ');
+                               print_word(h, arg2);
+                               print_byte(h, ';');

                        }
                        break;
                        }
                        break;

-               default:
-                       abort();

                }
                }

-
-               /* Second letter: style name. */
-
-               switch (*fmt++) {
-               case 'h':
-                       attr = "height";
-                       break;
-               case 'i':
-                       attr = "text-indent";
-                       break;
-               case 'l':
-                       attr = "margin-left";
-                       break;
-               case 'w':
-                       attr = "width";
-                       break;
-               case 'W':
-                       attr = "min-width";
-                       break;
-               case '?':
-                       attr = arg1;
-                       arg1 = va_arg(ap, char *);
-                       break;
-               default:
-                       abort();
-               }
-               if (su == NULL && arg1 == NULL)
-                       continue;
-
-               if (have_style == 1)
-                       print_word(h, " style=\"");
-               else
-                       print_byte(h, ' ');
-               print_word(h, attr);
-               print_byte(h, ':');
-               print_byte(h, ' ');
-               if (su != NULL) {
-                       v = su->scale;
-                       if (su->unit == SCALE_MM && (v /= 100.0) == 0.0)
-                               v = 1.0;
-                       else if (su->unit == SCALE_BU)
-                               v /= 24.0;
-                       (void)snprintf(numbuf, sizeof(numbuf), "%.2f", v);
-                       print_word(h, numbuf);
-                       print_word(h, roffscales[su->unit]);
-               } else
-                       print_word(h, arg1);
-               print_byte(h, ';');
-               have_style = 2;
-       }
-       if (have_style == 2)

                print_byte(h, '"');
                print_byte(h, '"');

-
+       }

        va_end(ap);
 
        /* Accommodate for "well-formed" singleton escaping. */
        va_end(ap);
 
        /* Accommodate for "well-formed" singleton escaping. */


@@ -764,6 +670,32 @@ print_gen_decls(struct html *h)
        print_endline(h);
 }
 
        print_endline(h);
 }
 

+void
+print_gen_comment(struct html *h, struct roff_node *n)
+{
+       int      wantblank;
+
+       print_word(h, "<!-- This is an automatically generated file."
+           "  Do not edit.");
+       h->indent = 1;
+       wantblank = 0;
+       while (n != NULL && n->type == ROFFT_COMMENT) {
+               if (strstr(n->string, "-->") == NULL &&
+                   (wantblank || *n->string != '\0')) {
+                       print_endline(h);
+                       print_indent(h);
+                       print_word(h, n->string);
+                       wantblank = *n->string != '\0';
+               }
+               n = n->next;
+       }
+       if (wantblank)
+               print_endline(h);
+       print_word(h, " -->");
+       print_endline(h);
+       h->indent = 0;
+}
+

 void
 print_text(struct html *h, const char *word)
 {
 void
 print_text(struct html *h, const char *word)
 {


@@ -955,21 +887,3 @@ print_word(struct html *h, const char *cp)
        while (*cp != '\0')
                print_byte(h, *cp++);
 }
        while (*cp != '\0')
                print_byte(h, *cp++);
 }

-
-/*
- * Calculate the scaling unit passed in a `-width' argument.  This uses
- * either a native scaling unit (e.g., 1i, 2m) or the string length of
- * the value.
- */
-static void
-a2width(const char *p, struct roffsu *su)
-{
-       const char      *end;
-
-       end = a2roffsu(p, su, SCALE_MAX);
-       if (end == NULL || *end != '\0') {
-               su->unit = SCALE_EN;
-               su->scale = html_strlen(p);
-       } else if (su->scale < 0.0)
-               su->scale = 0.0;
-}