]>
git.cameronkatri.com Git - mandoc.git/blob - html.c
1 /* $Id: html.c,v 1.132 2011/04/09 15:29:40 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2011 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>
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 {"p", HTML_CLRLINE
| HTML_NOSTACK
| HTML_AUTOCLOSE
}, /* TAG_P */
72 {"pre", HTML_CLRLINE
}, /* TAG_PRE */
73 {"b", 0 }, /* TAG_B */
74 {"i", 0 }, /* TAG_I */
75 {"code", 0 }, /* TAG_CODE */
76 {"small", 0 }, /* TAG_SMALL */
79 static const char *const htmlattrs
[ATTR_MAX
] = {
80 "http-equiv", /* ATTR_HTTPEQUIV */
81 "content", /* ATTR_CONTENT */
82 "name", /* ATTR_NAME */
84 "href", /* ATTR_HREF */
85 "type", /* ATTR_TYPE */
86 "media", /* ATTR_MEDIA */
87 "class", /* ATTR_CLASS */
88 "style", /* ATTR_STYLE */
89 "width", /* ATTR_WIDTH */
91 "summary", /* ATTR_SUMMARY */
92 "align", /* ATTR_ALIGN */
93 "colspan", /* ATTR_COLSPAN */
96 static void print_num(struct html
*, const char *, size_t);
97 static void print_spec(struct html
*, const char *, size_t);
98 static void print_res(struct html
*, const char *, size_t);
99 static void print_ctag(struct html
*, enum htmltag
);
100 static void print_doctype(struct html
*);
101 static void print_xmltype(struct html
*);
102 static int print_encode(struct html
*, const char *, int);
103 static void print_metaf(struct html
*, enum mandoc_esc
);
104 static void print_attr(struct html
*,
105 const char *, const char *);
106 static void *ml_alloc(char *, enum htmltype
);
110 ml_alloc(char *outopts
, enum htmltype type
)
118 toks
[2] = "includes";
121 h
= mandoc_calloc(1, sizeof(struct html
));
125 h
->symtab
= chars_init(CHARS_HTML
);
127 while (outopts
&& *outopts
)
128 switch (getsubopt(&outopts
, UNCONST(toks
), &v
)) {
136 h
->base_includes
= v
;
146 html_alloc(char *outopts
)
149 return(ml_alloc(outopts
, HTML_HTML_4_01_STRICT
));
154 xhtml_alloc(char *outopts
)
157 return(ml_alloc(outopts
, HTML_XHTML_1_0_STRICT
));
167 h
= (struct html
*)p
;
169 while ((tag
= h
->tags
.head
) != NULL
) {
170 h
->tags
.head
= tag
->next
;
175 chars_free(h
->symtab
);
182 print_gen_head(struct html
*h
)
184 struct htmlpair tag
[4];
186 tag
[0].key
= ATTR_HTTPEQUIV
;
187 tag
[0].val
= "Content-Type";
188 tag
[1].key
= ATTR_CONTENT
;
189 tag
[1].val
= "text/html; charset=utf-8";
190 print_otag(h
, TAG_META
, 2, tag
);
192 tag
[0].key
= ATTR_NAME
;
193 tag
[0].val
= "resource-type";
194 tag
[1].key
= ATTR_CONTENT
;
195 tag
[1].val
= "document";
196 print_otag(h
, TAG_META
, 2, tag
);
199 tag
[0].key
= ATTR_REL
;
200 tag
[0].val
= "stylesheet";
201 tag
[1].key
= ATTR_HREF
;
202 tag
[1].val
= h
->style
;
203 tag
[2].key
= ATTR_TYPE
;
204 tag
[2].val
= "text/css";
205 tag
[3].key
= ATTR_MEDIA
;
207 print_otag(h
, TAG_LINK
, 4, tag
);
213 print_num(struct html
*h
, const char *p
, size_t len
)
217 rhs
= chars_num2char(p
, len
);
223 print_spec(struct html
*h
, const char *p
, size_t len
)
229 if ((cp
= chars_spec2cp(h
->symtab
, p
, len
)) > 0) {
232 } else if (-1 == cp
&& 1 == len
) {
233 fwrite(p
, 1, len
, stdout
);
238 if (NULL
!= (rhs
= chars_spec2str(h
->symtab
, p
, len
, &sz
)))
239 fwrite(rhs
, 1, sz
, stdout
);
244 print_res(struct html
*h
, const char *p
, size_t len
)
250 if ((cp
= chars_res2cp(h
->symtab
, p
, len
)) > 0) {
256 if (NULL
!= (rhs
= chars_res2str(h
->symtab
, p
, len
, &sz
)))
257 fwrite(rhs
, 1, sz
, stdout
);
262 print_metaf(struct html
*h
, enum mandoc_esc deco
)
267 case (ESCAPE_FONTPREV
):
270 case (ESCAPE_FONTITALIC
):
271 font
= HTMLFONT_ITALIC
;
273 case (ESCAPE_FONTBOLD
):
274 font
= HTMLFONT_BOLD
;
276 case (ESCAPE_FONTROMAN
):
277 font
= HTMLFONT_NONE
;
285 print_tagq(h
, h
->metaf
);
292 if (HTMLFONT_NONE
!= font
)
293 h
->metaf
= HTMLFONT_BOLD
== font
?
294 print_otag(h
, TAG_B
, 0, NULL
) :
295 print_otag(h
, TAG_I
, 0, NULL
);
300 print_encode(struct html
*h
, const char *p
, int norecurse
)
306 static const char rejs
[6] = { '\\', '<', '>', '&', ASCII_HYPH
, '\0' };
311 sz
= strcspn(p
, rejs
);
313 fwrite(p
, 1, sz
, stdout
);
336 esc
= mandoc_escape(&p
, &seq
, &len
);
337 if (ESCAPE_ERROR
== esc
)
341 case (ESCAPE_NUMBERED
):
342 print_num(h
, seq
, len
);
344 case (ESCAPE_PREDEF
):
345 print_res(h
, seq
, len
);
347 case (ESCAPE_SPECIAL
):
348 print_spec(h
, seq
, len
);
350 case (ESCAPE_FONTPREV
):
352 case (ESCAPE_FONTBOLD
):
354 case (ESCAPE_FONTITALIC
):
356 case (ESCAPE_FONTROMAN
):
361 case (ESCAPE_NOSPACE
):
375 print_attr(struct html
*h
, const char *key
, const char *val
)
377 printf(" %s=\"", key
);
378 (void)print_encode(h
, val
, 1);
384 print_otag(struct html
*h
, enum htmltag tag
,
385 int sz
, const struct htmlpair
*p
)
390 /* Push this tags onto the stack of open scopes. */
392 if ( ! (HTML_NOSTACK
& htmltags
[tag
].flags
)) {
393 t
= mandoc_malloc(sizeof(struct tag
));
395 t
->next
= h
->tags
.head
;
400 if ( ! (HTML_NOSPACE
& h
->flags
))
401 if ( ! (HTML_CLRLINE
& htmltags
[tag
].flags
)) {
403 if ( ! (HTML_KEEP
& h
->flags
)) {
404 if (HTML_PREKEEP
& h
->flags
)
405 h
->flags
|= HTML_KEEP
;
411 if ( ! (h
->flags
& HTML_NONOSPACE
))
412 h
->flags
&= ~HTML_NOSPACE
;
414 h
->flags
|= HTML_NOSPACE
;
416 /* Print out the tag name and attributes. */
418 printf("<%s", htmltags
[tag
].name
);
419 for (i
= 0; i
< sz
; i
++)
420 print_attr(h
, htmlattrs
[p
[i
].key
], p
[i
].val
);
422 /* Add non-overridable attributes. */
424 if (TAG_HTML
== tag
&& HTML_XHTML_1_0_STRICT
== h
->type
) {
425 print_attr(h
, "xmlns", "http://www.w3.org/1999/xhtml");
426 print_attr(h
, "xml:lang", "en");
427 print_attr(h
, "lang", "en");
430 /* Accomodate for XML "well-formed" singleton escaping. */
432 if (HTML_AUTOCLOSE
& htmltags
[tag
].flags
)
434 case (HTML_XHTML_1_0_STRICT
):
443 h
->flags
|= HTML_NOSPACE
;
445 if ((HTML_AUTOCLOSE
| HTML_CLRLINE
) & htmltags
[tag
].flags
)
453 print_ctag(struct html
*h
, enum htmltag tag
)
456 printf("</%s>", htmltags
[tag
].name
);
457 if (HTML_CLRLINE
& htmltags
[tag
].flags
) {
458 h
->flags
|= HTML_NOSPACE
;
465 print_gen_decls(struct html
*h
)
474 print_xmltype(struct html
*h
)
477 if (HTML_XHTML_1_0_STRICT
== h
->type
)
478 puts("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
483 print_doctype(struct html
*h
)
490 case (HTML_HTML_4_01_STRICT
):
492 doctype
= "-//W3C//DTD HTML 4.01//EN";
493 dtd
= "http://www.w3.org/TR/html4/strict.dtd";
497 doctype
= "-//W3C//DTD XHTML 1.0 Strict//EN";
498 dtd
= "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";
502 printf("<!DOCTYPE %s PUBLIC \"%s\" \"%s\">\n",
507 print_text(struct html
*h
, const char *word
)
510 if ( ! (HTML_NOSPACE
& h
->flags
)) {
512 if ( ! (HTML_KEEP
& h
->flags
)) {
513 if (HTML_PREKEEP
& h
->flags
)
514 h
->flags
|= HTML_KEEP
;
520 assert(NULL
== h
->metaf
);
521 if (HTMLFONT_NONE
!= h
->metac
)
522 h
->metaf
= HTMLFONT_BOLD
== h
->metac
?
523 print_otag(h
, TAG_B
, 0, NULL
) :
524 print_otag(h
, TAG_I
, 0, NULL
);
527 if ( ! print_encode(h
, word
, 0))
528 if ( ! (h
->flags
& HTML_NONOSPACE
))
529 h
->flags
&= ~HTML_NOSPACE
;
532 print_tagq(h
, h
->metaf
);
536 h
->flags
&= ~HTML_IGNDELIM
;
541 print_tagq(struct html
*h
, const struct tag
*until
)
545 while ((tag
= h
->tags
.head
) != NULL
) {
547 * Remember to close out and nullify the current
548 * meta-font and table, if applicable.
554 print_ctag(h
, tag
->tag
);
555 h
->tags
.head
= tag
->next
;
557 if (until
&& tag
== until
)
564 print_stagq(struct html
*h
, const struct tag
*suntil
)
568 while ((tag
= h
->tags
.head
) != NULL
) {
569 if (suntil
&& tag
== suntil
)
572 * Remember to close out and nullify the current
573 * meta-font and table, if applicable.
579 print_ctag(h
, tag
->tag
);
580 h
->tags
.head
= tag
->next
;
587 bufinit(struct html
*h
)
596 bufcat_style(struct html
*h
, const char *key
, const char *val
)
607 bufcat(struct html
*h
, const char *p
)
610 bufncat(h
, p
, strlen(p
));
615 buffmt(struct html
*h
, const char *fmt
, ...)
620 (void)vsnprintf(h
->buf
+ (int)h
->buflen
,
621 BUFSIZ
- h
->buflen
- 1, fmt
, ap
);
623 h
->buflen
= strlen(h
->buf
);
628 bufncat(struct html
*h
, const char *p
, size_t sz
)
631 if (h
->buflen
+ sz
> BUFSIZ
- 1)
632 sz
= BUFSIZ
- 1 - h
->buflen
;
634 (void)strncat(h
->buf
, p
, sz
);
640 buffmt_includes(struct html
*h
, const char *name
)
644 pp
= h
->base_includes
;
646 while (NULL
!= (p
= strchr(pp
, '%'))) {
647 bufncat(h
, pp
, (size_t)(p
- pp
));
664 buffmt_man(struct html
*h
,
665 const char *name
, const char *sec
)
672 while (NULL
!= (p
= strchr(pp
, '%'))) {
673 bufncat(h
, pp
, (size_t)(p
- pp
));
676 bufcat(h
, sec
? sec
: "1");
693 bufcat_su(struct html
*h
, const char *p
, const struct roffsu
*su
)
736 * XXX: the CSS spec isn't clear as to which types accept
737 * integer or real numbers, so we just make them all decimals.
739 buffmt(h
, "%s: %.2f%s;", p
, v
, u
);
744 html_idcat(char *dst
, const char *src
, int sz
)
750 /* Cf. <http://www.w3.org/TR/html4/types.html#h-6.2>. */
752 /* We can't start with a number (bah). */
764 for ( ; *dst
!= '\0' && sz
; dst
++, sz
--)
767 for ( ; *src
!= '\0' && sz
> 1; src
++) {
768 ssz
= snprintf(dst
, (size_t)sz
, "%.2x", *src
);