]> git.cameronkatri.com Git - mandoc.git/blobdiff - html.c
add a LICENSE file for clarity and for the convenience of porters
[mandoc.git] / html.c
diff --git a/html.c b/html.c
index 8e333ecba7631a5c0f323d90cec46834ac96ddf3..7319de66790264f0774ce3072b67843393e57498 100644 (file)
--- a/html.c
+++ b/html.c
@@ -1,7 +1,7 @@
-/*     $Id: html.c,v 1.129 2011/03/17 09:16:38 kristaps Exp $ */
+/*     $Id: html.c,v 1.156 2014/04/20 16:46:04 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2011 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2011, 2012, 2013, 2014 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,8 +31,9 @@
 #include <unistd.h>
 
 #include "mandoc.h"
+#include "mandoc_aux.h"
+#include "libmandoc.h"
 #include "out.h"
-#include "chars.h"
 #include "html.h"
 #include "main.h"
 
@@ -94,49 +95,60 @@ static      const char      *const htmlattrs[ATTR_MAX] = {
        "colspan", /* ATTR_COLSPAN */
 };
 
-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 *);
-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 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 */
+};
+
+static void     bufncat(struct html *, const char *, size_t);
+static void     print_ctag(struct html *, enum htmltag);
+static int      print_encode(struct html *, const char *, int);
+static void     print_metaf(struct html *, enum mandoc_esc);
+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];
+       const char      *toks[5];
        char            *v;
 
        toks[0] = "style";
        toks[1] = "man";
        toks[2] = "includes";
-       toks[3] = NULL;
+       toks[3] = "fragment";
+       toks[4] = NULL;
 
        h = mandoc_calloc(1, sizeof(struct html));
 
        h->type = type;
        h->tags.head = NULL;
-       h->symtab = chars_init(CHARS_HTML);
+       h->symtab = mchars_alloc();
 
        while (outopts && *outopts)
                switch (getsubopt(&outopts, UNCONST(toks), &v)) {
-               case (0):
+               case 0:
                        h->style = v;
                        break;
-               case (1):
+               case 1:
                        h->base_man = v;
                        break;
-               case (2):
+               case 2:
                        h->base_includes = v;
                        break;
+               case 3:
+                       h->oflags |= HTML_FRAGMENT;
+                       break;
                default:
                        break;
                }
@@ -151,7 +163,6 @@ html_alloc(char *outopts)
        return(ml_alloc(outopts, HTML_HTML_4_01_STRICT));
 }
 
-
 void *
 xhtml_alloc(char *outopts)
 {
@@ -159,7 +170,6 @@ xhtml_alloc(char *outopts)
        return(ml_alloc(outopts, HTML_XHTML_1_0_STRICT));
 }
 
-
 void
 html_free(void *p)
 {
@@ -169,17 +179,16 @@ html_free(void *p)
        h = (struct html *)p;
 
        while ((tag = h->tags.head) != NULL) {
-               h->tags.head = tag->next;       
+               h->tags.head = tag->next;
                free(tag);
        }
-       
+
        if (h->symtab)
-               chars_free(h->symtab);
+               mchars_free(h->symtab);
 
        free(h);
 }
 
-
 void
 print_gen_head(struct html *h)
 {
@@ -210,72 +219,27 @@ print_gen_head(struct html *h)
        }
 }
 
-/* ARGSUSED */
 static void
