Fawkes API  Fawkes Development Version
memory.h
1 
2 /***************************************************************************
3  * memory.h - Fawkes in-memory configuration
4  *
5  * Created: Sat Dec 29 12:15:48 2012
6  * Copyright 2006-2012 Tim Niemueller [www.niemueller.de]
7  *
8  ****************************************************************************/
9 
10 /* This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version. A runtime exception applies to
14  * this software (see LICENSE.GPL_WRE file mentioned below for details).
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Library General Public License for more details.
20  *
21  * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22  */
23 
24 #ifndef _CONFIG_MEMORY_H_
25 #define _CONFIG_MEMORY_H_
26 
27 #include <config/config.h>
28 #include <config/yaml.h>
29 
30 #include <string>
31 #include <vector>
32 
33 namespace fawkes {
34 
35 class YamlConfigurationNode;
36 class Mutex;
37 
38 class MemoryConfiguration : public Configuration
39 {
40 public:
43 
44  virtual void copy(Configuration *copyconf);
45 
46  virtual void load(const char *file_path);
47 
48  virtual bool exists(const char *path);
49  virtual bool is_float(const char *path);
50  virtual bool is_uint(const char *path);
51  virtual bool is_int(const char *path);
52  virtual bool is_bool(const char *path);
53  virtual bool is_string(const char *path);
54  virtual bool is_list(const char *path);
55 
56  virtual bool is_default(const char *path);
57 
58  virtual std::string get_type(const char *path);
59  virtual float get_float(const char *path);
60  virtual unsigned int get_uint(const char *path);
61  virtual int get_int(const char *path);
62  virtual bool get_bool(const char *path);
63  virtual std::string get_string(const char *path);
64  virtual std::vector<float> get_floats(const char *path);
65  virtual std::vector<unsigned int> get_uints(const char *path);
66  virtual std::vector<int> get_ints(const char *path);
67  virtual std::vector<bool> get_bools(const char *path);
68  virtual std::vector<std::string> get_strings(const char *path);
69  virtual ValueIterator * get_value(const char *path);
70  virtual std::string get_comment(const char *path);
71  virtual std::string get_default_comment(const char *path);
72 
73  virtual void set_float(const char *path, float f);
74  virtual void set_uint(const char *path, unsigned int uint);
75  virtual void set_int(const char *path, int i);
76  virtual void set_bool(const char *path, bool b);
77  virtual void set_string(const char *path, std::string &s);
78  virtual void set_string(const char *path, const char *s);
79  virtual void set_floats(const char *path, std::vector<float> &f);
80  virtual void set_uints(const char *path, std::vector<unsigned int> &uint);
81  virtual void set_ints(const char *path, std::vector<int> &i);
82  virtual void set_bools(const char *path, std::vector<bool> &b);
83  virtual void set_strings(const char *path, std::vector<std::string> &s);
84  virtual void set_strings(const char *path, std::vector<const char *> &s);
85  virtual void set_comment(const char *path, std::string &comment);
86  virtual void set_comment(const char *path, const char *comment);
87 
88  virtual void erase(const char *path);
89 
90  virtual void set_default_float(const char *path, float f);
91  virtual void set_default_uint(const char *path, unsigned int uint);
92  virtual void set_default_int(const char *path, int i);
93  virtual void set_default_bool(const char *path, bool b);
94  virtual void set_default_string(const char *path, std::string &s);
95  virtual void set_default_string(const char *path, const char *s);
96  virtual void set_default_comment(const char *path, const char *comment);
97  virtual void set_default_comment(const char *path, std::string &comment);
98 
99  virtual void erase_default(const char *path);
100 
104  ValueIterator *search(const char *path);
105 
106  void lock();
107  bool try_lock();
108  void unlock();
109 
110  virtual void try_dump();
111 
112 private:
113  std::shared_ptr<YamlConfigurationNode> query(const char *path) const;
114 
115  std::shared_ptr<YamlConfigurationNode> root_;
116 
117 private:
118  Mutex *mutex_;
119 };
120 
121 } // end namespace fawkes
122 
123 #endif
fawkes::MemoryConfiguration::get_ints
virtual std::vector< int > get_ints(const char *path)
Definition: memory.cpp:176
fawkes::MemoryConfiguration::set_comment
virtual void set_comment(const char *path, std::string &comment)
Definition: memory.cpp:376
fawkes::MemoryConfiguration::get_int
virtual int get_int(const char *path)
Definition: memory.cpp:146
fawkes::MemoryConfiguration::is_default
virtual bool is_default(const char *path)
Definition: memory.cpp:256
fawkes::MemoryConfiguration::get_comment
virtual std::string get_comment(const char *path)
Definition: memory.cpp:92
fawkes::MemoryConfiguration::set_strings
virtual void set_strings(const char *path, std::vector< std::string > &s)
Definition: memory.cpp:357
fawkes::Mutex
Definition: mutex.h:36
fawkes::MemoryConfiguration::get_type
virtual std::string get_type(const char *path)
Definition: memory.cpp:81
fawkes::MemoryConfiguration::get_strings
virtual std::vector< std::string > get_strings(const char *path)
Definition: memory.cpp:188
fawkes::MemoryConfiguration::get_value
virtual ValueIterator * get_value(const char *path)
Definition: memory.cpp:272
fawkes::MemoryConfiguration::unlock
void unlock()
Unlock the config.
Definition: memory.cpp:467
fawkes::MemoryConfiguration::set_floats
virtual void set_floats(const char *path, std::vector< float > &f)
Definition: memory.cpp:329
fawkes::MemoryConfiguration::set_default_bool
virtual void set_default_bool(const char *path, bool b)
Definition: memory.cpp:408
fawkes::MemoryConfiguration::is_list
virtual bool is_list(const char *path)
Definition: memory.cpp:240
fawkes::MemoryConfiguration::erase
virtual void erase(const char *path)
Definition: memory.cpp:381
fawkes::MemoryConfiguration::load
virtual void load(const char *file_path)
Definition: memory.cpp:59
fawkes::MemoryConfiguration::~MemoryConfiguration
virtual ~MemoryConfiguration()
Destructor.
Definition: memory.cpp:53
fawkes::MemoryConfiguration::search
ValueIterator * search(const char *path)
Definition: memory.cpp:530
fawkes::MemoryConfiguration::set_uints
virtual void set_uints(const char *path, std::vector< unsigned int > &uint)
Definition: memory.cpp:336
fawkes::MemoryConfiguration::set_default_comment
virtual void set_default_comment(const char *path, const char *comment)
Definition: memory.cpp:428
fawkes::MemoryConfiguration::copy
virtual void copy(Configuration *copyconf)
Definition: memory.cpp:64
fawkes::MemoryConfiguration::get_floats
virtual std::vector< float > get_floats(const char *path)
Definition: memory.cpp:164
fawkes::Configuration::ValueIterator
Definition: config.h:75
fawkes::MemoryConfiguration::get_string
virtual std::string get_string(const char *path)
Definition: memory.cpp:158
fawkes::Configuration
Definition: config.h:68
fawkes::MemoryConfiguration::is_uint
virtual bool is_uint(const char *path)
Definition: memory.cpp:216
fawkes::MemoryConfiguration::erase_default
virtual void erase_default(const char *path)
Definition: memory.cpp:438
fawkes::MemoryConfiguration::iterator_hostspecific
ValueIterator * iterator_hostspecific()
Get iterator over host-specific values.
Definition: memory.cpp:511
fawkes::MemoryConfiguration::get_default_comment
virtual std::string get_default_comment(const char *path)
Definition: memory.cpp:250
fawkes::MemoryConfiguration::try_dump
virtual void try_dump()
Definition: memory.cpp:473
fawkes::MemoryConfiguration::set_float
virtual void set_float(const char *path, float f)
Definition: memory.cpp:288
fawkes::MemoryConfiguration::set_default_float
virtual void set_default_float(const char *path, float f)
Definition: memory.cpp:387
fawkes::MemoryConfiguration::get_bool
virtual bool get_bool(const char *path)
Definition: memory.cpp:152
fawkes::MemoryConfiguration::is_float
virtual bool is_float(const char *path)
Definition: memory.cpp:210
fawkes::MemoryConfiguration::iterator_default
ValueIterator * iterator_default()
Get iterator over default values.
Definition: memory.cpp:489
fawkes
fawkes::MemoryConfiguration::is_string
virtual bool is_string(const char *path)
Definition: memory.cpp:234
fawkes::MemoryConfiguration::get_bools
virtual std::vector< bool > get_bools(const char *path)
Definition: memory.cpp:182
fawkes::MemoryConfiguration::iterator
ValueIterator * iterator()
Definition: memory.cpp:478
fawkes::MemoryConfiguration::set_int
virtual void set_int(const char *path, int i)
Definition: memory.cpp:302
fawkes::MemoryConfiguration::set_bool
virtual void set_bool(const char *path, bool b)
Definition: memory.cpp:309
fawkes::MemoryConfiguration::set_default_string
virtual void set_default_string(const char *path, std::string &s)
Definition: memory.cpp:422
fawkes::MemoryConfiguration::set_uint
virtual void set_uint(const char *path, unsigned int uint)
Definition: memory.cpp:295
fawkes::MemoryConfiguration::lock
void lock()
Lock the config.
Definition: memory.cpp:448
fawkes::MemoryConfiguration::set_default_uint
virtual void set_default_uint(const char *path, unsigned int uint)
Definition: memory.cpp:394
fawkes::MemoryConfiguration::is_bool
virtual bool is_bool(const char *path)
Definition: memory.cpp:228
fawkes::MemoryConfiguration::get_uint
virtual unsigned int get_uint(const char *path)
Definition: memory.cpp:140
fawkes::MemoryConfiguration::MemoryConfiguration
MemoryConfiguration()
Constructor.
Definition: memory.cpp:46
fawkes::MemoryConfiguration::set_default_int
virtual void set_default_int(const char *path, int i)
Definition: memory.cpp:401
fawkes::MemoryConfiguration::exists
virtual bool exists(const char *path)
Definition: memory.cpp:70
fawkes::MemoryConfiguration::set_bools
virtual void set_bools(const char *path, std::vector< bool > &b)
Definition: memory.cpp:350
fawkes::MemoryConfiguration::get_float
virtual float get_float(const char *path)
Definition: memory.cpp:134
fawkes::MemoryConfiguration::set_string
virtual void set_string(const char *path, std::string &s)
Definition: memory.cpp:323
fawkes::MemoryConfiguration::try_lock
bool try_lock()
Try to lock the config.
Definition: memory.cpp:458
fawkes::MemoryConfiguration::set_ints
virtual void set_ints(const char *path, std::vector< int > &i)
Definition: memory.cpp:343
fawkes::MemoryConfiguration::get_uints
virtual std::vector< unsigned int > get_uints(const char *path)
Definition: memory.cpp:170
fawkes::MemoryConfiguration::is_int
virtual bool is_int(const char *path)
Definition: memory.cpp:222