Fawkes API
Fawkes Development Version
|
24 #ifndef _CONFIG_CONFIG_H_
25 #define _CONFIG_CONFIG_H_
27 #include <core/exception.h>
28 #include <utils/misc/string_compare.h>
37 class ConfigurationChangeHandler;
39 class ConfigurationException :
public Exception
77 virtual bool next() = 0;
80 virtual const char *
path()
const = 0;
81 virtual const char *
type()
const = 0;
84 virtual bool is_uint()
const = 0;
85 virtual bool is_int()
const = 0;
86 virtual bool is_bool()
const = 0;
88 virtual bool is_list()
const = 0;
92 virtual unsigned int get_uint()
const = 0;
93 virtual int get_int()
const = 0;
96 virtual std::vector<float>
get_floats()
const = 0;
97 virtual std::vector<unsigned int>
get_uints()
const = 0;
98 virtual std::vector<int>
get_ints()
const = 0;
99 virtual std::vector<bool>
get_bools()
const = 0;
100 virtual std::vector<std::string>
get_strings()
const = 0;
113 virtual void load(
const char *file_path) = 0;
115 virtual bool exists(
const char *path) = 0;
116 virtual bool is_float(
const char *path) = 0;
117 virtual bool is_uint(
const char *path) = 0;
118 virtual bool is_int(
const char *path) = 0;
119 virtual bool is_bool(
const char *path) = 0;
120 virtual bool is_string(
const char *path) = 0;
121 virtual bool is_list(
const char *path) = 0;
123 virtual bool is_default(
const char *path) = 0;
125 virtual float get_float(
const char *path) = 0;
126 virtual unsigned int get_uint(
const char *path) = 0;
127 virtual int get_int(
const char *path) = 0;
128 virtual bool get_bool(
const char *path) = 0;
129 virtual std::string
get_string(
const char *path) = 0;
131 virtual unsigned int get_uint_or_default(
const char *path,
const unsigned int &default_val);
135 virtual std::vector<float>
get_floats(
const char *path) = 0;
136 virtual std::vector<unsigned int>
get_uints(
const char *path) = 0;
137 virtual std::vector<int>
get_ints(
const char *path) = 0;
138 virtual std::vector<bool>
get_bools(
const char *path) = 0;
139 virtual std::vector<std::string>
get_strings(
const char *path) = 0;
141 const std::vector<float> &default_val);
142 virtual std::vector<unsigned int>
145 const std::vector<int> &default_val);
147 const std::vector<bool> &default_val);
148 virtual std::vector<std::string>
151 virtual std::string
get_type(
const char *path) = 0;
152 virtual std::string
get_comment(
const char *path) = 0;
155 virtual void set_float(
const char *path,
float f) = 0;
156 virtual void set_uint(
const char *path,
unsigned int uint) = 0;
157 virtual void set_int(
const char *path,
int i) = 0;
158 virtual void set_bool(
const char *path,
bool b) = 0;
159 virtual void set_string(
const char *path, std::string &s) = 0;
160 virtual void set_string(
const char *path,
const char *s) = 0;
161 virtual void set_floats(
const char *path, std::vector<float> &f) = 0;
162 virtual void set_uints(
const char *path, std::vector<unsigned int> &uint) = 0;
163 virtual void set_ints(
const char *path, std::vector<int> &i) = 0;
164 virtual void set_bools(
const char *path, std::vector<bool> &b) = 0;
165 virtual void set_strings(
const char *path, std::vector<std::string> &s) = 0;
166 virtual void set_strings(
const char *path, std::vector<const char *> &s) = 0;
167 virtual void set_comment(
const char *path,
const char *comment) = 0;
168 virtual void set_comment(
const char *path, std::string &comment) = 0;
170 virtual void erase(
const char *path) = 0;
188 virtual void lock() = 0;
190 virtual void unlock() = 0;
196 exists(
const std::string &path)
198 return exists(path.c_str());
207 is_uint(
const std::string &path)
212 is_int(
const std::string &path)
214 return is_int(path.c_str());
217 is_bool(
const std::string &path)
227 is_list(
const std::string &path)
249 get_int(
const std::string &path)
263 virtual std::vector<float>
268 virtual std::vector<unsigned int>
273 virtual std::vector<int>
278 virtual std::vector<bool>
283 virtual std::vector<std::string>
288 virtual ValueIterator *
310 set_float(
const std::string &path,
float f)
315 set_uint(
const std::string &path,
unsigned int uint)
320 set_int(
const std::string &path,
int i)
325 set_bool(
const std::string &path,
bool b)
330 set_string(
const std::string &path, std::string &s)
335 set_string(
const std::string &path,
const char *s)
340 set_floats(
const std::string &path, std::vector<float> &f)
345 set_uints(
const std::string &path, std::vector<unsigned int> &uint)
350 set_ints(
const std::string &path, std::vector<int> &i)
355 set_bools(
const std::string &path, std::vector<bool> &b)
360 set_strings(
const std::string &path, std::vector<std::string> &s)
365 set_strings(
const std::string &path, std::vector<const char *> &s)
370 set_comment(
const std::string &path,
const char *comment)
375 set_comment(
const std::string &path, std::string &comment)
381 erase(
const std::string &path)
434 virtual ValueIterator *
435 search(
const std::string &path)
437 return search(path.c_str());
446 typedef std::multimap<const char *, ConfigurationChangeHandler *, StringLess>
450 typedef std::pair<ChangeHandlerMultimap::iterator, ChangeHandlerMultimap::iterator>
virtual std::vector< int > get_ints(const char *path)=0
virtual bool valid() const =0
virtual void set_string(const char *path, std::string &s)=0
virtual std::string get_type(const char *path)=0
virtual bool is_default(const char *path)=0
std::list< ConfigurationChangeHandler * > ChangeHandlerList
List that contains pointers to ConfigurationChangeHandler.
ChangeHandlerMultimapRange _ch_range
Change handler range.
virtual void set_default_comment(const char *path, const char *comment)=0
virtual ValueIterator * iterator()=0
virtual bool get_bool() const =0
std::multimap< const char *, ConfigurationChangeHandler *, StringLess > ChangeHandlerMultimap
Multimap string to config change handlers.
virtual std::vector< unsigned int > get_uints() const =0
virtual void set_default_float(const char *path, float f)=0
virtual float get_float_or_default(const char *path, const float &default_val)
virtual std::vector< bool > get_bools(const char *path)=0
virtual bool is_string() const =0
virtual std::string get_as_string() const =0
virtual bool get_bool(const char *path)=0
virtual void load(const char *file_path)=0
virtual void set_default_int(const char *path, int i)=0
virtual std::string get_string() const =0
ChangeHandlerMultimap _change_handlers
Registered change handlers.
virtual bool is_bool(const char *path)=0
virtual bool is_list(const char *path)=0
virtual void set_floats(const char *path, std::vector< float > &f)=0
virtual void set_strings(const char *path, std::vector< std::string > &s)=0
virtual void erase_default(const char *path)=0
virtual bool is_list() const =0
ChangeHandlerList * find_handlers(const char *path)
Find handlers for given path.
virtual std::vector< unsigned int > get_uints(const char *path)=0
virtual std::vector< bool > get_bools() const =0
virtual int get_int(const char *path)=0
std::pair< ChangeHandlerMultimap::iterator, ChangeHandlerMultimap::iterator > ChangeHandlerMultimapRange
Config change handler multimap range.
virtual ValueIterator * search(const char *path)=0
ConfigTypeMismatchException(const char *path, const char *actual, const char *requested)
Constructor.
virtual bool is_bool() const =0
virtual void set_int(const char *path, int i)=0
virtual void set_default_bool(const char *path, bool b)=0
virtual bool is_default() const =0
virtual std::vector< float > get_floats(const char *path)=0
ConfigEntryNotFoundException(const char *path)
Constructor.
virtual void set_float(const char *path, float f)=0
virtual bool get_bool_or_default(const char *path, const bool &default_val)
virtual void set_bools(const char *path, std::vector< bool > &b)=0
virtual void set_bool(const char *path, bool b)=0
virtual void set_uints(const char *path, std::vector< unsigned int > &uint)=0
virtual void erase(const char *path)=0
virtual std::vector< int > get_ints() const =0
virtual bool is_float() const =0
virtual bool is_uint(const char *path)=0
virtual std::vector< std::string > get_strings(const char *path)=0
virtual bool is_float(const char *path)=0
virtual size_t get_list_size() const =0
virtual void set_default_uint(const char *path, unsigned int uint)=0
virtual void rem_change_handler(ConfigurationChangeHandler *h)
Remove a configuration change handler.
virtual std::vector< unsigned int > get_uints_or_defaults(const char *path, const std::vector< unsigned int > &default_val)
virtual bool is_int() const =0
virtual void set_default_string(const char *path, std::string &s)=0
virtual std::string get_comment(const char *path)=0
virtual std::string get_comment() const =0
virtual std::vector< std::string > get_strings_or_defaults(const char *path, const std::vector< std::string > &default_val)
virtual std::vector< float > get_floats_or_defaults(const char *path, const std::vector< float > &default_val)
virtual void set_comment(const char *path, const char *comment)=0
virtual float get_float(const char *path)=0
virtual unsigned int get_uint_or_default(const char *path, const unsigned int &default_val)
virtual void copy(Configuration *copyconf)=0
virtual int get_int() const =0
virtual const char * type() const =0
virtual unsigned int get_uint(const char *path)=0
virtual std::vector< float > get_floats() const =0
virtual bool try_lock()=0
virtual std::string get_string(const char *path)=0
virtual bool is_int(const char *path)=0
virtual std::string get_string_or_default(const char *path, const std::string &default_val)
virtual int get_int_or_default(const char *path, const int &default_val)
ConfigurationException(const char *msg)
Constructor.
virtual std::vector< int > get_ints_or_defaults(const char *path, const std::vector< int > &default_val)
virtual void try_dump()=0
virtual std::string get_default_comment(const char *path)=0
CouldNotOpenConfigException(const char *format,...)
Constructor.
virtual std::vector< std::string > get_strings() const =0
virtual std::vector< bool > get_bools_or_defaults(const char *path, const std::vector< bool > &default_val)
virtual bool exists(const char *path)=0
virtual void add_change_handler(ConfigurationChangeHandler *h)
Add a configuration change handler.
void notify_handlers(const char *path, bool comment_changed=false)
Notify handlers for given path.
virtual const char * path() const =0
virtual void set_uint(const char *path, unsigned int uint)=0
virtual void set_ints(const char *path, std::vector< int > &i)=0
virtual ValueIterator * get_value(const char *path)=0
virtual unsigned int get_uint() const =0
virtual bool is_uint() const =0
virtual float get_float() const =0
virtual bool is_string(const char *path)=0