#include <args.h>

Inheritance diagram for ArgsManager:

Collaboration diagram for ArgsManager:

Classes
struct	Arg

struct	Command

Public Types
enum	Flags : uint32_t { ALLOW_ANY = 0x01 , DISALLOW_NEGATION = 0x20 , DISALLOW_ELISION = 0x40 , 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
common::SettingsValue	GetSetting (const std::string &arg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Get setting value.

std::vector< common::SettingsValue >	GetSettingsList (const std::string &arg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Get list of setting values.

	ArgsManager ()

	~ArgsManager ()

void	SelectConfigNetwork (const std::string &network) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Select the network in use.

bool	ParseParameters (int argc, const char *const argv[], std::string &error) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)

fs::path	GetConfigFilePath () const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Return config file path (read-only)

void	SetConfigFilePath (fs::path) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)

bool	ReadConfigFiles (std::string &error, bool ignore_invalid_keys=false) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)

std::set< std::string >	GetUnsuitableSectionOnlyArgs () const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	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.

std::list< SectionInfo >	GetUnrecognizedSections () const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Log warnings for unrecognized section names in the config file.

std::optional< const Command >	GetCommand () const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Get the command and command args (returns std::nullopt if no command provided)

bool	CheckCommandOptions (const std::string &command, std::vector< std::string > *errors=nullptr) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Check that any command-specific options the user specified are valid for the given command.

fs::path	GetBlocksDirPath () const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Get blocks directory path.

fs::path	GetDataDirBase () const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Get data directory path.

fs::path	GetDataDirNet () const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Get data directory path with appended network identifier.

void	ClearPathCache () EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Clear cached directory paths.

