]> git.cameronkatri.com Git - mandoc.git/blobdiff - man_html.c
Rename manup(8) to catman(8), which Linux already uses for a similar tool.
[mandoc.git] / man_html.c
index 9e666c77812f213d1bcf2a06679d766025e17365..580ef779e3c7d6a0f3fbbfd1443449bb40b6f38e 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: man_html.c,v 1.63 2011/01/12 10:43:22 kristaps Exp $ */
+/*     $Id: man_html.c,v 1.84 2011/11/18 17:05:50 joerg Exp $ */
 /*
- * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
+ * Copyright (c) 2008, 2009, 2010, 2011 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
@@ -36,7 +36,6 @@
 /* FIXME: have PD set the default vspace width. */
 
 #define        INDENT            5
-#define        HALFINDENT        3
 
 #define        MAN_ARGS          const struct man_meta *m, \
                          const struct man_node *n, \
@@ -53,6 +52,8 @@ struct        htmlman {
        int             (*post)(MAN_ARGS);
 };
 
+static void              print_bvspace(struct html *, 
+                               const struct man_node *);
 static void              print_man(MAN_ARGS);
 static void              print_man_head(MAN_ARGS);
 static void              print_man_nodelist(MAN_ARGS);
@@ -67,7 +68,7 @@ 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 void              man_root_pre(MAN_ARGS);
 static int               man_B_pre(MAN_ARGS);
 static int               man_HP_pre(MAN_ARGS);
 static int               man_I_pre(MAN_ARGS);
@@ -100,7 +101,7 @@ static      const struct htmlman mans[MAN_MAX] = {
        { man_I_pre, NULL }, /* I */
        { man_alt_pre, NULL }, /* IR */
        { man_alt_pre, NULL }, /* RI */
-       { NULL, NULL }, /* na */
+       { man_ign_pre, NULL }, /* na */
        { man_br_pre, NULL }, /* sp */
        { man_literal_pre, NULL }, /* nf */
        { man_literal_pre, NULL }, /* fi */
@@ -114,38 +115,58 @@ static    const struct htmlman mans[MAN_MAX] = {
        { man_ign_pre, NULL }, /* ft */
 };
 
+/*
+ * Printing leading vertical space before a block.
+ * This is used for the paragraph macros.
+ * The rules are pretty simple, since there's very little nesting going
+ * on here.  Basically, if we're the first within another block (SS/SH),
+ * then don't emit vertical space.  If we are (RS), then do.  If not the
+ * first, print it.
+ */
+static void
+print_bvspace(struct html *h, const struct man_node *n)
+{
+
+       if (n->body && n->body->child)
+               if (MAN_TBL == n->body->child->type)
+                       return;
+
+       if (MAN_ROOT == n->parent->type || MAN_RS != n->parent->tok)
+               if (NULL == n->prev)
+                       return;
+
+       print_otag(h, TAG_P, 0, NULL);
+}
 
 void
 html_man(void *arg, const struct man *m)
 {
-       struct html     *h;
-       struct tag      *t;
        struct mhtml     mh;
 
-       h = (struct html *)arg;
-
-       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), &mh, h);
-       print_tagq(h, t);
-
-       printf("\n");
+       print_man(man_meta(m), man_node(m), &mh, (struct html *)arg);
+       putchar('\n');
 }
 
-
 static void
 print_man(MAN_ARGS) 
 {
-       struct tag      *t;
+       struct tag      *t, *tt;
+       struct htmlpair  tag;
 
-       t = print_otag(h, TAG_HEAD, 0, NULL);
-       print_man_head(m, n, mh, h);
-       print_tagq(h, t);
+       PAIR_CLASS_INIT(&tag, "mandoc");
+
+       if ( ! (HTML_FRAGMENT & h->oflags)) {
+               print_gen_decls(h);
+               t = print_otag(h, TAG_HTML, 0, NULL);
+               tt = print_otag(h, TAG_HEAD, 0, NULL);
+               print_man_head(m, n, mh, h);
+               print_tagq(h, tt);
+               print_otag(h, TAG_BODY, 0, NULL);
+               print_otag(h, TAG_DIV, 1, &tag);
+       } else 
+               t = print_otag(h, TAG_DIV, 1, &tag);
 
-       t = print_otag(h, TAG_BODY, 0, NULL);
        print_man_nodelist(m, n, mh, h);
        print_tagq(h, t);
 }
