]>
git.cameronkatri.com Git - mandoc.git/blob - html.c
1 /* $Id: html.c,v 1.171 2014/09/27 10:56:18 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2011, 2012, 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.
20 #include <sys/types.h>
32 #include "mandoc_aux.h"
33 #include "libmandoc.h"
41 #define HTML_CLRLINE (1 << 0)
42 #define HTML_NOSTACK (1 << 1)
43 #define HTML_AUTOCLOSE (1 << 2) /* Tag has auto-closure. */
46 static const struct htmldata htmltags
[TAG_MAX
] = {
47 {"html", HTML_CLRLINE
}, /* TAG_HTML */
48 {"head", HTML_CLRLINE
}, /* TAG_HEAD */
49 {"body", HTML_CLRLINE
}, /* TAG_BODY */
50 {"meta", HTML_CLRLINE
| HTML_NOSTACK
| HTML_AUTOCLOSE
}, /* TAG_META */
51 {"title", HTML_CLRLINE
}, /* TAG_TITLE */
52 {"div", HTML_CLRLINE
}, /* TAG_DIV */
53 {"h1", 0}, /* TAG_H1 */
54 {"h2", 0}, /* TAG_H2 */
55 {"span", 0}, /* TAG_SPAN */
56 {"link", HTML_CLRLINE
| HTML_NOSTACK
| HTML_AUTOCLOSE
}, /* TAG_LINK */
57 {"br", HTML_CLRLINE
| HTML_NOSTACK
| HTML_AUTOCLOSE
}, /* TAG_BR */
59 {"table", HTML_CLRLINE
}, /* TAG_TABLE */
60 {"tbody", HTML_CLRLINE
}, /* TAG_TBODY */
61 {"col", HTML_CLRLINE
| HTML_NOSTACK
| HTML_AUTOCLOSE
}, /* TAG_COL */
62 {"tr", HTML_CLRLINE
}, /* TAG_TR */
63 {"td", HTML_CLRLINE
}, /* TAG_TD */
64 {"li", HTML_CLRLINE
}, /* TAG_LI */
65 {"ul", HTML_CLRLINE
}, /* TAG_UL */
66 {"ol", HTML_CLRLINE
}, /* TAG_OL */
67 {"dl", HTML_CLRLINE
}, /* TAG_DL */
68 {"dt", HTML_CLRLINE
}, /* TAG_DT */
69 {"dd", HTML_CLRLINE
}, /* TAG_DD */
70 {"blockquote", HTML_CLRLINE
}, /* TAG_BLOCKQUOTE */
71 {"pre", HTML_CLRLINE
}, /* TAG_PRE */
72 {"b", 0 }, /* TAG_B */
73 {"i", 0 }, /* TAG_I */
74 {"code", 0 }, /* TAG_CODE */
75 {"small", 0 }, /* TAG_SMALL */
76 {"style", HTML_CLRLINE
}, /* TAG_STYLE */
79 static const char *const htmlattrs
[ATTR_MAX
] = {
80 "name", /* ATTR_NAME */
82 "href", /* ATTR_HREF */
83 "type", /* ATTR_TYPE */
84 "media", /* ATTR_MEDIA */
85 "class", /* ATTR_CLASS */
86 "style", /* ATTR_STYLE */
88 "colspan", /* ATTR_COLSPAN */
89 "charset", /* ATTR_CHARSET */
92 static const char *const roffscales
[SCALE_MAX
] = {
105 static void bufncat(struct html
*, const char *, size_t);
106 static void print_ctag(struct html
*, enum htmltag
);
107 static int print_escape(char);
108 static int print_encode(struct html
*, const char *, int);
109 static void print_metaf(struct html
*, enum mandoc_esc
);
110 static void print_attr(struct html
*, const char *, const char *);
111 static void *ml_alloc(char *, enum htmltype
);
115 ml_alloc(char *outopts
, enum htmltype type
)
123 toks
[2] = "includes";
124 toks
[3] = "fragment";
127 h
= mandoc_calloc(1, sizeof(struct html
));
131 h
->symtab
= mchars_alloc();
133 while (outopts
&& *outopts
)
134 switch (getsubopt(&outopts
, UNCONST(toks
), &v
)) {
142 h
->base_includes
= v
;
145 h
->oflags
|= HTML_FRAGMENT
;
155 html_alloc(char *outopts
)
158 return(ml_alloc(outopts
, HTML_HTML_4_01_STRICT
));
162 xhtml_alloc(char *outopts
)
165 return(ml_alloc(outopts
, HTML_XHTML_1_0_STRICT
));
174 h
= (struct html
*)p
;
176 while ((tag
= h
->tags
.head
) != NULL
) {
177 h
->tags
.head
= tag
->next
;
182 mchars_free(h
->symtab
);
188 print_gen_head(struct html
*h
)
190 struct htmlpair tag
[4];
193 tag
[0].key
= ATTR_CHARSET
;
194 tag
[0].val
= "utf-8";
195 print_otag(h
, TAG_META
, 1, tag
);
198 * Print a default style-sheet.
200 t
= print_otag(h
, TAG_STYLE
, 0, NULL
);
201 print_text(h
, "table.head, table.foot { width: 100%; }\n"
202 "td.head-rtitle, td.foot-os { text-align: right; }\n"
203 "td.head-vol { text-align: center; }\n"
204 "table.foot td { width: 50%; }\n"
205 "table.head td { width: 33%; }\n"
206 "div.spacer { margin: 1em 0; }\n");
210 tag
[0].key
= ATTR_REL
;
211 tag
[0].val
= "stylesheet";
212 tag
[1].key
= ATTR_HREF
;
213 tag
[1].val
= h
->style
;
214 tag
[2].key
= ATTR_TYPE
;
215 tag
[2].val
= "text/css";
216 tag
[3].key
= ATTR_MEDIA
;
218 print_otag(h
, TAG_LINK
, 4, tag
);
223 print_metaf(struct html
*h
, enum mandoc_esc deco
)
228 case ESCAPE_FONTPREV
:
231 case ESCAPE_FONTITALIC
:
232 font
= HTMLFONT_ITALIC
;
234 case ESCAPE_FONTBOLD
:
235 font
= HTMLFONT_BOLD
;
242 case ESCAPE_FONTROMAN
:
243 font
= HTMLFONT_NONE
;
251 print_tagq(h
, h
->metaf
);
259 case HTMLFONT_ITALIC
:
260 h
->metaf
= print_otag(h
, TAG_I
, 0, NULL
);
263 h
->metaf
= print_otag(h
, TAG_B
, 0, NULL
);
266 h
->metaf
= print_otag(h
, TAG_B
, 0, NULL
);
267 print_otag(h
, TAG_I
, 0, NULL
);
275 html_strlen(const char *cp
)
281 * Account for escaped sequences within string length
282 * calculations. This follows the logic in term_strlen() as we
283 * must calculate the width of produced strings.
284 * Assume that characters are always width of "1". This is
285 * hacky, but it gets the job done for approximation of widths.
291 rsz
= strcspn(cp
, "\\");
303 switch (mandoc_escape(&cp
, NULL
, NULL
)) {
308 case ESCAPE_NUMBERED
:
316 case ESCAPE_SKIPCHAR
:
358 print_encode(struct html
*h
, const char *p
, int norecurse
)
364 static const char rejs
[9] = { '\\', '<', '>', '&', '"',
365 ASCII_NBRSP
, ASCII_HYPH
, ASCII_BREAK
, '\0' };
370 if (HTML_SKIPCHAR
& h
->flags
&& '\\' != *p
) {
371 h
->flags
&= ~HTML_SKIPCHAR
;
376 sz
= strcspn(p
, rejs
);
378 fwrite(p
, 1, sz
, stdout
);
384 if (print_escape(*p
++))
387 esc
= mandoc_escape(&p
, &seq
, &len
);
388 if (ESCAPE_ERROR
== esc
)
394 case ESCAPE_FONTPREV
:
396 case ESCAPE_FONTBOLD
:
398 case ESCAPE_FONTITALIC
:
402 case ESCAPE_FONTROMAN
:
406 case ESCAPE_SKIPCHAR
:
407 h
->flags
|= HTML_SKIPCHAR
;
413 if (h
->flags
& HTML_SKIPCHAR
) {
414 h
->flags
&= ~HTML_SKIPCHAR
;
420 /* Skip past "u" header. */
421 c
= mchars_num2uc(seq
+ 1, len
- 1);
425 case ESCAPE_NUMBERED
:
426 c
= mchars_num2char(seq
, len
);
427 if ( ! ('\0' == c
|| print_escape(c
)))
431 c
= mchars_spec2cp(h
->symtab
, seq
, len
);
434 else if (-1 == c
&& 1 == len
&&
451 print_attr(struct html
*h
, const char *key
, const char *val
)
453 printf(" %s=\"", key
);
454 (void)print_encode(h
, val
, 1);
459 print_otag(struct html
*h
, enum htmltag tag
,
460 int sz
, const struct htmlpair
*p
)
465 /* Push this tags onto the stack of open scopes. */
467 if ( ! (HTML_NOSTACK
& htmltags
[tag
].flags
)) {
468 t
= mandoc_malloc(sizeof(struct tag
));
470 t
->next
= h
->tags
.head
;
475 if ( ! (HTML_NOSPACE
& h
->flags
))
476 if ( ! (HTML_CLRLINE
& htmltags
[tag
].flags
)) {
478 if ( ! (HTML_KEEP
& h
->flags
)) {
479 if (HTML_PREKEEP
& h
->flags
)
480 h
->flags
|= HTML_KEEP
;
486 if ( ! (h
->flags
& HTML_NONOSPACE
))
487 h
->flags
&= ~HTML_NOSPACE
;
489 h
->flags
|= HTML_NOSPACE
;
491 /* Print out the tag name and attributes. */
493 printf("<%s", htmltags
[tag
].name
);
494 for (i
= 0; i
< sz
; i
++)
495 print_attr(h
, htmlattrs
[p
[i
].key
], p
[i
].val
);
497 /* Accommodate for XML "well-formed" singleton escaping. */
499 if (HTML_AUTOCLOSE
& htmltags
[tag
].flags
)
501 case HTML_XHTML_1_0_STRICT
:
510 h
->flags
|= HTML_NOSPACE
;
512 if ((HTML_AUTOCLOSE
| HTML_CLRLINE
) & htmltags
[tag
].flags
)
519 print_ctag(struct html
*h
, enum htmltag tag
)
522 printf("</%s>", htmltags
[tag
].name
);
523 if (HTML_CLRLINE
& htmltags
[tag
].flags
) {
524 h
->flags
|= HTML_NOSPACE
;
530 print_gen_decls(struct html
*h
)
533 puts("<!DOCTYPE html>");
537 print_text(struct html
*h
, const char *word
)
540 if ( ! (HTML_NOSPACE
& h
->flags
)) {
542 if ( ! (HTML_KEEP
& h
->flags
)) {
543 if (HTML_PREKEEP
& h
->flags
)
544 h
->flags
|= HTML_KEEP
;
550 assert(NULL
== h
->metaf
);
552 case HTMLFONT_ITALIC
:
553 h
->metaf
= print_otag(h
, TAG_I
, 0, NULL
);
556 h
->metaf
= print_otag(h
, TAG_B
, 0, NULL
);
559 h
->metaf
= print_otag(h
, TAG_B
, 0, NULL
);
560 print_otag(h
, TAG_I
, 0, NULL
);
567 if ( ! print_encode(h
, word
, 0)) {
568 if ( ! (h
->flags
& HTML_NONOSPACE
))
569 h
->flags
&= ~HTML_NOSPACE
;
571 h
->flags
|= HTML_NOSPACE
;
574 print_tagq(h
, h
->metaf
);
578 h
->flags
&= ~HTML_IGNDELIM
;
582 print_tagq(struct html
*h
, const struct tag
*until
)
586 while ((tag
= h
->tags
.head
) != NULL
) {
588 * Remember to close out and nullify the current
589 * meta-font and table, if applicable.
595 print_ctag(h
, tag
->tag
);
596 h
->tags
.head
= tag
->next
;
598 if (until
&& tag
== until
)
604 print_stagq(struct html
*h
, const struct tag
*suntil
)
608 while ((tag
= h
->tags
.head
) != NULL
) {
609 if (suntil
&& tag
== suntil
)
612 * Remember to close out and nullify the current
613 * meta-font and table, if applicable.
619 print_ctag(h
, tag
->tag
);
620 h
->tags
.head
= tag
->next
;
626 print_paragraph(struct html
*h
)
631 PAIR_CLASS_INIT(&tag
, "spacer");
632 t
= print_otag(h
, TAG_DIV
, 1, &tag
);
638 bufinit(struct html
*h
)
646 bufcat_style(struct html
*h
, const char *key
, const char *val
)
656 bufcat(struct html
*h
, const char *p
)
660 * XXX This is broken and not easy to fix.
661 * When using the -Oincludes option, buffmt_includes()
662 * may pass in strings overrunning BUFSIZ, causing a crash.
665 h
->buflen
= strlcat(h
->buf
, p
, BUFSIZ
);
666 assert(h
->buflen
< BUFSIZ
);
670 bufcat_fmt(struct html
*h
, const char *fmt
, ...)
675 (void)vsnprintf(h
->buf
+ (int)h
->buflen
,
676 BUFSIZ
- h
->buflen
- 1, fmt
, ap
);
678 h
->buflen
= strlen(h
->buf
);
682 bufncat(struct html
*h
, const char *p
, size_t sz
)
685 assert(h
->buflen
+ sz
+ 1 < BUFSIZ
);
686 strncat(h
->buf
, p
, sz
);
691 buffmt_includes(struct html
*h
, const char *name
)
695 pp
= h
->base_includes
;
698 while (NULL
!= (p
= strchr(pp
, '%'))) {
699 bufncat(h
, pp
, (size_t)(p
- pp
));
715 buffmt_man(struct html
*h
, const char *name
, const char *sec
)
722 while (NULL
!= (p
= strchr(pp
, '%'))) {
723 bufncat(h
, pp
, (size_t)(p
- pp
));
726 bufcat(h
, sec
? sec
: "1");
729 bufcat_fmt(h
, "%s", name
);
742 bufcat_su(struct html
*h
, const char *p
, const struct roffsu
*su
)
747 if (SCALE_MM
== su
->unit
&& 0.0 == (v
/= 100.0))
749 else if (SCALE_BU
== su
->unit
)
752 bufcat_fmt(h
, "%s: %.2f%s;", p
, v
, roffscales
[su
->unit
]);
756 bufcat_id(struct html
*h
, const char *src
)
759 /* Cf. <http://www.w3.org/TR/html4/types.html#h-6.2>. */
762 bufcat_fmt(h
, "%.2x", *src
++);