#$@%#$%!

Ngiler SH3LL 360
: / usr / include / bind9 / isccfg /

Information Server
MySQL : OFF Perl : OFF CURL : ON WGET : OFF PKEXEC : OFF

Directive	Local Value
IP Address	162.0.209.101
System	Linux premium169.web-hosting.com 4.18.0-553.50.1.lve.el8.x86_64 #1 SMP Thu Apr 17 19:10:24 UTC 2025 x86_64
User	luxeelil
PHP Version	8.0.30
Software	LiteSpeed
Doc root	Writable

Edit File : grammar.h \| Size : 15.43 KB
/* * Copyright (C) Internet Systems Consortium, Inc. ("ISC") * * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, you can obtain one at https://mozilla.org/MPL/2.0/. * * See the COPYRIGHT file distributed with this work for additional * information regarding copyright ownership. / #ifndef ISCCFG_GRAMMAR_H #define ISCCFG_GRAMMAR_H 1 /! \file isccfg/grammar.h / #include <inttypes.h> #include <stdbool.h> #include <isc/lex.h> #include <isc/netaddr.h> #include <isc/refcount.h> #include <isc/sockaddr.h> #include <isc/region.h> #include <isc/types.h> #include <isccfg/cfg.h> / * Definitions shared between the configuration parser * and the grammars; not visible to users of the parser. / /% Clause may occur multiple times (e.g., "zone") / #define CFG_CLAUSEFLAG_MULTI 0x00000001 /% Clause is obsolete / #define CFG_CLAUSEFLAG_OBSOLETE 0x00000002 /% Clause is not implemented, and may never be / #define CFG_CLAUSEFLAG_NOTIMP 0x00000004 /% Clause is not implemented yet / #define CFG_CLAUSEFLAG_NYI 0x00000008 /% Default value has changed since earlier release / #define CFG_CLAUSEFLAG_NEWDEFAULT 0x00000010 /% * Clause needs to be interpreted during parsing * by calling a callback function, like the * "directory" option. / #define CFG_CLAUSEFLAG_CALLBACK 0x00000020 /% A option that is only used in testing. / #define CFG_CLAUSEFLAG_TESTONLY 0x00000040 /% A configuration option that was not configured at compile time. / #define CFG_CLAUSEFLAG_NOTCONFIGURED 0x00000080 /% A option for a experimental feature. / #define CFG_CLAUSEFLAG_EXPERIMENTAL 0x00000100 /% A configuration option that is ineffective due to * compile time options, but is harmless. / #define CFG_CLAUSEFLAG_NOOP 0x00000200 /% Clause is obsolete in a future release / #define CFG_CLAUSEFLAG_DEPRECATED 0x00000400 /% * Zone types for which a clause is valid: * These share space with CFG_CLAUSEFLAG values, but count * down from the top. / #define CFG_ZONE_MASTER 0x80000000 #define CFG_ZONE_SLAVE 0x40000000 #define CFG_ZONE_STUB 0x20000000 #define CFG_ZONE_HINT 0x10000000 #define CFG_ZONE_FORWARD 0x08000000 #define CFG_ZONE_STATICSTUB 0x04000000 #define CFG_ZONE_REDIRECT 0x02000000 #define CFG_ZONE_DELEGATION 0x01000000 #define CFG_ZONE_INVIEW 0x00800000 typedef struct cfg_clausedef cfg_clausedef_t; typedef struct cfg_tuplefielddef cfg_tuplefielddef_t; typedef struct cfg_printer cfg_printer_t; typedef ISC_LIST(cfg_listelt_t) cfg_list_t; typedef struct cfg_map cfg_map_t; typedef struct cfg_rep cfg_rep_t; / * Function types for configuration object methods / typedef isc_result_t (cfg_parsefunc_t)(cfg_parser_t , const cfg_type_t type, cfg_obj_t *); typedef void (cfg_printfunc_t)(cfg_printer_t , const cfg_obj_t ); typedef void (cfg_docfunc_t)(cfg_printer_t , const cfg_type_t ); typedef void (cfg_freefunc_t)(cfg_parser_t , cfg_obj_t ); /* * Structure definitions / /% * A configuration printer object. This is an abstract * interface to a destination to which text can be printed * by calling the function 'f'. / struct cfg_printer { void (f)(void closure, const char text, int textlen); void closure; int indent; int flags; }; /% A clause definition. / struct cfg_clausedef { const char name; cfg_type_t type; unsigned int flags; }; /% A tuple field definition. / struct cfg_tuplefielddef { const char name; cfg_type_t type; unsigned int flags; }; /% A configuration object type definition. / struct cfg_type { const char name; /%< For debugging purposes only / cfg_parsefunc_t parse; cfg_printfunc_t print; cfg_docfunc_t doc; /%< Print grammar description / cfg_rep_t * rep; /%< Data representation / const void * of; /%< Additional data for meta-types / }; /% A keyword-type definition, for things like "port <integer>". / typedef struct { const char name; const cfg_type_t type; } keyword_type_t; struct cfg_map { cfg_obj_t id; /%< Used for 'named maps' like keys, zones, &c / const cfg_clausedef_t const clausesets; /%< The clauses that can occur in this map; used for printing / isc_symtab_t symtab; }; typedef struct cfg_netprefix cfg_netprefix_t; struct cfg_netprefix { isc_netaddr_t address; /* IP4/IP6 / unsigned int prefixlen; }; /% * A configuration data representation. / struct cfg_rep { const char name; /%< For debugging only / cfg_freefunc_t free; /%< How to free this kind of data. / }; /% A configuration object. This is the main building block * of the configuration parse tree. / struct cfg_obj { const cfg_type_t type; union { uint32_t uint32; uint64_t uint64; isc_textregion_t string; /%< null terminated, too / bool boolean; cfg_map_t map; cfg_list_t list; cfg_obj_t ** tuple; isc_sockaddr_t sockaddr; struct { isc_sockaddr_t sockaddr; isc_dscp_t dscp; } sockaddrdscp; cfg_netprefix_t netprefix; } value; isc_refcount_t references; /%< reference counter / const char * file; unsigned int line; cfg_parser_t * pctx; }; /% A list element. / struct cfg_listelt { cfg_obj_t obj; ISC_LINK(cfg_listelt_t) link; }; /% The parser object. / struct cfg_parser { isc_mem_t mctx; isc_log_t * lctx; isc_lex_t * lexer; unsigned int errors; unsigned int warnings; isc_token_t token; /% We are at the end of all input. / bool seen_eof; /% The current token has been pushed back. / bool ungotten; /% The stack of currently active files, represented * as a configuration list of configuration strings. * The head is the top-level file, subsequent elements * (if any) are the nested include files, and the * last element is the file currently being parsed. / cfg_obj_t open_files; /% Names of files that we have parsed and closed * and were previously on the open_file list. * We keep these objects around after closing * the files because the file names may still be * referenced from other configuration objects * for use in reporting semantic errors after * parsing is complete. / cfg_obj_t closed_files; /% Name of a buffer being parsed; used only for * logging. / char const buf_name; /% Current line number. We maintain our own * copy of this so that it is available even * when a file has just been closed. / unsigned int line; /% * Parser context flags, used for maintaining state * from one token to the next. / unsigned int flags; /%< Reference counter / isc_refcount_t references; cfg_parsecallback_t callback; void callbackarg; }; /* Parser context flags / #define CFG_PCTX_SKIP 0x1 #define CFG_PCTX_NODEPRECATED 0x2 /@{/ /% * Flags defining whether to accept certain types of network addresses. / #define CFG_ADDR_V4OK 0x00000001 #define CFG_ADDR_V4PREFIXOK 0x00000002 #define CFG_ADDR_V6OK 0x00000004 #define CFG_ADDR_WILDOK 0x00000008 #define CFG_ADDR_DSCPOK 0x00000010 #define CFG_ADDR_MASK (CFG_ADDR_V6OK\|CFG_ADDR_V4OK) /@}/ /@{/ /% * Predefined data representation types. / LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_uint32; LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_uint64; LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_string; LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_boolean; LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_map; LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_list; LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_tuple; LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_sockaddr; LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_netprefix; LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_void; LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_fixedpoint; LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_percentage; /@}/ /@{/ /% * Predefined configuration object types. / LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_boolean; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_uint32; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_uint64; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_qstring; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_astring; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_ustring; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_sstring; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_bracketed_text; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_sockaddr; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_sockaddrdscp; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netaddr; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netaddr4; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netaddr4wild; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netaddr6; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netaddr6wild; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netprefix; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_void; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_token; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_unsupported; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_fixedpoint; LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_percentage; /@}/ isc_result_t cfg_gettoken(cfg_parser_t pctx, int options); isc_result_t cfg_peektoken(cfg_parser_t pctx, int options); void cfg_ungettoken(cfg_parser_t pctx); #define CFG_LEXOPT_QSTRING (ISC_LEXOPT_QSTRING \| ISC_LEXOPT_QSTRINGMULTILINE) isc_result_t cfg_create_obj(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t *objp); void cfg_print_rawuint(cfg_printer_t pctx, unsigned int u); isc_result_t cfg_parse_uint32(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t *ret); void cfg_print_uint32(cfg_printer_t pctx, const cfg_obj_t obj); void cfg_print_uint64(cfg_printer_t pctx, const cfg_obj_t obj); isc_result_t cfg_parse_qstring(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); void cfg_print_ustring(cfg_printer_t pctx, const cfg_obj_t obj); isc_result_t cfg_parse_astring(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); isc_result_t cfg_parse_sstring(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); isc_result_t cfg_parse_rawaddr(cfg_parser_t pctx, unsigned int flags, isc_netaddr_t na); void cfg_print_rawaddr(cfg_printer_t pctx, const isc_netaddr_t na); bool cfg_lookingat_netaddr(cfg_parser_t pctx, unsigned int flags); isc_result_t cfg_parse_rawport(cfg_parser_t pctx, unsigned int flags, in_port_t port); isc_result_t cfg_parse_dscp(cfg_parser_t pctx, isc_dscp_t dscp); isc_result_t cfg_parse_sockaddr(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t *ret); isc_result_t cfg_parse_boolean(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); void cfg_print_sockaddr(cfg_printer_t pctx, const cfg_obj_t obj); void cfg_print_boolean(cfg_printer_t pctx, const cfg_obj_t obj); void cfg_doc_sockaddr(cfg_printer_t pctx, const cfg_type_t type); isc_result_t cfg_parse_netprefix(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); isc_result_t cfg_parse_special(cfg_parser_t pctx, int special); /%< Parse a required special character 'special'. / isc_result_t cfg_create_tuple(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t *objp); isc_result_t cfg_parse_tuple(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); void cfg_print_tuple(cfg_printer_t pctx, const cfg_obj_t obj); void cfg_doc_tuple(cfg_printer_t pctx, const cfg_type_t type); isc_result_t cfg_create_list(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t objp); isc_result_t cfg_parse_listelt(cfg_parser_t pctx, const cfg_type_t elttype, cfg_listelt_t ret); isc_result_t cfg_parse_bracketed_list(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); void cfg_print_bracketed_list(cfg_printer_t pctx, const cfg_obj_t obj); void cfg_doc_bracketed_list(cfg_printer_t pctx, const cfg_type_t type); isc_result_t cfg_parse_spacelist(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); void cfg_print_spacelist(cfg_printer_t pctx, const cfg_obj_t obj); isc_result_t cfg_parse_enum(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); void cfg_doc_enum(cfg_printer_t pctx, const cfg_type_t type); void cfg_print_chars(cfg_printer_t pctx, const char text, int len); /%< Print 'len' characters at 'text' / void cfg_print_cstr(cfg_printer_t pctx, const char s); /%< Print the null-terminated string 's' / isc_result_t cfg_parse_map(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); isc_result_t cfg_parse_named_map(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); isc_result_t cfg_parse_addressed_map(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); isc_result_t cfg_parse_netprefix_map(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t * ret); void cfg_print_map(cfg_printer_t pctx, const cfg_obj_t obj); void cfg_doc_map(cfg_printer_t pctx, const cfg_type_t type); isc_result_t cfg_parse_mapbody(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t *ret); void cfg_print_mapbody(cfg_printer_t pctx, const cfg_obj_t obj); void cfg_doc_mapbody(cfg_printer_t pctx, const cfg_type_t type); isc_result_t cfg_parse_void(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); void cfg_print_void(cfg_printer_t pctx, const cfg_obj_t obj); void cfg_doc_void(cfg_printer_t pctx, const cfg_type_t type); isc_result_t cfg_parse_fixedpoint(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); void cfg_print_fixedpoint(cfg_printer_t pctx, const cfg_obj_t obj); isc_result_t cfg_parse_percentage(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); void cfg_print_percentage(cfg_printer_t pctx, const cfg_obj_t obj); isc_result_t cfg_parse_obj(cfg_parser_t pctx, const cfg_type_t type, cfg_obj_t ret); void cfg_print_obj(cfg_printer_t pctx, const cfg_obj_t obj); void cfg_doc_obj(cfg_printer_t pctx, const cfg_type_t type); /%< * Print a description of the grammar of an arbitrary configuration * type 'type' / void cfg_doc_terminal(cfg_printer_t pctx, const cfg_type_t type); /%< * Document the type 'type' as a terminal by printing its * name in angle brackets, e.g., <uint32>. / void cfg_parser_error(cfg_parser_t pctx, unsigned int flags, const char fmt, ...) ISC_FORMAT_PRINTF(3, 4); /! * Pass one of these flags to cfg_parser_error() to include the * token text in log message. / #define CFG_LOG_NEAR 0x00000001 /%< Say "near <token>" / #define CFG_LOG_BEFORE 0x00000002 /%< Say "before <token>" / #define CFG_LOG_NOPREP 0x00000004 /%< Say just "<token>" / void cfg_parser_warning(cfg_parser_t pctx, unsigned int flags, const char fmt, ...) ISC_FORMAT_PRINTF(3, 4); bool cfg_is_enum(const char s, const char const enums); /%< Return true iff the string 's' is one of the strings in 'enums' / bool cfg_clause_validforzone(const char name, unsigned int ztype); /%< * Check whether an option is legal for the specified zone type. / void cfg_print_zonegrammar(const unsigned int zonetype, void (f)(void closure, const char text, int textlen), void closure); /%< * Print a summary of the grammar of the zone type represented by * 'zonetype'. / void cfg_print_clauseflags(cfg_printer_t pctx, unsigned int flags); /%< Print clause flags (e.g. "obsolete", "not implemented", etc) in * human readable form / void cfg_print_indent(cfg_printer_t pctx); /%< Print the necessary indent required by the current settings of 'pctx'. / #endif / ISCCFG_GRAMMAR_H */ Back

