1 /* $Id: man_html.c,v 1.62 2011/01/07 13:20:58 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 #include <sys/types.h>
35 /* TODO: preserve ident widths. */
36 /* FIXME: have PD set the default vspace width. */
41 #define MAN_ARGS const struct man_meta *m, \
42 const struct man_node *n, \
48 #define MANH_LITERAL (1 << 0) /* literal context */
53 int (*post)(MAN_ARGS);
56 static void print_man(MAN_ARGS);
57 static void print_man_head(MAN_ARGS);
58 static void print_man_nodelist(MAN_ARGS);
59 static void print_man_node(MAN_ARGS);
61 static int a2width(const struct man_node *,
64 static int man_alt_pre(MAN_ARGS);
65 static int man_br_pre(MAN_ARGS);
66 static int man_ign_pre(MAN_ARGS);
67 static int man_in_pre(MAN_ARGS);
68 static int man_literal_pre(MAN_ARGS);
69 static void man_root_post(MAN_ARGS);
70 static int man_root_pre(MAN_ARGS);
71 static int man_B_pre(MAN_ARGS);
72 static int man_HP_pre(MAN_ARGS);
73 static int man_I_pre(MAN_ARGS);
74 static int man_IP_pre(MAN_ARGS);
75 static int man_PP_pre(MAN_ARGS);
76 static int man_RS_pre(MAN_ARGS);
77 static int man_SH_pre(MAN_ARGS);
78 static int man_SM_pre(MAN_ARGS);
79 static int man_SS_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 { NULL, NULL }, /* na */
104 { man_br_pre, NULL }, /* sp */
105 { man_literal_pre, NULL }, /* nf */
106 { man_literal_pre, NULL }, /* fi */
107 { NULL, NULL }, /* RE */
108 { man_RS_pre, NULL }, /* RS */
109 { man_ign_pre, NULL }, /* DT */
110 { man_ign_pre, NULL }, /* UC */
111 { man_ign_pre, NULL }, /* PD */
112 { man_ign_pre, NULL }, /* AT */
113 { man_in_pre, NULL }, /* in */
114 { man_ign_pre, NULL }, /* ft */
119 html_man(void *arg, const struct man *m)
125 h = (struct html *)arg;
129 memset(&mh, 0, sizeof(struct mhtml));
131 t = print_otag(h, TAG_HTML, 0, NULL);
132 print_man(man_meta(m), man_node(m), &mh, h);
144 t = print_otag(h, TAG_HEAD, 0, NULL);
145 print_man_head(m, n, mh, h);
148 t = print_otag(h, TAG_BODY, 0, NULL);
149 print_man_nodelist(m, n, mh, h);
156 print_man_head(MAN_ARGS)
161 buffmt(h, "%s(%s)", m->title, m->msec);
163 print_otag(h, TAG_TITLE, 0, NULL);
164 print_text(h, h->buf);
169 print_man_nodelist(MAN_ARGS)
172 print_man_node(m, n, mh, h);
174 print_man_nodelist(m, n->next, mh, h);
179 print_man_node(MAN_ARGS)
190 * FIXME: embedded elements within next-line scopes (e.g., `br'
191 * within an empty `B') will cause formatting to be forgotten
192 * due to scope closing out.
197 child = man_root_pre(m, n, mh, h);
200 print_text(h, n->string);
201 if (MANH_LITERAL & mh->fl)
202 print_otag(h, TAG_BR, 0, NULL);
205 print_tbl(h, n->span);
209 * Close out scope of font prior to opening a macro
210 * scope. Assert that the metafont is on the top of the
211 * stack (it's never nested).
213 if (HTMLFONT_NONE != h->metac) {
215 h->metac = HTMLFONT_NONE;
217 if (mans[n->tok].pre)
218 child = (*mans[n->tok].pre)(m, n, mh, h);
222 if (child && n->child)
223 print_man_nodelist(m, n->child, mh, h);
225 /* This will automatically close out any font scope. */
232 man_root_post(m, n, mh, h);
237 if (mans[n->tok].post)
238 (*mans[n->tok].post)(m, n, mh, h);
245 a2width(const struct man_node *n, struct roffsu *su)
248 if (MAN_TEXT != n->type)
250 if (a2roffsu(n->string, su, SCALE_BU))
259 man_root_pre(MAN_ARGS)
261 struct htmlpair tag[3];
263 char b[BUFSIZ], title[BUFSIZ];
267 (void)strlcat(b, m->vol, BUFSIZ);
269 snprintf(title, BUFSIZ - 1, "%s(%s)", m->title, m->msec);
271 PAIR_SUMMARY_INIT(&tag[0], "Document Header");
272 PAIR_CLASS_INIT(&tag[1], "head");
273 if (NULL == h->style) {
274 PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
275 t = print_otag(h, TAG_TABLE, 3, tag);
276 PAIR_INIT(&tag[0], ATTR_WIDTH, "30%");
277 print_otag(h, TAG_COL, 1, tag);
278 print_otag(h, TAG_COL, 1, tag);
279 print_otag(h, TAG_COL, 1, tag);
281 t = print_otag(h, TAG_TABLE, 2, tag);
283 print_otag(h, TAG_TBODY, 0, NULL);
285 tt = print_otag(h, TAG_TR, 0, NULL);
287 PAIR_CLASS_INIT(&tag[0], "head-ltitle");
288 print_otag(h, TAG_TD, 1, tag);
290 print_text(h, title);
293 PAIR_CLASS_INIT(&tag[0], "head-vol");
294 if (NULL == h->style) {
295 PAIR_INIT(&tag[1], ATTR_ALIGN, "center");
296 print_otag(h, TAG_TD, 2, tag);
298 print_otag(h, TAG_TD, 1, tag);
303 PAIR_CLASS_INIT(&tag[0], "head-rtitle");
304 if (NULL == h->style) {
305 PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
306 print_otag(h, TAG_TD, 2, tag);
308 print_otag(h, TAG_TD, 1, tag);
310 print_text(h, title);
318 man_root_post(MAN_ARGS)
320 struct htmlpair tag[3];
325 strlcpy(b, m->rawdate, DATESIZ);
327 time2a(m->date, b, DATESIZ);
329 PAIR_SUMMARY_INIT(&tag[0], "Document Footer");
330 PAIR_CLASS_INIT(&tag[1], "foot");
331 if (NULL == h->style) {
332 PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
333 t = print_otag(h, TAG_TABLE, 3, tag);
334 PAIR_INIT(&tag[0], ATTR_WIDTH, "50%");
335 print_otag(h, TAG_COL, 1, tag);
336 print_otag(h, TAG_COL, 1, tag);
338 t = print_otag(h, TAG_TABLE, 2, tag);
340 tt = print_otag(h, TAG_TR, 0, NULL);
342 PAIR_CLASS_INIT(&tag[0], "foot-date");
343 print_otag(h, TAG_TD, 1, tag);
348 PAIR_CLASS_INIT(&tag[0], "foot-os");
349 if (NULL == h->style) {
350 PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
351 print_otag(h, TAG_TD, 2, tag);
353 print_otag(h, TAG_TD, 1, tag);
356 print_text(h, m->source);
369 SCALE_VS_INIT(&su, 1);
371 if (MAN_sp == n->tok) {
373 a2roffsu(n->child->string, &su, SCALE_VS);
377 bufcat_su(h, "height", &su);
378 PAIR_STYLE_INIT(&tag, h);
379 print_otag(h, TAG_DIV, 1, &tag);
381 /* So the div isn't empty: */
382 print_text(h, "\\~");
394 if (MAN_BLOCK == n->type) {
395 PAIR_CLASS_INIT(&tag, "section");
396 print_otag(h, TAG_DIV, 1, &tag);
398 } else if (MAN_BODY == n->type)
401 print_otag(h, TAG_H1, 0, NULL);
408 man_alt_pre(MAN_ARGS)
410 const struct man_node *nn;
415 for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
419 fp = i % 2 ? TAG_I : TAG_B;
422 fp = i % 2 ? TAG_B : TAG_I;
425 fp = i % 2 ? TAG_I : TAG_MAX;
428 fp = i % 2 ? TAG_MAX : TAG_I;
431 fp = i % 2 ? TAG_MAX : TAG_B;
434 fp = i % 2 ? TAG_B : TAG_MAX;
442 h->flags |= HTML_NOSPACE;
445 t = print_otag(h, fp, 0, NULL);
447 print_man_node(m, nn, mh, h);
462 print_otag(h, TAG_SMALL, 0, NULL);
463 if (MAN_SB == n->tok)
464 print_otag(h, TAG_B, 0, NULL);
475 if (MAN_BLOCK == n->type) {
476 PAIR_CLASS_INIT(&tag, "subsection");
477 print_otag(h, TAG_DIV, 1, &tag);
479 } else if (MAN_BODY == n->type)
482 print_otag(h, TAG_H2, 0, NULL);
492 if (MAN_HEAD == n->type)
494 else if (MAN_BODY == n->type && n->prev)
495 print_otag(h, TAG_P, 0, NULL);
507 const struct man_node *nn;
510 * This scattering of 1-BU margins and pads is to make sure that
511 * when text overruns its box, the subsequent text isn't flush
512 * up against it. However, the rest of the right-hand box must
513 * also be adjusted in consideration of this 1-BU space.
516 if (MAN_BODY == n->type) {
517 print_otag(h, TAG_TD, 0, NULL);
521 nn = MAN_BLOCK == n->type ?
522 n->head->child : n->parent->head->child;
524 SCALE_HS_INIT(&su, INDENT);
526 /* Width is the second token. */
528 if (MAN_IP == n->tok && NULL != nn)
529 if (NULL != (nn = nn->next))
532 /* Width is the first token. */
534 if (MAN_TP == n->tok && NULL != nn) {
535 /* Skip past non-text children. */
536 while (nn && MAN_TEXT != nn->type)
542 if (MAN_BLOCK == n->type) {
543 print_otag(h, TAG_P, 0, NULL);
544 print_otag(h, TAG_TABLE, 0, NULL);
545 bufcat_su(h, "width", &su);
546 PAIR_STYLE_INIT(&tag, h);
547 print_otag(h, TAG_COL, 1, &tag);
548 print_otag(h, TAG_COL, 0, NULL);
549 print_otag(h, TAG_TBODY, 0, NULL);
550 print_otag(h, TAG_TR, 0, NULL);
554 print_otag(h, TAG_TD, 0, NULL);
556 /* For IP, only print the first header element. */
558 if (MAN_IP == n->tok && n->child)
559 print_man_node(m, n->child, mh, h);
561 /* For TP, only print next-line header elements. */
563 if (MAN_TP == n->tok)
564 for (nn = n->child; nn; nn = nn->next)
565 if (nn->line > n->line)
566 print_man_node(m, nn, mh, h);
578 const struct man_node *np;
580 np = MAN_BLOCK == n->type ?
582 n->parent->head->child;
584 if (NULL == np || ! a2width(np, &su))
585 SCALE_HS_INIT(&su, INDENT);
587 if (MAN_HEAD == n->type) {
588 print_otag(h, TAG_TD, 0, NULL);
590 } else if (MAN_BLOCK == n->type) {
591 print_otag(h, TAG_P, 0, NULL);
592 print_otag(h, TAG_TABLE, 0, NULL);
593 bufcat_su(h, "width", &su);
594 PAIR_STYLE_INIT(&tag, h);
595 print_otag(h, TAG_COL, 1, &tag);
596 print_otag(h, TAG_COL, 0, NULL);
597 print_otag(h, TAG_TBODY, 0, NULL);
598 print_otag(h, TAG_TR, 0, NULL);
602 su.scale = -su.scale;
603 bufcat_su(h, "text-indent", &su);
604 PAIR_STYLE_INIT(&tag, h);
605 print_otag(h, TAG_TD, 1, &tag);
615 print_otag(h, TAG_B, 0, NULL);
625 print_otag(h, TAG_I, 0, NULL);
632 man_literal_pre(MAN_ARGS)
635 if (MAN_nf == n->tok) {
636 print_otag(h, TAG_BR, 0, NULL);
637 mh->fl |= MANH_LITERAL;
639 mh->fl &= ~MANH_LITERAL;
650 print_otag(h, TAG_BR, 0, NULL);
657 man_ign_pre(MAN_ARGS)
671 if (MAN_HEAD == n->type)
673 else if (MAN_BODY == n->type)
676 SCALE_HS_INIT(&su, INDENT);
678 a2width(n->head->child, &su);
680 bufcat_su(h, "margin-left", &su);
681 PAIR_STYLE_INIT(&tag, h);
682 print_otag(h, TAG_DIV, 1, &tag);