@@ -157,9 +178,7 @@ print_man_head(MAN_ARGS)
 {
 
        print_gen_head(h);
-       bufinit(h);
-       buffmt(h, "%s(%s)", m->title, m->msec);
-
+       bufcat_fmt(h, "%s(%s)", m->title, m->msec);
        print_otag(h, TAG_TITLE, 0, NULL);
        print_text(h, h->buf);
 }
@@ -184,19 +203,16 @@ print_man_node(MAN_ARGS)
        child = 1;
        t = h->tags.head;
 
-       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, mh, h);
+               man_root_pre(m, n, mh, h);
                break;
        case (MAN_TEXT):
+               /*
+                * If we have a blank line, output a vertical space.
+                * If we have a space as the first character, break
+                * before printing the line's data.
+                */
                if ('\0' == *n->string) {
                        print_otag(h, TAG_P, 0, NULL);
                        return;
@@ -204,25 +220,41 @@ print_man_node(MAN_ARGS)
 
                if (' ' == *n->string && MAN_LINE & n->flags)
                        print_otag(h, TAG_BR, 0, NULL);
+               else if (MANH_LITERAL & mh->fl && n->prev)
+                       print_otag(h, TAG_BR, 0, NULL);
 
                print_text(h, n->string);
-
-               if (MANH_LITERAL & mh->fl)
-                       print_otag(h, TAG_BR, 0, NULL);
                return;
+       case (MAN_EQN):
+               print_eqn(h, n->eqn);
+               break;
        case (MAN_TBL):
+               /*
+                * This will take care of initialising all of the table
+                * state data for the first table, then tearing it down
+                * for the last one.
+                */
                print_tbl(h, n->span);
-               break;
+               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).
+                * scope.
                 */
                if (HTMLFONT_NONE != h->metac) {
                        h->metal = h->metac;
                        h->metac = HTMLFONT_NONE;
                }
+
+               /*
+                * Close out the current table, if it's open, and unset
+                * the "meta" table state.  This will be reopened on the
+                * next table element.
+                */
+               if (h->tblt) {
+                       print_tblclose(h);
+                       t = h->tags.head;
+               }
                if (mans[n->tok].pre)
                        child = (*mans[n->tok].pre)(m, n, mh, h);
                break;
@@ -234,13 +266,11 @@ print_man_node(MAN_ARGS)
        /* 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, mh, h);
                break;
-       case (MAN_TBL):
+       case (MAN_EQN):
                break;
        default:
                if (mans[n->tok].post)
@@ -264,7 +294,7 @@ a2width(const struct man_node *n, struct roffsu *su)
 
 
 /* ARGSUSED */
