more info on man(7) .Xr hyperlinking
[mandoc.git] / html.h
1 /* $Id: html.h,v 1.79 2017/01/26 18:28:18 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_PRE,
44 TAG_B,
45 TAG_I,
46 TAG_CODE,
47 TAG_SMALL,
48 TAG_STYLE,
49 TAG_MATH,
50 TAG_MROW,
51 TAG_MI,
52 TAG_MO,
53 TAG_MSUP,
54 TAG_MSUB,
55 TAG_MSUBSUP,
56 TAG_MFRAC,
57 TAG_MSQRT,
58 TAG_MFENCED,
59 TAG_MTABLE,
60 TAG_MTR,
61 TAG_MTD,
62 TAG_MUNDEROVER,
63 TAG_MUNDER,
64 TAG_MOVER,
65 TAG_MAX
66 };
67
68 enum htmlfont {
69 HTMLFONT_NONE = 0,
70 HTMLFONT_BOLD,
71 HTMLFONT_ITALIC,
72 HTMLFONT_BI,
73 HTMLFONT_MAX
74 };
75
76 struct tag {
77 struct tag *next;
78 enum htmltag tag;
79 };
80
81 struct tagq {
82 struct tag *head;
83 };
84
85 struct html {
86 int flags;
87 #define HTML_NOSPACE (1 << 0) /* suppress next space */
88 #define HTML_IGNDELIM (1 << 1)
89 #define HTML_KEEP (1 << 2)
90 #define HTML_PREKEEP (1 << 3)
91 #define HTML_NONOSPACE (1 << 4) /* never add spaces */
92 #define HTML_LITERAL (1 << 5) /* literal (e.g., <PRE>) context */
93 #define HTML_SKIPCHAR (1 << 6) /* skip the next character */
94 #define HTML_NOSPLIT (1 << 7) /* do not break line before .An */
95 #define HTML_SPLIT (1 << 8) /* break line before .An */
96 #define HTML_NONEWLINE (1 << 9) /* No line break in nofill mode. */
97 #define HTML_BUFFER (1 << 10) /* Collect a word to see if it fits. */
98 size_t indent; /* current output indentation level */
99 int noindent; /* indent disabled by <pre> */
100 size_t col; /* current output byte position */
101 size_t bufcol; /* current buf byte position */
102 char buf[80]; /* output buffer */
103 struct tagq tags; /* stack of open tags */
104 struct rofftbl tbl; /* current table */
105 struct tag *tblt; /* current open table scope */
106 char *base_man; /* base for manpage href */
107 char *base_includes; /* base for include href */
108 char *style; /* style-sheet URI */
109 struct tag *metaf; /* current open font scope */
110 enum htmlfont metal; /* last used font */
111 enum htmlfont metac; /* current font mode */
112 int oflags; /* output options */
113 #define HTML_FRAGMENT (1 << 0) /* don't emit HTML/HEAD/BODY */
114 };
115
116
117 struct tbl_span;
118 struct eqn;
119
120 void print_gen_decls(struct html *);
121 void print_gen_head(struct html *);
122 struct tag *print_otag(struct html *, enum htmltag, const char *, ...);
123 void print_tagq(struct html *, const struct tag *);
124 void print_stagq(struct html *, const struct tag *);
125 void print_text(struct html *, const char *);
126 void print_tblclose(struct html *);
127 void print_tbl(struct html *, const struct tbl_span *);
128 void print_eqn(struct html *, const struct eqn *);
129 void print_paragraph(struct html *);
130 void print_endline(struct html *);
131
132 int html_strlen(const char *);