1 /* $Id: html.c,v 1.183 2014/12/02 10:08:06 schwarze Exp $ */
3 * Copyright (c) 2008-2011, 2014 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"
40 #define HTML_CLRLINE (1 << 0)
41 #define HTML_NOSTACK (1 << 1)
42 #define HTML_AUTOCLOSE (1 << 2) /* Tag has auto-closure. */
45 static const struct htmldata htmltags[TAG_MAX] = {
46 {"html", HTML_CLRLINE}, /* TAG_HTML */
47 {"head", HTML_CLRLINE}, /* TAG_HEAD */
48 {"body", HTML_CLRLINE}, /* TAG_BODY */
49 {"meta", HTML_CLRLINE | HTML_NOSTACK | HTML_AUTOCLOSE}, /* TAG_META */
50 {"title", HTML_CLRLINE}, /* TAG_TITLE */
51 {"div", HTML_CLRLINE}, /* TAG_DIV */
52 {"h1", 0}, /* TAG_H1 */
53 {"h2", 0}, /* TAG_H2 */
54 {"span", 0}, /* TAG_SPAN */
55 {"link", HTML_CLRLINE | HTML_NOSTACK | HTML_AUTOCLOSE}, /* TAG_LINK */
56 {"br", HTML_CLRLINE | HTML_NOSTACK | HTML_AUTOCLOSE}, /* TAG_BR */
58 {"table", HTML_CLRLINE}, /* TAG_TABLE */
59 {"tbody", HTML_CLRLINE}, /* TAG_TBODY */
60 {"col", HTML_CLRLINE | HTML_NOSTACK | HTML_AUTOCLOSE}, /* TAG_COL */
61 {"tr", HTML_CLRLINE}, /* TAG_TR */
62 {"td", HTML_CLRLINE}, /* TAG_TD */
63 {"li", HTML_CLRLINE}, /* TAG_LI */
64 {"ul", HTML_CLRLINE}, /* TAG_UL */
65 {"ol", HTML_CLRLINE}, /* TAG_OL */
66 {"dl", HTML_CLRLINE}, /* TAG_DL */
67 {"dt", HTML_CLRLINE}, /* TAG_DT */
68 {"dd", HTML_CLRLINE}, /* TAG_DD */
69 {"blockquote", HTML_CLRLINE}, /* TAG_BLOCKQUOTE */
70 {"pre", HTML_CLRLINE }, /* TAG_PRE */
71 {"b", 0 }, /* TAG_B */
72 {"i", 0 }, /* TAG_I */
73 {"code", 0 }, /* TAG_CODE */
74 {"small", 0 }, /* TAG_SMALL */
75 {"style", HTML_CLRLINE}, /* TAG_STYLE */
76 {"math", HTML_CLRLINE}, /* TAG_MATH */
77 {"mrow", 0}, /* TAG_MROW */
78 {"mi", 0}, /* TAG_MI */
79 {"mo", 0}, /* TAG_MO */
80 {"msup", 0}, /* TAG_MSUP */
81 {"msub", 0}, /* TAG_MSUB */
82 {"msubsup", 0}, /* TAG_MSUBSUP */
83 {"mfrac", 0}, /* TAG_MFRAC */
84 {"msqrt", 0}, /* TAG_MSQRT */
85 {"mfenced", 0}, /* TAG_MFENCED */
86 {"mtable", 0}, /* TAG_MTABLE */
87 {"mtr", 0}, /* TAG_MTR */
88 {"mtd", 0}, /* TAG_MTD */
89 {"munderover", 0}, /* TAG_MUNDEROVER */
90 {"munder", 0}, /* TAG_MUNDER*/
91 {"mover", 0}, /* TAG_MOVER*/
94 static const char *const htmlattrs[ATTR_MAX] = {
95 "name", /* ATTR_NAME */
97 "href", /* ATTR_HREF */
98 "type", /* ATTR_TYPE */
99 "media", /* ATTR_MEDIA */
100 "class", /* ATTR_CLASS */
101 "style", /* ATTR_STYLE */
103 "colspan", /* ATTR_COLSPAN */
104 "charset", /* ATTR_CHARSET */
105 "open", /* ATTR_OPEN */
106 "close", /* ATTR_CLOSE */
107 "mathvariant", /* ATTR_MATHVARIANT */
110 static const char *const roffscales[SCALE_MAX] = {
123 static void bufncat(struct html *, const char *, size_t);
124 static void print_ctag(struct html *, enum htmltag);
125 static int print_escape(char);
126 static int print_encode(struct html *, const char *, int);
127 static void print_metaf(struct html *, enum mandoc_esc);
128 static void print_attr(struct html *, const char *, const char *);
132 html_alloc(const struct mchars *mchars, char *outopts)
140 toks[2] = "includes";
141 toks[3] = "fragment";
144 h = mandoc_calloc(1, sizeof(struct html));
149 while (outopts && *outopts)
150 switch (getsubopt(&outopts, UNCONST(toks), &v)) {
158 h->base_includes = v;
161 h->oflags |= HTML_FRAGMENT;
176 h = (struct html *)p;
178 while ((tag = h->tags.head) != NULL) {
179 h->tags.head = tag->next;
187 print_gen_head(struct html *h)
189 struct htmlpair tag[4];
192 tag[0].key = ATTR_CHARSET;
193 tag[0].val = "utf-8";
194 print_otag(h, TAG_META, 1, tag);
197 * Print a default style-sheet.
199 t = print_otag(h, TAG_STYLE, 0, NULL);
200 print_text(h, "table.head, table.foot { width: 100%; }\n"
201 "td.head-rtitle, td.foot-os { text-align: right; }\n"
202 "td.head-vol { text-align: center; }\n"
203 "table.foot td { width: 50%; }\n"
204 "table.head td { width: 33%; }\n"
205 "div.spacer { margin: 1em 0; }\n");
209 tag[0].key = ATTR_REL;
210 tag[0].val = "stylesheet";
211 tag[1].key = ATTR_HREF;
212 tag[1].val = h->style;
213 tag[2].key = ATTR_TYPE;
214 tag[2].val = "text/css";
215 tag[3].key = ATTR_MEDIA;
217 print_otag(h, TAG_LINK, 4, tag);
222 print_metaf(struct html *h, enum mandoc_esc deco)
227 case ESCAPE_FONTPREV:
230 case ESCAPE_FONTITALIC:
231 font = HTMLFONT_ITALIC;
233 case ESCAPE_FONTBOLD:
234 font = HTMLFONT_BOLD;
241 case ESCAPE_FONTROMAN:
242 font = HTMLFONT_NONE;
250 print_tagq(h, h->metaf);
258 case HTMLFONT_ITALIC:
259 h->metaf = print_otag(h, TAG_I, 0, NULL);
262 h->metaf = print_otag(h, TAG_B, 0, NULL);
265 h->metaf = print_otag(h, TAG_B, 0, NULL);
266 print_otag(h, TAG_I, 0, NULL);
274 html_strlen(const char *cp)
280 * Account for escaped sequences within string length
281 * calculations. This follows the logic in term_strlen() as we
282 * must calculate the width of produced strings.
283 * Assume that characters are always width of "1". This is
284 * hacky, but it gets the job done for approximation of widths.
290 rsz = strcspn(cp, "\\");
302 switch (mandoc_escape(&cp, NULL, NULL)) {
307 case ESCAPE_NUMBERED:
315 case ESCAPE_SKIPCHAR:
357 print_encode(struct html *h, const char *p, int norecurse)
363 static const char rejs[9] = { '\\', '<', '>', '&', '"',
364 ASCII_NBRSP, ASCII_HYPH, ASCII_BREAK, '\0' };
369 if (HTML_SKIPCHAR & h->flags && '\\' != *p) {
370 h->flags &= ~HTML_SKIPCHAR;
375 sz = strcspn(p, rejs);
377 fwrite(p, 1, sz, stdout);
383 if (print_escape(*p++))
386 esc = mandoc_escape(&p, &seq, &len);
387 if (ESCAPE_ERROR == esc)
393 case ESCAPE_FONTPREV:
395 case ESCAPE_FONTBOLD:
397 case ESCAPE_FONTITALIC:
401 case ESCAPE_FONTROMAN:
405 case ESCAPE_SKIPCHAR:
406 h->flags |= HTML_SKIPCHAR;
412 if (h->flags & HTML_SKIPCHAR) {
413 h->flags &= ~HTML_SKIPCHAR;
419 /* Skip past "u" header. */
420 c = mchars_num2uc(seq + 1, len - 1);
422 case ESCAPE_NUMBERED:
423 c = mchars_num2char(seq, len);
428 c = mchars_spec2cp(h->symtab, seq, len);
439 if ((c < 0x20 && c != 0x09) ||
440 (c > 0x7E && c < 0xA0))
444 else if ( ! print_escape(c))
452 print_attr(struct html *h, const char *key, const char *val)
454 printf(" %s=\"", key);
455 (void)print_encode(h, val, 1);
460 print_otag(struct html *h, enum htmltag tag,
461 int sz, const struct htmlpair *p)
466 /* Push this tags onto the stack of open scopes. */
468 if ( ! (HTML_NOSTACK & htmltags[tag].flags)) {
469 t = mandoc_malloc(sizeof(struct tag));
471 t->next = h->tags.head;
476 if ( ! (HTML_NOSPACE & h->flags))
477 if ( ! (HTML_CLRLINE & htmltags[tag].flags)) {
479 if ( ! (HTML_KEEP & h->flags)) {
480 if (HTML_PREKEEP & h->flags)
481 h->flags |= HTML_KEEP;
487 if ( ! (h->flags & HTML_NONOSPACE))
488 h->flags &= ~HTML_NOSPACE;
490 h->flags |= HTML_NOSPACE;
492 /* Print out the tag name and attributes. */
494 printf("<%s", htmltags[tag].name);
495 for (i = 0; i < sz; i++)
496 print_attr(h, htmlattrs[p[i].key], p[i].val);
498 /* Accommodate for "well-formed" singleton escaping. */
500 if (HTML_AUTOCLOSE & htmltags[tag].flags)
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)
528 puts("<!DOCTYPE html>");
532 print_text(struct html *h, const char *word)
535 if ( ! (HTML_NOSPACE & h->flags)) {
537 if ( ! (HTML_KEEP & h->flags)) {
538 if (HTML_PREKEEP & h->flags)
539 h->flags |= HTML_KEEP;
545 assert(NULL == h->metaf);
547 case HTMLFONT_ITALIC:
548 h->metaf = print_otag(h, TAG_I, 0, NULL);
551 h->metaf = print_otag(h, TAG_B, 0, NULL);
554 h->metaf = print_otag(h, TAG_B, 0, NULL);
555 print_otag(h, TAG_I, 0, NULL);
562 if ( ! print_encode(h, word, 0)) {
563 if ( ! (h->flags & HTML_NONOSPACE))
564 h->flags &= ~HTML_NOSPACE;
565 h->flags &= ~HTML_NONEWLINE;
567 h->flags |= HTML_NOSPACE | HTML_NONEWLINE;
570 print_tagq(h, h->metaf);
574 h->flags &= ~HTML_IGNDELIM;
578 print_tagq(struct html *h, const struct tag *until)
582 while ((tag = h->tags.head) != NULL) {
584 * Remember to close out and nullify the current
585 * meta-font and table, if applicable.
591 print_ctag(h, tag->tag);
592 h->tags.head = tag->next;
594 if (until && tag == until)
600 print_stagq(struct html *h, const struct tag *suntil)
604 while ((tag = h->tags.head) != NULL) {
605 if (suntil && tag == suntil)
608 * Remember to close out and nullify the current
609 * meta-font and table, if applicable.
615 print_ctag(h, tag->tag);
616 h->tags.head = tag->next;
622 print_paragraph(struct html *h)
627 PAIR_CLASS_INIT(&tag, "spacer");
628 t = print_otag(h, TAG_DIV, 1, &tag);
634 bufinit(struct html *h)
642 bufcat_style(struct html *h, const char *key, const char *val)
652 bufcat(struct html *h, const char *p)
656 * XXX This is broken and not easy to fix.
657 * When using the -Oincludes option, buffmt_includes()
658 * may pass in strings overrunning BUFSIZ, causing a crash.
661 h->buflen = strlcat(h->buf, p, BUFSIZ);
662 assert(h->buflen < BUFSIZ);
666 bufcat_fmt(struct html *h, const char *fmt, ...)
671 (void)vsnprintf(h->buf + (int)h->buflen,
672 BUFSIZ - h->buflen - 1, fmt, ap);
674 h->buflen = strlen(h->buf);
678 bufncat(struct html *h, const char *p, size_t sz)
681 assert(h->buflen + sz + 1 < BUFSIZ);
682 strncat(h->buf, p, sz);
687 buffmt_includes(struct html *h, const char *name)
691 pp = h->base_includes;
694 while (NULL != (p = strchr(pp, '%'))) {
695 bufncat(h, pp, (size_t)(p - pp));
711 buffmt_man(struct html *h, const char *name, const char *sec)
718 while (NULL != (p = strchr(pp, '%'))) {
719 bufncat(h, pp, (size_t)(p - pp));
722 bufcat(h, sec ? sec : "1");
725 bufcat_fmt(h, "%s", name);
738 bufcat_su(struct html *h, const char *p, const struct roffsu *su)
743 if (SCALE_MM == su->unit && 0.0 == (v /= 100.0))
745 else if (SCALE_BU == su->unit)
748 bufcat_fmt(h, "%s: %.2f%s;", p, v, roffscales[su->unit]);
752 bufcat_id(struct html *h, const char *src)
755 /* Cf. <http://www.w3.org/TR/html4/types.html#h-6.2>. */
758 bufcat_fmt(h, "%.2x", *src++);