![]() |
Bitcoin Core
22.99.0
P2P Digital Currency
|
#include <system.h>
Classes | |
struct | Arg |
struct | Command |
Public Types | |
enum | Flags : uint32_t { ALLOW_ANY = 0x01, DISALLOW_NEGATION = 0x20, DEBUG_ONLY = 0x100, NETWORK_ONLY = 0x200, SENSITIVE = 0x400, COMMAND = 0x800 } |
Flags controlling how config and command line arguments are validated and interpreted. More... | |
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... | |
std::optional< const Command > | GetCommand () const |
Get the command and command args (returns std::nullopt if no command provided) More... | |
fs::path | GetPathArg (std::string pathlike_arg) const |
Get a normalized path from a specified pathlike argument. 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... | |
int64_t | GetIntArg (const std::string &strArg, int64_t nDefault) const |
Return integer argument or default value. More... | |
bool | GetBoolArg (const std::string &strArg, bool fDefault) const |
Return boolean argument or default value. More... | |
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) |
std::string | GetChainName () const |
Returns the appropriate chain name from the program arguments. More... | |
void | AddArg (const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat) |
Add argument. More... | |
void | AddCommand (const std::string &cmd, const std::string &help) |
Add subcommand. 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) 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) const |
Write settings file. 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::vector< std::string > m_command | 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) |
bool m_accept_any_command | 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 : uint32_t |
ArgsManager::ArgsManager | ( | ) |
Definition at line 252 of file system.cpp.
ArgsManager::~ArgsManager | ( | ) |
Definition at line 253 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 640 of file system.cpp.
void ArgsManager::AddCommand | ( | const std::string & | cmd, |
const std::string & | help | ||
) |
Add subcommand.
Definition at line 628 of file system.cpp.
void ArgsManager::AddHiddenArgs | ( | const std::vector< std::string > & | args | ) |
Add many hidden arguments.
Definition at line 661 of file system.cpp.
|
inline |
void ArgsManager::ClearPathCache | ( | ) |
Clear cached directory paths.
Definition at line 456 of file system.cpp.
void ArgsManager::ForceSetArg | ( | const std::string & | strArg, |
const std::string & | strValue | ||
) |
Definition at line 622 of file system.cpp.
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 588 of file system.cpp.
std::optional< unsigned int > ArgsManager::GetArgFlags | ( | const std::string & | name | ) | const |
Return Flags for known arg.
Return nullopt for unknown arg.
Definition at line 378 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 485 of file system.cpp.
const fs::path & ArgsManager::GetBlocksDirPath | ( | ) | const |
Get blocks directory path.
Definition at line 397 of file system.cpp.
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 600 of file system.cpp.
std::string ArgsManager::GetChainName | ( | ) | const |
Returns the appropriate chain name from the program arguments.
Definition at line 987 of file system.cpp.
std::optional< const ArgsManager::Command > ArgsManager::GetCommand | ( | ) | const |
Get the command and command args (returns std::nullopt if no command provided)
Definition at line 465 of file system.cpp.
|
private |
Get data directory path.
net_specific | Append network identifier to the returned path |
Definition at line 422 of file system.cpp.
|
inline |
Get data directory path.
Definition at line 296 of file system.h.
|
inline |
Get data directory path with appended network identifier.
Definition at line 304 of file system.h.
std::string ArgsManager::GetHelpMessage | ( | ) | const |
Get the help string.
Definition at line 668 of file system.cpp.
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 594 of file system.cpp.
fs::path ArgsManager::GetPathArg | ( | std::string | pathlike_arg | ) | const |
Get a normalized path from a specified pathlike argument.
It is guaranteed that the returned path has no trailing slashes.
pathlike_arg | Pathlike argument to get a path from (e.g., "-datadir", "-blocksdir" or "-walletdir") |
Definition at line 390 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 1021 of file system.cpp.
std::vector< util::SettingsValue > ArgsManager::GetSettingsList | ( | const std::string & | arg | ) | const |
Get list of setting values.
Definition at line 1028 of file system.cpp.
bool ArgsManager::GetSettingsPath | ( | fs::path * | filepath = nullptr , |
bool | temp = false |
||
) | const |
Get settings file path, or return false if read-write settings were disabled with -nosettings.
Definition at line 517 of file system.cpp.
const std::list< SectionInfo > ArgsManager::GetUnrecognizedSections | ( | ) | const |
Log warnings for unrecognized section names in the config file.
Definition at line 275 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 255 of file system.cpp.
|
protected |
|
protected |
|
protected |
|
protected |
|
inlineprotected |
|
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 499 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 583 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 494 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 1051 of file system.cpp.
|
private |
Definition at line 1034 of file system.cpp.
bool ArgsManager::ParseParameters | ( | int | argc, |
const char *const | argv[], | ||
std::string & | error | ||
) |
Definition at line 297 of file system.cpp.
bool ArgsManager::ReadConfigFiles | ( | std::string & | error, |
bool | ignore_invalid_keys = false |
||
) |
Definition at line 895 of file system.cpp.
|
protected |
Definition at line 867 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 540 of file system.cpp.
void ArgsManager::SelectConfigNetwork | ( | const std::string & | network | ) |
Select the network in use.
Definition at line 291 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 606 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 614 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 1016 of file system.cpp.
bool ArgsManager::WriteSettingsFile | ( | std::vector< std::string > * | errors = nullptr | ) | const |
Write settings file.
Push errors to vector, or log them if null.
Definition at line 563 of file system.cpp.
|
mutableprotected |