-print_num(struct html *h, const char *p, size_t len)
-{
-       const char      *rhs;
-
-       rhs = chars_num2char(p, len);
-       if (rhs)
-               putchar((int)*rhs);
-}
-
-static void
-print_spec(struct html *h, enum roffdeco d, const char *p, size_t len)
-{
-       int              cp;
-       const char      *rhs;
-       size_t           sz;
-
-       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;
-
-       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)
-{
-       int              cp;
-       const char      *rhs;
-       size_t           sz;
-
-       if ((cp = chars_res2cp(h->symtab, p, len)) > 0) {
-               printf("&#%d;", cp);
-               return;
-       } else if (-1 == cp)
-               return;
-
-       if (NULL != (rhs = chars_res2str(h->symtab, p, len, &sz)))
-               fwrite(rhs, 1, sz, stdout);
-}
-
-
-static void
-print_metaf(struct html *h, enum roffdeco deco)
+print_metaf(struct html *h, enum mandoc_esc deco)
 {
        enum htmlfont    font;
 
        switch (deco) {
-       case (DECO_PREVIOUS):
+       case ESCAPE_FONTPREV:
                font = h->metal;
                break;
-       case (DECO_ITALIC):
+       case ESCAPE_FONTITALIC:
                font = HTMLFONT_ITALIC;
                break;
-       case (DECO_BOLD):
+       case ESCAPE_FONTBOLD:
                font = HTMLFONT_BOLD;
                break;
-       case (DECO_ROMAN):
+       case ESCAPE_FONTBI:
+               font = HTMLFONT_BI;
+               break;
+       case ESCAPE_FONT:
+               /* FALLTHROUGH */
+       case ESCAPE_FONTROMAN:
                font = HTMLFONT_NONE;
                break;
        default:
@@ -291,92 +255,185 @@ print_metaf(struct html *h, enum roffdeco deco)
        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);
+       switch (font) {
+       case HTMLFONT_ITALIC:
+               h->metaf = print_otag(h, TAG_I, 0, NULL);
+               break;
+       case HTMLFONT_BOLD:
+               h->metaf = print_otag(h, TAG_B, 0, NULL);
+               break;
+       case HTMLFONT_BI:
+               h->metaf = print_otag(h, TAG_B, 0, NULL);
+               print_otag(h, TAG_I, 0, NULL);
+               break;
+       default:
+               break;
+       }
 }
 
