lix-project/lix
20
58
Fork 31
Code Issues 359 Code Review (Gerrit) Projects 3 Releases Wiki Activity

Merge pull request #9299 from tfc/config-improvements

Browse source 
Improvements in src/libutil/config.*

(cherry picked from commit dea63bb81078d7290410544285c6df1a8e002952)
Change-Id: I8090eb2ad393dd9964cf2d5254ec8c796b1bd367
This commit is contained in:
eldritch horrors 2024-03-04 05:36:42 +01:00
parent 8ed486ebe6
commit b7e7949035
4 changed files with 49 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/libutil/abstract-setting-to-json.hh
View file

@ -7,7 +7,7 @@
namespace nix {
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();
obj.emplace("value", value);

10
src/libutil/config-impl.hh
View file

@ -45,13 +45,13 @@ bool BaseSetting<T>::isAppendable()
return trait::appendable;
}
template<> void BaseSetting<Strings>::appendOrSet(Strings && newValue, bool append);
template<> void BaseSetting<StringSet>::appendOrSet(StringSet && 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<Strings>::appendOrSet(Strings newValue, bool append);
template<> void BaseSetting<StringSet>::appendOrSet(StringSet 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<typename T>
void BaseSetting<T>::appendOrSet(T && newValue, bool append)
void BaseSetting<T>::appendOrSet(T newValue, bool append)
{
static_assert(
!trait::appendable,

82
src/libutil/config.cc
View file

@ -34,27 +34,25 @@ bool Config::set(const std::string & name, const std::string & value)
void Config::addSetting(AbstractSetting * 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});
bool set = false;
auto i = unknownSettings.find(setting->name);
if (i != unknownSettings.end()) {
setting->set(i->second);
if (auto i = unknownSettings.find(setting->name); i != unknownSettings.end()) {
setting->set(std::move(i->second));
setting->overridden = true;
unknownSettings.erase(i);
set = true;
}
for (auto & alias : setting->aliases) {
auto i = unknownSettings.find(alias);
if (i != unknownSettings.end()) {
if (auto i = unknownSettings.find(alias); i != unknownSettings.end()) {
if (set)
warn("setting '%s' is set, but it's an alias of '%s' which is also set",
alias, setting->name);
else {
setting->set(i->second);
setting->set(std::move(i->second));
setting->overridden = true;
unknownSettings.erase(i);
set = true;
@ -69,7 +67,7 @@ AbstractConfig::AbstractConfig(StringMap initials)
void AbstractConfig::warnUnknownSettings()
{
for (auto & s : unknownSettings)
for (const auto & s : unknownSettings)
warn("unknown setting '%s'", s.first);
}
@ -83,7 +81,7 @@ void AbstractConfig::reapplyUnknownSettings()
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))
res.emplace(opt.first, SettingInfo{opt.second.setting->to_string(), opt.second.setting->description});
}
@ -99,8 +97,7 @@ void AbstractConfig::applyConfig(const std::string & contents, const std::string
line += contents[pos++];
pos++;
auto hash = line.find('#');
if (hash != std::string::npos)
if (auto hash = line.find('#'); hash != line.npos)
line = std::string(line, 0, hash);
auto tokens = tokenizeString<std::vector<std::string>>(line);
@ -133,24 +130,24 @@ void AbstractConfig::applyConfig(const std::string & contents, const std::string
if (tokens[1] != "=")
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();
advance(i, 2);
parsedContents.push_back({
name,
std::move(name),
concatStringsSep(" ", Strings(i, tokens.end())),
});
};
// 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")
set(name, value);
// Then apply other settings
for (auto & [name, value] : parsedContents)
for (const auto & [name, value] : parsedContents)
if (name != "experimental-features" && name != "extra-experimental-features")
set(name, value);
}
@ -172,7 +169,7 @@ void Config::resetOverridden()
nlohmann::json Config::toJSON()
{
auto res = nlohmann::json::object();
for (auto & s : _settings)
for (const auto & s : _settings)
if (!s.second.isAlias)
res.emplace(s.first, s.second.setting->toJSON());
return res;
@ -180,8 +177,8 @@ nlohmann::json Config::toJSON()
std::string Config::toKeyValue()
{
auto res = std::string();
for (auto & s : _settings)
std::string res;
for (const auto & s : _settings)
if (s.second.isAlias)
res += fmt("%s = %s\n", s.first, s.second.setting->to_string());
return res;
@ -203,7 +200,7 @@ AbstractSetting::AbstractSetting(
: name(name)
, description(stripIndentation(description))
, aliases(aliases)
, experimentalFeature(experimentalFeature)
, experimentalFeature(std::move(experimentalFeature))
{
}
@ -219,7 +216,7 @@ nlohmann::json AbstractSetting::toJSON()
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;
obj.emplace("description", description);
@ -282,14 +279,14 @@ template<> void BaseSetting<bool>::convertToArg(Args & args, const std::string &
.longName = name,
.description = fmt("Enable the `%s` setting.", name),
.category = category,
.handler = {[this]() { override(true); }},
.handler = {[this] { override(true); }},
.experimentalFeature = experimentalFeature,
});
args.addFlag({
.longName = "no-" + name,
.description = fmt("Disable the `%s` setting.", name),
.category = category,
.handler = {[this]() { override(false); }},
.handler = {[this] { override(false); }},
.experimentalFeature = experimentalFeature,
});
}
@ -299,10 +296,11 @@ template<> Strings BaseSetting<Strings>::parse(const std::string & str) const
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();
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
@ -315,11 +313,10 @@ template<> StringSet BaseSetting<StringSet>::parse(const std::string & str) cons
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();
for (auto && s : std::move(newValue))
value.insert(s);
value.insert(std::make_move_iterator(newValue.begin()), std::make_move_iterator(newValue.end()));
}
template<> std::string BaseSetting<StringSet>::to_string() const
@ -331,8 +328,7 @@ template<> std::set<ExperimentalFeature> BaseSetting<std::set<ExperimentalFeatur
{
std::set<ExperimentalFeature> res;
for (auto & s : tokenizeString<StringSet>(str)) {
auto thisXpFeature = parseExperimentalFeature(s);
if (thisXpFeature)
if (auto thisXpFeature = parseExperimentalFeature(s); thisXpFeature)
res.insert(thisXpFeature.value());
else
warn("unknown experimental feature '%s'", s);
@ -340,17 +336,16 @@ template<> std::set<ExperimentalFeature> BaseSetting<std::set<ExperimentalFeatur
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();
for (auto && s : std::move(newValue))
value.insert(s);
value.insert(std::make_move_iterator(newValue.begin()), std::make_move_iterator(newValue.end()));
}
template<> std::string BaseSetting<std::set<ExperimentalFeature>>::to_string() const
{
StringSet stringifiedXpFeatures;
for (auto & feature : value)
for (const auto & feature : value)
stringifiedXpFeatures.insert(std::string(showExperimentalFeature(feature)));
return concatStringsSep(" ", stringifiedXpFeatures);
}
@ -358,28 +353,25 @@ template<> std::string BaseSetting<std::set<ExperimentalFeature>>::to_string() c
template<> StringMap BaseSetting<StringMap>::parse(const std::string & str) const
{
StringMap res;
for (auto & s : tokenizeString<Strings>(str)) {
auto eq = s.find_first_of('=');
if (std::string::npos != eq)
for (const auto & s : tokenizeString<Strings>(str)) {
if (auto eq = s.find_first_of('='); s.npos != eq)
res.emplace(std::string(s, 0, eq), std::string(s, eq + 1));
// else ignored
}
return res;
}
template<> void BaseSetting<StringMap>::appendOrSet(StringMap && newValue, bool append)
template<> void BaseSetting<StringMap>::appendOrSet(StringMap newValue, bool append)
{
if (!append) value.clear();
for (auto && [k, v] : std::move(newValue))
value.emplace(std::move(k), std::move(v));
value.insert(std::make_move_iterator(newValue.begin()), std::make_move_iterator(newValue.end()));
}
template<> std::string BaseSetting<StringMap>::to_string() const
{
Strings kvstrs;
std::transform(value.begin(), value.end(), back_inserter(kvstrs),
[&](auto kvpair){ return kvpair.first + "=" + kvpair.second; });
return concatStringsSep(" ", kvstrs);
return std::transform_reduce(value.cbegin(), value.cend(), std::string{},
[](const auto & l, const auto &r) { return l + " " + r; },
[](const auto & kvpair){ return kvpair.first + "=" + kvpair.second; });
}
template class BaseSetting<int>;
@ -468,7 +460,7 @@ void GlobalConfig::resetOverridden()
nlohmann::json GlobalConfig::toJSON()
{
auto res = nlohmann::json::object();
for (auto & config : *configRegistrations)
for (const auto & config : *configRegistrations)
res.update(config->toJSON());
return res;
}
@ -478,7 +470,7 @@ std::string GlobalConfig::toKeyValue()
std::string res;
std::map<std::string, Config::SettingInfo> settings;
globalConfig.getSettings(settings);
for (auto & s : settings)
for (const auto & s : settings)
res += fmt("%s = %s\n", s.first, s.second.value);
return res;
}

12
src/libutil/config.hh
View file

@ -150,7 +150,7 @@ public:
AbstractSetting * setting;
};
typedef std::map<std::string, SettingData> Settings;
using Settings = std::map<std::string, SettingData>;
private:
@ -213,7 +213,7 @@ protected:
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);
@ -247,7 +247,7 @@ protected:
*
* @param append Whether to append or overwrite.
*/
virtual void appendOrSet(T && newValue, bool append);
virtual void appendOrSet(T newValue, bool append);
public:
@ -306,7 +306,7 @@ public:
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>
@ -316,7 +316,7 @@ std::ostream & operator <<(std::ostream & str, const BaseSetting<T> & opt)
}
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>
class Setting : public BaseSetting<T>
@ -329,7 +329,7 @@ public:
const std::set<std::string> & aliases = {},
const bool documentDefault = true,
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);
}