Annotation of src/usr.bin/mandoc/html.h, Revision 1.59
1.59 ! schwarze 1: /* $OpenBSD: html.h,v 1.58 2018/12/15 23:33:20 schwarze Exp $ */
1.1 schwarze 2: /*
1.25 schwarze 3: * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
1.50 schwarze 4: * Copyright (c) 2017, 2018 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,
1.51 schwarze 26: TAG_IDIV,
1.1 schwarze 27: TAG_H1,
28: TAG_H2,
29: TAG_SPAN,
30: TAG_LINK,
31: TAG_BR,
32: TAG_A,
33: TAG_TABLE,
34: TAG_TR,
35: TAG_TD,
36: TAG_LI,
37: TAG_UL,
38: TAG_OL,
1.9 schwarze 39: TAG_DL,
40: TAG_DT,
41: TAG_DD,
42: TAG_PRE,
1.45 schwarze 43: TAG_VAR,
1.44 schwarze 44: TAG_CITE,
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,
1.48 schwarze 53: TAG_MN,
1.26 schwarze 54: TAG_MO,
55: TAG_MSUP,
56: TAG_MSUB,
57: TAG_MSUBSUP,
58: TAG_MFRAC,
59: TAG_MSQRT,
60: TAG_MFENCED,
61: TAG_MTABLE,
62: TAG_MTR,
63: TAG_MTD,
1.27 schwarze 64: TAG_MUNDEROVER,
65: TAG_MUNDER,
66: TAG_MOVER,
1.1 schwarze 67: TAG_MAX
68: };
69:
1.4 schwarze 70: enum htmlfont {
71: HTMLFONT_NONE = 0,
72: HTMLFONT_BOLD,
73: HTMLFONT_ITALIC,
1.20 schwarze 74: HTMLFONT_BI,
1.57 schwarze 75: HTMLFONT_CW,
1.4 schwarze 76: HTMLFONT_MAX
77: };
78:
1.1 schwarze 79: struct tag {
1.2 schwarze 80: struct tag *next;
1.1 schwarze 81: enum htmltag tag;
82: };
83:
84: struct html {
85: int flags;
1.15 schwarze 86: #define HTML_NOSPACE (1 << 0) /* suppress next space */
1.7 schwarze 87: #define HTML_IGNDELIM (1 << 1)
88: #define HTML_KEEP (1 << 2)
89: #define HTML_PREKEEP (1 << 3)
1.15 schwarze 90: #define HTML_NONOSPACE (1 << 4) /* never add spaces */
1.19 schwarze 91: #define HTML_SKIPCHAR (1 << 6) /* skip the next character */
1.24 schwarze 92: #define HTML_NOSPLIT (1 << 7) /* do not break line before .An */
93: #define HTML_SPLIT (1 << 8) /* break line before .An */
1.32 schwarze 94: #define HTML_NONEWLINE (1 << 9) /* No line break in nofill mode. */
1.39 schwarze 95: #define HTML_BUFFER (1 << 10) /* Collect a word to see if it fits. */
1.56 schwarze 96: #define HTML_TOCDONE (1 << 11) /* The TOC was already written. */
1.39 schwarze 97: size_t indent; /* current output indentation level */
1.38 schwarze 98: int noindent; /* indent disabled by <pre> */
1.39 schwarze 99: size_t col; /* current output byte position */
100: size_t bufcol; /* current buf byte position */
101: char buf[80]; /* output buffer */
1.42 schwarze 102: struct tag *tag; /* last open tag */
1.13 schwarze 103: struct rofftbl tbl; /* current table */
1.14 schwarze 104: struct tag *tblt; /* current open table scope */
1.55 schwarze 105: char *base_man1; /* bases for manpage href */
106: char *base_man2;
1.13 schwarze 107: char *base_includes; /* base for include href */
108: char *style; /* style-sheet URI */
1.11 schwarze 109: struct tag *metaf; /* current open font scope */
110: enum htmlfont metal; /* last used font */
111: enum htmlfont metac; /* current font mode */
1.18 schwarze 112: int oflags; /* output options */
113: #define HTML_FRAGMENT (1 << 0) /* don't emit HTML/HEAD/BODY */
1.56 schwarze 114: #define HTML_TOC (1 << 1) /* emit a table of contents */
1.1 schwarze 115: };
1.31 schwarze 116:
117:
1.46 schwarze 118: struct roff_node;
1.31 schwarze 119: struct tbl_span;
1.49 schwarze 120: struct eqn_box;
1.47 schwarze 121:
122: void roff_html_pre(struct html *, const struct roff_node *);
1.1 schwarze 123:
1.50 schwarze 124: void print_gen_comment(struct html *, struct roff_node *);
1.5 schwarze 125: void print_gen_decls(struct html *);
1.1 schwarze 126: void print_gen_head(struct html *);
1.58 schwarze 127: void print_metaf(struct html *, enum mandoc_esc);
1.36 schwarze 128: struct tag *print_otag(struct html *, enum htmltag, const char *, ...);
1.1 schwarze 129: void print_tagq(struct html *, const struct tag *);
130: void print_stagq(struct html *, const struct tag *);
131: void print_text(struct html *, const char *);
1.14 schwarze 132: void print_tblclose(struct html *);
1.12 schwarze 133: void print_tbl(struct html *, const struct tbl_span *);
1.49 schwarze 134: void print_eqn(struct html *, const struct eqn_box *);
1.25 schwarze 135: void print_paragraph(struct html *);
1.41 schwarze 136: void print_endline(struct html *);
1.3 schwarze 137:
1.52 schwarze 138: char *html_make_id(const struct roff_node *, int);