Annotation of mandoc/html.h, Revision 1.55
1.55 ! kristaps 1: /* $Id: html.h,v 1.54 2014/09/17 19:55:59 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.55 ! kristaps 71: ATTR_CHARSET,
1.6 kristaps 72: ATTR_MAX
73: };
74:
1.21 kristaps 75: enum htmlfont {
76: HTMLFONT_NONE = 0,
77: HTMLFONT_BOLD,
78: HTMLFONT_ITALIC,
1.49 schwarze 79: HTMLFONT_BI,
1.21 kristaps 80: HTMLFONT_MAX
81: };
82:
1.6 kristaps 83: struct tag {
1.14 kristaps 84: struct tag *next;
1.6 kristaps 85: enum htmltag tag;
86: };
87:
1.14 kristaps 88: struct tagq {
89: struct tag *head;
90: };
1.6 kristaps 91:
92: struct htmlpair {
93: enum htmlattr key;
1.13 kristaps 94: const char *val;
1.1 kristaps 95: };
96:
1.23 kristaps 97: #define PAIR_INIT(p, t, v) \
98: do { \
99: (p)->key = (t); \
100: (p)->val = (v); \
101: } while (/* CONSTCOND */ 0)
102:
103: #define PAIR_ID_INIT(p, v) PAIR_INIT(p, ATTR_ID, v)
104: #define PAIR_CLASS_INIT(p, v) PAIR_INIT(p, ATTR_CLASS, v)
105: #define PAIR_HREF_INIT(p, v) PAIR_INIT(p, ATTR_HREF, v)
106: #define PAIR_STYLE_INIT(p, h) PAIR_INIT(p, ATTR_STYLE, (h)->buf)
107: #define PAIR_SUMMARY_INIT(p, v) PAIR_INIT(p, ATTR_SUMMARY, v)
1.12 kristaps 108:
1.51 schwarze 109: enum htmltype {
1.22 kristaps 110: HTML_HTML_4_01_STRICT,
111: HTML_XHTML_1_0_STRICT
112: };
113:
1.6 kristaps 114: struct html {
115: int flags;
1.40 kristaps 116: #define HTML_NOSPACE (1 << 0) /* suppress next space */
1.25 kristaps 117: #define HTML_IGNDELIM (1 << 1)
118: #define HTML_KEEP (1 << 2)
119: #define HTML_PREKEEP (1 << 3)
1.40 kristaps 120: #define HTML_NONOSPACE (1 << 4) /* never add spaces */
121: #define HTML_LITERAL (1 << 5) /* literal (e.g., <PRE>) context */
1.48 schwarze 122: #define HTML_SKIPCHAR (1 << 6) /* skip the next character */
1.54 schwarze 123: #define HTML_NOSPLIT (1 << 7) /* do not break line before .An */
124: #define HTML_SPLIT (1 << 8) /* break line before .An */
1.38 kristaps 125: struct tagq tags; /* stack of open tags */
126: struct rofftbl tbl; /* current table */
1.39 kristaps 127: struct tag *tblt; /* current open table scope */
1.41 kristaps 128: struct mchars *symtab; /* character-escapes */
1.38 kristaps 129: char *base_man; /* base for manpage href */
130: char *base_includes; /* base for include href */
131: char *style; /* style-sheet URI */
132: char buf[BUFSIZ]; /* see bufcat and friends */
1.51 schwarze 133: size_t buflen;
1.35 kristaps 134: struct tag *metaf; /* current open font scope */
135: enum htmlfont metal; /* last used font */
136: enum htmlfont metac; /* current font mode */
1.47 kristaps 137: enum htmltype type; /* output media type */
138: int oflags; /* output options */
139: #define HTML_FRAGMENT (1 << 0) /* don't emit HTML/HEAD/BODY */
1.6 kristaps 140: };
1.12 kristaps 141:
1.22 kristaps 142: void print_gen_decls(struct html *);
1.6 kristaps 143: void print_gen_head(struct html *);
1.51 schwarze 144: struct tag *print_otag(struct html *, enum htmltag,
1.6 kristaps 145: int, const struct htmlpair *);
146: void print_tagq(struct html *, const struct tag *);
147: void print_stagq(struct html *, const struct tag *);
148: void print_text(struct html *, const char *);
1.39 kristaps 149: void print_tblclose(struct html *);
1.37 kristaps 150: void print_tbl(struct html *, const struct tbl_span *);
1.45 kristaps 151: void print_eqn(struct html *, const struct eqn *);
1.1 kristaps 152:
1.50 joerg 153: #if __GNUC__ - 0 >= 4
154: __attribute__((__format__ (__printf__, 2, 3)))
155: #endif
1.44 kristaps 156: void bufcat_fmt(struct html *, const char *, ...);
157: void bufcat(struct html *, const char *);
158: void bufcat_id(struct html *, const char *);
1.51 schwarze 159: void bufcat_style(struct html *,
1.44 kristaps 160: const char *, const char *);
1.51 schwarze 161: void bufcat_su(struct html *, const char *,
1.12 kristaps 162: const struct roffsu *);
1.44 kristaps 163: void bufinit(struct html *);
1.51 schwarze 164: void buffmt_man(struct html *,
1.12 kristaps 165: const char *, const char *);
1.10 kristaps 166: void buffmt_includes(struct html *, const char *);
167:
1.42 kristaps 168: int html_strlen(const char *);
1.16 kristaps 169:
1.1 kristaps 170: __END_DECLS
171:
172: #endif /*!HTML_H*/
CVSweb