Annotation of mandoc/mdoc.h, Revision 1.21
1.21 ! kristaps 1: /* $Id: mdoc.h,v 1.20 2009/01/12 12:52:21 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.16 kristaps 22: #define MDOC_LINEARG_MAX 12
1.1 kristaps 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
1.12 kristaps 192: #define MDOC_Emphasis 60
193: #define MDOC_Symbolic 61
194: #define MDOC_ARG_MAX 62
1.1 kristaps 195:
1.21 ! kristaps 196: /* FIXME: have these be generic groups. */
! 197:
1.1 kristaps 198: enum mdoc_err {
1.5 kristaps 199: ERR_SYNTAX_QUOTE, /* NOTUSED */
1.4 kristaps 200: ERR_SYNTAX_UNQUOTE,
1.8 kristaps 201: ERR_SYNTAX_NOPUNCT,
1.1 kristaps 202: ERR_SYNTAX_WS,
1.5 kristaps 203: ERR_SYNTAX_ARG,
204: ERR_SYNTAX_ARGFORM,
1.4 kristaps 205: ERR_SYNTAX_ARGVAL,
1.5 kristaps 206: ERR_SYNTAX_ARGBAD,
1.19 kristaps 207: ERR_SYNTAX_ARGMISS,
1.4 kristaps 208: ERR_SYNTAX_ARGMANY,
1.1 kristaps 209: ERR_MACRO_NOTSUP,
210: ERR_MACRO_NOTCALL,
211: ERR_SCOPE_BREAK,
1.4 kristaps 212: ERR_SCOPE_NOCTX,
1.5 kristaps 213: ERR_SCOPE_NONEST,
1.3 kristaps 214: ERR_SEC_PROLOGUE,
215: ERR_SEC_NPROLOGUE,
216: ERR_SEC_PROLOGUE_OO,
217: ERR_SEC_PROLOGUE_REP,
218: ERR_SEC_NAME,
1.8 kristaps 219: ERR_ARGS_EQ0,
1.9 kristaps 220: ERR_ARGS_EQ1,
1.3 kristaps 221: ERR_ARGS_GE1,
1.8 kristaps 222: ERR_ARGS_LE2,
1.16 kristaps 223: ERR_ARGS_LE8,
1.11 kristaps 224: ERR_ARGS_MANY,
1.19 kristaps 225: ERR_SYNTAX_CHILDBAD,
1.20 kristaps 226: ERR_SYNTAX_PARENTBAD,
1.13 kristaps 227: ERR_SYNTAX_CHILDHEAD,
228: ERR_SYNTAX_CHILDBODY,
229: ERR_SYNTAX_EMPTYBODY,
1.15 kristaps 230: ERR_SYNTAX_EMPTYHEAD,
231: ERR_SYNTAX_NOTEXT
1.1 kristaps 232: };
233:
1.8 kristaps 234: enum mdoc_att {
235: ATT_DEFAULT = 0,
236: ATT_v1,
237: ATT_v2,
238: ATT_v3,
239: ATT_v4,
240: ATT_v5,
241: ATT_v6,
242: ATT_v7,
243: ATT_32v,
244: ATT_V1,
245: ATT_V2,
246: ATT_V3,
247: ATT_V4
248: };
249:
1.1 kristaps 250: enum mdoc_warn {
251: WARN_SYNTAX_WS_EOLN,
252: WARN_SYNTAX_MACLIKE,
1.5 kristaps 253: WARN_SYNTAX_ARGLIKE,
254: WARN_SYNTAX_QUOTED,
1.20 kristaps 255: WARN_SYNTAX_EMPTYHEAD,
1.13 kristaps 256: WARN_SYNTAX_EMPTYBODY,
1.20 kristaps 257: WARN_SYNTAX_NOBODY,
1.5 kristaps 258: WARN_IGN_AFTER_BLK,
259: WARN_IGN_BEFORE_BLK,
1.10 kristaps 260: WARN_IGN_OBSOLETE,
1.3 kristaps 261: WARN_SEC_OO,
1.18 kristaps 262: WARN_SEC_REP,
1.4 kristaps 263: WARN_ARGS_GE1,
1.5 kristaps 264: WARN_ARGS_EQ0,
1.6 kristaps 265: WARN_COMPAT_TROFF
1.1 kristaps 266: };
267:
268: struct mdoc_arg {
269: int arg;
1.19 kristaps 270: int line;
271: int pos;
1.1 kristaps 272: size_t sz;
273: char **value;
274: };
275:
276: enum mdoc_type {
277: MDOC_TEXT,
278: MDOC_ELEM,
279: MDOC_HEAD,
1.14 kristaps 280: MDOC_TAIL,
1.1 kristaps 281: MDOC_BODY,
1.18 kristaps 282: MDOC_BLOCK,
283: MDOC_ROOT
1.1 kristaps 284: };
285:
1.2 kristaps 286: enum mdoc_msec {
1.3 kristaps 287: MSEC_DEFAULT = 0,
1.2 kristaps 288: MSEC_1,
289: MSEC_2,
290: MSEC_3,
291: MSEC_3f,
292: MSEC_3p,
293: MSEC_4,
294: MSEC_5,
295: MSEC_6,
296: MSEC_7,
297: MSEC_8,
298: MSEC_9,
299: MSEC_X11,
300: MSEC_X11R6,
301: MSEC_local,
302: MSEC_n,
303: MSEC_unass,
304: MSEC_draft,
1.3 kristaps 305: MSEC_paper
1.2 kristaps 306: };
307:
308: enum mdoc_sec {
1.3 kristaps 309: SEC_PROLOGUE = 0,
310: SEC_BODY,
1.2 kristaps 311: SEC_NAME,
312: SEC_SYNOPSIS,
313: SEC_DESCRIPTION,
314: SEC_RETURN_VALUES,
315: SEC_ENVIRONMENT,
316: SEC_FILES,
317: SEC_EXAMPLES,
318: SEC_DIAGNOSTICS,
319: SEC_ERRORS,
320: SEC_SEE_ALSO,
321: SEC_STANDARDS,
322: SEC_HISTORY,
323: SEC_AUTHORS,
324: SEC_CAVEATS,
325: SEC_BUGS,
326: SEC_CUSTOM
327: };
328:
329: enum mdoc_vol {
1.3 kristaps 330: VOL_DEFAULT = 0,
1.2 kristaps 331: VOL_AMD,
332: VOL_IND,
333: VOL_KM,
334: VOL_LOCAL,
335: VOL_PRM,
336: VOL_PS1,
337: VOL_SMM,
338: VOL_URM,
1.3 kristaps 339: VOL_USD
1.2 kristaps 340: };
341:
342: enum mdoc_arch {
1.3 kristaps 343: ARCH_DEFAULT = 0,
1.2 kristaps 344: ARCH_alpha,
345: ARCH_amd64,
346: ARCH_amiga,
347: ARCH_arc,
348: ARCH_armish,
349: ARCH_aviion,
350: ARCH_hp300,
351: ARCH_hppa,
352: ARCH_hppa64,
353: ARCH_i386,
354: ARCH_landisk,
355: ARCH_luna88k,
356: ARCH_mac68k,
357: ARCH_macppc,
358: ARCH_mvme68k,
359: ARCH_mvme88k,
360: ARCH_mvmeppc,
361: ARCH_pmax,
362: ARCH_sgi,
363: ARCH_socppc,
364: ARCH_sparc,
365: ARCH_sparc64,
366: ARCH_sun3,
367: ARCH_vax,
1.3 kristaps 368: ARCH_zaurus
1.2 kristaps 369: };
370:
371: struct mdoc_meta {
372: enum mdoc_msec msec;
373: enum mdoc_vol vol;
374: enum mdoc_arch arch;
1.3 kristaps 375: time_t date;
376: #define META_TITLE_SZ (64)
377: char title[META_TITLE_SZ];
1.4 kristaps 378: #define META_OS_SZ (64)
379: char os[META_OS_SZ];
1.2 kristaps 380: };
381:
1.1 kristaps 382: struct mdoc_text {
383: char *string;
384: };
385:
386: struct mdoc_block {
387: size_t argc;
388: struct mdoc_arg *argv;
1.20 kristaps 389: struct mdoc_node *head;
390: struct mdoc_node *body;
391: struct mdoc_node *tail;
1.1 kristaps 392: };
393:
394: struct mdoc_elem {
395: size_t sz;
396: char **args;
397: size_t argc;
398: struct mdoc_arg *argv;
399: };
400:
401: union mdoc_data {
402: struct mdoc_text text;
403: struct mdoc_elem elem;
404: struct mdoc_block block;
405: };
406:
407: struct mdoc_node {
408: struct mdoc_node *parent;
409: struct mdoc_node *child;
410: struct mdoc_node *next;
1.5 kristaps 411: struct mdoc_node *prev;
1.16 kristaps 412: int line;
413: int pos;
1.20 kristaps 414: int tok;
1.1 kristaps 415: enum mdoc_type type;
416: union mdoc_data data;
417: };
418:
419: struct mdoc_cb {
420: int (*mdoc_err)(void *, int, int, enum mdoc_err);
421: int (*mdoc_warn)(void *, int, int, enum mdoc_warn);
1.17 kristaps 422: void (*mdoc_msg)(void *, int, int, const char *);
1.1 kristaps 423: };
424:
425: extern const char *const *mdoc_macronames;
426: extern const char *const *mdoc_argnames;
427:
428: __BEGIN_DECLS
429:
430: struct mdoc;
431:
432: void mdoc_free(struct mdoc *);
433: struct mdoc *mdoc_alloc(void *data, const struct mdoc_cb *);
1.16 kristaps 434: int mdoc_parseln(struct mdoc *, int, char *buf);
1.1 kristaps 435: const struct mdoc_node
436: *mdoc_result(struct mdoc *);
1.16 kristaps 437: int mdoc_endparse(struct mdoc *);
1.1 kristaps 438:
1.21 ! kristaps 439: char *mdoc_type2a(enum mdoc_type);
! 440:
1.1 kristaps 441: __END_DECLS
442:
443: #endif /*!MDOC_H*/
CVSweb