1 /* $Id: man_html.c,v 1.96 2014/08/01 19:25:52 schwarze Exp $ */
3 * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2013, 2014 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 AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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.
22 #include <sys/types.h>
31 #include "mandoc_aux.h"
37 /* TODO: preserve ident widths. */
38 /* FIXME: have PD set the default vspace width. */
42 #define MAN_ARGS const struct man_meta *man, \
43 const struct man_node *n, \
49 #define MANH_LITERAL (1 << 0) /* literal context */
54 int (*post)(MAN_ARGS);
57 static void print_bvspace(struct html *,
58 const struct man_node *);
59 static void print_man(MAN_ARGS);
60 static void print_man_head(MAN_ARGS);
61 static void print_man_nodelist(MAN_ARGS);
62 static void print_man_node(MAN_ARGS);
63 static int a2width(const struct man_node *,
65 static int man_B_pre(MAN_ARGS);
66 static int man_HP_pre(MAN_ARGS);
67 static int man_IP_pre(MAN_ARGS);
68 static int man_I_pre(MAN_ARGS);
69 static int man_OP_pre(MAN_ARGS);
70 static int man_PP_pre(MAN_ARGS);
71 static int man_RS_pre(MAN_ARGS);
72 static int man_SH_pre(MAN_ARGS);
73 static int man_SM_pre(MAN_ARGS);
74 static int man_SS_pre(MAN_ARGS);
75 static int man_UR_pre(MAN_ARGS);
76 static int man_alt_pre(MAN_ARGS);
77 static int man_br_pre(MAN_ARGS);
78 static int man_ign_pre(MAN_ARGS);
79 static int man_in_pre(MAN_ARGS);
80 static int man_literal_pre(MAN_ARGS);
81 static void man_root_post(MAN_ARGS);
82 static void man_root_pre(MAN_ARGS);
84 static const struct htmlman mans[MAN_MAX] = {
85 { man_br_pre, NULL }, /* br */
86 { NULL, NULL }, /* TH */
87 { man_SH_pre, NULL }, /* SH */
88 { man_SS_pre, NULL }, /* SS */
89 { man_IP_pre, NULL }, /* TP */
90 { man_PP_pre, NULL }, /* LP */
91 { man_PP_pre, NULL }, /* PP */
92 { man_PP_pre, NULL }, /* P */
93 { man_IP_pre, NULL }, /* IP */
94 { man_HP_pre, NULL }, /* HP */
95 { man_SM_pre, NULL }, /* SM */
96 { man_SM_pre, NULL }, /* SB */
97 { man_alt_pre, NULL }, /* BI */
98 { man_alt_pre, NULL }, /* IB */
99 { man_alt_pre, NULL }, /* BR */
100 { man_alt_pre, NULL }, /* RB */
101 { NULL, NULL }, /* R */
102 { man_B_pre, NULL }, /* B */
103 { man_I_pre, NULL }, /* I */
104 { man_alt_pre, NULL }, /* IR */
105 { man_alt_pre, NULL }, /* RI */
106 { man_ign_pre, NULL }, /* na */
107 { man_br_pre, NULL }, /* sp */
108 { man_literal_pre, NULL }, /* nf */
109 { man_literal_pre, NULL }, /* fi */
110 { NULL, NULL }, /* RE */
111 { man_RS_pre, NULL }, /* RS */
112 { man_ign_pre, NULL }, /* DT */
113 { man_ign_pre, NULL }, /* UC */
114 { man_ign_pre, NULL }, /* PD */
115 { man_ign_pre, NULL }, /* AT */
116 { man_in_pre, NULL }, /* in */
117 { man_ign_pre, NULL }, /* ft */
118 { man_OP_pre, NULL }, /* OP */
119 { man_literal_pre, NULL }, /* EX */
120 { man_literal_pre, NULL }, /* EE */
121 { man_UR_pre, NULL }, /* UR */
122 { NULL, NULL }, /* UE */
123 { man_ign_pre, NULL }, /* ll */
128 * Printing leading vertical space before a block.
129 * This is used for the paragraph macros.
130 * The rules are pretty simple, since there's very little nesting going
131 * on here. Basically, if we're the first within another block (SS/SH),
132 * then don't emit vertical space. If we are (RS), then do. If not the
136 print_bvspace(struct html *h, const struct man_node *n)
139 if (n->body && n->body->child)
140 if (MAN_TBL == n->body->child->type)
143 if (MAN_ROOT == n->parent->type || MAN_RS != n->parent->tok)
147 print_otag(h, TAG_P, 0, NULL);
151 html_man(void *arg, const struct man *man)
155 memset(&mh, 0, sizeof(struct mhtml));
156 print_man(man_meta(man), man_node(man), &mh, (struct html *)arg);
166 PAIR_CLASS_INIT(&tag, "mandoc");
168 if ( ! (HTML_FRAGMENT & h->oflags)) {
170 t = print_otag(h, TAG_HTML, 0, NULL);
171 tt = print_otag(h, TAG_HEAD, 0, NULL);
172 print_man_head(man, n, mh, h);
174 print_otag(h, TAG_BODY, 0, NULL);
175 print_otag(h, TAG_DIV, 1, &tag);
177 t = print_otag(h, TAG_DIV, 1, &tag);
179 print_man_nodelist(man, n, mh, h);
184 print_man_head(MAN_ARGS)
190 bufcat_fmt(h, "%s(%s)", man->title, man->msec);
191 print_otag(h, TAG_TITLE, 0, NULL);
192 print_text(h, h->buf);
196 print_man_nodelist(MAN_ARGS)
199 print_man_node(man, n, mh, h);
201 print_man_nodelist(man, n->next, mh, h);
205 print_man_node(MAN_ARGS)
215 man_root_pre(man, n, mh, h);
219 * If we have a blank line, output a vertical space.
220 * If we have a space as the first character, break
221 * before printing the line's data.
223 if ('\0' == *n->string) {
224 print_otag(h, TAG_P, 0, NULL);
228 if (' ' == *n->string && MAN_LINE & n->flags)
229 print_otag(h, TAG_BR, 0, NULL);
230 else if (MANH_LITERAL & mh->fl && n->prev)
231 print_otag(h, TAG_BR, 0, NULL);
233 print_text(h, n->string);
236 print_eqn(h, n->eqn);
240 * This will take care of initialising all of the table
241 * state data for the first table, then tearing it down
244 print_tbl(h, n->span);
248 * Close out scope of font prior to opening a macro
251 if (HTMLFONT_NONE != h->metac) {
253 h->metac = HTMLFONT_NONE;
257 * Close out the current table, if it's open, and unset
258 * the "meta" table state. This will be reopened on the
259 * next table element.
265 if (mans[n->tok].pre)
266 child = (*mans[n->tok].pre)(man, n, mh, h);
270 if (child && n->child)
271 print_man_nodelist(man, n->child, mh, h);
273 /* This will automatically close out any font scope. */
278 man_root_post(man, n, mh, h);
283 if (mans[n->tok].post)
284 (*mans[n->tok].post)(man, n, mh, h);
290 a2width(const struct man_node *n, struct roffsu *su)
293 if (MAN_TEXT != n->type)
295 if (a2roffsu(n->string, su, SCALE_BU))
302 man_root_pre(MAN_ARGS)
304 struct htmlpair tag[3];
310 mandoc_asprintf(&title, "%s(%s)", man->title, man->msec);
312 PAIR_SUMMARY_INIT(&tag[0], "Document Header");
313 PAIR_CLASS_INIT(&tag[1], "head");
314 PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
315 t = print_otag(h, TAG_TABLE, 3, tag);
316 PAIR_INIT(&tag[0], ATTR_WIDTH, "30%");
317 print_otag(h, TAG_COL, 1, tag);
318 print_otag(h, TAG_COL, 1, tag);
319 print_otag(h, TAG_COL, 1, tag);
321 print_otag(h, TAG_TBODY, 0, NULL);
323 tt = print_otag(h, TAG_TR, 0, NULL);
325 PAIR_CLASS_INIT(&tag[0], "head-ltitle");
326 print_otag(h, TAG_TD, 1, tag);
327 print_text(h, title);
330 PAIR_CLASS_INIT(&tag[0], "head-vol");
331 PAIR_INIT(&tag[1], ATTR_ALIGN, "center");
332 print_otag(h, TAG_TD, 2, tag);
333 if (NULL != man->vol)
334 print_text(h, man->vol);
337 PAIR_CLASS_INIT(&tag[0], "head-rtitle");
338 PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
339 print_otag(h, TAG_TD, 2, tag);
340 print_text(h, title);
346 man_root_post(MAN_ARGS)
348 struct htmlpair tag[3];
351 PAIR_SUMMARY_INIT(&tag[0], "Document Footer");
352 PAIR_CLASS_INIT(&tag[1], "foot");
353 PAIR_INIT(&tag[2], ATTR_WIDTH, "100%");
354 t = print_otag(h, TAG_TABLE, 3, tag);
355 PAIR_INIT(&tag[0], ATTR_WIDTH, "50%");
356 print_otag(h, TAG_COL, 1, tag);
357 print_otag(h, TAG_COL, 1, tag);
359 tt = print_otag(h, TAG_TR, 0, NULL);
361 PAIR_CLASS_INIT(&tag[0], "foot-date");
362 print_otag(h, TAG_TD, 1, tag);
365 print_text(h, man->date);
368 PAIR_CLASS_INIT(&tag[0], "foot-os");
369 PAIR_INIT(&tag[1], ATTR_ALIGN, "right");
370 print_otag(h, TAG_TD, 2, tag);
373 print_text(h, man->source);
384 SCALE_VS_INIT(&su, 1);
386 if (MAN_sp == n->tok) {
387 if (NULL != (n = n->child))
388 if ( ! a2roffsu(n->string, &su, SCALE_VS))
389 SCALE_VS_INIT(&su, atoi(n->string));
394 bufcat_su(h, "height", &su);
395 PAIR_STYLE_INIT(&tag, h);
396 print_otag(h, TAG_DIV, 1, &tag);
398 /* So the div isn't empty: */
399 print_text(h, "\\~");
409 if (MAN_BLOCK == n->type) {
410 mh->fl &= ~MANH_LITERAL;
411 PAIR_CLASS_INIT(&tag, "section");
412 print_otag(h, TAG_DIV, 1, &tag);
414 } else if (MAN_BODY == n->type)
417 print_otag(h, TAG_H1, 0, NULL);
422 man_alt_pre(MAN_ARGS)
424 const struct man_node *nn;
429 if ((savelit = mh->fl & MANH_LITERAL))
430 print_otag(h, TAG_BR, 0, NULL);
432 mh->fl &= ~MANH_LITERAL;
434 for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
438 fp = i % 2 ? TAG_I : TAG_B;
441 fp = i % 2 ? TAG_B : TAG_I;
444 fp = i % 2 ? TAG_I : TAG_MAX;
447 fp = i % 2 ? TAG_MAX : TAG_I;
450 fp = i % 2 ? TAG_MAX : TAG_B;
453 fp = i % 2 ? TAG_B : TAG_MAX;
461 h->flags |= HTML_NOSPACE;
464 t = print_otag(h, fp, 0, NULL);
466 print_man_node(man, nn, mh, h);
473 mh->fl |= MANH_LITERAL;
482 print_otag(h, TAG_SMALL, 0, NULL);
483 if (MAN_SB == n->tok)
484 print_otag(h, TAG_B, 0, NULL);
493 if (MAN_BLOCK == n->type) {
494 mh->fl &= ~MANH_LITERAL;
495 PAIR_CLASS_INIT(&tag, "subsection");
496 print_otag(h, TAG_DIV, 1, &tag);
498 } else if (MAN_BODY == n->type)
501 print_otag(h, TAG_H2, 0, NULL);
509 if (MAN_HEAD == n->type)
511 else if (MAN_BLOCK == n->type)
520 const struct man_node *nn;
522 if (MAN_BODY == n->type) {
523 print_otag(h, TAG_DD, 0, NULL);
525 } else if (MAN_HEAD != n->type) {
526 print_otag(h, TAG_DL, 0, NULL);
530 /* FIXME: width specification. */
532 print_otag(h, TAG_DT, 0, NULL);
534 /* For IP, only print the first header element. */
536 if (MAN_IP == n->tok && n->child)
537 print_man_node(man, n->child, mh, h);
539 /* For TP, only print next-line header elements. */
541 if (MAN_TP == n->tok) {
543 while (NULL != nn && 0 == (MAN_LINE & nn->flags))
546 print_man_node(man, nn, mh, h);
559 const struct man_node *np;
561 if (MAN_HEAD == n->type)
563 else if (MAN_BLOCK != n->type)
568 if (NULL == np || ! a2width(np, &su))
569 SCALE_HS_INIT(&su, INDENT);
574 bufcat_su(h, "margin-left", &su);
575 su.scale = -su.scale;
576 bufcat_su(h, "text-indent", &su);
577 PAIR_STYLE_INIT(&tag, h);
578 print_otag(h, TAG_P, 1, &tag);
589 h->flags |= HTML_NOSPACE;
590 PAIR_CLASS_INIT(&tag, "opt");
591 tt = print_otag(h, TAG_SPAN, 1, &tag);
593 if (NULL != (n = n->child)) {
594 print_otag(h, TAG_B, 0, NULL);
595 print_text(h, n->string);
600 if (NULL != n && NULL != n->next) {
601 print_otag(h, TAG_I, 0, NULL);
602 print_text(h, n->next->string);
606 h->flags |= HTML_NOSPACE;
615 print_otag(h, TAG_B, 0, NULL);
623 print_otag(h, TAG_I, 0, NULL);
628 man_literal_pre(MAN_ARGS)
631 if (MAN_fi == n->tok || MAN_EE == n->tok) {
632 print_otag(h, TAG_BR, 0, NULL);
633 mh->fl &= ~MANH_LITERAL;
635 mh->fl |= MANH_LITERAL;
644 print_otag(h, TAG_BR, 0, NULL);
649 man_ign_pre(MAN_ARGS)
661 if (MAN_HEAD == n->type)
663 else if (MAN_BODY == n->type)
666 SCALE_HS_INIT(&su, INDENT);
668 a2width(n->head->child, &su);
671 bufcat_su(h, "margin-left", &su);
672 PAIR_STYLE_INIT(&tag, h);
673 print_otag(h, TAG_DIV, 1, &tag);
680 struct htmlpair tag[2];
683 assert(MAN_HEAD == n->type);
685 assert(MAN_TEXT == n->child->type);
686 PAIR_CLASS_INIT(&tag[0], "link-ext");
687 PAIR_HREF_INIT(&tag[1], n->child->string);
688 print_otag(h, TAG_A, 2, tag);
691 assert(MAN_BODY == n->next->type);
695 print_man_nodelist(man, n->child, mh, h);