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
|
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */
#ifndef CONFIG_VALUE_H
#define CONFIG_VALUE_H
#include <boost/noncopyable.hpp>
#include <map>
#include <string>
#include "System/StringConvertibleOptionalValue.h"
/**
* @brief Untyped configuration variable meta data.
*
* That is, meta data of a type that does not depend on the declared type
* of the config variable.
*/
class ConfigVariableMetaData : public boost::noncopyable
{
public:
typedef TypedStringConvertibleOptionalValue<std::string> OptionalString;
typedef TypedStringConvertibleOptionalValue<int> OptionalInt;
virtual ~ConfigVariableMetaData() {}
/// @brief Get the default value of this config variable.
virtual const StringConvertibleOptionalValue& GetDefaultValue() const = 0;
/// @brief Get the minimum value of this config variable.
virtual const StringConvertibleOptionalValue& GetMinimumValue() const = 0;
/// @brief Get the maximum value of this config variable.
virtual const StringConvertibleOptionalValue& GetMaximumValue() const = 0;
/// @brief Get the safemode value of this config variable.
virtual const StringConvertibleOptionalValue& GetSafemodeValue() const = 0;
/// @brief Get the headless value of this config variable.
virtual const StringConvertibleOptionalValue& GetHeadlessValue() const = 0;
/// @brief Get the dedicated value of this config variable.
virtual const StringConvertibleOptionalValue& GetDedicatedValue() const = 0;
/// @brief Clamp a value using the declared minimum and maximum value.
virtual std::string Clamp(const std::string& value) const = 0;
std::string GetKey() const { return key; }
std::string GetType() const { return type; }
const OptionalString& GetDeclarationFile() const { return declarationFile; }
const OptionalInt& GetDeclarationLine() const { return declarationLine; }
const OptionalString& GetDescription() const { return description; }
const OptionalInt& GetReadOnly() const { return readOnly; }
protected:
const char* key;
const char* type;
OptionalString declarationFile;
OptionalInt declarationLine;
OptionalString description;
OptionalInt readOnly;
template<typename F> friend class ConfigVariableBuilder;
};
/**
* @brief Typed configuration variable meta data.
*
* That is, meta data of the same type as the declared type
* of the config variable.
*/
template<typename T>
class ConfigVariableTypedMetaData : public ConfigVariableMetaData
{
public:
ConfigVariableTypedMetaData(const char* k, const char* t) { key = k; type = t; }
const StringConvertibleOptionalValue& GetDefaultValue() const { return defaultValue; }
const StringConvertibleOptionalValue& GetMinimumValue() const { return minimumValue; }
const StringConvertibleOptionalValue& GetMaximumValue() const { return maximumValue; }
const StringConvertibleOptionalValue& GetSafemodeValue() const { return safemodeValue; }
const StringConvertibleOptionalValue& GetHeadlessValue() const { return headlessValue; }
const StringConvertibleOptionalValue& GetDedicatedValue() const { return dedicatedValue; }
/**
* @brief Clamp a value using the declared minimum and maximum value.
*
* Even though the input and the output is passed as string, the clamping
* happens in the domain of the declared type of the config variable.
* This may be a different type than what is read from the ConfigHandler.
*
* For example: a config variable declared as int will be clamped in the
* int domain even if ConfigHandler::GetString is used to fetch it.
*
* This guarantees the value will always be in range, even if Lua, a client
* of unitsync or erroneous Spring code uses the wrong getter.
*/
std::string Clamp(const std::string& value) const
{
TypedStringConvertibleOptionalValue<T> temp;
temp = TypedStringConvertibleOptionalValue<T>::FromString(value);
if (minimumValue.IsSet()) {
temp = std::max(temp.Get(), minimumValue.Get());
}
if (maximumValue.IsSet()) {
temp = std::min(temp.Get(), maximumValue.Get());
}
return temp.ToString();
}
protected:
TypedStringConvertibleOptionalValue<T> defaultValue;
TypedStringConvertibleOptionalValue<T> minimumValue;
TypedStringConvertibleOptionalValue<T> maximumValue;
TypedStringConvertibleOptionalValue<T> safemodeValue;
TypedStringConvertibleOptionalValue<T> headlessValue;
TypedStringConvertibleOptionalValue<T> dedicatedValue;
template<typename F> friend class ConfigVariableBuilder;
};
/**
* @brief Fluent interface to declare meta data of config variables
*
* Uses method chaining so that a config variable can be declared like this:
*
* CONFIG(int, Example)
* .defaultValue(6)
* .minimumValue(1)
* .maximumValue(10)
* .description("This is an example")
* .readOnly(true);
*/
template<typename T>
class ConfigVariableBuilder : public boost::noncopyable
{
public:
ConfigVariableBuilder(ConfigVariableTypedMetaData<T>& data) : data(&data) {}
const ConfigVariableMetaData* GetData() const { return data; }
#define MAKE_CHAIN_METHOD(property, type) \
ConfigVariableBuilder& property(type const& x) { \
data->property = x; \
return *this; \
}
MAKE_CHAIN_METHOD(declarationFile, const char*);
MAKE_CHAIN_METHOD(declarationLine, int);
MAKE_CHAIN_METHOD(description, std::string);
MAKE_CHAIN_METHOD(readOnly, bool);
MAKE_CHAIN_METHOD(defaultValue, T);
MAKE_CHAIN_METHOD(minimumValue, T);
MAKE_CHAIN_METHOD(maximumValue, T);
MAKE_CHAIN_METHOD(safemodeValue, T);
MAKE_CHAIN_METHOD(headlessValue, T);
MAKE_CHAIN_METHOD(dedicatedValue, T);
#undef MAKE_CHAIN_METHOD
private:
ConfigVariableTypedMetaData<T>* data;
};
/**
* @brief Configuration variable declaration
*
* The only purpose of this class is to store the meta data created by a
* ConfigVariableBuilder in a global map of meta data as it is assigned to
* an instance of this class.
*/
class ConfigVariable
{
public:
typedef std::map<std::string, const ConfigVariableMetaData*> MetaDataMap;
static const MetaDataMap& GetMetaDataMap();
static const ConfigVariableMetaData* GetMetaData(const std::string& key);
static void OutputMetaDataMap();
private:
static MetaDataMap& GetMutableMetaDataMap();
static void AddMetaData(const ConfigVariableMetaData* data);
public:
/// @brief Implicit conversion from ConfigVariableBuilder<T>.
template<typename T>
ConfigVariable(const ConfigVariableBuilder<T>& builder)
{
AddMetaData(builder.GetData());
}
};
/**
* @brief Macro to start the method chain used to declare a config variable.
* @see ConfigVariableBuilder
*/
#define CONFIG(T, name) \
static ConfigVariableTypedMetaData<T> cfgdata##name(#name, #T); \
static ConfigVariable cfg##name = ConfigVariableBuilder<T>(cfgdata##name) \
.declarationFile(__FILE__).declarationLine(__LINE__)
#endif // CONFIG_VALUE_H
|
