Switch the emitted HTML element from <b> to <code> for the fixed

[mandoc.git] / html.c

diff --git a/html.c b/html.c
index cee98aea7035bcf46ba47562060e9ca153d8976c..00631cd92ae1b1f8a72a89c9550f02002091ff02 100644 (file)
--- a/html.c
+++ b/html.c
@@ -1,7 +1,7 @@
-/*     $Id: html.c,v 1.201 2017/01/25 02:14:43 schwarze Exp $ */
+/*     $Id: html.c,v 1.223 2018/05/08 17:52:55 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


@@ -28,8 +28,9 @@
 #include <string.h>
 #include <unistd.h>
 
 #include <string.h>
 #include <unistd.h>
 

-#include "mandoc.h"

 #include "mandoc_aux.h"
 #include "mandoc_aux.h"

+#include "mandoc.h"
+#include "roff.h"

 #include "out.h"
 #include "html.h"
 #include "manconf.h"
 #include "out.h"
 #include "html.h"
 #include "manconf.h"


@@ -65,7 +66,7 @@ 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},

-       {"tbody",       HTML_NLALL | HTML_INDENT},
+       {"colgroup",    HTML_NLALL | HTML_INDENT},

        {"col",         HTML_NOSTACK | HTML_AUTOCLOSE | HTML_NLALL},
        {"tr",          HTML_NLALL | HTML_INDENT},
        {"td",          HTML_NLAROUND},
        {"col",         HTML_NOSTACK | HTML_AUTOCLOSE | HTML_NLALL},
        {"tr",          HTML_NLALL | HTML_INDENT},
        {"td",          HTML_NLAROUND},


@@ -76,6 +77,8 @@ static        const struct htmldata htmltags[TAG_MAX] = {
        {"dt",          HTML_NLAROUND},
        {"dd",          HTML_NLAROUND | HTML_INDENT},
        {"pre",         HTML_NLALL | HTML_NOINDENT},
        {"dt",          HTML_NLAROUND},
        {"dd",          HTML_NLAROUND | HTML_INDENT},
        {"pre",         HTML_NLALL | HTML_NOINDENT},

+       {"var",         0},
+       {"cite",        0},

        {"b",           0},
        {"i",           0},
        {"code",        0},
        {"b",           0},
        {"i",           0},
        {"code",        0},


@@ -84,6 +87,7 @@ static        const struct htmldata htmltags[TAG_MAX] = {
        {"math",        HTML_NLALL | HTML_INDENT},
        {"mrow",        0},
        {"mi",          0},
        {"math",        HTML_NLALL | HTML_INDENT},
        {"mrow",        0},
        {"mi",          0},

+       {"mn",          0},

        {"mo",          0},
        {"msup",        0},
        {"msub",        0},
        {"mo",          0},
        {"msup",        0},
        {"msub",        0},


@@ -114,7 +118,6 @@ static      const char      *const roffscales[SCALE_MAX] = {
 
 static void     a2width(const char *, struct roffsu *);
 static void     print_byte(struct html *, char);
 
 static void     a2width(const char *, struct roffsu *);
 static void     print_byte(struct html *, char);

-static void     print_endline(struct html *);

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


@@ -133,7 +136,7 @@ html_alloc(const struct manoutput *outopts)
 
        h = mandoc_calloc(1, sizeof(struct html));
 
 
        h = mandoc_calloc(1, sizeof(struct html));
 

-       h->tags.head = NULL;
+       h->tag = NULL;

        h->style = outopts->style;
        h->base_man = outopts->man;
        h->base_includes = outopts->includes;
        h->style = outopts->style;
        h->base_man = outopts->man;
        h->base_includes = outopts->includes;


@@ -151,8 +154,8 @@ html_free(void *p)
 
        h = (struct html *)p;
 
 
        h = (struct html *)p;
 

-       while ((tag = h->tags.head) != NULL) {
-               h->tags.head = tag->next;
+       while ((tag = h->tag) != NULL) {
+               h->tag = tag->next;

                free(tag);
        }
 
                free(tag);
        }
 


@@ -165,9 +168,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, "");


@@ -178,11 +186,13 @@ 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, "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


@@ -235,6 +245,30 @@ print_metaf(struct html *h, enum mandoc_esc deco)
        }
 }
 
        }
 }
 

+char *
+html_make_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);
+       if (buf == NULL)
+               return NULL;
+
+       /* http://www.w3.org/TR/html5/dom.html#the-id-attribute */
+
+       for (cp = buf; *cp != '\0'; cp++)
+               if (*cp == ' ')
+                       *cp = '_';
+
+       return buf;
+}
+

 int
 html_strlen(const char *cp)
 {
 int
 html_strlen(const char *cp)
 {


@@ -321,16 +355,18 @@ static int
 print_encode(struct html *h, const char *p, const char *pend, int norecurse)
 {
        char             numbuf[16];
 print_encode(struct html *h, const char *p, const char *pend, int norecurse)
 {
        char             numbuf[16];

-       size_t           sz;
-       int              c, len, nospace;
+       struct tag      *t;

        const char      *seq;
        const char      *seq;

+       size_t           sz;
+       int              c, len, breakline, nospace;

        enum mandoc_esc  esc;
        enum mandoc_esc  esc;

-       static const char rejs[9] = { '\\', '<', '>', '&', '"',
+       static const char rejs[10] = { ' ', '\\', '<', '>', '&', '"',

                ASCII_NBRSP, ASCII_HYPH, ASCII_BREAK, '\0' };
 
        if (pend == NULL)
                pend = strchr(p, '\0');
 
                ASCII_NBRSP, ASCII_HYPH, ASCII_BREAK, '\0' };
 
        if (pend == NULL)
                pend = strchr(p, '\0');
 

+       breakline = 0;

        nospace = 0;
 
        while (p < pend) {
        nospace = 0;
 
        while (p < pend) {


@@ -341,14 +377,28 @@ print_encode(struct html *h, const char *p, const char *pend, int norecurse)
                }
 
                for (sz = strcspn(p, rejs); sz-- && p < pend; p++)
                }
 
                for (sz = strcspn(p, rejs); sz-- && p < pend; p++)

-                       if (*p == ' ')
-                               print_endword(h);
-                       else
-                               print_byte(h, *p);
+                       print_byte(h, *p);
+
+               if (breakline &&
+                   (p >= pend || *p == ' ' || *p == ASCII_NBRSP)) {
+                       t = print_otag(h, TAG_DIV, "");
+                       print_text(h, "\\~");
+                       print_tagq(h, t);
+                       breakline = 0;
+                       while (p < pend && (*p == ' ' || *p == ASCII_NBRSP))
+                               p++;
+                       continue;
+               }

 
                if (p >= pend)
                        break;
 
 
                if (p >= pend)
                        break;
 

+               if (*p == ' ') {
+                       print_endword(h);
+                       p++;
+                       continue;
+               }
+

                if (print_escape(h, *p++))
                        continue;
 
                if (print_escape(h, *p++))
                        continue;
 


@@ -393,6 +443,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_BREAK:
+                       breakline = 1;
+                       continue;

                case ESCAPE_NOSPACE:
                        if ('\0' == *p)
                                nospace = 1;
                case ESCAPE_NOSPACE:
                        if ('\0' == *p)
                                nospace = 1;


@@ -409,7 +462,7 @@ print_encode(struct html *h, const char *p, const char *pend, int norecurse)
                    (c > 0x7E && c < 0xA0))
                        c = 0xFFFD;
                if (c > 0x7E) {
                    (c > 0x7E && c < 0xA0))
                        c = 0xFFFD;
                if (c > 0x7E) {

-                       (void)snprintf(numbuf, sizeof(numbuf), "&#%d;", c);
+                       (void)snprintf(numbuf, sizeof(numbuf), "&#x%.4X;", c);

                        print_word(h, numbuf);
                } else if (print_escape(h, c) == 0)
                        print_byte(h, c);
                        print_word(h, numbuf);
                } else if (print_escape(h, c) == 0)
                        print_byte(h, c);


@@ -450,19 +503,19 @@ print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
        char             numbuf[16];
        struct tag      *t;
        const char      *attr;
        char             numbuf[16];
        struct tag      *t;
        const char      *attr;

-       char            *s;
+       char            *arg1, *arg2;

        double           v;
        int              i, have_style, tflags;
 
        tflags = htmltags[tag].flags;
 
        double           v;
        int              i, have_style, tflags;
 
        tflags = htmltags[tag].flags;
 

-       /* Push this tags onto the stack of open scopes. */
+       /* Push this tag onto the stack of open scopes. */

 
        if ((tflags & HTML_NOSTACK) == 0) {
                t = mandoc_malloc(sizeof(struct tag));
                t->tag = tag;
 
        if ((tflags & HTML_NOSTACK) == 0) {
                t = mandoc_malloc(sizeof(struct tag));
                t->tag = tag;

-               t->next = h->tags.head;
-               h->tags.head = t;
+               t->next = h->tag;
+               h->tag = t;

        } else
                t = NULL;
 
        } else
                t = NULL;
 


@@ -472,7 +525,7 @@ print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
                print_indent(h);
        else if ((h->flags & HTML_NOSPACE) == 0) {
                if (h->flags & HTML_KEEP)
                print_indent(h);
        else if ((h->flags & HTML_NOSPACE) == 0) {
                if (h->flags & HTML_KEEP)

-                       print_word(h, "&#160;");
+                       print_word(h, "&#x00A0;");

                else {
                        if (h->flags & HTML_PREKEEP)
                                h->flags |= HTML_KEEP;
                else {
                        if (h->flags & HTML_PREKEEP)
                                h->flags |= HTML_KEEP;


@@ -495,12 +548,14 @@ print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
        have_style = 0;
        while (*fmt != '\0') {
                if (*fmt == 's') {
        have_style = 0;
        while (*fmt != '\0') {
                if (*fmt == 's') {

-                       print_word(h, " style=\"");

                        have_style = 1;
                        fmt++;
                        break;
                }
                        have_style = 1;
                        fmt++;
                        break;
                }

-               s = va_arg(ap, char *);
+
+               /* Parse a non-style attribute and its arguments. */
+
+               arg1 = va_arg(ap, char *);

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


@@ -512,31 +567,46 @@ print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
                        attr = "id";
                        break;
                case '?':
                        attr = "id";
                        break;
                case '?':

-                       attr = s;
-                       s = va_arg(ap, char *);
+                       attr = arg1;
+                       arg1 = va_arg(ap, char *);

                        break;
                default:
                        abort();
                }
                        break;
                default:
                        abort();
                }

+               arg2 = NULL;
+               if (*fmt == 'M')
+                       arg2 = va_arg(ap, char *);
+               if (arg1 == NULL)
+                       continue;
+
+               /* Print the non-style attributes. */
+

                print_byte(h, ' ');
                print_word(h, attr);
                print_byte(h, '=');
                print_byte(h, '"');
                switch (*fmt) {
                print_byte(h, ' ');
                print_word(h, attr);
                print_byte(h, '=');
                print_byte(h, '"');
                switch (*fmt) {

-               case 'M':
-                       print_href(h, s, va_arg(ap, char *), 1);
+               case 'I':
+                       print_href(h, arg1, NULL, 0);

                        fmt++;
                        break;
                        fmt++;
                        break;

-               case 'I':
-                       print_href(h, s, NULL, 0);
+               case 'M':
+                       print_href(h, arg1, arg2, 1);

                        fmt++;
                        break;
                case 'R':
                        print_byte(h, '#');
                        fmt++;
                        break;
                case 'R':
                        print_byte(h, '#');

+                       print_encode(h, arg1, NULL, 1);
+                       fmt++;
+                       break;
+               case 'T':
+                       print_encode(h, arg1, NULL, 1);
+                       print_word(h, "\" title=\"");
+                       print_encode(h, arg1, NULL, 1);

                        fmt++;
                        fmt++;

-                       /* FALLTHROUGH */
+                       break;

                default:
                default:

-                       print_encode(h, s, NULL, 1);
+                       print_encode(h, arg1, NULL, 1);

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


@@ -544,33 +614,49 @@ print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
 
        /* Print out styles. */
 
 
        /* Print out styles. */
 

-       s = NULL;
-       su = &mysu;

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

+               arg1 = NULL;
+               su = NULL;

 
                /* First letter: input argument type. */
 
                switch (*fmt++) {
                case 'h':
                        i = va_arg(ap, int);
 
                /* First letter: input argument type. */
 
                switch (*fmt++) {
                case 'h':
                        i = va_arg(ap, int);

+                       su = &mysu;

                        SCALE_HS_INIT(su, i);
                        break;
                case 's':
                        SCALE_HS_INIT(su, i);
                        break;
                case 's':

-                       s = va_arg(ap, char *);
+                       arg1 = va_arg(ap, char *);

                        break;
                case 'u':
                        su = va_arg(ap, struct roffsu *);
                        break;
                        break;
                case 'u':
                        su = va_arg(ap, struct roffsu *);
                        break;

-               case 'v':
-                       i = va_arg(ap, int);
-                       SCALE_VS_INIT(su, i);
-                       break;

                case 'w':
                case 'w':

-               case 'W':
-                       s = va_arg(ap, char *);
-                       a2width(s, su);
-                       if (fmt[-1] == 'W')
-                               su->scale *= -1.0;
+                       if ((arg2 = va_arg(ap, char *)) != NULL) {
+                               su = &mysu;
+                               a2width(arg2, su);
+                       }
+                       if (*fmt == '*') {
+                               if (su != NULL && su->unit == SCALE_EN &&
+                                   su->scale > 5.9 && su->scale < 6.1)
+                                       su = NULL;
+                               fmt++;
+                       }
+                       if (*fmt == '+') {
+                               if (su != NULL) {
+                                       /* Make even bold text fit. */
+                                       su->scale *= 1.2;
+                                       /* Add padding. */
+                                       su->scale += 3.0;
+                               }
+                               fmt++;
+                       }
+                       if (*fmt == '-') {
+                               if (su != NULL)
+                                       su->scale *= -1.0;
+                               fmt++;
+                       }

                        break;
                default:
                        abort();
                        break;
                default:
                        abort();


@@ -579,9 +665,6 @@ print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
                /* Second letter: style name. */
 
                switch (*fmt++) {
                /* Second letter: style name. */
 
                switch (*fmt++) {

-               case 'b':
-                       attr = "margin-bottom";
-                       break;

                case 'h':
                        attr = "height";
                        break;
                case 'h':
                        attr = "height";
                        break;


@@ -591,9 +674,6 @@ print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
                case 'l':
                        attr = "margin-left";
                        break;
                case 'l':
                        attr = "margin-left";
                        break;

-               case 't':
-                       attr = "margin-top";
-                       break;

                case 'w':
                        attr = "width";
                        break;
                case 'w':
                        attr = "width";
                        break;


@@ -601,33 +681,37 @@ print_otag(struct html *h, enum htmltag tag, const char *fmt, ...)
                        attr = "min-width";
                        break;
                case '?':
                        attr = "min-width";
                        break;
                case '?':

-                       print_word(h, s);
-                       print_byte(h, ':');
-                       print_byte(h, ' ');
-                       print_word(h, va_arg(ap, char *));
-                       print_byte(h, ';');
-                       if (*fmt != '\0')
-                               print_byte(h, ' ');
-                       continue;
+                       attr = arg1;
+                       arg1 = va_arg(ap, char *);
+                       break;

                default:
                        abort();
                }
                default:
                        abort();
                }

-               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;
+               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, ' ');
                print_word(h, attr);
                print_byte(h, ':');
                print_byte(h, ' ');

-               (void)snprintf(numbuf, sizeof(numbuf), "%.2f", v);
-               print_word(h, numbuf);
-               print_word(h, roffscales[su->unit]);
+               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, ';');
                print_byte(h, ';');

-               if (*fmt != '\0')
-                       print_byte(h, ' ');
+               have_style = 2;

        }
        }

-       if (have_style)
+       if (have_style == 2)

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


@@ -682,7 +766,7 @@ print_ctag(struct html *h, struct tag *tag)
        if (tflags & HTML_NLAFTER)
                print_endline(h);
 
        if (tflags & HTML_NLAFTER)
                print_endline(h);
 

-       h->tags.head = tag->next;
+       h->tag = tag->next;

        free(tag);
 }
 
        free(tag);
 }
 


@@ -693,6 +777,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)
 {


@@ -702,7 +812,7 @@ print_text(struct html *h, const char *word)
                                h->flags |= HTML_KEEP;
                        print_endword(h);
                } else
                                h->flags |= HTML_KEEP;
                        print_endword(h);
                } else

-                       print_word(h, "&#160;");
+                       print_word(h, "&#x00A0;");

        }
 
        assert(NULL == h->metaf);
        }
 
        assert(NULL == h->metaf);


