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