#include <system.h>

Inheritance diagram for ArgsManager:

Collaboration diagram for ArgsManager:

Public Member Functions
	ArgsManager ()

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

void	ParseParameters (int argc, const char *const argv[])

void	ReadConfigFile (const std::string &confPath)

void	WarnForSectionOnlyArgs ()
	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...

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
	Looks for -regtest, -testnet and returns the appropriate BIP70 chain name. More...

Protected Member Functions
void	ReadConfigStream (std::istream &stream)

Protected Attributes
RecursiveMutex	cs_args

std::map< std::string, std::vector< std::string > >	m_override_args

std::map< std::string, std::vector< std::string > >	m_config_args

std::string	m_network

std::set< std::string >	m_network_only_args

Friends
class	ArgsManagerHelper

Detailed Description

Definition at line 127 of file system.h.

Constructor & Destructor Documentation

◆ ArgsManager()

ArgsManager::ArgsManager ( )

Definition at line 322 of file system.cpp.

Member Function Documentation

◆ ForceSetArg()

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

Definition at line 489 of file system.cpp.

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")
default	(e.g. "1")

Returns: command-line argument or default value

Definition at line 449 of file system.cpp.

Here is the call graph for this function:

Here is the caller 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")
default	(e.g. 1)

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

Definition at line 457 of file system.cpp.

Here is the call 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 406 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")
default	(true or false)

Returns: command-line argument or default value

Definition at line 465 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

Looks for -regtest, -testnet and returns the appropriate BIP70 chain name.

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

Definition at line 861 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 431 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 425 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseParameters()

void ArgsManager::ParseParameters	(	int	argc,
		const char *const	argv[]
	)

Definition at line 371 of file system.cpp.

Here is the caller graph for this function:

◆ ReadConfigFile()

void ArgsManager::ReadConfigFile ( const std::string & confPath )

Definition at line 832 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReadConfigStream()

void ArgsManager::ReadConfigStream ( std::istream & stream )

protected

Definition at line 816 of file system.cpp.

Here is the caller graph for this function:

◆ SelectConfigNetwork()

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

Select the network in use.

Definition at line 366 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 473 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 481 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WarnForSectionOnlyArgs()

void ArgsManager::WarnForSectionOnlyArgs ( )

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

Here is the call graph for this function:

Friends And Related Function Documentation

◆ ArgsManagerHelper

friend class ArgsManagerHelper

friend

Definition at line 130 of file system.h.

Member Data Documentation

◆ cs_args

RecursiveMutex ArgsManager::cs_args

mutableprotected

Definition at line 132 of file system.h.

◆ m_config_args

std::map<std::string, std::vector<std::string> > ArgsManager::m_config_args

protected

Definition at line 134 of file system.h.

◆ m_network

std::string ArgsManager::m_network

protected

Definition at line 135 of file system.h.

◆ m_network_only_args

std::set<std::string> ArgsManager::m_network_only_args

protected

Definition at line 136 of file system.h.

◆ m_override_args

std::map<std::string, std::vector<std::string> > ArgsManager::m_override_args

protected

Definition at line 133 of file system.h.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ArgsManager()

Member Function Documentation

◆ ForceSetArg()

◆ GetArg() [1/2]

◆ GetArg() [2/2]

◆ GetArgs()

◆ GetBoolArg()

◆ GetChainName()

◆ IsArgNegated()

◆ IsArgSet()

◆ ParseParameters()

◆ ReadConfigFile()

◆ ReadConfigStream()

◆ SelectConfigNetwork()

◆ SoftSetArg()

◆ SoftSetBoolArg()

◆ WarnForSectionOnlyArgs()

Friends And Related Function Documentation

◆ ArgsManagerHelper

Member Data Documentation

◆ cs_args

◆ m_config_args

◆ m_network

◆ m_network_only_args

◆ m_override_args