-static int
+static void
 man_root_pre(MAN_ARGS)
 {
        struct htmlpair  tag[3];
@@ -275,19 +305,17 @@ man_root_pre(MAN_ARGS)
        if (m->vol)
                (void)strlcat(b, m->vol, BUFSIZ);
 
-       snprintf(title, BUFSIZ - 1, "%s(%s)", m->title, m->msec);
+       snprintf(title, BUFSIZ - 1, "%s(%s)", m->title ? m->title : "",
+           m->msec ? m->msec : "");
 
        PAIR_SUMMARY_INIT(&tag[0], "Document Header");
        PAIR_CLASS_INIT(&tag[1], "head");
-       if (NULL == h->style) {
-               PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
-               t = print_otag(h, TAG_TABLE, 3, tag);
-               PAIR_INIT(&tag[0], ATTR_WIDTH, "30%");
-               print_otag(h, TAG_COL, 1, tag);
-               print_otag(h, TAG_COL, 1, tag);
-               print_otag(h, TAG_COL, 1, tag);
-       } else
-               t = print_otag(h, TAG_TABLE, 2, tag);
+       PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
+       t = print_otag(h, TAG_TABLE, 3, tag);
+       PAIR_INIT(&tag[0], ATTR_WIDTH, "30%");
+       print_otag(h, TAG_COL, 1, tag);
+       print_otag(h, TAG_COL, 1, tag);
+       print_otag(h, TAG_COL, 1, tag);
 
        print_otag(h, TAG_TBODY, 0, NULL);
 
@@ -295,30 +323,20 @@ man_root_pre(MAN_ARGS)
 
        PAIR_CLASS_INIT(&tag[0], "head-ltitle");
        print_otag(h, TAG_TD, 1, tag);
-
        print_text(h, title);
        print_stagq(h, tt);
 
        PAIR_CLASS_INIT(&tag[0], "head-vol");
-       if (NULL == h->style) {
-               PAIR_INIT(&tag[1], ATTR_ALIGN, "center");
-               print_otag(h, TAG_TD, 2, tag);
-       } else 
-               print_otag(h, TAG_TD, 1, tag);
-
+       PAIR_INIT(&tag[1], ATTR_ALIGN, "center");
+       print_otag(h, TAG_TD, 2, tag);
        print_text(h, b);
        print_stagq(h, tt);
 
        PAIR_CLASS_INIT(&tag[0], "head-rtitle");
-       if (NULL == h->style) {
-               PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
-               print_otag(h, TAG_TD, 2, tag);
-       } else 
-               print_otag(h, TAG_TD, 1, tag);
-
+       PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
+       print_otag(h, TAG_TD, 2, tag);
        print_text(h, title);
        print_tagq(h, t);
-       return(1);
 }
 
 
@@ -328,38 +346,27 @@ man_root_post(MAN_ARGS)
 {
        struct htmlpair  tag[3];
        struct tag      *t, *tt;
-       char             b[DATESIZ];
-
-       if (m->rawdate)
-               strlcpy(b, m->rawdate, DATESIZ);
-       else
-               time2a(m->date, b, DATESIZ);
 
        PAIR_SUMMARY_INIT(&tag[0], "Document Footer");
        PAIR_CLASS_INIT(&tag[1], "foot");
-       if (NULL == h->style) {
-               PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
-               t = print_otag(h, TAG_TABLE, 3, tag);
-               PAIR_INIT(&tag[0], ATTR_WIDTH, "50%");
-               print_otag(h, TAG_COL, 1, tag);
-               print_otag(h, TAG_COL, 1, tag);
-       } else
-               t = print_otag(h, TAG_TABLE, 2, tag);
+       PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
+       t = print_otag(h, TAG_TABLE, 3, tag);
+       PAIR_INIT(&tag[0], ATTR_WIDTH, "50%");
+       print_otag(h, TAG_COL, 1, tag);
+       print_otag(h, TAG_COL, 1, tag);
 
        tt = print_otag(h, TAG_TR, 0, NULL);
 
        PAIR_CLASS_INIT(&tag[0], "foot-date");
        print_otag(h, TAG_TD, 1, tag);
 
-       print_text(h, b);
+       if (m->date)
+               print_text(h, m->date);
        print_stagq(h, tt);
 
        PAIR_CLASS_INIT(&tag[0], "foot-os");
-       if (NULL == h->style) {
-               PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
-               print_otag(h, TAG_TD, 2, tag);
-       } else 
-               print_otag(h, TAG_TD, 1, tag);
+       PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
+       print_otag(h, TAG_TD, 2, tag);
 
        if (m->source)
                print_text(h, m->source);
@@ -367,7 +374,6 @@ man_root_post(MAN_ARGS)
 }
 
 
-
 /* ARGSUSED */
 static int
 man_br_pre(MAN_ARGS)
@@ -378,11 +384,13 @@ man_br_pre(MAN_ARGS)
        SCALE_VS_INIT(&su, 1);
 
        if (MAN_sp == n->tok) {
-               if (n->child)
-                       a2roffsu(n->child->string, &su, SCALE_VS);
+               if (NULL != (n = n->child))
+                       if ( ! a2roffsu(n->string, &su, SCALE_VS))
+                               SCALE_VS_INIT(&su, atoi(n->string));
        } else
                su.scale = 0;
 
