Annotation of src/usr.bin/mandoc/html.h, Revision 1.68
1.68 ! schwarze 1: /* $OpenBSD: html.h,v 1.67 2019/09/01 15:12:03 schwarze Exp $ */
1.1 schwarze 2: /*
1.25 schwarze 3: * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
1.61 schwarze 4: * Copyright (c) 2017, 2018, 2019 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_META,
1.66 schwarze 23: TAG_LINK,
24: TAG_STYLE,
1.1 schwarze 25: TAG_TITLE,
1.66 schwarze 26: TAG_BODY,
1.1 schwarze 27: TAG_DIV,
1.64 schwarze 28: TAG_SECTION,
1.1 schwarze 29: TAG_TABLE,
30: TAG_TR,
31: TAG_TD,
32: TAG_LI,
33: TAG_UL,
34: TAG_OL,
1.9 schwarze 35: TAG_DL,
36: TAG_DT,
37: TAG_DD,
1.66 schwarze 38: TAG_H1,
39: TAG_H2,
1.61 schwarze 40: TAG_P,
1.9 schwarze 41: TAG_PRE,
1.66 schwarze 42: TAG_A,
43: TAG_B,
1.44 schwarze 44: TAG_CITE,
1.66 schwarze 45: TAG_CODE,
1.10 schwarze 46: TAG_I,
1.11 schwarze 47: TAG_SMALL,
1.66 schwarze 48: TAG_SPAN,
49: TAG_VAR,
50: TAG_BR,
1.68 ! schwarze 51: TAG_MARK,
1.26 schwarze 52: TAG_MATH,
53: TAG_MROW,
54: TAG_MI,
1.48 schwarze 55: TAG_MN,
1.26 schwarze 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: struct tag {
1.2 schwarze 73: struct tag *next;
1.63 schwarze 74: int refcnt;
75: int closed;
1.1 schwarze 76: enum htmltag tag;
77: };
78:
79: struct html {
80: int flags;
1.15 schwarze 81: #define HTML_NOSPACE (1 << 0) /* suppress next space */
1.7 schwarze 82: #define HTML_IGNDELIM (1 << 1)
83: #define HTML_KEEP (1 << 2)
84: #define HTML_PREKEEP (1 << 3)
1.15 schwarze 85: #define HTML_NONOSPACE (1 << 4) /* never add spaces */
1.19 schwarze 86: #define HTML_SKIPCHAR (1 << 6) /* skip the next character */
1.24 schwarze 87: #define HTML_NOSPLIT (1 << 7) /* do not break line before .An */
88: #define HTML_SPLIT (1 << 8) /* break line before .An */
1.32 schwarze 89: #define HTML_NONEWLINE (1 << 9) /* No line break in nofill mode. */
1.39 schwarze 90: #define HTML_BUFFER (1 << 10) /* Collect a word to see if it fits. */
1.56 schwarze 91: #define HTML_TOCDONE (1 << 11) /* The TOC was already written. */
1.39 schwarze 92: size_t indent; /* current output indentation level */
1.38 schwarze 93: int noindent; /* indent disabled by <pre> */
1.39 schwarze 94: size_t col; /* current output byte position */
95: size_t bufcol; /* current buf byte position */
96: char buf[80]; /* output buffer */
1.42 schwarze 97: struct tag *tag; /* last open tag */
1.13 schwarze 98: struct rofftbl tbl; /* current table */
1.14 schwarze 99: struct tag *tblt; /* current open table scope */
1.55 schwarze 100: char *base_man1; /* bases for manpage href */
101: char *base_man2;
1.13 schwarze 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 */
1.65 schwarze 105: enum mandoc_esc metal; /* last used font */
106: enum mandoc_esc 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.56 schwarze 109: #define HTML_TOC (1 << 1) /* emit a table of contents */
1.1 schwarze 110: };
1.31 schwarze 111:
112:
1.46 schwarze 113: struct roff_node;
1.31 schwarze 114: struct tbl_span;
1.49 schwarze 115: struct eqn_box;
1.47 schwarze 116:
117: void roff_html_pre(struct html *, const struct roff_node *);
1.1 schwarze 118:
1.50 schwarze 119: void print_gen_comment(struct html *, struct roff_node *);
1.5 schwarze 120: void print_gen_decls(struct html *);
1.1 schwarze 121: void print_gen_head(struct html *);
1.36 schwarze 122: struct tag *print_otag(struct html *, enum htmltag, const char *, ...);
1.1 schwarze 123: void print_tagq(struct html *, const struct tag *);
124: void print_stagq(struct html *, const struct tag *);
125: void print_text(struct html *, const char *);
1.14 schwarze 126: void print_tblclose(struct html *);
1.12 schwarze 127: void print_tbl(struct html *, const struct tbl_span *);
1.49 schwarze 128: void print_eqn(struct html *, const struct eqn_box *);
1.41 schwarze 129: void print_endline(struct html *);
1.3 schwarze 130:
1.61 schwarze 131: void html_close_paragraph(struct html *);
1.60 schwarze 132: enum roff_tok html_fillmode(struct html *, enum roff_tok);
1.52 schwarze 133: char *html_make_id(const struct roff_node *, int);
1.65 schwarze 134: int html_setfont(struct html *, enum mandoc_esc);