]> git.cameronkatri.com Git - mandoc.git/blobdiff - html.c
Make empty sections and parts (SH, SS, RS) only produce a warning if it
[mandoc.git] / html.c
diff --git a/html.c b/html.c
index 6f0d318a0ef3d3bfe397c66c7c7c84e5ced79fd5..ab57c3743f6bf5c06aa2e444219ba90c0818f165 100644 (file)
--- a/html.c
+++ b/html.c
@@ -1,6 +1,7 @@
-/*     $Id: html.c,v 1.101 2010/06/07 10:52:44 kristaps Exp $ */
+/*     $Id: html.c,v 1.131 2011/03/22 14:05:45 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2011 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
@@ -31,7 +32,6 @@
 
 #include "mandoc.h"
 #include "out.h"
-#include "chars.h"
 #include "html.h"
 #include "main.h"
 
@@ -57,38 +57,45 @@ static      const struct htmldata htmltags[TAG_MAX] = {
        {"br",          HTML_CLRLINE | HTML_NOSTACK | HTML_AUTOCLOSE}, /* TAG_BR */
        {"a",           0}, /* TAG_A */
        {"table",       HTML_CLRLINE}, /* TAG_TABLE */
+       {"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 */
-};
-
-static const char      *const htmlfonts[HTMLFONT_MAX] = {
-       "roman",
-       "bold",
-       "italic"
+       {"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",
+       "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 */
+       "colspan", /* ATTR_COLSPAN */
 };
 
-static void              print_spec(struct html *, const char *, size_t);
+static void              print_num(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_doctype(struct html *);
@@ -112,15 +119,10 @@ ml_alloc(char *outopts, enum htmltype type)
        toks[2] = "includes";
        toks[3] = NULL;
 
-       h = calloc(1, sizeof(struct html));
-       if (NULL == h) {
-               perror(NULL);
-               exit(EXIT_FAILURE);
-       }
+       h = mandoc_calloc(1, sizeof(struct html));
 
        h->type = type;
        h->tags.head = NULL;
-       h->ords.head = NULL;
        h->symtab = chars_init(CHARS_HTML);
 
        while (outopts && *outopts)
@@ -161,16 +163,10 @@ 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);
@@ -213,51 +209,53 @@ print_gen_head(struct html *h)
        }
 }
 
-
+/* ARGSUSED */
 static void
-print_spec(struct html *h, const char *p, size_t len)
+print_num(struct html *h, const char *p, size_t len)
 {
        const char      *rhs;
-       size_t           sz;
-
-       rhs = chars_a2ascii(h->symtab, p, len, &sz);
 
-       if (NULL == rhs) 
-               return;
-       fwrite(rhs, 1, sz, stdout);
+       rhs = chars_num2char(p, len);
+       if (rhs)
+               putchar((int)*rhs);
 }
 
-
 static void
-print_res(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;
 
-       rhs = chars_a2res(h->symtab, p, 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;
+       } else if (-1 == cp)
                return;
-       fwrite(rhs, 1, sz, stdout);
+
+       if (NULL != (rhs = chars_spec2str(h->symtab, p, len, &sz)))
+               fwrite(rhs, 1, sz, stdout);
 }
 
 
-struct tag *
-print_ofont(struct html *h, enum htmlfont font)
+static void
+print_res(struct html *h, const char *p, size_t len)
 {
-       struct htmlpair  tag;
-
-       h->metal = h->metac;
-       h->metac = font;
-
-       /* FIXME: DECO_ROMAN should just close out preexisting. */
+       int              cp;
+       const char      *rhs;
+       size_t           sz;
 
-       if (h->metaf && h->tags.head == h->metaf)
-               print_tagq(h, h->metaf);
+       if ((cp = chars_res2cp(h->symtab, p, len)) > 0) {
+               printf("&#%d;", cp);
+               return;
+       } else if (-1 == cp)
+               return;
 
-       PAIR_CLASS_INIT(&tag, htmlfonts[font]);
-       h->metaf = print_otag(h, TAG_SPAN, 1, &tag);
-       return(h->metaf);
+       if (NULL != (rhs = chars_res2str(h->symtab, p, len, &sz)))
+               fwrite(rhs, 1, sz, stdout);
 }
 
 
@@ -284,7 +282,18 @@ print_metaf(struct html *h, enum roffdeco deco)
                /* NOTREACHED */
        }
 