+       bufinit(h);
        bufcat_su(h, "height", &su);
        PAIR_STYLE_INIT(&tag, h);
        print_otag(h, TAG_DIV, 1, &tag);
@@ -393,7 +401,6 @@ man_br_pre(MAN_ARGS)
        return(0);
 }
 
-
 /* ARGSUSED */
 static int
 man_SH_pre(MAN_ARGS)
@@ -401,6 +408,7 @@ man_SH_pre(MAN_ARGS)
        struct htmlpair  tag;
 
        if (MAN_BLOCK == n->type) {
+               mh->fl &= ~MANH_LITERAL;
                PAIR_CLASS_INIT(&tag, "section");
                print_otag(h, TAG_DIV, 1, &tag);
                return(1);
@@ -411,16 +419,20 @@ man_SH_pre(MAN_ARGS)
        return(1);
 }
 
-
 /* ARGSUSED */
 static int
 man_alt_pre(MAN_ARGS)
 {
        const struct man_node   *nn;
-       int              i;
+       int              i, savelit;
        enum htmltag     fp;
        struct tag      *t;
 
+       if ((savelit = mh->fl & MANH_LITERAL)) 
+               print_otag(h, TAG_BR, 0, NULL);
+
+       mh->fl &= ~MANH_LITERAL;
+
        for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
                t = NULL;
                switch (n->tok) {
@@ -459,10 +471,12 @@ man_alt_pre(MAN_ARGS)
                        print_tagq(h, t);
        }
 
+       if (savelit)
+               mh->fl |= MANH_LITERAL;
+
        return(0);
 }
 
-
 /* ARGSUSED */
 static int
 man_SM_pre(MAN_ARGS)
@@ -474,7 +488,6 @@ man_SM_pre(MAN_ARGS)
        return(1);
 }
 
-
 /* ARGSUSED */
 static int
 man_SS_pre(MAN_ARGS)
@@ -482,6 +495,7 @@ man_SS_pre(MAN_ARGS)
        struct htmlpair  tag;
 
        if (MAN_BLOCK == n->type) {
+               mh->fl &= ~MANH_LITERAL;
                PAIR_CLASS_INIT(&tag, "subsection");
                print_otag(h, TAG_DIV, 1, &tag);
                return(1);
@@ -492,7 +506,6 @@ man_SS_pre(MAN_ARGS)
        return(1);
 }
 
-
 /* ARGSUSED */
 static int
 man_PP_pre(MAN_ARGS)
@@ -500,67 +513,29 @@ man_PP_pre(MAN_ARGS)
 
        if (MAN_HEAD == n->type)
                return(0);
-       else if (MAN_BODY == n->type && n->prev)
-               print_otag(h, TAG_P, 0, NULL);
+       else if (MAN_BLOCK == n->type)
+               print_bvspace(h, n);
 
        return(1);
 }
 
-
 /* ARGSUSED */
 static int
 man_IP_pre(MAN_ARGS)
 {
-       struct roffsu            su;
-       struct htmlpair          tag;
        const struct man_node   *nn;
 
-       /*
-        * This scattering of 1-BU margins and pads is to make sure that
-        * when text overruns its box, the subsequent text isn't flush
-        * up against it.  However, the rest of the right-hand box must
-        * also be adjusted in consideration of this 1-BU space.
-        */
-
        if (MAN_BODY == n->type) { 
-               print_otag(h, TAG_TD, 0, NULL);
+               print_otag(h, TAG_DD, 0, NULL);
+               return(1);
+       } else if (MAN_HEAD != n->type) {
+               print_otag(h, TAG_DL, 0, NULL);
                return(1);
        }
 
-       nn = MAN_BLOCK == n->type ? 
-               n->head->child : n->parent->head->child;
-
-       SCALE_HS_INIT(&su, INDENT);
-
-       /* Width is the second token. */
-
-       if (MAN_IP == n->tok && NULL != nn)
-               if (NULL != (nn = nn->next))
-                       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)
-                       a2width(nn, &su);
-       }
-
-       if (MAN_BLOCK == n->type) {
-               print_otag(h, TAG_P, 0, NULL);
-               print_otag(h, TAG_TABLE, 0, NULL);
-               bufcat_su(h, "width", &su);
-               PAIR_STYLE_INIT(&tag, h);
-               print_otag(h, TAG_COL, 1, &tag);
-               print_otag(h, TAG_COL, 0, NULL);
-               print_otag(h, TAG_TBODY, 0, NULL);
-               print_otag(h, TAG_TR, 0, NULL);
-               return(1);
-       } 
+       /* FIXME: width specification. */
 