+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--;
+                       }
+                       sz += rsz;
+               }
+               if ('\0' == *cp)
+                       break;
+               cp++;
+               switch (mandoc_escape(&cp, NULL, NULL)) {
+               case ESCAPE_ERROR:
+                       return(sz);
+               case ESCAPE_UNICODE:
+                       /* FALLTHROUGH */
+               case ESCAPE_NUMBERED:
+                       /* FALLTHROUGH */
+               case ESCAPE_SPECIAL:
+                       if (skip)
+                               skip = 0;
+                       else
+                               sz++;
+                       break;
+               case ESCAPE_SKIPCHAR:
+                       skip = 1;
+                       break;
+               default:
+                       break;
+               }
+       }
+       return(sz);
+}
 
 static int
 print_encode(struct html *h, const char *p, int norecurse)
 {
        size_t           sz;
-       int              len, nospace;
+       int              c, len, nospace;
        const char      *seq;
-       enum roffdeco    deco;
-       static const char rejs[6] = { '\\', '<', '>', '&', ASCII_HYPH, '\0' };
+       enum mandoc_esc  esc;
+       static const char rejs[8] = { '\\', '<', '>', '&',
+               ASCII_NBRSP, ASCII_HYPH, ASCII_BREAK, '\0' };
 
        nospace = 0;
 
-       for (; *p; p++) {
+       while ('\0' != *p) {
+               if (HTML_SKIPCHAR & h->flags && '\\' != *p) {
+                       h->flags &= ~HTML_SKIPCHAR;
+                       p++;
+                       continue;
+               }
+
                sz = strcspn(p, rejs);
 
                fwrite(p, 1, sz, stdout);
-               p += /* LINTED */
-                       sz;
+               p += (int)sz;
+
+               if ('\0' == *p)
+                       break;
 
-               if ('<' == *p) {
+               switch (*p++) {
+               case '<':
                        printf("&lt;");
                        continue;
-               } else if ('>' == *p) {
+               case '>':
                        printf("&gt;");
                        continue;
-               } else if ('&' == *p) {
+               case '&':
                        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;");*/
+               case ASCII_NBRSP:
+                       putchar('-');
+                       continue;
+               case ASCII_HYPH:
                        putchar('-');
+                       /* FALLTHROUGH */
+               case ASCII_BREAK:
                        continue;
-               } else if ('\0' == *p)
+               default:
                        break;
+               }
 
-               seq = ++p;
-               len = a2roffdeco(&deco, &seq, &sz);
-
-               switch (deco) {
-               case (DECO_NUMBERED):
-                       print_num(h, seq, sz);
+               esc = mandoc_escape(&p, &seq, &len);
+               if (ESCAPE_ERROR == esc)
                        break;
-               case (DECO_RESERVED):
-                       print_res(h, seq, sz);
-                       break;
-               case (DECO_SSPECIAL):
+
+               switch (esc) {
+               case ESCAPE_FONT:
                        /* FALLTHROUGH */
-               case (DECO_SPECIAL):
-                       print_spec(h, deco, seq, sz);
-                       break;
-               case (DECO_PREVIOUS):
+               case ESCAPE_FONTPREV:
                        /* FALLTHROUGH */
-               case (DECO_BOLD):
+               case ESCAPE_FONTBOLD:
                        /* FALLTHROUGH */
-               case (DECO_ITALIC):
+               case ESCAPE_FONTITALIC:
                        /* FALLTHROUGH */
-               case (DECO_ROMAN):
-                       if (norecurse)
-                               break;
-                       print_metaf(h, deco);
-                       break;
+               case ESCAPE_FONTBI:
+                       /* FALLTHROUGH */
+               case ESCAPE_FONTROMAN:
+                       if (0 == norecurse)
+                               print_metaf(h, esc);
+                       continue;
+               case ESCAPE_SKIPCHAR:
+                       h->flags |= HTML_SKIPCHAR;
+                       continue;
                default:
                        break;
                }
 
-               p += len - 1;
+               if (h->flags & HTML_SKIPCHAR) {
+                       h->flags &= ~HTML_SKIPCHAR;
+                       continue;
+               }
 
-               if (DECO_NOSPACE == deco && '\0' == *(p + 1))
-                       nospace = 1;
+               switch (esc) {
+               case ESCAPE_UNICODE:
+                       /* Skip passed "u" header. */
+                       c = mchars_num2uc(seq + 1, len - 1);
+                       if ('\0' != c)
+                               printf("&#x%x;", c);
+                       break;
+               case ESCAPE_NUMBERED:
+                       c = mchars_num2char(seq, len);
+                       if ('\0' != c)
+                               putchar(c);
+                       break;
+               case ESCAPE_SPECIAL:
+                       c = mchars_spec2cp(h->symtab, seq, len);
+                       if (c > 0)
+                               printf("&#%d;", c);
+                       else if (-1 == c && 1 == len)
+                               putchar((int)*seq);
+                       break;
+               case ESCAPE_NOSPACE:
+                       if ('\0' == *p)
+                               nospace = 1;
+                       break;
+               default:
+                       break;
+               }
        }
 
        return(nospace);
 }
 
-
 static void
 print_attr(struct html *h, const char *key, const char *val)
 {
@@ -385,9 +442,8 @@ print_attr(struct html *h, const char *key, const char *val)
        putchar('\"');
 }
 
-
 struct tag *
-print_otag(struct html *h, enum htmltag tag, 
+print_otag(struct html *h, enum htmltag tag,
                int sz, const struct htmlpair *p)
 {
        int              i;
@@ -433,11 +489,11 @@ print_otag(struct html *h, enum htmltag tag,
                print_attr(h, "lang", "en");
        }
 
-       /* Accomodate for XML "well-formed" singleton escaping. */
+       /* Accommodate for XML "well-formed" singleton escaping. */
 
        if (HTML_AUTOCLOSE & htmltags[tag].flags)
                switch (h->type) {
-               case (HTML_XHTML_1_0_STRICT):
+               case HTML_XHTML_1_0_STRICT:
                        putchar('/');
                        break;
                default:
@@ -454,70 +510,46 @@ print_otag(struct html *h, enum htmltag tag,
        return(t);
 }
 
-
 static void
 print_ctag(struct html *h, enum htmltag tag)
 {
-       
+
        printf("</%s>", htmltags[tag].name);
        if (HTML_CLRLINE & htmltags[tag].flags) {
                h->flags |= HTML_NOSPACE;
                putchar('\n');
-       } 
+       }
 }
 
-
 void
 print_gen_decls(struct html *h)
-{
-
-       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):
+       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:
+               puts("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
                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);
+       printf("<!DOCTYPE %s PUBLIC \"%s\" \"%s\">\n",
+           name, doctype, dtd);
 }
 
-
 void
 print_text(struct html *h, const char *word)
 {
 
-       if (DELIM_CLOSE == mandoc_isdelim(word))
-               if ( ! (HTML_IGNDELIM & h->flags))
-                       h->flags |= HTML_NOSPACE;
-
        if ( ! (HTML_NOSPACE & h->flags)) {
                /* Manage keeps! */
                if ( ! (HTML_KEEP & h->flags)) {
@@ -529,15 +561,27 @@ print_text(struct html *h, const char *word)
        }
 
        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);
+       switch (h->metac) {
+       case HTMLFONT_ITALIC:
+               h->metaf = print_otag(h, TAG_I, 0, NULL);
+               break;
+       case HTMLFONT_BOLD:
+               h->metaf = print_otag(h, TAG_B, 0, NULL);
+               break;
+       case HTMLFONT_BI:
+               h->metaf = print_otag(h, TAG_B, 0, NULL);
+               print_otag(h, TAG_I, 0, NULL);
+               break;
+       default:
+               break;
+       }
 
        assert(word);
-       if ( ! print_encode(h, word, 0))
+       if ( ! print_encode(h, word, 0)) {
                if ( ! (h->flags & HTML_NONOSPACE))
                        h->flags &= ~HTML_NOSPACE;
+       } else
+               h->flags |= HTML_NOSPACE;
 
        if (h->metaf) {
                print_tagq(h, h->metaf);
@@ -545,19 +589,15 @@ print_text(struct html *h, const char *word)
        }
 
        h->flags &= ~HTML_IGNDELIM;
-
-       if (DELIM_OPEN == mandoc_isdelim(word))
-               h->flags |= HTML_NOSPACE;
 }
 
-
 void
 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.
                 */
@@ -573,7 +613,6 @@ print_tagq(struct html *h, const struct tag *until)
        }
 }
 
-
 void
 print_stagq(struct html *h, const struct tag *suntil)
 {
@@ -582,7 +621,7 @@ 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.
                 */
@@ -596,7 +635,6 @@ print_stagq(struct html *h, const struct tag *suntil)
        }
 }
 
