Merge pull request #9299 from tfc/config-improvements

Improvements in src/libutil/config.*
This commit is contained in:
John Ericson 2023-11-06 13:03:54 -05:00 committed by GitHub
commit dea63bb810
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 49 additions and 57 deletions

View file

@ -7,7 +7,7 @@
namespace nix { namespace nix {
template<typename T> template<typename T>
std::map<std::string, nlohmann::json> BaseSetting<T>::toJSONObject() std::map<std::string, nlohmann::json> BaseSetting<T>::toJSONObject() const
{ {
auto obj = AbstractSetting::toJSONObject(); auto obj = AbstractSetting::toJSONObject();
obj.emplace("value", value); obj.emplace("value", value);

View file

@ -45,13 +45,13 @@ bool BaseSetting<T>::isAppendable()
return trait::appendable; return trait::appendable;
} }
template<> void BaseSetting<Strings>::appendOrSet(Strings && newValue, bool append); template<> void BaseSetting<Strings>::appendOrSet(Strings newValue, bool append);
template<> void BaseSetting<StringSet>::appendOrSet(StringSet && newValue, bool append); template<> void BaseSetting<StringSet>::appendOrSet(StringSet newValue, bool append);
template<> void BaseSetting<StringMap>::appendOrSet(StringMap && newValue, bool append); template<> void BaseSetting<StringMap>::appendOrSet(StringMap newValue, bool append);
template<> void BaseSetting<std::set<ExperimentalFeature>>::appendOrSet(std::set<ExperimentalFeature> && newValue, bool append); template<> void BaseSetting<std::set<ExperimentalFeature>>::appendOrSet(std::set<ExperimentalFeature> newValue, bool append);
template<typename T> template<typename T>
void BaseSetting<T>::appendOrSet(T && newValue, bool append) void BaseSetting<T>::appendOrSet(T newValue, bool append)
{ {
static_assert( static_assert(
!trait::appendable, !trait::appendable,

View file

@ -36,27 +36,25 @@ bool Config::set(const std::string & name, const std::string & value)
void Config::addSetting(AbstractSetting * setting) void Config::addSetting(AbstractSetting * setting)
{ {
_settings.emplace(setting->name, Config::SettingData{false, setting}); _settings.emplace(setting->name, Config::SettingData{false, setting});
for (auto & alias : setting->aliases) for (const auto & alias : setting->aliases)
_settings.emplace(alias, Config::SettingData{true, setting}); _settings.emplace(alias, Config::SettingData{true, setting});
bool set = false; bool set = false;
auto i = unknownSettings.find(setting->name); if (auto i = unknownSettings.find(setting->name); i != unknownSettings.end()) {
if (i != unknownSettings.end()) { setting->set(std::move(i->second));
setting->set(i->second);
setting->overridden = true; setting->overridden = true;
unknownSettings.erase(i); unknownSettings.erase(i);
set = true; set = true;
} }
for (auto & alias : setting->aliases) { for (auto & alias : setting->aliases) {
auto i = unknownSettings.find(alias); if (auto i = unknownSettings.find(alias); i != unknownSettings.end()) {
if (i != unknownSettings.end()) {
if (set) if (set)
warn("setting '%s' is set, but it's an alias of '%s' which is also set", warn("setting '%s' is set, but it's an alias of '%s' which is also set",
alias, setting->name); alias, setting->name);
else { else {
setting->set(i->second); setting->set(std::move(i->second));
setting->overridden = true; setting->overridden = true;
unknownSettings.erase(i); unknownSettings.erase(i);
set = true; set = true;
@ -71,7 +69,7 @@ AbstractConfig::AbstractConfig(StringMap initials)
void AbstractConfig::warnUnknownSettings() void AbstractConfig::warnUnknownSettings()
{ {
for (auto & s : unknownSettings) for (const auto & s : unknownSettings)
warn("unknown setting '%s'", s.first); warn("unknown setting '%s'", s.first);
} }
@ -85,7 +83,7 @@ void AbstractConfig::reapplyUnknownSettings()
void Config::getSettings(std::map<std::string, SettingInfo> & res, bool overriddenOnly) void Config::getSettings(std::map<std::string, SettingInfo> & res, bool overriddenOnly)
{ {
for (auto & opt : _settings) for (const auto & opt : _settings)
if (!opt.second.isAlias && (!overriddenOnly || opt.second.setting->overridden)) if (!opt.second.isAlias && (!overriddenOnly || opt.second.setting->overridden))
res.emplace(opt.first, SettingInfo{opt.second.setting->to_string(), opt.second.setting->description}); res.emplace(opt.first, SettingInfo{opt.second.setting->to_string(), opt.second.setting->description});
} }
@ -101,8 +99,7 @@ void AbstractConfig::applyConfig(const std::string & contents, const std::string
line += contents[pos++]; line += contents[pos++];
pos++; pos++;
auto hash = line.find('#'); if (auto hash = line.find('#'); hash != line.npos)
if (hash != std::string::npos)
line = std::string(line, 0, hash); line = std::string(line, 0, hash);
auto tokens = tokenizeString<std::vector<std::string>>(line); auto tokens = tokenizeString<std::vector<std::string>>(line);
@ -135,24 +132,24 @@ void AbstractConfig::applyConfig(const std::string & contents, const std::string
if (tokens[1] != "=") if (tokens[1] != "=")
throw UsageError("illegal configuration line '%1%' in '%2%'", line, path); throw UsageError("illegal configuration line '%1%' in '%2%'", line, path);
std::string name = tokens[0]; std::string name = std::move(tokens[0]);
auto i = tokens.begin(); auto i = tokens.begin();
advance(i, 2); advance(i, 2);
parsedContents.push_back({ parsedContents.push_back({
name, std::move(name),
concatStringsSep(" ", Strings(i, tokens.end())), concatStringsSep(" ", Strings(i, tokens.end())),
}); });
}; };
// First apply experimental-feature related settings // First apply experimental-feature related settings
for (auto & [name, value] : parsedContents) for (const auto & [name, value] : parsedContents)
if (name == "experimental-features" || name == "extra-experimental-features") if (name == "experimental-features" || name == "extra-experimental-features")
set(name, value); set(name, value);
// Then apply other settings // Then apply other settings
for (auto & [name, value] : parsedContents) for (const auto & [name, value] : parsedContents)
if (name != "experimental-features" && name != "extra-experimental-features") if (name != "experimental-features" && name != "extra-experimental-features")
set(name, value); set(name, value);
} }
@ -174,7 +171,7 @@ void Config::resetOverridden()
nlohmann::json Config::toJSON() nlohmann::json Config::toJSON()
{ {
auto res = nlohmann::json::object(); auto res = nlohmann::json::object();
for (auto & s : _settings) for (const auto & s : _settings)
if (!s.second.isAlias) if (!s.second.isAlias)
res.emplace(s.first, s.second.setting->toJSON()); res.emplace(s.first, s.second.setting->toJSON());
return res; return res;
@ -182,8 +179,8 @@ nlohmann::json Config::toJSON()
std::string Config::toKeyValue() std::string Config::toKeyValue()
{ {
auto res = std::string(); std::string res;
for (auto & s : _settings) for (const auto & s : _settings)
if (s.second.isAlias) if (s.second.isAlias)
res += fmt("%s = %s\n", s.first, s.second.setting->to_string()); res += fmt("%s = %s\n", s.first, s.second.setting->to_string());
return res; return res;
@ -205,7 +202,7 @@ AbstractSetting::AbstractSetting(
: name(name) : name(name)
, description(stripIndentation(description)) , description(stripIndentation(description))
, aliases(aliases) , aliases(aliases)
, experimentalFeature(experimentalFeature) , experimentalFeature(std::move(experimentalFeature))
{ {
} }
@ -221,7 +218,7 @@ nlohmann::json AbstractSetting::toJSON()
return nlohmann::json(toJSONObject()); return nlohmann::json(toJSONObject());
} }
std::map<std::string, nlohmann::json> AbstractSetting::toJSONObject() std::map<std::string, nlohmann::json> AbstractSetting::toJSONObject() const
{ {
std::map<std::string, nlohmann::json> obj; std::map<std::string, nlohmann::json> obj;
obj.emplace("description", description); obj.emplace("description", description);
@ -284,14 +281,14 @@ template<> void BaseSetting<bool>::convertToArg(Args & args, const std::string &
.longName = name, .longName = name,
.description = fmt("Enable the `%s` setting.", name), .description = fmt("Enable the `%s` setting.", name),
.category = category, .category = category,
.handler = {[this]() { override(true); }}, .handler = {[this] { override(true); }},
.experimentalFeature = experimentalFeature, .experimentalFeature = experimentalFeature,
}); });
args.addFlag({ args.addFlag({
.longName = "no-" + name, .longName = "no-" + name,
.description = fmt("Disable the `%s` setting.", name), .description = fmt("Disable the `%s` setting.", name),
.category = category, .category = category,
.handler = {[this]() { override(false); }}, .handler = {[this] { override(false); }},
.experimentalFeature = experimentalFeature, .experimentalFeature = experimentalFeature,
}); });
} }
@ -301,10 +298,11 @@ template<> Strings BaseSetting<Strings>::parse(const std::string & str) const
return tokenizeString<Strings>(str); return tokenizeString<Strings>(str);
} }
template<> void BaseSetting<Strings>::appendOrSet(Strings && newValue, bool append) template<> void BaseSetting<Strings>::appendOrSet(Strings newValue, bool append)
{ {
if (!append) value.clear(); if (!append) value.clear();
for (auto && s : std::move(newValue)) value.push_back(std::move(s)); value.insert(value.end(), std::make_move_iterator(newValue.begin()),
std::make_move_iterator(newValue.end()));
} }
template<> std::string BaseSetting<Strings>::to_string() const template<> std::string BaseSetting<Strings>::to_string() const
@ -317,11 +315,10 @@ template<> StringSet BaseSetting<StringSet>::parse(const std::string & str) cons
return tokenizeString<StringSet>(str); return tokenizeString<StringSet>(str);
} }
template<> void BaseSetting<StringSet>::appendOrSet(StringSet && newValue, bool append) template<> void BaseSetting<StringSet>::appendOrSet(StringSet newValue, bool append)
{ {
if (!append) value.clear(); if (!append) value.clear();
for (auto && s : std::move(newValue)) value.insert(std::make_move_iterator(newValue.begin()), std::make_move_iterator(newValue.end()));
value.insert(s);
} }
template<> std::string BaseSetting<StringSet>::to_string() const template<> std::string BaseSetting<StringSet>::to_string() const
@ -333,8 +330,7 @@ template<> std::set<ExperimentalFeature> BaseSetting<std::set<ExperimentalFeatur
{ {
std::set<ExperimentalFeature> res; std::set<ExperimentalFeature> res;
for (auto & s : tokenizeString<StringSet>(str)) { for (auto & s : tokenizeString<StringSet>(str)) {
auto thisXpFeature = parseExperimentalFeature(s); if (auto thisXpFeature = parseExperimentalFeature(s); thisXpFeature)
if (thisXpFeature)
res.insert(thisXpFeature.value()); res.insert(thisXpFeature.value());
else else
warn("unknown experimental feature '%s'", s); warn("unknown experimental feature '%s'", s);
@ -342,17 +338,16 @@ template<> std::set<ExperimentalFeature> BaseSetting<std::set<ExperimentalFeatur
return res; return res;
} }
template<> void BaseSetting<std::set<ExperimentalFeature>>::appendOrSet(std::set<ExperimentalFeature> && newValue, bool append) template<> void BaseSetting<std::set<ExperimentalFeature>>::appendOrSet(std::set<ExperimentalFeature> newValue, bool append)
{ {
if (!append) value.clear(); if (!append) value.clear();
for (auto && s : std::move(newValue)) value.insert(std::make_move_iterator(newValue.begin()), std::make_move_iterator(newValue.end()));
value.insert(s);
} }
template<> std::string BaseSetting<std::set<ExperimentalFeature>>::to_string() const template<> std::string BaseSetting<std::set<ExperimentalFeature>>::to_string() const
{ {
StringSet stringifiedXpFeatures; StringSet stringifiedXpFeatures;
for (auto & feature : value) for (const auto & feature : value)
stringifiedXpFeatures.insert(std::string(showExperimentalFeature(feature))); stringifiedXpFeatures.insert(std::string(showExperimentalFeature(feature)));
return concatStringsSep(" ", stringifiedXpFeatures); return concatStringsSep(" ", stringifiedXpFeatures);
} }
@ -360,28 +355,25 @@ template<> std::string BaseSetting<std::set<ExperimentalFeature>>::to_string() c
template<> StringMap BaseSetting<StringMap>::parse(const std::string & str) const template<> StringMap BaseSetting<StringMap>::parse(const std::string & str) const
{ {
StringMap res; StringMap res;
for (auto & s : tokenizeString<Strings>(str)) { for (const auto & s : tokenizeString<Strings>(str)) {
auto eq = s.find_first_of('='); if (auto eq = s.find_first_of('='); s.npos != eq)
if (std::string::npos != eq)
res.emplace(std::string(s, 0, eq), std::string(s, eq + 1)); res.emplace(std::string(s, 0, eq), std::string(s, eq + 1));
// else ignored // else ignored
} }
return res; return res;
} }
template<> void BaseSetting<StringMap>::appendOrSet(StringMap && newValue, bool append) template<> void BaseSetting<StringMap>::appendOrSet(StringMap newValue, bool append)
{ {
if (!append) value.clear(); if (!append) value.clear();
for (auto && [k, v] : std::move(newValue)) value.insert(std::make_move_iterator(newValue.begin()), std::make_move_iterator(newValue.end()));
value.emplace(std::move(k), std::move(v));
} }
template<> std::string BaseSetting<StringMap>::to_string() const template<> std::string BaseSetting<StringMap>::to_string() const
{ {
Strings kvstrs; return std::transform_reduce(value.cbegin(), value.cend(), std::string{},
std::transform(value.begin(), value.end(), back_inserter(kvstrs), [](const auto & l, const auto &r) { return l + " " + r; },
[&](auto kvpair){ return kvpair.first + "=" + kvpair.second; }); [](const auto & kvpair){ return kvpair.first + "=" + kvpair.second; });
return concatStringsSep(" ", kvstrs);
} }
template class BaseSetting<int>; template class BaseSetting<int>;
@ -470,7 +462,7 @@ void GlobalConfig::resetOverridden()
nlohmann::json GlobalConfig::toJSON() nlohmann::json GlobalConfig::toJSON()
{ {
auto res = nlohmann::json::object(); auto res = nlohmann::json::object();
for (auto & config : *configRegistrations) for (const auto & config : *configRegistrations)
res.update(config->toJSON()); res.update(config->toJSON());
return res; return res;
} }
@ -480,7 +472,7 @@ std::string GlobalConfig::toKeyValue()
std::string res; std::string res;
std::map<std::string, Config::SettingInfo> settings; std::map<std::string, Config::SettingInfo> settings;
globalConfig.getSettings(settings); globalConfig.getSettings(settings);
for (auto & s : settings) for (const auto & s : settings)
res += fmt("%s = %s\n", s.first, s.second.value); res += fmt("%s = %s\n", s.first, s.second.value);
return res; return res;
} }

View file

@ -150,7 +150,7 @@ public:
AbstractSetting * setting; AbstractSetting * setting;
}; };
typedef std::map<std::string, SettingData> Settings; using Settings = std::map<std::string, SettingData>;
private: private:
@ -213,7 +213,7 @@ protected:
nlohmann::json toJSON(); nlohmann::json toJSON();
virtual std::map<std::string, nlohmann::json> toJSONObject(); virtual std::map<std::string, nlohmann::json> toJSONObject() const;
virtual void convertToArg(Args & args, const std::string & category); virtual void convertToArg(Args & args, const std::string & category);
@ -247,7 +247,7 @@ protected:
* *
* @param append Whether to append or overwrite. * @param append Whether to append or overwrite.
*/ */
virtual void appendOrSet(T && newValue, bool append); virtual void appendOrSet(T newValue, bool append);
public: public:
@ -306,7 +306,7 @@ public:
void convertToArg(Args & args, const std::string & category) override; void convertToArg(Args & args, const std::string & category) override;
std::map<std::string, nlohmann::json> toJSONObject() override; std::map<std::string, nlohmann::json> toJSONObject() const override;
}; };
template<typename T> template<typename T>
@ -316,7 +316,7 @@ std::ostream & operator <<(std::ostream & str, const BaseSetting<T> & opt)
} }
template<typename T> template<typename T>
bool operator ==(const T & v1, const BaseSetting<T> & v2) { return v1 == (const T &) v2; } bool operator ==(const T & v1, const BaseSetting<T> & v2) { return v1 == static_cast<const T &>(v2); }
template<typename T> template<typename T>
class Setting : public BaseSetting<T> class Setting : public BaseSetting<T>
@ -329,7 +329,7 @@ public:
const std::set<std::string> & aliases = {}, const std::set<std::string> & aliases = {},
const bool documentDefault = true, const bool documentDefault = true,
std::optional<ExperimentalFeature> experimentalFeature = std::nullopt) std::optional<ExperimentalFeature> experimentalFeature = std::nullopt)
: BaseSetting<T>(def, documentDefault, name, description, aliases, experimentalFeature) : BaseSetting<T>(def, documentDefault, name, description, aliases, std::move(experimentalFeature))
{ {
options->addSetting(this); options->addSetting(this);
} }