]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_html.c
Make empty sections and parts (SH, SS, RS) only produce a warning if it
[mandoc.git] / mdoc_html.c
index 9f392a9b78874901a6fff048fbf150009af2b8cd..9656aced55e87bbaafeb2ed1ad9df7a15d7e3b39 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_html.c,v 1.132 2010/12/20 10:40:11 kristaps Exp $ */
+/*     $Id: mdoc_html.c,v 1.155 2011/03/22 14:05:45 kristaps 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
@@ -410,6 +410,7 @@ print_mdoc_node(MDOC_ARGS)
 {
        int              child;
        struct tag      *t;
+       struct htmlpair  tag;
 
        child = 1;
        t = h->tags.head;
@@ -420,9 +421,47 @@ print_mdoc_node(MDOC_ARGS)
                child = mdoc_root_pre(m, n, h);
                break;
        case (MDOC_TEXT):
+               /* No tables in this mode... */
+               assert(NULL == h->tblt);
+
+               /*
+                * Make sure that if we're in a literal mode already
+                * (i.e., within a <PRE>) don't print the newline.
+                */
+               if (' ' == *n->string && MDOC_LINE & n->flags)
+                       if ( ! (HTML_LITERAL & h->flags))
+                               print_otag(h, TAG_BR, 0, NULL);
+               if (MDOC_DELIMC & n->flags)
+                       h->flags |= HTML_NOSPACE;
                print_text(h, n->string);
+               if (MDOC_DELIMO & n->flags)
+                       h->flags |= HTML_NOSPACE;
+               return;
+       case (MDOC_EQN):
+               PAIR_CLASS_INIT(&tag, "eqn");
+               print_otag(h, TAG_SPAN, 1, &tag);
+               print_text(h, n->eqn->data);
+               break;
+       case (MDOC_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);
                return;
        default:
