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

Include dependency graph for args.cpp:

Namespaces
namespace	common

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

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

util::SettingsValue	InterpretOption (std::string &section, std::string &key, const std::string &value)
	Interpret -nofoo as if the user supplied -foo=0.

bool	CheckValid (const std::string &key, const util::SettingsValue &val, unsigned int flags, std::string &error)
	Check settings value validity according to flags.

bool	ParseKeyValue (std::string &key, std::string &val)

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

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

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

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

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

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

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

bool	HelpRequested (const ArgsManager &args)

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

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

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

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

Function Documentation

◆ CheckDataDirOption()

bool CheckDataDirOption ( const ArgsManager & args )

Definition at line 784 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckValid()

bool CheckValid	(	const std::string &	key,
		const util::SettingsValue &	val,
		unsigned int	flags,
		std::string &	error
	)

Check settings value validity according to flags.

TODO: Add more meaningful error checks here in the future See "here's how the flags are meant to behave" in https://github.com/bitcoin/bitcoin/pull/16097#issuecomment-514627823

Definition at line 117 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 759 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 747 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 751 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 732 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 atoi() 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 atoi() is undefined when given input not representable as an int. On most systems this means string value between "-2147483648" and "2147483647" are well defined (this method will return true). Setting -txindex=2147483648 on most systems, however, is probably undefined.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InterpretOption()

util::SettingsValue InterpretOption	(	std::string &	section,
		std::string &	key,
		const std::string &	value
	)

Interpret -nofoo as if the user supplied -foo=0.

This method also tracks when the -no form was supplied, and if so, checks whether there was a double-negative (-nofoo=0 -> -foo=1).

If there was not a double negative, it removes the "no" from the key and returns false.

If there was a double negative, it removes "no" from the key, and returns true.

If there was no "no", it returns the string value untouched.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseKeyValue()

bool ParseKeyValue	(	std::string &	key,
		std::string &	val
	)

Definition at line 177 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 421 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SettingName()

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

static

Definition at line 64 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SettingToBool() [1/2]

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

Definition at line 565 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 util::SettingsValue &	value,
		bool	fDefault
	)

Definition at line 575 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SettingToInt() [1/2]

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

Definition at line 536 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 util::SettingsValue &	value,
		int64_t	nDefault
	)

Definition at line 552 of file args.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SettingToString() [1/2]

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

Definition at line 505 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 util::SettingsValue &	value,
		const std::string &	strDefault
	)

Definition at line 521 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 737 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 35 of file args.cpp.

◆ BITCOIN_SETTINGS_FILENAME

const char* const BITCOIN_SETTINGS_FILENAME = "settings.json"

Definition at line 36 of file args.cpp.

◆ gArgs

ArgsManager gArgs

Definition at line 38 of file args.cpp.

◆ msgIndent

const int msgIndent = 7

static

Definition at line 745 of file args.cpp.

◆ optIndent

const int optIndent = 2

static

Definition at line 744 of file args.cpp.

◆ screenWidth

const int screenWidth = 79

static

Definition at line 743 of file args.cpp.

Namespaces

Functions

Variables

Function Documentation

◆ CheckDataDirOption()

◆ CheckValid()

◆ GetDefaultDataDir()

◆ HelpMessageGroup()

◆ HelpMessageOpt()

◆ HelpRequested()

◆ InterpretBool()

◆ InterpretOption()

◆ ParseKeyValue()

◆ 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