1 /* $Id: man_html.c,v 1.112 2015/03/03 21:11:34 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 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.
20 #include <sys/types.h>
28 #include "mandoc_aux.h"
34 /* TODO: preserve ident widths. */
35 /* FIXME: have PD set the default vspace width. */
39 #define MAN_ARGS const struct man_meta *man, \
40 const struct man_node *n, \
46 #define MANH_LITERAL (1 << 0) /* literal context */
51 int (*post)(MAN_ARGS);
54 static void print_bvspace(struct html *,
55 const struct man_node *);
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);
60 static int a2width(const struct man_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 man_node *n)
135 if (n->body && n->body->child)
136 if (MAN_TBL == n->body->child->type)
139 if (MAN_ROOT == n->parent->type || MAN_RS != n->parent->tok)
147 html_man(void *arg, const struct man *man)
151 memset(&mh, 0, sizeof(struct mhtml));
152 print_man(man_meta(man), man_node(man), &mh, (struct html *)arg);
162 PAIR_CLASS_INIT(&tag, "mandoc");
164 if ( ! (HTML_FRAGMENT & h->oflags)) {
166 t = print_otag(h, TAG_HTML, 0, NULL);
167 tt = print_otag(h, TAG_HEAD, 0, NULL);
168 print_man_head(man, n, mh, h);
170 print_otag(h, TAG_BODY, 0, NULL);
171 print_otag(h, TAG_DIV, 1, &tag);
173 t = print_otag(h, TAG_DIV, 1, &tag);
175 print_man_nodelist(man, n, mh, h);
180 print_man_head(MAN_ARGS)
186 bufcat_fmt(h, "%s(%s)", man->title, man->msec);
187 print_otag(h, TAG_TITLE, 0, NULL);
188 print_text(h, h->buf);
192 print_man_nodelist(MAN_ARGS)
196 print_man_node(man, n, mh, h);
202 print_man_node(MAN_ARGS)
212 man_root_pre(man, n, mh, h);
215 if ('\0' == *n->string) {
219 if (n->flags & MAN_LINE && (*n->string == ' ' ||
220 (n->prev != NULL && mh->fl & MANH_LITERAL &&
221 ! (h->flags & HTML_NONEWLINE))))
222 print_otag(h, TAG_BR, 0, NULL);
223 print_text(h, n->string);
226 if (n->flags & MAN_LINE)
228 print_eqn(h, n->eqn);
232 * This will take care of initialising all of the table
233 * state data for the first table, then tearing it down
236 print_tbl(h, n->span);
240 * Close out scope of font prior to opening a macro
243 if (HTMLFONT_NONE != h->metac) {
245 h->metac = HTMLFONT_NONE;
249 * Close out the current table, if it's open, and unset
250 * the "meta" table state. This will be reopened on the
251 * next table element.
257 if (mans[n->tok].pre)
258 child = (*mans[n->tok].pre)(man, n, mh, h);
262 if (child && n->child)
263 print_man_nodelist(man, n->child, mh, h);
265 /* This will automatically close out any font scope. */
270 man_root_post(man, n, mh, h);
275 if (mans[n->tok].post)
276 (*mans[n->tok].post)(man, n, mh, h);
282 a2width(const struct man_node *n, struct roffsu *su)
285 if (MAN_TEXT != n->type)
287 if (a2roffsu(n->string, su, SCALE_EN))
294 man_root_pre(MAN_ARGS)
302 mandoc_asprintf(&title, "%s(%s)", man->title, man->msec);
304 PAIR_CLASS_INIT(&tag, "head");
305 t = print_otag(h, TAG_TABLE, 1, &tag);
307 print_otag(h, TAG_TBODY, 0, NULL);
309 tt = print_otag(h, TAG_TR, 0, NULL);
311 PAIR_CLASS_INIT(&tag, "head-ltitle");
312 print_otag(h, TAG_TD, 1, &tag);
313 print_text(h, title);
316 PAIR_CLASS_INIT(&tag, "head-vol");
317 print_otag(h, TAG_TD, 1, &tag);
318 if (NULL != man->vol)
319 print_text(h, man->vol);
322 PAIR_CLASS_INIT(&tag, "head-rtitle");
323 print_otag(h, TAG_TD, 1, &tag);
324 print_text(h, title);
330 man_root_post(MAN_ARGS)
335 PAIR_CLASS_INIT(&tag, "foot");
336 t = print_otag(h, TAG_TABLE, 1, &tag);
338 tt = print_otag(h, TAG_TR, 0, NULL);
340 PAIR_CLASS_INIT(&tag, "foot-date");
341 print_otag(h, TAG_TD, 1, &tag);
344 print_text(h, man->date);
347 PAIR_CLASS_INIT(&tag, "foot-os");
348 print_otag(h, TAG_TD, 1, &tag);
351 print_text(h, man->source);
362 SCALE_VS_INIT(&su, 1);
364 if (MAN_sp == n->tok) {
365 if (NULL != (n = n->child))
366 if ( ! a2roffsu(n->string, &su, SCALE_VS))
372 bufcat_su(h, "height", &su);
373 PAIR_STYLE_INIT(&tag, h);
374 print_otag(h, TAG_DIV, 1, &tag);
376 /* So the div isn't empty: */
377 print_text(h, "\\~");
387 if (MAN_BLOCK == n->type) {
388 mh->fl &= ~MANH_LITERAL;
389 PAIR_CLASS_INIT(&tag, "section");
390 print_otag(h, TAG_DIV, 1, &tag);
392 } else if (MAN_BODY == n->type)
395 print_otag(h, TAG_H1, 0, NULL);
400 man_alt_pre(MAN_ARGS)
402 const struct man_node *nn;
407 if ((savelit = mh->fl & MANH_LITERAL))
408 print_otag(h, TAG_BR, 0, NULL);
410 mh->fl &= ~MANH_LITERAL;
412 for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
416 fp = i % 2 ? TAG_I : TAG_B;
419 fp = i % 2 ? TAG_B : TAG_I;
422 fp = i % 2 ? TAG_I : TAG_MAX;
425 fp = i % 2 ? TAG_MAX : TAG_I;
428 fp = i % 2 ? TAG_MAX : TAG_B;
431 fp = i % 2 ? TAG_B : TAG_MAX;
439 h->flags |= HTML_NOSPACE;
442 t = print_otag(h, fp, 0, NULL);
444 print_man_node(man, nn, mh, h);
451 mh->fl |= MANH_LITERAL;
460 print_otag(h, TAG_SMALL, 0, NULL);
461 if (MAN_SB == n->tok)
462 print_otag(h, TAG_B, 0, NULL);
471 if (MAN_BLOCK == n->type) {
472 mh->fl &= ~MANH_LITERAL;
473 PAIR_CLASS_INIT(&tag, "subsection");
474 print_otag(h, TAG_DIV, 1, &tag);
476 } else if (MAN_BODY == n->type)
479 print_otag(h, TAG_H2, 0, NULL);
487 if (MAN_HEAD == n->type)
489 else if (MAN_BLOCK == n->type)
498 const struct man_node *nn;
500 if (MAN_BODY == n->type) {
501 print_otag(h, TAG_DD, 0, NULL);
503 } else if (MAN_HEAD != n->type) {
504 print_otag(h, TAG_DL, 0, NULL);
508 /* FIXME: width specification. */
510 print_otag(h, TAG_DT, 0, NULL);
512 /* For IP, only print the first header element. */
514 if (MAN_IP == n->tok && n->child)
515 print_man_node(man, n->child, mh, h);
517 /* For TP, only print next-line header elements. */
519 if (MAN_TP == n->tok) {
521 while (NULL != nn && 0 == (MAN_LINE & nn->flags))
524 print_man_node(man, nn, mh, h);
535 struct htmlpair tag[2];
537 const struct man_node *np;
539 if (MAN_HEAD == n->type)
541 else if (MAN_BLOCK != n->type)
546 if (NULL == np || ! a2width(np, &su))
547 SCALE_HS_INIT(&su, INDENT);
552 bufcat_su(h, "margin-left", &su);
553 su.scale = -su.scale;
554 bufcat_su(h, "text-indent", &su);
555 PAIR_STYLE_INIT(&tag[0], h);
556 PAIR_CLASS_INIT(&tag[1], "spacer");
557 print_otag(h, TAG_DIV, 2, tag);
568 h->flags |= HTML_NOSPACE;
569 PAIR_CLASS_INIT(&tag, "opt");
570 tt = print_otag(h, TAG_SPAN, 1, &tag);
572 if (NULL != (n = n->child)) {
573 print_otag(h, TAG_B, 0, NULL);
574 print_text(h, n->string);
579 if (NULL != n && NULL != n->next) {
580 print_otag(h, TAG_I, 0, NULL);
581 print_text(h, n->next->string);
585 h->flags |= HTML_NOSPACE;
594 print_otag(h, TAG_B, 0, NULL);
602 print_otag(h, TAG_I, 0, NULL);
607 man_literal_pre(MAN_ARGS)
610 if (MAN_fi == n->tok || MAN_EE == n->tok) {
611 print_otag(h, TAG_BR, 0, NULL);
612 mh->fl &= ~MANH_LITERAL;
614 mh->fl |= MANH_LITERAL;
623 print_otag(h, TAG_BR, 0, NULL);
628 man_ign_pre(MAN_ARGS)
640 if (MAN_HEAD == n->type)
642 else if (MAN_BODY == n->type)
645 SCALE_HS_INIT(&su, INDENT);
647 a2width(n->head->child, &su);
650 bufcat_su(h, "margin-left", &su);
651 PAIR_STYLE_INIT(&tag, h);
652 print_otag(h, TAG_DIV, 1, &tag);
659 struct htmlpair tag[2];
662 assert(MAN_HEAD == n->type);
664 assert(MAN_TEXT == n->child->type);
665 PAIR_CLASS_INIT(&tag[0], "link-ext");
666 PAIR_HREF_INIT(&tag[1], n->child->string);
667 print_otag(h, TAG_A, 2, tag);
670 assert(MAN_BODY == n->next->type);
674 print_man_nodelist(man, n->child, mh, h);