Bitcoin ABC
0.29.2
P2P Digital Currency
|
#include <system.h>
Classes | |
struct | Arg |
Public Types | |
enum | Flags { ALLOW_BOOL = 0x01 , ALLOW_INT = 0x02 , ALLOW_STRING = 0x04 , ALLOW_ANY = ALLOW_BOOL | ALLOW_INT | ALLOW_STRING , DEBUG_ONLY = 0x100 , NETWORK_ONLY = 0x200 , SENSITIVE = 0x400 } |
Public Member Functions | |
util::SettingsValue | GetSetting (const std::string &arg) const |
Get setting value. More... | |
std::vector< util::SettingsValue > | GetSettingsList (const std::string &arg) const |
Get list of setting values. More... | |
ArgsManager () | |
~ArgsManager () | |
void | SelectConfigNetwork (const std::string &network) |
Select the network in use. More... | |
bool | ParseParameters (int argc, const char *const argv[], std::string &error) |
bool | ReadConfigFiles (std::string &error, bool ignore_invalid_keys=false) |
const std::set< std::string > | GetUnsuitableSectionOnlyArgs () const |
Log warnings for options in m_section_only_args when they are specified in the default section but not overridden on the command line or in a network-specific section in the config file. More... | |
const std::list< SectionInfo > | GetUnrecognizedSections () const |
Log warnings for unrecognized section names in the config file. More... | |
const fs::path & | GetBlocksDirPath () const |
Get blocks directory path. More... | |
const fs::path & | GetDataDirBase () const |
Get data directory path. More... | |
const fs::path & | GetDataDirNet () const |
Get data directory path with appended network identifier. More... | |
void | ClearPathCache () |
Clear cached directory paths. More... | |
std::vector< std::string > | GetArgs (const std::string &strArg) const |
Return a vector of strings of the given argument. More... | |
bool | IsArgSet (const std::string &strArg) const |
Return true if the given argument has been manually set. More... | |
bool | IsArgNegated (const std::string &strArg) const |
Return true if the argument was originally passed as a negated option, i.e. More... | |
std::string | GetArg (const std::string &strArg, const std::string &strDefault) const |
Return string argument or default value. More... | |
std::optional< std::string > | GetArg (const std::string &strArg) const |
fs::path | GetPathArg (std::string arg, const fs::path &default_value={}) const |
Return path argument or default value. More... | |
int64_t | GetIntArg (const std::string &strArg, int64_t nDefault) const |
Return integer argument or default value. More... | |
std::optional< int64_t > | GetIntArg (const std::string &strArg) const |
bool | GetBoolArg (const std::string &strArg, bool fDefault) const |
Return boolean argument or default value. More... | |
std::optional< bool > | GetBoolArg (const std::string &strArg) const |
bool | SoftSetArg (const std::string &strArg, const std::string &strValue) |
Set an argument if it doesn't already have a value. More... | |
bool | SoftSetBoolArg (const std::string &strArg, bool fValue) |
Set a boolean argument if it doesn't already have a value. More... | |
void | ForceSetArg (const std::string &strArg, const std::string &strValue) |
void | ForceSetMultiArg (const std::string &strArg, const std::vector< std::string > &values) |
This function is only used for testing purpose so so we should not worry about element uniqueness and integrity of the data structure. More... | |
std::string | GetChainName () const |
Looks for -regtest, -testnet and returns the appropriate BIP70 chain name. More... | |
void | AddArg (const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat) |
Add argument. More... | |
void | ClearForcedArg (const std::string &strArg) |
Remove a forced arg setting, used only in testing. More... | |
void | AddHiddenArgs (const std::vector< std::string > &args) |
Add many hidden arguments. More... | |
void | ClearArgs () |
Clear available arguments. More... | |
std::string | GetHelpMessage () const |
Get the help string. More... | |
std::optional< unsigned int > | GetArgFlags (const std::string &name) const |
Return Flags for known arg. More... | |
bool | InitSettings (std::string &error) |
Read and update settings file with saved settings. More... | |
bool | GetSettingsPath (fs::path *filepath=nullptr, bool temp=false, bool backup=false) const |
Get settings file path, or return false if read-write settings were disabled with -nosettings. More... | |
bool | ReadSettingsFile (std::vector< std::string > *errors=nullptr) |
Read settings file. More... | |
bool | WriteSettingsFile (std::vector< std::string > *errors=nullptr, bool backup=false) const |
Write settings file or backup settings file. More... | |
util::SettingsValue | GetPersistentSetting (const std::string &name) const |
Get current setting from config file or read/write settings file, ignoring nonpersistent command line or forced settings values. More... | |
template<typename Fn > | |
void | LockSettings (Fn &&fn) |
Access settings with lock held. More... | |
void | LogArgs () const |
Log the config file options and the command line arguments, useful for troubleshooting. More... | |
Protected Member Functions | |
util::Settings m_settings | GUARDED_BY (cs_args) |
std::string m_network | GUARDED_BY (cs_args) |
std::set< std::string > m_network_only_args | GUARDED_BY (cs_args) |
std::map< OptionsCategory, std::map< std::string, Arg > > m_available_args | GUARDED_BY (cs_args) |
std::list< SectionInfo > m_config_sections | GUARDED_BY (cs_args) |
fs::path m_cached_blocks_path | GUARDED_BY (cs_args) |
fs::path m_cached_datadir_path | GUARDED_BY (cs_args) |
fs::path m_cached_network_datadir_path | GUARDED_BY (cs_args) |
bool | ReadConfigStream (std::istream &stream, const std::string &filepath, std::string &error, bool ignore_invalid_keys=false) |
bool | UseDefaultSection (const std::string &arg) const EXCLUSIVE_LOCKS_REQUIRED(cs_args) |
Returns true if settings values from the default section should be used, depending on the current network and whether the setting is network-specific. More... | |
Protected Attributes | |
RecursiveMutex | cs_args |
Private Member Functions | |
const fs::path & | GetDataDir (bool net_specific) const |
Get data directory path. More... | |
void | logArgsPrefix (const std::string &prefix, const std::string §ion, const std::map< std::string, std::vector< util::SettingsValue >> &args) const |
enum ArgsManager::Flags |
ArgsManager::ArgsManager | ( | ) |
Definition at line 251 of file system.cpp.
ArgsManager::~ArgsManager | ( | ) |
Definition at line 252 of file system.cpp.
void ArgsManager::AddArg | ( | const std::string & | name, |
const std::string & | help, | ||
unsigned int | flags, | ||
const OptionsCategory & | cat | ||
) |
Add argument.
Definition at line 729 of file system.cpp.
void ArgsManager::AddHiddenArgs | ( | const std::vector< std::string > & | args | ) |
Add many hidden arguments.
Definition at line 751 of file system.cpp.
|
inline |
void ArgsManager::ClearForcedArg | ( | const std::string & | strArg | ) |
Remove a forced arg setting, used only in testing.
Definition at line 757 of file system.cpp.
void ArgsManager::ClearPathCache | ( | ) |
Clear cached directory paths.
Definition at line 472 of file system.cpp.
void ArgsManager::ForceSetArg | ( | const std::string & | strArg, |
const std::string & | strValue | ||
) |
Definition at line 706 of file system.cpp.
void ArgsManager::ForceSetMultiArg | ( | const std::string & | strArg, |
const std::vector< std::string > & | values | ||
) |
This function is only used for testing purpose so so we should not worry about element uniqueness and integrity of the data structure.
Definition at line 717 of file system.cpp.
std::optional< std::string > ArgsManager::GetArg | ( | const std::string & | strArg | ) | const |
std::string ArgsManager::GetArg | ( | const std::string & | strArg, |
const std::string & | strDefault | ||
) | const |
Return string argument or default value.
strArg | Argument to get (e.g. "-foo") |
strDefault | (e.g. "1") |
Definition at line 603 of file system.cpp.
std::optional< unsigned int > ArgsManager::GetArgFlags | ( | const std::string & | name | ) | const |
Return Flags for known arg.
Return std::nullopt for unknown arg.
Definition at line 385 of file system.cpp.
std::vector< std::string > ArgsManager::GetArgs | ( | const std::string & | strArg | ) | const |
Return a vector of strings of the given argument.
strArg | Argument to get (e.g. "-foo") |
Definition at line 480 of file system.cpp.
const fs::path & ArgsManager::GetBlocksDirPath | ( | ) | const |
Get blocks directory path.
Definition at line 410 of file system.cpp.
std::optional< bool > ArgsManager::GetBoolArg | ( | const std::string & | strArg | ) | const |
bool ArgsManager::GetBoolArg | ( | const std::string & | strArg, |
bool | fDefault | ||
) | const |
Return boolean argument or default value.
strArg | Argument to get (e.g. "-foo") |
fDefault | (true or false) |
Definition at line 665 of file system.cpp.
std::string ArgsManager::GetChainName | ( | ) | const |
Looks for -regtest, -testnet and returns the appropriate BIP70 chain name.
Definition at line 1123 of file system.cpp.
|
private |
Get data directory path.
net_specific | Append network identifier to the returned path |
Definition at line 436 of file system.cpp.
|
inline |
Get data directory path.
Definition at line 257 of file system.h.
|
inline |
Get data directory path with appended network identifier.
Definition at line 266 of file system.h.
std::string ArgsManager::GetHelpMessage | ( | ) | const |
Get the help string.
Definition at line 762 of file system.cpp.
std::optional< int64_t > ArgsManager::GetIntArg | ( | const std::string & | strArg | ) | const |
int64_t ArgsManager::GetIntArg | ( | const std::string & | strArg, |
int64_t | nDefault | ||
) | const |
Return integer argument or default value.
strArg | Argument to get (e.g. "-foo") |
nDefault | (e.g. 1) |
Definition at line 635 of file system.cpp.
Return path argument or default value.
arg | Argument to get a path from (e.g., "-datadir", "-blocksdir" or "-walletdir") |
default_value | Optional default value to return instead of the empty path. |
Definition at line 396 of file system.cpp.
util::SettingsValue ArgsManager::GetPersistentSetting | ( | const std::string & | name | ) | const |
Get current setting from config file or read/write settings file, ignoring nonpersistent command line or forced settings values.
Definition at line 592 of file system.cpp.
util::SettingsValue ArgsManager::GetSetting | ( | const std::string & | arg | ) | const |
Get setting value.
Result will be null if setting was unset, true if "-setting" argument was passed false if "-nosetting" argument was passed, and a string if a "-setting=value" argument was passed.
Definition at line 1158 of file system.cpp.
std::vector< util::SettingsValue > ArgsManager::GetSettingsList | ( | const std::string & | arg | ) | const |
Get list of setting values.
Definition at line 1167 of file system.cpp.
bool ArgsManager::GetSettingsPath | ( | fs::path * | filepath = nullptr , |
bool | temp = false , |
||
bool | backup = false |
||
) | const |
Get settings file path, or return false if read-write settings were disabled with -nosettings.
Definition at line 513 of file system.cpp.
const std::list< SectionInfo > ArgsManager::GetUnrecognizedSections | ( | ) | const |
Log warnings for unrecognized section names in the config file.
Definition at line 278 of file system.cpp.
const std::set< std::string > ArgsManager::GetUnsuitableSectionOnlyArgs | ( | ) | const |
Log warnings for options in m_section_only_args when they are specified in the default section but not overridden on the command line or in a network-specific section in the config file.
Definition at line 254 of file system.cpp.
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
bool ArgsManager::InitSettings | ( | std::string & | error | ) |
Read and update settings file with saved settings.
This needs to be called after SelectParams() because the settings file location is network-specific.
Definition at line 494 of file system.cpp.
bool ArgsManager::IsArgNegated | ( | const std::string & | strArg | ) | const |
Return true if the argument was originally passed as a negated option, i.e.
-nofoo.
strArg | Argument to get (e.g. "-foo") |
Definition at line 599 of file system.cpp.
bool ArgsManager::IsArgSet | ( | const std::string & | strArg | ) | const |
Return true if the given argument has been manually set.
strArg | Argument to get (e.g. "-foo") |
Definition at line 490 of file system.cpp.
|
inline |
void ArgsManager::LogArgs | ( | ) | const |
Log the config file options and the command line arguments, useful for troubleshooting.
Definition at line 1190 of file system.cpp.
|
private |
Definition at line 1173 of file system.cpp.
bool ArgsManager::ParseParameters | ( | int | argc, |
const char *const | argv[], | ||
std::string & | error | ||
) |
Definition at line 322 of file system.cpp.
bool ArgsManager::ReadConfigFiles | ( | std::string & | error, |
bool | ignore_invalid_keys = false |
||
) |
Definition at line 1021 of file system.cpp.
|
protected |
Definition at line 986 of file system.cpp.
bool ArgsManager::ReadSettingsFile | ( | std::vector< std::string > * | errors = nullptr | ) |
Read settings file.
Push errors to vector, or log them if null.
Definition at line 541 of file system.cpp.
void ArgsManager::SelectConfigNetwork | ( | const std::string & | network | ) |
Select the network in use.
Definition at line 293 of file system.cpp.
bool ArgsManager::SoftSetArg | ( | const std::string & | strArg, |
const std::string & | strValue | ||
) |
Set an argument if it doesn't already have a value.
strArg | Argument to set (e.g. "-foo") |
strValue | Value (e.g. "1") |
Definition at line 688 of file system.cpp.
bool ArgsManager::SoftSetBoolArg | ( | const std::string & | strArg, |
bool | fValue | ||
) |
Set a boolean argument if it doesn't already have a value.
strArg | Argument to set (e.g. "-foo") |
fValue | Value (e.g. false) |
Definition at line 698 of file system.cpp.
|
protected |
Returns true if settings values from the default section should be used, depending on the current network and whether the setting is network-specific.
Definition at line 1153 of file system.cpp.
bool ArgsManager::WriteSettingsFile | ( | std::vector< std::string > * | errors = nullptr , |
bool | backup = false |
||
) | const |
Write settings file or backup settings file.
Push errors to vector, or log them if null.
Definition at line 566 of file system.cpp.
|
mutableprotected |