@@ -743,7 +853,7 @@ print_tagq(struct html *h, const struct tag *until)
 {
        struct tag      *tag;
 
 {
        struct tag      *tag;
 

-       while ((tag = h->tags.head) != NULL) {
+       while ((tag = h->tag) != NULL) {

                print_ctag(h, tag);
                if (until && tag == until)
                        return;
                print_ctag(h, tag);
                if (until && tag == until)
                        return;


@@ -755,7 +865,7 @@ print_stagq(struct html *h, const struct tag *suntil)
 {
        struct tag      *tag;
 
 {
        struct tag      *tag;
 

-       while ((tag = h->tags.head) != NULL) {
+       while ((tag = h->tag) != NULL) {

                if (suntil && tag == suntil)
                        return;
                print_ctag(h, tag);
                if (suntil && tag == suntil)
                        return;
                print_ctag(h, tag);


@@ -812,7 +922,7 @@ print_byte(struct html *h, char c)
  * If something was printed on the current output line, end it.
  * Not to be called right after print_indent().
  */
  * If something was printed on the current output line, end it.
  * Not to be called right after print_indent().
  */

-static void
+void

 print_endline(struct html *h)
 {
        if (h->col == 0)
 print_endline(struct html *h)
 {
        if (h->col == 0)


@@ -893,7 +1003,10 @@ print_word(struct html *h, const char *cp)
 static void
 a2width(const char *p, struct roffsu *su)
 {
 static void
 a2width(const char *p, struct roffsu *su)
 {

-       if (a2roffsu(p, su, SCALE_MAX) < 2) {
+       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->unit = SCALE_EN;
                su->scale = html_strlen(p);
        } else if (su->scale < 0.0)