OpenBSD src/sbin was used as a tool to hunt bugs in mandoc.

[mandoc.git] / html.c

diff --git a/html.c b/html.c
index 887c7de4d8c7769d8f7aaf6106af6194dc0d54ca..24c17fb23a31796569b3355d3e50981f3951efaa 100644 (file)
--- a/html.c
+++ b/html.c
@@ -1,6 +1,6 @@
-/*     $Id: html.c,v 1.87 2009/11/14 12:04:59 kristaps Exp $ */
+/*     $Id: html.c,v 1.110 2010/07/26 22:26:05 kristaps Exp $ */

 /*
 /*

- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>

  *
  * 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


@@ -14,6 +14,10 @@
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */

+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+

 #include <sys/types.h>
 
 #include <assert.h>
 #include <sys/types.h>
 
 #include <assert.h>


@@ -25,45 +29,46 @@
 #include <string.h>
 #include <unistd.h>
 
 #include <string.h>
 #include <unistd.h>
 

+#include "mandoc.h"

 #include "out.h"
 #include "chars.h"
 #include "html.h"
 #include "main.h"
 
 #include "out.h"
 #include "chars.h"
 #include "html.h"
 #include "main.h"
 

-#define        UNCONST(a)      ((void *)(uintptr_t)(const void *)(a))
-
-#define        DOCTYPE         "-//W3C//DTD HTML 4.01//EN"
-#define        DTD             "http://www.w3.org/TR/html4/strict.dtd"
-

 struct htmldata {
        const char       *name;
        int               flags;
 #define        HTML_CLRLINE     (1 << 0)
 #define        HTML_NOSTACK     (1 << 1)
 struct htmldata {
        const char       *name;
        int               flags;
 #define        HTML_CLRLINE     (1 << 0)
 #define        HTML_NOSTACK     (1 << 1)

+#define        HTML_AUTOCLOSE   (1 << 2) /* Tag has auto-closure. */

 };
 
 static const struct htmldata htmltags[TAG_MAX] = {
        {"html",        HTML_CLRLINE}, /* TAG_HTML */
        {"head",        HTML_CLRLINE}, /* TAG_HEAD */
        {"body",        HTML_CLRLINE}, /* TAG_BODY */
 };
 
 static const struct htmldata htmltags[TAG_MAX] = {
        {"html",        HTML_CLRLINE}, /* TAG_HTML */
        {"head",        HTML_CLRLINE}, /* TAG_HEAD */
        {"body",        HTML_CLRLINE}, /* TAG_BODY */

-       {"meta",        HTML_CLRLINE | HTML_NOSTACK}, /* TAG_META */
+       {"meta",        HTML_CLRLINE | HTML_NOSTACK | HTML_AUTOCLOSE}, /* TAG_META */

        {"title",       HTML_CLRLINE}, /* TAG_TITLE */
        {"div",         HTML_CLRLINE}, /* TAG_DIV */
        {"h1",          0}, /* TAG_H1 */
        {"h2",          0}, /* TAG_H2 */
        {"title",       HTML_CLRLINE}, /* TAG_TITLE */
        {"div",         HTML_CLRLINE}, /* TAG_DIV */
        {"h1",          0}, /* TAG_H1 */
        {"h2",          0}, /* TAG_H2 */

-       {"p",           HTML_CLRLINE}, /* TAG_P */

        {"span",        0}, /* TAG_SPAN */
        {"span",        0}, /* TAG_SPAN */

-       {"link",        HTML_CLRLINE | HTML_NOSTACK}, /* TAG_LINK */
-       {"br",          HTML_CLRLINE | HTML_NOSTACK}, /* TAG_LINK */
+       {"link",        HTML_CLRLINE | HTML_NOSTACK | HTML_AUTOCLOSE}, /* TAG_LINK */
+       {"br",          HTML_CLRLINE | HTML_NOSTACK | HTML_AUTOCLOSE}, /* TAG_BR */

        {"a",           0}, /* TAG_A */
        {"table",       HTML_CLRLINE}, /* TAG_TABLE */
        {"a",           0}, /* TAG_A */
        {"table",       HTML_CLRLINE}, /* TAG_TABLE */

-       {"col",         HTML_CLRLINE | HTML_NOSTACK}, /* TAG_COL */
+       {"col",         HTML_CLRLINE | HTML_NOSTACK | HTML_AUTOCLOSE}, /* TAG_COL */

        {"tr",          HTML_CLRLINE}, /* TAG_TR */
        {"td",          HTML_CLRLINE}, /* TAG_TD */
        {"li",          HTML_CLRLINE}, /* TAG_LI */
        {"ul",          HTML_CLRLINE}, /* TAG_UL */
        {"ol",          HTML_CLRLINE}, /* TAG_OL */
        {"tr",          HTML_CLRLINE}, /* TAG_TR */
        {"td",          HTML_CLRLINE}, /* TAG_TD */
        {"li",          HTML_CLRLINE}, /* TAG_LI */
        {"ul",          HTML_CLRLINE}, /* TAG_UL */
        {"ol",          HTML_CLRLINE}, /* TAG_OL */

-       {"base",        HTML_CLRLINE | HTML_NOSTACK}, /* TAG_BASE */
+};
+
+static const char      *const htmlfonts[HTMLFONT_MAX] = {
+       "roman",
+       "bold",
+       "italic"

 };
 
 static const char      *const htmlattrs[ATTR_MAX] = {
 };
 
 static const char      *const htmlattrs[ATTR_MAX] = {


@@ -83,19 +88,21 @@ static      const char      *const htmlattrs[ATTR_MAX] = {
        "summary",
 };
 
        "summary",
 };
 

-#ifdef __linux__
-extern int               getsubopt(char **, char * const *, char **);
-#endif
-
-
-static void              print_spec(struct html *, const char *, size_t);
+static void              print_spec(struct html *, enum roffdeco,
+                               const char *, size_t);

 static void              print_res(struct html *, const char *, size_t);
 static void              print_ctag(struct html *, enum htmltag);
 static void              print_res(struct html *, const char *, size_t);
 static void              print_ctag(struct html *, enum htmltag);

-static int               print_encode(struct html *, const char *);
+static void              print_doctype(struct html *);
+static void              print_xmltype(struct html *);
+static int               print_encode(struct html *, const char *, int);
+static void              print_metaf(struct html *, enum roffdeco);
+static void              print_attr(struct html *, 
+                               const char *, const char *);
+static void             *ml_alloc(char *, enum htmltype);

 
 
 
 

-void *
-html_alloc(char *outopts)
+static void *
+ml_alloc(char *outopts, enum htmltype type)

 {
        struct html     *h;
        const char      *toks[4];
 {
        struct html     *h;
        const char      *toks[4];


@@ -112,6 +119,7 @@ html_alloc(char *outopts)
                exit(EXIT_FAILURE);
        }
 
                exit(EXIT_FAILURE);
        }
 

+       h->type = type;

        h->tags.head = NULL;
        h->ords.head = NULL;
        h->symtab = chars_init(CHARS_HTML);
        h->tags.head = NULL;
        h->ords.head = NULL;
        h->symtab = chars_init(CHARS_HTML);


@@ -134,6 +142,21 @@ html_alloc(char *outopts)
        return(h);
 }
 
        return(h);
 }
 

