OpenBSD src/sbin was used as a tool to hunt bugs in mandoc.

[mandoc.git] / man_html.c

diff --git a/man_html.c b/man_html.c
index 5f6c4cf2fc172f4fa91f5b49275be55414b6b7bd..0a386e07db7a4d1c8e4afa8774380a3fc2535d1a 100644 (file)
--- a/man_html.c
+++ b/man_html.c
@@ -1,6 +1,6 @@
-/*     $Id: man_html.c,v 1.23 2009/11/16 06:07:49 kristaps Exp $ */
+/*     $Id: man_html.c,v 1.45 2010/07/23 12:27:28 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
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above


@@ -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.
  */
  * 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>
 #include <sys/types.h>
 
 #include <assert.h>


@@ -22,6 +26,7 @@
 #include <stdlib.h>
 #include <string.h>
 
 #include <stdlib.h>
 #include <string.h>
 

+#include "mandoc.h"

 #include "out.h"
 #include "html.h"
 #include "man.h"
 #include "out.h"
 #include "html.h"
 #include "man.h"


@@ -35,8 +40,14 @@
 
 #define        MAN_ARGS          const struct man_meta *m, \
                          const struct man_node *n, \
 
 #define        MAN_ARGS          const struct man_meta *m, \
                          const struct man_node *n, \

+                         struct mhtml *mh, \

                          struct html *h
 
                          struct html *h
 

+struct mhtml {
+       int               fl;
+#define        MANH_LITERAL     (1 << 0) /* literal context */
+};
+

 struct htmlman {
        int             (*pre)(MAN_ARGS);
        int             (*post)(MAN_ARGS);
 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_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);
 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);
 
 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 */
 static const struct htmlman mans[MAN_MAX] = {
        { man_br_pre, NULL }, /* br */
        { NULL, NULL }, /* TH */


@@ -96,14 +104,19 @@ static     const struct htmlman mans[MAN_MAX] = {
        { NULL, NULL }, /* na */
        { NULL, NULL }, /* i */
        { man_br_pre, NULL }, /* sp */
        { 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 */
        { 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_br_pre, NULL }, /* Sp */
+       { man_literal_pre, NULL }, /* Vb */
+       { man_literal_pre, NULL }, /* Ve */
+       { man_ign_pre, NULL }, /* AT */
+       { man_in_pre, NULL }, /* in */

 };
 
 
 };
 
 


@@ -112,13 +125,16 @@ html_man(void *arg, const struct man *m)
 {
        struct html     *h;
        struct tag      *t;
 {
        struct html     *h;
        struct tag      *t;

+       struct mhtml     mh;

 
        h = (struct html *)arg;
 
 
        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);
 
        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");
        print_tagq(h, t);
 
        printf("\n");


@@ -133,7 +149,7 @@ print_man(MAN_ARGS)
 
        t = print_otag(h, TAG_HEAD, 0, NULL);
 
 
        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);
 
        print_tagq(h, t);
        t = print_otag(h, TAG_BODY, 0, NULL);
 


@@ -141,7 +157,7 @@ print_man(MAN_ARGS)
        tag.val = "body";
        print_otag(h, TAG_DIV, 1, &tag);
 
        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);
 }
 
        print_tagq(h, t);
 }


@@ -154,7 +170,7 @@ print_man_head(MAN_ARGS)
 
        print_gen_head(h);
        bufinit(h);
 
        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);
 
        print_otag(h, TAG_TITLE, 0, NULL);
        print_text(h, h->buf);


@@ -165,9 +181,9 @@ static void
 print_man_nodelist(MAN_ARGS)
 {
 
 print_man_nodelist(MAN_ARGS)
 {
 

-       print_man_node(m, n, h);
+       print_man_node(m, n, mh, h);

        if (n->next)
        if (n->next)

-               print_man_nodelist(m, n->next, h);
+               print_man_nodelist(m, n->next, mh, h);

 }
 
 
 }
 
 


