#include <system.h>

Collaboration diagram for ArgsManager:

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
	ArgsManager ()

	~ArgsManager ()

void	SelectConfigNetwork (const std::string &network)
	Select the network in use. More...

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

NODISCARD 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::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	GetArg (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	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...

Optional< unsigned int >	GetArgFlags (const std::string &name) const
	Return Flags for known arg. 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)

NODISCARD 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...

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...

Protected Attributes
RecursiveMutex	cs_args

Private Member Functions
void	logArgsPrefix (const std::string &prefix, const std::string &section, const std::map< std::string, std::vector< util::SettingsValue >> &args) const

Detailed Description

Definition at line 143 of file system.h.

Member Enumeration Documentation

◆ Flags

enum ArgsManager::Flags

Enumerator
ALLOW_BOOL
ALLOW_INT
ALLOW_STRING
ALLOW_ANY
DEBUG_ONLY
NETWORK_ONLY
SENSITIVE

Definition at line 146 of file system.h.

Constructor & Destructor Documentation

◆ ArgsManager()

ArgsManager::ArgsManager ( )

Definition at line 239 of file system.cpp.

◆ ~ArgsManager()

ArgsManager::~ArgsManager ( )

Definition at line 240 of file system.cpp.

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 420 of file system.cpp.

Here is the caller graph for this function:

◆ AddHiddenArgs()

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

Add many hidden arguments.

Definition at line 439 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClearArgs()

void ArgsManager::ClearArgs ( )

inline

Clear available arguments.

Definition at line 319 of file system.h.

Here is the call graph for this function:

◆ ForceSetArg()

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

Definition at line 414 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetArg() [1/2]

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 380 of file system.cpp.

Here is the call graph for this function:

◆ GetArg() [2/2]

int64_t ArgsManager::GetArg	(	const std::string &	strArg,
		int64_t	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 386 of file system.cpp.

Here is the call graph for this function:

◆ GetArgFlags()

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

Return Flags for known arg.

Return nullopt for unknown arg.

Definition at line 349 of file system.cpp.

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 361 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBoolArg()

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 392 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetChainName()

std::string ArgsManager::GetChainName ( ) const

Returns the appropriate chain name from the program arguments.

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

Definition at line 831 of file system.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 446 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSetting()

util::SettingsValue ArgsManager::GetSetting ( const std::string & arg ) const

protected

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 860 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSettingsList()

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

protected

Get list of setting values.

Definition at line 867 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetUnrecognizedSections()

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

Log warnings for unrecognized section names in the config file.

Definition at line 262 of file system.cpp.

Here is the caller graph for this function:

◆ GetUnsuitableSectionOnlyArgs()

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 242 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GUARDED_BY() [1/5]

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

protected

◆ GUARDED_BY() [2/5]

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

protected

◆ GUARDED_BY() [3/5]

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

protected

◆ GUARDED_BY() [4/5]

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

protected

◆ GUARDED_BY() [5/5]

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

protected

◆ 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 375 of file system.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 370 of file system.cpp.

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 890 of file system.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< util::SettingsValue >> &	args
	)		const

private

Definition at line 873 of file system.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 283 of file system.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 744 of file system.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 715 of file system.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 277 of file system.cpp.

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 398 of file system.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 406 of file system.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

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 855 of file system.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ cs_args

RecursiveMutex ArgsManager::cs_args

mutableprotected

Definition at line 171 of file system.h.

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

src/util/system.h
src/util/system.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ Flags

Constructor & Destructor Documentation

◆ ArgsManager()

◆ ~ArgsManager()

Member Function Documentation

◆ AddArg()

◆ AddHiddenArgs()

◆ ClearArgs()

◆ ForceSetArg()

◆ GetArg() [1/2]

◆ GetArg() [2/2]

◆ GetArgFlags()

◆ GetArgs()

◆ GetBoolArg()

◆ GetChainName()

◆ GetHelpMessage()

◆ GetSetting()

◆ GetSettingsList()

◆ GetUnrecognizedSections()

◆ GetUnsuitableSectionOnlyArgs()

◆ GUARDED_BY() [1/5]

◆ GUARDED_BY() [2/5]

◆ GUARDED_BY() [3/5]

◆ GUARDED_BY() [4/5]

◆ GUARDED_BY() [5/5]

◆ IsArgNegated()

◆ IsArgSet()

◆ LogArgs()

◆ logArgsPrefix()

◆ ParseParameters()

◆ ReadConfigFiles()

◆ ReadConfigStream()

◆ SelectConfigNetwork()

◆ SoftSetArg()

◆ SoftSetBoolArg()

◆ UseDefaultSection()

Member Data Documentation

◆ cs_args