]> git.cameronkatri.com Git - mandoc.git/blobdiff - html.c
Note that "^" needs an empty cell, while "s" does not.
[mandoc.git] / html.c
diff --git a/html.c b/html.c
index ee90cda1375bf1fff25f38d12a10fe503496c8b6..70403ff77e0d5218e26b01e522ec341fb0b91af1 100644 (file)
--- a/html.c
+++ b/html.c
@@ -1,6 +1,6 @@
-/*     $Id: html.c,v 1.81 2009/11/05 10:16:01 kristaps Exp $ */
+/*     $Id: html.c,v 1.124 2010/12/27 21:41:05 schwarze 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
  * 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 <string.h>
 #include <unistd.h>
 
+#include "mandoc.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)
+#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 */
-       {"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 */
-       {"p",           HTML_CLRLINE}, /* TAG_P */
        {"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 */
-       {"col",         HTML_CLRLINE | HTML_NOSTACK}, /* TAG_COL */
+       {"tbody",       HTML_CLRLINE}, /* TAG_TBODY */
+       {"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 */
-       {"base",        HTML_CLRLINE | HTML_NOSTACK}, /* TAG_BASE */
+       {"dl",          HTML_CLRLINE}, /* TAG_DL */
+       {"dt",          HTML_CLRLINE}, /* TAG_DT */
+       {"dd",          HTML_CLRLINE}, /* TAG_DD */
+       {"blockquote",  HTML_CLRLINE}, /* TAG_BLOCKQUOTE */
+       {"p",           HTML_CLRLINE | HTML_NOSTACK | HTML_AUTOCLOSE}, /* TAG_P */
+       {"pre",         HTML_CLRLINE }, /* TAG_PRE */
+       {"b",           0 }, /* TAG_B */
+       {"i",           0 }, /* TAG_I */
+       {"code",        0 }, /* TAG_CODE */
+       {"small",       0 }, /* TAG_SMALL */
 };
 
-static const char       *const htmlattrs[ATTR_MAX] = {
-       "http-equiv",
-       "content",
-       "name",
-       "rel",
-       "href",
-       "type",
-       "media",
-       "class",
-       "style",
-       "width",
-       "valign",
-       "target",
-       "id",
-       "summary",
+static const char      *const htmlattrs[ATTR_MAX] = {
+       "http-equiv", /* ATTR_HTTPEQUIV */
+       "content", /* ATTR_CONTENT */
+       "name", /* ATTR_NAME */
+       "rel", /* ATTR_REL */
+       "href", /* ATTR_HREF */
+       "type", /* ATTR_TYPE */
+       "media", /* ATTR_MEDIA */
+       "class", /* ATTR_CLASS */
+       "style", /* ATTR_STYLE */
+       "width", /* ATTR_WIDTH */
+       "id", /* ATTR_ID */
+       "summary", /* ATTR_SUMMARY */
+       "align", /* ATTR_ALIGN */
 };
 
-#ifdef __linux__
-extern int               getsubopt(char **, char * const *, char **);
-#endif
-
-void *
-html_alloc(char *outopts)
+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_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);
+
+
+static void *
+ml_alloc(char *outopts, enum htmltype type)
 {
        struct html     *h;
        const char      *toks[4];
@@ -102,11 +120,11 @@ html_alloc(char *outopts)
        h = calloc(1, sizeof(struct html));
        if (NULL == h) {
                perror(NULL);
-               exit(EXIT_FAILURE);
+               exit((int)MANDOCLEVEL_SYSERR);
        }
 
+       h->type = type;
        h->tags.head = NULL;
-       h->ords.head = NULL;
        h->symtab = chars_init(CHARS_HTML);
 
        while (outopts && *outopts)
@@ -127,21 +145,30 @@ html_alloc(char *outopts)
        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)
 {
        struct tag      *tag;
-       struct ord      *ord;
        struct html     *h;
 
        h = (struct html *)p;
 
-       while ((ord = h->ords.head) != NULL) { 
-               h->ords.head = ord->next;
-               free(ord);
-       }
-
        while ((tag = h->tags.head) != NULL) {
                h->tags.head = tag->next;       
                free(tag);
@@ -186,156 +213,164 @@ print_gen_head(struct html *h)
 
 
 static void
-print_spec(struct html *h, const char *p, int len)
+print_spec(struct html *h, enum roffdeco d, const char *p, size_t len)
 {
+       int              cp;
        const char      *rhs;
        size_t           sz;
 
-       rhs = chars_a2ascii(h->symtab, p, (size_t)len, &sz);
-
-       if (NULL == rhs) 
+       if ((cp = chars_spec2cp(h->symtab, p, len)) > 0) {
+               printf("&#%d;", cp);
+               return;
+       } else if (-1 == cp && DECO_SSPECIAL == d) {
+               fwrite(p, 1, len, stdout);
                return;
-       fwrite(rhs, 1, sz, stdout);
+       } 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, int len)
+print_res(struct html *h, const char *p, size_t len)
 {
+       int              cp;
        const char      *rhs;
        size_t           sz;
 
-       rhs = chars_a2res(h->symtab, p, (size_t)len, &sz);
-
-       if (NULL == rhs)
+       if ((cp = chars_res2cp(h->symtab, p, len)) > 0) {
+               printf("&#%d;", cp);
                return;
-       fwrite(rhs, 1, sz, stdout);
+       } else if (-1 == cp)
+               return;
+
+       if (NULL != (rhs = chars_res2str(h->symtab, p, len, &sz)))
+               fwrite(rhs, 1, sz, stdout);
 }
 
 
 static void
-print_escape(struct html *h, const char **p)
+print_metaf(struct html *h, enum roffdeco deco)
 {
-       int              j, type;
-       const char      *wp;
-
-       wp = *p;
-       type = 1;
-
-       if (0 == *(++wp)) {
-               *p = wp;
-               return;
-       }
-
-       if ('(' == *wp) {
-               wp++;
-               if (0 == *wp || 0 == *(wp + 1)) {
-                       *p = 0 == *wp ? wp : wp + 1;
-                       return;
-               }
-
-               print_spec(h, wp, 2);
-               *p = ++wp;
-               return;
+       enum htmlfont    font;
 
-       } else if ('*' == *wp) {
-               if (0 == *(++wp)) {
-                       *p = wp;
-                       return;
-               }
-
-               switch (*wp) {
-               case ('('):
-                       wp++;
-                       if (0 == *wp || 0 == *(wp + 1)) {
-                               *p = 0 == *wp ? wp : wp + 1;
-                               return;
-                       }
-
-                       print_res(h, wp, 2);
-                       *p = ++wp;
-                       return;
-               case ('['):
-                       type = 0;
-                       break;
-               default:
-                       print_res(h, wp, 1);
-                       *p = wp;
-                       return;
-               }
-       
-       } else if ('f' == *wp) {
-               if (0 == *(++wp)) {
-                       *p = wp;
-                       return;
-               }
-
-               /* 
-                * These aren't supported, as they're symmetry-breaking
-                * constructs that don't play well with hierarchical
-                * mark-up.  Consider:
-                *
-                * \fBHello.
-                * .PP
-                * World.
-                *
-                * The style started before "Hello" wouldn't be able to
-                * propogate into the next `PP' because we'd exit the
-                * current paragraph's scope.
-                */
-
-               *p = wp;
-               return;
-
-       } else if ('[' != *wp) {
-               print_spec(h, wp, 1);
-               *p = wp;
-               return;
+       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 */
        }
 
-       wp++;
-       for (j = 0; *wp && ']' != *wp; wp++, j++)
-               /* Loop... */ ;
-
-       if (0 == *wp) {
-               *p = wp;
-               return;
+       if (h->metaf) {
+               print_tagq(h, h->metaf);
+               h->metaf = NULL;
        }
 
-       if (type)
-               print_spec(h, wp - j, j);
-       else
-               print_res(h, wp - j, j);
+       h->metal = h->metac;
+       h->metac = font;
 
-       *p = wp;
+       if (HTMLFONT_NONE != font)
+               h->metaf = HTMLFONT_BOLD == font ?
+                       print_otag(h, TAG_B, 0, NULL) :
+                       print_otag(h, TAG_I, 0, NULL);
 }
 
 
-static void
-print_encode(struct html *h, const char *p)
+static int
+print_encode(struct html *h, const char *p, int norecurse)
 {
        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++) {
-               sz = strcspn(p, "\\<>&");
+               sz = strcspn(p, rejs);
 
                fwrite(p, 1, sz, stdout);
                p += /* LINTED */
                        sz;
 
-               if ('\\' == *p) {
-                       print_escape(h, &p);
+               if ('<' == *p) {
+                       printf("&lt;");
+                       continue;
+               } else if ('>' == *p) {
+                       printf("&gt;");
+                       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;
 
-               if ('<' == *p)
-                       printf("&lt;");
-               else if ('>' == *p)
-                       printf("&gt;");
-               else if ('&' == *p)
-                       printf("&amp;");
+               seq = ++p;
+               len = a2roffdeco(&deco, &seq, &sz);
+
+               switch (deco) {
+               case (DECO_RESERVED):
+                       print_res(h, seq, sz);
+                       break;
+               case (DECO_SSPECIAL):
+                       /* FALLTHROUGH */
+               case (DECO_SPECIAL):
+                       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;
+               }
+
+               p += len - 1;
+
+               if (DECO_NOSPACE == deco && '\0' == *(p + 1))
+                       nospace = 1;
        }
+
+       return(nospace);
+}
+
+
+static void
+print_attr(struct html *h, const char *key, const char *val)
+{
+       printf(" %s=\"", key);
+       (void)print_encode(h, val, 1);
+       putchar('\"');
 }
 
 
@@ -346,11 +381,13 @@ print_otag(struct html *h, enum htmltag tag,
        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) {
                        perror(NULL);
-                       exit(EXIT_FAILURE);
+                       exit((int)MANDOCLEVEL_SYSERR);
                }
                t->tag = tag;
                t->next = h->tags.head;
@@ -359,29 +396,57 @@ print_otag(struct html *h, enum htmltag tag,
                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);
-       for (i = 0; i < sz; i++) {
-               printf(" %s=\"", htmlattrs[p[i].key]);
-               assert(p->val);
-               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;
-       if (HTML_CLRLINE & htmltags[tag].flags)
-               h->flags |= HTML_NEWLINE;
-       else
-               h->flags &= ~HTML_NEWLINE;
+
+       if ((HTML_AUTOCLOSE | HTML_CLRLINE) & htmltags[tag].flags)
+               putchar('\n');
 
        return(t);
 }
 
 
-/* ARGSUSED */
 static void
 print_ctag(struct html *h, enum htmltag tag)
 {
@@ -389,28 +454,60 @@ print_ctag(struct html *h, enum htmltag tag)
        printf("</%s>", htmltags[tag].name);
        if (HTML_CLRLINE & htmltags[tag].flags) {
                h->flags |= HTML_NOSPACE;
-               h->flags |= HTML_NEWLINE;
                putchar('\n');
-       } else
-               h->flags &= ~HTML_NEWLINE;
+       } 
 }
 
 
-/* ARGSUSED */
 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)
+               puts("<?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
-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(','):
@@ -426,8 +523,6 @@ print_text(struct html *h, const char *p)
                case(')'):
                        /* FALLTHROUGH */
                case(']'):
-                       /* FALLTHROUGH */
-               case('}'):
                        if ( ! (HTML_IGNDELIM & h->flags))
                                h->flags |= HTML_NOSPACE;
                        break;
@@ -435,22 +530,43 @@ print_text(struct html *h, const char *p)
                        break;
                }
 
-       if ( ! (h->flags & HTML_NOSPACE))
-               putchar(' ');
+       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;");
+       }
+
+       assert(NULL == h->metaf);
+       if (HTMLFONT_NONE != h->metac)
+               h->metaf = HTMLFONT_BOLD == h->metac ?
+                       print_otag(h, TAG_B, 0, NULL) :
+                       print_otag(h, TAG_I, 0, NULL);
 
-       h->flags &= ~HTML_NOSPACE;
-       h->flags &= ~HTML_NEWLINE;
+       assert(word);
+       if ( ! print_encode(h, word, 0))
+               if ( ! (h->flags & HTML_NONOSPACE))
+                       h->flags &= ~HTML_NOSPACE;
+
+       if (h->metaf) {
+               print_tagq(h, h->metaf);
+               h->metaf = NULL;
+       }
 
-       if (p)
-               print_encode(h, p);
+       h->flags &= ~HTML_IGNDELIM;
 
-       if (*p && 0 == *(p + 1))
-               switch (*p) {
+       /* 
+        * 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('['):
-                       /* FALLTHROUGH */
-               case('{'):
                        h->flags |= HTML_NOSPACE;
                        break;
                default:
@@ -465,6 +581,8 @@ print_tagq(struct html *h, const struct tag *until)
        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);
@@ -482,6 +600,8 @@ print_stagq(struct html *h, const struct tag *suntil)
        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);
@@ -638,11 +758,11 @@ bufcat_su(struct html *h, const char *p, const struct roffsu *su)
                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);
 }
 
 
@@ -651,20 +771,24 @@ html_idcat(char *dst, const char *src, int sz)
 {
        int              ssz;
 
-       assert(sz);
+       assert(sz > 2);
 
        /* Cf. <http://www.w3.org/TR/html4/types.html#h-6.2>. */
 
-       for ( ; *dst != '\0' && sz; dst++, sz--)
-               /* Jump to end. */ ;
-
-       assert(sz > 2);
-
        /* We can't start with a number (bah). */
 
-       *dst++ = 'x';
-       *dst = '\0';
-       sz--;
+       if ('#' == *dst) {
+               dst++;
+               sz--;
+       }
+       if ('\0' == *dst) {
+               *dst++ = 'x';
+               *dst = '\0';
+               sz--;
+       }
+
+       for ( ; *dst != '\0' && sz; dst++, sz--)
+               /* Jump to end. */ ;
 
        for ( ; *src != '\0' && sz > 1; src++) {
                ssz = snprintf(dst, (size_t)sz, "%.2x", *src);