+               /*
+                * 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;
+               }
+
+               assert(NULL == h->tblt);
                if (mdocs[n->tok].pre && ENDBODY_NOT == n->end)
                        child = (*mdocs[n->tok].pre)(m, n, h);
                break;
@@ -450,6 +489,8 @@ print_mdoc_node(MDOC_ARGS)
        case (MDOC_ROOT):
                mdoc_root_post(m, n, h);
                break;
+       case (MDOC_EQN):
+               break;
        default:
                if (mdocs[n->tok].post && ENDBODY_NOT == n->end)
                        (*mdocs[n->tok].post)(m, n, h);
@@ -463,14 +504,11 @@ mdoc_root_post(MDOC_ARGS)
 {
        struct htmlpair  tag[3];
        struct tag      *t, *tt;
-       char             b[DATESIZ];
-
-       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[1], ATTR_WIDTH, "100%");
+               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);
@@ -485,7 +523,7 @@ mdoc_root_post(MDOC_ARGS)
        PAIR_CLASS_INIT(&tag[0], "foot-date");
        print_otag(h, TAG_TD, 1, tag);
 
-       print_text(h, b);
+       print_text(h, m->date);
        print_stagq(h, tt);
 
        PAIR_CLASS_INIT(&tag[0], "foot-os");
@@ -751,7 +789,8 @@ static int
 mdoc_ns_pre(MDOC_ARGS)
 {
 
-       h->flags |= HTML_NOSPACE;
+       if ( ! (MDOC_LINE & n->flags))
+               h->flags |= HTML_NOSPACE;
        return(1);
 }
 
@@ -763,7 +802,7 @@ mdoc_ar_pre(MDOC_ARGS)
        struct htmlpair tag;
 
        PAIR_CLASS_INIT(&tag, "arg");
-       print_otag(h, TAG_SPAN, 1, &tag);
+       print_otag(h, TAG_I, 1, &tag);
        return(1);
 }
 
@@ -774,6 +813,7 @@ mdoc_xx_pre(MDOC_ARGS)
 {
        const char      *pp;
        struct htmlpair  tag;
+       int              flags;
 
        switch (n->tok) {
        case (MDOC_Bsx):
@@ -800,8 +840,15 @@ mdoc_xx_pre(MDOC_ARGS)
 
        PAIR_CLASS_INIT(&tag, "unix");
        print_otag(h, TAG_SPAN, 1, &tag);
+
        print_text(h, pp);
-       return(1);
+       if (n->child) {
+               flags = h->flags;
+               h->flags |= HTML_KEEP;
+               print_text(h, n->child->string);
+               h->flags = flags;
+       }
+       return(0);
 }
 
 
@@ -809,22 +856,31 @@ mdoc_xx_pre(MDOC_ARGS)
 static int
 mdoc_bx_pre(MDOC_ARGS)
 {
-       const struct mdoc_node  *nn;
-       struct htmlpair          tag;
+       struct htmlpair  tag;
 
        PAIR_CLASS_INIT(&tag, "unix");
        print_otag(h, TAG_SPAN, 1, &tag);
 
-       for (nn = n->child; nn; nn = nn->next)
-               print_mdoc_node(m, nn, h);
+       if (NULL != (n = n->child)) {
+               print_text(h, n->string);
+               h->flags |= HTML_NOSPACE;
+               print_text(h, "BSD");
+       } else {
+               print_text(h, "BSD");
+               return(0);
+       }
 
-       if (n->child)
+       if (NULL != (n = n->next)) {
                h->flags |= HTML_NOSPACE;
+               print_text(h, "-");
+               h->flags |= HTML_NOSPACE;
+               print_text(h, n->string);
+       }
 
-       print_text(h, "BSD");
        return(0);
 }
 
+/* ARGSUSED */
 static int
 mdoc_it_pre(MDOC_ARGS)
 {
@@ -839,7 +895,7 @@ mdoc_it_pre(MDOC_ARGS)
 
        assert(bl);
 
-       type = bl->data.Bl->type;
+       type = bl->norm->Bl.type;
 
        assert(lists[type]);
        PAIR_CLASS_INIT(&tag[0], lists[type]);
@@ -857,7 +913,6 @@ mdoc_it_pre(MDOC_ARGS)
                case(LIST_enum):
                        return(0);
                case(LIST_diag):
-                       /* FIXME: STYLE for diag! */
                        /* FALLTHROUGH */
                case(LIST_hang):
                        /* FALLTHROUGH */
@@ -866,10 +921,14 @@ mdoc_it_pre(MDOC_ARGS)
                case(LIST_ohang):
                        /* FALLTHROUGH */
                case(LIST_tag):
-                       SCALE_VS_INIT(&su, ! bl->data.Bl->comp);
+                       SCALE_VS_INIT(&su, ! bl->norm->Bl.comp);
                        bufcat_su(h, "margin-top", &su);
                        PAIR_STYLE_INIT(&tag[1], h);
                        print_otag(h, TAG_DT, 2, tag);
+                       if (LIST_diag != type)
+                               break;
+                       PAIR_CLASS_INIT(&tag[0], "diag");
+                       print_otag(h, TAG_B, 1, tag);
                        break;
                case(LIST_column):
                        break;
@@ -887,7 +946,7 @@ mdoc_it_pre(MDOC_ARGS)
                case(LIST_enum):
                        /* FALLTHROUGH */
                case(LIST_item):
-                       SCALE_VS_INIT(&su, ! bl->data.Bl->comp);
+                       SCALE_VS_INIT(&su, ! bl->norm->Bl.comp);
                        bufcat_su(h, "margin-top", &su);
                        PAIR_STYLE_INIT(&tag[1], h);
                        print_otag(h, TAG_LI, 2, tag);
@@ -901,17 +960,17 @@ mdoc_it_pre(MDOC_ARGS)
                case(LIST_ohang):
                        /* FALLTHROUGH */
                case(LIST_tag):
-                       if (NULL == bl->data.Bl->width) {
+                       if (NULL == bl->norm->Bl.width) {
                                print_otag(h, TAG_DD, 1, tag);
                                break;
                        }
-                       a2width(bl->data.Bl->width, &su);
+                       a2width(bl->norm->Bl.width, &su);
                        bufcat_su(h, "margin-left", &su);
                        PAIR_STYLE_INIT(&tag[1], h);
                        print_otag(h, TAG_DD, 2, tag);
                        break;
                case(LIST_column):
-                       SCALE_VS_INIT(&su, ! bl->data.Bl->comp);
+                       SCALE_VS_INIT(&su, ! bl->norm->Bl.comp);
                        bufcat_su(h, "margin-top", &su);
                        PAIR_STYLE_INIT(&tag[1], h);
                        print_otag(h, TAG_TD, 2, tag);
@@ -936,18 +995,19 @@ mdoc_it_pre(MDOC_ARGS)
 static int
 mdoc_bl_pre(MDOC_ARGS)
 {
-       size_t           i;
+       int              i;
        struct htmlpair  tag[3];
        struct roffsu    su;
+       char             buf[BUFSIZ];
 
        if (MDOC_BODY == n->type) {
-               if (LIST_column == n->data.Bl->type)
+               if (LIST_column == n->norm->Bl.type)
                        print_otag(h, TAG_TBODY, 0, NULL);
                return(1);
        }
 
        if (MDOC_HEAD == n->type) {
-               if (LIST_column != n->data.Bl->type)
+               if (LIST_column != n->norm->Bl.type)
                        return(0);
 
                /*
@@ -957,10 +1017,10 @@ mdoc_bl_pre(MDOC_ARGS)
                 * screen and we want to preserve that behaviour.
                 */
 
-               for (i = 0; i < n->data.Bl->ncols; i++) {
-                       a2width(n->data.Bl->cols[i], &su);
+               for (i = 0; i < (int)n->norm->Bl.ncols; i++) {
+                       a2width(n->norm->Bl.cols[i], &su);
                        bufinit(h);
-                       if (i < n->data.Bl->ncols - 1)
+                       if (i < (int)n->norm->Bl.ncols - 1)
                                bufcat_su(h, "width", &su);
                        else
                                bufcat_su(h, "min-width", &su);
@@ -976,23 +1036,19 @@ mdoc_bl_pre(MDOC_ARGS)
        bufcat_su(h, "margin-bottom", &su);
        PAIR_STYLE_INIT(&tag[0], h);
 
-       assert(lists[n->data.Bl->type]);
-       bufinit(h);
-       bufcat(h, "list ");
-       bufcat(h, lists[n->data.Bl->type]);
-       PAIR_INIT(&tag[1], ATTR_CLASS, h->buf);
-       i = 2;
+       assert(lists[n->norm->Bl.type]);
+       strlcpy(buf, "list ", BUFSIZ);
+       strlcat(buf, lists[n->norm->Bl.type], BUFSIZ);
+       PAIR_INIT(&tag[1], ATTR_CLASS, buf);
 
        /* Set the block's left-hand margin. */
 
-       if (n->data.Bl->offs) {
-               a2offs(n->data.Bl->offs, &su);
+       if (n->norm->Bl.offs) {
+               a2offs(n->norm->Bl.offs, &su);
                bufcat_su(h, "margin-left", &su);
-               PAIR_STYLE_INIT(&tag[2], h);
-               i = 3;
        }
 
-       switch (n->data.Bl->type) {
+       switch (n->norm->Bl.type) {
        case(LIST_bullet):
                /* FALLTHROUGH */
        case(LIST_dash):
@@ -1000,10 +1056,10 @@ mdoc_bl_pre(MDOC_ARGS)
        case(LIST_hyphen):
                /* FALLTHROUGH */
        case(LIST_item):
-               print_otag(h, TAG_UL, i, tag);
+               print_otag(h, TAG_UL, 2, tag);
                break;
        case(LIST_enum):
-               print_otag(h, TAG_OL, i, tag);
+               print_otag(h, TAG_OL, 2, tag);
                break;
        case(LIST_diag):
                /* FALLTHROUGH */
@@ -1014,10 +1070,10 @@ mdoc_bl_pre(MDOC_ARGS)
        case(LIST_ohang):
                /* FALLTHROUGH */
        case(LIST_tag):
-               print_otag(h, TAG_DL, i, tag);
+               print_otag(h, TAG_DL, 2, tag);
                break;
        case(LIST_column):
-               print_otag(h, TAG_TABLE, i, tag);
+               print_otag(h, TAG_TABLE, 2, tag);
                break;
        default:
                abort();
@@ -1096,12 +1152,14 @@ mdoc_d1_pre(MDOC_ARGS)
 
        /* BLOCKQUOTE needs a block body. */
 
-       if (MDOC_Dl == n->tok)
-               PAIR_CLASS_INIT(&tag[0], "lit display");
-       else
-               PAIR_CLASS_INIT(&tag[0], "display");
-
+       PAIR_CLASS_INIT(&tag[0], "display");
        print_otag(h, TAG_DIV, 1, tag);
+
+       if (MDOC_Dl == n->tok) {
+               PAIR_CLASS_INIT(&tag[0], "lit");
+               print_otag(h, TAG_CODE, 1, tag);
+       } 
+
        return(1);
 }
 
@@ -1124,6 +1182,7 @@ mdoc_sx_pre(MDOC_ARGS)
        PAIR_CLASS_INIT(&tag[0], "link-sec");
        PAIR_HREF_INIT(&tag[1], buf);
 
+       print_otag(h, TAG_I, 1, tag);
        print_otag(h, TAG_A, 2, tag);
        return(1);
 }
@@ -1134,7 +1193,7 @@ static int
 mdoc_bd_pre(MDOC_ARGS)
 {
        struct htmlpair          tag[2];
-       int                      comp;
+       int                      comp, sv;
        const struct mdoc_node  *nn;
        struct roffsu            su;
 
@@ -1142,7 +1201,7 @@ mdoc_bd_pre(MDOC_ARGS)
                return(0);
 
        if (MDOC_BLOCK == n->type) {
-               comp = n->data.Bd->comp;
+               comp = n->norm->Bd.comp;
                for (nn = n; nn && ! comp; nn = nn->parent) {
                        if (MDOC_BLOCK != nn->type)
                                continue;
@@ -1157,14 +1216,14 @@ mdoc_bd_pre(MDOC_ARGS)
        }
 
        SCALE_HS_INIT(&su, 0);
-       if (n->data.Bd->offs)
-               a2offs(n->data.Bd->offs, &su);
+       if (n->norm->Bd.offs)
+               a2offs(n->norm->Bd.offs, &su);
 
        bufcat_su(h, "margin-left", &su);
        PAIR_STYLE_INIT(&tag[0], h);
 
-       if (DISP_unfilled != n->data.Bd->type && 
-                       DISP_literal != n->data.Bd->type) {
+       if (DISP_unfilled != n->norm->Bd.type && 
+                       DISP_literal != n->norm->Bd.type) {
                PAIR_CLASS_INIT(&tag[1], "display");
                print_otag(h, TAG_DIV, 2, tag);
                return(1);
@@ -1173,6 +1232,11 @@ mdoc_bd_pre(MDOC_ARGS)
        PAIR_CLASS_INIT(&tag[1], "lit display");
        print_otag(h, TAG_PRE, 2, tag);
 
+       /* This can be recursive: save & set our literal state. */
+
+       sv = h->flags & HTML_LITERAL;
+       h->flags |= HTML_LITERAL;
+
        for (nn = n->child; nn; nn = nn->next) {
                print_mdoc_node(m, nn, h);
                /*
@@ -1209,6 +1273,9 @@ mdoc_bd_pre(MDOC_ARGS)
                h->flags |= HTML_NOSPACE;
        }
 
+       if (0 == sv)
+               h->flags &= ~HTML_LITERAL;
+
        return(0);
 }
 
@@ -1220,7 +1287,7 @@ mdoc_pa_pre(MDOC_ARGS)
        struct htmlpair tag;
 
        PAIR_CLASS_INIT(&tag, "file");
-       print_otag(h, TAG_SPAN, 1, &tag);
+       print_otag(h, TAG_I, 1, &tag);
        return(1);
 }
 
@@ -1232,7 +1299,7 @@ mdoc_ad_pre(MDOC_ARGS)
        struct htmlpair tag;
 
        PAIR_CLASS_INIT(&tag, "addr");
-       print_otag(h, TAG_SPAN, 1, &tag);
+       print_otag(h, TAG_I, 1, &tag);
        return(1);
 }
 
@@ -1310,20 +1377,24 @@ mdoc_fa_pre(MDOC_ARGS)
 
        PAIR_CLASS_INIT(&tag, "farg");
        if (n->parent->tok != MDOC_Fo) {
-               print_otag(h, TAG_SPAN, 1, &tag);
+               print_otag(h, TAG_I, 1, &tag);
                return(1);
        }
 
        for (nn = n->child; nn; nn = nn->next) {
-               t = print_otag(h, TAG_SPAN, 1, &tag);
+               t = print_otag(h, TAG_I, 1, &tag);
                print_text(h, nn->string);
                print_tagq(h, t);
-               if (nn->next)
+               if (nn->next) {
+                       h->flags |= HTML_NOSPACE;
                        print_text(h, ",");
+               }
        }
 
-       if (n->child && n->next && n->next->tok == MDOC_Fa)
+       if (n->child && n->next && n->next->tok == MDOC_Fa) {
+               h->flags |= HTML_NOSPACE;
                print_text(h, ",");
+       }
 
        return(0);
 }
@@ -1371,7 +1442,7 @@ mdoc_ft_pre(MDOC_ARGS)
 
        synopsis_pre(h, n);
        PAIR_CLASS_INIT(&tag, "ftype");
-       print_otag(h, TAG_SPAN, 1, &tag);
+       print_otag(h, TAG_I, 1, &tag);
        return(1);
 }
 
@@ -1396,7 +1467,7 @@ mdoc_fn_pre(MDOC_ARGS)
        ep = strchr(sp, ' ');
        if (NULL != ep) {
                PAIR_CLASS_INIT(&tag[0], "ftype");
-               t = print_otag(h, TAG_SPAN, 1, tag);
+               t = print_otag(h, TAG_I, 1, tag);
        
                while (ep) {
                        sz = MIN((int)(ep - sp), BUFSIZ - 1);
@@ -1448,16 +1519,22 @@ mdoc_fn_pre(MDOC_ARGS)
                i = 1;
                if (MDOC_SYNPRETTY & n->flags)
                        i = 2;
-               t = print_otag(h, TAG_SPAN, i, tag);
+               t = print_otag(h, TAG_I, i, tag);
                print_text(h, nn->string);
                print_tagq(h, t);
-               if (nn->next)
+               if (nn->next) {
+                       h->flags |= HTML_NOSPACE;
                        print_text(h, ",");
+               }
        }
 
+       h->flags |= HTML_NOSPACE;
        print_text(h, ")");
-       if (MDOC_SYNPRETTY & n->flags)
+
+       if (MDOC_SYNPRETTY & n->flags) {
+               h->flags |= HTML_NOSPACE;
                print_text(h, ";");
+       }
 
        return(0);
 }
@@ -1594,7 +1671,7 @@ mdoc_fo_pre(MDOC_ARGS)
        assert(n->child->string);
 
        PAIR_CLASS_INIT(&tag, "fname");
-       t = print_otag(h, TAG_SPAN, 1, &tag);
+       t = print_otag(h, TAG_B, 1, &tag);
        print_text(h, n->child->string);
        print_tagq(h, t);
        return(0);
@@ -1608,7 +1685,9 @@ mdoc_fo_post(MDOC_ARGS)
 
        if (MDOC_BODY != n->type)
                return;
+       h->flags |= HTML_NOSPACE;
        print_text(h, ")");
+       h->flags |= HTML_NOSPACE;
        print_text(h, ";");
 }
 
@@ -1681,7 +1760,7 @@ mdoc_rv_pre(MDOC_ARGS)
 
        for (nn = n->child; nn; nn = nn->next) {
                PAIR_CLASS_INIT(&tag, "fname");
-               t = print_otag(h, TAG_SPAN, 1, &tag);
+               t = print_otag(h, TAG_B, 1, &tag);
                print_text(h, nn->string);
                print_tagq(h, t);
 
@@ -1747,13 +1826,11 @@ mdoc_bf_pre(MDOC_ARGS)
        else if (MDOC_BODY != n->type)
                return(1);
 
-       assert(n->data.Bf);
-
-       if (FONT_Em == n->data.Bf->font) 
+       if (FONT_Em == n->norm->Bf.font) 
                PAIR_CLASS_INIT(&tag[0], "emph");
-       else if (FONT_Sy == n->data.Bf->font) 
+       else if (FONT_Sy == n->norm->Bf.font) 
                PAIR_CLASS_INIT(&tag[0], "symb");
-       else if (FONT_Li == n->data.Bf->font) 
+       else if (FONT_Li == n->norm->Bf.font) 
                PAIR_CLASS_INIT(&tag[0], "lit");
        else
                PAIR_CLASS_INIT(&tag[0], "none");
@@ -1886,6 +1963,9 @@ static int
 mdoc__x_pre(MDOC_ARGS)
 {
        struct htmlpair tag[2];
+       enum htmltag    t;
+
+       t = TAG_SPAN;
 
        switch (n->tok) {
        case(MDOC__A):
@@ -1896,6 +1976,7 @@ mdoc__x_pre(MDOC_ARGS)
                break;
        case(MDOC__B):
                PAIR_CLASS_INIT(&tag[0], "ref-book");
+               t = TAG_I;
                break;
        case(MDOC__C):
                PAIR_CLASS_INIT(&tag[0], "ref-city");
@@ -1905,9 +1986,11 @@ mdoc__x_pre(MDOC_ARGS)
                break;
        case(MDOC__I):
                PAIR_CLASS_INIT(&tag[0], "ref-issue");
+               t = TAG_I;
                break;
        case(MDOC__J):
                PAIR_CLASS_INIT(&tag[0], "ref-jrnl");
+               t = TAG_I;
                break;
        case(MDOC__N):
                PAIR_CLASS_INIT(&tag[0], "ref-num");
@@ -1939,7 +2022,7 @@ mdoc__x_pre(MDOC_ARGS)
        }
 
        if (MDOC__U != n->tok) {
-               print_otag(h, TAG_SPAN, 1, tag);
+               print_otag(h, t, 1, tag);
                return(1);
        }
 
@@ -1965,6 +2048,7 @@ mdoc__x_post(MDOC_ARGS)
        if (NULL == n->parent || MDOC_Rs != n->parent->tok)
                return;
 
+       h->flags |= HTML_NOSPACE;
        print_text(h, n->next ? "," : ".");
 }