-
 void
 bufinit(struct html *h)
 {
@@ -605,62 +643,57 @@ bufinit(struct html *h)
        h->buflen = 0;
 }
 
-
 void
 bufcat_style(struct html *h, const char *key, const char *val)
 {
 
        bufcat(h, key);
-       bufncat(h, ":", 1);
+       bufcat(h, ":");
        bufcat(h, val);
-       bufncat(h, ";", 1);
+       bufcat(h, ";");
 }
 
-
 void
 bufcat(struct html *h, const char *p)
 {
 
-       bufncat(h, p, strlen(p));
+       h->buflen = strlcat(h->buf, p, BUFSIZ);
+       assert(h->buflen < BUFSIZ);
 }
 
-
 void
-buffmt(struct html *h, const char *fmt, ...)
+bufcat_fmt(struct html *h, const char *fmt, ...)
 {
        va_list          ap;
 
        va_start(ap, fmt);
-       (void)vsnprintf(h->buf + (int)h->buflen, 
-                       BUFSIZ - h->buflen - 1, fmt, ap);
+       (void)vsnprintf(h->buf + (int)h->buflen,
+           BUFSIZ - h->buflen - 1, fmt, ap);
        va_end(ap);
        h->buflen = strlen(h->buf);
 }
 
-
-void
+static void
 bufncat(struct html *h, const char *p, size_t sz)
 {
 
-       if (h->buflen + sz > BUFSIZ - 1)
-               sz = BUFSIZ - 1 - h->buflen;
-
-       (void)strncat(h->buf, p, sz);
+       assert(h->buflen + sz + 1 < BUFSIZ);
+       strncat(h->buf, p, sz);
        h->buflen += sz;
 }
 
