#acupoftea - mail.ontime-ae.com

System	:	Linux server1.ontime-gulf.com 4.18.0-553.5.1.el8_10.x86_64 #1 SMP Wed Jun 5 09:12:13 EDT 2024 x86_64
Software	:	Apache
Server	:	162.0.230.206
Domains	:	40 Domain
Permission	:	[ drwxr-xr-x ]
	:	/ usr / include / bind9 / isc /

216.73.216.49

Home

File lex.h

/*
 * 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 ISC_LEX_H
#define ISC_LEX_H 1

/*****
 ***** Module Info
 *****/

/*! \file isc/lex.h
 * \brief The "lex" module provides a lightweight tokenizer.  It can operate
 * on files or buffers, and can handle "include".  It is designed for
 * parsing of DNS master files and the BIND configuration file, but
 * should be general enough to tokenize other things, e.g. HTTP.
 *
 * \li MP:
 *	No synchronization is provided.  Clients must ensure exclusive
 *	access.
 *
 * \li Reliability:
 *	No anticipated impact.
 *
 * \li Resources:
 *	TBS
 *
 * \li Security:
 *	No anticipated impact.
 *
 * \li Standards:
 * 	None.
 */

/***
 *** Imports
 ***/

#include <stdbool.h>
#include <stdio.h>

#include <isc/lang.h>
#include <isc/region.h>
#include <isc/types.h>

ISC_LANG_BEGINDECLS

/***
 *** Options
 ***/

/*@{*/
/*!
 * Various options for isc_lex_gettoken().
 */

#define ISC_LEXOPT_EOL			0x01	/*%< Want end-of-line token. */
#define ISC_LEXOPT_EOF			0x02	/*%< Want end-of-file token. */
#define ISC_LEXOPT_INITIALWS		0x04	/*%< Want initial whitespace. */
#define ISC_LEXOPT_NUMBER		0x08	/*%< Recognize numbers. */
#define ISC_LEXOPT_QSTRING		0x10	/*%< Recognize qstrings. */
/*@}*/

/*@{*/
/*!
 * The ISC_LEXOPT_DNSMULTILINE option handles the processing of '(' and ')' in
 * the DNS master file format.  If this option is set, then the
 * ISC_LEXOPT_INITIALWS and ISC_LEXOPT_EOL options will be ignored when
 * the paren count is > 0.  To use this option, '(' and ')' must be special
 * characters.
 */
#define ISC_LEXOPT_DNSMULTILINE		0x20	/*%< Handle '(' and ')'. */
#define ISC_LEXOPT_NOMORE		0x40	/*%< Want "no more" token. */

#define ISC_LEXOPT_CNUMBER		0x80    /*%< Recognize octal and hex. */
#define ISC_LEXOPT_ESCAPE		0x100	/*%< Recognize escapes. */
#define ISC_LEXOPT_QSTRINGMULTILINE	0x200	/*%< Allow multiline "" strings */
#define ISC_LEXOPT_OCTAL		0x400	/*%< Expect a octal number. */
#define ISC_LEXOPT_BTEXT		0x800	/*%< Bracketed text. */
/*@}*/
/*@{*/
/*!
 * Various commenting styles, which may be changed at any time with
 * isc_lex_setcomments().
 */

#define ISC_LEXCOMMENT_C		0x01
#define ISC_LEXCOMMENT_CPLUSPLUS	0x02
#define ISC_LEXCOMMENT_SHELL		0x04
#define ISC_LEXCOMMENT_DNSMASTERFILE	0x08
/*@}*/

/***
 *** Types
 ***/

/*! Lex */

typedef char isc_lexspecials_t[256];

/* Tokens */

typedef enum {
	isc_tokentype_unknown = 0,
	isc_tokentype_string = 1,
	isc_tokentype_number = 2,
	isc_tokentype_qstring = 3,
	isc_tokentype_eol = 4,
	isc_tokentype_eof = 5,
	isc_tokentype_initialws = 6,
	isc_tokentype_special = 7,
	isc_tokentype_nomore = 8,
	isc_tokentype_btext = 8
} isc_tokentype_t;

typedef union {
	char				as_char;
	unsigned long			as_ulong;
	isc_region_t			as_region;
	isc_textregion_t		as_textregion;
	void *				as_pointer;
} isc_tokenvalue_t;

typedef struct isc_token {
	isc_tokentype_t			type;
	isc_tokenvalue_t		value;
} isc_token_t;

/***
 *** Functions
 ***/

