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
|
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */
#include "ConfigVariable.h"
#include "System/Log/ILog.h"
#include "System/StringUtil.h"
#include <iostream>
/**
* @brief Log an error about a ConfigVariableMetaData
*/
#define LOG_VAR(data, fmt, ...) \
LOG_L(L_ERROR, "%s:%d: " fmt, data->GetDeclarationFile().Get().c_str(), data->GetDeclarationLine().Get(), ## __VA_ARGS__) \
ConfigVariable::MetaDataMap& ConfigVariable::GetMutableMetaDataMap()
{
static MetaDataMap vars;
return vars;
}
const ConfigVariable::MetaDataMap& ConfigVariable::GetMetaDataMap()
{
return GetMutableMetaDataMap();
}
void ConfigVariable::AddMetaData(const ConfigVariableMetaData* data)
{
MetaDataMap& vars = GetMutableMetaDataMap();
MetaDataMap::const_iterator pos = vars.find(data->GetKey());
if (pos != vars.end()) {
LOG_VAR(data, "Duplicate config variable declaration \"%s\"", data->GetKey().c_str());
LOG_VAR(pos->second, " Previously declared here");
}
else {
vars[data->GetKey()] = data;
}
}
const ConfigVariableMetaData* ConfigVariable::GetMetaData(const std::string& key)
{
const MetaDataMap& vars = GetMetaDataMap();
MetaDataMap::const_iterator pos = vars.find(key);
if (pos != vars.end()) {
return pos->second;
}
else {
return nullptr;
}
}
#ifdef DEBUG
CONFIG(std::string, test)
.defaultValue("x y z")
.description("\"quoted\", escaped: \\, \b, \f, \n, \r, \t");
#endif
/**
* @brief Call Quote if type is not bool, float or int.
*/
static inline std::string Quote(const std::string& type, const std::string& value)
{
if (type == "bool" || type == "float" || type == "int") {
return value;
}
else {
return Quote(value);
}
}
/**
* @brief Write a ConfigVariableMetaData to a stream.
*/
static std::ostream& operator<< (std::ostream& out, const ConfigVariableMetaData* d)
{
const char* const OUTER_INDENT = " ";
const char* const INDENT = " ";
out << OUTER_INDENT << Quote(d->GetKey()) << ": {\n";
#define KV(key, value) out << INDENT << Quote(#key) << ": " << (value) << ",\n"
if (d->GetDeclarationFile().IsSet()) {
KV(declarationFile, Quote(d->GetDeclarationFile().Get()));
}
if (d->GetDeclarationLine().IsSet()) {
KV(declarationLine, d->GetDeclarationLine().Get());
}
if (d->GetDescription().IsSet()) {
KV(description, Quote(d->GetDescription().Get()));
}
if (d->GetReadOnly().IsSet()) {
KV(readOnly, d->GetReadOnly().Get());
}
if (d->GetDefaultValue().IsSet()) {
KV(defaultValue, Quote(d->GetType(), d->GetDefaultValue().ToString()));
}
if (d->GetMinimumValue().IsSet()) {
KV(minimumValue, Quote(d->GetType(), d->GetMinimumValue().ToString()));
}
if (d->GetMaximumValue().IsSet()) {
KV(maximumValue, Quote(d->GetType(), d->GetMaximumValue().ToString()));
}
if (d->GetSafemodeValue().IsSet()) {
KV(safemodeValue, Quote(d->GetType(), d->GetSafemodeValue().ToString()));
}
if (d->GetHeadlessValue().IsSet()) {
KV(headlessValue, Quote(d->GetType(), d->GetHeadlessValue().ToString()));
}
if (d->GetDedicatedValue().IsSet()) {
KV(dedicatedValue, Quote(d->GetType(), d->GetDedicatedValue().ToString()));
}
// Type is required.
// Easiest to do this last because of the trailing comma that isn't there.
out << INDENT << Quote("type") << ": " << Quote(d->GetType()) << "\n";
#undef KV
out << OUTER_INDENT << "}";
return out;
}
/**
* @brief Output config variable meta data as JSON to stdout.
*
* This can be tested using, for example:
*
* ./spring --list-config-vars |
* python -c 'import json, sys; json.dump(json.load(sys.stdin), sys.stdout)'
*/
void ConfigVariable::OutputMetaDataMap()
{
std::cout << "{\n";
const MetaDataMap& mdm = GetMetaDataMap();
for (MetaDataMap::const_iterator it = mdm.begin(); it != mdm.end(); ++it) {
if (it != mdm.begin()) {
std::cout << ",\n";
}
std::cout << it->second;
}
std::cout << "\n}\n";
}
|