Annotation of mandoc/mdoc.h, Revision 1.45
1.45 ! kristaps 1: /* $Id: mdoc.h,v 1.44 2009/03/09 13:17: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:
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
1.45 ! kristaps 145: #define MDOC_Lk 109
! 146: #define MDOC_Mt 110
! 147: #define MDOC_MAX 111
1.1 kristaps 148:
1.22 kristaps 149: /* What follows is a list of ALL possible macro arguments. */
150:
1.1 kristaps 151: #define MDOC_Split 0
152: #define MDOC_Nosplit 1
153: #define MDOC_Ragged 2
154: #define MDOC_Unfilled 3
155: #define MDOC_Literal 4
156: #define MDOC_File 5
157: #define MDOC_Offset 6
158: #define MDOC_Bullet 7
159: #define MDOC_Dash 8
160: #define MDOC_Hyphen 9
161: #define MDOC_Item 10
162: #define MDOC_Enum 11
163: #define MDOC_Tag 12
164: #define MDOC_Diag 13
165: #define MDOC_Hang 14
166: #define MDOC_Ohang 15
167: #define MDOC_Inset 16
168: #define MDOC_Column 17
169: #define MDOC_Width 18
170: #define MDOC_Compact 19
171: #define MDOC_Std 20
1.37 kristaps 172: #define MDOC_Filled 21
173: #define MDOC_Words 22
174: #define MDOC_Emphasis 23
175: #define MDOC_Symbolic 24
176: #define MDOC_ARG_MAX 25
1.1 kristaps 177:
1.29 kristaps 178: /* Warnings are either syntax or groff-compatibility. */
1.22 kristaps 179: enum mdoc_warn {
1.29 kristaps 180: WARN_SYNTAX,
181: WARN_COMPAT
1.1 kristaps 182: };
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.37 kristaps 197: SEC_PROLOGUE = 0,
198: SEC_BODY = 1,
199: SEC_NAME = 2,
200: SEC_LIBRARY = 3,
201: SEC_SYNOPSIS = 4,
202: SEC_DESCRIPTION = 5,
203: SEC_IMPLEMENTATION = 6,
204: SEC_RETURN_VALUES = 7,
205: SEC_ENVIRONMENT = 8,
206: SEC_FILES = 9,
207: SEC_EXAMPLES = 10,
208: SEC_DIAGNOSTICS = 11,
209: SEC_COMPATIBILITY = 12,
210: SEC_ERRORS = 13,
211: SEC_SEE_ALSO = 14,
212: SEC_STANDARDS = 15,
213: SEC_HISTORY = 16,
214: SEC_AUTHORS = 17,
215: SEC_CAVEATS = 18,
216: SEC_BUGS = 19,
1.2 kristaps 217: SEC_CUSTOM
218: };
219:
1.29 kristaps 220: /* Information from prologue. */
1.2 kristaps 221: struct mdoc_meta {
1.37 kristaps 222: int msec;
223: char *vol;
224: char *arch;
1.3 kristaps 225: time_t date;
1.25 kristaps 226: char *title;
227: char *os;
228: char *name;
1.2 kristaps 229: };
230:
1.38 kristaps 231: /* An argument to a macro (multiple values = `It -column'). */
232: struct mdoc_argv {
233: int arg;
234: int line;
235: int pos;
236: size_t sz;
237: char **value;
1.1 kristaps 238: };
239:
1.38 kristaps 240: struct mdoc_arg {
1.1 kristaps 241: size_t argc;
1.38 kristaps 242: struct mdoc_argv *argv;
243: unsigned int refcnt;
1.1 kristaps 244: };
245:
1.29 kristaps 246: /* Node in AST. */
1.1 kristaps 247: struct mdoc_node {
248: struct mdoc_node *parent;
249: struct mdoc_node *child;
250: struct mdoc_node *next;
1.5 kristaps 251: struct mdoc_node *prev;
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:
261: /* FIXME: union/struct this with #defines. */
1.38 kristaps 262: struct mdoc_arg *args; /* BLOCK/ELEM */
263: struct mdoc_node *head; /* BLOCK */
264: struct mdoc_node *body; /* BLOCK */
265: struct mdoc_node *tail; /* BLOCK */
266: char *string; /* TEXT */
1.1 kristaps 267: };
268:
1.40 kristaps 269: #define MDOC_IGN_SCOPE (1 << 0) /* Ignore scope violations. */
270: #define MDOC_IGN_ESCAPE (1 << 1) /* Ignore bad escape sequences. */
1.43 kristaps 271: #define MDOC_IGN_MACRO (1 << 2) /* Ignore unknown macros. */
1.38 kristaps 272:
1.23 kristaps 273: /* Call-backs for parse messages. */
1.1 kristaps 274: struct mdoc_cb {
1.17 kristaps 275: void (*mdoc_msg)(void *, int, int, const char *);
1.22 kristaps 276: int (*mdoc_err)(void *, int, int, const char *);
277: int (*mdoc_warn)(void *, int, int,
278: enum mdoc_warn, const char *);
1.1 kristaps 279: };
280:
1.29 kristaps 281: /* Global table of macro names (`Bd', `Ed', etc.). */
1.1 kristaps 282: extern const char *const *mdoc_macronames;
1.29 kristaps 283:
284: /* Global table of argument names (`column', `tag', etc.). */
1.1 kristaps 285: extern const char *const *mdoc_argnames;
286:
287: __BEGIN_DECLS
288:
289: struct mdoc;
290:
1.23 kristaps 291: /* Free memory allocated with mdoc_alloc. */
1.1 kristaps 292: void mdoc_free(struct mdoc *);
1.23 kristaps 293:
294: /* Allocate a new parser instance. */
1.40 kristaps 295: struct mdoc *mdoc_alloc(void *, int, const struct mdoc_cb *);
1.23 kristaps 296:
1.38 kristaps 297: /* Set parse options. */
298: void mdoc_setflags(struct mdoc *, int);
299:
1.29 kristaps 300: /* Parse a single line in a stream (boolean retval). */
1.16 kristaps 301: int mdoc_parseln(struct mdoc *, int, char *buf);
1.23 kristaps 302:
1.29 kristaps 303: /* Get result first node (after mdoc_endparse!). */
1.32 kristaps 304: const struct mdoc_node *mdoc_node(const struct mdoc *);
1.27 kristaps 305:
1.29 kristaps 306: /* Get result meta-information (after mdoc_endparse!). */
1.32 kristaps 307: const struct mdoc_meta *mdoc_meta(const struct mdoc *);
1.23 kristaps 308:
309: /* Signal end of parse sequence (boolean retval). */
1.16 kristaps 310: int mdoc_endparse(struct mdoc *);
1.1 kristaps 311:
1.33 kristaps 312: /* The following are utility functions. */
1.37 kristaps 313:
314: const char *mdoc_a2att(const char *);
315: const char *mdoc_a2lib(const char *);
316: const char *mdoc_a2st(const char *);
317:
1.30 kristaps 318: int mdoc_isdelim(const char *);
319:
1.1 kristaps 320: __END_DECLS
321:
322: #endif /*!MDOC_H*/
CVSweb