Clarify -man -T[x]html handling of `br' within `B'.

[mandoc.git] / man_html.c

diff --git a/man_html.c b/man_html.c
index 07806bf7423b58544768e041cddf598eb8034a30..495a5fca6cf0d0e36320dd5dc15acf976c14cebf 100644 (file)
--- a/man_html.c
+++ b/man_html.c
@@ -1,4 +1,4 @@
-/*     $Id: man_html.c,v 1.21 2009/11/15 06:45:31 kristaps Exp $ */
+/*     $Id: man_html.c,v 1.28 2010/03/22 14:03:03 kristaps Exp $ */
 /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -14,6 +14,10 @@
  * 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>
@@ -66,11 +70,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 */
@@ -115,7 +114,7 @@ html_man(void *arg, const struct man *m)
 
        h = (struct html *)arg;
 
-       print_gen_doctype(h);
+       print_gen_decls(h);
 
        t = print_otag(h, TAG_HTML, 0, NULL);
        print_man(man_meta(m), man_node(m), h);
@@ -182,6 +181,12 @@ 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);
@@ -209,6 +214,7 @@ print_man_node(MAN_ARGS)
        if (child && n->child)
                print_man_nodelist(m, n->child, h);
 
+       /* This will automatically close out any font scope. */
        print_stagq(h, t);
 
        bufinit(h);
@@ -252,8 +258,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(%d)", m->title, m->msec);
 
        PAIR_CLASS_INIT(&tag[0], "header");
        bufcat_style(h, "width", "100%");
@@ -344,6 +349,7 @@ man_br_pre(MAN_ARGS)
        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, "\\~");
 
@@ -395,31 +401,27 @@ man_alt_pre(MAN_ARGS)
        const struct man_node   *nn;
        struct tag              *t;
        int                      i;
-       struct htmlpair          tagi, tagb, tagr, *tagp;
-
-       PAIR_CLASS_INIT(&tagi, "italic");
-       PAIR_CLASS_INIT(&tagb, "bold");
-       PAIR_CLASS_INIT(&tagr, "roman");
+       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 : &tagr;
+                       fp = i % 2 ? HTMLFONT_ITALIC : HTMLFONT_NONE;
                        break;
                case (MAN_IR):
-                       tagp = i % 2 ? &tagr : &tagi;
+                       fp = i % 2 ? HTMLFONT_NONE : HTMLFONT_ITALIC;
                        break;
                case (MAN_BR):
-                       tagp = i % 2 ? &tagr : &tagb;
+                       fp = i % 2 ? HTMLFONT_NONE : HTMLFONT_BOLD;
                        break;
                case (MAN_RB):
-                       tagp = i % 2 ? &tagb : &tagr;
+                       fp = i % 2 ? HTMLFONT_BOLD : HTMLFONT_NONE;
                        break;
                default:
                        abort();
@@ -429,7 +431,12 @@ man_alt_pre(MAN_ARGS)
                if (i)
                        h->flags |= HTML_NOSPACE;
 
-               t = print_otag(h, TAG_SPAN, 1, tagp);
+               /* 
+                * 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, h);
                print_tagq(h, t);
        }
@@ -444,6 +451,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);
@@ -518,19 +526,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);
 }
 
@@ -565,6 +573,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)
@@ -572,8 +582,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);
@@ -598,11 +615,20 @@ 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);
@@ -657,10 +683,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);
 }
 
@@ -669,10 +693,8 @@ man_B_pre(MAN_ARGS)
 static int
 man_I_pre(MAN_ARGS)
 {
-       struct htmlpair  tag;
-
-       PAIR_CLASS_INIT(&tag, "italic");
-       print_otag(h, TAG_SPAN, 1, &tag);
+       
+       print_ofont(h, HTMLFONT_ITALIC);
        return(1);
 }