Annotation of src/usr.bin/mandoc/html.h, Revision 1.37
1.37 ! schwarze 1: /* $OpenBSD: html.h,v 1.36 2017/01/17 01:47:46 schwarze Exp $ */
1.1 schwarze 2: /*
1.25 schwarze 3: * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
1.36 schwarze 4: * Copyright (c) 2017 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 5: *
6: * Permission to use, copy, modify, and distribute this software for any
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
18:
19: enum htmltag {
20: TAG_HTML,
21: TAG_HEAD,
22: TAG_BODY,
23: TAG_META,
24: TAG_TITLE,
25: TAG_DIV,
26: TAG_H1,
27: TAG_H2,
28: TAG_SPAN,
29: TAG_LINK,
30: TAG_BR,
31: TAG_A,
32: TAG_TABLE,
1.9 schwarze 33: TAG_TBODY,
1.1 schwarze 34: TAG_COL,
35: TAG_TR,
36: TAG_TD,
37: TAG_LI,
38: TAG_UL,
39: TAG_OL,
1.9 schwarze 40: TAG_DL,
41: TAG_DT,
42: TAG_DD,
43: TAG_BLOCKQUOTE,
44: TAG_PRE,
1.10 schwarze 45: TAG_B,
46: TAG_I,
1.11 schwarze 47: TAG_CODE,
48: TAG_SMALL,
1.25 schwarze 49: TAG_STYLE,
1.26 schwarze 50: TAG_MATH,
51: TAG_MROW,
52: TAG_MI,
53: TAG_MO,
54: TAG_MSUP,
55: TAG_MSUB,
56: TAG_MSUBSUP,
57: TAG_MFRAC,
58: TAG_MSQRT,
59: TAG_MFENCED,
60: TAG_MTABLE,
61: TAG_MTR,
62: TAG_MTD,
1.27 schwarze 63: TAG_MUNDEROVER,
64: TAG_MUNDER,
65: TAG_MOVER,
1.1 schwarze 66: TAG_MAX
67: };
68:
1.4 schwarze 69: enum htmlfont {
70: HTMLFONT_NONE = 0,
71: HTMLFONT_BOLD,
72: HTMLFONT_ITALIC,
1.20 schwarze 73: HTMLFONT_BI,
1.4 schwarze 74: HTMLFONT_MAX
75: };
76:
1.1 schwarze 77: struct tag {
1.2 schwarze 78: struct tag *next;
1.1 schwarze 79: enum htmltag tag;
80: };
81:
1.2 schwarze 82: struct tagq {
83: struct tag *head;
84: };
1.1 schwarze 85:
86: struct html {
87: int flags;
1.15 schwarze 88: #define HTML_NOSPACE (1 << 0) /* suppress next space */
1.7 schwarze 89: #define HTML_IGNDELIM (1 << 1)
90: #define HTML_KEEP (1 << 2)
91: #define HTML_PREKEEP (1 << 3)
1.15 schwarze 92: #define HTML_NONOSPACE (1 << 4) /* never add spaces */
93: #define HTML_LITERAL (1 << 5) /* literal (e.g., <PRE>) context */
1.19 schwarze 94: #define HTML_SKIPCHAR (1 << 6) /* skip the next character */
1.24 schwarze 95: #define HTML_NOSPLIT (1 << 7) /* do not break line before .An */
96: #define HTML_SPLIT (1 << 8) /* break line before .An */
1.32 schwarze 97: #define HTML_NONEWLINE (1 << 9) /* No line break in nofill mode. */
1.13 schwarze 98: struct tagq tags; /* stack of open tags */
99: struct rofftbl tbl; /* current table */
1.14 schwarze 100: struct tag *tblt; /* current open table scope */
1.13 schwarze 101: char *base_man; /* base for manpage href */
102: char *base_includes; /* base for include href */
103: char *style; /* style-sheet URI */
1.11 schwarze 104: struct tag *metaf; /* current open font scope */
105: enum htmlfont metal; /* last used font */
106: enum htmlfont metac; /* current font mode */
1.18 schwarze 107: int oflags; /* output options */
108: #define HTML_FRAGMENT (1 << 0) /* don't emit HTML/HEAD/BODY */
1.1 schwarze 109: };
1.31 schwarze 110:
111:
112: struct tbl_span;
113: struct eqn;
1.1 schwarze 114:
1.5 schwarze 115: void print_gen_decls(struct html *);
1.1 schwarze 116: void print_gen_head(struct html *);
1.36 schwarze 117: struct tag *print_otag(struct html *, enum htmltag, const char *, ...);
1.1 schwarze 118: void print_tagq(struct html *, const struct tag *);
119: void print_stagq(struct html *, const struct tag *);
120: void print_text(struct html *, const char *);
1.14 schwarze 121: void print_tblclose(struct html *);
1.12 schwarze 122: void print_tbl(struct html *, const struct tbl_span *);
1.17 schwarze 123: void print_eqn(struct html *, const struct eqn *);
1.25 schwarze 124: void print_paragraph(struct html *);
1.3 schwarze 125:
1.16 schwarze 126: int html_strlen(const char *);