=================================================================== RCS file: /cvs/mandoc/man_html.c,v retrieving revision 1.90 retrieving revision 1.129 diff -u -p -r1.90 -r1.129 --- mandoc/man_html.c 2013/10/17 20:54:58 1.90 +++ mandoc/man_html.c 2017/01/21 01:20:32 1.129 @@ -1,23 +1,21 @@ -/* $Id: man_html.c,v 1.90 2013/10/17 20:54:58 schwarze Exp $ */ +/* $Id: man_html.c,v 1.129 2017/01/21 01:20:32 schwarze Exp $ */ /* - * Copyright (c) 2008-2012 Kristaps Dzonsons - * Copyright (c) 2013 Ingo Schwarze + * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons + * Copyright (c) 2013, 2014, 2015, 2017 Ingo Schwarze * * 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. * - * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF - * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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. */ -#ifdef HAVE_CONFIG_H #include "config.h" -#endif #include @@ -27,10 +25,11 @@ #include #include -#include "mandoc.h" +#include "mandoc_aux.h" +#include "roff.h" +#include "man.h" #include "out.h" #include "html.h" -#include "man.h" #include "main.h" /* TODO: preserve ident widths. */ @@ -38,8 +37,8 @@ #define INDENT 5 -#define MAN_ARGS const struct man_meta *man, \ - const struct man_node *n, \ +#define MAN_ARGS const struct roff_meta *man, \ + const struct roff_node *n, \ struct mhtml *mh, \ struct html *h @@ -53,13 +52,12 @@ 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_bvspace(struct html *, + const struct roff_node *); static void print_man_head(MAN_ARGS); static void print_man_nodelist(MAN_ARGS); static void print_man_node(MAN_ARGS); -static int a2width(const struct man_node *, +static int a2width(const struct roff_node *, struct roffsu *); static int man_B_pre(MAN_ARGS); static int man_HP_pre(MAN_ARGS); @@ -90,7 +88,7 @@ static const struct htmlman mans[MAN_MAX] = { { man_PP_pre, NULL }, /* PP */ { man_PP_pre, NULL }, /* P */ { man_IP_pre, NULL }, /* IP */ - { man_HP_pre, NULL }, /* HP */ + { man_HP_pre, NULL }, /* HP */ { man_SM_pre, NULL }, /* SM */ { man_SM_pre, NULL }, /* SB */ { man_alt_pre, NULL }, /* BI */ @@ -102,7 +100,6 @@ static const struct htmlman mans[MAN_MAX] = { { man_I_pre, NULL }, /* I */ { man_alt_pre, NULL }, /* IR */ { man_alt_pre, NULL }, /* RI */ - { man_ign_pre, NULL }, /* na */ { man_br_pre, NULL }, /* sp */ { man_literal_pre, NULL }, /* nf */ { man_literal_pre, NULL }, /* fi */ @@ -119,8 +116,10 @@ static const struct htmlman mans[MAN_MAX] = { { man_literal_pre, NULL }, /* EE */ { man_UR_pre, NULL }, /* UR */ { NULL, NULL }, /* UE */ + { man_ign_pre, NULL }, /* ll */ }; + /* * Printing leading vertical space before a block. * This is used for the paragraph macros. @@ -130,78 +129,69 @@ static const struct htmlman mans[MAN_MAX] = { * first, print it. */ static void -print_bvspace(struct html *h, const struct man_node *n) +print_bvspace(struct html *h, const struct roff_node *n) { if (n->body && n->body->child) - if (MAN_TBL == n->body->child->type) + if (n->body->child->type == ROFFT_TBL) return; - if (MAN_ROOT == n->parent->type || MAN_RS != n->parent->tok) + if (n->parent->type == ROFFT_ROOT || n->parent->tok != MAN_RS) if (NULL == n->prev) return; - print_otag(h, TAG_P, 0, NULL); + print_paragraph(h); } void -html_man(void *arg, const struct man *man) +html_man(void *arg, const struct roff_man *man) { struct mhtml mh; + struct html *h; + struct tag *t; - memset(&mh, 0, sizeof(struct mhtml)); - print_man(man_meta(man), man_node(man), &mh, (struct html *)arg); - putchar('\n'); -} + memset(&mh, 0, sizeof(mh)); + h = (struct html *)arg; -static void -print_man(MAN_ARGS) -{ - struct tag *t, *tt; - struct htmlpair tag; - - PAIR_CLASS_INIT(&tag, "mandoc"); - - if ( ! (HTML_FRAGMENT & h->oflags)) { + if ((h->oflags & HTML_FRAGMENT) == 0) { print_gen_decls(h); - t = print_otag(h, TAG_HTML, 0, NULL); - tt = print_otag(h, TAG_HEAD, 0, NULL); - print_man_head(man, 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); + print_otag(h, TAG_HTML, ""); + t = print_otag(h, TAG_HEAD, ""); + print_man_head(&man->meta, man->first, &mh, h); + print_tagq(h, t); + print_otag(h, TAG_BODY, ""); + } - print_man_nodelist(man, n, mh, h); + man_root_pre(&man->meta, man->first, &mh, h); + t = print_otag(h, TAG_DIV, "c", "manual-text"); + print_man_nodelist(&man->meta, man->first->child, &mh, h); print_tagq(h, t); + man_root_post(&man->meta, man->first, &mh, h); + print_tagq(h, NULL); } - -/* ARGSUSED */ static void print_man_head(MAN_ARGS) { + char *cp; print_gen_head(h); - assert(man->title); - assert(man->msec); - bufcat_fmt(h, "%s(%s)", man->title, man->msec); - print_otag(h, TAG_TITLE, 0, NULL); - print_text(h, h->buf); + mandoc_asprintf(&cp, "%s(%s)", man->title, man->msec); + print_otag(h, TAG_TITLE, ""); + print_text(h, cp); + free(cp); } - static void print_man_nodelist(MAN_ARGS) { - print_man_node(man, n, mh, h); - if (n->next) - print_man_nodelist(man, n->next, mh, h); + while (n != NULL) { + print_man_node(man, n, mh, h); + n = n->next; + } } - static void print_man_node(MAN_ARGS) { @@ -212,31 +202,21 @@ print_man_node(MAN_ARGS) t = h->tags.head; switch (n->type) { - case (MAN_ROOT): - man_root_pre(man, 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. - */ + case ROFFT_TEXT: if ('\0' == *n->string) { - print_otag(h, TAG_P, 0, NULL); + print_paragraph(h); return; } - - 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); - + if (n->flags & NODE_LINE && (*n->string == ' ' || + (n->prev != NULL && mh->fl & MANH_LITERAL && + ! (h->flags & HTML_NONEWLINE)))) + print_otag(h, TAG_BR, ""); print_text(h, n->string); return; - case (MAN_EQN): + case ROFFT_EQN: print_eqn(h, n->eqn); break; - case (MAN_TBL): + case ROFFT_TBL: /* * This will take care of initialising all of the table * state data for the first table, then tearing it down @@ -245,7 +225,7 @@ print_man_node(MAN_ARGS) print_tbl(h, n->span); return; default: - /* + /* * Close out scope of font prior to opening a macro * scope. */ @@ -275,11 +255,8 @@ print_man_node(MAN_ARGS) print_stagq(h, t); switch (n->type) { - case (MAN_ROOT): - man_root_post(man, n, mh, h); + case ROFFT_EQN: break; - case (MAN_EQN): - break; default: if (mans[n->tok].post) (*mans[n->tok].post)(man, n, mh, h); @@ -287,192 +264,144 @@ print_man_node(MAN_ARGS) } } - static int -a2width(const struct man_node *n, struct roffsu *su) +a2width(const struct roff_node *n, struct roffsu *su) { - if (MAN_TEXT != n->type) - return(0); - if (a2roffsu(n->string, su, SCALE_BU)) - return(1); + if (n->type != ROFFT_TEXT) + return 0; + if (a2roffsu(n->string, su, SCALE_EN)) + return 1; - return(0); + return 0; } - -/* ARGSUSED */ static void man_root_pre(MAN_ARGS) { - struct htmlpair tag[3]; struct tag *t, *tt; - char b[BUFSIZ], title[BUFSIZ]; + char *title; - b[0] = 0; - if (man->vol) - (void)strlcat(b, man->vol, BUFSIZ); - assert(man->title); assert(man->msec); - snprintf(title, BUFSIZ - 1, "%s(%s)", man->title, man->msec); + mandoc_asprintf(&title, "%s(%s)", man->title, man->msec); - PAIR_SUMMARY_INIT(&tag[0], "Document Header"); - PAIR_CLASS_INIT(&tag[1], "head"); - 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); + t = print_otag(h, TAG_TABLE, "c", "head"); + print_otag(h, TAG_TBODY, ""); + tt = print_otag(h, TAG_TR, ""); - print_otag(h, TAG_TBODY, 0, NULL); - - tt = print_otag(h, TAG_TR, 0, NULL); - - PAIR_CLASS_INIT(&tag[0], "head-ltitle"); - print_otag(h, TAG_TD, 1, tag); + print_otag(h, TAG_TD, "c", "head-ltitle"); print_text(h, title); print_stagq(h, tt); - PAIR_CLASS_INIT(&tag[0], "head-vol"); - PAIR_INIT(&tag[1], ATTR_ALIGN, "center"); - print_otag(h, TAG_TD, 2, tag); - print_text(h, b); + print_otag(h, TAG_TD, "c", "head-vol"); + if (NULL != man->vol) + print_text(h, man->vol); print_stagq(h, tt); - PAIR_CLASS_INIT(&tag[0], "head-rtitle"); - PAIR_INIT(&tag[1], ATTR_ALIGN, "right"); - print_otag(h, TAG_TD, 2, tag); + print_otag(h, TAG_TD, "c", "head-rtitle"); print_text(h, title); print_tagq(h, t); + free(title); } - -/* ARGSUSED */ static void man_root_post(MAN_ARGS) { - struct htmlpair tag[3]; struct tag *t, *tt; - PAIR_SUMMARY_INIT(&tag[0], "Document Footer"); - PAIR_CLASS_INIT(&tag[1], "foot"); - 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); + t = print_otag(h, TAG_TABLE, "c", "foot"); + tt = print_otag(h, TAG_TR, ""); - tt = print_otag(h, TAG_TR, 0, NULL); - - PAIR_CLASS_INIT(&tag[0], "foot-date"); - print_otag(h, TAG_TD, 1, tag); - - assert(man->date); + print_otag(h, TAG_TD, "c", "foot-date"); print_text(h, man->date); print_stagq(h, tt); - PAIR_CLASS_INIT(&tag[0], "foot-os"); - PAIR_INIT(&tag[1], ATTR_ALIGN, "right"); - print_otag(h, TAG_TD, 2, tag); - - if (man->source) - print_text(h, man->source); + print_otag(h, TAG_TD, "c", "foot-os"); + if (man->os) + print_text(h, man->os); print_tagq(h, t); } -/* ARGSUSED */ static int man_br_pre(MAN_ARGS) { struct roffsu su; - struct htmlpair tag; SCALE_VS_INIT(&su, 1); if (MAN_sp == n->tok) { if (NULL != (n = n->child)) if ( ! a2roffsu(n->string, &su, SCALE_VS)) - SCALE_VS_INIT(&su, atoi(n->string)); + su.scale = 1.0; } else - su.scale = 0; + su.scale = 0.0; - bufinit(h); - bufcat_su(h, "height", &su); - PAIR_STYLE_INIT(&tag, h); - print_otag(h, TAG_DIV, 1, &tag); + print_otag(h, TAG_DIV, "suh", &su); /* So the div isn't empty: */ print_text(h, "\\~"); - return(0); + return 0; } -/* ARGSUSED */ static int man_SH_pre(MAN_ARGS) { - struct htmlpair tag; - - if (MAN_BLOCK == n->type) { + if (n->type == ROFFT_BLOCK) { mh->fl &= ~MANH_LITERAL; - PAIR_CLASS_INIT(&tag, "section"); - print_otag(h, TAG_DIV, 1, &tag); - return(1); - } else if (MAN_BODY == n->type) - return(1); + return 1; + } else if (n->type == ROFFT_BODY) + return 1; - print_otag(h, TAG_H1, 0, NULL); - return(1); + print_otag(h, TAG_H1, "c", "Sh"); + return 1; } -/* ARGSUSED */ static int man_alt_pre(MAN_ARGS) { - const struct man_node *nn; + const struct roff_node *nn; int i, savelit; enum htmltag fp; struct tag *t; - if ((savelit = mh->fl & MANH_LITERAL)) - print_otag(h, TAG_BR, 0, NULL); + if ((savelit = mh->fl & MANH_LITERAL)) + print_otag(h, TAG_BR, ""); mh->fl &= ~MANH_LITERAL; for (i = 0, nn = n->child; nn; nn = nn->next, i++) { t = NULL; switch (n->tok) { - case (MAN_BI): + case MAN_BI: fp = i % 2 ? TAG_I : TAG_B; break; - case (MAN_IB): + case MAN_IB: fp = i % 2 ? TAG_B : TAG_I; break; - case (MAN_RI): + case MAN_RI: fp = i % 2 ? TAG_I : TAG_MAX; break; - case (MAN_IR): + case MAN_IR: fp = i % 2 ? TAG_MAX : TAG_I; break; - case (MAN_BR): + case MAN_BR: fp = i % 2 ? TAG_MAX : TAG_B; break; - case (MAN_RB): + case MAN_RB: fp = i % 2 ? TAG_B : TAG_MAX; break; default: abort(); - /* NOTREACHED */ } if (i) h->flags |= HTML_NOSPACE; if (TAG_MAX != fp) - t = print_otag(h, fp, 0, NULL); + t = print_otag(h, fp, ""); print_man_node(man, nn, mh, h); @@ -483,68 +412,59 @@ man_alt_pre(MAN_ARGS) if (savelit) mh->fl |= MANH_LITERAL; - return(0); + return 0; } -/* ARGSUSED */ static int man_SM_pre(MAN_ARGS) { - - print_otag(h, TAG_SMALL, 0, NULL); + print_otag(h, TAG_SMALL, ""); if (MAN_SB == n->tok) - print_otag(h, TAG_B, 0, NULL); - return(1); + print_otag(h, TAG_B, ""); + return 1; } -/* ARGSUSED */ static int man_SS_pre(MAN_ARGS) { - struct htmlpair tag; - - if (MAN_BLOCK == n->type) { + if (n->type == ROFFT_BLOCK) { mh->fl &= ~MANH_LITERAL; - PAIR_CLASS_INIT(&tag, "subsection"); - print_otag(h, TAG_DIV, 1, &tag); - return(1); - } else if (MAN_BODY == n->type) - return(1); + return 1; + } else if (n->type == ROFFT_BODY) + return 1; - print_otag(h, TAG_H2, 0, NULL); - return(1); + print_otag(h, TAG_H2, "c", "Ss"); + return 1; } -/* ARGSUSED */ static int man_PP_pre(MAN_ARGS) { - if (MAN_HEAD == n->type) - return(0); - else if (MAN_BLOCK == n->type) + if (n->type == ROFFT_HEAD) + return 0; + else if (n->type == ROFFT_BLOCK) print_bvspace(h, n); - return(1); + return 1; } -/* ARGSUSED */ static int man_IP_pre(MAN_ARGS) { - const struct man_node *nn; + const struct roff_node *nn; - if (MAN_BODY == n->type) { - print_otag(h, TAG_DD, 0, NULL); - return(1); - } else if (MAN_HEAD != n->type) { - print_otag(h, TAG_DL, 0, NULL); - return(1); + if (n->type == ROFFT_BODY) { + print_otag(h, TAG_DD, "c", "It-tag"); + return 1; + } else if (n->type != ROFFT_HEAD) { + print_otag(h, TAG_DL, "c", "Bl-tag"); + return 1; } /* FIXME: width specification. */ - print_otag(h, TAG_DT, 0, NULL); + print_otag(h, TAG_DT, "c", "It-tag"); /* For IP, only print the first header element. */ @@ -553,166 +473,144 @@ man_IP_pre(MAN_ARGS) /* For TP, only print next-line header elements. */ - if (MAN_TP == n->tok) - for (nn = n->child; nn; nn = nn->next) - if (nn->line > n->line) - print_man_node(man, nn, mh, h); + if (MAN_TP == n->tok) { + nn = n->child; + while (NULL != nn && 0 == (NODE_LINE & nn->flags)) + nn = nn->next; + while (NULL != nn) { + print_man_node(man, nn, mh, h); + nn = nn->next; + } + } - return(0); + return 0; } -/* ARGSUSED */ static int man_HP_pre(MAN_ARGS) { - struct htmlpair tag; - struct roffsu su; - const struct man_node *np; + struct roffsu sum, sui; + const struct roff_node *np; - if (MAN_HEAD == n->type) - return(0); - else if (MAN_BLOCK != n->type) - return(1); + if (n->type == ROFFT_HEAD) + return 0; + else if (n->type != ROFFT_BLOCK) + return 1; np = n->head->child; - if (NULL == np || ! a2width(np, &su)) - SCALE_HS_INIT(&su, INDENT); + if (np == NULL || !a2width(np, &sum)) + SCALE_HS_INIT(&sum, INDENT); - bufinit(h); + sui.unit = sum.unit; + sui.scale = -sum.scale; 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_P, 1, &tag); - return(1); + print_otag(h, TAG_DIV, "csului", "Pp", &sum, &sui); + return 1; } -/* ARGSUSED */ static int man_OP_pre(MAN_ARGS) { struct tag *tt; - struct htmlpair tag; print_text(h, "["); h->flags |= HTML_NOSPACE; - PAIR_CLASS_INIT(&tag, "opt"); - tt = print_otag(h, TAG_SPAN, 1, &tag); + tt = print_otag(h, TAG_SPAN, "c", "Op"); if (NULL != (n = n->child)) { - print_otag(h, TAG_B, 0, NULL); + print_otag(h, TAG_B, ""); print_text(h, n->string); } print_stagq(h, tt); if (NULL != n && NULL != n->next) { - print_otag(h, TAG_I, 0, NULL); + print_otag(h, TAG_I, ""); print_text(h, n->next->string); } print_stagq(h, tt); h->flags |= HTML_NOSPACE; print_text(h, "]"); - return(0); + return 0; } - -/* ARGSUSED */ static int man_B_pre(MAN_ARGS) { - - print_otag(h, TAG_B, 0, NULL); - return(1); + print_otag(h, TAG_B, ""); + return 1; } -/* ARGSUSED */ static int man_I_pre(MAN_ARGS) { - - print_otag(h, TAG_I, 0, NULL); - return(1); + print_otag(h, TAG_I, ""); + return 1; } -/* ARGSUSED */ static int man_literal_pre(MAN_ARGS) { if (MAN_fi == n->tok || MAN_EE == n->tok) { - print_otag(h, TAG_BR, 0, NULL); + print_otag(h, TAG_BR, ""); mh->fl &= ~MANH_LITERAL; } else mh->fl |= MANH_LITERAL; - return(0); + return 0; } -/* ARGSUSED */ static int man_in_pre(MAN_ARGS) { - - print_otag(h, TAG_BR, 0, NULL); - return(0); + print_otag(h, TAG_BR, ""); + return 0; } -/* ARGSUSED */ static int man_ign_pre(MAN_ARGS) { - return(0); + return 0; } -/* ARGSUSED */ static int man_RS_pre(MAN_ARGS) { - struct htmlpair tag; struct roffsu su; - if (MAN_HEAD == n->type) - return(0); - else if (MAN_BODY == n->type) - return(1); + if (n->type == ROFFT_HEAD) + return 0; + else if (n->type == ROFFT_BODY) + return 1; SCALE_HS_INIT(&su, INDENT); 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); - return(1); + print_otag(h, TAG_DIV, "sul", &su); + return 1; } -/* ARGSUSED */ static int man_UR_pre(MAN_ARGS) { - struct htmlpair tag[2]; - n = n->child; - assert(MAN_HEAD == n->type); - if (n->nchild) { - assert(MAN_TEXT == n->child->type); - PAIR_CLASS_INIT(&tag[0], "link-ext"); - PAIR_HREF_INIT(&tag[1], n->child->string); - print_otag(h, TAG_A, 2, tag); + assert(n->type == ROFFT_HEAD); + if (n->child != NULL) { + assert(n->child->type == ROFFT_TEXT); + print_otag(h, TAG_A, "ch", "Lk", n->child->string); } - assert(MAN_BODY == n->next->type); - if (n->next->nchild) + assert(n->next->type == ROFFT_BODY); + if (n->next->child != NULL) n = n->next; print_man_nodelist(man, n->child, mh, h); - return(0); + return 0; }