3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #ifndef SETTINGS_HEADER
21 #define SETTINGS_HEADER
23 #include "irrlichttypes_bloated.h"
24 #include "util/string.h"
25 #include "jthread/jmutex.h"
34 /** function type to register a changed callback */
35 typedef void (*setting_changed_callback)(const std::string, void*);
39 VALUETYPE_FLAG // Doesn't take any arguments
42 enum SettingsParseEvent {
53 ValueSpec(ValueType a_type, const char *a_help=NULL)
63 struct SettingsEntry {
70 SettingsEntry(const std::string &value_)
77 SettingsEntry(Settings *group_)
93 Settings & operator += (const Settings &other);
94 Settings & operator = (const Settings &other);
96 /***********************
97 * Reading and writing *
98 ***********************/
100 // Read configuration file. Returns success.
101 bool readConfigFile(const char *filename);
102 //Updates configuration file. Returns success.
103 bool updateConfigFile(const char *filename);
104 // NOTE: Types of allowed_options are ignored. Returns success.
105 bool parseCommandLine(int argc, char *argv[],
106 std::map<std::string, ValueSpec> &allowed_options);
107 bool parseConfigLines(std::istream &is, const std::string &end = "");
108 void writeLines(std::ostream &os, u32 tab_depth=0) const;
110 SettingsParseEvent parseConfigObject(const std::string &line,
111 const std::string &end, std::string &name, std::string &value);
112 bool updateConfigObject(std::istream &is, std::ostream &os,
113 const std::string &end, u32 tab_depth=0);
115 static bool checkNameValid(const std::string &name);
116 static bool checkValueValid(const std::string &value);
117 static std::string sanitizeName(const std::string &name);
118 static std::string sanitizeValue(const std::string &value);
119 static std::string getMultiline(std::istream &is, size_t *num_lines=NULL);
120 static void printEntry(std::ostream &os, const std::string &name,
121 const SettingsEntry &entry, u32 tab_depth=0);
127 const SettingsEntry &getEntry(const std::string &name) const;
128 Settings *getGroup(const std::string &name) const;
129 std::string get(const std::string &name) const;
130 bool getBool(const std::string &name) const;
131 u16 getU16(const std::string &name) const;
132 s16 getS16(const std::string &name) const;
133 s32 getS32(const std::string &name) const;
134 u64 getU64(const std::string &name) const;
135 float getFloat(const std::string &name) const;
136 v2f getV2F(const std::string &name) const;
137 v3f getV3F(const std::string &name) const;
138 u32 getFlagStr(const std::string &name, const FlagDesc *flagdesc,
139 u32 *flagmask) const;
140 // N.B. if getStruct() is used to read a non-POD aggregate type,
141 // the behavior is undefined.
142 bool getStruct(const std::string &name, const std::string &format,
143 void *out, size_t olen) const;
144 bool getNoiseParams(const std::string &name, NoiseParams &np) const;
145 bool getNoiseParamsFromValue(const std::string &name, NoiseParams &np) const;
146 bool getNoiseParamsFromGroup(const std::string &name, NoiseParams &np) const;
148 // return all keys used
149 std::vector<std::string> getNames() const;
150 bool exists(const std::string &name) const;
153 /***************************************
154 * Getters that don't throw exceptions *
155 ***************************************/
157 bool getEntryNoEx(const std::string &name, SettingsEntry &val) const;
158 bool getGroupNoEx(const std::string &name, Settings *&val) const;
159 bool getNoEx(const std::string &name, std::string &val) const;
160 bool getFlag(const std::string &name) const;
161 bool getU16NoEx(const std::string &name, u16 &val) const;
162 bool getS16NoEx(const std::string &name, s16 &val) const;
163 bool getS32NoEx(const std::string &name, s32 &val) const;
164 bool getU64NoEx(const std::string &name, u64 &val) const;
165 bool getFloatNoEx(const std::string &name, float &val) const;
166 bool getV2FNoEx(const std::string &name, v2f &val) const;
167 bool getV3FNoEx(const std::string &name, v3f &val) const;
168 // N.B. getFlagStrNoEx() does not set val, but merely modifies it. Thus,
169 // val must be initialized before using getFlagStrNoEx(). The intention of
170 // this is to simplify modifying a flags field from a default value.
171 bool getFlagStrNoEx(const std::string &name, u32 &val, FlagDesc *flagdesc) const;
178 // N.B. Groups not allocated with new must be set to NULL in the settings
179 // tree before object destruction.
180 bool setEntry(const std::string &name, const void *entry,
181 bool set_group, bool set_default);
182 bool set(const std::string &name, const std::string &value);
183 bool setDefault(const std::string &name, const std::string &value);
184 bool setGroup(const std::string &name, Settings *group);
185 bool setGroupDefault(const std::string &name, Settings *group);
186 bool setBool(const std::string &name, bool value);
187 bool setS16(const std::string &name, s16 value);
188 bool setU16(const std::string &name, u16 value);
189 bool setS32(const std::string &name, s32 value);
190 bool setU64(const std::string &name, u64 value);
191 bool setFloat(const std::string &name, float value);
192 bool setV2F(const std::string &name, v2f value);
193 bool setV3F(const std::string &name, v3f value);
194 bool setFlagStr(const std::string &name, u32 flags,
195 const FlagDesc *flagdesc, u32 flagmask);
196 bool setNoiseParams(const std::string &name, const NoiseParams &np,
197 bool set_default=false);
198 // N.B. if setStruct() is used to write a non-POD aggregate type,
199 // the behavior is undefined.
200 bool setStruct(const std::string &name, const std::string &format, void *value);
203 bool remove(const std::string &name);
205 void updateValue(const Settings &other, const std::string &name);
206 void update(const Settings &other);
207 void registerChangedCallback(std::string name, setting_changed_callback cbf, void *userdata = NULL);
208 void deregisterChangedCallback(std::string name, setting_changed_callback cbf, void *userdata = NULL);
212 void updateNoLock(const Settings &other);
215 void doCallbacks(std::string name);
217 std::map<std::string, SettingsEntry> m_settings;
218 std::map<std::string, SettingsEntry> m_defaults;
220 std::map<std::string, std::vector<std::pair<setting_changed_callback,void*> > > m_callbacks;
222 mutable JMutex m_callbackMutex;
223 mutable JMutex m_mutex; // All methods that access m_settings/m_defaults directly should lock this.