Annotation of mandoc/mdoc.h, Revision 1.5
1.5 ! kristaps 1: /* $Id: mdoc.h,v 1.4 2008/12/23 05:30:49 kristaps Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
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
7: * above copyright notice and this permission notice appear in all
8: * copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11: * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12: * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13: * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14: * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15: * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16: * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17: * PERFORMANCE OF THIS SOFTWARE.
18: */
19: #ifndef MDOC_H
20: #define MDOC_H
21:
22: #define MDOC_LINEARG_MAX 9
23:
24: #define MDOC___ 0
25: #define MDOC_Dd 1
26: #define MDOC_Dt 2
27: #define MDOC_Os 3
28: #define MDOC_Sh 4
29: #define MDOC_Ss 5
30: #define MDOC_Pp 6
31: #define MDOC_D1 7
32: #define MDOC_Dl 8
33: #define MDOC_Bd 9
34: #define MDOC_Ed 10
35: #define MDOC_Bl 11
36: #define MDOC_El 12
37: #define MDOC_It 13
38: #define MDOC_Ad 14
39: #define MDOC_An 15
40: #define MDOC_Ar 16
41: #define MDOC_Cd 17
42: #define MDOC_Cm 18
43: #define MDOC_Dv 19
44: #define MDOC_Er 20
45: #define MDOC_Ev 21
46: #define MDOC_Ex 22
47: #define MDOC_Fa 23
48: #define MDOC_Fd 24
49: #define MDOC_Fl 25
50: #define MDOC_Fn 26
51: #define MDOC_Ft 27
52: #define MDOC_Ic 28
53: #define MDOC_In 29
54: #define MDOC_Li 30
55: #define MDOC_Nd 31
56: #define MDOC_Nm 32
57: #define MDOC_Op 33
58: #define MDOC_Ot 34
59: #define MDOC_Pa 35
60: #define MDOC_Rv 36
61: #define MDOC_St 37
62: #define MDOC_Va 38
63: #define MDOC_Vt 39
64: #define MDOC_Xr 40
65: #define MDOC__A 41
66: #define MDOC__B 42
67: #define MDOC__D 43
68: #define MDOC__I 44
69: #define MDOC__J 45
70: #define MDOC__N 46
71: #define MDOC__O 47
72: #define MDOC__P 48
73: #define MDOC__R 49
74: #define MDOC__T 50
75: #define MDOC__V 51
76: #define MDOC_Ac 52
77: #define MDOC_Ao 53
78: #define MDOC_Aq 54
79: #define MDOC_At 55
80: #define MDOC_Bc 56
81: #define MDOC_Bf 57
82: #define MDOC_Bo 58
83: #define MDOC_Bq 59
84: #define MDOC_Bsx 60
85: #define MDOC_Bx 61
86: #define MDOC_Db 62
87: #define MDOC_Dc 63
88: #define MDOC_Do 64
89: #define MDOC_Dq 65
90: #define MDOC_Ec 66
91: #define MDOC_Ef 67
92: #define MDOC_Em 68
93: #define MDOC_Eo 69
94: #define MDOC_Fx 70
95: #define MDOC_Ms 71
96: #define MDOC_No 72
97: #define MDOC_Ns 73
98: #define MDOC_Nx 74
99: #define MDOC_Ox 75
100: #define MDOC_Pc 76
101: #define MDOC_Pf 77
102: #define MDOC_Po 78
103: #define MDOC_Pq 79
104: #define MDOC_Qc 80
105: #define MDOC_Ql 81
106: #define MDOC_Qo 82
107: #define MDOC_Qq 83
108: #define MDOC_Re 84
109: #define MDOC_Rs 85
110: #define MDOC_Sc 86
111: #define MDOC_So 87
112: #define MDOC_Sq 88
113: #define MDOC_Sm 89
114: #define MDOC_Sx 90
115: #define MDOC_Sy 91
116: #define MDOC_Tn 92
117: #define MDOC_Ux 93
118: #define MDOC_Xc 94
119: #define MDOC_Xo 95
120: #define MDOC_Fo 96
121: #define MDOC_Fc 97
122: #define MDOC_Oo 98
123: #define MDOC_Oc 99
124: #define MDOC_Bk 100
125: #define MDOC_Ek 101
126: #define MDOC_Bt 102
127: #define MDOC_Hf 103
128: #define MDOC_Fr 104
129: #define MDOC_Ud 105
130: #define MDOC_MAX 106
131:
132: #define MDOC_Split 0
133: #define MDOC_Nosplit 1
134: #define MDOC_Ragged 2
135: #define MDOC_Unfilled 3
136: #define MDOC_Literal 4
137: #define MDOC_File 5
138: #define MDOC_Offset 6
139: #define MDOC_Bullet 7
140: #define MDOC_Dash 8
141: #define MDOC_Hyphen 9
142: #define MDOC_Item 10
143: #define MDOC_Enum 11
144: #define MDOC_Tag 12
145: #define MDOC_Diag 13
146: #define MDOC_Hang 14
147: #define MDOC_Ohang 15
148: #define MDOC_Inset 16
149: #define MDOC_Column 17
150: #define MDOC_Width 18
151: #define MDOC_Compact 19
152: #define MDOC_Std 20
153: #define MDOC_p1003_1_88 21
154: #define MDOC_p1003_1_90 22
155: #define MDOC_p1003_1_96 23
156: #define MDOC_p1003_1_2001 24
157: #define MDOC_p1003_1_2004 25
158: #define MDOC_p1003_1 26
159: #define MDOC_p1003_1b 27
160: #define MDOC_p1003_1b_93 28
161: #define MDOC_p1003_1c_95 29
162: #define MDOC_p1003_1g_2000 30
163: #define MDOC_p1003_2_92 31
164: #define MDOC_p1387_2_95 32
165: #define MDOC_p1003_2 33
166: #define MDOC_p1387_2 34
167: #define MDOC_isoC_90 35
168: #define MDOC_isoC_amd1 36
169: #define MDOC_isoC_tcor1 37
170: #define MDOC_isoC_tcor2 38
171: #define MDOC_isoC_99 39
172: #define MDOC_ansiC 40
173: #define MDOC_ansiC_89 41
174: #define MDOC_ansiC_99 42
175: #define MDOC_ieee754 43
176: #define MDOC_iso8802_3 44
177: #define MDOC_xpg3 45
178: #define MDOC_xpg4 46
179: #define MDOC_xpg4_2 47
180: #define MDOC_xpg4_3 48
181: #define MDOC_xbd5 49
182: #define MDOC_xcu5 50
183: #define MDOC_xsh5 51
184: #define MDOC_xns5 52
185: #define MDOC_xns5_2d2_0 53
186: #define MDOC_xcurses4_2 54
187: #define MDOC_susv2 55
188: #define MDOC_susv3 56
189: #define MDOC_svid4 57
190: #define MDOC_Filled 58
191: #define MDOC_Words 59
192: #define MDOC_ARG_MAX 60
193:
194: enum mdoc_err {
1.5 ! kristaps 195: ERR_SYNTAX_QUOTE, /* NOTUSED */
1.4 kristaps 196: ERR_SYNTAX_UNQUOTE,
1.1 kristaps 197: ERR_SYNTAX_WS,
1.5 ! kristaps 198: ERR_SYNTAX_ARG,
! 199: ERR_SYNTAX_ARGFORM,
1.4 kristaps 200: ERR_SYNTAX_ARGVAL,
1.5 ! kristaps 201: ERR_SYNTAX_ARGBAD,
1.4 kristaps 202: ERR_SYNTAX_ARGMANY,
1.1 kristaps 203: ERR_MACRO_NOTSUP,
204: ERR_MACRO_NOTCALL,
205: ERR_SCOPE_BREAK,
1.4 kristaps 206: ERR_SCOPE_NOCTX,
1.5 ! kristaps 207: ERR_SCOPE_NONEST,
1.3 kristaps 208: ERR_SEC_PROLOGUE,
209: ERR_SEC_NPROLOGUE,
210: ERR_SEC_PROLOGUE_OO,
211: ERR_SEC_PROLOGUE_REP,
212: ERR_SEC_NAME,
213: ERR_ARGS_GE1,
214: ERR_ARGS_MANY
1.1 kristaps 215: };
216:
217: enum mdoc_warn {
218: WARN_SYNTAX_WS_EOLN,
219: WARN_SYNTAX_MACLIKE,
1.5 ! kristaps 220: WARN_SYNTAX_ARGLIKE,
! 221: WARN_SYNTAX_QUOTED,
! 222: WARN_IGN_AFTER_BLK,
! 223: WARN_IGN_BEFORE_BLK,
1.3 kristaps 224: WARN_SEC_OO,
1.4 kristaps 225: WARN_ARGS_GE1,
1.5 ! kristaps 226: WARN_ARGS_EQ0,
1.1 kristaps 227: };
228:
229: struct mdoc_arg {
230: int arg;
231: size_t sz;
232: char **value;
233: };
234:
235: enum mdoc_type {
236: MDOC_TEXT,
237: MDOC_ELEM,
238: MDOC_HEAD,
239: MDOC_BODY,
240: MDOC_BLOCK
241: };
242:
1.2 kristaps 243: enum mdoc_msec {
1.3 kristaps 244: MSEC_DEFAULT = 0,
1.2 kristaps 245: MSEC_1,
246: MSEC_2,
247: MSEC_3,
248: MSEC_3f,
249: MSEC_3p,
250: MSEC_4,
251: MSEC_5,
252: MSEC_6,
253: MSEC_7,
254: MSEC_8,
255: MSEC_9,
256: MSEC_X11,
257: MSEC_X11R6,
258: MSEC_local,
259: MSEC_n,
260: MSEC_unass,
261: MSEC_draft,
1.3 kristaps 262: MSEC_paper
1.2 kristaps 263: };
264:
265: enum mdoc_sec {
1.3 kristaps 266: SEC_PROLOGUE = 0,
267: SEC_BODY,
1.2 kristaps 268: SEC_NAME,
269: SEC_SYNOPSIS,
270: SEC_DESCRIPTION,
271: SEC_RETURN_VALUES,
272: SEC_ENVIRONMENT,
273: SEC_FILES,
274: SEC_EXAMPLES,
275: SEC_DIAGNOSTICS,
276: SEC_ERRORS,
277: SEC_SEE_ALSO,
278: SEC_STANDARDS,
279: SEC_HISTORY,
280: SEC_AUTHORS,
281: SEC_CAVEATS,
282: SEC_BUGS,
283: SEC_CUSTOM
284: };
285:
286: enum mdoc_vol {
1.3 kristaps 287: VOL_DEFAULT = 0,
1.2 kristaps 288: VOL_AMD,
289: VOL_IND,
290: VOL_KM,
291: VOL_LOCAL,
292: VOL_PRM,
293: VOL_PS1,
294: VOL_SMM,
295: VOL_URM,
1.3 kristaps 296: VOL_USD
1.2 kristaps 297: };
298:
299: enum mdoc_arch {
1.3 kristaps 300: ARCH_DEFAULT = 0,
1.2 kristaps 301: ARCH_alpha,
302: ARCH_amd64,
303: ARCH_amiga,
304: ARCH_arc,
305: ARCH_armish,
306: ARCH_aviion,
307: ARCH_hp300,
308: ARCH_hppa,
309: ARCH_hppa64,
310: ARCH_i386,
311: ARCH_landisk,
312: ARCH_luna88k,
313: ARCH_mac68k,
314: ARCH_macppc,
315: ARCH_mvme68k,
316: ARCH_mvme88k,
317: ARCH_mvmeppc,
318: ARCH_pmax,
319: ARCH_sgi,
320: ARCH_socppc,
321: ARCH_sparc,
322: ARCH_sparc64,
323: ARCH_sun3,
324: ARCH_vax,
1.3 kristaps 325: ARCH_zaurus
1.2 kristaps 326: };
327:
328: struct mdoc_meta {
329: enum mdoc_msec msec;
330: enum mdoc_vol vol;
331: enum mdoc_arch arch;
1.3 kristaps 332: time_t date;
333: #define META_TITLE_SZ (64)
334: char title[META_TITLE_SZ];
1.4 kristaps 335: #define META_OS_SZ (64)
336: char os[META_OS_SZ];
1.2 kristaps 337: };
338:
1.1 kristaps 339: struct mdoc_text {
340: char *string;
341: };
342:
343: struct mdoc_block {
344: int tok;
345: size_t argc;
346: struct mdoc_arg *argv;
347: };
348:
349: struct mdoc_head {
350: size_t sz;
351: char **args;
352: int tok;
353: };
354:
355: struct mdoc_body {
356: int tok;
357: };
358:
359: struct mdoc_elem {
360: size_t sz;
361: char **args;
362: int tok;
363: size_t argc;
364: struct mdoc_arg *argv;
365: };
366:
367: union mdoc_data {
368: struct mdoc_text text;
369: struct mdoc_elem elem;
370: struct mdoc_body body;
371: struct mdoc_head head;
372: struct mdoc_block block;
373: };
374:
375: struct mdoc_node {
376: struct mdoc_node *parent;
377: struct mdoc_node *child;
378: struct mdoc_node *next;
1.5 ! kristaps 379: struct mdoc_node *prev;
1.1 kristaps 380: enum mdoc_type type;
381: union mdoc_data data;
382: };
383:
384: struct mdoc_cb {
385: int (*mdoc_err)(void *, int, int, enum mdoc_err);
386: int (*mdoc_warn)(void *, int, int, enum mdoc_warn);
387: void (*mdoc_msg)(void *, int, const char *);
388: };
389:
390: extern const char *const *mdoc_macronames;
391: extern const char *const *mdoc_argnames;
392:
393: __BEGIN_DECLS
394:
395: struct mdoc;
396:
397: void mdoc_free(struct mdoc *);
398: struct mdoc *mdoc_alloc(void *data, const struct mdoc_cb *);
399: int mdoc_parseln(struct mdoc *, char *buf);
400: const struct mdoc_node
401: *mdoc_result(struct mdoc *);
402:
403: __END_DECLS
404:
405: #endif /*!MDOC_H*/
CVSweb