Deleted Added
sdiff udiff text old ( 302408 ) new ( 241675 )
full compact
mdoc.h (302408) mdoc.h (241675)
1/* $Id: mdoc.h,v 1.144 2015/11/07 14:01:16 schwarze Exp $ */
1/* $Id: mdoc.h,v 1.122 2011/03/22 14:05:45 kristaps Exp $ */
2/*
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
2/*
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2014, 2015 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 *
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 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
11 * 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 */
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 MDOC_H
18#define MDOC_H
18
19
19#define MDOC_Ap 0
20#define MDOC_Dd 1
21#define MDOC_Dt 2
22#define MDOC_Os 3
23#define MDOC_Sh 4
24#define MDOC_Ss 5
25#define MDOC_Pp 6
26#define MDOC_D1 7
27#define MDOC_Dl 8
28#define MDOC_Bd 9
29#define MDOC_Ed 10
30#define MDOC_Bl 11
31#define MDOC_El 12
32#define MDOC_It 13
33#define MDOC_Ad 14
34#define MDOC_An 15
35#define MDOC_Ar 16
36#define MDOC_Cd 17
37#define MDOC_Cm 18
38#define MDOC_Dv 19
39#define MDOC_Er 20
40#define MDOC_Ev 21
41#define MDOC_Ex 22
42#define MDOC_Fa 23
43#define MDOC_Fd 24
44#define MDOC_Fl 25
45#define MDOC_Fn 26
46#define MDOC_Ft 27
47#define MDOC_Ic 28
48#define MDOC_In 29
49#define MDOC_Li 30
50#define MDOC_Nd 31
51#define MDOC_Nm 32
52#define MDOC_Op 33
53#define MDOC_Ot 34
54#define MDOC_Pa 35
55#define MDOC_Rv 36
56#define MDOC_St 37
57#define MDOC_Va 38
58#define MDOC_Vt 39
59#define MDOC_Xr 40
60#define MDOC__A 41
61#define MDOC__B 42
62#define MDOC__D 43
63#define MDOC__I 44
64#define MDOC__J 45
65#define MDOC__N 46
66#define MDOC__O 47
67#define MDOC__P 48
68#define MDOC__R 49
69#define MDOC__T 50
70#define MDOC__V 51
71#define MDOC_Ac 52
72#define MDOC_Ao 53
73#define MDOC_Aq 54
74#define MDOC_At 55
75#define MDOC_Bc 56
76#define MDOC_Bf 57
77#define MDOC_Bo 58
78#define MDOC_Bq 59
79#define MDOC_Bsx 60
80#define MDOC_Bx 61
81#define MDOC_Db 62
82#define MDOC_Dc 63
83#define MDOC_Do 64
84#define MDOC_Dq 65
85#define MDOC_Ec 66
86#define MDOC_Ef 67
87#define MDOC_Em 68
88#define MDOC_Eo 69
89#define MDOC_Fx 70
90#define MDOC_Ms 71
91#define MDOC_No 72
92#define MDOC_Ns 73
93#define MDOC_Nx 74
94#define MDOC_Ox 75
95#define MDOC_Pc 76
96#define MDOC_Pf 77
97#define MDOC_Po 78
98#define MDOC_Pq 79
99#define MDOC_Qc 80
100#define MDOC_Ql 81
101#define MDOC_Qo 82
102#define MDOC_Qq 83
103#define MDOC_Re 84
104#define MDOC_Rs 85
105#define MDOC_Sc 86
106#define MDOC_So 87
107#define MDOC_Sq 88
108#define MDOC_Sm 89
109#define MDOC_Sx 90
110#define MDOC_Sy 91
111#define MDOC_Tn 92
112#define MDOC_Ux 93
113#define MDOC_Xc 94
114#define MDOC_Xo 95
115#define MDOC_Fo 96
116#define MDOC_Fc 97
117#define MDOC_Oo 98
118#define MDOC_Oc 99
119#define MDOC_Bk 100
120#define MDOC_Ek 101
121#define MDOC_Bt 102
122#define MDOC_Hf 103
123#define MDOC_Fr 104
124#define MDOC_Ud 105
125#define MDOC_Lb 106
126#define MDOC_Lp 107
127#define MDOC_Lk 108
128#define MDOC_Mt 109
129#define MDOC_Brq 110
130#define MDOC_Bro 111
131#define MDOC_Brc 112
132#define MDOC__C 113
133#define MDOC_Es 114
134#define MDOC_En 115
135#define MDOC_Dx 116
136#define MDOC__Q 117
137#define MDOC_br 118
138#define MDOC_sp 119
139#define MDOC__U 120
140#define MDOC_Ta 121
141#define MDOC_ll 122
142#define MDOC_MAX 123
20enum mdoct {
21 MDOC_Ap = 0,
22 MDOC_Dd,
23 MDOC_Dt,
24 MDOC_Os,
25 MDOC_Sh,
26 MDOC_Ss,
27 MDOC_Pp,
28 MDOC_D1,
29 MDOC_Dl,
30 MDOC_Bd,
31 MDOC_Ed,
32 MDOC_Bl,
33 MDOC_El,
34 MDOC_It,
35 MDOC_Ad,
36 MDOC_An,
37 MDOC_Ar,
38 MDOC_Cd,
39 MDOC_Cm,
40 MDOC_Dv,
41 MDOC_Er,
42 MDOC_Ev,
43 MDOC_Ex,
44 MDOC_Fa,
45 MDOC_Fd,
46 MDOC_Fl,
47 MDOC_Fn,
48 MDOC_Ft,
49 MDOC_Ic,
50 MDOC_In,
51 MDOC_Li,
52 MDOC_Nd,
53 MDOC_Nm,
54 MDOC_Op,
55 MDOC_Ot,
56 MDOC_Pa,
57 MDOC_Rv,
58 MDOC_St,
59 MDOC_Va,
60 MDOC_Vt,
61 MDOC_Xr,
62 MDOC__A,
63 MDOC__B,
64 MDOC__D,
65 MDOC__I,
66 MDOC__J,
67 MDOC__N,
68 MDOC__O,
69 MDOC__P,
70 MDOC__R,
71 MDOC__T,
72 MDOC__V,
73 MDOC_Ac,
74 MDOC_Ao,
75 MDOC_Aq,
76 MDOC_At,
77 MDOC_Bc,
78 MDOC_Bf,
79 MDOC_Bo,
80 MDOC_Bq,
81 MDOC_Bsx,
82 MDOC_Bx,
83 MDOC_Db,
84 MDOC_Dc,
85 MDOC_Do,
86 MDOC_Dq,
87 MDOC_Ec,
88 MDOC_Ef,
89 MDOC_Em,
90 MDOC_Eo,
91 MDOC_Fx,
92 MDOC_Ms,
93 MDOC_No,
94 MDOC_Ns,
95 MDOC_Nx,
96 MDOC_Ox,
97 MDOC_Pc,
98 MDOC_Pf,
99 MDOC_Po,
100 MDOC_Pq,
101 MDOC_Qc,
102 MDOC_Ql,
103 MDOC_Qo,
104 MDOC_Qq,
105 MDOC_Re,
106 MDOC_Rs,
107 MDOC_Sc,
108 MDOC_So,
109 MDOC_Sq,
110 MDOC_Sm,
111 MDOC_Sx,
112 MDOC_Sy,
113 MDOC_Tn,
114 MDOC_Ux,
115 MDOC_Xc,
116 MDOC_Xo,
117 MDOC_Fo,
118 MDOC_Fc,
119 MDOC_Oo,
120 MDOC_Oc,
121 MDOC_Bk,
122 MDOC_Ek,
123 MDOC_Bt,
124 MDOC_Hf,
125 MDOC_Fr,
126 MDOC_Ud,
127 MDOC_Lb,
128 MDOC_Lp,
129 MDOC_Lk,
130 MDOC_Mt,
131 MDOC_Brq,
132 MDOC_Bro,
133 MDOC_Brc,
134 MDOC__C,
135 MDOC_Es,
136 MDOC_En,
137 MDOC_Dx,
138 MDOC__Q,
139 MDOC_br,
140 MDOC_sp,
141 MDOC__U,
142 MDOC_Ta,
143 MDOC_MAX
144};
143
144enum mdocargt {
145 MDOC_Split, /* -split */
146 MDOC_Nosplit, /* -nospli */
147 MDOC_Ragged, /* -ragged */
148 MDOC_Unfilled, /* -unfilled */
149 MDOC_Literal, /* -literal */
150 MDOC_File, /* -file */

--- 16 unchanged lines hidden (view full) ---

167 MDOC_Words, /* -words */
168 MDOC_Emphasis, /* -emphasis */
169 MDOC_Symbolic, /* -symbolic */
170 MDOC_Nested, /* -nested */
171 MDOC_Centred, /* -centered */
172 MDOC_ARG_MAX
173};
174
145
146enum mdocargt {
147 MDOC_Split, /* -split */
148 MDOC_Nosplit, /* -nospli */
149 MDOC_Ragged, /* -ragged */
150 MDOC_Unfilled, /* -unfilled */
151 MDOC_Literal, /* -literal */
152 MDOC_File, /* -file */

--- 16 unchanged lines hidden (view full) ---

169 MDOC_Words, /* -words */
170 MDOC_Emphasis, /* -emphasis */
171 MDOC_Symbolic, /* -symbolic */
172 MDOC_Nested, /* -nested */
173 MDOC_Centred, /* -centered */
174 MDOC_ARG_MAX
175};
176
175/*
176 * An argument to a macro (multiple values = `-column xxx yyy').
177enum mdoc_type {
178 MDOC_TEXT,
179 MDOC_ELEM,
180 MDOC_HEAD,
181 MDOC_TAIL,
182 MDOC_BODY,
183 MDOC_BLOCK,
184 MDOC_TBL,
185 MDOC_EQN,
186 MDOC_ROOT
187};
188
189/*
190 * Section (named/unnamed) of `Sh'. Note that these appear in the
191 * conventional order imposed by mdoc.7. In the case of SEC_NONE, no
192 * section has been invoked (this shouldn't happen). SEC_CUSTOM refers
193 * to other sections.
177 */
194 */
195enum mdoc_sec {
196 SEC_NONE = 0,
197 SEC_NAME, /* NAME */
198 SEC_LIBRARY, /* LIBRARY */
199 SEC_SYNOPSIS, /* SYNOPSIS */
200 SEC_DESCRIPTION, /* DESCRIPTION */
201 SEC_IMPLEMENTATION, /* IMPLEMENTATION NOTES */
202 SEC_RETURN_VALUES, /* RETURN VALUES */
203 SEC_ENVIRONMENT, /* ENVIRONMENT */
204 SEC_FILES, /* FILES */
205 SEC_EXIT_STATUS, /* EXIT STATUS */
206 SEC_EXAMPLES, /* EXAMPLES */
207 SEC_DIAGNOSTICS, /* DIAGNOSTICS */
208 SEC_COMPATIBILITY, /* COMPATIBILITY */
209 SEC_ERRORS, /* ERRORS */
210 SEC_SEE_ALSO, /* SEE ALSO */
211 SEC_STANDARDS, /* STANDARDS */
212 SEC_HISTORY, /* HISTORY */
213 SEC_AUTHORS, /* AUTHORS */
214 SEC_CAVEATS, /* CAVEATS */
215 SEC_BUGS, /* BUGS */
216 SEC_SECURITY, /* SECURITY */
217 SEC_CUSTOM,
218 SEC__MAX
219};
220
221struct mdoc_meta {
222 char *msec; /* `Dt' section (1, 3p, etc.) */
223 char *vol; /* `Dt' volume (implied) */
224 char *arch; /* `Dt' arch (i386, etc.) */
225 char *date; /* `Dd' normalised date */
226 char *title; /* `Dt' title (FOO, etc.) */
227 char *os; /* `Os' system (OpenBSD, etc.) */
228 char *name; /* leading `Nm' name */
229};
230
231/*
232 * An argument to a macro (multiple values = `-column xxx yyy').
233 */
178struct mdoc_argv {
234struct mdoc_argv {
179 enum mdocargt arg; /* type of argument */
235 enum mdocargt arg; /* type of argument */
180 int line;
181 int pos;
182 size_t sz; /* elements in "value" */
183 char **value; /* argument strings */
184};
185
186/*
187 * Reference-counted macro arguments. These are refcounted because
188 * blocks have multiple instances of the same arguments spread across
189 * the HEAD, BODY, TAIL, and BLOCK node types.
190 */
236 int line;
237 int pos;
238 size_t sz; /* elements in "value" */
239 char **value; /* argument strings */
240};
241
242/*
243 * Reference-counted macro arguments. These are refcounted because
244 * blocks have multiple instances of the same arguments spread across
245 * the HEAD, BODY, TAIL, and BLOCK node types.
246 */
191struct mdoc_arg {
247struct mdoc_arg {
192 size_t argc;
193 struct mdoc_argv *argv;
194 unsigned int refcnt;
195};
196
248 size_t argc;
249 struct mdoc_argv *argv;
250 unsigned int refcnt;
251};
252
253/*
254 * Indicates that a BODY's formatting has ended, but the scope is still
255 * open. Used for syntax-broken blocks.
256 */
257enum mdoc_endbody {
258 ENDBODY_NOT = 0,
259 ENDBODY_SPACE, /* is broken: append a space */
260 ENDBODY_NOSPACE /* is broken: don't append a space */
261};
262
197enum mdoc_list {
198 LIST__NONE = 0,
199 LIST_bullet, /* -bullet */
200 LIST_column, /* -column */
201 LIST_dash, /* -dash */
202 LIST_diag, /* -diag */
203 LIST_enum, /* -enum */
204 LIST_hang, /* -hang */
205 LIST_hyphen, /* -hyphen */
206 LIST_inset, /* -inset */
207 LIST_item, /* -item */
208 LIST_ohang, /* -ohang */
209 LIST_tag, /* -tag */
210 LIST_MAX
211};
212
213enum mdoc_disp {
214 DISP__NONE = 0,
263enum mdoc_list {
264 LIST__NONE = 0,
265 LIST_bullet, /* -bullet */
266 LIST_column, /* -column */
267 LIST_dash, /* -dash */
268 LIST_diag, /* -diag */
269 LIST_enum, /* -enum */
270 LIST_hang, /* -hang */
271 LIST_hyphen, /* -hyphen */
272 LIST_inset, /* -inset */
273 LIST_item, /* -item */
274 LIST_ohang, /* -ohang */
275 LIST_tag, /* -tag */
276 LIST_MAX
277};
278
279enum mdoc_disp {
280 DISP__NONE = 0,
215 DISP_centered, /* -centered */
281 DISP_centred, /* -centered */
216 DISP_ragged, /* -ragged */
217 DISP_unfilled, /* -unfilled */
218 DISP_filled, /* -filled */
219 DISP_literal /* -literal */
220};
221
222enum mdoc_auth {
223 AUTH__NONE = 0,

--- 16 unchanged lines hidden (view full) ---

240
241struct mdoc_bl {
242 const char *width; /* -width */
243 const char *offs; /* -offset */
244 enum mdoc_list type; /* -tag, -enum, etc. */
245 int comp; /* -compact */
246 size_t ncols; /* -column arg count */
247 const char **cols; /* -column val ptr */
282 DISP_ragged, /* -ragged */
283 DISP_unfilled, /* -unfilled */
284 DISP_filled, /* -filled */
285 DISP_literal /* -literal */
286};
287
288enum mdoc_auth {
289 AUTH__NONE = 0,

--- 16 unchanged lines hidden (view full) ---

306
307struct mdoc_bl {
308 const char *width; /* -width */
309 const char *offs; /* -offset */
310 enum mdoc_list type; /* -tag, -enum, etc. */
311 int comp; /* -compact */
312 size_t ncols; /* -column arg count */
313 const char **cols; /* -column val ptr */
248 int count; /* -enum counter */
249};
250
251struct mdoc_bf {
252 enum mdoc_font font; /* font */
253};
254
255struct mdoc_an {
256 enum mdoc_auth auth; /* -split, etc. */

--- 4 unchanged lines hidden (view full) ---

261};
262
263/*
264 * Consists of normalised node arguments. These should be used instead
265 * of iterating through the mdoc_arg pointers of a node: defaults are
266 * provided, etc.
267 */
268union mdoc_data {
314};
315
316struct mdoc_bf {
317 enum mdoc_font font; /* font */
318};
319
320struct mdoc_an {
321 enum mdoc_auth auth; /* -split, etc. */

--- 4 unchanged lines hidden (view full) ---

326};
327
328/*
329 * Consists of normalised node arguments. These should be used instead
330 * of iterating through the mdoc_arg pointers of a node: defaults are
331 * provided, etc.
332 */
333union mdoc_data {
269 struct mdoc_an An;
334 struct mdoc_an An;
270 struct mdoc_bd Bd;
271 struct mdoc_bf Bf;
272 struct mdoc_bl Bl;
335 struct mdoc_bd Bd;
336 struct mdoc_bf Bf;
337 struct mdoc_bl Bl;
273 struct roff_node *Es;
274 struct mdoc_rs Rs;
275};
276
338 struct mdoc_rs Rs;
339};
340
277/* Names of macros. */
341/*
342 * Single node in tree-linked AST.
343 */
344struct mdoc_node {
345 struct mdoc_node *parent; /* parent AST node */
346 struct mdoc_node *child; /* first child AST node */
347 struct mdoc_node *last; /* last child AST node */
348 struct mdoc_node *next; /* sibling AST node */
349 struct mdoc_node *prev; /* prior sibling AST node */
350 int nchild; /* number children */
351 int line; /* parse line */
352 int pos; /* parse column */
353 enum mdoct tok; /* tok or MDOC__MAX if none */
354 int flags;
355#define MDOC_VALID (1 << 0) /* has been validated */
356#define MDOC_EOS (1 << 2) /* at sentence boundary */
357#define MDOC_LINE (1 << 3) /* first macro/text on line */
358#define MDOC_SYNPRETTY (1 << 4) /* SYNOPSIS-style formatting */
359#define MDOC_ENDED (1 << 5) /* rendering has been ended */
360#define MDOC_DELIMO (1 << 6)
361#define MDOC_DELIMC (1 << 7)
362 enum mdoc_type type; /* AST node type */
363 enum mdoc_sec sec; /* current named section */
364 union mdoc_data *norm; /* normalised args */
365 /* FIXME: these can be union'd to shave a few bytes. */
366 struct mdoc_arg *args; /* BLOCK/ELEM */
367 struct mdoc_node *pending; /* BLOCK */
368 struct mdoc_node *head; /* BLOCK */
369 struct mdoc_node *body; /* BLOCK */
370 struct mdoc_node *tail; /* BLOCK */
371 char *string; /* TEXT */
372 const struct tbl_span *span; /* TBL */
373 const struct eqn *eqn; /* EQN */
374 enum mdoc_endbody end; /* BODY */
375};
376
377/* Names of macros. Index is enum mdoct. */
278extern const char *const *mdoc_macronames;
279
280/* Names of macro args. Index is enum mdocargt. */
281extern const char *const *mdoc_argnames;
282
378extern const char *const *mdoc_macronames;
379
380/* Names of macro args. Index is enum mdocargt. */
381extern const char *const *mdoc_argnames;
382
383__BEGIN_DECLS
283
384
284void mdoc_validate(struct roff_man *);
385struct mdoc;
386
387const struct mdoc_node *mdoc_node(const struct mdoc *);
388const struct mdoc_meta *mdoc_meta(const struct mdoc *);
389
390__END_DECLS
391
392#endif /*!MDOC_H*/