1 /* $Id: man_html.c,v 1.133 2017/02/05 18:15:39 schwarze Exp $ */
3 * Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2013, 2014, 2015, 2017 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 /* FIXME: have PD set the default vspace width. */
39 #define MAN_ARGS const struct roff_meta *man, \
40 const struct roff_node *n, \
45 int (*post)(MAN_ARGS);
48 static void print_bvspace(struct html *,
49 const struct roff_node *);
50 static void print_man_head(MAN_ARGS);
51 static void print_man_nodelist(MAN_ARGS);
52 static void print_man_node(MAN_ARGS);
53 static int fillmode(struct html *, int);
54 static int a2width(const struct roff_node *,
56 static int man_B_pre(MAN_ARGS);
57 static int man_HP_pre(MAN_ARGS);
58 static int man_IP_pre(MAN_ARGS);
59 static int man_I_pre(MAN_ARGS);
60 static int man_OP_pre(MAN_ARGS);
61 static int man_PP_pre(MAN_ARGS);
62 static int man_RS_pre(MAN_ARGS);
63 static int man_SH_pre(MAN_ARGS);
64 static int man_SM_pre(MAN_ARGS);
65 static int man_SS_pre(MAN_ARGS);
66 static int man_UR_pre(MAN_ARGS);
67 static int man_alt_pre(MAN_ARGS);
68 static int man_br_pre(MAN_ARGS);
69 static int man_ign_pre(MAN_ARGS);
70 static int man_in_pre(MAN_ARGS);
71 static void man_root_post(MAN_ARGS);
72 static void man_root_pre(MAN_ARGS);
74 static const struct htmlman mans[MAN_MAX] = {
75 { man_br_pre, NULL }, /* br */
76 { NULL, NULL }, /* TH */
77 { man_SH_pre, NULL }, /* SH */
78 { man_SS_pre, NULL }, /* SS */
79 { man_IP_pre, NULL }, /* TP */
80 { man_PP_pre, NULL }, /* LP */
81 { man_PP_pre, NULL }, /* PP */
82 { man_PP_pre, NULL }, /* P */
83 { man_IP_pre, NULL }, /* IP */
84 { man_HP_pre, NULL }, /* HP */
85 { man_SM_pre, NULL }, /* SM */
86 { man_SM_pre, NULL }, /* SB */
87 { man_alt_pre, NULL }, /* BI */
88 { man_alt_pre, NULL }, /* IB */
89 { man_alt_pre, NULL }, /* BR */
90 { man_alt_pre, NULL }, /* RB */
91 { NULL, NULL }, /* R */
92 { man_B_pre, NULL }, /* B */
93 { man_I_pre, NULL }, /* I */
94 { man_alt_pre, NULL }, /* IR */
95 { man_alt_pre, NULL }, /* RI */
96 { man_br_pre, NULL }, /* sp */
97 { NULL, NULL }, /* nf */
98 { NULL, NULL }, /* fi */
99 { NULL, NULL }, /* RE */
100 { man_RS_pre, NULL }, /* RS */
101 { man_ign_pre, NULL }, /* DT */
102 { man_ign_pre, NULL }, /* UC */
103 { man_ign_pre, NULL }, /* PD */
104 { man_ign_pre, NULL }, /* AT */
105 { man_in_pre, NULL }, /* in */
106 { man_ign_pre, NULL }, /* ft */
107 { man_OP_pre, NULL }, /* OP */
108 { NULL, NULL }, /* EX */
109 { NULL, NULL }, /* EE */
110 { man_UR_pre, NULL }, /* UR */
111 { NULL, NULL }, /* UE */
112 { man_ign_pre, NULL }, /* ll */
117 * Printing leading vertical space before a block.
118 * This is used for the paragraph macros.
119 * The rules are pretty simple, since there's very little nesting going
120 * on here. Basically, if we're the first within another block (SS/SH),
121 * then don't emit vertical space. If we are (RS), then do. If not the
125 print_bvspace(struct html *h, const struct roff_node *n)
128 if (n->body && n->body->child)
129 if (n->body->child->type == ROFFT_TBL)
132 if (n->parent->type == ROFFT_ROOT || n->parent->tok != MAN_RS)
140 html_man(void *arg, const struct roff_man *man)
145 h = (struct html *)arg;
147 if ((h->oflags & HTML_FRAGMENT) == 0) {
149 print_otag(h, TAG_HTML, "");
150 t = print_otag(h, TAG_HEAD, "");
151 print_man_head(&man->meta, man->first, h);
153 print_otag(h, TAG_BODY, "");
156 man_root_pre(&man->meta, man->first, h);
157 t = print_otag(h, TAG_DIV, "c", "manual-text");
158 print_man_nodelist(&man->meta, man->first->child, h);
160 man_root_post(&man->meta, man->first, h);
165 print_man_head(MAN_ARGS)
170 mandoc_asprintf(&cp, "%s(%s)", man->title, man->msec);
171 print_otag(h, TAG_TITLE, "");
177 print_man_nodelist(MAN_ARGS)
181 print_man_node(man, n, h);
187 print_man_node(MAN_ARGS)
189 static int want_fillmode = MAN_fi;
190 static int save_fillmode;
196 * Handle fill mode switch requests up front,
197 * they would just cause trouble in the subsequent code.
203 want_fillmode = MAN_nf;
207 want_fillmode = MAN_fi;
208 if (fillmode(h, 0) == MAN_fi)
209 print_otag(h, TAG_BR, "");
215 /* Set up fill mode for the upcoming node. */
220 /* Some block macros suspend or cancel .nf. */
222 case MAN_TP: /* Tagged paragraphs */
223 case MAN_IP: /* temporarily disable .nf */
224 case MAN_HP: /* for the head. */
225 save_fillmode = want_fillmode;
227 case MAN_SH: /* Section headers */
228 case MAN_SS: /* permanently cancel .nf. */
229 want_fillmode = MAN_fi;
231 case MAN_PP: /* These have no head. */
232 case MAN_LP: /* They will simply */
233 case MAN_P: /* reopen .nf in the body. */
247 * Some in-line macros produce tags and/or text
248 * in the handler, so they require fill mode to be
249 * configured up front just like for text nodes.
250 * For the others, keep the traditional approach
251 * of doing the same, for now.
253 fillmode(h, want_fillmode);
256 if (fillmode(h, want_fillmode) == MAN_fi &&
257 want_fillmode == MAN_fi &&
258 n->flags & NODE_LINE && *n->string == ' ')
259 print_otag(h, TAG_BR, "");
260 if (*n->string != '\0')
268 /* Produce output for this node. */
274 print_text(h, n->string);
278 print_eqn(h, n->eqn);
282 * This will take care of initialising all of the table
283 * state data for the first table, then tearing it down
286 print_tbl(h, n->span);
290 * Close out scope of font prior to opening a macro
293 if (HTMLFONT_NONE != h->metac) {
295 h->metac = HTMLFONT_NONE;
299 * Close out the current table, if it's open, and unset
300 * the "meta" table state. This will be reopened on the
301 * next table element.
307 if (mans[n->tok].pre)
308 child = (*mans[n->tok].pre)(man, n, h);
310 /* Some block macros resume .nf in the body. */
311 if (save_fillmode && n->type == ROFFT_BODY)
312 want_fillmode = save_fillmode;
317 if (child && n->child)
318 print_man_nodelist(man, n->child, h);
320 /* This will automatically close out any font scope. */
323 if (fillmode(h, 0) == MAN_nf &&
324 n->next != NULL && n->next->flags & NODE_LINE)
329 * MAN_nf switches to no-fill mode, MAN_fi to fill mode.
330 * Other arguments do not switch.
331 * The old mode is returned.
334 fillmode(struct html *h, int want)
339 for (pre = h->tag; pre != NULL; pre = pre->next)
340 if (pre->tag == TAG_PRE)
343 had = pre == NULL ? MAN_fi : MAN_nf;
345 if (want && want != had) {
347 print_otag(h, TAG_PRE, "");
355 a2width(const struct roff_node *n, struct roffsu *su)
358 if (n->type != ROFFT_TEXT)
360 if (a2roffsu(n->string, su, SCALE_EN))
367 man_root_pre(MAN_ARGS)
374 mandoc_asprintf(&title, "%s(%s)", man->title, man->msec);
376 t = print_otag(h, TAG_TABLE, "c", "head");
377 tt = print_otag(h, TAG_TR, "");
379 print_otag(h, TAG_TD, "c", "head-ltitle");
380 print_text(h, title);
383 print_otag(h, TAG_TD, "c", "head-vol");
384 if (NULL != man->vol)
385 print_text(h, man->vol);
388 print_otag(h, TAG_TD, "c", "head-rtitle");
389 print_text(h, title);
395 man_root_post(MAN_ARGS)
399 t = print_otag(h, TAG_TABLE, "c", "foot");
400 tt = print_otag(h, TAG_TR, "");
402 print_otag(h, TAG_TD, "c", "foot-date");
403 print_text(h, man->date);
406 print_otag(h, TAG_TD, "c", "foot-os");
408 print_text(h, man->os);
418 SCALE_VS_INIT(&su, 1);
420 if (MAN_sp == n->tok) {
421 if (NULL != (n = n->child))
422 if ( ! a2roffsu(n->string, &su, SCALE_VS))
427 print_otag(h, TAG_DIV, "suh", &su);
429 /* So the div isn't empty: */
430 print_text(h, "\\~");
438 if (n->type == ROFFT_HEAD)
439 print_otag(h, TAG_H1, "c", "Sh");
444 man_alt_pre(MAN_ARGS)
446 const struct roff_node *nn;
451 for (i = 0, nn = n->child; nn; nn = nn->next, i++) {
454 fp = i % 2 ? TAG_I : TAG_B;
457 fp = i % 2 ? TAG_B : TAG_I;
460 fp = i % 2 ? TAG_I : TAG_MAX;
463 fp = i % 2 ? TAG_MAX : TAG_I;
466 fp = i % 2 ? TAG_MAX : TAG_B;
469 fp = i % 2 ? TAG_B : TAG_MAX;
476 h->flags |= HTML_NOSPACE;
479 t = print_otag(h, fp, "");
481 print_text(h, nn->string);
492 print_otag(h, TAG_SMALL, "");
493 if (MAN_SB == n->tok)
494 print_otag(h, TAG_B, "");
501 if (n->type == ROFFT_HEAD)
502 print_otag(h, TAG_H2, "c", "Ss");
510 if (n->type == ROFFT_HEAD)
512 else if (n->type == ROFFT_BLOCK)
521 const struct roff_node *nn;
523 if (n->type == ROFFT_BODY) {
524 print_otag(h, TAG_DD, "c", "It-tag");
526 } else if (n->type != ROFFT_HEAD) {
527 print_otag(h, TAG_DL, "c", "Bl-tag");
531 /* FIXME: width specification. */
533 print_otag(h, TAG_DT, "c", "It-tag");
535 /* For IP, only print the first header element. */
537 if (MAN_IP == n->tok && n->child)
538 print_man_node(man, n->child, h);
540 /* For TP, only print next-line header elements. */
542 if (MAN_TP == n->tok) {
544 while (NULL != nn && 0 == (NODE_LINE & nn->flags))
547 print_man_node(man, nn, h);
558 struct roffsu sum, sui;
559 const struct roff_node *np;
561 if (n->type == ROFFT_HEAD)
563 else if (n->type != ROFFT_BLOCK)
568 if (np == NULL || !a2width(np, &sum))
569 SCALE_HS_INIT(&sum, INDENT);
572 sui.scale = -sum.scale;
575 print_otag(h, TAG_DIV, "csului", "Pp", &sum, &sui);
585 h->flags |= HTML_NOSPACE;
586 tt = print_otag(h, TAG_SPAN, "c", "Op");
588 if (NULL != (n = n->child)) {
589 print_otag(h, TAG_B, "");
590 print_text(h, n->string);
595 if (NULL != n && NULL != n->next) {
596 print_otag(h, TAG_I, "");
597 print_text(h, n->next->string);
601 h->flags |= HTML_NOSPACE;
609 print_otag(h, TAG_B, "");
616 print_otag(h, TAG_I, "");
623 print_otag(h, TAG_BR, "");
628 man_ign_pre(MAN_ARGS)
639 if (n->type == ROFFT_HEAD)
641 else if (n->type == ROFFT_BODY)
644 SCALE_HS_INIT(&su, INDENT);
646 a2width(n->head->child, &su);
648 print_otag(h, TAG_DIV, "sul", &su);
656 assert(n->type == ROFFT_HEAD);
657 if (n->child != NULL) {
658 assert(n->child->type == ROFFT_TEXT);
659 print_otag(h, TAG_A, "ch", "Lk", n->child->string);
662 assert(n->next->type == ROFFT_BODY);
663 if (n->next->child != NULL)
666 print_man_nodelist(man, n->child, h);