]> git.cameronkatri.com Git - mandoc.git/blob - html.h
Make HTML output more human readable by overhauling line break logic
[mandoc.git] / html.h
1 /* $Id: html.h,v 1.76 2017/01/18 19:22:22 schwarze Exp $ */
2 /*
3 * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2017 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
19 enum htmltag {
20 TAG_HTML,
21 TAG_HEAD,
22 TAG_BODY,
23 TAG_META,
24 TAG_TITLE,
25 TAG_DIV,
26 TAG_H1,
27 TAG_H2,
28 TAG_SPAN,
29 TAG_LINK,
30 TAG_BR,
31 TAG_A,
32 TAG_TABLE,
33 TAG_TBODY,
34 TAG_COL,
35 TAG_TR,
36 TAG_TD,
37 TAG_LI,
38 TAG_UL,
39 TAG_OL,
40 TAG_DL,
41 TAG_DT,
42 TAG_DD,
43 TAG_BLOCKQUOTE,
44 TAG_PRE,
45 TAG_B,
46 TAG_I,
47 TAG_CODE,
48 TAG_SMALL,
49 TAG_STYLE,
50 TAG_MATH,
51 TAG_MROW,
52 TAG_MI,
53 TAG_MO,
54 TAG_MSUP,
55 TAG_MSUB,
56 TAG_MSUBSUP,
57 TAG_MFRAC,
58 TAG_MSQRT,
59 TAG_MFENCED,
60 TAG_MTABLE,
61 TAG_MTR,
62 TAG_MTD,
63 TAG_MUNDEROVER,
64 TAG_MUNDER,
65 TAG_MOVER,
66 TAG_MAX
67 };
68
69 enum htmlfont {
70 HTMLFONT_NONE = 0,
71 HTMLFONT_BOLD,
72 HTMLFONT_ITALIC,
73 HTMLFONT_BI,
74 HTMLFONT_MAX
75 };
76
77 struct tag {
78 struct tag *next;
79 enum htmltag tag;
80 };
81
82 struct tagq {
83 struct tag *head;
84 };
85
86 struct html {
87 int flags;
88 #define HTML_NOSPACE (1 << 0) /* suppress next space */
89 #define HTML_IGNDELIM (1 << 1)
90 #define HTML_KEEP (1 << 2)
91 #define HTML_PREKEEP (1 << 3)
92 #define HTML_NONOSPACE (1 << 4) /* never add spaces */
93 #define HTML_LITERAL (1 << 5) /* literal (e.g., <PRE>) context */
94 #define HTML_SKIPCHAR (1 << 6) /* skip the next character */
95 #define HTML_NOSPLIT (1 << 7) /* do not break line before .An */
96 #define HTML_SPLIT (1 << 8) /* break line before .An */
97 #define HTML_NONEWLINE (1 << 9) /* No line break in nofill mode. */
98 #define HTML_NLDONE (1 << 10) /* Just started a new line of HTML. */
99 int indent; /* current output indentation level */
100 int noindent; /* indent disabled by <pre> */
101 struct tagq tags; /* stack of open tags */
102 struct rofftbl tbl; /* current table */
103 struct tag *tblt; /* current open table scope */
104 char *base_man; /* base for manpage href */
105 char *base_includes; /* base for include href */
106 char *style; /* style-sheet URI */
107 struct tag *metaf; /* current open font scope */
108 enum htmlfont metal; /* last used font */
109 enum htmlfont metac; /* current font mode */
110 int oflags; /* output options */
111 #define HTML_FRAGMENT (1 << 0) /* don't emit HTML/HEAD/BODY */
112 };
113
114
115 struct tbl_span;
116 struct eqn;
117
118 void print_gen_decls(struct html *);
119 void print_gen_head(struct html *);
120 struct tag *print_otag(struct html *, enum htmltag, const char *, ...);
121 void print_tagq(struct html *, const struct tag *);
122 void print_stagq(struct html *, const struct tag *);
123 void print_text(struct html *, const char *);
124 void print_tblclose(struct html *);
125 void print_tbl(struct html *, const struct tbl_span *);
126 void print_eqn(struct html *, const struct eqn *);
127 void print_paragraph(struct html *);
128
129 int html_strlen(const char *);