-       (void)print_ofont(h, font);
+       if (h->metaf) {
+               print_tagq(h, h->metaf);
+               h->metaf = NULL;
+       }
+
+       h->metal = h->metac;
+       h->metac = font;
+
+       if (HTMLFONT_NONE != font)
+               h->metaf = HTMLFONT_BOLD == font ?
+                       print_otag(h, TAG_B, 0, NULL) :
+                       print_otag(h, TAG_I, 0, NULL);
 }
 
 
@@ -331,11 +340,16 @@ print_encode(struct html *h, const char *p, int norecurse)
                len = a2roffdeco(&deco, &seq, &sz);
 
                switch (deco) {
+               case (DECO_NUMBERED):
+                       print_num(h, seq, sz);
+                       break;
                case (DECO_RESERVED):
                        print_res(h, seq, sz);
                        break;
+               case (DECO_SSPECIAL):
+                       /* FALLTHROUGH */
                case (DECO_SPECIAL):
-                       print_spec(h, seq, sz);
+                       print_spec(h, deco, seq, sz);
                        break;
                case (DECO_PREVIOUS):
                        /* FALLTHROUGH */
@@ -381,11 +395,7 @@ print_otag(struct html *h, enum htmltag tag,
        /* 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);
-               }
+               t = mandoc_malloc(sizeof(struct tag));
                t->tag = tag;
                t->next = h->tags.head;
                h->tags.head = t;
@@ -393,8 +403,20 @@ 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. */
 
@@ -424,6 +446,10 @@ print_otag(struct html *h, enum htmltag tag,
        putchar('>');
 
        h->flags |= HTML_NOSPACE;
+
+       if ((HTML_AUTOCLOSE | HTML_CLRLINE) & htmltags[tag].flags)
+               putchar('\n');
+
        return(t);
 }
 
@@ -454,7 +480,7 @@ print_xmltype(struct html *h)
 {
 
        if (HTML_XHTML_1_0_STRICT == h->type)
-               printf("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
+               puts("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
 }
 
 
@@ -482,56 +508,37 @@ print_doctype(struct html *h)
                        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) {
-               case('.'):
-                       /* FALLTHROUGH */
-               case(','):
-                       /* FALLTHROUGH */
-               case(';'):
-                       /* FALLTHROUGH */
-               case(':'):
-                       /* FALLTHROUGH */
-               case('?'):
-                       /* FALLTHROUGH */
-               case('!'):
-                       /* FALLTHROUGH */
-               case(')'):
-                       /* FALLTHROUGH */
-               case(']'):
-                       if ( ! (HTML_IGNDELIM & h->flags))
-                               h->flags |= HTML_NOSPACE;
-                       break;
-               default:
-                       break;
-               }
+       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 ( ! (h->flags & HTML_NOSPACE))
-               putchar(' ');
+       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);
 
-       assert(p);
-       if ( ! print_encode(h, p, 0))
-               h->flags &= ~HTML_NOSPACE;
+       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 (*p && 0 == *(p + 1))
-               switch (*p) {
-               case('('):
-                       /* FALLTHROUGH */
-               case('['):
-                       h->flags |= HTML_NOSPACE;
-                       break;
-               default:
-                       break;
-               }
+       if (h->metaf) {
+               print_tagq(h, h->metaf);
+               h->metaf = NULL;
+       }
+
+       h->flags &= ~HTML_IGNDELIM;
 }
 
 
@@ -541,8 +548,14 @@ print_tagq(struct html *h, const struct tag *until)
        struct tag      *tag;
 
        while ((tag = h->tags.head) != NULL) {
+               /* 
+                * Remember to close out and nullify the current
+                * meta-font and table, if applicable.
+                */
                if (tag == h->metaf)
                        h->metaf = NULL;
+               if (tag == h->tblt)
+                       h->tblt = NULL;
                print_ctag(h, tag->tag);
                h->tags.head = tag->next;
                free(tag);
@@ -560,8 +573,14 @@ print_stagq(struct html *h, const struct tag *suntil)
        while ((tag = h->tags.head) != NULL) {
                if (suntil && tag == suntil)
                        return;
+               /* 
+                * Remember to close out and nullify the current
+                * meta-font and table, if applicable.
+                */
                if (tag == h->metaf)
                        h->metaf = NULL;
+               if (tag == h->tblt)
+                       h->tblt = NULL;
                print_ctag(h, tag->tag);
                h->tags.head = tag->next;
                free(tag);
@@ -718,11 +737,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);
 }
 
 
@@ -731,20 +750,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);