#include <common/settings.h>
#include <compat/compat.h>
#include <sync.h>
#include <util/chaintype.h>
#include <util/fs.h>
#include <concepts>
#include <cstdint>
#include <iosfwd>
#include <list>
#include <map>
#include <optional>
#include <set>
#include <string>
#include <variant>
#include <vector>

Include dependency graph for args.h:

Classes
struct	KeyInfo

struct	SectionInfo

class	ArgsManager

struct	ArgsManager::Arg

struct	ArgsManager::Command

Enumerations
enum	OptionsCategory { OptionsCategory::OPTIONS, OptionsCategory::CONNECTION, OptionsCategory::WALLET, OptionsCategory::WALLET_DEBUG_TEST, OptionsCategory::ZMQ, OptionsCategory::DEBUG_TEST, OptionsCategory::CHAINPARAMS, OptionsCategory::NODE_RELAY, OptionsCategory::BLOCK_CREATION, OptionsCategory::RPC, OptionsCategory::GUI, OptionsCategory::COMMANDS, OptionsCategory::REGISTER_COMMANDS, OptionsCategory::CLI_COMMANDS, OptionsCategory::IPC, OptionsCategory::HIDDEN }

Functions
bool	CheckDataDirOption (const ArgsManager &args)

fs::path	AbsPathForConfigVal (const ArgsManager &args, const fs::path &path, bool net_specific=true)
	Most paths passed as configuration arguments are treated as relative to the datadir if they are not absolute. More...

bool	IsSwitchChar (char c)

KeyInfo	InterpretKey (std::string key)
	Parse "name", "section.name", "noname", "section.noname" settings keys. More...

std::optional< common::SettingsValue >	InterpretValue (const KeyInfo &key, const std::string *value, unsigned int flags, std::string &error)
	Interpret settings value based on registered flags. More...

std::string	SettingToString (const common::SettingsValue &, const std::string &)

std::optional< std::string >	SettingToString (const common::SettingsValue &)

template<std::integral Int>
Int	SettingTo (const common::SettingsValue &, Int)

template<std::integral Int>
std::optional< Int >	SettingTo (const common::SettingsValue &)

bool	SettingToBool (const common::SettingsValue &, bool)

std::optional< bool >	SettingToBool (const common::SettingsValue &)

bool	HelpRequested (const ArgsManager &args)

void	SetupHelpOptions (ArgsManager &args)
	Add help options to the args manager. More...

bool	HasTestOption (const ArgsManager &args, const std::string &test_option)
	Checks if a particular test option is present in -test command-line arg options. More...

std::string	HelpMessageGroup (const std::string &message)
	Format a string to be used as group of options in help messages. More...

std::string	HelpMessageOpt (const std::string &option, const std::string &message)
	Format a string to be used as option description in help messages. More...

Variables
const char *const	BITCOIN_CONF_FILENAME

const char *const	BITCOIN_SETTINGS_FILENAME

ArgsManager	gArgs

const std::vector< std::string >	TEST_OPTIONS_DOC

Enumeration Type Documentation

◆ OptionsCategory

enum OptionsCategory

strong

Enumerator
OPTIONS
CONNECTION
WALLET
WALLET_DEBUG_TEST
ZMQ
DEBUG_TEST
CHAINPARAMS
NODE_RELAY
BLOCK_CREATION
RPC
GUI
COMMANDS
REGISTER_COMMANDS
CLI_COMMANDS
IPC
HIDDEN

Definition at line 53 of file args.h.

Function Documentation

◆ AbsPathForConfigVal()

fs::path AbsPathForConfigVal	(	const ArgsManager &	args,
		const fs::path &	path,
		bool	net_specific = `true`
	)

Most paths passed as configuration arguments are treated as relative to the datadir if they are not absolute.

Parameters

args	Parsed arguments and settings.
path	The path to be conditionally prefixed with datadir.
net_specific	Use network specific datadir variant

Returns: The normalized path.

Definition at line 226 of file config.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckDataDirOption()

bool CheckDataDirOption ( const ArgsManager & args )

Definition at line 789 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasTestOption()

bool HasTestOption	(	const ArgsManager &	args,
		const std::string &	test_option
	)

Checks if a particular test option is present in -test command-line arg options.

Definition at line 749 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HelpMessageGroup()

std::string HelpMessageGroup ( const std::string & message )