@@ -182,12 +198,22 @@ print_man_node(MAN_ARGS)
 
        bufinit(h);
 
 
        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):
        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);
                break;
        case (MAN_TEXT):
                print_text(h, n->string);

+
+               if (MANH_LITERAL & mh->fl)
+                       print_otag(h, TAG_BR, 0, NULL);
+

                return;
        default:
                /* 
                return;
        default:
                /* 


@@ -202,26 +228,27 @@ print_man_node(MAN_ARGS)
                        t = h->tags.head;
                }
                if (mans[n->tok].pre)
                        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)
                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):
        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)
                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;
        }
 }
                break;
        }
 }


@@ -252,8 +279,7 @@ man_root_pre(MAN_ARGS)
        if (m->vol)
                (void)strlcat(b, m->vol, BUFSIZ);
 
        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%");
 
        PAIR_CLASS_INIT(&tag[0], "header");
        bufcat_style(h, "width", "100%");


@@ -298,7 +324,10 @@ man_root_post(MAN_ARGS)
        struct tag      *t, *tt;
        char             b[DATESIZ];
 
        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%");
 
        PAIR_CLASS_INIT(&tag[0], "footer");
        bufcat_style(h, "width", "100%");


@@ -336,14 +365,23 @@ man_br_pre(MAN_ARGS)
 
        SCALE_VS_INIT(&su, 1);
 
 
        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):
+               SCALE_VS_INIT(&su, 0.5);
+               break;
+       case (MAN_sp):
+               if (n->child)
+                       a2roffsu(n->child->string, &su, SCALE_VS);
+               break;
+       default:

                su.scale = 0;
                su.scale = 0;

+               break;
+       }

 
        bufcat_su(h, "height", &su);
        PAIR_STYLE_INIT(&tag, h);
        print_otag(h, TAG_DIV, 1, &tag);
 
        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, "\\~");
 
        /* So the div isn't empty: */
        print_text(h, "\\~");
 


@@ -425,8 +463,13 @@ man_alt_pre(MAN_ARGS)
                if (i)
                        h->flags |= HTML_NOSPACE;
 
                if (i)
                        h->flags |= HTML_NOSPACE;
 

+               /* 
+                * 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);
                t = print_ofont(h, fp);

-               print_man_node(m, nn, h);
+               print_man_node(m, nn, mh, h);

                print_tagq(h, t);
        }
 
                print_tagq(h, t);
        }
 


@@ -562,6 +605,8 @@ man_IP_pre(MAN_ARGS)
        SCALE_HS_INIT(&su, INDENT);
        width = 0;
 
        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)
        if (MAN_IP == n->tok && NULL != nn)
                if (NULL != (nn = nn->next)) {
                        for ( ; nn->next; nn = nn->next)


@@ -569,8 +614,15 @@ man_IP_pre(MAN_ARGS)
                        width = a2width(nn, &su);
                }
 
                        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);
 
        if (MAN_BLOCK == n->type) {
                bufcat_su(h, "margin-left", &su);


@@ -595,17 +647,26 @@ man_IP_pre(MAN_ARGS)
        PAIR_STYLE_INIT(&tag, h);
        print_otag(h, TAG_DIV, 1, &tag);
 
        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);
 
 
        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)
        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)
        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);
 }
 
        return(0);
 }


@@ -670,6 +731,37 @@ man_I_pre(MAN_ARGS)
 }
 
 
 }
 
 

+/* ARGSUSED */
+static int
+man_literal_pre(MAN_ARGS)
+{
+
+       switch (n->tok) {
+       case (MAN_nf):
+               /* FALLTHROUGH */
+       case (MAN_Vb):
+               print_otag(h, TAG_BR, 0, NULL);
+               mh->fl |= MANH_LITERAL;
+               return(MAN_Vb != n->tok);
+       default:
+               mh->fl &= ~MANH_LITERAL;
+               break;
+       }
+
+       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)
 /* ARGSUSED */
 static int
 man_ign_pre(MAN_ARGS)