Edit File : grammar.h | Size : 15.43 KB

/*
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, you can obtain one at https://mozilla.org/MPL/2.0/.
 *
 * See the COPYRIGHT file distributed with this work for additional
 * information regarding copyright ownership.
 */

#ifndef ISCCFG_GRAMMAR_H
#define ISCCFG_GRAMMAR_H 1

/*! \file isccfg/grammar.h */

#include <inttypes.h>
#include <stdbool.h>

#include <isc/lex.h>
#include <isc/netaddr.h>
#include <isc/refcount.h>
#include <isc/sockaddr.h>
#include <isc/region.h>
#include <isc/types.h>

#include <isccfg/cfg.h>

/*
 * Definitions shared between the configuration parser
 * and the grammars; not visible to users of the parser.
 */

/*% Clause may occur multiple times (e.g., "zone") */
#define CFG_CLAUSEFLAG_MULTI 		0x00000001
/*% Clause is obsolete */
#define CFG_CLAUSEFLAG_OBSOLETE 	0x00000002
/*% Clause is not implemented, and may never be */
#define CFG_CLAUSEFLAG_NOTIMP	 	0x00000004
/*% Clause is not implemented yet */
#define CFG_CLAUSEFLAG_NYI 		0x00000008
/*% Default value has changed since earlier release */
#define CFG_CLAUSEFLAG_NEWDEFAULT	0x00000010
/*%
 * Clause needs to be interpreted during parsing
 * by calling a callback function, like the
 * "directory" option.
 */
