]>
git.cameronkatri.com Git - mandoc.git/blob - html.c
1 /* $Id: html.c,v 1.157 2014/04/23 16:08:33 schwarze 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.
22 #include <sys/types.h>
34 #include "mandoc_aux.h"
35 #include "libmandoc.h"
43 #define HTML_CLRLINE (1 << 0)
44 #define HTML_NOSTACK (1 << 1)
45 #define HTML_AUTOCLOSE (1 << 2) /* Tag has auto-closure. */
48 static const struct htmldata htmltags
[TAG_MAX
] = {
49 {"html", HTML_CLRLINE
}, /* TAG_HTML */
50 {"head", HTML_CLRLINE
}, /* TAG_HEAD */
51 {"body", HTML_CLRLINE
}, /* TAG_BODY */
52 {"meta", HTML_CLRLINE
| HTML_NOSTACK
| HTML_AUTOCLOSE
}, /* TAG_META */
53 {"title", HTML_CLRLINE
}, /* TAG_TITLE */
54 {"div", HTML_CLRLINE
}, /* TAG_DIV */
55 {"h1", 0}, /* TAG_H1 */
56 {"h2", 0}, /* TAG_H2 */
57 {"span", 0}, /* TAG_SPAN */
58 {"link", HTML_CLRLINE
| HTML_NOSTACK
| HTML_AUTOCLOSE
}, /* TAG_LINK */
59 {"br", HTML_CLRLINE
| HTML_NOSTACK
| HTML_AUTOCLOSE
}, /* TAG_BR */
61 {"table", HTML_CLRLINE
}, /* TAG_TABLE */
62 {"tbody", HTML_CLRLINE
}, /* TAG_TBODY */
63 {"col", HTML_CLRLINE
| HTML_NOSTACK
| HTML_AUTOCLOSE
}, /* TAG_COL */
64 {"tr", HTML_CLRLINE
}, /* TAG_TR */
65 {"td", HTML_CLRLINE
}, /* TAG_TD */
66 {"li", HTML_CLRLINE
}, /* TAG_LI */
67 {"ul", HTML_CLRLINE
}, /* TAG_UL */
68 {"ol", HTML_CLRLINE
}, /* TAG_OL */
69 {"dl", HTML_CLRLINE
}, /* TAG_DL */
70 {"dt", HTML_CLRLINE
}, /* TAG_DT */
71 {"dd", HTML_CLRLINE
}, /* TAG_DD */
72 {"blockquote", HTML_CLRLINE
}, /* TAG_BLOCKQUOTE */
73 {"p", HTML_CLRLINE
| HTML_NOSTACK
| HTML_AUTOCLOSE
}, /* TAG_P */
74 {"pre", HTML_CLRLINE
}, /* TAG_PRE */
75 {"b", 0 }, /* TAG_B */
76 {"i", 0 }, /* TAG_I */
77 {"code", 0 }, /* TAG_CODE */
78 {"small", 0 }, /* TAG_SMALL */
81 static const char *const htmlattrs
[ATTR_MAX
] = {
82 "http-equiv", /* ATTR_HTTPEQUIV */
83 "content", /* ATTR_CONTENT */
84 "name", /* ATTR_NAME */
86 "href", /* ATTR_HREF */
87 "type", /* ATTR_TYPE */
88 "media", /* ATTR_MEDIA */
89 "class", /* ATTR_CLASS */
90 "style", /* ATTR_STYLE */
91 "width", /* ATTR_WIDTH */
93 "summary", /* ATTR_SUMMARY */
94 "align", /* ATTR_ALIGN */
95 "colspan", /* ATTR_COLSPAN */
98 static const char *const roffscales
[SCALE_MAX
] = {
111 static void bufncat(struct html
*, const char *, size_t);
112 static void print_ctag(struct html
*, enum htmltag
);
113 static int print_encode(struct html
*, const char *, int);
114 static void print_metaf(struct html
*, enum mandoc_esc
);
115 static void print_attr(struct html
*, const char *, const char *);
116 static void *ml_alloc(char *, enum htmltype
);
120 ml_alloc(char *outopts
, enum htmltype type
)
128 toks
[2] = "includes";
129 toks
[3] = "fragment";
132 h
= mandoc_calloc(1, sizeof(struct html
));
136 h
->symtab
= mchars_alloc();
138 while (outopts
&& *outopts
)
139 switch (getsubopt(&outopts
, UNCONST(toks
), &v
)) {
147 h
->base_includes
= v
;
150 h
->oflags
|= HTML_FRAGMENT
;
160 html_alloc(char *outopts
)
163 return(ml_alloc(outopts
, HTML_HTML_4_01_STRICT
));
167 xhtml_alloc(char *outopts
)
170 return(ml_alloc(outopts
, HTML_XHTML_1_0_STRICT
));
179 h
= (struct html
*)p
;
181 while ((tag
= h
->tags
.head
) != NULL
) {
182 h
->tags
.head
= tag
->next
;
187 mchars_free(h
->symtab
);
193 print_gen_head(struct html
*h
)
195 struct htmlpair tag
[4];
197 tag
[0].key
= ATTR_HTTPEQUIV
;
198 tag
[0].val
= "Content-Type";
199 tag
[1].key
= ATTR_CONTENT
;
200 tag
[1].val
= "text/html; charset=utf-8";
201 print_otag(h
, TAG_META
, 2, tag
);
203 tag
[0].key
= ATTR_NAME
;
204 tag
[0].val
= "resource-type";
205 tag
[1].key
= ATTR_CONTENT
;
206 tag
[1].val
= "document";
207 print_otag(h
, TAG_META
, 2, tag
);
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
:
327 print_encode(struct html
*h
, const char *p
, int norecurse
)
333 static const char rejs
[8] = { '\\', '<', '>', '&',
334 ASCII_NBRSP
, ASCII_HYPH
, ASCII_BREAK
, '\0' };
339 if (HTML_SKIPCHAR
& h
->flags
&& '\\' != *p
) {
340 h
->flags
&= ~HTML_SKIPCHAR
;
345 sz
= strcspn(p
, rejs
);
347 fwrite(p
, 1, sz
, stdout
);
375 esc
= mandoc_escape(&p
, &seq
, &len
);
376 if (ESCAPE_ERROR
== esc
)
382 case ESCAPE_FONTPREV
:
384 case ESCAPE_FONTBOLD
:
386 case ESCAPE_FONTITALIC
:
390 case ESCAPE_FONTROMAN
:
394 case ESCAPE_SKIPCHAR
:
395 h
->flags
|= HTML_SKIPCHAR
;
401 if (h
->flags
& HTML_SKIPCHAR
) {
402 h
->flags
&= ~HTML_SKIPCHAR
;
408 /* Skip passed "u" header. */
409 c
= mchars_num2uc(seq
+ 1, len
- 1);
413 case ESCAPE_NUMBERED
:
414 c
= mchars_num2char(seq
, len
);
419 c
= mchars_spec2cp(h
->symtab
, seq
, len
);
422 else if (-1 == c
&& 1 == len
)
438 print_attr(struct html
*h
, const char *key
, const char *val
)
440 printf(" %s=\"", key
);
441 (void)print_encode(h
, val
, 1);
446 print_otag(struct html
*h
, enum htmltag tag
,
447 int sz
, const struct htmlpair
*p
)
452 /* Push this tags onto the stack of open scopes. */
454 if ( ! (HTML_NOSTACK
& htmltags
[tag
].flags
)) {
455 t
= mandoc_malloc(sizeof(struct tag
));
457 t
->next
= h
->tags
.head
;
462 if ( ! (HTML_NOSPACE
& h
->flags
))
463 if ( ! (HTML_CLRLINE
& htmltags
[tag
].flags
)) {
465 if ( ! (HTML_KEEP
& h
->flags
)) {
466 if (HTML_PREKEEP
& h
->flags
)
467 h
->flags
|= HTML_KEEP
;
473 if ( ! (h
->flags
& HTML_NONOSPACE
))
474 h
->flags
&= ~HTML_NOSPACE
;
476 h
->flags
|= HTML_NOSPACE
;
478 /* Print out the tag name and attributes. */
480 printf("<%s", htmltags
[tag
].name
);
481 for (i
= 0; i
< sz
; i
++)
482 print_attr(h
, htmlattrs
[p
[i
].key
], p
[i
].val
);
484 /* Add non-overridable attributes. */
486 if (TAG_HTML
== tag
&& HTML_XHTML_1_0_STRICT
== h
->type
) {
487 print_attr(h
, "xmlns", "http://www.w3.org/1999/xhtml");
488 print_attr(h
, "xml:lang", "en");
489 print_attr(h
, "lang", "en");
492 /* Accommodate for XML "well-formed" singleton escaping. */
494 if (HTML_AUTOCLOSE
& htmltags
[tag
].flags
)
496 case HTML_XHTML_1_0_STRICT
:
505 h
->flags
|= HTML_NOSPACE
;
507 if ((HTML_AUTOCLOSE
| HTML_CLRLINE
) & htmltags
[tag
].flags
)
514 print_ctag(struct html
*h
, enum htmltag tag
)
517 printf("</%s>", htmltags
[tag
].name
);
518 if (HTML_CLRLINE
& htmltags
[tag
].flags
) {
519 h
->flags
|= HTML_NOSPACE
;
525 print_gen_decls(struct html
*h
)
532 case HTML_HTML_4_01_STRICT
:
534 doctype
= "-//W3C//DTD HTML 4.01//EN";
535 dtd
= "http://www.w3.org/TR/html4/strict.dtd";
538 puts("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
540 doctype
= "-//W3C//DTD XHTML 1.0 Strict//EN";
541 dtd
= "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";
545 printf("<!DOCTYPE %s PUBLIC \"%s\" \"%s\">\n",
550 print_text(struct html
*h
, const char *word
)
553 if ( ! (HTML_NOSPACE
& h
->flags
)) {
555 if ( ! (HTML_KEEP
& h
->flags
)) {
556 if (HTML_PREKEEP
& h
->flags
)
557 h
->flags
|= HTML_KEEP
;
563 assert(NULL
== h
->metaf
);
565 case HTMLFONT_ITALIC
:
566 h
->metaf
= print_otag(h
, TAG_I
, 0, NULL
);
569 h
->metaf
= print_otag(h
, TAG_B
, 0, NULL
);
572 h
->metaf
= print_otag(h
, TAG_B
, 0, NULL
);
573 print_otag(h
, TAG_I
, 0, NULL
);
580 if ( ! print_encode(h
, word
, 0)) {
581 if ( ! (h
->flags
& HTML_NONOSPACE
))
582 h
->flags
&= ~HTML_NOSPACE
;
584 h
->flags
|= HTML_NOSPACE
;
587 print_tagq(h
, h
->metaf
);
591 h
->flags
&= ~HTML_IGNDELIM
;
595 print_tagq(struct html
*h
, const struct tag
*until
)
599 while ((tag
= h
->tags
.head
) != NULL
) {
601 * Remember to close out and nullify the current
602 * meta-font and table, if applicable.
608 print_ctag(h
, tag
->tag
);
609 h
->tags
.head
= tag
->next
;
611 if (until
&& tag
== until
)
617 print_stagq(struct html
*h
, const struct tag
*suntil
)
621 while ((tag
= h
->tags
.head
) != NULL
) {
622 if (suntil
&& tag
== suntil
)
625 * Remember to close out and nullify the current
626 * meta-font and table, if applicable.
632 print_ctag(h
, tag
->tag
);
633 h
->tags
.head
= tag
->next
;
639 bufinit(struct html
*h
)
647 bufcat_style(struct html
*h
, const char *key
, const char *val
)
657 bufcat(struct html
*h
, const char *p
)
661 * XXX This is broken and not easy to fix.
662 * When using the -Oincludes option, buffmt_includes()
663 * may pass in strings overrunning BUFSIZ, causing a crash.
666 h
->buflen
= strlcat(h
->buf
, p
, BUFSIZ
);
667 assert(h
->buflen
< BUFSIZ
);
671 bufcat_fmt(struct html
*h
, const char *fmt
, ...)
676 (void)vsnprintf(h
->buf
+ (int)h
->buflen
,
677 BUFSIZ
- h
->buflen
- 1, fmt
, ap
);
679 h
->buflen
= strlen(h
->buf
);
683 bufncat(struct html
*h
, const char *p
, size_t sz
)
686 assert(h
->buflen
+ sz
+ 1 < BUFSIZ
);
687 strncat(h
->buf
, p
, sz
);
692 buffmt_includes(struct html
*h
, const char *name
)
696 pp
= h
->base_includes
;
699 while (NULL
!= (p
= strchr(pp
, '%'))) {
700 bufncat(h
, pp
, (size_t)(p
- pp
));
716 buffmt_man(struct html
*h
, const char *name
, const char *sec
)
723 while (NULL
!= (p
= strchr(pp
, '%'))) {
724 bufncat(h
, pp
, (size_t)(p
- pp
));
727 bufcat(h
, sec
? sec
: "1");
730 bufcat_fmt(h
, "%s", name
);
743 bufcat_su(struct html
*h
, const char *p
, const struct roffsu
*su
)
748 if (SCALE_MM
== su
->unit
&& 0.0 == (v
/= 100.0))
751 bufcat_fmt(h
, "%s: %.2f%s;", p
, v
, roffscales
[su
->unit
]);
755 bufcat_id(struct html
*h
, const char *src
)
758 /* Cf. <http://www.w3.org/TR/html4/types.html#h-6.2>. */
761 bufcat_fmt(h
, "%.2x", *src
++);