+void *
+html_alloc(char *outopts)
+{
+
+       return(ml_alloc(outopts, HTML_HTML_4_01_STRICT));
+}
+
+
+void *
+xhtml_alloc(char *outopts)
+{
+
+       return(ml_alloc(outopts, HTML_XHTML_1_0_STRICT));
+}
+

 
 void
 html_free(void *p)
 
 void
 html_free(void *p)


@@ -193,45 +216,103 @@ print_gen_head(struct html *h)
 
 
 static void
 
 
 static void

-print_spec(struct html *h, const char *p, size_t len)
+print_spec(struct html *h, enum roffdeco d, const char *p, size_t len)

 {
 {

+       int              cp;

        const char      *rhs;
        size_t           sz;
 
        const char      *rhs;
        size_t           sz;
 

-       rhs = chars_a2ascii(h->symtab, p, len, &sz);
-
-       if (NULL == rhs) 
+       if ((cp = chars_spec2cp(h->symtab, p, len)) > 0) {
+               printf("&#%d;", cp);

                return;
                return;

-       fwrite(rhs, 1, sz, stdout);
+       } else if (-1 == cp && DECO_SSPECIAL == d) {
+               fwrite(p, 1, len, stdout);
+               return;
+       } else if (-1 == cp)
+               return;
+
+       if (NULL != (rhs = chars_spec2str(h->symtab, p, len, &sz)))
+               fwrite(rhs, 1, sz, stdout);

 }
 
 
 static void
 print_res(struct html *h, const char *p, size_t len)
 {
 }
 
 
 static void
 print_res(struct html *h, const char *p, size_t len)
 {

+       int              cp;

        const char      *rhs;
        size_t           sz;
 
        const char      *rhs;
        size_t           sz;
 

-       rhs = chars_a2res(h->symtab, p, len, &sz);
-
-       if (NULL == rhs)
+       if ((cp = chars_res2cp(h->symtab, p, len)) > 0) {
+               printf("&#%d;", cp);
+               return;
+       } else if (-1 == cp)

                return;
                return;

-       fwrite(rhs, 1, sz, stdout);
+
+       if (NULL != (rhs = chars_res2str(h->symtab, p, len, &sz)))
+               fwrite(rhs, 1, sz, stdout);
+}
+
+
+struct tag *
+print_ofont(struct html *h, enum htmlfont font)
+{
+       struct htmlpair  tag;
+
+       h->metal = h->metac;
+       h->metac = font;
+
+       /* FIXME: DECO_ROMAN should just close out preexisting. */
+
+       if (h->metaf && h->tags.head == h->metaf)
+               print_tagq(h, h->metaf);
+
+       PAIR_CLASS_INIT(&tag, htmlfonts[font]);
+       h->metaf = print_otag(h, TAG_SPAN, 1, &tag);
+       return(h->metaf);
+}
+
+
+static void
+print_metaf(struct html *h, enum roffdeco deco)
+{
+       enum htmlfont    font;
+
+       switch (deco) {
+       case (DECO_PREVIOUS):
+               font = h->metal;
+               break;
+       case (DECO_ITALIC):
+               font = HTMLFONT_ITALIC;
+               break;
+       case (DECO_BOLD):
+               font = HTMLFONT_BOLD;
+               break;
+       case (DECO_ROMAN):
+               font = HTMLFONT_NONE;
+               break;
+       default:
+               abort();
+               /* NOTREACHED */
+       }
+
+       (void)print_ofont(h, font);

 }
 
 
 static int
 }
 
 
 static int

