]> git.cameronkatri.com Git - mandoc.git/blobdiff - html.c
Have mandoc-db accumulate manual page descriptions (`Nd' in -mdoc parlance)
[mandoc.git] / html.c
diff --git a/html.c b/html.c
index d99bd58fbdc28e083b30567fa0481cddda98c3db..812a1847338295b11886df3465dc557b0ee915d1 100644 (file)
--- a/html.c
+++ b/html.c
@@ -1,6 +1,7 @@
-/*     $Id: html.c,v 1.121 2010/12/22 11:15:16 kristaps Exp $ */
+/*     $Id: html.c,v 1.132 2011/04/09 15:29:40 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * 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"
 
@@ -72,14 +72,8 @@ static       const struct htmldata htmltags[TAG_MAX] = {
        {"pre",         HTML_CLRLINE }, /* TAG_PRE */
        {"b",           0 }, /* TAG_B */
        {"i",           0 }, /* TAG_I */
-       {"u",           0 }, /* TAG_U */
        {"code",        0 }, /* TAG_CODE */
-};
-
-static const char      *const htmlfonts[HTMLFONT_MAX] = {
-       "roman",
-       "bold",
-       "italic"
+       {"small",       0 }, /* TAG_SMALL */
 };
 
 static const char      *const htmlattrs[ATTR_MAX] = {
@@ -96,16 +90,17 @@ static      const char      *const htmlattrs[ATTR_MAX] = {
        "id", /* ATTR_ID */
        "summary", /* ATTR_SUMMARY */
        "align", /* ATTR_ALIGN */
+       "colspan", /* ATTR_COLSPAN */
 };
 
-static void              print_spec(struct html *, enum roffdeco,
-                               const char *, size_t);
+static void              print_num(struct html *, const char *, size_t);
+static void              print_spec(struct html *, 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_metaf(struct html *, enum mandoc_esc);
 static void              print_attr(struct html *, 
                                const char *, const char *);
 static void             *ml_alloc(char *, enum htmltype);
@@ -123,11 +118,7 @@ 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((int)MANDOCLEVEL_SYSERR);
-       }
+       h = mandoc_calloc(1, sizeof(struct html));
 
        h->type = type;
        h->tags.head = NULL;
@@ -217,9 +208,19 @@ 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)
+print_spec(struct html *h, const char *p, size_t len)
 {
        int              cp;
        const char      *rhs;
@@ -228,7 +229,7 @@ print_spec(struct html *h, enum roffdeco d, const char *p, size_t len)
        if ((cp = chars_spec2cp(h->symtab, p, len)) > 0) {
                printf("&#%d;", cp);
                return;
-       } else if (-1 == cp && DECO_SSPECIAL == d) {
+       } else if (-1 == cp && 1 == len) {
                fwrite(p, 1, len, stdout);
                return;
        } else if (-1 == cp)
@@ -257,41 +258,22 @@ print_res(struct html *h, const char *p, size_t len)
 }
 
 
-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)
+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_FONTROMAN):
                font = HTMLFONT_NONE;
                break;
        default:
@@ -299,7 +281,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);
 }
 
 
@@ -309,70 +302,69 @@ print_encode(struct html *h, const char *p, int norecurse)
        size_t           sz;
        int              len, nospace;
        const char      *seq;
-       enum roffdeco    deco;
+       enum mandoc_esc  esc;
        static const char rejs[6] = { '\\', '<', '>', '&', ASCII_HYPH, '\0' };
 
        nospace = 0;
 
-       for (; *p; p++) {
+       while ('\0' != *p) {
                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_HYPH):
                        putchar('-');
                        continue;
-               } else if ('\0' == *p)
+               default:
                        break;
+               }
 
-               seq = ++p;
-               len = a2roffdeco(&deco, &seq, &sz);
+               esc = mandoc_escape(&p, &seq, &len);
+               if (ESCAPE_ERROR == esc)
+                       break;
 
-               switch (deco) {
-               case (DECO_RESERVED):
-                       print_res(h, seq, sz);
+               switch (esc) {
+               case (ESCAPE_NUMBERED):
+                       print_num(h, seq, len);
                        break;
-               case (DECO_SSPECIAL):
-                       /* FALLTHROUGH */
-               case (DECO_SPECIAL):
-                       print_spec(h, deco, seq, sz);
+               case (ESCAPE_PREDEF):
+                       print_res(h, seq, len);
+                       break;
+               case (ESCAPE_SPECIAL):
+                       print_spec(h, seq, len);
                        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):
+               case (ESCAPE_FONTROMAN):
                        if (norecurse)
                                break;
-                       print_metaf(h, deco);
+                       print_metaf(h, esc);
+                       break;
+               case (ESCAPE_NOSPACE):
+                       if ('\0' == *p)
+                               nospace = 1;
                        break;
                default:
                        break;
                }
-
-               p += len - 1;
-
-               if (DECO_NOSPACE == deco && '\0' == *(p + 1))
-                       nospace = 1;
        }
 
        return(nospace);
@@ -398,11 +390,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((int)MANDOCLEVEL_SYSERR);
-               }
+               t = mandoc_malloc(sizeof(struct tag));
                t->tag = tag;
                t->next = h->tags.head;
                h->tags.head = t;
@@ -515,35 +503,10 @@ print_doctype(struct html *h)
                        name, doctype, dtd);
 }
 
-
 void
 print_text(struct html *h, const char *word)
 {
 
-       if (word[0] && '\0' == word[1])
-               switch (word[0]) {
-               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)) {
@@ -554,27 +517,23 @@ print_text(struct html *h, const char *word)
                        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);
+
        assert(word);
        if ( ! print_encode(h, word, 0))
                if ( ! (h->flags & HTML_NONOSPACE))
                        h->flags &= ~HTML_NOSPACE;
 
-       h->flags &= ~HTML_IGNDELIM;
+       if (h->metaf) {
+               print_tagq(h, h->metaf);
+               h->metaf = NULL;
+       }
 
-       /* 
-        * 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('['):
-                       h->flags |= HTML_NOSPACE;
-                       break;
-               default:
-                       break;
-               }
+       h->flags &= ~HTML_IGNDELIM;
 }
 
 
@@ -584,8 +543,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);
@@ -603,8 +568,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);
@@ -774,20 +745,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);