]>
git.cameronkatri.com Git - mandoc.git/blob - man_html.c
1 /* $Id: man_html.c,v 1.21 2009/11/15 06:45:31 kristaps Exp $ */
3 * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
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.
17 #include <sys/types.h>
30 /* TODO: preserve ident widths. */
31 /* FIXME: have PD set the default vspace width. */
36 #define MAN_ARGS const struct man_meta *m, \
37 const struct man_node *n, \
42 int (*post
)(MAN_ARGS
);
45 static void print_man(MAN_ARGS
);
46 static void print_man_head(MAN_ARGS
);
47 static void print_man_nodelist(MAN_ARGS
);
48 static void print_man_node(MAN_ARGS
);
50 static int a2width(const struct man_node
*,
53 static int man_alt_pre(MAN_ARGS
);
54 static int man_br_pre(MAN_ARGS
);
55 static int man_ign_pre(MAN_ARGS
);
56 static void man_root_post(MAN_ARGS
);
57 static int man_root_pre(MAN_ARGS
);
58 static int man_B_pre(MAN_ARGS
);
59 static int man_HP_pre(MAN_ARGS
);
60 static int man_I_pre(MAN_ARGS
);
61 static int man_IP_pre(MAN_ARGS
);
62 static int man_PP_pre(MAN_ARGS
);
63 static int man_RS_pre(MAN_ARGS
);
64 static int man_SB_pre(MAN_ARGS
);
65 static int man_SH_pre(MAN_ARGS
);
66 static int man_SM_pre(MAN_ARGS
);
67 static int man_SS_pre(MAN_ARGS
);
70 extern size_t strlcpy(char *, const char *, size_t);
71 extern size_t strlcat(char *, const char *, size_t);
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_SB_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 { NULL
, NULL
}, /* na */
97 { NULL
, NULL
}, /* i */
98 { man_br_pre
, NULL
}, /* sp */
99 { NULL
, NULL
}, /* nf */
100 { NULL
, NULL
}, /* fi */
101 { NULL
, NULL
}, /* r */
102 { NULL
, NULL
}, /* RE */
103 { man_RS_pre
, NULL
}, /* RS */
104 { man_ign_pre
, NULL
}, /* DT */
105 { man_ign_pre
, NULL
}, /* UC */
106 { man_ign_pre
, NULL
}, /* PD */
111 html_man(void *arg
, const struct man
*m
)
116 h
= (struct html
*)arg
;
118 print_gen_doctype(h
);
120 t
= print_otag(h
, TAG_HTML
, 0, NULL
);
121 print_man(man_meta(m
), man_node(m
), h
);
134 t
= print_otag(h
, TAG_HEAD
, 0, NULL
);
136 print_man_head(m
, n
, h
);
138 t
= print_otag(h
, TAG_BODY
, 0, NULL
);
140 tag
.key
= ATTR_CLASS
;
142 print_otag(h
, TAG_DIV
, 1, &tag
);
144 print_man_nodelist(m
, n
, h
);
152 print_man_head(MAN_ARGS
)
157 buffmt(h
, "%s(%d)", m
->title
, m
->msec
);
159 print_otag(h
, TAG_TITLE
, 0, NULL
);
160 print_text(h
, h
->buf
);
165 print_man_nodelist(MAN_ARGS
)
168 print_man_node(m
, n
, h
);
170 print_man_nodelist(m
, n
->next
, h
);
175 print_man_node(MAN_ARGS
)
187 child
= man_root_pre(m
, n
, h
);
190 print_text(h
, n
->string
);
194 * Close out scope of font prior to opening a macro
195 * scope. Assert that the metafont is on the top of the
196 * stack (it's never nested).
199 assert(h
->metaf
== t
);
200 print_tagq(h
, h
->metaf
);
201 assert(NULL
== h
->metaf
);
204 if (mans
[n
->tok
].pre
)
205 child
= (*mans
[n
->tok
].pre
)(m
, n
, h
);
209 if (child
&& n
->child
)
210 print_man_nodelist(m
, n
->child
, h
);
218 man_root_post(m
, n
, h
);
223 if (mans
[n
->tok
].post
)
224 (*mans
[n
->tok
].post
)(m
, n
, h
);
231 a2width(const struct man_node
*n
, struct roffsu
*su
)
234 if (MAN_TEXT
!= n
->type
)
236 if (a2roffsu(n
->string
, su
, SCALE_BU
))
245 man_root_pre(MAN_ARGS
)
247 struct htmlpair tag
[3];
249 char b
[BUFSIZ
], title
[BUFSIZ
];
253 (void)strlcat(b
, m
->vol
, BUFSIZ
);
255 (void)snprintf(title
, BUFSIZ
- 1,
256 "%s(%d)", m
->title
, m
->msec
);
258 PAIR_CLASS_INIT(&tag
[0], "header");
259 bufcat_style(h
, "width", "100%");
260 PAIR_STYLE_INIT(&tag
[1], h
);
261 PAIR_SUMMARY_INIT(&tag
[2], "header");
263 t
= print_otag(h
, TAG_TABLE
, 3, tag
);
264 tt
= print_otag(h
, TAG_TR
, 0, NULL
);
267 bufcat_style(h
, "width", "10%");
268 PAIR_STYLE_INIT(&tag
[0], h
);
269 print_otag(h
, TAG_TD
, 1, tag
);
270 print_text(h
, title
);
274 bufcat_style(h
, "width", "80%");
275 bufcat_style(h
, "white-space", "nowrap");
276 bufcat_style(h
, "text-align", "center");
277 PAIR_STYLE_INIT(&tag
[0], h
);
278 print_otag(h
, TAG_TD
, 1, tag
);
283 bufcat_style(h
, "width", "10%");
284 bufcat_style(h
, "text-align", "right");
285 PAIR_STYLE_INIT(&tag
[0], h
);
286 print_otag(h
, TAG_TD
, 1, tag
);
287 print_text(h
, title
);
295 man_root_post(MAN_ARGS
)
297 struct htmlpair tag
[3];
301 time2a(m
->date
, b
, DATESIZ
);
303 PAIR_CLASS_INIT(&tag
[0], "footer");
304 bufcat_style(h
, "width", "100%");
305 PAIR_STYLE_INIT(&tag
[1], h
);
306 PAIR_SUMMARY_INIT(&tag
[2], "footer");
308 t
= print_otag(h
, TAG_TABLE
, 3, tag
);
309 tt
= print_otag(h
, TAG_TR
, 0, NULL
);
312 bufcat_style(h
, "width", "50%");
313 PAIR_STYLE_INIT(&tag
[0], h
);
314 print_otag(h
, TAG_TD
, 1, tag
);
319 bufcat_style(h
, "width", "50%");
320 bufcat_style(h
, "text-align", "right");
321 PAIR_STYLE_INIT(&tag
[0], h
);
322 print_otag(h
, TAG_TD
, 1, tag
);
324 print_text(h
, m
->source
);
337 SCALE_VS_INIT(&su
, 1);
339 if (MAN_sp
== n
->tok
&& n
->child
)
340 a2roffsu(n
->child
->string
, &su
, SCALE_VS
);
341 else if (MAN_br
== n
->tok
)
344 bufcat_su(h
, "height", &su
);
345 PAIR_STYLE_INIT(&tag
, h
);
346 print_otag(h
, TAG_DIV
, 1, &tag
);
347 /* So the div isn't empty: */
348 print_text(h
, "\\~");
358 struct htmlpair tag
[2];
361 if (MAN_BODY
== n
->type
) {
362 SCALE_HS_INIT(&su
, INDENT
);
363 bufcat_su(h
, "margin-left", &su
);
364 PAIR_CLASS_INIT(&tag
[0], "sec-body");
365 PAIR_STYLE_INIT(&tag
[1], h
);
366 print_otag(h
, TAG_DIV
, 2, tag
);
368 } else if (MAN_BLOCK
== n
->type
) {
369 PAIR_CLASS_INIT(&tag
[0], "sec-block");
370 if (n
->prev
&& MAN_SH
== n
->prev
->tok
)
371 if (NULL
== n
->prev
->body
->child
) {
372 print_otag(h
, TAG_DIV
, 1, tag
);
376 SCALE_VS_INIT(&su
, 1);
377 bufcat_su(h
, "margin-top", &su
);
379 bufcat_su(h
, "margin-bottom", &su
);
380 PAIR_STYLE_INIT(&tag
[1], h
);
381 print_otag(h
, TAG_DIV
, 2, tag
);
385 PAIR_CLASS_INIT(&tag
[0], "sec-head");
386 print_otag(h
, TAG_DIV
, 1, tag
);
393 man_alt_pre(MAN_ARGS
)
395 const struct man_node
*nn
;
398 struct htmlpair tagi
, tagb
, tagr
, *tagp
;
400 PAIR_CLASS_INIT(&tagi
, "italic");
401 PAIR_CLASS_INIT(&tagb
, "bold");
402 PAIR_CLASS_INIT(&tagr
, "roman");
404 for (i
= 0, nn
= n
->child
; nn
; nn
= nn
->next
, i
++) {
407 tagp
= i
% 2 ? &tagi
: &tagb
;
410 tagp
= i
% 2 ? &tagb
: &tagi
;
413 tagp
= i
% 2 ? &tagi
: &tagr
;
416 tagp
= i
% 2 ? &tagr
: &tagi
;
419 tagp
= i
% 2 ? &tagr
: &tagb
;
422 tagp
= i
% 2 ? &tagb
: &tagr
;
430 h
->flags
|= HTML_NOSPACE
;
432 t
= print_otag(h
, TAG_SPAN
, 1, tagp
);
433 print_man_node(m
, nn
, h
);
447 PAIR_CLASS_INIT(&tag
, "small bold");
448 print_otag(h
, TAG_SPAN
, 1, &tag
);
459 PAIR_CLASS_INIT(&tag
, "small");
460 print_otag(h
, TAG_SPAN
, 1, &tag
);
469 struct htmlpair tag
[3];
472 SCALE_VS_INIT(&su
, 1);
474 if (MAN_BODY
== n
->type
) {
475 PAIR_CLASS_INIT(&tag
[0], "ssec-body");
476 if (n
->parent
->next
&& n
->child
) {
477 bufcat_su(h
, "margin-bottom", &su
);
478 PAIR_STYLE_INIT(&tag
[1], h
);
479 print_otag(h
, TAG_DIV
, 2, tag
);
483 print_otag(h
, TAG_DIV
, 1, tag
);
485 } else if (MAN_BLOCK
== n
->type
) {
486 PAIR_CLASS_INIT(&tag
[0], "ssec-block");
487 if (n
->prev
&& MAN_SS
== n
->prev
->tok
)
488 if (n
->prev
->body
->child
) {
489 bufcat_su(h
, "margin-top", &su
);
490 PAIR_STYLE_INIT(&tag
[1], h
);
491 print_otag(h
, TAG_DIV
, 2, tag
);
495 print_otag(h
, TAG_DIV
, 1, tag
);
499 SCALE_HS_INIT(&su
, INDENT
- HALFINDENT
);
500 bufcat_su(h
, "margin-left", &su
);
501 PAIR_CLASS_INIT(&tag
[0], "ssec-head");
502 PAIR_STYLE_INIT(&tag
[1], h
);
503 print_otag(h
, TAG_DIV
, 2, tag
);
516 if (MAN_BLOCK
!= n
->type
)
521 if (MAN_ROOT
== n
->parent
->tok
) {
522 SCALE_HS_INIT(&su
, INDENT
);
523 bufcat_su(h
, "margin-left", &su
);
526 if (n
->next
&& n
->next
->child
) {
527 SCALE_VS_INIT(&su
, 1);
528 bufcat_su(h
, "margin-bottom", &su
);
532 PAIR_STYLE_INIT(&tag
, h
);
533 print_otag(h
, TAG_DIV
, i
? 1 : 0, &tag
);
544 const struct man_node
*nn
;
548 * This scattering of 1-BU margins and pads is to make sure that
549 * when text overruns its box, the subsequent text isn't flush
550 * up against it. However, the rest of the right-hand box must
551 * also be adjusted in consideration of this 1-BU space.
554 if (MAN_BODY
== n
->type
) {
555 SCALE_HS_INIT(&su
, INDENT
);
556 bufcat_su(h
, "margin-left", &su
);
557 PAIR_STYLE_INIT(&tag
, h
);
558 print_otag(h
, TAG_DIV
, 1, &tag
);
562 nn
= MAN_BLOCK
== n
->type
?
563 n
->head
->child
: n
->parent
->head
->child
;
565 SCALE_HS_INIT(&su
, INDENT
);
568 if (MAN_IP
== n
->tok
&& NULL
!= nn
)
569 if (NULL
!= (nn
= nn
->next
)) {
570 for ( ; nn
->next
; nn
= nn
->next
)
572 width
= a2width(nn
, &su
);
575 if (MAN_TP
== n
->tok
&& NULL
!= nn
)
576 width
= a2width(nn
, &su
);
578 if (MAN_BLOCK
== n
->type
) {
579 bufcat_su(h
, "margin-left", &su
);
580 SCALE_VS_INIT(&su
, 1);
581 bufcat_su(h
, "margin-top", &su
);
582 bufcat_style(h
, "clear", "both");
583 PAIR_STYLE_INIT(&tag
, h
);
584 print_otag(h
, TAG_DIV
, 1, &tag
);
588 bufcat_su(h
, "min-width", &su
);
590 bufcat_su(h
, "margin-left", &su
);
591 SCALE_HS_INIT(&su
, 1);
592 bufcat_su(h
, "margin-right", &su
);
593 bufcat_style(h
, "clear", "left");
595 if (n
->next
&& n
->next
->child
)
596 bufcat_style(h
, "float", "left");
598 PAIR_STYLE_INIT(&tag
, h
);
599 print_otag(h
, TAG_DIV
, 1, &tag
);
601 /* With a length string, manually omit the last child. */
606 if (MAN_IP
== n
->tok
)
607 for (nn
= n
->child
; nn
->next
; nn
= nn
->next
)
608 print_man_node(m
, nn
, h
);
609 if (MAN_TP
== n
->tok
)
610 for (nn
= n
->child
->next
; nn
; nn
= nn
->next
)
611 print_man_node(m
, nn
, h
);
621 const struct man_node
*nn
;
625 if (MAN_HEAD
== n
->type
)
628 nn
= MAN_BLOCK
== n
->type
?
629 n
->head
->child
: n
->parent
->head
->child
;
631 SCALE_HS_INIT(&su
, INDENT
);
634 (void)a2width(nn
, &su
);
636 if (MAN_BLOCK
== n
->type
) {
637 bufcat_su(h
, "margin-left", &su
);
638 SCALE_VS_INIT(&su
, 1);
639 bufcat_su(h
, "margin-top", &su
);
640 bufcat_style(h
, "clear", "both");
641 PAIR_STYLE_INIT(&tag
, h
);
642 print_otag(h
, TAG_DIV
, 1, &tag
);
646 bufcat_su(h
, "margin-left", &su
);
648 bufcat_su(h
, "text-indent", &su
);
650 PAIR_STYLE_INIT(&tag
, h
);
651 print_otag(h
, TAG_DIV
, 1, &tag
);
662 PAIR_CLASS_INIT(&tag
, "bold");
663 print_otag(h
, TAG_SPAN
, 1, &tag
);
674 PAIR_CLASS_INIT(&tag
, "italic");
675 print_otag(h
, TAG_SPAN
, 1, &tag
);
682 man_ign_pre(MAN_ARGS
)
696 if (MAN_HEAD
== n
->type
)
698 else if (MAN_BODY
== n
->type
)
701 SCALE_HS_INIT(&su
, INDENT
);
702 bufcat_su(h
, "margin-left", &su
);
704 if (n
->head
->child
) {
705 SCALE_VS_INIT(&su
, 1);
706 a2width(n
->head
->child
, &su
);
707 bufcat_su(h
, "margin-top", &su
);
710 PAIR_STYLE_INIT(&tag
, h
);
711 print_otag(h
, TAG_DIV
, 1, &tag
);