Annotation of mandoc/html.h, Revision 1.54
1.54 ! schwarze 1: /* $Id: html.h,v 1.53 2014/08/14 00:31:43 schwarze Exp $ */
1.1 kristaps 2: /*
1.46 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
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_SPAN,
32: TAG_LINK,
33: TAG_BR,
34: TAG_A,
35: TAG_TABLE,
1.28 kristaps 36: TAG_TBODY,
1.6 kristaps 37: TAG_COL,
38: TAG_TR,
39: TAG_TD,
40: TAG_LI,
41: TAG_UL,
42: TAG_OL,
1.28 kristaps 43: TAG_DL,
44: TAG_DT,
45: TAG_DD,
1.29 kristaps 46: TAG_BLOCKQUOTE,
1.30 kristaps 47: TAG_P,
1.31 kristaps 48: TAG_PRE,
1.32 kristaps 49: TAG_B,
1.33 kristaps 50: TAG_I,
1.34 kristaps 51: TAG_CODE,
1.35 kristaps 52: TAG_SMALL,
1.6 kristaps 53: TAG_MAX
54: };
55:
56: enum htmlattr {
57: ATTR_HTTPEQUIV,
58: ATTR_CONTENT,
59: ATTR_NAME,
60: ATTR_REL,
61: ATTR_HREF,
62: ATTR_TYPE,
63: ATTR_MEDIA,
64: ATTR_CLASS,
65: ATTR_STYLE,
66: ATTR_WIDTH,
1.11 kristaps 67: ATTR_ID,
1.15 kristaps 68: ATTR_SUMMARY,
1.32 kristaps 69: ATTR_ALIGN,
1.39 kristaps 70: ATTR_COLSPAN,
1.6 kristaps 71: ATTR_MAX
72: };
73:
1.21 kristaps 74: enum htmlfont {
75: HTMLFONT_NONE = 0,
76: HTMLFONT_BOLD,
77: HTMLFONT_ITALIC,
1.49 schwarze 78: HTMLFONT_BI,
1.21 kristaps 79: HTMLFONT_MAX
80: };
81:
1.6 kristaps 82: struct tag {
1.14 kristaps 83: struct tag *next;
1.6 kristaps 84: enum htmltag tag;
85: };
86:
1.14 kristaps 87: struct tagq {
88: struct tag *head;
89: };
1.6 kristaps 90:
91: struct htmlpair {
92: enum htmlattr key;
1.13 kristaps 93: const char *val;
1.1 kristaps 94: };
95:
1.23 kristaps 96: #define PAIR_INIT(p, t, v) \
97: do { \
98: (p)->key = (t); \
99: (p)->val = (v); \
100: } while (/* CONSTCOND */ 0)
101:
102: #define PAIR_ID_INIT(p, v) PAIR_INIT(p, ATTR_ID, v)
103: #define PAIR_CLASS_INIT(p, v) PAIR_INIT(p, ATTR_CLASS, v)
104: #define PAIR_HREF_INIT(p, v) PAIR_INIT(p, ATTR_HREF, v)
105: #define PAIR_STYLE_INIT(p, h) PAIR_INIT(p, ATTR_STYLE, (h)->buf)
106: #define PAIR_SUMMARY_INIT(p, v) PAIR_INIT(p, ATTR_SUMMARY, v)
1.12 kristaps 107:
1.51 schwarze 108: enum htmltype {
1.22 kristaps 109: HTML_HTML_4_01_STRICT,
110: HTML_XHTML_1_0_STRICT
111: };
112:
1.6 kristaps 113: struct html {
114: int flags;
1.40 kristaps 115: #define HTML_NOSPACE (1 << 0) /* suppress next space */
1.25 kristaps 116: #define HTML_IGNDELIM (1 << 1)
117: #define HTML_KEEP (1 << 2)
118: #define HTML_PREKEEP (1 << 3)
1.40 kristaps 119: #define HTML_NONOSPACE (1 << 4) /* never add spaces */
120: #define HTML_LITERAL (1 << 5) /* literal (e.g., <PRE>) context */
1.48 schwarze 121: #define HTML_SKIPCHAR (1 << 6) /* skip the next character */
1.54 ! schwarze 122: #define HTML_NOSPLIT (1 << 7) /* do not break line before .An */
! 123: #define HTML_SPLIT (1 << 8) /* break line before .An */
1.38 kristaps 124: struct tagq tags; /* stack of open tags */
125: struct rofftbl tbl; /* current table */
1.39 kristaps 126: struct tag *tblt; /* current open table scope */
1.41 kristaps 127: struct mchars *symtab; /* character-escapes */
1.38 kristaps 128: char *base_man; /* base for manpage href */
129: char *base_includes; /* base for include href */
130: char *style; /* style-sheet URI */
131: char buf[BUFSIZ]; /* see bufcat and friends */
1.51 schwarze 132: size_t buflen;
1.35 kristaps 133: struct tag *metaf; /* current open font scope */
134: enum htmlfont metal; /* last used font */
135: enum htmlfont metac; /* current font mode */
1.47 kristaps 136: enum htmltype type; /* output media type */
137: int oflags; /* output options */
138: #define HTML_FRAGMENT (1 << 0) /* don't emit HTML/HEAD/BODY */
1.6 kristaps 139: };
1.12 kristaps 140:
1.22 kristaps 141: void print_gen_decls(struct html *);
1.6 kristaps 142: void print_gen_head(struct html *);
1.51 schwarze 143: struct tag *print_otag(struct html *, enum htmltag,
1.6 kristaps 144: int, const struct htmlpair *);
145: void print_tagq(struct html *, const struct tag *);
146: void print_stagq(struct html *, const struct tag *);
147: void print_text(struct html *, const char *);
1.39 kristaps 148: void print_tblclose(struct html *);
1.37 kristaps 149: void print_tbl(struct html *, const struct tbl_span *);
1.45 kristaps 150: void print_eqn(struct html *, const struct eqn *);
1.1 kristaps 151:
1.50 joerg 152: #if __GNUC__ - 0 >= 4
153: __attribute__((__format__ (__printf__, 2, 3)))
154: #endif
1.44 kristaps 155: void bufcat_fmt(struct html *, const char *, ...);
156: void bufcat(struct html *, const char *);
157: void bufcat_id(struct html *, const char *);
1.51 schwarze 158: void bufcat_style(struct html *,
1.44 kristaps 159: const char *, const char *);
1.51 schwarze 160: void bufcat_su(struct html *, const char *,
1.12 kristaps 161: const struct roffsu *);
1.44 kristaps 162: void bufinit(struct html *);
1.51 schwarze 163: void buffmt_man(struct html *,
1.12 kristaps 164: const char *, const char *);
1.10 kristaps 165: void buffmt_includes(struct html *, const char *);
166:
1.42 kristaps 167: int html_strlen(const char *);
1.16 kristaps 168:
1.1 kristaps 169: __END_DECLS
170:
171: #endif /*!HTML_H*/
CVSweb