Annotation of mandoc/mdoc.h, Revision 1.67
1.67 ! kristaps 1: /* $Id: mdoc.h,v 1.66 2009/07/17 10:56:57 kristaps Exp $ */
1.1 kristaps 2: /*
1.57 kristaps 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.56 kristaps 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.56 kristaps 9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
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.
1.1 kristaps 16: */
17: #ifndef MDOC_H
18: #define MDOC_H
19:
1.44 kristaps 20: #include <time.h>
21:
1.33 kristaps 22: /*
23: * This library implements a validating scanner/parser for ``mdoc'' roff
24: * macro documents, a.k.a. BSD manual page documents. The mdoc.c file
25: * drives the parser, while macro.c describes the macro ontologies.
26: * validate.c pre- and post-validates parsed macros, and action.c
27: * performs actions on parsed and validated macros.
28: */
29:
1.22 kristaps 30: /* What follows is a list of ALL possible macros. */
31:
1.59 kristaps 32: #define MDOC_Ap 0
1.1 kristaps 33: #define MDOC_Dd 1
34: #define MDOC_Dt 2
35: #define MDOC_Os 3
36: #define MDOC_Sh 4
37: #define MDOC_Ss 5
38: #define MDOC_Pp 6
39: #define MDOC_D1 7
40: #define MDOC_Dl 8
41: #define MDOC_Bd 9
42: #define MDOC_Ed 10
43: #define MDOC_Bl 11
44: #define MDOC_El 12
45: #define MDOC_It 13
46: #define MDOC_Ad 14
47: #define MDOC_An 15
48: #define MDOC_Ar 16
49: #define MDOC_Cd 17
50: #define MDOC_Cm 18
51: #define MDOC_Dv 19
52: #define MDOC_Er 20
53: #define MDOC_Ev 21
54: #define MDOC_Ex 22
55: #define MDOC_Fa 23
56: #define MDOC_Fd 24
57: #define MDOC_Fl 25
58: #define MDOC_Fn 26
59: #define MDOC_Ft 27
60: #define MDOC_Ic 28
61: #define MDOC_In 29
62: #define MDOC_Li 30
63: #define MDOC_Nd 31
64: #define MDOC_Nm 32
65: #define MDOC_Op 33
66: #define MDOC_Ot 34
67: #define MDOC_Pa 35
68: #define MDOC_Rv 36
69: #define MDOC_St 37
70: #define MDOC_Va 38
71: #define MDOC_Vt 39
72: #define MDOC_Xr 40
73: #define MDOC__A 41
74: #define MDOC__B 42
75: #define MDOC__D 43
76: #define MDOC__I 44
77: #define MDOC__J 45
78: #define MDOC__N 46
79: #define MDOC__O 47
80: #define MDOC__P 48
81: #define MDOC__R 49
82: #define MDOC__T 50
83: #define MDOC__V 51
84: #define MDOC_Ac 52
85: #define MDOC_Ao 53
86: #define MDOC_Aq 54
87: #define MDOC_At 55
88: #define MDOC_Bc 56
89: #define MDOC_Bf 57
90: #define MDOC_Bo 58
91: #define MDOC_Bq 59
92: #define MDOC_Bsx 60
93: #define MDOC_Bx 61
94: #define MDOC_Db 62
95: #define MDOC_Dc 63
96: #define MDOC_Do 64
97: #define MDOC_Dq 65
98: #define MDOC_Ec 66
99: #define MDOC_Ef 67
100: #define MDOC_Em 68
101: #define MDOC_Eo 69
102: #define MDOC_Fx 70
103: #define MDOC_Ms 71
104: #define MDOC_No 72
105: #define MDOC_Ns 73
106: #define MDOC_Nx 74
107: #define MDOC_Ox 75
108: #define MDOC_Pc 76
109: #define MDOC_Pf 77
110: #define MDOC_Po 78
111: #define MDOC_Pq 79
112: #define MDOC_Qc 80
113: #define MDOC_Ql 81
114: #define MDOC_Qo 82
115: #define MDOC_Qq 83
116: #define MDOC_Re 84
117: #define MDOC_Rs 85
118: #define MDOC_Sc 86
119: #define MDOC_So 87
120: #define MDOC_Sq 88
121: #define MDOC_Sm 89
122: #define MDOC_Sx 90
123: #define MDOC_Sy 91
124: #define MDOC_Tn 92
125: #define MDOC_Ux 93
126: #define MDOC_Xc 94
127: #define MDOC_Xo 95
128: #define MDOC_Fo 96
129: #define MDOC_Fc 97
130: #define MDOC_Oo 98
131: #define MDOC_Oc 99
132: #define MDOC_Bk 100
133: #define MDOC_Ek 101
134: #define MDOC_Bt 102
135: #define MDOC_Hf 103
136: #define MDOC_Fr 104
137: #define MDOC_Ud 105
1.37 kristaps 138: #define MDOC_Lb 106
1.59 kristaps 139: #define MDOC_Lp 107
140: #define MDOC_Lk 108
141: #define MDOC_Mt 109
142: #define MDOC_Brq 110
143: #define MDOC_Bro 111
144: #define MDOC_Brc 112
145: #define MDOC__C 113
146: #define MDOC_Es 114
147: #define MDOC_En 115
148: #define MDOC_Dx 116
149: #define MDOC__Q 117
1.66 kristaps 150: #define MDOC_br 118
151: #define MDOC_sp 119
152: #define MDOC_MAX 120
1.1 kristaps 153:
1.22 kristaps 154: /* What follows is a list of ALL possible macro arguments. */
155:
1.1 kristaps 156: #define MDOC_Split 0
157: #define MDOC_Nosplit 1
158: #define MDOC_Ragged 2
159: #define MDOC_Unfilled 3
160: #define MDOC_Literal 4
161: #define MDOC_File 5
162: #define MDOC_Offset 6
163: #define MDOC_Bullet 7
164: #define MDOC_Dash 8
165: #define MDOC_Hyphen 9
166: #define MDOC_Item 10
167: #define MDOC_Enum 11
168: #define MDOC_Tag 12
169: #define MDOC_Diag 13
170: #define MDOC_Hang 14
171: #define MDOC_Ohang 15
172: #define MDOC_Inset 16
173: #define MDOC_Column 17
174: #define MDOC_Width 18
175: #define MDOC_Compact 19
176: #define MDOC_Std 20
1.37 kristaps 177: #define MDOC_Filled 21
178: #define MDOC_Words 22
179: #define MDOC_Emphasis 23
180: #define MDOC_Symbolic 24
1.47 kristaps 181: #define MDOC_Nested 25
182: #define MDOC_ARG_MAX 26
1.1 kristaps 183:
1.23 kristaps 184: /* Type of a syntax node. */
1.1 kristaps 185: enum mdoc_type {
186: MDOC_TEXT,
187: MDOC_ELEM,
188: MDOC_HEAD,
1.14 kristaps 189: MDOC_TAIL,
1.1 kristaps 190: MDOC_BODY,
1.18 kristaps 191: MDOC_BLOCK,
192: MDOC_ROOT
1.1 kristaps 193: };
194:
1.37 kristaps 195: /* Section (named/unnamed) of `Sh'. */
1.2 kristaps 196: enum mdoc_sec {
1.60 kristaps 197: SEC_NONE, /* No section, yet. */
198: SEC_NAME,
199: SEC_LIBRARY,
200: SEC_SYNOPSIS,
201: SEC_DESCRIPTION,
202: SEC_IMPLEMENTATION,
203: SEC_RETURN_VALUES,
204: SEC_ENVIRONMENT,
205: SEC_FILES,
206: SEC_EXAMPLES,
207: SEC_DIAGNOSTICS,
208: SEC_COMPATIBILITY,
209: SEC_ERRORS,
210: SEC_SEE_ALSO,
211: SEC_STANDARDS,
212: SEC_HISTORY,
213: SEC_AUTHORS,
214: SEC_CAVEATS,
215: SEC_BUGS,
216: SEC_CUSTOM /* User-defined. */
1.2 kristaps 217: };
218:
1.29 kristaps 219: /* Information from prologue. */
1.2 kristaps 220: struct mdoc_meta {
1.37 kristaps 221: int msec;
222: char *vol;
223: char *arch;
1.3 kristaps 224: time_t date;
1.25 kristaps 225: char *title;
226: char *os;
227: char *name;
1.2 kristaps 228: };
229:
1.38 kristaps 230: /* An argument to a macro (multiple values = `It -column'). */
231: struct mdoc_argv {
232: int arg;
233: int line;
234: int pos;
235: size_t sz;
236: char **value;
1.1 kristaps 237: };
238:
1.38 kristaps 239: struct mdoc_arg {
1.1 kristaps 240: size_t argc;
1.38 kristaps 241: struct mdoc_argv *argv;
242: unsigned int refcnt;
1.1 kristaps 243: };
244:
1.29 kristaps 245: /* Node in AST. */
1.1 kristaps 246: struct mdoc_node {
247: struct mdoc_node *parent;
248: struct mdoc_node *child;
249: struct mdoc_node *next;
1.5 kristaps 250: struct mdoc_node *prev;
1.61 kristaps 251: int nchild;
1.16 kristaps 252: int line;
253: int pos;
1.20 kristaps 254: int tok;
1.26 kristaps 255: int flags;
256: #define MDOC_VALID (1 << 0)
257: #define MDOC_ACTED (1 << 1)
1.1 kristaps 258: enum mdoc_type type;
1.31 kristaps 259: enum mdoc_sec sec;
1.40 kristaps 260:
1.38 kristaps 261: struct mdoc_arg *args; /* BLOCK/ELEM */
262: struct mdoc_node *head; /* BLOCK */
263: struct mdoc_node *body; /* BLOCK */
264: struct mdoc_node *tail; /* BLOCK */
265: char *string; /* TEXT */
1.1 kristaps 266: };
267:
1.40 kristaps 268: #define MDOC_IGN_SCOPE (1 << 0) /* Ignore scope violations. */
269: #define MDOC_IGN_ESCAPE (1 << 1) /* Ignore bad escape sequences. */
1.43 kristaps 270: #define MDOC_IGN_MACRO (1 << 2) /* Ignore unknown macros. */
1.55 kristaps 271: #define MDOC_IGN_CHARS (1 << 3) /* Ignore disallowed chars. */
1.38 kristaps 272:
1.23 kristaps 273: /* Call-backs for parse messages. */
1.67 ! kristaps 274:
1.1 kristaps 275: struct mdoc_cb {
1.22 kristaps 276: int (*mdoc_err)(void *, int, int, const char *);
1.62 kristaps 277: int (*mdoc_warn)(void *, int, int, const char *);
1.1 kristaps 278: };
279:
1.60 kristaps 280: /* See mdoc.3 for documentation. */
281:
1.1 kristaps 282: extern const char *const *mdoc_macronames;
283: extern const char *const *mdoc_argnames;
284:
285: __BEGIN_DECLS
286:
287: struct mdoc;
288:
1.60 kristaps 289: /* See mdoc.3 for documentation. */
290:
1.1 kristaps 291: void mdoc_free(struct mdoc *);
1.40 kristaps 292: struct mdoc *mdoc_alloc(void *, int, const struct mdoc_cb *);
1.54 kristaps 293: int mdoc_reset(struct mdoc *);
1.16 kristaps 294: int mdoc_parseln(struct mdoc *, int, char *buf);
1.32 kristaps 295: const struct mdoc_node *mdoc_node(const struct mdoc *);
296: const struct mdoc_meta *mdoc_meta(const struct mdoc *);
1.16 kristaps 297: int mdoc_endparse(struct mdoc *);
1.1 kristaps 298:
299: __END_DECLS
300:
301: #endif /*!MDOC_H*/
CVSweb