-print_encode(struct html *h, const char *p)
+print_encode(struct html *h, const char *p, int norecurse)

 {
        size_t           sz;
        int              len, nospace;
        const char      *seq;
        enum roffdeco    deco;
 {
        size_t           sz;
        int              len, nospace;
        const char      *seq;
        enum roffdeco    deco;

+       static const char rejs[6] = { '\\', '<', '>', '&', ASCII_HYPH, '\0' };

 
        nospace = 0;
 
        for (; *p; p++) {
 
        nospace = 0;
 
        for (; *p; p++) {

-               sz = strcspn(p, "\\<>&");
+               sz = strcspn(p, rejs);

 
                fwrite(p, 1, sz, stdout);
                p += /* LINTED */
 
                fwrite(p, 1, sz, stdout);
                p += /* LINTED */


@@ -246,6 +327,15 @@ print_encode(struct html *h, const char *p)
                } else if ('&' == *p) {
                        printf("&amp;");
                        continue;
                } else if ('&' == *p) {
                        printf("&amp;");
                        continue;

+               } else if (ASCII_HYPH == *p) {
+                       /*
+                        * Note: "soft hyphens" aren't graphically
+                        * displayed when not breaking the text; we want
+                        * them to be displayed.
+                        */
+                       /*printf("&#173;");*/
+                       putchar('-');
+                       continue;

                } else if ('\0' == *p)
                        break;
 
                } else if ('\0' == *p)
                        break;
 


@@ -256,8 +346,21 @@ print_encode(struct html *h, const char *p)
                case (DECO_RESERVED):
                        print_res(h, seq, sz);
                        break;
                case (DECO_RESERVED):
                        print_res(h, seq, sz);
                        break;

+               case (DECO_SSPECIAL):
+                       /* FALLTHROUGH */

                case (DECO_SPECIAL):
                case (DECO_SPECIAL):

-                       print_spec(h, seq, sz);
+                       print_spec(h, deco, seq, sz);
+                       break;
+               case (DECO_PREVIOUS):
+                       /* FALLTHROUGH */
+               case (DECO_BOLD):
+                       /* FALLTHROUGH */
+               case (DECO_ITALIC):
+                       /* FALLTHROUGH */
+               case (DECO_ROMAN):
+                       if (norecurse)
+                               break;
+                       print_metaf(h, deco);

                        break;
                default:
                        break;
                        break;
                default:
                        break;


@@ -273,6 +376,15 @@ print_encode(struct html *h, const char *p)
 }
 
 
 }
 
 