isc_result_t
isc_lex_create(isc_mem_t *mctx, size_t max_token, isc_lex_t **lexp);
/*%<
 * Create a lexer.
 *
 * 'max_token' is a hint of the number of bytes in the largest token.
 *
 * Requires:
 *\li	'*lexp' is a valid lexer.
 *
 * Ensures:
 *\li	On success, *lexp is attached to the newly created lexer.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_NOMEMORY
 */

void
isc_lex_destroy(isc_lex_t **lexp);
/*%<
 * Destroy the lexer.
 *
 * Requires:
 *\li	'*lexp' is a valid lexer.
 *
 * Ensures:
 *\li	*lexp == NULL
 */

unsigned int
isc_lex_getcomments(isc_lex_t *lex);
/*%<
 * Return the current lexer commenting styles.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 *
 * Returns:
 *\li	The commenting styles which are currently allowed.
 */

void
isc_lex_setcomments(isc_lex_t *lex, unsigned int comments);
/*%<
 * Set allowed lexer commenting styles.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 *
 *\li	'comments' has meaningful values.
 */

void
isc_lex_getspecials(isc_lex_t *lex, isc_lexspecials_t specials);
/*%<
 * Put the current list of specials into 'specials'.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 */

void
isc_lex_setspecials(isc_lex_t *lex, isc_lexspecials_t specials);
/*!<
 * The characters in 'specials' are returned as tokens.  Along with
 * whitespace, they delimit strings and numbers.
 *
 * Note:
 *\li	Comment processing takes precedence over special character
 *	recognition.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 */

isc_result_t
isc_lex_openfile(isc_lex_t *lex, const char *filename);
/*%<
 * Open 'filename' and make it the current input source for 'lex'.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 *
 *\li	filename is a valid C string.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_NOMEMORY			Out of memory
 *\li	#ISC_R_NOTFOUND			File not found
 *\li	#ISC_R_NOPERM			No permission to open file
 *\li	#ISC_R_FAILURE			Couldn't open file, not sure why
 *\li	#ISC_R_UNEXPECTED
 */

isc_result_t
isc_lex_openstream(isc_lex_t *lex, FILE *stream);
/*%<
 * Make 'stream' the current input source for 'lex'.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 *
 *\li	'stream' is a valid C stream.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_NOMEMORY			Out of memory
 */

isc_result_t
isc_lex_openbuffer(isc_lex_t *lex, isc_buffer_t *buffer);
/*%<
 * Make 'buffer' the current input source for 'lex'.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 *
 *\li	'buffer' is a valid buffer.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_NOMEMORY			Out of memory
 */

isc_result_t
isc_lex_close(isc_lex_t *lex);
/*%<
 * Close the most recently opened object (i.e. file or buffer).
 *
 * Returns:
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_NOMORE			No more input sources
 */

isc_result_t
isc_lex_gettoken(isc_lex_t *lex, unsigned int options, isc_token_t *tokenp);
/*%<
 * Get the next token.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 *
 *\li	'lex' has an input source.
 *
 *\li	'options' contains valid options.
 *
 *\li	'*tokenp' is a valid pointer.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_UNEXPECTEDEND
 *\li	#ISC_R_NOMEMORY
 *
 *	These two results are returned only if their corresponding lexer
 *	options are not set.
 *
 *\li	#ISC_R_EOF			End of input source
 *\li	#ISC_R_NOMORE			No more input sources
 */

isc_result_t
isc_lex_getmastertoken(isc_lex_t *lex, isc_token_t *token,
		       isc_tokentype_t expect, bool eol);
/*%<
 * Get the next token from a DNS master file type stream.  This is a
 * convenience function that sets appropriate options and handles quoted
 * strings and end of line correctly for master files.  It also ungets
 * unexpected tokens.  If `eol` is set then expect end-of-line otherwise
 * eol is a error.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 *
 *\li	'token' is a valid pointer
 *
 * Returns:
 *
 * \li	any return code from isc_lex_gettoken().
 */

isc_result_t
isc_lex_getoctaltoken(isc_lex_t *lex, isc_token_t *token, bool eol);
/*%<
 * Get the next token from a DNS master file type stream.  This is a
 * convenience function that sets appropriate options and handles end
 * of line correctly for master files.  It also ungets unexpected tokens.
 * If `eol` is set then expect end-of-line otherwise eol is a error.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 *
 *\li	'token' is a valid pointer
 *
 * Returns:
 *
 * \li	any return code from isc_lex_gettoken().
 */

