Kea 2.7.0
agent/parser_context.h
Go to the documentation of this file.
1// Copyright (C) 2017-2023 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7#ifndef PARSER_CONTEXT_H
8#define PARSER_CONTEXT_H
9#include <string>
10#include <map>
11#include <vector>
12#include <agent/agent_parser.h>
15
16// Tell Flex the lexer's prototype ...
17#define YY_DECL isc::agent::AgentParser::symbol_type agent_lex (ParserContext& driver)
18
19// ... and declare it for the parser's sake.
21
22namespace isc {
23namespace agent {
24
37{
38public:
39
58
61
63 virtual ~ParserContext();
64
66 std::vector<isc::data::ElementPtr> stack_;
67
72 void scanStringBegin(const std::string& str, ParserType type);
73
79 void scanFileBegin(FILE* f, const std::string& filename, ParserType type);
80
82 void scanEnd();
83
87 void includeFile(const std::string& filename);
88
99 isc::data::ElementPtr parseString(const std::string& str,
100 ParserType parser_type);
101
113 isc::data::ElementPtr parseFile(const std::string& filename,
114 ParserType parser_type);
115
125 void error(const isc::agent::location& loc,
126 const std::string& what,
127 size_t pos = 0);
128
136 void error(const std::string& what);
137
145 static void fatal(const std::string& what);
146
154 isc::data::Element::Position loc2pos(isc::agent::location& loc);
155
165 void require(const std::string& name,
168
177 void unique(const std::string& name,
179
186 void warning(const isc::agent::location& loc, const std::string& what);
187
193 void warnAboutExtraCommas(const isc::agent::location& loc);
194
196 typedef enum {
199
201 CONFIG,
202
204 AGENT,
205
208
210 AUTH_TYPE,
211
213 CLIENTS,
214
217
219 SERVER,
220
223
226
228 LOGGERS,
229
233
235 std::string file_;
236
238 std::vector<std::string> files_;
239
244 isc::agent::location loc_;
245
247 std::vector<isc::agent::location> locs_;
248
250 std::vector<struct yy_buffer_state*> states_;
251
253 FILE* sfile_;
254
260 std::vector<FILE*> sfiles_;
261
264
282 void enter(const LexerContext& ctx);
283
291 void leave();
292
296 const std::string contextName();
297
298 private:
300 bool trace_scanning_;
301
303 bool trace_parsing_;
304
306 std::vector<LexerContext> cstack_;
307
311 isc::data::ElementPtr parseCommon();
312};
313
314} // end of isc::eval namespace
315} // end of isc namespace
316
317#endif
#define YY_DECL
Forward declaration of the ParserContext class.
Define the isc::agent::parser class.
Parser context is a wrapper around flex/bison instances dedicated to Control-agent config file parser...
void warning(const isc::agent::location &loc, const std::string &what)
Warning handler.
std::vector< isc::agent::location > locs_
Location stack.
void warnAboutExtraCommas(const isc::agent::location &loc)
Warning for extra commas.
std::vector< std::string > files_
File name stack.
void scanStringBegin(const std::string &str, ParserType type)
Method called before scanning starts on a string.
ParserContext()
Default constructor.
void scanFileBegin(FILE *f, const std::string &filename, ParserType type)
Method called before scanning starts on a file.
void unique(const std::string &name, isc::data::Element::Position loc)
Check if a parameter is already present.
std::vector< isc::data::ElementPtr > stack_
JSON elements being parsed.
static void fatal(const std::string &what)
Fatal error handler.
virtual ~ParserContext()
destructor
std::vector< struct yy_buffer_state * > states_
Lexer state stack.
isc::agent::location loc_
Location of the current token.
const std::string contextName()
Get the syntactic context name.
void includeFile(const std::string &filename)
Divert input to an include file.
isc::data::Element::Position loc2pos(isc::agent::location &loc)
Converts bison's position to one understandable by isc::data::Element.
isc::data::ElementPtr parseFile(const std::string &filename, ParserType parser_type)
Run the parser on the file specified.
LexerContext ctx_
Current syntactic context.
isc::data::ElementPtr parseString(const std::string &str, ParserType parser_type)
Run the parser on the string specified.
void leave()
Leave a syntactic context.
LexerContext
Defines syntactic contexts for lexical tie-ins.
@ CONFIG
Used while parsing content of Agent.
@ SERVER
Used while parsing Control-agent/control-socket/*-server/socket-type.
@ NO_KEYWORDS
This one is used in pure JSON mode.
@ HOOKS_LIBRARIES
Used while parsing Control-agent/loggers structures.
@ CONTROL_SOCKETS
Used while parsing Control-agent/control-socket/*-server.
@ SOCKET_TYPE
Used while parsing Control-agent/hooks-libraries.
@ AGENT
Used while parsing Control-agent/Authentication.
@ CLIENTS
Used while parsing Control-agent/control-sockets.
@ AUTHENTICATION
Used while parsing Control-agent/Authentication/type.
@ AUTH_TYPE
Used while parsing Control-agent/Authentication/clients.
@ LOGGERS
Used while parsing Control-agent/loggers/output-options structures.
std::vector< FILE * > sfiles_
sFile (aka FILE) stack
void require(const std::string &name, isc::data::Element::Position open_loc, isc::data::Element::Position close_loc)
Check if a required parameter is present.
void error(const isc::agent::location &loc, const std::string &what, size_t pos=0)
Error handler.
ParserType
Defines currently supported scopes.
@ PARSER_AGENT
This parser will expect the content as Control-agent config wrapped in a map (that's the regular conf...
@ PARSER_JSON
This parser will parse the content as generic JSON.
@ PARSER_SUB_AGENT
This parser will expect only the content of Control-agent.
void enter(const LexerContext &ctx)
Enter a new syntactic context.
FILE * sfile_
sFile (aka FILE)
void scanEnd()
Method called after the last tokens are scanned.
boost::shared_ptr< Element > ElementPtr
Definition data.h:28
Defines the logger used by the top-level component of kea-lfc.
Represents the position of the data element within a configuration string.
Definition data.h:94