]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_html.c
Remove `Sp', `Vb', and `Ve' (as per schwarze@'s changes in OpenBSD),
[mandoc.git] / man_html.c
index df0527e3318a96c2ba25bff033d4c9c53a856369..63de45340eef55b1e616c7eb6575e7097fe40400 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: man_html.c,v 1.19 2009/11/14 11:58:36 kristaps Exp $ */
+/*     $Id: man_html.c,v 1.46 2010/12/05 16:14:16 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
  * 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>
@@ -22,6 +26,7 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "mandoc.h"
 #include "out.h"
 #include "html.h"
 #include "man.h"
 
 #define        MAN_ARGS          const struct man_meta *m, \
                          const struct man_node *n, \
+                         struct mhtml *mh, \
                          struct html *h
 
+struct mhtml {
+       int               fl;
+#define        MANH_LITERAL     (1 << 0) /* literal context */
+};
+
 struct htmlman {
        int             (*pre)(MAN_ARGS);
        int             (*post)(MAN_ARGS);
@@ -53,6 +64,8 @@ static        int               a2width(const struct man_node *,
 static int               man_alt_pre(MAN_ARGS);
 static int               man_br_pre(MAN_ARGS);
 static int               man_ign_pre(MAN_ARGS);
+static int               man_in_pre(MAN_ARGS);
+static int               man_literal_pre(MAN_ARGS);
 static void              man_root_post(MAN_ARGS);
 static int               man_root_pre(MAN_ARGS);
 static int               man_B_pre(MAN_ARGS);
@@ -66,11 +79,6 @@ static       int               man_SH_pre(MAN_ARGS);
 static int               man_SM_pre(MAN_ARGS);
 static int               man_SS_pre(MAN_ARGS);
 
-#ifdef __linux__
-extern size_t            strlcpy(char *, const char *, size_t);
-extern size_t            strlcat(char *, const char *, size_t);
-#endif
-
 static const struct htmlman mans[MAN_MAX] = {
        { man_br_pre, NULL }, /* br */
        { NULL, NULL }, /* TH */
@@ -96,14 +104,16 @@ static     const struct htmlman mans[MAN_MAX] = {
        { NULL, NULL }, /* na */
        { NULL, NULL }, /* i */
        { man_br_pre, NULL }, /* sp */
-       { NULL, NULL }, /* nf */
-       { NULL, NULL }, /* fi */
+       { man_literal_pre, NULL }, /* nf */
+       { man_literal_pre, NULL }, /* fi */
        { NULL, NULL }, /* r */
        { NULL, NULL }, /* RE */
        { man_RS_pre, NULL }, /* RS */
        { man_ign_pre, NULL }, /* DT */
        { man_ign_pre, NULL }, /* UC */
        { man_ign_pre, NULL }, /* PD */
+       { man_ign_pre, NULL }, /* AT */
+       { man_in_pre, NULL }, /* in */
 };
 
 
@@ -112,13 +122,16 @@ html_man(void *arg, const struct man *m)
 {
        struct html     *h;
        struct tag      *t;
+       struct mhtml     mh;
 
        h = (struct html *)arg;
 
-       print_gen_doctype(h);
+       print_gen_decls(h);
+
+       memset(&mh, 0, sizeof(struct mhtml));
 
        t = print_otag(h, TAG_HTML, 0, NULL);
-       print_man(man_meta(m), man_node(m), h);
+       print_man(man_meta(m), man_node(m), &mh, h);
        print_tagq(h, t);
 
        printf("\n");
@@ -133,7 +146,7 @@ print_man(MAN_ARGS)
 
        t = print_otag(h, TAG_HEAD, 0, NULL);
 
-       print_man_head(m, n, h);
+       print_man_head(m, n, mh, h);
        print_tagq(h, t);
        t = print_otag(h, TAG_BODY, 0, NULL);
 
@@ -141,7 +154,7 @@ print_man(MAN_ARGS)
        tag.val = "body";
        print_otag(h, TAG_DIV, 1, &tag);
 
-       print_man_nodelist(m, n, h);
+       print_man_nodelist(m, n, mh, h);
 
        print_tagq(h, t);
 }
@@ -154,7 +167,7 @@ print_man_head(MAN_ARGS)
 
        print_gen_head(h);
        bufinit(h);
-       buffmt(h, "%s(%d)", m->title, m->msec);
+       buffmt(h, "%s(%s)", m->title, m->msec);
 
        print_otag(h, TAG_TITLE, 0, NULL);
        print_text(h, h->buf);
@@ -165,9 +178,9 @@ static void
 print_man_nodelist(MAN_ARGS)
 {
 
-       print_man_node(m, n, h);
+       print_man_node(m, n, mh, h);
        if (n->next)
-               print_man_nodelist(m, n->next, h);
+               print_man_nodelist(m, n->next, mh, h);
 }
 
 
@@ -182,35 +195,57 @@ print_man_node(MAN_ARGS)
 
        bufinit(h);
 
+       /*
+        * FIXME: embedded elements within next-line scopes (e.g., `br'
+        * within an empty `B') will cause formatting to be forgotten
+        * due to scope closing out.
+        */
+
        switch (n->type) {
        case (MAN_ROOT):
-               child = man_root_pre(m, n, h);
+               child = man_root_pre(m, n, mh, h);
                break;
        case (MAN_TEXT):
                print_text(h, n->string);
+
+               if (MANH_LITERAL & mh->fl)
+                       print_otag(h, TAG_BR, 0, NULL);
+
                return;
        default:
+               /* 
+                * Close out scope of font prior to opening a macro
+                * scope.  Assert that the metafont is on the top of the
+                * stack (it's never nested).
+                */
+               if (h->metaf) {
+                       assert(h->metaf == t);
+                       print_tagq(h, h->metaf);
+                       assert(NULL == h->metaf);
+                       t = h->tags.head;
+               }
                if (mans[n->tok].pre)
-                       child = (*mans[n->tok].pre)(m, n, h);
+                       child = (*mans[n->tok].pre)(m, n, mh, h);
                break;
        }
 
        if (child && n->child)
-               print_man_nodelist(m, n->child, h);
+               print_man_nodelist(m, n->child, mh, h);
 
+       /* This will automatically close out any font scope. */
        print_stagq(h, t);
 
        bufinit(h);
 
        switch (n->type) {
        case (MAN_ROOT):
-               man_root_post(m, n, h);
+               man_root_post(m, n, mh, h);
                break;
        case (MAN_TEXT):
                break;
        default:
                if (mans[n->tok].post)
-                       (*mans[n->tok].post)(m, n, h);
+                       (*mans[n->tok].post)(m, n, mh, h);
                break;
        }
 }
@@ -241,8 +276,7 @@ man_root_pre(MAN_ARGS)
        if (m->vol)
                (void)strlcat(b, m->vol, BUFSIZ);
 
-       (void)snprintf(title, BUFSIZ - 1, 
-                       "%s(%d)", m->title, m->msec);
+       snprintf(title, BUFSIZ - 1, "%s(%s)", m->title, m->msec);
 
        PAIR_CLASS_INIT(&tag[0], "header");
        bufcat_style(h, "width", "100%");
@@ -287,7 +321,10 @@ man_root_post(MAN_ARGS)
        struct tag      *t, *tt;
        char             b[DATESIZ];
 
-       time2a(m->date, b, DATESIZ);
+       if (m->rawdate)
+               strlcpy(b, m->rawdate, DATESIZ);
+       else
+               time2a(m->date, b, DATESIZ);
 
        PAIR_CLASS_INIT(&tag[0], "footer");
        bufcat_style(h, "width", "100%");
@@ -325,14 +362,20 @@ man_br_pre(MAN_ARGS)
 
        SCALE_VS_INIT(&su, 1);
 
-       if (MAN_sp == n->tok && n->child)
-               a2roffsu(n->child->string, &su, SCALE_VS);
-       else if (MAN_br == n->tok)
+       switch (n->tok) {
+       case (MAN_sp):
+               if (n->child)
+                       a2roffsu(n->child->string, &su, SCALE_VS);
+               break;
+       default:
                su.scale = 0;
+               break;
+       }
 
        bufcat_su(h, "height", &su);
        PAIR_STYLE_INIT(&tag, h);
        print_otag(h, TAG_DIV, 1, &tag);
+
        /* So the div isn't empty: */
        print_text(h, "\\~");
 
@@ -384,30 +427,27 @@ man_alt_pre(MAN_ARGS)
        const struct man_node   *nn;
        struct tag              *t;
        int                      i;
-       struct htmlpair          tagi, tagb, *tagp;
-
-       PAIR_CLASS_INIT(&tagi, "italic");
-       PAIR_CLASS_INIT(&tagb, "bold");
+       enum htmlfont            fp;
 
        for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
                switch (n->tok) {
                case (MAN_BI):
-                       tagp = i % 2 ? &tagi : &tagb;
+                       fp = i % 2 ? HTMLFONT_ITALIC : HTMLFONT_BOLD;
                        break;
                case (MAN_IB):
-                       tagp = i % 2 ? &tagb : &tagi;
+                       fp = i % 2 ? HTMLFONT_BOLD : HTMLFONT_ITALIC;
                        break;
                case (MAN_RI):
-                       tagp = i % 2 ? &tagi : NULL;
+                       fp = i % 2 ? HTMLFONT_ITALIC : HTMLFONT_NONE;
                        break;
                case (MAN_IR):
-                       tagp = i % 2 ? NULL : &tagi;
+                       fp = i % 2 ? HTMLFONT_NONE : HTMLFONT_ITALIC;
                        break;
                case (MAN_BR):
-                       tagp = i % 2 ? NULL : &tagb;
+                       fp = i % 2 ? HTMLFONT_NONE : HTMLFONT_BOLD;
                        break;
                case (MAN_RB):
-                       tagp = i % 2 ? &tagb : NULL;
+                       fp = i % 2 ? HTMLFONT_BOLD : HTMLFONT_NONE;
                        break;
                default:
                        abort();
@@ -417,12 +457,14 @@ man_alt_pre(MAN_ARGS)
                if (i)
                        h->flags |= HTML_NOSPACE;
 
-               if (tagp) {
-                       t = print_otag(h, TAG_SPAN, 1, tagp);
-                       print_man_node(m, nn, h);
-                       print_tagq(h, t);
-               } else
-                       print_man_node(m, nn, h);
+               /* 
+                * Open and close the scope with each argument, so that
+                * internal \f escapes, which are common, are also
+                * closed out with the scope.
+                */
+               t = print_ofont(h, fp);
+               print_man_node(m, nn, mh, h);
+               print_tagq(h, t);
        }
 
        return(0);
@@ -435,6 +477,7 @@ man_SB_pre(MAN_ARGS)
 {
        struct htmlpair  tag;
        
+       /* FIXME: print_ofont(). */
        PAIR_CLASS_INIT(&tag, "small bold");
        print_otag(h, TAG_SPAN, 1, &tag);
        return(1);
@@ -509,19 +552,19 @@ man_PP_pre(MAN_ARGS)
 
        i = 0;
 
-       if (MAN_ROOT == n->parent->tok) {
+       if (MAN_ROOT == n->parent->type) {
                SCALE_HS_INIT(&su, INDENT);
                bufcat_su(h, "margin-left", &su);
-               i++;
+               i = 1;
        }
-       if (n->next && n->next->child) {
+       if (n->prev) {
                SCALE_VS_INIT(&su, 1);
-               bufcat_su(h, "margin-bottom", &su);
-               i++;
+               bufcat_su(h, "margin-top", &su);
+               i = 1;
        }
 
        PAIR_STYLE_INIT(&tag, h);
-       print_otag(h, TAG_DIV, i ? 1 : 0, &tag);
+       print_otag(h, TAG_DIV, i, &tag);
        return(1);
 }
 
@@ -556,6 +599,8 @@ man_IP_pre(MAN_ARGS)
        SCALE_HS_INIT(&su, INDENT);
        width = 0;
 
+       /* Width is the last token. */
+
        if (MAN_IP == n->tok && NULL != nn)
                if (NULL != (nn = nn->next)) {
                        for ( ; nn->next; nn = nn->next)
@@ -563,8 +608,15 @@ man_IP_pre(MAN_ARGS)
                        width = a2width(nn, &su);
                }
 
-       if (MAN_TP == n->tok && NULL != nn)
-               width = a2width(nn, &su);
+       /* Width is the first token. */
+
+       if (MAN_TP == n->tok && NULL != nn) {
+               /* Skip past non-text children. */
+               while (nn && MAN_TEXT != nn->type)
+                       nn = nn->next;
+               if (nn)
+                       width = a2width(nn, &su);
+       }
 
        if (MAN_BLOCK == n->type) {
                bufcat_su(h, "margin-left", &su);
@@ -589,17 +641,26 @@ man_IP_pre(MAN_ARGS)
        PAIR_STYLE_INIT(&tag, h);
        print_otag(h, TAG_DIV, 1, &tag);
 
-       /* With a length string, manually omit the last child. */
+       /*
+        * Without a length string, we can print all of our children.
+        */
 
        if ( ! width)
                return(1);
 
+       /*
+        * When a length has been specified, we need to carefully print
+        * our child context:  IP gets all children printed but the last
+        * (the width), while TP gets all children printed but the first
+        * (the width).
+        */
+
        if (MAN_IP == n->tok)
                for (nn = n->child; nn->next; nn = nn->next)
-                       print_man_node(m, nn, h);
+                       print_man_node(m, nn, mh, h);
        if (MAN_TP == n->tok)
                for (nn = n->child->next; nn; nn = nn->next)
-                       print_man_node(m, nn, h);
+                       print_man_node(m, nn, mh, h);
 
        return(0);
 }
@@ -648,10 +709,8 @@ man_HP_pre(MAN_ARGS)
 static int
 man_B_pre(MAN_ARGS)
 {
-       struct htmlpair  tag;
 
-       PAIR_CLASS_INIT(&tag, "bold");
-       print_otag(h, TAG_SPAN, 1, &tag);
+       print_ofont(h, HTMLFONT_BOLD);
        return(1);
 }
 
@@ -660,14 +719,41 @@ man_B_pre(MAN_ARGS)
 static int
 man_I_pre(MAN_ARGS)
 {
-       struct htmlpair  tag;
+       
+       print_ofont(h, HTMLFONT_ITALIC);
+       return(1);
+}
+
+
+/* ARGSUSED */
+static int
+man_literal_pre(MAN_ARGS)
+{
+
+       switch (n->tok) {
+       case (MAN_nf):
+               print_otag(h, TAG_BR, 0, NULL);
+               mh->fl |= MANH_LITERAL;
+               break;
+       default:
+               mh->fl &= ~MANH_LITERAL;
+               break;
+       }
 
-       PAIR_CLASS_INIT(&tag, "italic");
-       print_otag(h, TAG_SPAN, 1, &tag);
        return(1);
 }
 
 
+/* ARGSUSED */
+static int
+man_in_pre(MAN_ARGS)
+{
+
+       print_otag(h, TAG_BR, 0, NULL);
+       return(0);
+}
+
+
 /* ARGSUSED */
 static int
 man_ign_pre(MAN_ARGS)