Bitcoin Core  0.20.99
P2P Digital Currency
settings.h
Go to the documentation of this file.
1 // Copyright (c) 2019-2020 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #ifndef BITCOIN_UTIL_SETTINGS_H
6 #define BITCOIN_UTIL_SETTINGS_H
7 
8 #include <fs.h>
9 
10 #include <map>
11 #include <string>
12 #include <vector>
13 
14 class UniValue;
15 
16 namespace util {
17 
28 
31 struct Settings {
33  std::map<std::string, SettingsValue> forced_settings;
35  std::map<std::string, std::vector<SettingsValue>> command_line_options;
37  std::map<std::string, SettingsValue> rw_settings;
39  std::map<std::string, std::map<std::string, std::vector<SettingsValue>>> ro_config;
40 };
41 
43 bool ReadSettings(const fs::path& path,
44  std::map<std::string, SettingsValue>& values,
45  std::vector<std::string>& errors);
46 
48 bool WriteSettings(const fs::path& path,
49  const std::map<std::string, SettingsValue>& values,
50  std::vector<std::string>& errors);
51 
60 SettingsValue GetSetting(const Settings& settings,
61  const std::string& section,
62  const std::string& name,
63  bool ignore_default_section_config,
64  bool get_chain_name);
65 
68 std::vector<SettingsValue> GetSettingsList(const Settings& settings,
69  const std::string& section,
70  const std::string& name,
71  bool ignore_default_section_config);
72 
78 bool OnlyHasDefaultSectionSetting(const Settings& settings, const std::string& section, const std::string& name);
79 
83 struct SettingsSpan {
84  explicit SettingsSpan() = default;
85  explicit SettingsSpan(const SettingsValue& value) noexcept : SettingsSpan(&value, 1) {}
86  explicit SettingsSpan(const SettingsValue* data, size_t size) noexcept : data(data), size(size) {}
87  explicit SettingsSpan(const std::vector<SettingsValue>& vec) noexcept;
88  const SettingsValue* begin() const;
89  const SettingsValue* end() const;
90  bool empty() const;
91  bool last_negated() const;
92  size_t negated() const;
93 
94  const SettingsValue* data = nullptr;
95  size_t size = 0;
96 };
97 
99 template <typename Map, typename Key>
100 auto FindKey(Map&& map, Key&& key) -> decltype(&map.at(key))
101 {
102  auto it = map.find(key);
103  return it == map.end() ? nullptr : &it->second;
104 }
105 
106 } // namespace util
107 
108 #endif // BITCOIN_UTIL_SETTINGS_H
std::map< std::string, SettingsValue > rw_settings
Map of setting name to read-write file setting value.
Definition: settings.h:37
Stored settings.
Definition: settings.h:31
bool OnlyHasDefaultSectionSetting(const Settings &settings, const std::string &section, const std::string &name)
Return true if a setting is set in the default config file section, and not overridden by a higher pr...
Definition: settings.cpp:212
std::deque< CInv >::iterator it
Definition: httprpc.h:8
SettingsValue GetSetting(const Settings &settings, const std::string &section, const std::string &name, bool ignore_default_section_config, bool get_chain_name)
Get settings value from combined sources: forced settings, command line arguments, runtime read-write settings, and the read-only config file.
Definition: settings.cpp:114
auto FindKey(Map &&map, Key &&key) -> decltype(&map.at(key))
Map lookup helper.
Definition: settings.h:100
std::vector< SettingsValue > GetSettingsList(const Settings &settings, const std::string &section, const std::string &name, bool ignore_default_section_config)
Get combined setting value similar to GetSetting(), except if setting was specified multiple times...
Definition: settings.cpp:167
bool WriteSettings(const fs::path &path, const std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
Write settings file.
Definition: settings.cpp:95
const char * name
Definition: rest.cpp:41
std::map< std::string, std::vector< SettingsValue > > command_line_options
Map of setting name to list of command line values.
Definition: settings.h:35
Accessor for list of settings that skips negated values when iterated over.
Definition: settings.h:83
std::map< std::string, std::map< std::string, std::vector< SettingsValue > > > ro_config
Map of config section name and setting name to list of config file values.
Definition: settings.h:39
SettingsSpan(const SettingsValue &value) noexcept
Definition: settings.h:85
std::map< std::string, SettingsValue > forced_settings
Map of setting name to forced setting value.
Definition: settings.h:33
SettingsSpan(const SettingsValue *data, size_t size) noexcept
Definition: settings.h:86
bool ReadSettings(const fs::path &path, std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
Read settings file.
Definition: settings.cpp:58