=================================================================== RCS file: /cvs/mandoc/man_html.c,v retrieving revision 1.102 retrieving revision 1.131 diff -u -p -r1.102 -r1.131 --- mandoc/man_html.c 2014/09/27 09:26:01 1.102 +++ mandoc/man_html.c 2017/01/29 14:02:42 1.131 @@ -1,15 +1,15 @@ -/* $Id: man_html.c,v 1.102 2014/09/27 09:26:01 kristaps Exp $ */ +/* $Id: man_html.c,v 1.131 2017/01/29 14:02:42 schwarze Exp $ */ /* - * Copyright (c) 2008-2012 Kristaps Dzonsons - * Copyright (c) 2013, 2014 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 @@ -25,26 +25,24 @@ #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. */ /* FIXME: have PD set the default vspace width. */ #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 struct mhtml { - int fl; -#define MANH_LITERAL (1 << 0) /* literal context */ + struct tag *nofill; }; struct htmlman { @@ -53,12 +51,11 @@ struct htmlman { }; static void print_bvspace(struct html *, - const struct man_node *); -static void print_man(MAN_ARGS); + 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); @@ -73,9 +70,9 @@ static int man_SS_pre(MAN_ARGS); static int man_UR_pre(MAN_ARGS); static int man_alt_pre(MAN_ARGS); static int man_br_pre(MAN_ARGS); +static int man_fill_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 void man_root_pre(MAN_ARGS); @@ -101,10 +98,9 @@ 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 */ + { man_fill_pre, NULL }, /* nf */ + { man_fill_pre, NULL }, /* fi */ { NULL, NULL }, /* RE */ { man_RS_pre, NULL }, /* RS */ { man_ign_pre, NULL }, /* DT */ @@ -114,8 +110,8 @@ static const struct htmlman mans[MAN_MAX] = { { man_in_pre, NULL }, /* in */ { man_ign_pre, NULL }, /* ft */ { man_OP_pre, NULL }, /* OP */ - { man_literal_pre, NULL }, /* EX */ - { man_literal_pre, NULL }, /* EE */ + { man_fill_pre, NULL }, /* EX */ + { man_fill_pre, NULL }, /* EE */ { man_UR_pre, NULL }, /* UR */ { NULL, NULL }, /* UE */ { man_ign_pre, NULL }, /* ll */ @@ -131,72 +127,67 @@ 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'); -} + mh.nofill = NULL; + 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); } 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 @@ -206,34 +197,25 @@ print_man_node(MAN_ARGS) struct tag *t; child = 1; - t = h->tags.head; + t = h->tag; + if (t == mh->nofill) + t = t->next; 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 (mh->nofill == NULL && + n->flags & NODE_LINE && *n->string == ' ') + print_otag(h, TAG_BR, ""); print_text(h, n->string); - return; - case MAN_EQN: + break; + 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 @@ -258,7 +240,7 @@ print_man_node(MAN_ARGS) */ if (h->tblt) { print_tblclose(h); - t = h->tags.head; + t = h->tag; } if (mans[n->tok].pre) child = (*mans[n->tok].pre)(man, n, mh, h); @@ -269,37 +251,32 @@ print_man_node(MAN_ARGS) print_man_nodelist(man, n->child, mh, h); /* This will automatically close out any font scope. */ - print_stagq(h, t); + print_stagq(h, mh->nofill == NULL ? t : mh->nofill); - switch (n->type) { - case MAN_ROOT: - man_root_post(man, n, mh, h); - break; - case MAN_EQN: - break; - default: - if (mans[n->tok].post) - (*mans[n->tok].post)(man, n, mh, h); - break; - } + if (n->type != ROFFT_TEXT && n->type != ROFFT_EQN && + mans[n->tok].post != NULL) + (*mans[n->tok].post)(man, n, mh, h); + + if (mh->nofill != NULL && + (n->next == NULL || n->next->flags & NODE_LINE)) + print_endline(h); } 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; } static void man_root_pre(MAN_ARGS) { - struct htmlpair tag; struct tag *t, *tt; char *title; @@ -307,26 +284,20 @@ man_root_pre(MAN_ARGS) assert(man->msec); mandoc_asprintf(&title, "%s(%s)", man->title, man->msec); - PAIR_CLASS_INIT(&tag, "head"); - t = print_otag(h, TAG_TABLE, 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, "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, "head-vol"); - print_otag(h, TAG_TD, 1, &tag); + 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, "head-rtitle"); - print_otag(h, TAG_TD, 1, &tag); + print_otag(h, TAG_TD, "c", "head-rtitle"); print_text(h, title); print_tagq(h, t); free(title); @@ -335,26 +306,18 @@ man_root_pre(MAN_ARGS) static void man_root_post(MAN_ARGS) { - struct htmlpair tag; struct tag *t, *tt; - PAIR_CLASS_INIT(&tag, "foot"); - t = print_otag(h, TAG_TABLE, 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, "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, "foot-os"); - print_otag(h, TAG_TD, 1, &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); } @@ -363,60 +326,44 @@ 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.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; } static int 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); - } else if (MAN_BODY == n->type) - return(1); - - print_otag(h, TAG_H1, 0, NULL); - return(1); + if (n->type == ROFFT_BLOCK && mh->nofill != NULL) { + print_tagq(h, mh->nofill); + mh->nofill = NULL; + } else if (n->type == ROFFT_HEAD) + print_otag(h, TAG_H1, "c", "Sh"); + return 1; } static int man_alt_pre(MAN_ARGS) { - const struct man_node *nn; - int i, savelit; + const struct roff_node *nn; + int i; 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) { case MAN_BI: fp = i % 2 ? TAG_I : TAG_B; @@ -438,82 +385,70 @@ man_alt_pre(MAN_ARGS) break; default: abort(); - /* NOTREACHED */ } if (i) h->flags |= HTML_NOSPACE; - if (TAG_MAX != fp) - t = print_otag(h, fp, 0, NULL); + if (fp != TAG_MAX) + t = print_otag(h, fp, ""); - print_man_node(man, nn, mh, h); + print_text(h, nn->string); - if (t) + if (fp != TAG_MAX) print_tagq(h, t); } - - if (savelit) - mh->fl |= MANH_LITERAL; - - return(0); + return 0; } 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; } static int 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); - } else if (MAN_BODY == n->type) - return(1); - - print_otag(h, TAG_H2, 0, NULL); - return(1); + if (n->type == ROFFT_BLOCK && mh->nofill != NULL) { + print_tagq(h, mh->nofill); + mh->nofill = NULL; + } else if (n->type == ROFFT_HEAD) + print_otag(h, TAG_H2, "c", "Ss"); + return 1; } 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; } 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. */ @@ -524,7 +459,7 @@ man_IP_pre(MAN_ARGS) if (MAN_TP == n->tok) { nn = n->child; - while (NULL != nn && 0 == (MAN_LINE & nn->flags)) + while (NULL != nn && 0 == (NODE_LINE & nn->flags)) nn = nn->next; while (NULL != nn) { print_man_node(man, nn, mh, h); @@ -532,151 +467,139 @@ man_IP_pre(MAN_ARGS) } } - return(0); + return 0; } 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; } 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; } static int man_B_pre(MAN_ARGS) { - - print_otag(h, TAG_B, 0, NULL); - return(1); + print_otag(h, TAG_B, ""); + return 1; } static int man_I_pre(MAN_ARGS) { - - print_otag(h, TAG_I, 0, NULL); - return(1); + print_otag(h, TAG_I, ""); + return 1; } static int -man_literal_pre(MAN_ARGS) +man_fill_pre(MAN_ARGS) { - if (MAN_fi == n->tok || MAN_EE == n->tok) { - print_otag(h, TAG_BR, 0, NULL); - mh->fl &= ~MANH_LITERAL; - } else - mh->fl |= MANH_LITERAL; - - return(0); + if (mh->nofill != NULL) { + print_tagq(h, mh->nofill); + mh->nofill = NULL; + } else + print_otag(h, TAG_BR, ""); + } else { + if (mh->nofill == NULL) + mh->nofill = print_otag(h, TAG_PRE, ""); + else + print_otag(h, TAG_BR, ""); + } + return 0; } static int man_in_pre(MAN_ARGS) { - - print_otag(h, TAG_BR, 0, NULL); - return(0); + print_otag(h, TAG_BR, ""); + return 0; } static int man_ign_pre(MAN_ARGS) { - return(0); + return 0; } 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; } 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; }