+static void
+print_attr(struct html *h, const char *key, const char *val)
+{
+       printf(" %s=\"", key);
+       (void)print_encode(h, val, 1);
+       putchar('\"');
+}
+
+

 struct tag *
 print_otag(struct html *h, enum htmltag tag, 
                int sz, const struct htmlpair *p)
 struct tag *
 print_otag(struct html *h, enum htmltag tag, 
                int sz, const struct htmlpair *p)


@@ -280,6 +392,8 @@ print_otag(struct html *h, enum htmltag tag,
        int              i;
        struct tag      *t;
 
        int              i;
        struct tag      *t;
 

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

        if ( ! (HTML_NOSTACK & htmltags[tag].flags)) {
                t = malloc(sizeof(struct tag));
                if (NULL == t) {
        if ( ! (HTML_NOSTACK & htmltags[tag].flags)) {
                t = malloc(sizeof(struct tag));
                if (NULL == t) {


@@ -293,16 +407,46 @@ print_otag(struct html *h, enum htmltag tag,
                t = NULL;
 
        if ( ! (HTML_NOSPACE & h->flags))
                t = NULL;
 
        if ( ! (HTML_NOSPACE & h->flags))

-               if ( ! (HTML_CLRLINE & htmltags[tag].flags))
-                       putchar(' ');
+               if ( ! (HTML_CLRLINE & htmltags[tag].flags)) {
+                       /* Manage keeps! */
+                       if ( ! (HTML_KEEP & h->flags)) {
+                               if (HTML_PREKEEP & h->flags)
+                                       h->flags |= HTML_KEEP;
+                               putchar(' ');
+                       } else
+                               printf("&#160;");
+               }
+
+       if ( ! (h->flags & HTML_NONOSPACE))
+               h->flags &= ~HTML_NOSPACE;
+       else
+               h->flags |= HTML_NOSPACE;
+
+       /* Print out the tag name and attributes. */

 
        printf("<%s", htmltags[tag].name);
 
        printf("<%s", htmltags[tag].name);

-       for (i = 0; i < sz; i++) {
-               printf(" %s=\"", htmlattrs[p[i].key]);
-               assert(p->val);
-               (void)print_encode(h, p[i].val);
-               putchar('\"');
+       for (i = 0; i < sz; i++)
+               print_attr(h, htmlattrs[p[i].key], p[i].val);
+
+       /* Add non-overridable attributes. */
+
+       if (TAG_HTML == tag && HTML_XHTML_1_0_STRICT == h->type) {
+               print_attr(h, "xmlns", "http://www.w3.org/1999/xhtml");
+               print_attr(h, "xml:lang", "en");
+               print_attr(h, "lang", "en");

        }
        }

+
+       /* Accomodate for XML "well-formed" singleton escaping. */
+
+       if (HTML_AUTOCLOSE & htmltags[tag].flags)
+               switch (h->type) {
+               case (HTML_XHTML_1_0_STRICT):
+                       putchar('/');
+                       break;
+               default:
+                       break;
+               }
+

        putchar('>');
 
        h->flags |= HTML_NOSPACE;
        putchar('>');
 
        h->flags |= HTML_NOSPACE;


@@ -310,7 +454,6 @@ print_otag(struct html *h, enum htmltag tag,
 }
 
 
 }
 
 

-/* ARGSUSED */

 static void
 print_ctag(struct html *h, enum htmltag tag)
 {
 static void
 print_ctag(struct html *h, enum htmltag tag)
 {


@@ -323,21 +466,55 @@ print_ctag(struct html *h, enum htmltag tag)
 }
 
 
 }
 
 

-/* ARGSUSED */

 void
 void

-print_gen_doctype(struct html *h)
+print_gen_decls(struct html *h)

 {
 {

-       
-       printf("<!DOCTYPE HTML PUBLIC \"%s\" \"%s\">", DOCTYPE, DTD);
+
+       print_xmltype(h);
+       print_doctype(h);
+}
+
+
+static void
+print_xmltype(struct html *h)
+{
+
+       if (HTML_XHTML_1_0_STRICT == h->type)
+               printf("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
+}
+
+
+static void
+print_doctype(struct html *h)
+{
+       const char      *doctype;
+       const char      *dtd;
+       const char      *name;
+
+       switch (h->type) {
+       case (HTML_HTML_4_01_STRICT):
+               name = "HTML";
+               doctype = "-//W3C//DTD HTML 4.01//EN";
+               dtd = "http://www.w3.org/TR/html4/strict.dtd";
+               break;
+       default:
+               name = "html";
+               doctype = "-//W3C//DTD XHTML 1.0 Strict//EN";
+               dtd = "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";
+               break;
+       }
+
+       printf("<!DOCTYPE %s PUBLIC \"%s\" \"%s\">\n", 
+                       name, doctype, dtd);

 }
 
 
 void
 }
 
 
 void

-print_text(struct html *h, const char *p)
+print_text(struct html *h, const char *word)

 {
 
 {
 

-       if (*p && 0 == *(p + 1))
-               switch (*p) {
+       if (word[0] && '\0' == word[1])
+               switch (word[0]) {

                case('.'):
                        /* FALLTHROUGH */
                case(','):
                case('.'):
                        /* FALLTHROUGH */
                case(','):


@@ -353,8 +530,6 @@ print_text(struct html *h, const char *p)
                case(')'):
                        /* FALLTHROUGH */
                case(']'):
                case(')'):
                        /* FALLTHROUGH */
                case(']'):

-                       /* FALLTHROUGH */
-               case('}'):

                        if ( ! (HTML_IGNDELIM & h->flags))
                                h->flags |= HTML_NOSPACE;
                        break;
                        if ( ! (HTML_IGNDELIM & h->flags))
                                h->flags |= HTML_NOSPACE;
                        break;


@@ -362,20 +537,30 @@ print_text(struct html *h, const char *p)
                        break;
                }
 
                        break;
                }
 

-       if ( ! (h->flags & HTML_NOSPACE))
-               putchar(' ');
-
-       assert(p);
-       if ( ! print_encode(h, p))
-               h->flags &= ~HTML_NOSPACE;
+       if ( ! (HTML_NOSPACE & h->flags)) {
+               /* Manage keeps! */
+               if ( ! (HTML_KEEP & h->flags)) {
+                       if (HTML_PREKEEP & h->flags)
+                               h->flags |= HTML_KEEP;
+                       putchar(' ');
+               } else
+                       printf("&#160;");
+       }

 
 

-       if (*p && 0 == *(p + 1))
-               switch (*p) {
+       assert(word);
+       if ( ! print_encode(h, word, 0))
+               if ( ! (h->flags & HTML_NONOSPACE))
+                       h->flags &= ~HTML_NOSPACE;
+
+       /* 
+        * Note that we don't process the pipe: the parser sees it as
+        * punctuation, but we don't in terms of typography.
+        */
+       if (word[0] && '\0' == word[1])
+               switch (word[0]) {

                case('('):
                        /* FALLTHROUGH */
                case('['):
                case('('):
                        /* FALLTHROUGH */
                case('['):

-                       /* FALLTHROUGH */
-               case('{'):

                        h->flags |= HTML_NOSPACE;
                        break;
                default:
                        h->flags |= HTML_NOSPACE;
                        break;
                default:


@@ -390,6 +575,8 @@ print_tagq(struct html *h, const struct tag *until)
        struct tag      *tag;
 
        while ((tag = h->tags.head) != NULL) {
        struct tag      *tag;
 
        while ((tag = h->tags.head) != NULL) {

+               if (tag == h->metaf)
+                       h->metaf = NULL;

                print_ctag(h, tag->tag);
                h->tags.head = tag->next;
                free(tag);
                print_ctag(h, tag->tag);
                h->tags.head = tag->next;
                free(tag);


@@ -407,6 +594,8 @@ print_stagq(struct html *h, const struct tag *suntil)
        while ((tag = h->tags.head) != NULL) {
                if (suntil && tag == suntil)
                        return;
        while ((tag = h->tags.head) != NULL) {
                if (suntil && tag == suntil)
                        return;

+               if (tag == h->metaf)
+                       h->metaf = NULL;

                print_ctag(h, tag->tag);
                h->tags.head = tag->next;
                free(tag);
                print_ctag(h, tag->tag);
                h->tags.head = tag->next;
                free(tag);


@@ -563,11 +752,11 @@ bufcat_su(struct html *h, const char *p, const struct roffsu *su)
                break;
        }
 
                break;
        }
 

-       if (su->pt)
-               buffmt(h, "%s: %f%s;", p, v, u);
-       else
-               /* LINTED */
-               buffmt(h, "%s: %d%s;", p, (int)v, u);
+       /* 
+        * XXX: the CSS spec isn't clear as to which types accept
+        * integer or real numbers, so we just make them all decimals.
+        */
+       buffmt(h, "%s: %.2f%s;", p, v, u);

 }
 
 
 }