#include <common/args.h>
#include <chainparamsbase.h>
#include <common/settings.h>
#include <logging.h>
#include <sync.h>
#include <tinyformat.h>
#include <univalue.h>
#include <util/chaintype.h>
#include <util/check.h>
#include <util/fs.h>
#include <util/fs_helpers.h>
#include <util/strencodings.h>
#include <util/string.h>
#include <algorithm>
#include <cassert>
#include <cstdint>
#include <cstdlib>
#include <cstring>
#include <map>
#include <optional>
#include <stdexcept>
#include <string>
#include <utility>
#include <variant>

Include dependency graph for args.cpp:

Namespaces
namespace	common

Functions
static bool	InterpretBool (const std::string &strValue)
	Interpret a string argument as a boolean. More...

static std::string	SettingName (const std::string &arg)

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

static void	SaveErrors (const std::vector< std::string > errors, std::vector< std::string > *error_out)

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

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

std::optional< int64_t >	SettingToInt (const common::SettingsValue &value)

int64_t	SettingToInt (const common::SettingsValue &value, int64_t nDefault)

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

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

bool	HelpRequested (const ArgsManager &args)

void	SetupHelpOptions (ArgsManager &args)
	Add help options to the args manager. 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...

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

fs::path	GetDefaultDataDir ()

bool	CheckDataDirOption (const ArgsManager &args)

Variables
const char *const	BITCOIN_CONF_FILENAME = "bitcoin.conf"

const char *const	BITCOIN_SETTINGS_FILENAME = "settings.json"

ArgsManager	gArgs

static const int	screenWidth = 79

static const int	optIndent = 2

static const int	msgIndent = 7

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

Function Documentation

◆ CheckDataDirOption()

bool CheckDataDirOption ( const ArgsManager & args )

Definition at line 755 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDefaultDataDir()

fs::path GetDefaultDataDir ( )

Definition at line 723 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 715 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 699 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 703 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 684 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InterpretBool()

static bool InterpretBool ( const std::string & strValue )

static

Interpret a string argument as a boolean.

The definition of LocaleIndependentAtoi<int>() requires that non-numeric string values like "foo", return 0. This means that if a user unintentionally supplies a non-integer argument here, the return value is always false. This means that -foo=false does what the user probably expects, but -foo=true is well defined but does not do what they probably expected.

The return value of LocaleIndependentAtoi<int>(...) is zero when given input not representable as an int.

For a more extensive discussion of this topic (and a wide range of opinions on the Right Way to change this code), see PR12713.

Definition at line 59 of file args.cpp.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SaveErrors()

static void SaveErrors	(	const std::vector< std::string >	errors,
		std::vector< std::string > *	error_out
	)

static

Definition at line 391 of file args.cpp.

Here is the caller graph for this function:

◆ SettingName()

static std::string SettingName ( const std::string & arg )

static

Definition at line 66 of file args.cpp.

Here is the caller graph for this function:

◆ SettingToBool() [1/2]

std::optional< bool > SettingToBool ( const common::SettingsValue & 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:

◆ SettingToBool() [2/2]

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

Definition at line 525 of file args.cpp.

Here is the call graph for this function:

◆ SettingToInt() [1/2]

std::optional< int64_t > SettingToInt ( const common::SettingsValue & value )

Definition at line 493 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SettingToInt() [2/2]

int64_t SettingToInt	(	const common::SettingsValue &	value,
		int64_t	nDefault
	)

Definition at line 502 of file args.cpp.

Here is the call graph for this function:

◆ SettingToString() [1/2]

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

Definition at line 468 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SettingToString() [2/2]

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

Definition at line 477 of file args.cpp.

Here is the call graph for this function:

◆ SetupHelpOptions()

void SetupHelpOptions ( ArgsManager & args )

Add help options to the args manager.

Definition at line 689 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 = "bitcoin.conf"

Definition at line 39 of file args.cpp.

◆ BITCOIN_SETTINGS_FILENAME

const char* const BITCOIN_SETTINGS_FILENAME = "settings.json"

Definition at line 40 of file args.cpp.

◆ gArgs

ArgsManager gArgs

Definition at line 42 of file args.cpp.

◆ msgIndent

const int msgIndent = 7

static

Definition at line 697 of file args.cpp.

◆ optIndent

const int optIndent = 2

static

Definition at line 696 of file args.cpp.

◆ screenWidth

const int screenWidth = 79

static

Definition at line 695 of file args.cpp.

◆ TEST_OPTIONS_DOC

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

Initial value:

{
    "addrman (use deterministic addrman)",
    "bip94 (enforce BIP94 consensus rules)",
}

Definition at line 710 of file args.cpp.

Namespaces

Functions

Variables

Function Documentation

◆ CheckDataDirOption()

◆ GetDefaultDataDir()

◆ HasTestOption()

◆ HelpMessageGroup()

◆ HelpMessageOpt()

◆ HelpRequested()

◆ InterpretBool()

◆ InterpretKey()

◆ InterpretValue()

◆ SaveErrors()

◆ SettingName()

◆ SettingToBool() [1/2]

◆ SettingToBool() [2/2]

◆ SettingToInt() [1/2]

◆ SettingToInt() [2/2]

◆ SettingToString() [1/2]

◆ SettingToString() [2/2]

◆ SetupHelpOptions()

Variable Documentation

◆ BITCOIN_CONF_FILENAME

◆ BITCOIN_SETTINGS_FILENAME

◆ gArgs

◆ msgIndent

◆ optIndent

◆ screenWidth

◆ TEST_OPTIONS_DOC