std::vector< std::string >	GetArgs (const std::string &strArg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Return a vector of strings of the given argument.

bool	IsArgSet (const std::string &strArg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Return true if the given argument has been manually set.

bool	IsArgNegated (const std::string &strArg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Return true if the argument was originally passed as a negated option, i.e.

std::string	GetArg (const std::string &strArg, const std::string &strDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Return string argument or default value.

std::optional< std::string >	GetArg (const std::string &strArg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)

fs::path	GetPathArg (std::string arg, const fs::path &default_value={}) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Return path argument or default value.

template<std::integral Int>
Int	GetArg (const std::string &strArg, Int nDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Return integer argument or default value.

template<std::integral Int>
std::optional< Int >	GetArg (const std::string &strArg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)

int64_t	GetIntArg (const std::string &strArg, int64_t nDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)

std::optional< int64_t >	GetIntArg (const std::string &strArg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)

bool	GetBoolArg (const std::string &strArg, bool fDefault) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Return boolean argument or default value.

std::optional< bool >	GetBoolArg (const std::string &strArg) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)

bool	SoftSetArg (const std::string &strArg, const std::string &strValue) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Set an argument if it doesn't already have a value.

bool	SoftSetBoolArg (const std::string &strArg, bool fValue) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Set a boolean argument if it doesn't already have a value.

void	ForceSetArg (const std::string &strArg, const std::string &strValue) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)

ChainType	GetChainType () const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Returns the appropriate chain type from the program arguments.

std::string	GetChainTypeString () const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Returns the appropriate chain type string from the program arguments.

void	AddArg (const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Add argument.

void	AddCommand (const std::string &cmd, const std::string &help, std::set< std::string > options={}) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Add command.

void	AddHiddenArgs (const std::vector< std::string > &args) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Add many hidden arguments.

void	ClearArgs () EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Clear available arguments.

void	CheckMultipleCLIArgs () const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Check CLI command args.

std::string	GetHelpMessage () const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Get the help string.

std::optional< unsigned int >	GetArgFlags (const std::string &name) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Return Flags for known arg.

void	SetDefaultFlags (std::optional< unsigned int >) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Set default flags to return for an unknown arg.

bool	GetSettingsPath (fs::path *filepath=nullptr, bool temp=false, bool backup=false) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Get settings file path, or return false if read-write settings were disabled with -nosettings.

bool	ReadSettingsFile (std::vector< std::string > *errors=nullptr) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Read settings file.

bool	WriteSettingsFile (std::vector< std::string > *errors=nullptr, bool backup=false) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Write settings file or backup settings file.

common::SettingsValue	GetPersistentSetting (const std::string &name) const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Get current setting from config file or read/write settings file, ignoring nonpersistent command line or forced settings values.

template<typename Fn >
void	LockSettings (Fn &&fn) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Access settings with lock held.

void	LogArgs () const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Log the config file options and the command line arguments, useful for troubleshooting.

Protected Member Functions
bool	ReadConfigStream (std::istream &stream, const std::string &filepath, std::string &error, bool ignore_invalid_keys=false) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)

bool	ReadConfigString (const std::string &str_config) EXCLUSIVE_LOCKS_REQUIRED(!cs_args)

Private Member Functions
common::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)

std::optional< unsigned int > m_default_flags	GUARDED_BY (cs_args)

std::map< std::string, std::set< std::string > > m_command_args	GUARDED_BY (cs_args)

bool m_accept_any_command	GUARDED_BY (cs_args)

std::list< SectionInfo > m_config_sections	GUARDED_BY (cs_args)

std::optional< fs::path > m_config_path	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	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.

common::SettingsValue	GetSetting_ (const std::string &arg) const EXCLUSIVE_LOCKS_REQUIRED(cs_args)

std::optional< unsigned int >	GetArgFlags_ (const std::string &name) const EXCLUSIVE_LOCKS_REQUIRED(cs_args)

fs::path	GetPathArg_ (std::string arg, const fs::path &default_value={}) const EXCLUSIVE_LOCKS_REQUIRED(cs_args)

fs::path	GetDataDir (bool net_specific) const EXCLUSIVE_LOCKS_REQUIRED(cs_args)
	Get data directory path.

std::variant< ChainType, std::string >	GetChainArg () const EXCLUSIVE_LOCKS_REQUIRED(!cs_args)
	Return -regtest/-signet/-testnet/-testnet4/-chain= setting as a ChainType enum if a recognized chain type was set, or as a string if an unrecognized chain name was set.

void	logArgsPrefix (const std::string &prefix, const std::string &section, const std::map< std::string, std::vector< common::SettingsValue > > &args) const EXCLUSIVE_LOCKS_REQUIRED(cs_args)

Private Attributes
Mutex	cs_args

Detailed Description

Definition at line 101 of file args.h.

Member Enumeration Documentation

◆ Flags

enum ArgsManager::Flags : uint32_t

Flags controlling how config and command line arguments are validated and interpreted.

Enumerator
ALLOW_ANY	disable validation
DISALLOW_NEGATION	disallow -nofoo syntax
DISALLOW_ELISION	disallow -foo syntax that doesn't assign any value
DEBUG_ONLY
NETWORK_ONLY
SENSITIVE
COMMAND

Definition at line 108 of file args.h.

Constructor & Destructor Documentation

◆ ArgsManager()

ArgsManager::ArgsManager ( )

default

◆ ~ArgsManager()

ArgsManager::~ArgsManager ( )

default

Member Function Documentation

◆ AddArg()

void ArgsManager::AddArg	(	const std::string &	name,
		const std::string &	help,
		unsigned int	flags,
		const OptionsCategory &	cat
	)

Add argument.

Definition at line 641 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddCommand()

void ArgsManager::AddCommand	(	const std::string &	cmd,
		const std::string &	help,
		std::set< std::string >	options = `{}`
	)

Add command.

Definition at line 617 of file args.cpp.

Here is the call graph for this function:

◆ AddHiddenArgs()

void ArgsManager::AddHiddenArgs ( const std::vector< std::string > & args )

Add many hidden arguments.

Definition at line 670 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckCommandOptions()

bool ArgsManager::CheckCommandOptions	(	const std::string &	command,
		std::vector< std::string > *	errors = `nullptr`
	)		const

Check that any command-specific options the user specified are valid for the given command.

Parameters

[in]	command	The command being run.
[out]	errors	If non-null, populated with a message for each invalid option.

Returns: false if any command-specific options were specified that are not valid for this command

Definition at line 389 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckMultipleCLIArgs()

void ArgsManager::CheckMultipleCLIArgs ( ) const

Check CLI command args.

Exceptions

std::runtime_error when multiple CLI_COMMAND arguments are specified

Definition at line 687 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClearArgs()

void ArgsManager::ClearArgs ( )

Clear available arguments.

Definition at line 677 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClearPathCache()

void ArgsManager::ClearPathCache ( )

Clear cached directory paths.

Definition at line 360 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ForceSetArg()

void ArgsManager::ForceSetArg	(	const std::string &	strArg,
		const std::string &	strValue
	)

Definition at line 611 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetArg() [1/4]

std::optional< std::string > ArgsManager::GetArg ( const std::string & strArg ) const

Definition at line 523 of file args.cpp.

Here is the call graph for this function:

◆ GetArg() [2/4]

template<std::integral Int>

std::optional< Int > ArgsManager::GetArg ( const std::string & strArg ) const

Definition at line 545 of file args.cpp.

Here is the call graph for this function:

◆ GetArg() [3/4]

std::string ArgsManager::GetArg	(	const std::string &	strArg,
		const std::string &	strDefault
	)		const

Return string argument or default value.

Parameters

strArg	Argument to get (e.g. "-foo")
strDefault	(e.g. "1")

Returns: command-line argument or default value

Definition at line 518 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetArg() [4/4]

template<std::integral Int>

Int ArgsManager::GetArg	(	const std::string &	strArg,
		Int	nDefault
	)		const

Return integer argument or default value.

Parameters

strArg	Argument to get (e.g. "-foo")
nDefault	(e.g. 1)

Returns: command-line argument (0 if invalid number) or default value

Definition at line 539 of file args.cpp.

Here is the call graph for this function:

◆ GetArgFlags()

std::optional< unsigned int > ArgsManager::GetArgFlags ( const std::string & name ) const

Return Flags for known arg.

Return default flags for unknown arg.

Definition at line 269 of file args.cpp.

Here is the call graph for this function:

◆ GetArgFlags_()

std::optional< unsigned int > ArgsManager::GetArgFlags_ ( const std::string & name ) const

private

Definition at line 257 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetArgs()

std::vector< std::string > ArgsManager::GetArgs ( const std::string & strArg ) const

Return a vector of strings of the given argument.

Parameters

strArg Argument to get (e.g. "-foo")

Returns: command-line arguments

Definition at line 423 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBlocksDirPath()

fs::path ArgsManager::GetBlocksDirPath ( ) const

Get blocks directory path.

Returns: Blocks path which is network specific

Definition at line 299 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBoolArg() [1/2]

std::optional< bool > ArgsManager::GetBoolArg ( const std::string & strArg ) const

Definition at line 566 of file args.cpp.

Here is the call graph for this function:

◆ GetBoolArg() [2/2]

bool ArgsManager::GetBoolArg	(	const std::string &	strArg,
		bool	fDefault
	)		const

Return boolean argument or default value.

Parameters

strArg	Argument to get (e.g. "-foo")
fDefault	(true or false)

Returns: command-line argument or default value

Definition at line 561 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetChainArg()

std::variant< ChainType, std::string > ArgsManager::GetChainArg ( ) const

private

Return -regtest/-signet/-testnet/-testnet4/-chain= setting as a ChainType enum if a recognized chain type was set, or as a string if an unrecognized chain name was set.

Raise an exception if an invalid combination of flags was provided.

Definition at line 908 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetChainType()

ChainType ArgsManager::GetChainType ( ) const

Returns the appropriate chain type from the program arguments.

Returns: ChainType::MAIN by default; raises runtime error if an invalid combination, or unknown chain is given.

Definition at line 894 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetChainTypeString()

std::string ArgsManager::GetChainTypeString ( ) const

Returns the appropriate chain type string from the program arguments.

Returns: ChainType::MAIN string by default; raises runtime error if an invalid combination is given.

Definition at line 901 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCommand()

std::optional< const ArgsManager::Command > ArgsManager::GetCommand ( ) const

Get the command and command args (returns std::nullopt if no command provided)

Definition at line 369 of file args.cpp.

Here is the call graph for this function:

◆ GetConfigFilePath()

fs::path ArgsManager::GetConfigFilePath ( ) const

Return config file path (read-only)

Definition at line 881 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDataDir()

fs::path ArgsManager::GetDataDir ( bool net_specific ) const

private

Get data directory path.

Parameters

net_specific Append network identifier to the returned path

Returns: Absolute path on success, otherwise an empty path when a non-directory path would be returned

Definition at line 334 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDataDirBase()

fs::path ArgsManager::GetDataDirBase ( ) const

Get data directory path.

Returns: Absolute path on success, otherwise an empty path when a non-directory path would be returned

Definition at line 324 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDataDirNet()

fs::path ArgsManager::GetDataDirNet ( ) const

Get data directory path with appended network identifier.

Returns: Absolute path on success, otherwise an empty path when a non-directory path would be returned

Definition at line 329 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHelpMessage()

std::string ArgsManager::GetHelpMessage ( ) const

Get the help string.

Definition at line 704 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetIntArg() [1/2]

std::optional< int64_t > ArgsManager::GetIntArg ( const std::string & strArg ) const

inline

Definition at line 319 of file args.h.

Here is the call graph for this function:

◆ GetIntArg() [2/2]

int64_t ArgsManager::GetIntArg	(	const std::string &	strArg,
		int64_t	nDefault
	)		const

inline

Definition at line 318 of file args.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPathArg()

fs::path ArgsManager::GetPathArg	(	std::string	arg,
		const fs::path &	default_value = `{}`
	)		const

Return path argument or default value.

Parameters

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.

Returns: normalized path if argument is set, with redundant "." and ".." path components and trailing separators removed (see patharg unit test for examples or implementation for details). If argument is empty or not set, default_value is returned unchanged.

Definition at line 293 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPathArg_()

fs::path ArgsManager::GetPathArg_	(	std::string	arg,
		const fs::path &	default_value = `{}`
	)		const

private

Definition at line 281 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPersistentSetting()

common::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 506 of file args.cpp.

Here is the call graph for this function:

◆ GetSetting()

common::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 954 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSetting_()

common::SettingsValue ArgsManager::GetSetting_ ( const std::string & arg ) const

private

Definition at line 946 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSettingsList()

std::vector< common::SettingsValue > ArgsManager::GetSettingsList ( const std::string & arg ) const

Get list of setting values.

Definition at line 960 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSettingsPath()

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 437 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUnrecognizedSections()

std::list< SectionInfo > ArgsManager::GetUnrecognizedSections ( ) const

Log warnings for unrecognized section names in the config file.

Definition at line 153 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUnsuitableSectionOnlyArgs()

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 133 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GUARDED_BY() [1/13]

common::Settings m_settings ArgsManager::GUARDED_BY ( cs_args )

private

◆ GUARDED_BY() [2/13]

std::vector< std::string > m_command ArgsManager::GUARDED_BY ( cs_args )

private

◆ GUARDED_BY() [3/13]

std::string m_network ArgsManager::GUARDED_BY ( cs_args )

private

◆ GUARDED_BY() [4/13]

std::set< std::string > m_network_only_args ArgsManager::GUARDED_BY ( cs_args )

private

◆ GUARDED_BY() [5/13]

std::map< OptionsCategory, std::map< std::string, Arg > > m_available_args ArgsManager::GUARDED_BY ( cs_args )

private

◆ GUARDED_BY() [6/13]

std::optional< unsigned int > m_default_flags ArgsManager::GUARDED_BY ( cs_args )

inlineprivate

Definition at line 143 of file args.h.

◆ GUARDED_BY() [7/13]

std::map< std::string, std::set< std::string > > m_command_args ArgsManager::GUARDED_BY ( cs_args )

private

◆ GUARDED_BY() [8/13]

bool m_accept_any_command ArgsManager::GUARDED_BY ( cs_args )

inlineprivate

Definition at line 145 of file args.h.

◆ GUARDED_BY() [9/13]

std::list< SectionInfo > m_config_sections ArgsManager::GUARDED_BY ( cs_args )

private

◆ GUARDED_BY() [10/13]

std::optional< fs::path > m_config_path ArgsManager::GUARDED_BY ( cs_args )

private

◆ GUARDED_BY() [11/13]

fs::path m_cached_blocks_path ArgsManager::GUARDED_BY ( cs_args )

mutableprivate

◆ GUARDED_BY() [12/13]

fs::path m_cached_datadir_path ArgsManager::GUARDED_BY ( cs_args )

mutableprivate

◆ GUARDED_BY() [13/13]

fs::path m_cached_network_datadir_path ArgsManager::GUARDED_BY ( cs_args )

mutableprivate

◆ IsArgNegated()

bool ArgsManager::IsArgNegated ( const std::string & strArg ) const

Return true if the argument was originally passed as a negated option, i.e.

-nofoo.

Parameters

strArg Argument to get (e.g. "-foo")

Returns: true if the argument was passed negated

Definition at line 513 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsArgSet()

bool ArgsManager::IsArgSet ( const std::string & strArg ) const

Return true if the given argument has been manually set.

Parameters

strArg Argument to get (e.g. "-foo")

Returns: true if the argument has been set

Definition at line 432 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LockSettings()

template<typename Fn >

void ArgsManager::LockSettings ( Fn && fn )

inline

Access settings with lock held.

Definition at line 437 of file args.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LogArgs()

void ArgsManager::LogArgs ( ) const

Log the config file options and the command line arguments, useful for troubleshooting.

Definition at line 984 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ logArgsPrefix()

void ArgsManager::logArgsPrefix	(	const std::string &	prefix,
		const std::string &	section,
		const std::map< std::string, std::vector< common::SettingsValue > > &	args
	)		const

private

Definition at line 966 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseParameters()

bool ArgsManager::ParseParameters	(	int	argc,
		const char *const	argv[],
		std::string &	error
	)

Definition at line 176 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadConfigFiles()

bool ArgsManager::ReadConfigFiles	(	std::string &	error,
		bool	ignore_invalid_keys = `false`
	)

Definition at line 132 of file config.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadConfigStream()

bool ArgsManager::ReadConfigStream	(	std::istream &	stream,
		const std::string &	filepath,
		std::string &	error,
		bool	ignore_invalid_keys = `false`
	)

protected

Definition at line 91 of file config.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadConfigString()

bool ArgsManager::ReadConfigString ( const std::string & str_config )

protected

Definition at line 120 of file config.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadSettingsFile()

bool ArgsManager::ReadSettingsFile ( std::vector< std::string > * errors = nullptr )

Read settings file.

Push errors to vector, or log them if null.

Definition at line 463 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SelectConfigNetwork()

void ArgsManager::SelectConfigNetwork ( const std::string & network )

Select the network in use.

Definition at line 170 of file args.cpp.

Here is the caller graph for this function:

◆ SetConfigFilePath()

void ArgsManager::SetConfigFilePath ( fs::path path )

Definition at line 887 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDefaultFlags()

void ArgsManager::SetDefaultFlags ( std::optional< unsigned int > flags )

Set default flags to return for an unknown arg.

Definition at line 275 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SoftSetArg()

bool ArgsManager::SoftSetArg	(	const std::string &	strArg,
		const std::string &	strValue
	)

Set an argument if it doesn't already have a value.

Parameters

strArg	Argument to set (e.g. "-foo")
strValue	Value (e.g. "1")

Returns: true if argument gets set, false if it already had a value

Definition at line 595 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SoftSetBoolArg()

bool ArgsManager::SoftSetBoolArg	(	const std::string &	strArg,
		bool	fValue
	)

Set a boolean argument if it doesn't already have a value.

Parameters

strArg	Argument to set (e.g. "-foo")
fValue	Value (e.g. false)

Returns: true if argument gets set, false if it already had a value

Definition at line 603 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UseDefaultSection()

bool ArgsManager::UseDefaultSection ( const std::string & arg ) const

private

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 940 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteSettingsFile()

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 486 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ cs_args

Mutex ArgsManager::cs_args

mutableprivate

Definition at line 137 of file args.h.

The documentation for this class was generated from the following files:

src/common/args.h
src/common/args.cpp
src/common/config.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Flags

Constructor & Destructor Documentation

◆ ArgsManager()

◆ ~ArgsManager()

Member Function Documentation

◆ AddArg()

◆ AddCommand()

◆ AddHiddenArgs()

◆ CheckCommandOptions()

◆ CheckMultipleCLIArgs()

◆ ClearArgs()

◆ ClearPathCache()

◆ ForceSetArg()

◆ GetArg() [1/4]

◆ GetArg() [2/4]

◆ GetArg() [3/4]

◆ GetArg() [4/4]

◆ GetArgFlags()

◆ GetArgFlags_()

◆ GetArgs()

◆ GetBlocksDirPath()

◆ GetBoolArg() [1/2]

◆ GetBoolArg() [2/2]

◆ GetChainArg()

◆ GetChainType()

◆ GetChainTypeString()

◆ GetCommand()

◆ GetConfigFilePath()

◆ GetDataDir()

◆ GetDataDirBase()

◆ GetDataDirNet()

◆ GetHelpMessage()

◆ GetIntArg() [1/2]

◆ GetIntArg() [2/2]

◆ GetPathArg()

◆ GetPathArg_()

◆ GetPersistentSetting()

◆ GetSetting()

◆ GetSetting_()

◆ GetSettingsList()

◆ GetSettingsPath()

◆ GetUnrecognizedSections()

◆ GetUnsuitableSectionOnlyArgs()

◆ GUARDED_BY() [1/13]

◆ GUARDED_BY() [2/13]

◆ GUARDED_BY() [3/13]

◆ GUARDED_BY() [4/13]

◆ GUARDED_BY() [5/13]

◆ GUARDED_BY() [6/13]

◆ GUARDED_BY() [7/13]

◆ GUARDED_BY() [8/13]

◆ GUARDED_BY() [9/13]

◆ GUARDED_BY() [10/13]

◆ GUARDED_BY() [11/13]

◆ GUARDED_BY() [12/13]

◆ GUARDED_BY() [13/13]

◆ IsArgNegated()

◆ IsArgSet()

◆ LockSettings()

◆ LogArgs()

◆ logArgsPrefix()

◆ ParseParameters()

◆ ReadConfigFiles()

◆ ReadConfigStream()

◆ ReadConfigString()

◆ ReadSettingsFile()

◆ SelectConfigNetwork()

◆ SetConfigFilePath()

◆ SetDefaultFlags()

◆ SoftSetArg()

◆ SoftSetBoolArg()

◆ UseDefaultSection()