]> git.cameronkatri.com Git - mandoc.git/blob - html.c
Use <em> for .Em and .Bf -emphasis.
[mandoc.git] / html.c
1 /* $Id: html.c,v 1.161 2014/08/13 15:25:22 schwarze Exp $ */
2 /*
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2011, 2012, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
5 *
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.
9 *
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.
17 */
18 #include "config.h"
19
20 #include <sys/types.h>
21
22 #include <assert.h>
23 #include <ctype.h>
24 #include <stdarg.h>
25 #include <stdio.h>
26 #include <stdint.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <unistd.h>
30
31 #include "mandoc.h"
32 #include "mandoc_aux.h"
33 #include "libmandoc.h"
34 #include "out.h"
35 #include "html.h"
36 #include "main.h"
37
38 struct htmldata {
39 const char *name;
40 int flags;
41 #define HTML_CLRLINE (1 << 0)
42 #define HTML_NOSTACK (1 << 1)
43 #define HTML_AUTOCLOSE (1 << 2) /* Tag has auto-closure. */
44 };
45
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 */
58 {"a", 0}, /* TAG_A */
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 */
77 {"em", 0 }, /* TAG_EM */
78 };
79
80 static const char *const htmlattrs[ATTR_MAX] = {
81 "http-equiv", /* ATTR_HTTPEQUIV */
82 "content", /* ATTR_CONTENT */
83 "name", /* ATTR_NAME */
84 "rel", /* ATTR_REL */
85 "href", /* ATTR_HREF */
86 "type", /* ATTR_TYPE */
87 "media", /* ATTR_MEDIA */
88 "class", /* ATTR_CLASS */
89 "style", /* ATTR_STYLE */
90 "width", /* ATTR_WIDTH */
91 "id", /* ATTR_ID */
92 "summary", /* ATTR_SUMMARY */
93 "align", /* ATTR_ALIGN */
94 "colspan", /* ATTR_COLSPAN */
95 };
96
97 static const char *const roffscales[SCALE_MAX] = {
98 "cm", /* SCALE_CM */
99 "in", /* SCALE_IN */
100 "pc", /* SCALE_PC */
101 "pt", /* SCALE_PT */
102 "em", /* SCALE_EM */
103 "em", /* SCALE_MM */
104 "ex", /* SCALE_EN */
105 "ex", /* SCALE_BU */
106 "em", /* SCALE_VS */
107 "ex", /* SCALE_FS */
108 };
109
110 static void bufncat(struct html *, const char *, size_t);
111 static void print_ctag(struct html *, enum htmltag);
112 static int print_escape(char);
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);
117
118
119 static void *
120 ml_alloc(char *outopts, enum htmltype type)
121 {
122 struct html *h;
123 const char *toks[5];
124 char *v;
125
126 toks[0] = "style";
127 toks[1] = "man";
128 toks[2] = "includes";
129 toks[3] = "fragment";
130 toks[4] = NULL;
131
132 h = mandoc_calloc(1, sizeof(struct html));
133
134 h->type = type;
135 h->tags.head = NULL;
136 h->symtab = mchars_alloc();
137
138 while (outopts && *outopts)
139 switch (getsubopt(&outopts, UNCONST(toks), &v)) {
140 case 0:
141 h->style = v;
142 break;
143 case 1:
144 h->base_man = v;
145 break;
146 case 2:
147 h->base_includes = v;
148 break;
149 case 3:
150 h->oflags |= HTML_FRAGMENT;
151 break;
152 default:
153 break;
154 }
155
156 return(h);
157 }
158
159 void *
160 html_alloc(char *outopts)
161 {
162
163 return(ml_alloc(outopts, HTML_HTML_4_01_STRICT));
164 }
165
166 void *
167 xhtml_alloc(char *outopts)
168 {
169
170 return(ml_alloc(outopts, HTML_XHTML_1_0_STRICT));
171 }
172
173 void
174 html_free(void *p)
175 {
176 struct tag *tag;
177 struct html *h;
178
179 h = (struct html *)p;
180
181 while ((tag = h->tags.head) != NULL) {
182 h->tags.head = tag->next;
183 free(tag);
184 }
185
186 if (h->symtab)
187 mchars_free(h->symtab);
188
189 free(h);
190 }
191
192 void
193 print_gen_head(struct html *h)
194 {
195 struct htmlpair tag[4];
196
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);
202
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);
208
209 if (h->style) {
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;
217 tag[3].val = "all";
218 print_otag(h, TAG_LINK, 4, tag);
219 }
220 }
221
222 static void
223 print_metaf(struct html *h, enum mandoc_esc deco)
224 {
225 enum htmlfont font;
226
227 switch (deco) {
228 case ESCAPE_FONTPREV:
229 font = h->metal;
230 break;
231 case ESCAPE_FONTITALIC:
232 font = HTMLFONT_ITALIC;
233 break;
234 case ESCAPE_FONTBOLD:
235 font = HTMLFONT_BOLD;
236 break;
237 case ESCAPE_FONTBI:
238 font = HTMLFONT_BI;
239 break;
240 case ESCAPE_FONT:
241 /* FALLTHROUGH */
242 case ESCAPE_FONTROMAN:
243 font = HTMLFONT_NONE;
244 break;
245 default:
246 abort();
247 /* NOTREACHED */
248 }
249
250 if (h->metaf) {
251 print_tagq(h, h->metaf);
252 h->metaf = NULL;
253 }
254
255 h->metal = h->metac;
256 h->metac = font;
257
258 switch (font) {
259 case HTMLFONT_ITALIC:
260 h->metaf = print_otag(h, TAG_I, 0, NULL);
261 break;
262 case HTMLFONT_BOLD:
263 h->metaf = print_otag(h, TAG_B, 0, NULL);
264 break;
265 case HTMLFONT_BI:
266 h->metaf = print_otag(h, TAG_B, 0, NULL);
267 print_otag(h, TAG_I, 0, NULL);
268 break;
269 default:
270 break;
271 }
272 }
273
274 int
275 html_strlen(const char *cp)
276 {
277 size_t rsz;
278 int skip, sz;
279
280 /*
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.
286 */
287
288 sz = 0;
289 skip = 0;
290 while (1) {
291 rsz = strcspn(cp, "\\");
292 if (rsz) {
293 cp += rsz;
294 if (skip) {
295 skip = 0;
296 rsz--;
297 }
298 sz += rsz;
299 }
300 if ('\0' == *cp)
301 break;
302 cp++;
303 switch (mandoc_escape(&cp, NULL, NULL)) {
304 case ESCAPE_ERROR:
305 return(sz);
306 case ESCAPE_UNICODE:
307 /* FALLTHROUGH */
308 case ESCAPE_NUMBERED:
309 /* FALLTHROUGH */
310 case ESCAPE_SPECIAL:
311 if (skip)
312 skip = 0;
313 else
314 sz++;
315 break;
316 case ESCAPE_SKIPCHAR:
317 skip = 1;
318 break;
319 default:
320 break;
321 }
322 }
323 return(sz);
324 }
325
326 static int
327 print_escape(char c)
328 {
329
330 switch (c) {
331 case '<':
332 printf("&lt;");
333 break;
334 case '>':
335 printf("&gt;");
336 break;
337 case '&':
338 printf("&amp;");
339 break;
340 case '"':
341 printf("&quot;");
342 break;
343 case ASCII_NBRSP:
344 putchar('-');
345 break;
346 case ASCII_HYPH:
347 putchar('-');
348 /* FALLTHROUGH */
349 case ASCII_BREAK:
350 break;
351 default:
352 return(0);
353 }
354 return(1);
355 }
356
357 static int
358 print_encode(struct html *h, const char *p, int norecurse)
359 {
360 size_t sz;
361 int c, len, nospace;
362 const char *seq;
363 enum mandoc_esc esc;
364 static const char rejs[9] = { '\\', '<', '>', '&', '"',
365 ASCII_NBRSP, ASCII_HYPH, ASCII_BREAK, '\0' };
366
367 nospace = 0;
368
369 while ('\0' != *p) {
370 if (HTML_SKIPCHAR & h->flags && '\\' != *p) {
371 h->flags &= ~HTML_SKIPCHAR;
372 p++;
373 continue;
374 }
375
376 sz = strcspn(p, rejs);
377
378 fwrite(p, 1, sz, stdout);
379 p += (int)sz;
380
381 if ('\0' == *p)
382 break;
383
384 if (print_escape(*p++))
385 continue;
386
387 esc = mandoc_escape(&p, &seq, &len);
388 if (ESCAPE_ERROR == esc)
389 break;
390
391 switch (esc) {
392 case ESCAPE_FONT:
393 /* FALLTHROUGH */
394 case ESCAPE_FONTPREV:
395 /* FALLTHROUGH */
396 case ESCAPE_FONTBOLD:
397 /* FALLTHROUGH */
398 case ESCAPE_FONTITALIC:
399 /* FALLTHROUGH */
400 case ESCAPE_FONTBI:
401 /* FALLTHROUGH */
402 case ESCAPE_FONTROMAN:
403 if (0 == norecurse)
404 print_metaf(h, esc);
405 continue;
406 case ESCAPE_SKIPCHAR:
407 h->flags |= HTML_SKIPCHAR;
408 continue;
409 default:
410 break;
411 }
412
413 if (h->flags & HTML_SKIPCHAR) {
414 h->flags &= ~HTML_SKIPCHAR;
415 continue;
416 }
417
418 switch (esc) {
419 case ESCAPE_UNICODE:
420 /* Skip past "u" header. */
421 c = mchars_num2uc(seq + 1, len - 1);
422 if ('\0' != c)
423 printf("&#x%x;", c);
424 break;
425 case ESCAPE_NUMBERED:
426 c = mchars_num2char(seq, len);
427 if ( ! ('\0' == c || print_escape(c)))
428 putchar(c);
429 break;
430 case ESCAPE_SPECIAL:
431 c = mchars_spec2cp(h->symtab, seq, len);
432 if (c > 0)
433 printf("&#%d;", c);
434 else if (-1 == c && 1 == len &&
435 !print_escape(*seq))
436 putchar((int)*seq);
437 break;
438 case ESCAPE_NOSPACE:
439 if ('\0' == *p)
440 nospace = 1;
441 break;
442 default:
443 break;
444 }
445 }
446
447 return(nospace);
448 }
449
450 static void
451 print_attr(struct html *h, const char *key, const char *val)
452 {
453 printf(" %s=\"", key);
454 (void)print_encode(h, val, 1);
455 putchar('\"');
456 }
457
458 struct tag *
459 print_otag(struct html *h, enum htmltag tag,
460 int sz, const struct htmlpair *p)
461 {
462 int i;
463 struct tag *t;
464
465 /* Push this tags onto the stack of open scopes. */
466
467 if ( ! (HTML_NOSTACK & htmltags[tag].flags)) {
468 t = mandoc_malloc(sizeof(struct tag));
469 t->tag = tag;
470 t->next = h->tags.head;
471 h->tags.head = t;
472 } else
473 t = NULL;
474
475 if ( ! (HTML_NOSPACE & h->flags))
476 if ( ! (HTML_CLRLINE & htmltags[tag].flags)) {
477 /* Manage keeps! */
478 if ( ! (HTML_KEEP & h->flags)) {
479 if (HTML_PREKEEP & h->flags)
480 h->flags |= HTML_KEEP;
481 putchar(' ');
482 } else
483 printf("&#160;");
484 }
485
486 if ( ! (h->flags & HTML_NONOSPACE))
487 h->flags &= ~HTML_NOSPACE;
488 else
489 h->flags |= HTML_NOSPACE;
490
491 /* Print out the tag name and attributes. */
492
493 printf("<%s", htmltags[tag].name);
494 for (i = 0; i < sz; i++)
495 print_attr(h, htmlattrs[p[i].key], p[i].val);
496
497 /* Add non-overridable attributes. */
498
499 if (TAG_HTML == tag && HTML_XHTML_1_0_STRICT == h->type) {
500 print_attr(h, "xmlns", "http://www.w3.org/1999/xhtml");
501 print_attr(h, "xml:lang", "en");
502 print_attr(h, "lang", "en");
503 }
504
505 /* Accommodate for XML "well-formed" singleton escaping. */
506
507 if (HTML_AUTOCLOSE & htmltags[tag].flags)
508 switch (h->type) {
509 case HTML_XHTML_1_0_STRICT:
510 putchar('/');
511 break;
512 default:
513 break;
514 }
515
516 putchar('>');
517
518 h->flags |= HTML_NOSPACE;
519
520 if ((HTML_AUTOCLOSE | HTML_CLRLINE) & htmltags[tag].flags)
521 putchar('\n');
522
523 return(t);
524 }
525
526 static void
527 print_ctag(struct html *h, enum htmltag tag)
528 {
529
530 printf("</%s>", htmltags[tag].name);
531 if (HTML_CLRLINE & htmltags[tag].flags) {
532 h->flags |= HTML_NOSPACE;
533 putchar('\n');
534 }
535 }
536
537 void
538 print_gen_decls(struct html *h)
539 {
540 const char *doctype;
541 const char *dtd;
542 const char *name;
543
544 switch (h->type) {
545 case HTML_HTML_4_01_STRICT:
546 name = "HTML";
547 doctype = "-//W3C//DTD HTML 4.01//EN";
548 dtd = "http://www.w3.org/TR/html4/strict.dtd";
549 break;
550 default:
551 puts("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
552 name = "html";
553 doctype = "-//W3C//DTD XHTML 1.0 Strict//EN";
554 dtd = "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";
555 break;
556 }
557
558 printf("<!DOCTYPE %s PUBLIC \"%s\" \"%s\">\n",
559 name, doctype, dtd);
560 }
561
562 void
563 print_text(struct html *h, const char *word)
564 {
565
566 if ( ! (HTML_NOSPACE & h->flags)) {
567 /* Manage keeps! */
568 if ( ! (HTML_KEEP & h->flags)) {
569 if (HTML_PREKEEP & h->flags)
570 h->flags |= HTML_KEEP;
571 putchar(' ');
572 } else
573 printf("&#160;");
574 }
575
576 assert(NULL == h->metaf);
577 switch (h->metac) {
578 case HTMLFONT_ITALIC:
579 h->metaf = print_otag(h, TAG_I, 0, NULL);
580 break;
581 case HTMLFONT_BOLD:
582 h->metaf = print_otag(h, TAG_B, 0, NULL);
583 break;
584 case HTMLFONT_BI:
585 h->metaf = print_otag(h, TAG_B, 0, NULL);
586 print_otag(h, TAG_I, 0, NULL);
587 break;
588 default:
589 break;
590 }
591
592 assert(word);
593 if ( ! print_encode(h, word, 0)) {
594 if ( ! (h->flags & HTML_NONOSPACE))
595 h->flags &= ~HTML_NOSPACE;
596 } else
597 h->flags |= HTML_NOSPACE;
598
599 if (h->metaf) {
600 print_tagq(h, h->metaf);
601 h->metaf = NULL;
602 }
603
604 h->flags &= ~HTML_IGNDELIM;
605 }
606
607 void
608 print_tagq(struct html *h, const struct tag *until)
609 {
610 struct tag *tag;
611
612 while ((tag = h->tags.head) != NULL) {
613 /*
614 * Remember to close out and nullify the current
615 * meta-font and table, if applicable.
616 */
617 if (tag == h->metaf)
618 h->metaf = NULL;
619 if (tag == h->tblt)
620 h->tblt = NULL;
621 print_ctag(h, tag->tag);
622 h->tags.head = tag->next;
623 free(tag);
624 if (until && tag == until)
625 return;
626 }
627 }
628
629 void
630 print_stagq(struct html *h, const struct tag *suntil)
631 {
632 struct tag *tag;
633
634 while ((tag = h->tags.head) != NULL) {
635 if (suntil && tag == suntil)
636 return;
637 /*
638 * Remember to close out and nullify the current
639 * meta-font and table, if applicable.
640 */
641 if (tag == h->metaf)
642 h->metaf = NULL;
643 if (tag == h->tblt)
644 h->tblt = NULL;
645 print_ctag(h, tag->tag);
646 h->tags.head = tag->next;
647 free(tag);
648 }
649 }
650
651 void
652 bufinit(struct html *h)
653 {
654
655 h->buf[0] = '\0';
656 h->buflen = 0;
657 }
658
659 void
660 bufcat_style(struct html *h, const char *key, const char *val)
661 {
662
663 bufcat(h, key);
664 bufcat(h, ":");
665 bufcat(h, val);
666 bufcat(h, ";");
667 }
668
669 void
670 bufcat(struct html *h, const char *p)
671 {
672
673 /*
674 * XXX This is broken and not easy to fix.
675 * When using the -Oincludes option, buffmt_includes()
676 * may pass in strings overrunning BUFSIZ, causing a crash.
677 */
678
679 h->buflen = strlcat(h->buf, p, BUFSIZ);
680 assert(h->buflen < BUFSIZ);
681 }
682
683 void
684 bufcat_fmt(struct html *h, const char *fmt, ...)
685 {
686 va_list ap;
687
688 va_start(ap, fmt);
689 (void)vsnprintf(h->buf + (int)h->buflen,
690 BUFSIZ - h->buflen - 1, fmt, ap);
691 va_end(ap);
692 h->buflen = strlen(h->buf);
693 }
694
695 static void
696 bufncat(struct html *h, const char *p, size_t sz)
697 {
698
699 assert(h->buflen + sz + 1 < BUFSIZ);
700 strncat(h->buf, p, sz);
701 h->buflen += sz;
702 }
703
704 void
705 buffmt_includes(struct html *h, const char *name)
706 {
707 const char *p, *pp;
708
709 pp = h->base_includes;
710
711 bufinit(h);
712 while (NULL != (p = strchr(pp, '%'))) {
713 bufncat(h, pp, (size_t)(p - pp));
714 switch (*(p + 1)) {
715 case'I':
716 bufcat(h, name);
717 break;
718 default:
719 bufncat(h, p, 2);
720 break;
721 }
722 pp = p + 2;
723 }
724 if (pp)
725 bufcat(h, pp);
726 }
727
728 void
729 buffmt_man(struct html *h, const char *name, const char *sec)
730 {
731 const char *p, *pp;
732
733 pp = h->base_man;
734
735 bufinit(h);
736 while (NULL != (p = strchr(pp, '%'))) {
737 bufncat(h, pp, (size_t)(p - pp));
738 switch (*(p + 1)) {
739 case 'S':
740 bufcat(h, sec ? sec : "1");
741 break;
742 case 'N':
743 bufcat_fmt(h, "%s", name);
744 break;
745 default:
746 bufncat(h, p, 2);
747 break;
748 }
749 pp = p + 2;
750 }
751 if (pp)
752 bufcat(h, pp);
753 }
754
755 void
756 bufcat_su(struct html *h, const char *p, const struct roffsu *su)
757 {
758 double v;
759
760 v = su->scale;
761 if (SCALE_MM == su->unit && 0.0 == (v /= 100.0))
762 v = 1.0;
763
764 bufcat_fmt(h, "%s: %.2f%s;", p, v, roffscales[su->unit]);
765 }
766
767 void
768 bufcat_id(struct html *h, const char *src)
769 {
770
771 /* Cf. <http://www.w3.org/TR/html4/types.html#h-6.2>. */
772
773 while ('\0' != *src)
774 bufcat_fmt(h, "%.2x", *src++);
775 }