1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207 | /*
* @file Configuration.h
*
* @author <a href="mailto:krause@informatik.hu-berlin.de">Thomas Krause</a>
* @author <a href="mailto:xu@informatik.hu-berlin.de">Xu Yuan</a>
* @breief the gloabl configuration for NaoTH framework
*
*/
#ifndef CONFIGURATION_H
#define CONFIGURATION_H
#include <string>
#include <set>
#include <glib.h>
namespace naoth
{
class Configuration<--- The class 'Configuration' has 'copy constructor' but lack of 'operator='.
{
public:
Configuration();
Configuration(const Configuration& orig);
virtual ~Configuration();
void loadFromDir(std::string dirlocation,
const std::string &platform,
const std::string& scheme,
const std::string &strategy,
const std::string& bodyID,
const std::string& headID,
const std::string& robotName);
// note this function only save private keys
void save();
/**
* Get all keys for a specific group.
* @param group
* @return
*/
std::set<std::string> getKeys(const std::string& group) const;
/**
* Returns true if the configuration has a key with this name and group
* @param group
* @param key
* @return
*/
bool hasKey(const std::string& group, const std::string& key) const;
/**
* Returns true if the configuration has a group with this name
* @param group
*/
bool hasGroup(const std::string& group) const;
/**
* Returns true if the configuration has a group with this name
* and copies the content of the key to value
* @param group
* @param key
* @return
*/
// EXPERIMENTAL
bool getT(const std::string& group, const std::string& key, int& value)<--- Technically the member function 'naoth::Configuration::getT' can be const. [+]The member function 'naoth::Configuration::getT' can be made a const function. Making this function 'const' should not cause compiler errors. Even though the function can be made const function technically it may not make sense conceptually. Think about your design and the task of the function first - is it a function that must not change object internal state?
{
if(hasKey(group,key)) {
value = getInt(group,key);
return true;
}
return false;
}//end get int
/**
* Get a string value from the configuration
* @param group
* @param key
* @return
*/
std::string getString(const std::string& group, const std::string& key) const;
bool get(const std::string& group, const std::string& key, std::string& result) const {
if(hasKey(group,key)) {
result = getString(group, key);
return true;
}
return false;
}
void setString(const std::string& group, const std::string& key, const std::string& value);
void set(const std::string& group, const std::string& key, const std::string& value) {
setString(group, key, value);
}
void setDefault(const std::string& group, const std::string& key, const std::string& value);
/**
* Get a double value from the configuration
* @param group
* @param key
* @return
*/
double getDouble(const std::string& group, const std::string& key) const;
bool get(const std::string& group, const std::string& key, double& result) const {
if(hasKey(group,key)) {
result = getDouble(group, key);
return true;
}
return false;
}
void setDouble(const std::string& group, const std::string& key, double value);
void set(const std::string& group, const std::string& key, double value) {
setDouble(group, key, value);
}
void setDefault(const std::string& group, const std::string& key, double value);
/**
* Get an integer value from the configuration
* @param group
* @param key
* @return
*/
int getInt(const std::string& group, const std::string& key) const;
bool get(const std::string& group, const std::string& key, int& result) const {
if(hasKey(group,key)) {
result = getInt(group, key);
return true;
}
return false;
}
bool get(const std::string& group, const std::string& key, unsigned int& result) const {
if(hasKey(group,key)) {
result = static_cast<unsigned int>(getInt(group, key));
return true;
}
return false;
}
void setInt(const std::string& group, const std::string& key, int value);
void set(const std::string& group, const std::string& key, int value) {
setInt(group, key, value);
}
void set(const std::string& group, const std::string& key, unsigned int value) {
setInt(group, key, static_cast<int>(value));
}
void setDefault(const std::string& group, const std::string& key, int value);
void setDefault(const std::string& group, const std::string& key, unsigned int value);
/**
* Get a bool value from the configuration
* @param group
* @param key
* @return
*/
bool getBool(const std::string& group, const std::string& key) const;
bool get(const std::string& group, const std::string& key, bool& result) const {
if(hasKey(group,key)) {
result = getBool(group, key);
return true;
}
return false;
}
void setBool(const std::string& group, const std::string& key, bool value);
void set(const std::string& group, const std::string& key, bool value) {
setBool(group, key, value);
}
void setDefault(const std::string& group, const std::string& key, bool value);
/**
* Get a raw and uninterpretated string from the configuration
* @param group
* @param key
* @return
*/
std::string getRawValue(const std::string& group, const std::string& key) const;
void setRawValue(const std::string& group, const std::string& key, const std::string& value);
private:
GKeyFile* publicKeyFile;
GKeyFile* privateKeyFile;
std::string privateDir;
// returns true if the path exists and is a directory, false otherwise
bool isDir(std::string& path) const {<--- Technically the member function 'naoth::Configuration::isDir' can be static. [+]The member function 'naoth::Configuration::isDir' can be made a static function. Making a function static can bring a performance benefit since no 'this' instance is passed to the function. This change should not cause compiler errors but it does not necessarily make sense conceptually. Think about your design and the task of the function first - is it a function that must not access members of class instances?
return g_file_test(path.c_str(), G_FILE_TEST_EXISTS) && g_file_test(path.c_str(), G_FILE_TEST_IS_DIR);
}
void loadFromSingleDir(GKeyFile* keyFile, std::string dirlocation, bool required = true);
void loadFile(GKeyFile* keyFile, std::string file, std::string groupName);
void saveFile(GKeyFile* keyFile, const std::string& file, const std::string& group);
GKeyFile* chooseKeyFile(const std::string& group, const std::string& key) const { return ( g_key_file_has_key(privateKeyFile, group.c_str(), key.c_str(), NULL) > 0 ) ? privateKeyFile : publicKeyFile; }
};//end class Configuration
}
#endif /* CONFIGURATION_H */
|