1 /* $Id: man_html.c,v 1.70 2011/03/07 01:35:51 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 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 void 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 { man_ign_pre, 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)
191 man_root_pre(m, n, mh, h);
195 * If we have a blank line, output a vertical space.
196 * If we have a space as the first character, break
197 * before printing the line's data.
199 if ('\0' == *n->string) {
200 print_otag(h, TAG_P, 0, NULL);
202 } else if (' ' == *n->string && MAN_LINE & n->flags)
203 print_otag(h, TAG_BR, 0, NULL);
205 print_text(h, n->string);
208 * If we're in a literal context, make sure that words
209 * togehter on the same line stay together. This is a
210 * POST-printing call, so we check the NEXT word. Since
211 * -man doesn't have nested macros, we don't need to be
212 * more specific than this.
214 if (MANH_LITERAL & mh->fl &&
216 n->next->line > n->line))
217 print_otag(h, TAG_BR, 0, NULL);
220 PAIR_CLASS_INIT(&tag, "eqn");
221 print_otag(h, TAG_SPAN, 1, &tag);
222 print_text(h, n->eqn->data);
226 * This will take care of initialising all of the table
227 * state data for the first table, then tearing it down
230 print_tbl(h, n->span);
234 * Close out scope of font prior to opening a macro
237 if (HTMLFONT_NONE != h->metac) {
239 h->metac = HTMLFONT_NONE;
243 * Close out the current table, if it's open, and unset
244 * the "meta" table state. This will be reopened on the
245 * next table element.
251 if (mans[n->tok].pre)
252 child = (*mans[n->tok].pre)(m, n, mh, h);
256 if (child && n->child)
257 print_man_nodelist(m, n->child, mh, h);
259 /* This will automatically close out any font scope. */
266 man_root_post(m, n, mh, h);
271 if (mans[n->tok].post)
272 (*mans[n->tok].post)(m, n, mh, h);
279 a2width(const struct man_node *n, struct roffsu *su)
282 if (MAN_TEXT != n->type)
284 if (a2roffsu(n->string, su, SCALE_BU))
293 man_root_pre(MAN_ARGS)
295 struct htmlpair tag[3];
297 char b[BUFSIZ], title[BUFSIZ];
301 (void)strlcat(b, m->vol, BUFSIZ);
303 snprintf(title, BUFSIZ - 1, "%s(%s)", m->title, m->msec);
305 PAIR_SUMMARY_INIT(&tag[0], "Document Header");
306 PAIR_CLASS_INIT(&tag[1], "head");
307 if (NULL == h->style) {
308 PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
309 t = print_otag(h, TAG_TABLE, 3, tag);
310 PAIR_INIT(&tag[0], ATTR_WIDTH, "30%");
311 print_otag(h, TAG_COL, 1, tag);
312 print_otag(h, TAG_COL, 1, tag);
313 print_otag(h, TAG_COL, 1, tag);
315 t = print_otag(h, TAG_TABLE, 2, tag);
317 print_otag(h, TAG_TBODY, 0, NULL);
319 tt = print_otag(h, TAG_TR, 0, NULL);
321 PAIR_CLASS_INIT(&tag[0], "head-ltitle");
322 print_otag(h, TAG_TD, 1, tag);
324 print_text(h, title);
327 PAIR_CLASS_INIT(&tag[0], "head-vol");
328 if (NULL == h->style) {
329 PAIR_INIT(&tag[1], ATTR_ALIGN, "center");
330 print_otag(h, TAG_TD, 2, tag);
332 print_otag(h, TAG_TD, 1, tag);
337 PAIR_CLASS_INIT(&tag[0], "head-rtitle");
338 if (NULL == h->style) {
339 PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
340 print_otag(h, TAG_TD, 2, tag);
342 print_otag(h, TAG_TD, 1, tag);
344 print_text(h, title);
351 man_root_post(MAN_ARGS)
353 struct htmlpair tag[3];
356 PAIR_SUMMARY_INIT(&tag[0], "Document Footer");
357 PAIR_CLASS_INIT(&tag[1], "foot");
358 if (NULL == h->style) {
359 PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
360 t = print_otag(h, TAG_TABLE, 3, tag);
361 PAIR_INIT(&tag[0], ATTR_WIDTH, "50%");
362 print_otag(h, TAG_COL, 1, tag);
363 print_otag(h, TAG_COL, 1, tag);
365 t = print_otag(h, TAG_TABLE, 2, tag);
367 tt = print_otag(h, TAG_TR, 0, NULL);
369 PAIR_CLASS_INIT(&tag[0], "foot-date");
370 print_otag(h, TAG_TD, 1, tag);
372 print_text(h, m->date);
375 PAIR_CLASS_INIT(&tag[0], "foot-os");
376 if (NULL == h->style) {
377 PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
378 print_otag(h, TAG_TD, 2, tag);
380 print_otag(h, TAG_TD, 1, tag);
383 print_text(h, m->source);
396 SCALE_VS_INIT(&su, 1);
398 if (MAN_sp == n->tok) {
400 a2roffsu(n->child->string, &su, SCALE_VS);
404 bufcat_su(h, "height", &su);
405 PAIR_STYLE_INIT(&tag, h);
406 print_otag(h, TAG_DIV, 1, &tag);
408 /* So the div isn't empty: */
409 print_text(h, "\\~");
421 if (MAN_BLOCK == n->type) {
422 PAIR_CLASS_INIT(&tag, "section");
423 print_otag(h, TAG_DIV, 1, &tag);
425 } else if (MAN_BODY == n->type)
428 print_otag(h, TAG_H1, 0, NULL);
435 man_alt_pre(MAN_ARGS)
437 const struct man_node *nn;
442 for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
446 fp = i % 2 ? TAG_I : TAG_B;
449 fp = i % 2 ? TAG_B : TAG_I;
452 fp = i % 2 ? TAG_I : TAG_MAX;
455 fp = i % 2 ? TAG_MAX : TAG_I;
458 fp = i % 2 ? TAG_MAX : TAG_B;
461 fp = i % 2 ? TAG_B : TAG_MAX;
469 h->flags |= HTML_NOSPACE;
472 t = print_otag(h, fp, 0, NULL);
474 print_man_node(m, nn, mh, h);
489 print_otag(h, TAG_SMALL, 0, NULL);
490 if (MAN_SB == n->tok)
491 print_otag(h, TAG_B, 0, NULL);
502 if (MAN_BLOCK == n->type) {
503 PAIR_CLASS_INIT(&tag, "subsection");
504 print_otag(h, TAG_DIV, 1, &tag);
506 } else if (MAN_BODY == n->type)
509 print_otag(h, TAG_H2, 0, NULL);
519 if (MAN_HEAD == n->type)
521 else if (MAN_BODY == n->type && n->prev)
522 print_otag(h, TAG_P, 0, NULL);
534 const struct man_node *nn;
537 * This scattering of 1-BU margins and pads is to make sure that
538 * when text overruns its box, the subsequent text isn't flush
539 * up against it. However, the rest of the right-hand box must
540 * also be adjusted in consideration of this 1-BU space.
543 if (MAN_BODY == n->type) {
544 print_otag(h, TAG_TD, 0, NULL);
548 nn = MAN_BLOCK == n->type ?
549 n->head->child : n->parent->head->child;
551 SCALE_HS_INIT(&su, INDENT);
553 /* Width is the second token. */
555 if (MAN_IP == n->tok && NULL != nn)
556 if (NULL != (nn = nn->next))
559 /* Width is the first token. */
561 if (MAN_TP == n->tok && NULL != nn) {
562 /* Skip past non-text children. */
563 while (nn && MAN_TEXT != nn->type)
569 if (MAN_BLOCK == n->type) {
570 print_otag(h, TAG_P, 0, NULL);
571 print_otag(h, TAG_TABLE, 0, NULL);
572 bufcat_su(h, "width", &su);
573 PAIR_STYLE_INIT(&tag, h);
574 print_otag(h, TAG_COL, 1, &tag);
575 print_otag(h, TAG_COL, 0, NULL);
576 print_otag(h, TAG_TBODY, 0, NULL);
577 print_otag(h, TAG_TR, 0, NULL);
581 print_otag(h, TAG_TD, 0, NULL);
583 /* For IP, only print the first header element. */
585 if (MAN_IP == n->tok && n->child)
586 print_man_node(m, n->child, mh, h);
588 /* For TP, only print next-line header elements. */
590 if (MAN_TP == n->tok)
591 for (nn = n->child; nn; nn = nn->next)
592 if (nn->line > n->line)
593 print_man_node(m, nn, mh, h);
605 const struct man_node *np;
607 np = MAN_BLOCK == n->type ?
609 n->parent->head->child;
611 if (NULL == np || ! a2width(np, &su))
612 SCALE_HS_INIT(&su, INDENT);
614 if (MAN_HEAD == n->type) {
615 print_otag(h, TAG_TD, 0, NULL);
617 } else if (MAN_BLOCK == n->type) {
618 print_otag(h, TAG_P, 0, NULL);
619 print_otag(h, TAG_TABLE, 0, NULL);
620 bufcat_su(h, "width", &su);
621 PAIR_STYLE_INIT(&tag, h);
622 print_otag(h, TAG_COL, 1, &tag);
623 print_otag(h, TAG_COL, 0, NULL);
624 print_otag(h, TAG_TBODY, 0, NULL);
625 print_otag(h, TAG_TR, 0, NULL);
629 su.scale = -su.scale;
630 bufcat_su(h, "text-indent", &su);
631 PAIR_STYLE_INIT(&tag, h);
632 print_otag(h, TAG_TD, 1, &tag);
642 print_otag(h, TAG_B, 0, NULL);
652 print_otag(h, TAG_I, 0, NULL);
659 man_literal_pre(MAN_ARGS)
662 if (MAN_nf == n->tok) {
663 print_otag(h, TAG_BR, 0, NULL);
664 mh->fl |= MANH_LITERAL;
666 mh->fl &= ~MANH_LITERAL;
677 print_otag(h, TAG_BR, 0, NULL);
684 man_ign_pre(MAN_ARGS)
698 if (MAN_HEAD == n->type)
700 else if (MAN_BODY == n->type)
703 SCALE_HS_INIT(&su, INDENT);
705 a2width(n->head->child, &su);
707 bufcat_su(h, "margin-left", &su);
708 PAIR_STYLE_INIT(&tag, h);
709 print_otag(h, TAG_DIV, 1, &tag);