#define CFG_CLAUSEFLAG_CALLBACK		0x00000020
/*% A option that is only used in testing. */
#define CFG_CLAUSEFLAG_TESTONLY		0x00000040
/*% A configuration option that was not configured at compile time. */
#define CFG_CLAUSEFLAG_NOTCONFIGURED	0x00000080
/*% A option for a experimental feature. */
#define CFG_CLAUSEFLAG_EXPERIMENTAL	0x00000100
/*% A configuration option that is ineffective due to
 * compile time options, but is harmless. */
#define CFG_CLAUSEFLAG_NOOP		0x00000200
/*% Clause is obsolete in a future release */
#define CFG_CLAUSEFLAG_DEPRECATED	0x00000400

/*%
 * Zone types for which a clause is valid:
 * These share space with CFG_CLAUSEFLAG values, but count
 * down from the top.
 */
#define CFG_ZONE_MASTER			0x80000000
#define CFG_ZONE_SLAVE			0x40000000
#define CFG_ZONE_STUB			0x20000000
#define CFG_ZONE_HINT			0x10000000
#define CFG_ZONE_FORWARD		0x08000000
#define CFG_ZONE_STATICSTUB		0x04000000
#define CFG_ZONE_REDIRECT		0x02000000
#define CFG_ZONE_DELEGATION		0x01000000
#define CFG_ZONE_INVIEW			0x00800000