Format a string to be used as group of options in help messages.

Parameters

message Group name (e.g. "RPC server options:")

Returns: the formatted string

Definition at line 732 of file args.cpp.

Here is the caller graph for this function:

◆ HelpMessageOpt()

std::string HelpMessageOpt	(	const std::string &	option,
		const std::string &	message
	)

Format a string to be used as option description in help messages.

Parameters

option	Option message (e.g. "-rpcuser=<user>")
message	Option description (e.g. "Username for JSON-RPC connections")

Returns: the formatted string

Definition at line 736 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HelpRequested()

bool HelpRequested ( const ArgsManager & args )

Returns: true if help has been requested via a command-line arg

Definition at line 717 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InterpretKey()

KeyInfo InterpretKey ( std::string key )

Parse "name", "section.name", "noname", "section.noname" settings keys.

Note: Where an option was negated can be later checked using the IsArgNegated() method. One use case for this is to have a way to disable options that are not normally boolean (e.g. using -nodebuglogfile to request that debug log output is not sent to any file at all).

Definition at line 77 of file args.cpp.

Here is the caller graph for this function:

◆ InterpretValue()

std::optional<common::SettingsValue> InterpretValue	(	const KeyInfo &	key,
		const std::string *	value,
		unsigned int	flags,
		std::string &	error
	)

Interpret settings value based on registered flags.

Parameters

[in]	key	key information to know if key was negated
[in]	value	string value of setting to be parsed
[in]	flags	ArgsManager registered argument flags
[out]	error	Error description if settings value is not valid

Returns: parsed settings value if it is valid, otherwise nullopt accompanied by a descriptive error string

Definition at line 105 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsSwitchChar()

bool IsSwitchChar ( char c )

inline

Definition at line 44 of file args.h.

Here is the caller graph for this function:

◆ SettingTo() [1/2]

template<std::integral Int>

Int SettingTo	(	const common::SettingsValue &	,
		Int
	)

Definition at line 510 of file args.cpp.

◆ SettingTo() [2/2]

template<std::integral Int>

std::optional<Int> SettingTo ( const common::SettingsValue & )

Definition at line 500 of file args.cpp.

Here is the call graph for this function:

◆ SettingToBool() [1/2]

bool SettingToBool	(	const common::SettingsValue &	,
		bool
	)

Definition at line 533 of file args.cpp.

Here is the call graph for this function:

◆ SettingToBool() [2/2]

std::optional<bool> SettingToBool ( const common::SettingsValue & )

Definition at line 526 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SettingToString() [1/2]

std::string SettingToString	(	const common::SettingsValue &	,
		const std::string &
	)

Definition at line 481 of file args.cpp.

Here is the call graph for this function:

◆ SettingToString() [2/2]

std::optional<std::string> SettingToString ( const common::SettingsValue & )

Definition at line 472 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetupHelpOptions()

void SetupHelpOptions ( ArgsManager & args )

Add help options to the args manager.

Definition at line 722 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ BITCOIN_CONF_FILENAME

const char* const BITCOIN_CONF_FILENAME

Definition at line 37 of file args.cpp.

◆ BITCOIN_SETTINGS_FILENAME

const char* const BITCOIN_SETTINGS_FILENAME

Definition at line 38 of file args.cpp.

◆ gArgs

ArgsManager gArgs

Definition at line 40 of file args.cpp.

◆ TEST_OPTIONS_DOC

const std::vector<std::string> TEST_OPTIONS_DOC

Definition at line 743 of file args.cpp.

Classes

Enumerations

Functions

Variables

Enumeration Type Documentation

◆ OptionsCategory

Function Documentation

◆ AbsPathForConfigVal()

◆ CheckDataDirOption()

◆ HasTestOption()

◆ HelpMessageGroup()

◆ HelpMessageOpt()

◆ HelpRequested()

◆ InterpretKey()

◆ InterpretValue()

◆ IsSwitchChar()

◆ SettingTo() [1/2]

◆ SettingTo() [2/2]

◆ SettingToBool() [1/2]

◆ SettingToBool() [2/2]

◆ SettingToString() [1/2]

◆ SettingToString() [2/2]

◆ SetupHelpOptions()

Variable Documentation

◆ BITCOIN_CONF_FILENAME

◆ BITCOIN_SETTINGS_FILENAME

◆ gArgs

◆ TEST_OPTIONS_DOC