-
 void
 buffmt_includes(struct html *h, const char *name)
 {
        const char      *p, *pp;
 
        pp = h->base_includes;
-       
+
+       bufinit(h);
        while (NULL != (p = strchr(pp, '%'))) {
                bufncat(h, pp, (size_t)(p - pp));
                switch (*(p + 1)) {
-               case('I'):
+               case'I':
                        bufcat(h, name);
                        break;
                default:
@@ -673,24 +706,22 @@ buffmt_includes(struct html *h, const char *name)
                bufcat(h, pp);
 }
 
-
 void
-buffmt_man(struct html *h, 
-               const char *name, const char *sec)
+buffmt_man(struct html *h, const char *name, const char *sec)
 {
        const char      *p, *pp;
 
        pp = h->base_man;
-       
-       /* LINTED */
+
+       bufinit(h);
        while (NULL != (p = strchr(pp, '%'))) {
                bufncat(h, pp, (size_t)(p - pp));
                switch (*(p + 1)) {
-               case('S'):
+               case 'S':
                        bufcat(h, sec ? sec : "1");
                        break;
-               case('N'):
-                       buffmt(h, name);
+               case 'N':
+                       bufcat_fmt(h, "%s", name);
                        break;
                default:
                        bufncat(h, p, 2);
@@ -702,85 +733,24 @@ buffmt_man(struct html *h,
                bufcat(h, pp);
 }
 
-
 void
 bufcat_su(struct html *h, const char *p, const struct roffsu *su)
 {
        double           v;
-       const char      *u;
 
        v = su->scale;
+       if (SCALE_MM == su->unit && 0.0 == (v /= 100.0))
+               v = 1.0;
 
-       switch (su->unit) {
-       case (SCALE_CM):
-               u = "cm";
-               break;
-       case (SCALE_IN):
-               u = "in";
-               break;
-       case (SCALE_PC):
-               u = "pc";
-               break;
-       case (SCALE_PT):
-               u = "pt";
-               break;
-       case (SCALE_EM):
-               u = "em";
-               break;
-       case (SCALE_MM):
-               if (0 == (v /= 100))
-                       v = 1;
-               u = "em";
-               break;
-       case (SCALE_EN):
-               u = "ex";
-               break;
-       case (SCALE_BU):
-               u = "ex";
-               break;
-       case (SCALE_VS):
-               u = "em";
-               break;
-       default:
-               u = "ex";
-               break;
-       }
-
-       /* 
-        * 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);
+       bufcat_fmt(h, "%s: %.2f%s;", p, v, roffscales[su->unit]);
 }
 
-
 void
-html_idcat(char *dst, const char *src, int sz)
+bufcat_id(struct html *h, const char *src)
 {
-       int              ssz;
-
-       assert(sz > 2);
 
        /* Cf. <http://www.w3.org/TR/html4/types.html#h-6.2>. */
 
-       /* We can't start with a number (bah). */
-
-       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);
-               sz -= ssz;
-               dst += ssz;
-       }
+       while ('\0' != *src)
+               bufcat_fmt(h, "%.2x", *src++);
 }