void
isc_lex_ungettoken(isc_lex_t *lex, isc_token_t *tokenp);
/*%<
 * Unget the current token.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 *
 *\li	'lex' has an input source.
 *
 *\li	'tokenp' points to a valid token.
 *
 *\li	There is no ungotten token already.
 */

void
isc_lex_getlasttokentext(isc_lex_t *lex, isc_token_t *tokenp, isc_region_t *r);
/*%<
 * Returns a region containing the text of the last token returned.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 *
 *\li	'lex' has an input source.
 *
 *\li	'tokenp' points to a valid token.
 *
 *\li	A token has been gotten and not ungotten.
 */

char *
isc_lex_getsourcename(isc_lex_t *lex);
/*%<
 * Return the input source name.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 *
 * Returns:
 * \li	source name or NULL if no current source.
 *\li	result valid while current input source exists.
 */

unsigned long
isc_lex_getsourceline(isc_lex_t *lex);
/*%<
 * Return the input source line number.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 *
 * Returns:
 *\li 	Current line number or 0 if no current source.
 */

isc_result_t
isc_lex_setsourcename(isc_lex_t *lex, const char *name);
/*%<
 * Assigns a new name to the input source.
 *
 * Requires:
 *
 * \li	'lex' is a valid lexer.
 *
 * Returns:
 * \li	#ISC_R_SUCCESS
 * \li	#ISC_R_NOMEMORY
 * \li	#ISC_R_NOTFOUND - there are no sources.
 */

isc_result_t
isc_lex_setsourceline(isc_lex_t *lex, unsigned long line);
/*%<
 * Assigns a new line number to the input source. This can be used
 * when parsing a buffer that's been excerpted from the middle a file,
 * allowing logged messages to display the correct line number,
 * rather than the line number within the buffer.
 *
 * Requires:
 *
 * \li	'lex' is a valid lexer.
 *
 * Returns:
 * \li	#ISC_R_SUCCESS
 * \li	#ISC_R_NOTFOUND - there are no sources.
 */

bool
isc_lex_isfile(isc_lex_t *lex);
/*%<
 * Return whether the current input source is a file.
 *
 * Requires:
 *\li	'lex' is a valid lexer.
 *
 * Returns:
 * \li	#true if the current input is a file,
 *\li	#false otherwise.
 */

ISC_LANG_ENDDECLS

#endif /* ISC_LEX_H */