typedef struct cfg_clausedef cfg_clausedef_t;
typedef struct cfg_tuplefielddef cfg_tuplefielddef_t;
typedef struct cfg_printer cfg_printer_t;
typedef ISC_LIST(cfg_listelt_t) cfg_list_t;
typedef struct cfg_map cfg_map_t;
typedef struct cfg_rep cfg_rep_t;

/*
 * Function types for configuration object methods
 */

typedef isc_result_t (*cfg_parsefunc_t)(cfg_parser_t *, const cfg_type_t *type,
					cfg_obj_t **);
typedef void	     (*cfg_printfunc_t)(cfg_printer_t *, const cfg_obj_t *);
typedef void	     (*cfg_docfunc_t)(cfg_printer_t *, const cfg_type_t *);
typedef void	     (*cfg_freefunc_t)(cfg_parser_t *, cfg_obj_t *);

/*
 * Structure definitions
 */

/*%
 * A configuration printer object.  This is an abstract
 * interface to a destination to which text can be printed
 * by calling the function 'f'.
 */
struct cfg_printer {
	void (*f)(void *closure, const char *text, int textlen);
	void *closure;
	int indent;
	int flags;
};

/*% A clause definition. */
struct cfg_clausedef {
	const char      *name;
	cfg_type_t      *type;
	unsigned int	flags;
};

