Annotation of mandoc/html.h, Revision 1.17
1.17 ! kristaps 1: /* $Id: html.h,v 1.16 2009/10/28 05:08:17 kristaps Exp $ */
1.1 kristaps 2: /*
1.6 kristaps 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.6 kristaps 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.6 kristaps 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.
1.1 kristaps 16: */
17: #ifndef HTML_H
18: #define HTML_H
19:
1.6 kristaps 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_P,
32: TAG_SPAN,
33: TAG_LINK,
34: TAG_BR,
35: TAG_A,
36: TAG_TABLE,
37: TAG_COL,
38: TAG_TR,
39: TAG_TD,
40: TAG_LI,
41: TAG_UL,
42: TAG_OL,
43: TAG_BASE,
44: TAG_MAX
45: };
46:
47: enum htmlattr {
48: ATTR_HTTPEQUIV,
49: ATTR_CONTENT,
50: ATTR_NAME,
51: ATTR_REL,
52: ATTR_HREF,
53: ATTR_TYPE,
54: ATTR_MEDIA,
55: ATTR_CLASS,
56: ATTR_STYLE,
57: ATTR_WIDTH,
58: ATTR_VALIGN,
1.9 kristaps 59: ATTR_TARGET,
1.11 kristaps 60: ATTR_ID,
1.15 kristaps 61: ATTR_SUMMARY,
1.6 kristaps 62: ATTR_MAX
63: };
64:
65: struct tag {
1.14 kristaps 66: struct tag *next;
1.6 kristaps 67: enum htmltag tag;
68: };
69:
70: struct ord {
1.14 kristaps 71: struct ord *next;
72: const void *cookie;
1.6 kristaps 73: int pos;
74: };
1.1 kristaps 75:
1.14 kristaps 76: struct tagq {
77: struct tag *head;
78: };
79: struct ordq {
80: struct ord *head;
81: };
1.6 kristaps 82:
83: struct htmlpair {
84: enum htmlattr key;
1.13 kristaps 85: const char *val;
1.1 kristaps 86: };
87:
1.12 kristaps 88: #define PAIR_CLASS_INIT(p, v) \
89: do { (p)->key = ATTR_CLASS; \
90: (p)->val = (v); } while (/* CONSTCOND */ 0)
91: #define PAIR_HREF_INIT(p, v) \
92: do { (p)->key = ATTR_HREF; \
93: (p)->val = (v); } while (/* CONSTCOND */ 0)
94: #define PAIR_STYLE_INIT(p, h) \
95: do { (p)->key = ATTR_STYLE; \
96: (p)->val = (h)->buf; } while (/* CONSTCOND */ 0)
1.15 kristaps 97: #define PAIR_SUMMARY_INIT(p, v) \
98: do { (p)->key = ATTR_SUMMARY; \
99: (p)->val = (v); } while (/* CONSTCOND */ 0)
1.12 kristaps 100:
1.6 kristaps 101: struct html {
102: int flags;
103: #define HTML_NOSPACE (1 << 0)
104: #define HTML_NEWLINE (1 << 1)
1.7 kristaps 105: #define HTML_IGNDELIM (1 << 2)
1.6 kristaps 106: struct tagq tags;
107: struct ordq ords;
108: void *symtab;
109: char *base;
1.8 kristaps 110: char *base_man;
1.9 kristaps 111: char *base_includes;
1.6 kristaps 112: char *style;
1.8 kristaps 113: char buf[BUFSIZ];
114: size_t buflen;
1.6 kristaps 115: };
1.1 kristaps 116:
1.12 kristaps 117: struct roffsu;
118:
1.6 kristaps 119: void print_gen_doctype(struct html *);
120: void print_gen_head(struct html *);
121: struct tag *print_otag(struct html *, enum htmltag,
122: int, const struct htmlpair *);
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 *);
1.1 kristaps 126:
1.12 kristaps 127: void bufcat_su(struct html *, const char *,
128: const struct roffsu *);
129: void buffmt_man(struct html *,
130: const char *, const char *);
1.10 kristaps 131: void buffmt_includes(struct html *, const char *);
132: void buffmt(struct html *, const char *, ...);
133: void bufcat(struct html *, const char *);
1.12 kristaps 134: void bufcat_style(struct html *,
135: const char *, const char *);
1.10 kristaps 136: void bufncat(struct html *, const char *, size_t);
137: void bufinit(struct html *);
138:
1.16 kristaps 139: void html_idcat(char *, const char *, int);
140:
1.1 kristaps 141: __END_DECLS
142:
143: #endif /*!HTML_H*/
CVSweb