Name	Type	Size	Permission	Last Modified	Actions
.	DIR	-	drwxr-xr-x	2025-02-21 10:57:15
..	DIR	-	drwxr-xr-x	2025-02-21 10:57:16
aes.h	text/x-c	1.05 KB	-rw-r--r--	2025-02-20 09:05:24
app.h	text/x-c	10.23 KB	-rw-r--r--	2025-02-20 09:05:24
assertions.h	text/x-c	2.84 KB	-rw-r--r--	2025-02-20 09:05:24
atomic.h	text/x-c	4.07 KB	-rw-r--r--	2025-02-20 09:05:24
backtrace.h	text/x-c	3.8 KB	-rw-r--r--	2025-02-20 09:05:24
base32.h	text/x-c	4.35 KB	-rw-r--r--	2025-02-20 09:05:24
base64.h	text/x-c	2.8 KB	-rw-r--r--	2025-02-20 09:05:24
bind9.h	text/x-c	830 B	-rw-r--r--	2025-02-20 09:05:24
boolean.h	text/plain	594 B	-rw-r--r--	2025-02-20 09:05:24
buffer.h	text/x-c	25.65 KB	-rw-r--r--	2025-02-20 09:05:24
bufferlist.h	text/x-c	1.42 KB	-rw-r--r--	2025-02-20 09:05:24
cmocka.h	text/x-c	1.35 KB	-rw-r--r--	2025-02-20 09:05:24
commandline.h	text/x-c	1.67 KB	-rw-r--r--	2025-02-20 09:05:24
condition.h	text/x-c	1.44 KB	-rw-r--r--	2025-02-20 09:05:24
counter.h	text/x-c	1.88 KB	-rw-r--r--	2025-02-20 09:05:24
crc64.h	text/x-c	998 B	-rw-r--r--	2025-02-20 09:05:24
deprecated.h	text/plain	623 B	-rw-r--r--	2025-02-20 09:05:24
dir.h	text/x-c	1.56 KB	-rw-r--r--	2025-02-20 09:05:24
endian.h	text/x-c	4.67 KB	-rw-r--r--	2025-02-20 09:05:24
entropy.h	text/x-c	10.13 KB	-rw-r--r--	2025-02-20 09:05:24
errno.h	text/x-c	659 B	-rw-r--r--	2025-02-20 09:05:24
errno2result.h	text/x-c	902 B	-rw-r--r--	2025-02-20 09:05:37
error.h	text/x-c	1.4 KB	-rw-r--r--	2025-02-20 09:05:24
event.h	text/x-c	2.98 KB	-rw-r--r--	2025-02-20 09:05:24
eventclass.h	text/plain	1.35 KB	-rw-r--r--	2025-02-20 09:05:24
file.h	text/x-c	11.39 KB	-rw-r--r--	2025-02-20 09:05:24
formatcheck.h	text/plain	893 B	-rw-r--r--	2025-02-20 09:05:24
fsaccess.h	text/x-c	7.27 KB	-rw-r--r--	2025-02-20 09:05:24
hash.h	text/x-c	7.48 KB	-rw-r--r--	2025-02-20 09:05:24
heap.h	text/x-c	5.14 KB	-rw-r--r--	2025-02-20 09:05:24
hex.h	text/x-c	2.74 KB	-rw-r--r--	2025-02-20 09:05:24
hmacmd5.h	text/x-c	1.75 KB	-rw-r--r--	2025-02-20 09:05:24
hmacsha.h	text/x-c	4.41 KB	-rw-r--r--	2025-02-20 09:05:24
ht.h	text/x-c	4.29 KB	-rw-r--r--	2025-02-20 09:05:24
httpd.h	text/x-c	2.26 KB	-rw-r--r--	2025-02-20 09:05:24
int.h	text/x-c	1.06 KB	-rw-r--r--	2025-02-20 09:05:24
interfaceiter.h	text/x-c	3.05 KB	-rw-r--r--	2025-02-20 09:05:24
iterated_hash.h	text/x-c	1.02 KB	-rw-r--r--	2025-02-20 09:05:24
json.h	text/x-c	1.42 KB	-rw-r--r--	2025-02-20 09:05:24
keyboard.h	text/x-c	989 B	-rw-r--r--	2025-02-20 09:05:24
lang.h	text/plain	637 B	-rw-r--r--	2025-02-20 09:05:24
lex.h	text/x-c	9.54 KB	-rw-r--r--	2025-02-20 09:05:24
lfsr.h	text/x-c	2.89 KB	-rw-r--r--	2025-02-20 09:05:24
lib.h	text/x-c	1.04 KB	-rw-r--r--	2025-02-20 09:05:24
likely.h	text/plain	818 B	-rw-r--r--	2025-02-20 09:05:24
list.h	text/x-c	5.62 KB	-rw-r--r--	2025-02-20 09:05:24
log.h	text/x-c	28.06 KB	-rw-r--r--	2025-02-20 09:05:24
magic.h	text/x-c	994 B	-rw-r--r--	2025-02-20 09:05:24
md5.h	text/x-c	2.32 KB	-rw-r--r--	2025-02-20 09:05:24
mem.h	text/x-c	20.62 KB	-rw-r--r--	2025-02-20 09:05:24
meminfo.h	text/x-c	710 B	-rw-r--r--	2025-02-20 09:05:24
msgcat.h	text/x-c	2.66 KB	-rw-r--r--	2025-02-20 09:05:24
msgs.h	text/x-c	8.22 KB	-rw-r--r--	2025-02-20 09:05:24
mutex.h	text/x-c	3.44 KB	-rw-r--r--	2025-02-20 09:05:24
mutexblock.h	text/x-c	1.34 KB	-rw-r--r--	2025-02-20 09:05:24
net.h	text/x-c	10.29 KB	-rw-r--r--	2025-02-20 09:05:24
netaddr.h	text/x-c	4.48 KB	-rw-r--r--	2025-02-20 09:05:24
netdb.h	text/x-c	863 B	-rw-r--r--	2025-02-20 09:05:24
netscope.h	text/x-c	967 B	-rw-r--r--	2025-02-20 09:05:24
offset.h	text/x-c	700 B	-rw-r--r--	2025-02-20 09:05:24
once.h	text/x-c	983 B	-rw-r--r--	2025-02-20 09:05:24
ondestroy.h	text/x-c	2.73 KB	-rw-r--r--	2025-02-20 09:05:24
os.h	text/x-c	671 B	-rw-r--r--	2025-02-20 09:05:24
parseint.h	text/x-c	1.51 KB	-rw-r--r--	2025-02-20 09:05:24
platform.h	text/x-c	9.49 KB	-rw-r--r--	2025-02-20 09:05:24
pool.h	text/x-c	3.42 KB	-rw-r--r--	2025-02-20 09:05:24
portset.h	text/x-c	3.22 KB	-rw-r--r--	2025-02-20 09:05:24
print.h	text/x-c	2.42 KB	-rw-r--r--	2025-02-20 09:05:24
queue.h	text/x-c	5.08 KB	-rw-r--r--	2025-02-20 09:05:24
quota.h	text/x-c	2.38 KB	-rw-r--r--	2025-02-20 09:05:24
radix.h	text/x-c	6.34 KB	-rw-r--r--	2025-02-20 09:05:24
random.h	text/x-c	3.5 KB	-rw-r--r--	2025-02-20 09:05:24
ratelimiter.h	text/x-c	3.42 KB	-rw-r--r--	2025-02-20 09:05:24
refcount.h	text/x-c	8 KB	-rw-r--r--	2025-02-20 09:05:24
regex.h	text/x-c	767 B	-rw-r--r--	2025-02-20 09:05:24
region.h	text/x-c	1.99 KB	-rw-r--r--	2025-02-20 09:05:24
resource.h	text/x-c	2.79 KB	-rw-r--r--	2025-02-20 09:05:24
result.h	text/x-c	4.87 KB	-rw-r--r--	2025-02-20 09:05:24
resultclass.h	text/plain	1.56 KB	-rw-r--r--	2025-02-20 09:05:24
rwlock.h	text/x-c	3.72 KB	-rw-r--r--	2025-02-20 09:05:24
safe.h	text/x-c	1.32 KB	-rw-r--r--	2025-02-20 09:05:24
serial.h	text/x-c	1.34 KB	-rw-r--r--	2025-02-20 09:05:24
sha1.h	text/x-c	1.52 KB	-rw-r--r--	2025-02-20 09:05:24
sha2.h	text/x-c	5.6 KB	-rw-r--r--	2025-02-20 09:05:24
siphash.h	text/x-c	734 B	-rw-r--r--	2025-02-20 09:05:24
sockaddr.h	text/x-c	5.9 KB	-rw-r--r--	2025-02-20 09:05:24
socket.h	text/x-c	35.8 KB	-rw-r--r--	2025-02-20 09:05:24
stat.h	text/x-c	806 B	-rw-r--r--	2025-02-20 09:05:24
stats.h	text/x-c	3.62 KB	-rw-r--r--	2025-02-20 09:05:24
stdatomic.h	text/plain	5.13 KB	-rw-r--r--	2025-02-20 09:05:24
stdio.h	text/x-c	1.75 KB	-rw-r--r--	2025-02-20 09:05:24
stdlib.h	text/x-c	704 B	-rw-r--r--	2025-02-20 09:05:24
stdtime.h	text/x-c	1.04 KB	-rw-r--r--	2025-02-20 09:05:24
strerror.h	text/x-c	777 B	-rw-r--r--	2025-02-20 09:05:24
string.h	text/x-c	5.88 KB	-rw-r--r--	2025-02-20 09:05:24
symtab.h	text/x-c	4.22 KB	-rw-r--r--	2025-02-20 09:05:24
syslog.h	text/x-c	844 B	-rw-r--r--	2025-02-20 09:05:24
task.h	text/x-c	21.04 KB	-rw-r--r--	2025-02-20 09:05:24
taskpool.h	text/x-c	3.62 KB	-rw-r--r--	2025-02-20 09:05:24
thread.h	text/x-c	1.47 KB	-rw-r--r--	2025-02-20 09:05:24
time.h	text/x-c	8.67 KB	-rw-r--r--	2025-02-20 09:05:24
timer.h	text/x-c	10.54 KB	-rw-r--r--	2025-02-20 09:05:24
tm.h	text/x-c	895 B	-rw-r--r--	2025-02-20 09:05:24
types.h	text/x-c	5.64 KB	-rw-r--r--	2025-02-20 09:05:24
utf8.h	text/x-c	928 B	-rw-r--r--	2025-02-20 09:05:24
util.h	text/x-c	10.29 KB	-rw-r--r--	2025-02-20 09:05:24
version.h	text/x-c	689 B	-rw-r--r--	2025-02-20 09:05:24
xml.h	text/x-c	1.07 KB	-rw-r--r--	2025-02-20 09:05:24

~ ACUPOFTEA - mail.ontime-ae.com