#include <system.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 , 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...

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 &section, const std::map< std::string, std::vector< util::SettingsValue > > &args) const

Detailed Description

Definition at line 158 of file system.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
DEBUG_ONLY
NETWORK_ONLY
SENSITIVE
COMMAND

Definition at line 165 of file system.h.

Constructor & Destructor Documentation

◆ ArgsManager()

ArgsManager::ArgsManager ( )

Definition at line 263 of file system.cpp.

◆ ~ArgsManager()

ArgsManager::~ArgsManager ( )

Definition at line 264 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 642 of file system.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
	)

Add subcommand.

Definition at line 630 of file system.cpp.

Here is the call graph for this function:

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 663 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 393 of file system.h.

Here is the caller graph for this function:

◆ ClearPathCache()

void ArgsManager::ClearPathCache ( )

Clear cached directory paths.

Definition at line 458 of file system.cpp.

Here is the caller graph for this function:

◆ ForceSetArg()

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

Definition at line 624 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetArg()

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetArgFlags()

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

Return Flags for known arg.

Return nullopt for unknown arg.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBlocksDirPath()

const fs::path & ArgsManager::GetBlocksDirPath ( ) const

Get blocks directory path.

Returns: Blocks path which is network specific

Definition at line 401 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 602 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 989 of file system.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 467 of file system.cpp.

Here is the caller graph for this function:

◆ GetDataDir()

const 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

Postcondition: Returned directory path is created unless it is empty

Definition at line 427 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDataDirBase()

const fs::path & ArgsManager::GetDataDirBase ( ) const

inline

Get data directory path.

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

Postcondition: Returned directory path is created unless it is empty

Definition at line 280 of file system.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDataDirNet()

const fs::path & ArgsManager::GetDataDirNet ( ) const

inline

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

Postcondition: Returned directory path is created unless it is empty

Definition at line 288 of file system.h.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetIntArg()

int64_t ArgsManager::GetIntArg	(	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 596 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

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

Get list of setting values.

Definition at line 1030 of file system.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`
	)		const

Get settings file path, or return false if read-write settings were disabled with -nosettings.

Definition at line 519 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 286 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 266 of file system.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GUARDED_BY() [1/10]

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

protected

◆ GUARDED_BY() [2/10]

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

protected

◆ GUARDED_BY() [3/10]

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

protected

◆ GUARDED_BY() [4/10]

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

protected

◆ GUARDED_BY() [5/10]

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

protected

◆ GUARDED_BY() [6/10]

bool m_accept_any_command ArgsManager::GUARDED_BY ( cs_args )

inlineprotected

Definition at line 199 of file system.h.

◆ GUARDED_BY() [7/10]

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

protected

◆ GUARDED_BY() [8/10]

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

mutableprotected

◆ GUARDED_BY() [9/10]

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

mutableprotected

◆ GUARDED_BY() [10/10]

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

mutableprotected

◆ InitSettings()

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 501 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 585 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 496 of file system.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 system.h.

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 1053 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 1036 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 308 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 897 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 869 of file system.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 542 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 302 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 608 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 616 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 1018 of file system.cpp.

Here is the caller graph for this function:

◆ WriteSettingsFile()

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ cs_args

RecursiveMutex ArgsManager::cs_args

mutableprotected

Definition at line 193 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()

◆ AddCommand()

◆ AddHiddenArgs()

◆ ClearArgs()

◆ ClearPathCache()

◆ ForceSetArg()

◆ GetArg()

◆ GetArgFlags()

◆ GetArgs()

◆ GetBlocksDirPath()

◆ GetBoolArg()

◆ GetChainName()

◆ GetCommand()

◆ GetDataDir()

◆ GetDataDirBase()

◆ GetDataDirNet()

◆ GetHelpMessage()

◆ GetIntArg()

◆ GetSetting()

◆ GetSettingsList()

◆ GetSettingsPath()

◆ GetUnrecognizedSections()

◆ GetUnsuitableSectionOnlyArgs()

◆ GUARDED_BY() [1/10]

◆ GUARDED_BY() [2/10]

◆ GUARDED_BY() [3/10]

◆ GUARDED_BY() [4/10]

◆ GUARDED_BY() [5/10]

◆ GUARDED_BY() [6/10]

◆ GUARDED_BY() [7/10]

◆ GUARDED_BY() [8/10]

◆ GUARDED_BY() [9/10]

◆ GUARDED_BY() [10/10]

◆ InitSettings()

◆ IsArgNegated()

◆ IsArgSet()

◆ LockSettings()

◆ LogArgs()

◆ logArgsPrefix()

◆ ParseParameters()

◆ ReadConfigFiles()

◆ ReadConfigStream()

◆ ReadSettingsFile()

◆ SelectConfigNetwork()

◆ SoftSetArg()

◆ SoftSetBoolArg()

◆ UseDefaultSection()

◆ WriteSettingsFile()

Member Data Documentation

◆ cs_args