-       print_otag(h, TAG_TD, 0, NULL);
+       print_otag(h, TAG_DT, 0, NULL);
 
        /* For IP, only print the first header element. */
 
@@ -577,7 +552,6 @@ man_IP_pre(MAN_ARGS)
        return(0);
 }
 
-
 /* ARGSUSED */
 static int
 man_HP_pre(MAN_ARGS)
@@ -586,36 +560,27 @@ man_HP_pre(MAN_ARGS)
        struct roffsu    su;
        const struct man_node *np;
 
-       np = MAN_BLOCK == n->type ? 
-               n->head->child : 
-               n->parent->head->child;
+       if (MAN_HEAD == n->type)
+               return(0);
+       else if (MAN_BLOCK != n->type)
+               return(1);
+
+       np = n->head->child;
 
        if (NULL == np || ! a2width(np, &su))
                SCALE_HS_INIT(&su, INDENT);
 
-       if (MAN_HEAD == n->type) {
-               print_otag(h, TAG_TD, 0, NULL);
-               return(0);
-       } else if (MAN_BLOCK == n->type) {
-               print_otag(h, TAG_P, 0, NULL);
-               print_otag(h, TAG_TABLE, 0, NULL);
-               bufcat_su(h, "width", &su);
-               PAIR_STYLE_INIT(&tag, h);
-               print_otag(h, TAG_COL, 1, &tag);
-               print_otag(h, TAG_COL, 0, NULL);
-               print_otag(h, TAG_TBODY, 0, NULL);
-               print_otag(h, TAG_TR, 0, NULL);
-               return(1);
-       }
+       bufinit(h);
 
+       print_bvspace(h, n);
+       bufcat_su(h, "margin-left", &su);
        su.scale = -su.scale;
        bufcat_su(h, "text-indent", &su);
        PAIR_STYLE_INIT(&tag, h);
-       print_otag(h, TAG_TD, 1, &tag);
+       print_otag(h, TAG_P, 1, &tag);
        return(1);
 }
 
-
 /* ARGSUSED */
 static int
 man_B_pre(MAN_ARGS)
@@ -625,7 +590,6 @@ man_B_pre(MAN_ARGS)
        return(1);
 }
 
-
 /* ARGSUSED */
 static int
 man_I_pre(MAN_ARGS)
@@ -635,22 +599,20 @@ man_I_pre(MAN_ARGS)
        return(1);
 }
 
-
 /* ARGSUSED */
 static int
 man_literal_pre(MAN_ARGS)
 {
 
-       if (MAN_nf == n->tok) {
+       if (MAN_nf != n->tok) {
                print_otag(h, TAG_BR, 0, NULL);
-               mh->fl |= MANH_LITERAL;
-       } else
                mh->fl &= ~MANH_LITERAL;
+       } else
+               mh->fl |= MANH_LITERAL;
 
-       return(1);
+       return(0);
 }
 
-
 /* ARGSUSED */
 static int
 man_in_pre(MAN_ARGS)
@@ -660,7 +622,6 @@ man_in_pre(MAN_ARGS)
        return(0);
 }
 
-
 /* ARGSUSED */
 static int
 man_ign_pre(MAN_ARGS)
@@ -669,7 +630,6 @@ man_ign_pre(MAN_ARGS)
        return(0);
 }
 
-
 /* ARGSUSED */
 static int
 man_RS_pre(MAN_ARGS)
@@ -686,6 +646,7 @@ man_RS_pre(MAN_ARGS)
        if (n->head->child)
                a2width(n->head->child, &su);
 
+       bufinit(h);
        bufcat_su(h, "margin-left", &su);
        PAIR_STYLE_INIT(&tag, h);
        print_otag(h, TAG_DIV, 1, &tag);