xref: /illumos-gate/usr/src/cmd/mandoc/html.h (revision 0d2006e4703eda0f88de2e571bf9fb317552faa2)
1 /*	$Id: html.h,v 1.92 2018/06/25 16:54:59 schwarze Exp $ */
2 /*
3  * Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
4  * Copyright (c) 2017, 2018 Ingo Schwarze <schwarze@openbsd.org>
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_IDIV,
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,
39 	TAG_DL,
40 	TAG_DT,
41 	TAG_DD,
42 	TAG_PRE,
43 	TAG_VAR,
44 	TAG_CITE,
45 	TAG_B,
46 	TAG_I,
47 	TAG_CODE,
48 	TAG_SMALL,
49 	TAG_STYLE,
50 	TAG_MATH,
51 	TAG_MROW,
52 	TAG_MI,
53 	TAG_MN,
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,
64 	TAG_MUNDEROVER,
65 	TAG_MUNDER,
66 	TAG_MOVER,
67 	TAG_MAX
68 };
69 
70 enum	htmlfont {
71 	HTMLFONT_NONE = 0,
72 	HTMLFONT_BOLD,
73 	HTMLFONT_ITALIC,
74 	HTMLFONT_BI,
75 	HTMLFONT_MAX
76 };
77 
78 struct	tag {
79 	struct tag	 *next;
80 	enum htmltag	  tag;
81 };
82 
83 struct	html {
84 	int		  flags;
85 #define	HTML_NOSPACE	 (1 << 0) /* suppress next space */
86 #define	HTML_IGNDELIM	 (1 << 1)
87 #define	HTML_KEEP	 (1 << 2)
88 #define	HTML_PREKEEP	 (1 << 3)
89 #define	HTML_NONOSPACE	 (1 << 4) /* never add spaces */
90 #define	HTML_LITERAL	 (1 << 5) /* literal (e.g., <PRE>) context */
91 #define	HTML_SKIPCHAR	 (1 << 6) /* skip the next character */
92 #define	HTML_NOSPLIT	 (1 << 7) /* do not break line before .An */
93 #define	HTML_SPLIT	 (1 << 8) /* break line before .An */
94 #define	HTML_NONEWLINE	 (1 << 9) /* No line break in nofill mode. */
95 #define	HTML_BUFFER	 (1 << 10) /* Collect a word to see if it fits. */
96 	size_t		  indent; /* current output indentation level */
97 	int		  noindent; /* indent disabled by <pre> */
98 	size_t		  col; /* current output byte position */
99 	size_t		  bufcol; /* current buf byte position */
100 	char		  buf[80]; /* output buffer */
101 	struct tag	 *tag; /* last open tag */
102 	struct rofftbl	  tbl; /* current table */
103 	struct tag	 *tblt; /* current open table scope */
104 	char		 *base_man; /* base for manpage href */
105 	char		 *base_includes; /* base for include href */
106 	char		 *style; /* style-sheet URI */
107 	struct tag	 *metaf; /* current open font scope */
108 	enum htmlfont	  metal; /* last used font */
109 	enum htmlfont	  metac; /* current font mode */
110 	int		  oflags; /* output options */
111 #define	HTML_FRAGMENT	 (1 << 0) /* don't emit HTML/HEAD/BODY */
112 };
113 
114 
115 struct	roff_node;
116 struct	tbl_span;
117 struct	eqn_box;
118 
119 void		  roff_html_pre(struct html *, const struct roff_node *);
120 
121 void		  print_gen_comment(struct html *, struct roff_node *);
122 void		  print_gen_decls(struct html *);
123 void		  print_gen_head(struct html *);
124 struct tag	 *print_otag(struct html *, enum htmltag, const char *, ...);
125 void		  print_tagq(struct html *, const struct tag *);
126 void		  print_stagq(struct html *, const struct tag *);
127 void		  print_text(struct html *, const char *);
128 void		  print_tblclose(struct html *);
129 void		  print_tbl(struct html *, const struct tbl_span *);
130 void		  print_eqn(struct html *, const struct eqn_box *);
131 void		  print_paragraph(struct html *);
132 void		  print_endline(struct html *);
133 
134 char		 *html_make_id(const struct roff_node *, int);
135