Annotation of src/usr.bin/mandoc/html.h, Revision 1.27
1.27 ! schwarze 1: /* $OpenBSD: html.h,v 1.26 2014/10/09 15:49:09 schwarze Exp $ */
1.1 schwarze 2: /*
1.25 schwarze 3: * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
1.1 schwarze 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,
1.9 schwarze 36: TAG_TBODY,
1.1 schwarze 37: TAG_COL,
38: TAG_TR,
39: TAG_TD,
40: TAG_LI,
41: TAG_UL,
42: TAG_OL,
1.9 schwarze 43: TAG_DL,
44: TAG_DT,
45: TAG_DD,
46: TAG_BLOCKQUOTE,
47: TAG_PRE,
1.10 schwarze 48: TAG_B,
49: TAG_I,
1.11 schwarze 50: TAG_CODE,
51: TAG_SMALL,
1.25 schwarze 52: TAG_STYLE,
1.26 schwarze 53: TAG_MATH,
54: TAG_MROW,
55: TAG_MI,
56: TAG_MO,
57: TAG_MSUP,
58: TAG_MSUB,
59: TAG_MSUBSUP,
60: TAG_MFRAC,
61: TAG_MSQRT,
62: TAG_MFENCED,
63: TAG_MTABLE,
64: TAG_MTR,
65: TAG_MTD,
1.27 ! schwarze 66: TAG_MUNDEROVER,
! 67: TAG_MUNDER,
! 68: TAG_MOVER,
1.1 schwarze 69: TAG_MAX
70: };
71:
72: enum htmlattr {
73: ATTR_NAME,
74: ATTR_REL,
75: ATTR_HREF,
76: ATTR_TYPE,
77: ATTR_MEDIA,
78: ATTR_CLASS,
79: ATTR_STYLE,
80: ATTR_ID,
1.14 schwarze 81: ATTR_COLSPAN,
1.25 schwarze 82: ATTR_CHARSET,
1.26 schwarze 83: ATTR_OPEN,
84: ATTR_CLOSE,
1.1 schwarze 85: ATTR_MAX
86: };
87:
1.4 schwarze 88: enum htmlfont {
89: HTMLFONT_NONE = 0,
90: HTMLFONT_BOLD,
91: HTMLFONT_ITALIC,
1.20 schwarze 92: HTMLFONT_BI,
1.4 schwarze 93: HTMLFONT_MAX
94: };
95:
1.1 schwarze 96: struct tag {
1.2 schwarze 97: struct tag *next;
1.1 schwarze 98: enum htmltag tag;
99: };
100:
1.2 schwarze 101: struct tagq {
102: struct tag *head;
103: };
1.1 schwarze 104:
105: struct htmlpair {
106: enum htmlattr key;
107: const char *val;
108: };
109:
1.6 schwarze 110: #define PAIR_INIT(p, t, v) \
111: do { \
112: (p)->key = (t); \
113: (p)->val = (v); \
114: } while (/* CONSTCOND */ 0)
115:
116: #define PAIR_ID_INIT(p, v) PAIR_INIT(p, ATTR_ID, v)
117: #define PAIR_CLASS_INIT(p, v) PAIR_INIT(p, ATTR_CLASS, v)
118: #define PAIR_HREF_INIT(p, v) PAIR_INIT(p, ATTR_HREF, v)
119: #define PAIR_STYLE_INIT(p, h) PAIR_INIT(p, ATTR_STYLE, (h)->buf)
1.5 schwarze 120:
1.1 schwarze 121: struct html {
122: int flags;
1.15 schwarze 123: #define HTML_NOSPACE (1 << 0) /* suppress next space */
1.7 schwarze 124: #define HTML_IGNDELIM (1 << 1)
125: #define HTML_KEEP (1 << 2)
126: #define HTML_PREKEEP (1 << 3)
1.15 schwarze 127: #define HTML_NONOSPACE (1 << 4) /* never add spaces */
128: #define HTML_LITERAL (1 << 5) /* literal (e.g., <PRE>) context */
1.19 schwarze 129: #define HTML_SKIPCHAR (1 << 6) /* skip the next character */
1.24 schwarze 130: #define HTML_NOSPLIT (1 << 7) /* do not break line before .An */
131: #define HTML_SPLIT (1 << 8) /* break line before .An */
1.13 schwarze 132: struct tagq tags; /* stack of open tags */
133: struct rofftbl tbl; /* current table */
1.14 schwarze 134: struct tag *tblt; /* current open table scope */
1.16 schwarze 135: struct mchars *symtab; /* character-escapes */
1.13 schwarze 136: char *base_man; /* base for manpage href */
137: char *base_includes; /* base for include href */
138: char *style; /* style-sheet URI */
139: char buf[BUFSIZ]; /* see bufcat and friends */
1.21 schwarze 140: size_t buflen;
1.11 schwarze 141: struct tag *metaf; /* current open font scope */
142: enum htmlfont metal; /* last used font */
143: enum htmlfont metac; /* current font mode */
1.18 schwarze 144: int oflags; /* output options */
145: #define HTML_FRAGMENT (1 << 0) /* don't emit HTML/HEAD/BODY */
1.1 schwarze 146: };
147:
1.5 schwarze 148: void print_gen_decls(struct html *);
1.1 schwarze 149: void print_gen_head(struct html *);
1.21 schwarze 150: struct tag *print_otag(struct html *, enum htmltag,
1.1 schwarze 151: int, const struct htmlpair *);
152: void print_tagq(struct html *, const struct tag *);
153: void print_stagq(struct html *, const struct tag *);
154: void print_text(struct html *, const char *);
1.14 schwarze 155: void print_tblclose(struct html *);
1.12 schwarze 156: void print_tbl(struct html *, const struct tbl_span *);
1.17 schwarze 157: void print_eqn(struct html *, const struct eqn *);
1.25 schwarze 158: void print_paragraph(struct html *);
1.1 schwarze 159:
1.16 schwarze 160: void bufcat_fmt(struct html *, const char *, ...);
161: void bufcat(struct html *, const char *);
162: void bufcat_id(struct html *, const char *);
1.21 schwarze 163: void bufcat_style(struct html *,
1.16 schwarze 164: const char *, const char *);
1.21 schwarze 165: void bufcat_su(struct html *, const char *,
1.1 schwarze 166: const struct roffsu *);
1.16 schwarze 167: void bufinit(struct html *);
1.21 schwarze 168: void buffmt_man(struct html *,
1.1 schwarze 169: const char *, const char *);
170: void buffmt_includes(struct html *, const char *);
1.3 schwarze 171:
1.16 schwarze 172: int html_strlen(const char *);
1.1 schwarze 173:
174: __END_DECLS
175:
176: #endif /*!HTML_H*/
![[BACK]](/icons/back.gif){kind=icon}
Return to html.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc