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