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