mirror of
https://github.com/minetest/minetest.git
synced 2024-11-23 16:13:46 +01:00
613797a304
This is part 2 for 5f084cd98d7b3326b51320455364337539710efd Other improvements: * Use the defined ItemGroupList when used * make Client::checkPrivilege const * inline some trivial functions * Add ActiveObjectMap typedef * Add SettingsEntries typedef
250 lines
7.8 KiB
C++
250 lines
7.8 KiB
C++
/*
|
|
Minetest
|
|
Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU Lesser General Public License as published by
|
|
the Free Software Foundation; either version 2.1 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public License along
|
|
with this program; if not, write to the Free Software Foundation, Inc.,
|
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
|
|
#ifndef SETTINGS_HEADER
|
|
#define SETTINGS_HEADER
|
|
|
|
#include "irrlichttypes_bloated.h"
|
|
#include "util/string.h"
|
|
#include "threading/mutex.h"
|
|
#include <string>
|
|
#include "util/cpp11_container.h"
|
|
#include <list>
|
|
#include <set>
|
|
|
|
class Settings;
|
|
struct NoiseParams;
|
|
|
|
// Global objects
|
|
extern Settings *g_settings;
|
|
extern std::string g_settings_path;
|
|
|
|
// Type for a settings changed callback function
|
|
typedef void (*SettingsChangedCallback)(const std::string &name, void *data);
|
|
|
|
typedef std::vector<
|
|
std::pair<
|
|
SettingsChangedCallback,
|
|
void *
|
|
>
|
|
> SettingsCallbackList;
|
|
|
|
typedef UNORDERED_MAP<std::string, SettingsCallbackList> SettingsCallbackMap;
|
|
|
|
enum ValueType {
|
|
VALUETYPE_STRING,
|
|
VALUETYPE_FLAG // Doesn't take any arguments
|
|
};
|
|
|
|
enum SettingsParseEvent {
|
|
SPE_NONE,
|
|
SPE_INVALID,
|
|
SPE_COMMENT,
|
|
SPE_KVPAIR,
|
|
SPE_END,
|
|
SPE_GROUP,
|
|
SPE_MULTILINE,
|
|
};
|
|
|
|
struct ValueSpec {
|
|
ValueSpec(ValueType a_type, const char *a_help=NULL)
|
|
{
|
|
type = a_type;
|
|
help = a_help;
|
|
}
|
|
|
|
ValueType type;
|
|
const char *help;
|
|
};
|
|
|
|
struct SettingsEntry {
|
|
SettingsEntry()
|
|
{
|
|
group = NULL;
|
|
is_group = false;
|
|
}
|
|
|
|
SettingsEntry(const std::string &value_)
|
|
{
|
|
value = value_;
|
|
group = NULL;
|
|
is_group = false;
|
|
}
|
|
|
|
SettingsEntry(Settings *group_)
|
|
{
|
|
group = group_;
|
|
is_group = true;
|
|
}
|
|
|
|
std::string value;
|
|
Settings *group;
|
|
bool is_group;
|
|
};
|
|
|
|
typedef UNORDERED_MAP<std::string, SettingsEntry> SettingEntries;
|
|
|
|
class Settings {
|
|
public:
|
|
Settings() {}
|
|
~Settings();
|
|
|
|
Settings & operator += (const Settings &other);
|
|
Settings & operator = (const Settings &other);
|
|
|
|
/***********************
|
|
* Reading and writing *
|
|
***********************/
|
|
|
|
// Read configuration file. Returns success.
|
|
bool readConfigFile(const char *filename);
|
|
//Updates configuration file. Returns success.
|
|
bool updateConfigFile(const char *filename);
|
|
// NOTE: Types of allowed_options are ignored. Returns success.
|
|
bool parseCommandLine(int argc, char *argv[],
|
|
std::map<std::string, ValueSpec> &allowed_options);
|
|
bool parseConfigLines(std::istream &is, const std::string &end = "");
|
|
void writeLines(std::ostream &os, u32 tab_depth=0) const;
|
|
|
|
SettingsParseEvent parseConfigObject(const std::string &line,
|
|
const std::string &end, std::string &name, std::string &value);
|
|
bool updateConfigObject(std::istream &is, std::ostream &os,
|
|
const std::string &end, u32 tab_depth=0);
|
|
|
|
static bool checkNameValid(const std::string &name);
|
|
static bool checkValueValid(const std::string &value);
|
|
static std::string sanitizeName(const std::string &name);
|
|
static std::string sanitizeValue(const std::string &value);
|
|
static std::string getMultiline(std::istream &is, size_t *num_lines=NULL);
|
|
static void printEntry(std::ostream &os, const std::string &name,
|
|
const SettingsEntry &entry, u32 tab_depth=0);
|
|
|
|
/***********
|
|
* Getters *
|
|
***********/
|
|
|
|
const SettingsEntry &getEntry(const std::string &name) const;
|
|
Settings *getGroup(const std::string &name) const;
|
|
std::string get(const std::string &name) const;
|
|
bool getBool(const std::string &name) const;
|
|
u16 getU16(const std::string &name) const;
|
|
s16 getS16(const std::string &name) const;
|
|
s32 getS32(const std::string &name) const;
|
|
u64 getU64(const std::string &name) const;
|
|
float getFloat(const std::string &name) const;
|
|
v2f getV2F(const std::string &name) const;
|
|
v3f getV3F(const std::string &name) const;
|
|
u32 getFlagStr(const std::string &name, const FlagDesc *flagdesc,
|
|
u32 *flagmask) const;
|
|
// N.B. if getStruct() is used to read a non-POD aggregate type,
|
|
// the behavior is undefined.
|
|
bool getStruct(const std::string &name, const std::string &format,
|
|
void *out, size_t olen) const;
|
|
bool getNoiseParams(const std::string &name, NoiseParams &np) const;
|
|
bool getNoiseParamsFromValue(const std::string &name, NoiseParams &np) const;
|
|
bool getNoiseParamsFromGroup(const std::string &name, NoiseParams &np) const;
|
|
|
|
// return all keys used
|
|
std::vector<std::string> getNames() const;
|
|
bool exists(const std::string &name) const;
|
|
|
|
|
|
/***************************************
|
|
* Getters that don't throw exceptions *
|
|
***************************************/
|
|
|
|
bool getEntryNoEx(const std::string &name, SettingsEntry &val) const;
|
|
bool getGroupNoEx(const std::string &name, Settings *&val) const;
|
|
bool getNoEx(const std::string &name, std::string &val) const;
|
|
bool getFlag(const std::string &name) const;
|
|
bool getU16NoEx(const std::string &name, u16 &val) const;
|
|
bool getS16NoEx(const std::string &name, s16 &val) const;
|
|
bool getS32NoEx(const std::string &name, s32 &val) const;
|
|
bool getU64NoEx(const std::string &name, u64 &val) const;
|
|
bool getFloatNoEx(const std::string &name, float &val) const;
|
|
bool getV2FNoEx(const std::string &name, v2f &val) const;
|
|
bool getV3FNoEx(const std::string &name, v3f &val) const;
|
|
// N.B. getFlagStrNoEx() does not set val, but merely modifies it. Thus,
|
|
// val must be initialized before using getFlagStrNoEx(). The intention of
|
|
// this is to simplify modifying a flags field from a default value.
|
|
bool getFlagStrNoEx(const std::string &name, u32 &val, FlagDesc *flagdesc) const;
|
|
|
|
|
|
/***********
|
|
* Setters *
|
|
***********/
|
|
|
|
// N.B. Groups not allocated with new must be set to NULL in the settings
|
|
// tree before object destruction.
|
|
bool setEntry(const std::string &name, const void *entry,
|
|
bool set_group, bool set_default);
|
|
bool set(const std::string &name, const std::string &value);
|
|
bool setDefault(const std::string &name, const std::string &value);
|
|
bool setGroup(const std::string &name, Settings *group);
|
|
bool setGroupDefault(const std::string &name, Settings *group);
|
|
bool setBool(const std::string &name, bool value);
|
|
bool setS16(const std::string &name, s16 value);
|
|
bool setU16(const std::string &name, u16 value);
|
|
bool setS32(const std::string &name, s32 value);
|
|
bool setU64(const std::string &name, u64 value);
|
|
bool setFloat(const std::string &name, float value);
|
|
bool setV2F(const std::string &name, v2f value);
|
|
bool setV3F(const std::string &name, v3f value);
|
|
bool setFlagStr(const std::string &name, u32 flags,
|
|
const FlagDesc *flagdesc, u32 flagmask);
|
|
bool setNoiseParams(const std::string &name, const NoiseParams &np,
|
|
bool set_default=false);
|
|
// N.B. if setStruct() is used to write a non-POD aggregate type,
|
|
// the behavior is undefined.
|
|
bool setStruct(const std::string &name, const std::string &format, void *value);
|
|
|
|
// remove a setting
|
|
bool remove(const std::string &name);
|
|
void clear();
|
|
void clearDefaults();
|
|
void updateValue(const Settings &other, const std::string &name);
|
|
void update(const Settings &other);
|
|
|
|
void registerChangedCallback(const std::string &name,
|
|
SettingsChangedCallback cbf, void *userdata = NULL);
|
|
void deregisterChangedCallback(const std::string &name,
|
|
SettingsChangedCallback cbf, void *userdata = NULL);
|
|
|
|
private:
|
|
void updateNoLock(const Settings &other);
|
|
void clearNoLock();
|
|
void clearDefaultsNoLock();
|
|
|
|
void doCallbacks(const std::string &name) const;
|
|
|
|
SettingEntries m_settings;
|
|
SettingEntries m_defaults;
|
|
|
|
SettingsCallbackMap m_callbacks;
|
|
|
|
mutable Mutex m_callback_mutex;
|
|
|
|
// All methods that access m_settings/m_defaults directly should lock this.
|
|
mutable Mutex m_mutex;
|
|
|
|
};
|
|
|
|
#endif
|
|
|