Bitcoin Core  24.99.0
P2P Digital Currency
settings.h
Go to the documentation of this file.
1 // Copyright (c) 2019-2022 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 
65 SettingsValue GetSetting(const Settings& settings,
66  const std::string& section,
67  const std::string& name,
68  bool ignore_default_section_config,
69  bool ignore_nonpersistent,
70  bool get_chain_name);
71 
74 std::vector<SettingsValue> GetSettingsList(const Settings& settings,
75  const std::string& section,
76  const std::string& name,
77  bool ignore_default_section_config);
78 
84 bool OnlyHasDefaultSectionSetting(const Settings& settings, const std::string& section, const std::string& name);
85 
89 struct SettingsSpan {
90  explicit SettingsSpan() = default;
91  explicit SettingsSpan(const SettingsValue& value) noexcept : SettingsSpan(&value, 1) {}
92  explicit SettingsSpan(const SettingsValue* data, size_t size) noexcept : data(data), size(size) {}
93  explicit SettingsSpan(const std::vector<SettingsValue>& vec) noexcept;
94  const SettingsValue* begin() const;
95  const SettingsValue* end() const;
96  bool empty() const;
97  bool last_negated() const;
98  size_t negated() const;
99 
100  const SettingsValue* data = nullptr;
101  size_t size = 0;
102 };
103 
105 template <typename Map, typename Key>
106 auto FindKey(Map&& map, Key&& key) -> decltype(&map.at(key))
107 {
108  auto it = map.find(key);
109  return it == map.end() ? nullptr : &it->second;
110 }
111 
112 } // namespace util
113 
114 #endif // BITCOIN_UTIL_SETTINGS_H
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Definition: fs.h:31
Definition: overloaded.h:8
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:183
SettingsValue GetSetting(const Settings &settings, const std::string &section, const std::string &name, bool ignore_default_section_config, bool ignore_nonpersistent, bool get_chain_name)
Get settings value from combined sources: forced settings, command line arguments,...
Definition: settings.cpp:126
bool ReadSettings(const fs::path &path, std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
Read settings file.
Definition: settings.cpp:64
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:228
bool WriteSettings(const fs::path &path, const std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
Write settings file.
Definition: settings.cpp:107
auto FindKey(Map &&map, Key &&key) -> decltype(&map.at(key))
Map lookup helper.
Definition: settings.h:106
const char * name
Definition: rest.cpp:46
static const int64_t values[]
A selection of numbers that do not trigger int64_t overflow when added/subtracted.
Stored settings.
Definition: settings.h:31
std::map< std::string, SettingsValue > rw_settings
Map of setting name to read-write file setting value.
Definition: settings.h:37
std::map< std::string, SettingsValue > forced_settings
Map of setting name to forced setting value.
Definition: settings.h:33
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
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:89
size_t negated() const
Number of negated values.
Definition: settings.cpp:248
SettingsSpan(const SettingsValue *data, size_t size) noexcept
Definition: settings.h:92
SettingsSpan(const SettingsValue &value) noexcept
Definition: settings.h:91
const SettingsValue * end() const
Pointer to end of values.
Definition: settings.cpp:245
bool empty() const
True if there are any non-negated values.
Definition: settings.cpp:246
SettingsSpan()=default
const SettingsValue * data
Definition: settings.h:100
bool last_negated() const
True if the last value is negated.
Definition: settings.cpp:247
const SettingsValue * begin() const
Pointer to first non-negated value.
Definition: settings.cpp:244