/*% A tuple field definition. */
struct cfg_tuplefielddef {
	const char      *name;
	cfg_type_t      *type;
	unsigned int	flags;
};

/*% A configuration object type definition. */
struct cfg_type {
	const char *name;	/*%< For debugging purposes only */
	cfg_parsefunc_t	parse;
	cfg_printfunc_t print;
	cfg_docfunc_t	doc;	/*%< Print grammar description */
	cfg_rep_t *	rep;	/*%< Data representation */
	const void *	of;	/*%< Additional data for meta-types */
};

/*% A keyword-type definition, for things like "port <integer>". */
typedef struct {
	const char *name;
	const cfg_type_t *type;
} keyword_type_t;

struct cfg_map {
	cfg_obj_t	 *id; /*%< Used for 'named maps' like keys, zones, &c */
	const cfg_clausedef_t * const *clausesets; /*%< The clauses that
						      can occur in this map;
						      used for printing */
	isc_symtab_t     *symtab;
};

typedef struct cfg_netprefix cfg_netprefix_t;

struct cfg_netprefix {
	isc_netaddr_t address; /* IP4/IP6 */
	unsigned int prefixlen;
};

/*%
 * A configuration data representation.
 */
struct cfg_rep {
	const char *	name;	/*%< For debugging only */
	cfg_freefunc_t 	free;	/*%< How to free this kind of data. */
};

