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