Kea 2.6.0
lib/cc/simple_parser.h
Go to the documentation of this file.
1// Copyright (C) 2016-2022 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 SIMPLE_PARSER_H
8#define SIMPLE_PARSER_H
9
10#include <asiolink/io_address.h>
11#include <cc/data.h>
13#include <util/triplet.h>
14#include <map>
15#include <vector>
16#include <string>
17#include <stdint.h>
18#include <limits>
19
20namespace isc {
21namespace data {
22
25 SimpleDefault(const char* name, isc::data::Element::types type, const char* value)
26 :name_(name), type_(type), value_(value) {}
27 std::string name_;
29 const char* value_;
30};
31
33typedef std::vector<std::string> SimpleRequiredKeywords;
34
36typedef std::map<std::string, isc::data::Element::types> SimpleKeywords;
37
39typedef std::vector<SimpleDefault> SimpleDefaults;
40
43typedef std::vector<std::string> ParamsList;
44
45
69public:
70
79 static void checkRequired(const SimpleRequiredKeywords& required,
81
92 static void checkKeywords(const SimpleKeywords& keywords,
94
108 static size_t deriveParams(isc::data::ConstElementPtr parent,
110 const ParamsList& params);
111
123 static size_t setDefaults(isc::data::ElementPtr scope,
124 const SimpleDefaults& default_values);
125
136 const SimpleDefaults& default_values);
137
147 static const data::Element::Position&
148 getPosition(const std::string& name, const data::ConstElementPtr parent);
149
159 static std::string getString(isc::data::ConstElementPtr scope,
160 const std::string& name);
161
171 static int64_t getInteger(isc::data::ConstElementPtr scope,
172 const std::string& name);
173
187 static int64_t getInteger(isc::data::ConstElementPtr scope,
188 const std::string& name,
189 int64_t min, int64_t max);
190
200 static bool getBoolean(isc::data::ConstElementPtr scope,
201 const std::string& name);
202
203
215 getAddress(const ConstElementPtr& scope, const std::string& name);
216
226 static double getDouble(const ConstElementPtr& scope,
227 const std::string& name);
228
229protected:
230
241 template <typename int_type> int_type
243 const std::string& name) {
244 int64_t val_int = getInteger(scope, name);
245 if ((val_int < std::numeric_limits<int_type>::min()) ||
246 (val_int > std::numeric_limits<int_type>::max())) {
248 "out of range value (" << val_int
249 << ") specified for parameter '" << name
250 << "' (" << getPosition(name, scope) << ")");
251 }
252 return (static_cast<int_type>(val_int));
253 }
254
267 template <typename target_type,
268 target_type convert(const std::string&)> target_type
270 const std::string& name,
271 const std::string& type_name) {
272 std::string str = getString(scope, name);
273 try {
274 return (convert(str));
275 } catch (const std::exception&) {
277 "invalid " << type_name << " (" << str
278 << ") specified for parameter '" << name
279 << "' (" << getPosition(name, scope) << ")");
280 }
281 }
282
283public:
293 const std::string& name) {
294 return (getIntType<uint32_t>(scope, name));
295 }
296
306 const std::string& name) {
307 return (getIntType<uint16_t>(scope, name));
308 }
309
318 uint8_t getUint8(ConstElementPtr scope, const std::string& name) {
319 return (getIntType<uint8_t>(scope, name));
320 }
321
333 const std::string& name);
334};
335
336}
337}
338
339#endif
types
The types that an Element can hold.
Definition: data.h:139
static void checkKeywords(const SimpleKeywords &keywords, isc::data::ConstElementPtr scope)
Checks acceptable keywords with their expected type.
target_type getAndConvert(isc::data::ConstElementPtr scope, const std::string &name, const std::string &type_name)
Returns a converted value from a scope.
static size_t setListDefaults(isc::data::ConstElementPtr list, const SimpleDefaults &default_values)
Sets the default values for all entries in a list.
static const data::Element::Position & getPosition(const std::string &name, const data::ConstElementPtr parent)
Utility method that returns position of an element.
uint8_t getUint8(ConstElementPtr scope, const std::string &name)
Get an uint8_t value.
static double getDouble(const ConstElementPtr &scope, const std::string &name)
Returns a floating point parameter from a scope.
static void checkRequired(const SimpleRequiredKeywords &required, isc::data::ConstElementPtr scope)
Checks that all required keywords are present.
static isc::asiolink::IOAddress getAddress(const ConstElementPtr &scope, const std::string &name)
Returns a IOAddress parameter from a scope.
static std::string getString(isc::data::ConstElementPtr scope, const std::string &name)
Returns a string parameter from a scope.
uint32_t getUint32(isc::data::ConstElementPtr scope, const std::string &name)
Returns a value converted to uint32_t.
const isc::util::Triplet< uint32_t > parseIntTriplet(const data::ConstElementPtr &scope, const std::string &name)
Parses an integer triplet.
int_type getIntType(isc::data::ConstElementPtr scope, const std::string &name)
Returns an integer value with range checking from a scope.
static bool getBoolean(isc::data::ConstElementPtr scope, const std::string &name)
Returns a boolean parameter from a scope.
uint16_t getUint16(isc::data::ConstElementPtr scope, const std::string &name)
Returns a value converted to uint16_t.
static size_t deriveParams(isc::data::ConstElementPtr parent, isc::data::ElementPtr child, const ParamsList &params)
Derives (inherits) parameters from parent scope to a child.
static int64_t getInteger(isc::data::ConstElementPtr scope, const std::string &name)
Returns an integer parameter from a scope.
static size_t setDefaults(isc::data::ElementPtr scope, const SimpleDefaults &default_values)
Sets the default values.
To be removed. Please use ConfigError instead.
This template specifies a parameter value.
Definition: triplet.h:37
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
std::vector< std::string > SimpleRequiredKeywords
This specifies all required keywords.
std::vector< std::string > ParamsList
This defines a list of all parameters that are derived (or inherited) between contexts.
boost::shared_ptr< const Element > ConstElementPtr
Definition: data.h:29
std::vector< SimpleDefault > SimpleDefaults
This specifies all default values in a given scope (e.g. a subnet).
boost::shared_ptr< Element > ElementPtr
Definition: data.h:28
std::map< std::string, isc::data::Element::types > SimpleKeywords
This specifies all accepted keywords with their types.
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
This array defines a single entry of default values.
const isc::data::Element::types type_
SimpleDefault(const char *name, isc::data::Element::types type, const char *value)