/*%
 * A configuration object.  This is the main building block
 * of the configuration parse tree.
 */

struct cfg_obj {
	const cfg_type_t *type;
	union {
		uint32_t  	uint32;
		uint64_t  	uint64;
		isc_textregion_t string; /*%< null terminated, too */
		bool 	boolean;
		cfg_map_t	map;
		cfg_list_t	list;
		cfg_obj_t **	tuple;
		isc_sockaddr_t	sockaddr;
		struct {
			isc_sockaddr_t	sockaddr;
			isc_dscp_t	dscp;
		} sockaddrdscp;
		cfg_netprefix_t netprefix;
	}               value;
	isc_refcount_t  references;     /*%< reference counter */
	const char *	file;
	unsigned int    line;
	cfg_parser_t *	pctx;
};

/*% A list element. */
struct cfg_listelt {
	cfg_obj_t               *obj;
	ISC_LINK(cfg_listelt_t)  link;
};

/*% The parser object. */
struct cfg_parser {
	isc_mem_t *	mctx;
	isc_log_t *	lctx;
	isc_lex_t *	lexer;
	unsigned int    errors;
	unsigned int    warnings;
	isc_token_t     token;

/*% We are at the end of all input. */
	bool	seen_eof;

/*% The current token has been pushed back. */
	bool	ungotten;

/*%
	 * The stack of currently active files, represented
	 * as a configuration list of configuration strings.
	 * The head is the top-level file, subsequent elements
	 * (if any) are the nested include files, and the
	 * last element is the file currently being parsed.
	 */
	cfg_obj_t *	open_files;

/*%
	 * Names of files that we have parsed and closed
	 * and were previously on the open_file list.
	 * We keep these objects around after closing
	 * the files because the file names may still be
	 * referenced from other configuration objects
	 * for use in reporting semantic errors after
	 * parsing is complete.
	 */
	cfg_obj_t *	closed_files;

/*%
	 * Name of a buffer being parsed; used only for
	 * logging.
	 */
	char const *	buf_name;

/*%
	 * Current line number.  We maintain our own
	 * copy of this so that it is available even
	 * when a file has just been closed.
	 */
	unsigned int	line;

/*%
	 * Parser context flags, used for maintaining state
	 * from one token to the next.
	 */
	unsigned int flags;

/*%< Reference counter */
	isc_refcount_t  references;

cfg_parsecallback_t callback;
	void *callbackarg;
};

/* Parser context flags */
#define CFG_PCTX_SKIP		0x1
#define CFG_PCTX_NODEPRECATED	0x2

/*@{*/
/*%
 * Flags defining whether to accept certain types of network addresses.
 */
#define CFG_ADDR_V4OK 		0x00000001
#define CFG_ADDR_V4PREFIXOK 	0x00000002
#define CFG_ADDR_V6OK 		0x00000004
#define CFG_ADDR_WILDOK		0x00000008
#define CFG_ADDR_DSCPOK		0x00000010
#define CFG_ADDR_MASK		(CFG_ADDR_V6OK|CFG_ADDR_V4OK)
/*@}*/

/*@{*/
/*%
 * Predefined data representation types.
 */
LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_uint32;
LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_uint64;
LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_string;
LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_boolean;
LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_map;
LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_list;
LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_tuple;
LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_sockaddr;
LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_netprefix;
LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_void;
LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_fixedpoint;
LIBISCCFG_EXTERNAL_DATA extern cfg_rep_t cfg_rep_percentage;
/*@}*/

/*@{*/
/*%
 * Predefined configuration object types.
 */
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_boolean;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_uint32;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_uint64;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_qstring;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_astring;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_ustring;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_sstring;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_bracketed_text;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_sockaddr;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_sockaddrdscp;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netaddr;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netaddr4;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netaddr4wild;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netaddr6;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netaddr6wild;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_netprefix;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_void;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_token;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_unsupported;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_fixedpoint;
LIBISCCFG_EXTERNAL_DATA extern cfg_type_t cfg_type_percentage;
/*@}*/

isc_result_t
cfg_gettoken(cfg_parser_t *pctx, int options);

isc_result_t
cfg_peektoken(cfg_parser_t *pctx, int options);

void
cfg_ungettoken(cfg_parser_t *pctx);

#define CFG_LEXOPT_QSTRING (ISC_LEXOPT_QSTRING | ISC_LEXOPT_QSTRINGMULTILINE)

isc_result_t
cfg_create_obj(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **objp);

void
cfg_print_rawuint(cfg_printer_t *pctx, unsigned int u);

