xref: /netbsd-src/external/bsd/mdocml/dist/html.h (revision 179b12252ecaf3553d9c2b7458ce62b6a2203d0c)
1 /*	$Vendor-Id: html.h,v 1.27 2010/07/23 00:08:57 kristaps Exp $ */
2 /*
3  * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 #ifndef HTML_H
18 #define HTML_H
19 
20 __BEGIN_DECLS
21 
22 enum	htmltag {
23 	TAG_HTML,
24 	TAG_HEAD,
25 	TAG_BODY,
26 	TAG_META,
27 	TAG_TITLE,
28 	TAG_DIV,
29 	TAG_H1,
30 	TAG_H2,
31 	TAG_SPAN,
32 	TAG_LINK,
33 	TAG_BR,
34 	TAG_A,
35 	TAG_TABLE,
36 	TAG_COL,
37 	TAG_TR,
38 	TAG_TD,
39 	TAG_LI,
40 	TAG_UL,
41 	TAG_OL,
42 	TAG_MAX
43 };
44 
45 enum	htmlattr {
46 	ATTR_HTTPEQUIV,
47 	ATTR_CONTENT,
48 	ATTR_NAME,
49 	ATTR_REL,
50 	ATTR_HREF,
51 	ATTR_TYPE,
52 	ATTR_MEDIA,
53 	ATTR_CLASS,
54 	ATTR_STYLE,
55 	ATTR_WIDTH,
56 	ATTR_VALIGN,
57 	ATTR_TARGET,
58 	ATTR_ID,
59 	ATTR_SUMMARY,
60 	ATTR_MAX
61 };
62 
63 enum	htmlfont {
64 	HTMLFONT_NONE = 0,
65 	HTMLFONT_BOLD,
66 	HTMLFONT_ITALIC,
67 	HTMLFONT_MAX
68 };
69 
70 struct	tag {
71 	struct tag	 *next;
72 	enum htmltag	  tag;
73 };
74 
75 struct	ord {
76 	struct ord	 *next;
77 	const void	 *cookie;
78 	int		  pos;
79 };
80 
81 struct tagq {
82 	struct tag	 *head;
83 };
84 struct ordq {
85 	struct ord	 *head;
86 };
87 
88 struct	htmlpair {
89 	enum htmlattr	  key;
90 	const char	 *val;
91 };
92 
93 #define	PAIR_INIT(p, t, v) \
94 	do { \
95 		(p)->key = (t); \
96 		(p)->val = (v); \
97 	} while (/* CONSTCOND */ 0)
98 
99 #define	PAIR_ID_INIT(p, v)	PAIR_INIT(p, ATTR_ID, v)
100 #define	PAIR_CLASS_INIT(p, v)	PAIR_INIT(p, ATTR_CLASS, v)
101 #define	PAIR_HREF_INIT(p, v)	PAIR_INIT(p, ATTR_HREF, v)
102 #define	PAIR_STYLE_INIT(p, h)	PAIR_INIT(p, ATTR_STYLE, (h)->buf)
103 #define	PAIR_SUMMARY_INIT(p, v)	PAIR_INIT(p, ATTR_SUMMARY, v)
104 
105 enum	htmltype {
106 	HTML_HTML_4_01_STRICT,
107 	HTML_XHTML_1_0_STRICT
108 };
109 
110 struct	html {
111 	int		  flags;
112 #define	HTML_NOSPACE	 (1 << 0)
113 #define	HTML_IGNDELIM	 (1 << 1)
114 #define	HTML_KEEP	 (1 << 2)
115 #define	HTML_PREKEEP	 (1 << 3)
116 #define	HTML_NONOSPACE	 (1 << 4)
117 	struct tagq	  tags;
118 	struct ordq	  ords;
119 	void		 *symtab;
120 	char		 *base;
121 	char		 *base_man;
122 	char		 *base_includes;
123 	char		 *style;
124 	char		  buf[BUFSIZ];
125 	size_t		  buflen;
126 	struct tag	 *metaf;
127 	enum htmlfont	  metal;
128 	enum htmlfont	  metac;
129 	enum htmltype	  type;
130 };
131 
132 struct	roffsu;
133 
134 void		  print_gen_decls(struct html *);
135 void		  print_gen_head(struct html *);
136 struct tag	 *print_ofont(struct html *, enum htmlfont);
137 struct tag	 *print_otag(struct html *, enum htmltag,
138 				int, const struct htmlpair *);
139 void		  print_tagq(struct html *, const struct tag *);
140 void		  print_stagq(struct html *, const struct tag *);
141 void		  print_text(struct html *, const char *);
142 
143 void		  bufcat_su(struct html *, const char *,
144 			const struct roffsu *);
145 void		  buffmt_man(struct html *,
146 			const char *, const char *);
147 void		  buffmt_includes(struct html *, const char *);
148 void		  buffmt(struct html *, const char *, ...);
149 void		  bufcat(struct html *, const char *);
150 void		  bufcat_style(struct html *,
151 			const char *, const char *);
152 void		  bufncat(struct html *, const char *, size_t);
153 void		  bufinit(struct html *);
154 
155 void		  html_idcat(char *, const char *, int);
156 
157 __END_DECLS
158 
159 #endif /*!HTML_H*/
160