=================================================================== RCS file: /cvs/mandoc/html.c,v retrieving revision 1.2 retrieving revision 1.29 diff -u -p -r1.2 -r1.29 --- mandoc/html.c 2008/12/03 19:21:58 1.2 +++ mandoc/html.c 2009/09/16 09:41:24 1.29 @@ -1,245 +1,638 @@ -/* $Id: html.c,v 1.2 2008/12/03 19:21:58 kristaps Exp $ */ +/* $Id: html.c,v 1.29 2009/09/16 09:41:24 kristaps Exp $ */ /* - * Copyright (c) 2008 Kristaps Dzonsons + * Copyright (c) 2008, 2009 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 copyright notice and this permission notice appear in all - * copies. + * purpose with or without fee is hereby granted, provided that the above + * copyright notice and this permission notice appear in all copies. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL - * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED - * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE - * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL - * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR - * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER - * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR - * PERFORMANCE OF THIS SOFTWARE. + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #include +#include +#include #include -#include -#include "libmdocml.h" -#include "private.h" -#include "ml.h" +#include "mdoc.h" +#include "man.h" +#define DOCTYPE "-//W3C//DTD HTML 4.01//EN" +#define DTD "http://www.w3.org/TR/html4/strict.dtd" -static ssize_t html_endtag(struct md_mbuf *, - const struct md_args *, - enum md_ns, int); -static ssize_t html_begintag(struct md_mbuf *, - const struct md_args *, - enum md_ns, int, - const int *, const char **); -static int html_begin(struct md_mbuf *, - const struct md_args *); -static int html_end(struct md_mbuf *, - const struct md_args *); -static ssize_t html_blocktagname(struct md_mbuf *, - const struct md_args *, int); -static ssize_t html_blocktagargs(struct md_mbuf *, - const struct md_args *, int, - const int *, const char **); -static ssize_t html_inlinetagname(struct md_mbuf *, - const struct md_args *, int); -static ssize_t html_inlinetagargs(struct md_mbuf *, - const struct md_args *, int, - const int *, const char **); +enum htmltag { + TAG_HTML, + TAG_HEAD, + TAG_BODY, + TAG_META, + TAG_TITLE, + TAG_DIV, + TAG_H1, + TAG_H2, + TAG_P, + TAG_SPAN, + TAG_LINK, + TAG_MAX +}; +enum htmlattr { + ATTR_HTTPEQUIV, + ATTR_CONTENT, + ATTR_NAME, + ATTR_REL, + ATTR_HREF, + ATTR_TYPE, + ATTR_MEDIA, + ATTR_CLASS, + ATTR_MAX +}; -static int -html_begin(struct md_mbuf *mbuf, const struct md_args *args) +struct htmldata { + char *name; + int flags; +#define HTML_BLOCK (1 << 0) +}; + +static const struct htmldata htmltags[TAG_MAX] = { + {"html", HTML_BLOCK}, /* TAG_HTML */ + {"head", HTML_BLOCK}, /* TAG_HEAD */ + {"body", HTML_BLOCK}, /* TAG_BODY */ + {"meta", HTML_BLOCK}, /* TAG_META */ + {"title", HTML_BLOCK}, /* TAG_TITLE */ + {"div", HTML_BLOCK}, /* TAG_DIV */ + {"h1", 0}, /* TAG_H1 */ + {"h2", 0}, /* TAG_H2 */ + {"p", HTML_BLOCK}, /* TAG_P */ + {"span", 0}, /* TAG_SPAN */ + {"link", HTML_BLOCK}, /* TAG_LINK */ +}; + +static const char *const htmlattrs[ATTR_MAX] = { + "http-equiv", + "content", + "name", + "rel", + "href", + "type", + "media", + "class" +}; + +struct htmlpair { + enum htmlattr key; + char *val; +}; + +struct html { + int flags; +#define HTML_NOSPACE (1 << 0) +}; + +#define MDOC_ARGS const struct mdoc_meta *m, \ + const struct mdoc_node *n, \ + struct html *h +#define MAN_ARGS const struct man_meta *m, \ + const struct man_node *n, \ + struct html *h +struct htmlmdoc { + int (*pre)(MDOC_ARGS); + void (*post)(MDOC_ARGS); +}; + +static void print_gen_doctype(struct html *); +static void print_gen_head(struct html *); +static void print_mdoc(MDOC_ARGS); +static void print_mdoc_head(MDOC_ARGS); +static void print_mdoc_node(MDOC_ARGS); +static void print_man(MAN_ARGS); +static void print_man_head(MAN_ARGS); +static void print_man_body(MAN_ARGS); +static void print_otag(struct html *, enum htmltag, + int, const struct htmlpair *); +static void print_ctag(struct html *, enum htmltag); +static void print_encode(const char *); +static void print_text(struct html *, const char *); +static int mdoc_root_pre(MDOC_ARGS); +static void mdoc_root_post(MDOC_ARGS); + +static int mdoc_nd_pre(MDOC_ARGS); +static int mdoc_nm_pre(MDOC_ARGS); +static void mdoc_nm_post(MDOC_ARGS); +static int mdoc_pp_pre(MDOC_ARGS); +static int mdoc_sh_pre(MDOC_ARGS); +static void mdoc_sh_post(MDOC_ARGS); +static int mdoc_ss_pre(MDOC_ARGS); +static void mdoc_ss_post(MDOC_ARGS); + +static const struct htmlmdoc mdocs[MDOC_MAX] = { + {NULL, NULL}, /* Ap */ + {NULL, NULL}, /* Dd */ + {NULL, NULL}, /* Dt */ + {NULL, NULL}, /* Os */ + {mdoc_sh_pre, mdoc_sh_post }, /* Sh */ + {mdoc_ss_pre, mdoc_ss_post }, /* Ss */ + {mdoc_pp_pre, NULL}, /* Pp */ + {NULL, NULL}, /* D1 */ + {NULL, NULL}, /* Dl */ + {NULL, NULL}, /* Bd */ + {NULL, NULL}, /* Ed */ + {NULL, NULL}, /* Bl */ + {NULL, NULL}, /* El */ + {NULL, NULL}, /* It */ + {NULL, NULL}, /* Ad */ + {NULL, NULL}, /* An */ + {NULL, NULL}, /* Ar */ + {NULL, NULL}, /* Cd */ + {NULL, NULL}, /* Cm */ + {NULL, NULL}, /* Dv */ + {NULL, NULL}, /* Er */ + {NULL, NULL}, /* Ev */ + {NULL, NULL}, /* Ex */ + {NULL, NULL}, /* Fa */ + {NULL, NULL}, /* Fd */ + {NULL, NULL}, /* Fl */ + {NULL, NULL}, /* Fn */ + {NULL, NULL}, /* Ft */ + {NULL, NULL}, /* Ic */ + {NULL, NULL}, /* In */ + {NULL, NULL}, /* Li */ + {mdoc_nd_pre, NULL}, /* Nd */ + {mdoc_nm_pre, mdoc_nm_post}, /* Nm */ + {NULL, NULL}, /* Op */ + {NULL, NULL}, /* Ot */ + {NULL, NULL}, /* Pa */ + {NULL, NULL}, /* Rv */ + {NULL, NULL}, /* St */ + {NULL, NULL}, /* Va */ + {NULL, NULL}, /* Vt */ + {NULL, NULL}, /* Xr */ + {NULL, NULL}, /* %A */ + {NULL, NULL}, /* %B */ + {NULL, NULL}, /* %D */ + {NULL, NULL}, /* %I */ + {NULL, NULL}, /* %J */ + {NULL, NULL}, /* %N */ + {NULL, NULL}, /* %O */ + {NULL, NULL}, /* %P */ + {NULL, NULL}, /* %R */ + {NULL, NULL}, /* %T */ + {NULL, NULL}, /* %V */ + {NULL, NULL}, /* Ac */ + {NULL, NULL}, /* Ao */ + {NULL, NULL}, /* Aq */ + {NULL, NULL}, /* At */ + {NULL, NULL}, /* Bc */ + {NULL, NULL}, /* Bf */ + {NULL, NULL}, /* Bo */ + {NULL, NULL}, /* Bq */ + {NULL, NULL}, /* Bsx */ + {NULL, NULL}, /* Bx */ + {NULL, NULL}, /* Db */ + {NULL, NULL}, /* Dc */ + {NULL, NULL}, /* Do */ + {NULL, NULL}, /* Dq */ + {NULL, NULL}, /* Ec */ + {NULL, NULL}, /* Ef */ + {NULL, NULL}, /* Em */ + {NULL, NULL}, /* Eo */ + {NULL, NULL}, /* Fx */ + {NULL, NULL}, /* Ms */ + {NULL, NULL}, /* No */ + {NULL, NULL}, /* Ns */ + {NULL, NULL}, /* Nx */ + {NULL, NULL}, /* Ox */ + {NULL, NULL}, /* Pc */ + {NULL, NULL}, /* Pf */ + {NULL, NULL}, /* Po */ + {NULL, NULL}, /* Pq */ + {NULL, NULL}, /* Qc */ + {NULL, NULL}, /* Ql */ + {NULL, NULL}, /* Qo */ + {NULL, NULL}, /* Qq */ + {NULL, NULL}, /* Re */ + {NULL, NULL}, /* Rs */ + {NULL, NULL}, /* Sc */ + {NULL, NULL}, /* So */ + {NULL, NULL}, /* Sq */ + {NULL, NULL}, /* Sm */ + {NULL, NULL}, /* Sx */ + {NULL, NULL}, /* Sy */ + {NULL, NULL}, /* Tn */ + {NULL, NULL}, /* Ux */ + {NULL, NULL}, /* Xc */ + {NULL, NULL}, /* Xo */ + {NULL, NULL}, /* Fo */ + {NULL, NULL}, /* Fc */ + {NULL, NULL}, /* Oo */ + {NULL, NULL}, /* Oc */ + {NULL, NULL}, /* Bk */ + {NULL, NULL}, /* Ek */ + {NULL, NULL}, /* Bt */ + {NULL, NULL}, /* Hf */ + {NULL, NULL}, /* Fr */ + {NULL, NULL}, /* Ud */ + {NULL, NULL}, /* Lb */ + {NULL, NULL}, /* Lp */ + {NULL, NULL}, /* Lk */ + {NULL, NULL}, /* Mt */ + {NULL, NULL}, /* Brq */ + {NULL, NULL}, /* Bro */ + {NULL, NULL}, /* Brc */ + {NULL, NULL}, /* %C */ + {NULL, NULL}, /* Es */ + {NULL, NULL}, /* En */ + {NULL, NULL}, /* Dx */ + {NULL, NULL}, /* %Q */ + {NULL, NULL}, /* br */ + {NULL, NULL}, /* sp */ +}; + + +int +html_mdoc(void *arg, const struct mdoc *m) { - size_t res; + struct html *h; - res = 0; - if ( ! ml_puts(mbuf, "\n", &res)) - return(0); - if ( ! ml_puts(mbuf, "\n", &res)) - return(0); - if ( ! ml_puts(mbuf, "\n", &res)) - return(0); - if ( ! ml_puts(mbuf, " Manual page\n", &res)) - return(0); - if ( ! ml_puts(mbuf, " \n", &res)) - return(0); - if ( ! ml_puts(mbuf, " \n", &res)) - return(0); - if ( ! ml_puts(mbuf, "\n", &res)) - return(0); - if ( ! ml_puts(mbuf, "", &res)) - return(0); + h = (struct html *)arg; + print_gen_doctype(h); + print_otag(h, TAG_HTML, 0, NULL); + print_mdoc(mdoc_meta(m), mdoc_node(m), h); + print_ctag(h, TAG_HTML); + printf("\n"); return(1); } -static int -html_end(struct md_mbuf *mbuf, const struct md_args *args) +int +html_man(void *arg, const struct man *m) { - size_t res; + struct html *h; - res = 0; - if ( ! ml_puts(mbuf, "\n", &res)) - return(0); + h = (struct html *)arg; + print_gen_doctype(h); + print_otag(h, TAG_HTML, 0, NULL); + print_man(man_meta(m), man_node(m), h); + print_ctag(h, TAG_HTML); + printf("\n"); return(1); } -static ssize_t -html_blocktagname(struct md_mbuf *mbuf, - const struct md_args *args, int tok) +void * +html_alloc(void) { - size_t res; - res = 0; + return(calloc(1, sizeof(struct html))); +} - switch (tok) { - case (ROFF_Sh): - if ( ! ml_puts(mbuf, "blockquote", &res)) - return(-1); - break; - case (ROFF_Bd): - if ( ! ml_puts(mbuf, "pre", &res)) - return(-1); - break; - case (ROFF_Bl): - if ( ! ml_puts(mbuf, "ul", &res)) - return(-1); - break; - case (ROFF_It): - if ( ! ml_puts(mbuf, "li", &res)) - return(-1); - break; - default: - if ( ! ml_puts(mbuf, "div", &res)) - return(-1); - break; - } - return((size_t)res); +void +html_free(void *p) +{ + + free(p); } -/* ARGSUSED */ -static ssize_t -html_blocktagargs(struct md_mbuf *mbuf, const struct md_args *args, - int tok, const int *argc, const char **argv) +static void +print_mdoc(MDOC_ARGS) { - switch (tok) { - default: - return(0); - } + print_otag(h, TAG_HEAD, 0, NULL); + print_mdoc_head(m, n, h); + print_ctag(h, TAG_HEAD); + print_otag(h, TAG_BODY, 0, NULL); + print_mdoc_node(m, n, h); + print_ctag(h, TAG_BODY); +} - return(-1); + +static void +print_gen_head(struct html *h) +{ + struct htmlpair meta0[2]; + struct htmlpair meta1[2]; + struct htmlpair link[4]; + + meta0[0].key = ATTR_HTTPEQUIV; + meta0[0].val = "Content-Type"; + meta0[1].key = ATTR_CONTENT; + meta0[1].val = "text/html; charest-utf-8"; + + meta1[0].key = ATTR_NAME; + meta1[0].val = "resource-type"; + meta1[1].key = ATTR_CONTENT; + meta1[1].val = "document"; + + link[0].key = ATTR_REL; + link[0].val = "stylesheet"; + link[1].key = ATTR_HREF; + link[1].val = "style.css"; + link[2].key = ATTR_TYPE; + link[2].val = "text/css"; + link[3].key = ATTR_MEDIA; + link[3].val = "all"; + + print_otag(h, TAG_META, 2, meta0); + print_otag(h, TAG_META, 2, meta1); + print_otag(h, TAG_LINK, 4, link); } -/* ARGSUSED */ -static ssize_t -html_inlinetagargs(struct md_mbuf *mbuf, const struct md_args *args, - int tok, const int *argc, const char **argv) +static void +print_mdoc_head(MDOC_ARGS) { - switch (tok) { - default: - return(0); - } + print_gen_head(h); + print_otag(h, TAG_TITLE, 0, NULL); + print_encode(m->title); + print_ctag(h, TAG_TITLE); +} - return(-1); + +static int +mdoc_root_pre(MDOC_ARGS) +{ + struct htmlpair div; + + div.key = ATTR_CLASS; + div.val = "body"; + + print_otag(h, TAG_DIV, 1, &div); + return(1); } -static ssize_t -html_inlinetagname(struct md_mbuf *mbuf, - const struct md_args *args, int tok) +static void +mdoc_root_post(MDOC_ARGS) { - size_t res; - res = 0; + print_ctag(h, TAG_DIV); +} - switch (tok) { - case (ROFF_Sh): - if ( ! ml_puts(mbuf, "h1", &res)) - return(-1); + +static int +mdoc_ss_pre(MDOC_ARGS) +{ + + if (MDOC_BODY == n->type) + print_otag(h, TAG_P, 0, NULL); + if (MDOC_HEAD == n->type) + print_otag(h, TAG_H2, 0, NULL); + return(1); +} + + +static void +mdoc_ss_post(MDOC_ARGS) +{ + + if (MDOC_BODY == n->type) + print_ctag(h, TAG_P); + if (MDOC_HEAD == n->type) + print_ctag(h, TAG_H2); +} + + +static int +mdoc_pp_pre(MDOC_ARGS) +{ + + print_otag(h, TAG_P, 0, NULL); + return(0); +} + + +static int +mdoc_nd_pre(MDOC_ARGS) +{ + + if (MDOC_BODY == n->type) + print_text(h, "--"); + return(1); +} + + +static int +mdoc_nm_pre(MDOC_ARGS) +{ + struct htmlpair class; + + class.key = ATTR_CLASS; + class.val = "name"; + + print_otag(h, TAG_SPAN, 1, &class); + if (NULL == n->child) + print_text(h, m->name); + + return(1); +} + + +static void +mdoc_nm_post(MDOC_ARGS) +{ + + print_ctag(h, TAG_SPAN); +} + + +static int +mdoc_sh_pre(MDOC_ARGS) +{ + + if (MDOC_BODY == n->type) + print_otag(h, TAG_P, 0, NULL); + if (MDOC_HEAD == n->type) + print_otag(h, TAG_H1, 0, NULL); + return(1); +} + + +static void +mdoc_sh_post(MDOC_ARGS) +{ + + if (MDOC_BODY == n->type) + print_ctag(h, TAG_P); + if (MDOC_HEAD == n->type) + print_ctag(h, TAG_H1); +} + + +static void +print_mdoc_node(MDOC_ARGS) +{ + int child; + + child = 1; + + switch (n->type) { + case (MDOC_ROOT): + child = mdoc_root_pre(m, n, h); break; - case (ROFF_Ss): - if ( ! ml_puts(mbuf, "h2", &res)) - return(-1); + case (MDOC_TEXT): + print_text(h, n->string); break; default: - if ( ! ml_puts(mbuf, "span", &res)) - return(-1); + if (mdocs[n->tok].pre) + child = (*mdocs[n->tok].pre)(m, n, h); break; } - return((ssize_t)res); + if (child && n->child) + print_mdoc_node(m, n->child, h); + + switch (n->type) { + case (MDOC_ROOT): + mdoc_root_post(m, n, h); + break; + case (MDOC_TEXT): + break; + default: + if (mdocs[n->tok].post) + (*mdocs[n->tok].post)(m, n, h); + break; + } + + if (n->next) + print_mdoc_node(m, n->next, h); } -static ssize_t -html_begintag(struct md_mbuf *mbuf, const struct md_args *args, - enum md_ns ns, int tok, - const int *argc, const char **argv) +static void +print_man(MAN_ARGS) { - assert(ns != MD_NS_DEFAULT); - if (MD_NS_BLOCK == ns) { - if ( ! html_blocktagname(mbuf, args, tok)) - return(0); - return(html_blocktagargs(mbuf, args, - tok, argc, argv)); - } - - if ( ! html_inlinetagname(mbuf, args, tok)) - return(0); - return(html_inlinetagargs(mbuf, args, tok, argc, argv)); + print_otag(h, TAG_HEAD, 0, NULL); + print_man_head(m, n, h); + print_ctag(h, TAG_HEAD); + print_otag(h, TAG_BODY, 0, NULL); + print_man_body(m, n, h); + print_ctag(h, TAG_BODY); } -static ssize_t -html_endtag(struct md_mbuf *mbuf, const struct md_args *args, - enum md_ns ns, int tok) +static void +print_man_head(MAN_ARGS) { - assert(ns != MD_NS_DEFAULT); - if (MD_NS_BLOCK == ns) - return(html_blocktagname(mbuf, args, tok)); + print_gen_head(h); + print_otag(h, TAG_TITLE, 0, NULL); + print_encode(m->title); + print_ctag(h, TAG_TITLE); +} - return(html_inlinetagname(mbuf, args, tok)); + +static void +print_man_body(MAN_ARGS) +{ } -int -md_line_html(void *data, char *buf) +static void +print_encode(const char *p) { - return(mlg_line((struct md_mlg *)data, buf)); + printf("%s", p); /* XXX */ } -int -md_exit_html(void *data, int flush) +static void +print_otag(struct html *h, enum htmltag tag, + int sz, const struct htmlpair *p) { + int i; - return(mlg_exit((struct md_mlg *)data, flush)); + if ( ! (HTML_NOSPACE & h->flags)) + if ( ! (HTML_BLOCK & htmltags[tag].flags)) + printf(" "); + + printf("<%s", htmltags[tag].name); + for (i = 0; i < sz; i++) { + printf(" %s=\"", htmlattrs[p[i].key]); + assert(p->val); + print_encode(p[i].val); + printf("\""); + } + printf(">"); + + h->flags |= HTML_NOSPACE; + } -void * -md_init_html(const struct md_args *args, - struct md_mbuf *mbuf, const struct md_rbuf *rbuf) +/* ARGSUSED */ +static void +print_ctag(struct html *h, enum htmltag tag) { + + printf("", htmltags[tag].name); + if (HTML_BLOCK & htmltags[tag].flags) + h->flags |= HTML_NOSPACE; +} - return(mlg_alloc(args, rbuf, mbuf, html_begintag, - html_endtag, html_begin, html_end)); + +/* ARGSUSED */ +static void +print_gen_doctype(struct html *h) +{ + + printf("\n", DOCTYPE, DTD); } + +static void +print_text(struct html *h, const char *p) +{ + + if (*p && 0 == *(p + 1)) + switch (*p) { + case('.'): + /* FALLTHROUGH */ + case(','): + /* FALLTHROUGH */ + case(';'): + /* FALLTHROUGH */ + case(':'): + /* FALLTHROUGH */ + case('?'): + /* FALLTHROUGH */ + case('!'): + /* FALLTHROUGH */ + case(')'): + /* FALLTHROUGH */ + case(']'): + /* FALLTHROUGH */ + case('}'): + h->flags |= HTML_NOSPACE; + default: + break; + } + + if ( ! (h->flags & HTML_NOSPACE)) + printf(" "); + h->flags &= ~HTML_NOSPACE; + + if (p) + print_encode(p); + + if (*p && 0 == *(p + 1)) + switch (*p) { + case('('): + /* FALLTHROUGH */ + case('['): + /* FALLTHROUGH */ + case('{'): + h->flags |= HTML_NOSPACE; + default: + break; + } +}