2 * Copyright (C) 2004, 2006 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 2002, 2003 Internet Software Consortium.
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: grammar.h,v 1.3.50.6 2006/03/02 00:37:20 marka Exp $ */
20 #ifndef ISCCFG_GRAMMAR_H
21 #define ISCCFG_GRAMMAR_H 1
24 #include <isc/netaddr.h>
25 #include <isc/sockaddr.h>
26 #include <isc/region.h>
27 #include <isc/types.h>
29 #include <isccfg/cfg.h>
32 * Definitions shared between the configuration parser
33 * and the grammars; not visible to users of the parser.
36 /* Clause may occur multiple times (e.g., "zone") */
37 #define CFG_CLAUSEFLAG_MULTI 0x00000001
38 /* Clause is obsolete */
39 #define CFG_CLAUSEFLAG_OBSOLETE 0x00000002
40 /* Clause is not implemented, and may never be */
41 #define CFG_CLAUSEFLAG_NOTIMP 0x00000004
42 /* Clause is not implemented yet */
43 #define CFG_CLAUSEFLAG_NYI 0x00000008
44 /* Default value has changed since earlier release */
45 #define CFG_CLAUSEFLAG_NEWDEFAULT 0x00000010
47 * Clause needs to be interpreted during parsing
48 * by calling a callback function, like the
51 #define CFG_CLAUSEFLAG_CALLBACK 0x00000020
53 typedef struct cfg_clausedef cfg_clausedef_t;
54 typedef struct cfg_tuplefielddef cfg_tuplefielddef_t;
55 typedef struct cfg_printer cfg_printer_t;
56 typedef ISC_LIST(cfg_listelt_t) cfg_list_t;
57 typedef struct cfg_map cfg_map_t;
58 typedef struct cfg_rep cfg_rep_t;
61 * Function types for configuration object methods
64 typedef isc_result_t (*cfg_parsefunc_t)(cfg_parser_t *, const cfg_type_t *type,
66 typedef void (*cfg_printfunc_t)(cfg_printer_t *, const cfg_obj_t *);
67 typedef void (*cfg_docfunc_t)(cfg_printer_t *, const cfg_type_t *);
68 typedef void (*cfg_freefunc_t)(cfg_parser_t *, cfg_obj_t *);
71 * Structure definitions
75 * A configuration printer object. This is an abstract
76 * interface to a destination to which text can be printed
77 * by calling the function 'f'.
80 void (*f)(void *closure, const char *text, int textlen);
85 /* A clause definition. */
87 struct cfg_clausedef {
93 /* A tuple field definition. */
95 struct cfg_tuplefielddef {
101 /* A configuration object type definition. */
103 const char *name; /* For debugging purposes only */
104 cfg_parsefunc_t parse;
105 cfg_printfunc_t print;
106 cfg_docfunc_t doc; /* Print grammar description */
107 cfg_rep_t * rep; /* Data representation */
108 const void * of; /* Additional data for meta-types */
111 /* A keyword-type definition, for things like "port <integer>". */
115 const cfg_type_t *type;
119 cfg_obj_t *id; /* Used for 'named maps' like keys, zones, &c */
120 const cfg_clausedef_t * const *clausesets; /* The clauses that
121 can occur in this map;
123 isc_symtab_t *symtab;
126 typedef struct cfg_netprefix cfg_netprefix_t;
128 struct cfg_netprefix {
129 isc_netaddr_t address; /* IP4/IP6 */
130 unsigned int prefixlen;
134 * A configuration data representation.
137 const char * name; /* For debugging only */
138 cfg_freefunc_t free; /* How to free this kind of data. */
142 * A configuration object. This is the main building block
143 * of the configuration parse tree.
147 const cfg_type_t *type;
151 isc_textregion_t string; /* null terminated, too */
152 isc_boolean_t boolean;
156 isc_sockaddr_t sockaddr;
157 cfg_netprefix_t netprefix;
164 /* A list element. */
168 ISC_LINK(cfg_listelt_t) link;
171 /* The parser object. */
177 unsigned int warnings;
180 /* We are at the end of all input. */
181 isc_boolean_t seen_eof;
183 /* The current token has been pushed back. */
184 isc_boolean_t ungotten;
187 * The stack of currently active files, represented
188 * as a configuration list of configuration strings.
189 * The head is the top-level file, subsequent elements
190 * (if any) are the nested include files, and the
191 * last element is the file currently being parsed.
193 cfg_obj_t * open_files;
196 * Names of files that we have parsed and closed
197 * and were previously on the open_file list.
198 * We keep these objects around after closing
199 * the files because the file names may still be
200 * referenced from other configuration objects
201 * for use in reporting semantic errors after
202 * parsing is complete.
204 cfg_obj_t * closed_files;
207 * Current line number. We maintain our own
208 * copy of this so that it is available even
209 * when a file has just been closed.
213 cfg_parsecallback_t callback;
219 * Flags defining whether to accept certain types of network addresses.
221 #define CFG_ADDR_V4OK 0x00000001
222 #define CFG_ADDR_V4PREFIXOK 0x00000002
223 #define CFG_ADDR_V6OK 0x00000004
224 #define CFG_ADDR_WILDOK 0x00000008
227 * Predefined data representation types.
229 LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_uint32;
230 LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_uint64;
231 LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_string;
232 LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_boolean;
233 LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_map;
234 LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_list;
235 LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_tuple;
236 LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_sockaddr;
237 LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_netprefix;
238 LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_void;
241 * Predefined configuration object types.
243 LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_boolean;
244 LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_uint32;
245 LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_uint64;
246 LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_qstring;
247 LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_astring;
248 LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_ustring;
249 LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_sockaddr;
250 LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netaddr;
251 LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netprefix;
252 LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_void;
253 LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_token;
254 LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_unsupported;
257 cfg_gettoken(cfg_parser_t *pctx, int options);
260 cfg_peektoken(cfg_parser_t *pctx, int options);
263 cfg_ungettoken(cfg_parser_t *pctx);
265 #define CFG_LEXOPT_QSTRING (ISC_LEXOPT_QSTRING | ISC_LEXOPT_QSTRINGMULTILINE)
268 cfg_create_obj(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **objp);
271 cfg_print_rawuint(cfg_printer_t *pctx, unsigned int u);
274 cfg_parse_uint32(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
277 cfg_print_uint32(cfg_printer_t *pctx, const cfg_obj_t *obj);
280 cfg_print_uint64(cfg_printer_t *pctx, const cfg_obj_t *obj);
283 cfg_parse_qstring(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
286 cfg_print_ustring(cfg_printer_t *pctx, const cfg_obj_t *obj);
289 cfg_parse_astring(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
292 cfg_parse_rawaddr(cfg_parser_t *pctx, unsigned int flags, isc_netaddr_t *na);
295 cfg_print_rawaddr(cfg_printer_t *pctx, const isc_netaddr_t *na);
298 cfg_lookingat_netaddr(cfg_parser_t *pctx, unsigned int flags);
301 cfg_parse_rawport(cfg_parser_t *pctx, unsigned int flags, in_port_t *port);
304 cfg_parse_sockaddr(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
307 cfg_print_sockaddr(cfg_printer_t *pctx, const cfg_obj_t *obj);
310 cfg_doc_sockaddr(cfg_printer_t *pctx, const cfg_type_t *type);
313 cfg_parse_netprefix(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
316 cfg_parse_special(cfg_parser_t *pctx, int special);
317 /* Parse a required special character 'special'. */
320 cfg_create_tuple(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **objp);
323 cfg_parse_tuple(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
326 cfg_print_tuple(cfg_printer_t *pctx, const cfg_obj_t *obj);
329 cfg_doc_tuple(cfg_printer_t *pctx, const cfg_type_t *type);
332 cfg_create_list(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **objp);
335 cfg_parse_listelt(cfg_parser_t *pctx, const cfg_type_t *elttype,
336 cfg_listelt_t **ret);
339 cfg_parse_bracketed_list(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
342 cfg_print_bracketed_list(cfg_printer_t *pctx, const cfg_obj_t *obj);
345 cfg_doc_bracketed_list(cfg_printer_t *pctx, const cfg_type_t *type);
348 cfg_parse_spacelist(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
351 cfg_print_spacelist(cfg_printer_t *pctx, const cfg_obj_t *obj);
354 cfg_parse_enum(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
357 cfg_doc_enum(cfg_printer_t *pctx, const cfg_type_t *type);
360 cfg_print_chars(cfg_printer_t *pctx, const char *text, int len);
361 /* Print 'len' characters at 'text' */
364 cfg_print_cstr(cfg_printer_t *pctx, const char *s);
365 /* Print the null-terminated string 's' */
368 cfg_parse_map(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
371 cfg_parse_named_map(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
374 cfg_parse_addressed_map(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
377 cfg_print_map(cfg_printer_t *pctx, const cfg_obj_t *obj);
380 cfg_doc_map(cfg_printer_t *pctx, const cfg_type_t *type);
383 cfg_parse_mapbody(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
386 cfg_print_mapbody(cfg_printer_t *pctx, const cfg_obj_t *obj);
389 cfg_doc_mapbody(cfg_printer_t *pctx, const cfg_type_t *type);
392 cfg_parse_void(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
395 cfg_print_void(cfg_printer_t *pctx, const cfg_obj_t *obj);
398 cfg_doc_void(cfg_printer_t *pctx, const cfg_type_t *type);
401 cfg_parse_obj(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
404 cfg_print_obj(cfg_printer_t *pctx, const cfg_obj_t *obj);
407 cfg_doc_obj(cfg_printer_t *pctx, const cfg_type_t *type);
409 * Print a description of the grammar of an arbitrary configuration
414 cfg_doc_terminal(cfg_printer_t *pctx, const cfg_type_t *type);
416 * Document the type 'type' as a terminal by printing its
417 * name in angle brackets, e.g., <uint32>.
421 cfg_parser_error(cfg_parser_t *pctx, unsigned int flags,
422 const char *fmt, ...) ISC_FORMAT_PRINTF(3, 4);
424 * Pass one of these flags to cfg_parser_error() to include the
425 * token text in log message.
427 #define CFG_LOG_NEAR 0x00000001 /* Say "near <token>" */
428 #define CFG_LOG_BEFORE 0x00000002 /* Say "before <token>" */
429 #define CFG_LOG_NOPREP 0x00000004 /* Say just "<token>" */
432 cfg_parser_warning(cfg_parser_t *pctx, unsigned int flags,
433 const char *fmt, ...) ISC_FORMAT_PRINTF(3, 4);
436 cfg_is_enum(const char *s, const char *const *enums);
437 /* Return true iff the string 's' is one of the strings in 'enums' */
439 #endif /* ISCCFG_GRAMMAR_H */