Annotation of mandoc/mdoc.h, Revision 1.44
1.44 ! kristaps 1: /* $Id: mdoc.h,v 1.43 2009/03/09 13:04:01 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.44 ! kristaps 22: #include <time.h>
! 23:
1.33 kristaps 24: /*
25: * This library implements a validating scanner/parser for ``mdoc'' roff
26: * macro documents, a.k.a. BSD manual page documents. The mdoc.c file
27: * drives the parser, while macro.c describes the macro ontologies.
28: * validate.c pre- and post-validates parsed macros, and action.c
29: * performs actions on parsed and validated macros.
30: */
31:
1.22 kristaps 32: /* What follows is a list of ALL possible macros. */
33:
1.39 kristaps 34: /* TODO: Brq et al. */
35:
1.1 kristaps 36: #define MDOC___ 0
37: #define MDOC_Dd 1
38: #define MDOC_Dt 2
39: #define MDOC_Os 3
40: #define MDOC_Sh 4
41: #define MDOC_Ss 5
42: #define MDOC_Pp 6
43: #define MDOC_D1 7
44: #define MDOC_Dl 8
45: #define MDOC_Bd 9
46: #define MDOC_Ed 10
47: #define MDOC_Bl 11
48: #define MDOC_El 12
49: #define MDOC_It 13
50: #define MDOC_Ad 14
51: #define MDOC_An 15
52: #define MDOC_Ar 16
53: #define MDOC_Cd 17
54: #define MDOC_Cm 18
55: #define MDOC_Dv 19
56: #define MDOC_Er 20
57: #define MDOC_Ev 21
58: #define MDOC_Ex 22
59: #define MDOC_Fa 23
60: #define MDOC_Fd 24
61: #define MDOC_Fl 25
62: #define MDOC_Fn 26
63: #define MDOC_Ft 27
64: #define MDOC_Ic 28
65: #define MDOC_In 29
66: #define MDOC_Li 30
67: #define MDOC_Nd 31
68: #define MDOC_Nm 32
69: #define MDOC_Op 33
70: #define MDOC_Ot 34
71: #define MDOC_Pa 35
72: #define MDOC_Rv 36
73: #define MDOC_St 37
74: #define MDOC_Va 38
75: #define MDOC_Vt 39
76: #define MDOC_Xr 40
77: #define MDOC__A 41
78: #define MDOC__B 42
79: #define MDOC__D 43
80: #define MDOC__I 44
81: #define MDOC__J 45
82: #define MDOC__N 46
83: #define MDOC__O 47
84: #define MDOC__P 48
85: #define MDOC__R 49
86: #define MDOC__T 50
87: #define MDOC__V 51
88: #define MDOC_Ac 52
89: #define MDOC_Ao 53
90: #define MDOC_Aq 54
91: #define MDOC_At 55
92: #define MDOC_Bc 56
93: #define MDOC_Bf 57
94: #define MDOC_Bo 58
95: #define MDOC_Bq 59
96: #define MDOC_Bsx 60
97: #define MDOC_Bx 61
98: #define MDOC_Db 62
99: #define MDOC_Dc 63
100: #define MDOC_Do 64
101: #define MDOC_Dq 65
102: #define MDOC_Ec 66
103: #define MDOC_Ef 67
104: #define MDOC_Em 68
105: #define MDOC_Eo 69
106: #define MDOC_Fx 70
107: #define MDOC_Ms 71
108: #define MDOC_No 72
109: #define MDOC_Ns 73
110: #define MDOC_Nx 74
111: #define MDOC_Ox 75
112: #define MDOC_Pc 76
113: #define MDOC_Pf 77
114: #define MDOC_Po 78
115: #define MDOC_Pq 79
116: #define MDOC_Qc 80
117: #define MDOC_Ql 81
118: #define MDOC_Qo 82
119: #define MDOC_Qq 83
120: #define MDOC_Re 84
121: #define MDOC_Rs 85
122: #define MDOC_Sc 86
123: #define MDOC_So 87
124: #define MDOC_Sq 88
125: #define MDOC_Sm 89
126: #define MDOC_Sx 90
127: #define MDOC_Sy 91
128: #define MDOC_Tn 92
129: #define MDOC_Ux 93
130: #define MDOC_Xc 94
131: #define MDOC_Xo 95
132: #define MDOC_Fo 96
133: #define MDOC_Fc 97
134: #define MDOC_Oo 98
135: #define MDOC_Oc 99
136: #define MDOC_Bk 100
137: #define MDOC_Ek 101
138: #define MDOC_Bt 102
139: #define MDOC_Hf 103
140: #define MDOC_Fr 104
141: #define MDOC_Ud 105
1.37 kristaps 142: #define MDOC_Lb 106
1.41 kristaps 143: #define MDOC_Ap 107
1.42 kristaps 144: #define MDOC_Lp 108
145: #define MDOC_MAX 109
1.1 kristaps 146:
1.22 kristaps 147: /* What follows is a list of ALL possible macro arguments. */
148:
1.1 kristaps 149: #define MDOC_Split 0
150: #define MDOC_Nosplit 1
151: #define MDOC_Ragged 2
152: #define MDOC_Unfilled 3
153: #define MDOC_Literal 4
154: #define MDOC_File 5
155: #define MDOC_Offset 6
156: #define MDOC_Bullet 7
157: #define MDOC_Dash 8
158: #define MDOC_Hyphen 9
159: #define MDOC_Item 10
160: #define MDOC_Enum 11
161: #define MDOC_Tag 12
162: #define MDOC_Diag 13
163: #define MDOC_Hang 14
164: #define MDOC_Ohang 15
165: #define MDOC_Inset 16
166: #define MDOC_Column 17
167: #define MDOC_Width 18
168: #define MDOC_Compact 19
169: #define MDOC_Std 20
1.37 kristaps 170: #define MDOC_Filled 21
171: #define MDOC_Words 22
172: #define MDOC_Emphasis 23
173: #define MDOC_Symbolic 24
174: #define MDOC_ARG_MAX 25
1.1 kristaps 175:
1.29 kristaps 176: /* Warnings are either syntax or groff-compatibility. */
1.22 kristaps 177: enum mdoc_warn {
1.29 kristaps 178: WARN_SYNTAX,
179: WARN_COMPAT
1.1 kristaps 180: };
181:
1.23 kristaps 182: /* Type of a syntax node. */
1.1 kristaps 183: enum mdoc_type {
184: MDOC_TEXT,
185: MDOC_ELEM,
186: MDOC_HEAD,
1.14 kristaps 187: MDOC_TAIL,
1.1 kristaps 188: MDOC_BODY,
1.18 kristaps 189: MDOC_BLOCK,
190: MDOC_ROOT
1.1 kristaps 191: };
192:
1.37 kristaps 193: /* Section (named/unnamed) of `Sh'. */
1.2 kristaps 194: enum mdoc_sec {
1.37 kristaps 195: SEC_PROLOGUE = 0,
196: SEC_BODY = 1,
197: SEC_NAME = 2,
198: SEC_LIBRARY = 3,
199: SEC_SYNOPSIS = 4,
200: SEC_DESCRIPTION = 5,
201: SEC_IMPLEMENTATION = 6,
202: SEC_RETURN_VALUES = 7,
203: SEC_ENVIRONMENT = 8,
204: SEC_FILES = 9,
205: SEC_EXAMPLES = 10,
206: SEC_DIAGNOSTICS = 11,
207: SEC_COMPATIBILITY = 12,
208: SEC_ERRORS = 13,
209: SEC_SEE_ALSO = 14,
210: SEC_STANDARDS = 15,
211: SEC_HISTORY = 16,
212: SEC_AUTHORS = 17,
213: SEC_CAVEATS = 18,
214: SEC_BUGS = 19,
1.2 kristaps 215: SEC_CUSTOM
216: };
217:
1.29 kristaps 218: /* Information from prologue. */
1.2 kristaps 219: struct mdoc_meta {
1.37 kristaps 220: int msec;
221: char *vol;
222: char *arch;
1.3 kristaps 223: time_t date;
1.25 kristaps 224: char *title;
225: char *os;
226: char *name;
1.2 kristaps 227: };
228:
1.38 kristaps 229: /* An argument to a macro (multiple values = `It -column'). */
230: struct mdoc_argv {
231: int arg;
232: int line;
233: int pos;
234: size_t sz;
235: char **value;
1.1 kristaps 236: };
237:
1.38 kristaps 238: struct mdoc_arg {
1.1 kristaps 239: size_t argc;
1.38 kristaps 240: struct mdoc_argv *argv;
241: unsigned int refcnt;
1.1 kristaps 242: };
243:
1.29 kristaps 244: /* Node in AST. */
1.1 kristaps 245: struct mdoc_node {
246: struct mdoc_node *parent;
247: struct mdoc_node *child;
248: struct mdoc_node *next;
1.5 kristaps 249: struct mdoc_node *prev;
1.16 kristaps 250: int line;
251: int pos;
1.20 kristaps 252: int tok;
1.26 kristaps 253: int flags;
254: #define MDOC_VALID (1 << 0)
255: #define MDOC_ACTED (1 << 1)
1.1 kristaps 256: enum mdoc_type type;
1.31 kristaps 257: enum mdoc_sec sec;
1.40 kristaps 258:
259: /* FIXME: union/struct this with #defines. */
1.38 kristaps 260: struct mdoc_arg *args; /* BLOCK/ELEM */
261: struct mdoc_node *head; /* BLOCK */
262: struct mdoc_node *body; /* BLOCK */
263: struct mdoc_node *tail; /* BLOCK */
264: char *string; /* TEXT */
1.1 kristaps 265: };
266:
1.40 kristaps 267: #define MDOC_IGN_SCOPE (1 << 0) /* Ignore scope violations. */
268: #define MDOC_IGN_ESCAPE (1 << 1) /* Ignore bad escape sequences. */
1.43 kristaps 269: #define MDOC_IGN_MACRO (1 << 2) /* Ignore unknown macros. */
1.38 kristaps 270:
1.23 kristaps 271: /* Call-backs for parse messages. */
1.1 kristaps 272: struct mdoc_cb {
1.17 kristaps 273: void (*mdoc_msg)(void *, int, int, const char *);
1.22 kristaps 274: int (*mdoc_err)(void *, int, int, const char *);
275: int (*mdoc_warn)(void *, int, int,
276: enum mdoc_warn, const char *);
1.1 kristaps 277: };
278:
1.29 kristaps 279: /* Global table of macro names (`Bd', `Ed', etc.). */
1.1 kristaps 280: extern const char *const *mdoc_macronames;
1.29 kristaps 281:
282: /* Global table of argument names (`column', `tag', etc.). */
1.1 kristaps 283: extern const char *const *mdoc_argnames;
284:
285: __BEGIN_DECLS
286:
287: struct mdoc;
288:
1.23 kristaps 289: /* Free memory allocated with mdoc_alloc. */
1.1 kristaps 290: void mdoc_free(struct mdoc *);
1.23 kristaps 291:
292: /* Allocate a new parser instance. */
1.40 kristaps 293: struct mdoc *mdoc_alloc(void *, int, const struct mdoc_cb *);
1.23 kristaps 294:
1.38 kristaps 295: /* Set parse options. */
296: void mdoc_setflags(struct mdoc *, int);
297:
1.29 kristaps 298: /* Parse a single line in a stream (boolean retval). */
1.16 kristaps 299: int mdoc_parseln(struct mdoc *, int, char *buf);
1.23 kristaps 300:
1.29 kristaps 301: /* Get result first node (after mdoc_endparse!). */
1.32 kristaps 302: const struct mdoc_node *mdoc_node(const struct mdoc *);
1.27 kristaps 303:
1.29 kristaps 304: /* Get result meta-information (after mdoc_endparse!). */
1.32 kristaps 305: const struct mdoc_meta *mdoc_meta(const struct mdoc *);
1.23 kristaps 306:
307: /* Signal end of parse sequence (boolean retval). */
1.16 kristaps 308: int mdoc_endparse(struct mdoc *);
1.1 kristaps 309:
1.33 kristaps 310: /* The following are utility functions. */
1.37 kristaps 311:
312: const char *mdoc_a2att(const char *);
313: const char *mdoc_a2lib(const char *);
314: const char *mdoc_a2st(const char *);
315:
1.30 kristaps 316: int mdoc_isdelim(const char *);
317:
1.1 kristaps 318: __END_DECLS
319:
320: #endif /*!MDOC_H*/
CVSweb