=================================================================== RCS file: /cvs/mandoc/man_html.c,v retrieving revision 1.9 retrieving revision 1.51 diff -u -p -r1.9 -r1.51 --- mandoc/man_html.c 2009/10/09 07:10:37 1.9 +++ mandoc/man_html.c 2010/12/06 15:31:44 1.51 @@ -1,6 +1,6 @@ -/* $Id: man_html.c,v 1.9 2009/10/09 07:10:37 kristaps Exp $ */ +/* $Id: man_html.c,v 1.51 2010/12/06 15:31:44 kristaps Exp $ */ /* - * Copyright (c) 2008, 2009 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -14,29 +14,40 @@ * 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 -#include #include #include -#include #include #include #include +#include "mandoc.h" #include "out.h" #include "html.h" #include "man.h" +#include "main.h" /* TODO: preserve ident widths. */ +/* 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, \ + 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,13 +104,17 @@ 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 */ + { man_ign_pre, NULL }, /* ft */ }; @@ -111,13 +123,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"); @@ -132,7 +147,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); @@ -140,7 +155,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); } @@ -153,7 +168,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); @@ -164,9 +179,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); } @@ -177,39 +192,61 @@ print_man_node(MAN_ARGS) struct tag *t; child = 1; - t = SLIST_FIRST(&h->tags); + 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, h); + child = man_root_pre(m, n, mh, h); break; case (MAN_TEXT): print_text(h, n->string); - break; + + 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; } } @@ -221,7 +258,7 @@ a2width(const struct man_node *n, struct roffsu *su) if (MAN_TEXT != n->type) return(0); - if (a2roffsu(n->string, su)) + if (a2roffsu(n->string, su, SCALE_BU)) return(1); return(0); @@ -232,7 +269,7 @@ a2width(const struct man_node *n, struct roffsu *su) static int man_root_pre(MAN_ARGS) { - struct htmlpair tag[2]; + struct htmlpair tag[3]; struct tag *t, *tt; char b[BUFSIZ], title[BUFSIZ]; @@ -240,13 +277,14 @@ 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%"); PAIR_STYLE_INIT(&tag[1], h); - t = print_otag(h, TAG_TABLE, 2, tag); + PAIR_SUMMARY_INIT(&tag[2], "header"); + + t = print_otag(h, TAG_TABLE, 3, tag); tt = print_otag(h, TAG_TR, 0, NULL); bufinit(h); @@ -280,20 +318,21 @@ man_root_pre(MAN_ARGS) static void man_root_post(MAN_ARGS) { - struct tm tm; - struct htmlpair tag[2]; + struct htmlpair tag[3]; struct tag *t, *tt; - char b[BUFSIZ]; + char b[DATESIZ]; - (void)localtime_r(&m->date, &tm); + if (m->rawdate) + strlcpy(b, m->rawdate, DATESIZ); + else + time2a(m->date, b, DATESIZ); - if (0 == strftime(b, BUFSIZ - 1, "%B %e, %Y", &tm)) - err(EXIT_FAILURE, "strftime"); - PAIR_CLASS_INIT(&tag[0], "footer"); bufcat_style(h, "width", "100%"); PAIR_STYLE_INIT(&tag[1], h); - t = print_otag(h, TAG_TABLE, 2, tag); + PAIR_SUMMARY_INIT(&tag[2], "footer"); + + t = print_otag(h, TAG_TABLE, 3, tag); tt = print_otag(h, TAG_TR, 0, NULL); bufinit(h); @@ -325,15 +364,18 @@ man_br_pre(MAN_ARGS) SCALE_VS_INIT(&su, 1); if (MAN_sp == n->tok) { - su.scale = 1; if (n->child) - a2roffsu(n->child->string, &su); - } else if (MAN_br == n->tok) + a2roffsu(n->child->string, &su, SCALE_VS); + } else su.scale = 0; 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, "\\~"); + return(0); } @@ -382,30 +424,27 @@ man_alt_pre(MAN_ARGS) const struct man_node *nn; struct tag *t; int i; - struct htmlpair tagi, tagb, *tagp; + enum htmlfont fp; - PAIR_CLASS_INIT(&tagi, "italic"); - PAIR_CLASS_INIT(&tagb, "bold"); - 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(); @@ -415,12 +454,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); @@ -433,6 +474,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); @@ -502,24 +544,27 @@ man_PP_pre(MAN_ARGS) struct roffsu su; int i; - if (MAN_BLOCK != n->type) + if (MAN_BODY == n->type) return(1); + if (MAN_HEAD == n->type) + return(0); 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); } @@ -554,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) @@ -561,9 +608,16 @@ 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); SCALE_VS_INIT(&su, 1); @@ -587,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); } @@ -646,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); } @@ -658,11 +719,34 @@ man_B_pre(MAN_ARGS) static int man_I_pre(MAN_ARGS) { - struct htmlpair tag; + + print_ofont(h, HTMLFONT_ITALIC); + return(1); +} - PAIR_CLASS_INIT(&tag, "italic"); - print_otag(h, TAG_SPAN, 1, &tag); + +/* ARGSUSED */ +static int +man_literal_pre(MAN_ARGS) +{ + + if (MAN_nf == n->tok) { + print_otag(h, TAG_BR, 0, NULL); + mh->fl |= MANH_LITERAL; + } else + mh->fl &= ~MANH_LITERAL; + return(1); +} + + +/* ARGSUSED */ +static int +man_in_pre(MAN_ARGS) +{ + + print_otag(h, TAG_BR, 0, NULL); + return(0); }