1 /* $Id: man_html.c,v 1.120 2016/01/08 17:48:09 schwarze Exp $ */
3 * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 #include <sys/types.h>
28 #include "mandoc_aux.h"
35 /* TODO: preserve ident widths. */
36 /* FIXME: have PD set the default vspace width. */
40 #define MAN_ARGS const struct roff_meta *man, \
41 const struct roff_node *n, \
47 #define MANH_LITERAL (1 << 0) /* literal context */
52 int (*post)(MAN_ARGS);
55 static void print_bvspace(struct html *,
56 const struct roff_node *);
57 static void print_man_head(MAN_ARGS);
58 static void print_man_nodelist(MAN_ARGS);
59 static void print_man_node(MAN_ARGS);
60 static int a2width(const struct roff_node *,
62 static int man_B_pre(MAN_ARGS);
63 static int man_HP_pre(MAN_ARGS);
64 static int man_IP_pre(MAN_ARGS);
65 static int man_I_pre(MAN_ARGS);
66 static int man_OP_pre(MAN_ARGS);
67 static int man_PP_pre(MAN_ARGS);
68 static int man_RS_pre(MAN_ARGS);
69 static int man_SH_pre(MAN_ARGS);
70 static int man_SM_pre(MAN_ARGS);
71 static int man_SS_pre(MAN_ARGS);
72 static int man_UR_pre(MAN_ARGS);
73 static int man_alt_pre(MAN_ARGS);
74 static int man_br_pre(MAN_ARGS);
75 static int man_ign_pre(MAN_ARGS);
76 static int man_in_pre(MAN_ARGS);
77 static int man_literal_pre(MAN_ARGS);
78 static void man_root_post(MAN_ARGS);
79 static void man_root_pre(MAN_ARGS);
81 static const struct htmlman mans[MAN_MAX] = {
82 { man_br_pre, NULL }, /* br */
83 { NULL, NULL }, /* TH */
84 { man_SH_pre, NULL }, /* SH */
85 { man_SS_pre, NULL }, /* SS */
86 { man_IP_pre, NULL }, /* TP */
87 { man_PP_pre, NULL }, /* LP */
88 { man_PP_pre, NULL }, /* PP */
89 { man_PP_pre, NULL }, /* P */
90 { man_IP_pre, NULL }, /* IP */
91 { man_HP_pre, NULL }, /* HP */
92 { man_SM_pre, NULL }, /* SM */
93 { man_SM_pre, NULL }, /* SB */
94 { man_alt_pre, NULL }, /* BI */
95 { man_alt_pre, NULL }, /* IB */
96 { man_alt_pre, NULL }, /* BR */
97 { man_alt_pre, NULL }, /* RB */
98 { NULL, NULL }, /* R */
99 { man_B_pre, NULL }, /* B */
100 { man_I_pre, NULL }, /* I */
101 { man_alt_pre, NULL }, /* IR */
102 { man_alt_pre, NULL }, /* RI */
103 { man_br_pre, NULL }, /* sp */
104 { man_literal_pre, NULL }, /* nf */
105 { man_literal_pre, NULL }, /* fi */
106 { NULL, NULL }, /* RE */
107 { man_RS_pre, NULL }, /* RS */
108 { man_ign_pre, NULL }, /* DT */
109 { man_ign_pre, NULL }, /* UC */
110 { man_ign_pre, NULL }, /* PD */
111 { man_ign_pre, NULL }, /* AT */
112 { man_in_pre, NULL }, /* in */
113 { man_ign_pre, NULL }, /* ft */
114 { man_OP_pre, NULL }, /* OP */
115 { man_literal_pre, NULL }, /* EX */
116 { man_literal_pre, NULL }, /* EE */
117 { man_UR_pre, NULL }, /* UR */
118 { NULL, NULL }, /* UE */
119 { man_ign_pre, NULL }, /* ll */
124 * Printing leading vertical space before a block.
125 * This is used for the paragraph macros.
126 * The rules are pretty simple, since there's very little nesting going
127 * on here. Basically, if we're the first within another block (SS/SH),
128 * then don't emit vertical space. If we are (RS), then do. If not the
132 print_bvspace(struct html *h, const struct roff_node *n)
135 if (n->body && n->body->child)
136 if (n->body->child->type == ROFFT_TBL)
139 if (n->parent->type == ROFFT_ROOT || n->parent->tok != MAN_RS)
147 html_man(void *arg, const struct roff_man *man)
154 memset(&mh, 0, sizeof(mh));
155 PAIR_CLASS_INIT(&tag, "mandoc");
156 h = (struct html *)arg;
158 if ( ! (HTML_FRAGMENT & h->oflags)) {
160 t = print_otag(h, TAG_HTML, 0, NULL);
161 tt = print_otag(h, TAG_HEAD, 0, NULL);
162 print_man_head(&man->meta, man->first, &mh, h);
164 print_otag(h, TAG_BODY, 0, NULL);
165 print_otag(h, TAG_DIV, 1, &tag);
167 t = print_otag(h, TAG_DIV, 1, &tag);
169 print_man_nodelist(&man->meta, man->first, &mh, h);
175 print_man_head(MAN_ARGS)
181 bufcat_fmt(h, "%s(%s)", man->title, man->msec);
182 print_otag(h, TAG_TITLE, 0, NULL);
183 print_text(h, h->buf);
187 print_man_nodelist(MAN_ARGS)
191 print_man_node(man, n, mh, h);
197 print_man_node(MAN_ARGS)
207 man_root_pre(man, n, mh, h);
210 if ('\0' == *n->string) {
214 if (n->flags & MAN_LINE && (*n->string == ' ' ||
215 (n->prev != NULL && mh->fl & MANH_LITERAL &&
216 ! (h->flags & HTML_NONEWLINE))))
217 print_otag(h, TAG_BR, 0, NULL);
218 print_text(h, n->string);
221 if (n->flags & MAN_LINE)
223 print_eqn(h, n->eqn);
227 * This will take care of initialising all of the table
228 * state data for the first table, then tearing it down
231 print_tbl(h, n->span);
235 * Close out scope of font prior to opening a macro
238 if (HTMLFONT_NONE != h->metac) {
240 h->metac = HTMLFONT_NONE;
244 * Close out the current table, if it's open, and unset
245 * the "meta" table state. This will be reopened on the
246 * next table element.
252 if (mans[n->tok].pre)
253 child = (*mans[n->tok].pre)(man, n, mh, h);
257 if (child && n->child)
258 print_man_nodelist(man, n->child, mh, h);
260 /* This will automatically close out any font scope. */
265 man_root_post(man, n, mh, h);
270 if (mans[n->tok].post)
271 (*mans[n->tok].post)(man, n, mh, h);
277 a2width(const struct roff_node *n, struct roffsu *su)
280 if (n->type != ROFFT_TEXT)
282 if (a2roffsu(n->string, su, SCALE_EN))
289 man_root_pre(MAN_ARGS)
297 mandoc_asprintf(&title, "%s(%s)", man->title, man->msec);
299 PAIR_CLASS_INIT(&tag, "head");
300 t = print_otag(h, TAG_TABLE, 1, &tag);
302 print_otag(h, TAG_TBODY, 0, NULL);
304 tt = print_otag(h, TAG_TR, 0, NULL);
306 PAIR_CLASS_INIT(&tag, "head-ltitle");
307 print_otag(h, TAG_TD, 1, &tag);
308 print_text(h, title);
311 PAIR_CLASS_INIT(&tag, "head-vol");
312 print_otag(h, TAG_TD, 1, &tag);
313 if (NULL != man->vol)
314 print_text(h, man->vol);
317 PAIR_CLASS_INIT(&tag, "head-rtitle");
318 print_otag(h, TAG_TD, 1, &tag);
319 print_text(h, title);
325 man_root_post(MAN_ARGS)
330 PAIR_CLASS_INIT(&tag, "foot");
331 t = print_otag(h, TAG_TABLE, 1, &tag);
333 tt = print_otag(h, TAG_TR, 0, NULL);
335 PAIR_CLASS_INIT(&tag, "foot-date");
336 print_otag(h, TAG_TD, 1, &tag);
339 print_text(h, man->date);
342 PAIR_CLASS_INIT(&tag, "foot-os");
343 print_otag(h, TAG_TD, 1, &tag);
346 print_text(h, man->os);
357 SCALE_VS_INIT(&su, 1);
359 if (MAN_sp == n->tok) {
360 if (NULL != (n = n->child))
361 if ( ! a2roffsu(n->string, &su, SCALE_VS))
367 bufcat_su(h, "height", &su);
368 PAIR_STYLE_INIT(&tag, h);
369 print_otag(h, TAG_DIV, 1, &tag);
371 /* So the div isn't empty: */
372 print_text(h, "\\~");
382 if (n->type == ROFFT_BLOCK) {
383 mh->fl &= ~MANH_LITERAL;
384 PAIR_CLASS_INIT(&tag, "section");
385 print_otag(h, TAG_DIV, 1, &tag);
387 } else if (n->type == ROFFT_BODY)
390 print_otag(h, TAG_H1, 0, NULL);
395 man_alt_pre(MAN_ARGS)
397 const struct roff_node *nn;
402 if ((savelit = mh->fl & MANH_LITERAL))
403 print_otag(h, TAG_BR, 0, NULL);
405 mh->fl &= ~MANH_LITERAL;
407 for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
411 fp = i % 2 ? TAG_I : TAG_B;
414 fp = i % 2 ? TAG_B : TAG_I;
417 fp = i % 2 ? TAG_I : TAG_MAX;
420 fp = i % 2 ? TAG_MAX : TAG_I;
423 fp = i % 2 ? TAG_MAX : TAG_B;
426 fp = i % 2 ? TAG_B : TAG_MAX;
433 h->flags |= HTML_NOSPACE;
436 t = print_otag(h, fp, 0, NULL);
438 print_man_node(man, nn, mh, h);
445 mh->fl |= MANH_LITERAL;
454 print_otag(h, TAG_SMALL, 0, NULL);
455 if (MAN_SB == n->tok)
456 print_otag(h, TAG_B, 0, NULL);
465 if (n->type == ROFFT_BLOCK) {
466 mh->fl &= ~MANH_LITERAL;
467 PAIR_CLASS_INIT(&tag, "subsection");
468 print_otag(h, TAG_DIV, 1, &tag);
470 } else if (n->type == ROFFT_BODY)
473 print_otag(h, TAG_H2, 0, NULL);
481 if (n->type == ROFFT_HEAD)
483 else if (n->type == ROFFT_BLOCK)
492 const struct roff_node *nn;
494 if (n->type == ROFFT_BODY) {
495 print_otag(h, TAG_DD, 0, NULL);
497 } else if (n->type != ROFFT_HEAD) {
498 print_otag(h, TAG_DL, 0, NULL);
502 /* FIXME: width specification. */
504 print_otag(h, TAG_DT, 0, NULL);
506 /* For IP, only print the first header element. */
508 if (MAN_IP == n->tok && n->child)
509 print_man_node(man, n->child, mh, h);
511 /* For TP, only print next-line header elements. */
513 if (MAN_TP == n->tok) {
515 while (NULL != nn && 0 == (MAN_LINE & nn->flags))
518 print_man_node(man, nn, mh, h);
529 struct htmlpair tag[2];
531 const struct roff_node *np;
533 if (n->type == ROFFT_HEAD)
535 else if (n->type != ROFFT_BLOCK)
540 if (NULL == np || ! a2width(np, &su))
541 SCALE_HS_INIT(&su, INDENT);
546 bufcat_su(h, "margin-left", &su);
547 su.scale = -su.scale;
548 bufcat_su(h, "text-indent", &su);
549 PAIR_STYLE_INIT(&tag[0], h);
550 PAIR_CLASS_INIT(&tag[1], "spacer");
551 print_otag(h, TAG_DIV, 2, tag);
562 h->flags |= HTML_NOSPACE;
563 PAIR_CLASS_INIT(&tag, "opt");
564 tt = print_otag(h, TAG_SPAN, 1, &tag);
566 if (NULL != (n = n->child)) {
567 print_otag(h, TAG_B, 0, NULL);
568 print_text(h, n->string);
573 if (NULL != n && NULL != n->next) {
574 print_otag(h, TAG_I, 0, NULL);
575 print_text(h, n->next->string);
579 h->flags |= HTML_NOSPACE;
588 print_otag(h, TAG_B, 0, NULL);
596 print_otag(h, TAG_I, 0, NULL);
601 man_literal_pre(MAN_ARGS)
604 if (MAN_fi == n->tok || MAN_EE == n->tok) {
605 print_otag(h, TAG_BR, 0, NULL);
606 mh->fl &= ~MANH_LITERAL;
608 mh->fl |= MANH_LITERAL;
617 print_otag(h, TAG_BR, 0, NULL);
622 man_ign_pre(MAN_ARGS)
634 if (n->type == ROFFT_HEAD)
636 else if (n->type == ROFFT_BODY)
639 SCALE_HS_INIT(&su, INDENT);
641 a2width(n->head->child, &su);
644 bufcat_su(h, "margin-left", &su);
645 PAIR_STYLE_INIT(&tag, h);
646 print_otag(h, TAG_DIV, 1, &tag);
653 struct htmlpair tag[2];
656 assert(n->type == ROFFT_HEAD);
657 if (n->child != NULL) {
658 assert(n->child->type == ROFFT_TEXT);
659 PAIR_CLASS_INIT(&tag[0], "link-ext");
660 PAIR_HREF_INIT(&tag[1], n->child->string);
661 print_otag(h, TAG_A, 2, tag);
664 assert(n->next->type == ROFFT_BODY);
665 if (n->next->child != NULL)
668 print_man_nodelist(man, n->child, mh, h);