]>
git.cameronkatri.com Git - mandoc.git/blob - html.c
1 /* $Id: html.c,v 1.245 2018/12/04 18:29:38 schwarze Exp $ */
3 * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2011-2015, 2017, 2018 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 AUTHORS DISCLAIM ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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>
33 #include "mandoc_aux.h"
34 #include "mandoc_ohash.h"
45 #define HTML_NOSTACK (1 << 0)
46 #define HTML_AUTOCLOSE (1 << 1)
47 #define HTML_NLBEFORE (1 << 2)
48 #define HTML_NLBEGIN (1 << 3)
49 #define HTML_NLEND (1 << 4)
50 #define HTML_NLAFTER (1 << 5)
51 #define HTML_NLAROUND (HTML_NLBEFORE | HTML_NLAFTER)
52 #define HTML_NLINSIDE (HTML_NLBEGIN | HTML_NLEND)
53 #define HTML_NLALL (HTML_NLAROUND | HTML_NLINSIDE)
54 #define HTML_INDENT (1 << 6)
55 #define HTML_NOINDENT (1 << 7)
58 static const struct htmldata htmltags
[TAG_MAX
] = {
60 {"head", HTML_NLALL
| HTML_INDENT
},
62 {"meta", HTML_NOSTACK
| HTML_AUTOCLOSE
| HTML_NLALL
},
63 {"title", HTML_NLAROUND
},
64 {"div", HTML_NLAROUND
},
66 {"h1", HTML_NLAROUND
},
67 {"h2", HTML_NLAROUND
},
69 {"link", HTML_NOSTACK
| HTML_AUTOCLOSE
| HTML_NLALL
},
70 {"br", HTML_NOSTACK
| HTML_AUTOCLOSE
| HTML_NLALL
},
72 {"table", HTML_NLALL
| HTML_INDENT
},
73 {"tr", HTML_NLALL
| HTML_INDENT
},
74 {"td", HTML_NLAROUND
},
75 {"li", HTML_NLAROUND
| HTML_INDENT
},
76 {"ul", HTML_NLALL
| HTML_INDENT
},
77 {"ol", HTML_NLALL
| HTML_INDENT
},
78 {"dl", HTML_NLALL
| HTML_INDENT
},
79 {"dt", HTML_NLAROUND
},
80 {"dd", HTML_NLAROUND
| HTML_INDENT
},
81 {"pre", HTML_NLALL
| HTML_NOINDENT
},
88 {"style", HTML_NLALL
| HTML_INDENT
},
89 {"math", HTML_NLALL
| HTML_INDENT
},
108 /* Avoid duplicate HTML id= attributes. */
109 static struct ohash id_unique
;
111 static void print_byte(struct html
*, char);
112 static void print_endword(struct html
*);
113 static void print_indent(struct html
*);
114 static void print_word(struct html
*, const char *);
116 static void print_ctag(struct html
*, struct tag
*);
117 static int print_escape(struct html
*, char);
118 static int print_encode(struct html
*, const char *, const char *, int);
119 static void print_href(struct html
*, const char *, const char *, int);
120 static void print_metaf(struct html
*, enum mandoc_esc
);
124 html_alloc(const struct manoutput
*outopts
)
128 h
= mandoc_calloc(1, sizeof(struct html
));
131 h
->style
= outopts
->style
;
132 if ((h
->base_man1
= outopts
->man
) == NULL
)
134 else if ((h
->base_man2
= strchr(h
->base_man1
, ';')) != NULL
)
135 *h
->base_man2
++ = '\0';
136 h
->base_includes
= outopts
->includes
;
137 if (outopts
->fragment
)
138 h
->oflags
|= HTML_FRAGMENT
;
140 h
->oflags
|= HTML_TOC
;
142 mandoc_ohash_init(&id_unique
, 4, 0);
155 h
= (struct html
*)p
;
156 while ((tag
= h
->tag
) != NULL
) {
162 cp
= ohash_first(&id_unique
, &slot
);
165 cp
= ohash_next(&id_unique
, &slot
);
167 ohash_delete(&id_unique
);
171 print_gen_head(struct html
*h
)
175 print_otag(h
, TAG_META
, "?", "charset", "utf-8");
176 if (h
->style
!= NULL
) {
177 print_otag(h
, TAG_LINK
, "?h??", "rel", "stylesheet",
178 h
->style
, "type", "text/css", "media", "all");
183 * Print a minimal embedded style sheet.
186 t
= print_otag(h
, TAG_STYLE
, "");
187 print_text(h
, "table.head, table.foot { width: 100%; }");
189 print_text(h
, "td.head-rtitle, td.foot-os { text-align: right; }");
191 print_text(h
, "td.head-vol { text-align: center; }");
193 print_text(h
, "div.Pp { margin: 1ex 0ex; }");
195 print_text(h
, "div.Nd, div.Bf, div.Op { display: inline; }");
197 print_text(h
, "span.Pa, span.Ad { font-style: italic; }");
199 print_text(h
, "span.Ms { font-weight: bold; }");
201 print_text(h
, "dl.Bl-diag ");
203 print_text(h
, " dt { font-weight: bold; }");
205 print_text(h
, "code.Nm, code.Fl, code.Cm, code.Ic, "
206 "code.In, code.Fd, code.Fn,");
208 print_text(h
, "code.Cd { font-weight: bold; "
209 "font-family: inherit; }");
214 print_metaf(struct html
*h
, enum mandoc_esc deco
)
219 case ESCAPE_FONTPREV
:
222 case ESCAPE_FONTITALIC
:
223 font
= HTMLFONT_ITALIC
;
225 case ESCAPE_FONTBOLD
:
226 font
= HTMLFONT_BOLD
;
235 case ESCAPE_FONTROMAN
:
236 font
= HTMLFONT_NONE
;
243 print_tagq(h
, h
->metaf
);
251 case HTMLFONT_ITALIC
:
252 h
->metaf
= print_otag(h
, TAG_I
, "");
255 h
->metaf
= print_otag(h
, TAG_B
, "");
258 h
->metaf
= print_otag(h
, TAG_B
, "");
259 print_otag(h
, TAG_I
, "");
262 h
->metaf
= print_otag(h
, TAG_SPAN
, "c", "Li");
270 html_make_id(const struct roff_node
*n
, int unique
)
272 const struct roff_node
*nch
;
273 char *buf
, *bufs
, *cp
;
277 for (nch
= n
->child
; nch
!= NULL
; nch
= nch
->next
)
278 if (nch
->type
!= ROFFT_TEXT
)
287 * In ID attributes, only use ASCII characters that are
288 * permitted in URL-fragment strings according to the
290 * https://url.spec.whatwg.org/#url-fragment-string
293 for (cp
= buf
; *cp
!= '\0'; cp
++)
294 if (isalnum((unsigned char)*cp
) == 0 &&
295 strchr("!$&'()*+,-./:;=?@_~", *cp
) == NULL
)
301 /* Avoid duplicate HTML id= attributes. */
305 slot
= ohash_qlookup(&id_unique
, buf
);
306 cp
= ohash_find(&id_unique
, slot
);
310 if (++suffix
> 127) {
314 mandoc_asprintf(&bufs
, "%s_%d", buf
, suffix
);
315 slot
= ohash_qlookup(&id_unique
, bufs
);
316 cp
= ohash_find(&id_unique
, slot
);
321 ohash_insert(&id_unique
, slot
, buf
);
326 print_escape(struct html
*h
, char c
)
331 print_word(h
, "<");
334 print_word(h
, ">");
337 print_word(h
, "&");
340 print_word(h
, """);
343 print_word(h
, " ");
357 print_encode(struct html
*h
, const char *p
, const char *pend
, int norecurse
)
362 int c
, len
, breakline
, nospace
;
364 static const char rejs
[10] = { ' ', '\\', '<', '>', '&', '"',
365 ASCII_NBRSP
, ASCII_HYPH
, ASCII_BREAK
, '\0' };
368 pend
= strchr(p
, '\0');
374 if (HTML_SKIPCHAR
& h
->flags
&& '\\' != *p
) {
375 h
->flags
&= ~HTML_SKIPCHAR
;
380 for (sz
= strcspn(p
, rejs
); sz
-- && p
< pend
; p
++)
384 (p
>= pend
|| *p
== ' ' || *p
== ASCII_NBRSP
)) {
385 print_otag(h
, TAG_BR
, "");
387 while (p
< pend
&& (*p
== ' ' || *p
== ASCII_NBRSP
))
401 if (print_escape(h
, *p
++))
404 esc
= mandoc_escape(&p
, &seq
, &len
);
405 if (ESCAPE_ERROR
== esc
)
410 case ESCAPE_FONTPREV
:
411 case ESCAPE_FONTBOLD
:
412 case ESCAPE_FONTITALIC
:
415 case ESCAPE_FONTROMAN
:
416 if (0 == norecurse
) {
417 h
->flags
|= HTML_NOSPACE
;
419 h
->flags
&= ~HTML_NOSPACE
;
422 case ESCAPE_SKIPCHAR
:
423 h
->flags
|= HTML_SKIPCHAR
;
429 if (h
->flags
& HTML_SKIPCHAR
) {
430 h
->flags
&= ~HTML_SKIPCHAR
;
436 /* Skip past "u" header. */
437 c
= mchars_num2uc(seq
+ 1, len
- 1);
439 case ESCAPE_NUMBERED
:
440 c
= mchars_num2char(seq
, len
);
445 c
= mchars_spec2cp(seq
, len
);
450 print_word(h
, "html");
459 case ESCAPE_OVERSTRIKE
:
467 if ((c
< 0x20 && c
!= 0x09) ||
468 (c
> 0x7E && c
< 0xA0))
471 (void)snprintf(numbuf
, sizeof(numbuf
), "&#x%.4X;", c
);
472 print_word(h
, numbuf
);
473 } else if (print_escape(h
, c
) == 0)
481 print_href(struct html
*h
, const char *name
, const char *sec
, int man
)
489 if (h
->base_man2
!= NULL
) {
490 mandoc_asprintf(&filename
, "%s.%s", name
, sec
);
491 if (stat(filename
, &sb
) == -1)
496 pp
= h
->base_includes
;
498 while ((p
= strchr(pp
, '%')) != NULL
) {
499 print_encode(h
, pp
, p
, 1);
500 if (man
&& p
[1] == 'S') {
504 print_encode(h
, sec
, NULL
, 1);
505 } else if ((man
&& p
[1] == 'N') ||
506 (man
== 0 && p
[1] == 'I'))
507 print_encode(h
, name
, NULL
, 1);
509 print_encode(h
, p
, p
+ 2, 1);
513 print_encode(h
, pp
, NULL
, 1);
517 print_otag(struct html
*h
, enum htmltag tag
, const char *fmt
, ...)
523 int style_written
, tflags
;
525 tflags
= htmltags
[tag
].flags
;
527 /* Push this tag onto the stack of open scopes. */
529 if ((tflags
& HTML_NOSTACK
) == 0) {
530 t
= mandoc_malloc(sizeof(struct tag
));
537 if (tflags
& HTML_NLBEFORE
)
541 else if ((h
->flags
& HTML_NOSPACE
) == 0) {
542 if (h
->flags
& HTML_KEEP
)
543 print_word(h
, " ");
545 if (h
->flags
& HTML_PREKEEP
)
546 h
->flags
|= HTML_KEEP
;
551 if ( ! (h
->flags
& HTML_NONOSPACE
))
552 h
->flags
&= ~HTML_NOSPACE
;
554 h
->flags
|= HTML_NOSPACE
;
556 /* Print out the tag name and attributes. */
559 print_word(h
, htmltags
[tag
].name
);
563 while (*fmt
!= '\0' && *fmt
!= 's') {
565 /* Parse attributes and arguments. */
567 arg1
= va_arg(ap
, char *);
581 arg1
= va_arg(ap
, char *);
587 arg2
= va_arg(ap
, char *);
591 /* Print the attributes. */
599 print_href(h
, arg1
, NULL
, 0);
603 print_href(h
, arg1
, arg2
, 1);
608 print_encode(h
, arg1
, NULL
, 1);
612 print_encode(h
, arg1
, NULL
, 1);
613 print_word(h
, "\" title=\"");
614 print_encode(h
, arg1
, NULL
, 1);
618 print_encode(h
, arg1
, NULL
, 1);
625 while (*fmt
++ == 's') {
626 arg1
= va_arg(ap
, char *);
627 arg2
= va_arg(ap
, char *);
631 if (style_written
== 0) {
632 print_word(h
, "style=\"");
646 /* Accommodate for "well-formed" singleton escaping. */
648 if (HTML_AUTOCLOSE
& htmltags
[tag
].flags
)
653 if (tflags
& HTML_NLBEGIN
)
656 h
->flags
|= HTML_NOSPACE
;
658 if (tflags
& HTML_INDENT
)
660 if (tflags
& HTML_NOINDENT
)
667 print_ctag(struct html
*h
, struct tag
*tag
)
672 * Remember to close out and nullify the current
673 * meta-font and table, if applicable.
680 tflags
= htmltags
[tag
->tag
].flags
;
682 if (tflags
& HTML_INDENT
)
684 if (tflags
& HTML_NOINDENT
)
686 if (tflags
& HTML_NLEND
)
691 print_word(h
, htmltags
[tag
->tag
].name
);
693 if (tflags
& HTML_NLAFTER
)
701 print_gen_decls(struct html
*h
)
703 print_word(h
, "<!DOCTYPE html>");
708 print_gen_comment(struct html
*h
, struct roff_node
*n
)
712 print_word(h
, "<!-- This is an automatically generated file."
716 while (n
!= NULL
&& n
->type
== ROFFT_COMMENT
) {
717 if (strstr(n
->string
, "-->") == NULL
&&
718 (wantblank
|| *n
->string
!= '\0')) {
721 print_word(h
, n
->string
);
722 wantblank
= *n
->string
!= '\0';
728 print_word(h
, " -->");
734 print_text(struct html
*h
, const char *word
)
736 if (h
->col
&& (h
->flags
& HTML_NOSPACE
) == 0) {
737 if ( ! (HTML_KEEP
& h
->flags
)) {
738 if (HTML_PREKEEP
& h
->flags
)
739 h
->flags
|= HTML_KEEP
;
742 print_word(h
, " ");
745 assert(NULL
== h
->metaf
);
747 case HTMLFONT_ITALIC
:
748 h
->metaf
= print_otag(h
, TAG_I
, "");
751 h
->metaf
= print_otag(h
, TAG_B
, "");
754 h
->metaf
= print_otag(h
, TAG_B
, "");
755 print_otag(h
, TAG_I
, "");
758 h
->metaf
= print_otag(h
, TAG_SPAN
, "c", "Li");
766 if ( ! print_encode(h
, word
, NULL
, 0)) {
767 if ( ! (h
->flags
& HTML_NONOSPACE
))
768 h
->flags
&= ~HTML_NOSPACE
;
769 h
->flags
&= ~HTML_NONEWLINE
;
771 h
->flags
|= HTML_NOSPACE
| HTML_NONEWLINE
;
774 print_tagq(h
, h
->metaf
);
778 h
->flags
&= ~HTML_IGNDELIM
;
782 print_tagq(struct html
*h
, const struct tag
*until
)
786 while ((tag
= h
->tag
) != NULL
) {
788 if (until
&& tag
== until
)
794 print_stagq(struct html
*h
, const struct tag
*suntil
)
798 while ((tag
= h
->tag
) != NULL
) {
799 if (suntil
&& tag
== suntil
)
806 print_paragraph(struct html
*h
)
810 t
= print_otag(h
, TAG_DIV
, "c", "Pp");
815 /***********************************************************************
816 * Low level output functions.
817 * They implement line breaking using a short static buffer.
818 ***********************************************************************/
821 * Buffer one HTML output byte.
822 * If the buffer is full, flush and deactivate it and start a new line.
823 * If the buffer is inactive, print directly.
826 print_byte(struct html
*h
, char c
)
828 if ((h
->flags
& HTML_BUFFER
) == 0) {
834 if (h
->col
+ h
->bufcol
< sizeof(h
->buf
)) {
835 h
->buf
[h
->bufcol
++] = c
;
844 fwrite(h
->buf
, h
->bufcol
, 1, stdout
);
846 h
->col
= (h
->indent
+ 1) * 2 + h
->bufcol
+ 1;
848 h
->flags
&= ~HTML_BUFFER
;
852 * If something was printed on the current output line, end it.
853 * Not to be called right after print_indent().
856 print_endline(struct html
*h
)
863 fwrite(h
->buf
, h
->bufcol
, 1, stdout
);
868 h
->flags
|= HTML_NOSPACE
;
869 h
->flags
&= ~HTML_BUFFER
;
873 * Flush the HTML output buffer.
874 * If it is inactive, activate it.
877 print_endword(struct html
*h
)
884 if ((h
->flags
& HTML_BUFFER
) == 0) {
886 h
->flags
|= HTML_BUFFER
;
887 } else if (h
->bufcol
) {
889 fwrite(h
->buf
, h
->bufcol
, 1, stdout
);
890 h
->col
+= h
->bufcol
+ 1;
896 * If at the beginning of a new output line,
897 * perform indentation and mark the line as containing output.
898 * Make sure to really produce some output right afterwards,
899 * but do not use print_otag() for producing it.
902 print_indent(struct html
*h
)
909 if (h
->noindent
== 0) {
910 h
->col
= h
->indent
* 2;
911 for (i
= 0; i
< h
->col
; i
++)
914 h
->flags
&= ~HTML_NOSPACE
;
918 * Print or buffer some characters
919 * depending on the current HTML output buffer state.
922 print_word(struct html
*h
, const char *cp
)
925 print_byte(h
, *cp
++);