isc_result_t
cfg_parse_uint32(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

void
cfg_print_uint32(cfg_printer_t *pctx, const cfg_obj_t *obj);

void
cfg_print_uint64(cfg_printer_t *pctx, const cfg_obj_t *obj);

isc_result_t
cfg_parse_qstring(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

void
cfg_print_ustring(cfg_printer_t *pctx, const cfg_obj_t *obj);

isc_result_t
cfg_parse_astring(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

isc_result_t
cfg_parse_sstring(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

isc_result_t
cfg_parse_rawaddr(cfg_parser_t *pctx, unsigned int flags, isc_netaddr_t *na);

void
cfg_print_rawaddr(cfg_printer_t *pctx, const isc_netaddr_t *na);

bool
cfg_lookingat_netaddr(cfg_parser_t *pctx, unsigned int flags);

isc_result_t
cfg_parse_rawport(cfg_parser_t *pctx, unsigned int flags, in_port_t *port);

isc_result_t
cfg_parse_dscp(cfg_parser_t *pctx, isc_dscp_t *dscp);

isc_result_t
cfg_parse_sockaddr(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

isc_result_t
cfg_parse_boolean(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

void
cfg_print_sockaddr(cfg_printer_t *pctx, const cfg_obj_t *obj);

void
cfg_print_boolean(cfg_printer_t *pctx, const cfg_obj_t *obj);

void
cfg_doc_sockaddr(cfg_printer_t *pctx, const cfg_type_t *type);

isc_result_t
cfg_parse_netprefix(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

isc_result_t
cfg_parse_special(cfg_parser_t *pctx, int special);
/*%< Parse a required special character 'special'. */

isc_result_t
cfg_create_tuple(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **objp);

isc_result_t
cfg_parse_tuple(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

void
cfg_print_tuple(cfg_printer_t *pctx, const cfg_obj_t *obj);

void
cfg_doc_tuple(cfg_printer_t *pctx, const cfg_type_t *type);

isc_result_t
cfg_create_list(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **objp);

isc_result_t
cfg_parse_listelt(cfg_parser_t *pctx, const cfg_type_t *elttype,
		  cfg_listelt_t **ret);

isc_result_t
cfg_parse_bracketed_list(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

void
cfg_print_bracketed_list(cfg_printer_t *pctx, const cfg_obj_t *obj);

void
cfg_doc_bracketed_list(cfg_printer_t *pctx, const cfg_type_t *type);

isc_result_t
cfg_parse_spacelist(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

void
cfg_print_spacelist(cfg_printer_t *pctx, const cfg_obj_t *obj);

isc_result_t
cfg_parse_enum(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

void
cfg_doc_enum(cfg_printer_t *pctx, const cfg_type_t *type);

void
cfg_print_chars(cfg_printer_t *pctx, const char *text, int len);
/*%< Print 'len' characters at 'text' */

void
cfg_print_cstr(cfg_printer_t *pctx, const char *s);
/*%< Print the null-terminated string 's' */

isc_result_t
cfg_parse_map(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

isc_result_t
cfg_parse_named_map(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

isc_result_t
cfg_parse_addressed_map(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

isc_result_t
cfg_parse_netprefix_map(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **
ret);

void
cfg_print_map(cfg_printer_t *pctx, const cfg_obj_t *obj);

void
cfg_doc_map(cfg_printer_t *pctx, const cfg_type_t *type);

isc_result_t
cfg_parse_mapbody(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

void
cfg_print_mapbody(cfg_printer_t *pctx, const cfg_obj_t *obj);

void
cfg_doc_mapbody(cfg_printer_t *pctx, const cfg_type_t *type);

isc_result_t
cfg_parse_void(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

void
cfg_print_void(cfg_printer_t *pctx, const cfg_obj_t *obj);

void
cfg_doc_void(cfg_printer_t *pctx, const cfg_type_t *type);

isc_result_t
cfg_parse_fixedpoint(cfg_parser_t *pctx, const cfg_type_t *type,
		     cfg_obj_t **ret);

void
cfg_print_fixedpoint(cfg_printer_t *pctx, const cfg_obj_t *obj);

isc_result_t
cfg_parse_percentage(cfg_parser_t *pctx, const cfg_type_t *type,
		     cfg_obj_t **ret);

void
cfg_print_percentage(cfg_printer_t *pctx, const cfg_obj_t *obj);

isc_result_t
cfg_parse_obj(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);

void
cfg_print_obj(cfg_printer_t *pctx, const cfg_obj_t *obj);

void
cfg_doc_obj(cfg_printer_t *pctx, const cfg_type_t *type);
/*%<
 * Print a description of the grammar of an arbitrary configuration
 * type 'type'
 */

void
cfg_doc_terminal(cfg_printer_t *pctx, const cfg_type_t *type);
/*%<
 * Document the type 'type' as a terminal by printing its
 * name in angle brackets, e.g., &lt;uint32>.
 */

void
cfg_parser_error(cfg_parser_t *pctx, unsigned int flags,
		 const char *fmt, ...) ISC_FORMAT_PRINTF(3, 4);
/*!
 * Pass one of these flags to cfg_parser_error() to include the
 * token text in log message.
 */
#define CFG_LOG_NEAR    0x00000001	/*%< Say "near <token>" */
#define CFG_LOG_BEFORE  0x00000002	/*%< Say "before <token>" */
#define CFG_LOG_NOPREP  0x00000004	/*%< Say just "<token>" */

void
cfg_parser_warning(cfg_parser_t *pctx, unsigned int flags,
		   const char *fmt, ...) ISC_FORMAT_PRINTF(3, 4);

bool
cfg_is_enum(const char *s, const char *const *enums);
/*%< Return true iff the string 's' is one of the strings in 'enums' */

bool
cfg_clause_validforzone(const char *name, unsigned int ztype);
/*%<
 * Check whether an option is legal for the specified zone type.
 */

void
cfg_print_zonegrammar(const unsigned int zonetype,
		      void (*f)(void *closure, const char *text, int textlen),
		      void *closure);
/*%<
 * Print a summary of the grammar of the zone type represented by
 * 'zonetype'.
 */

void
cfg_print_clauseflags(cfg_printer_t *pctx, unsigned int flags);
/*%<
 * Print clause flags (e.g. "obsolete", "not implemented", etc) in
 * human readable form
 */

void
cfg_print_indent(cfg_printer_t *pctx);
/*%<
 * Print the necessary indent required by the current settings of 'pctx'.
 */

#endif /* ISCCFG_GRAMMAR_H */

Back