Bitcoin ABC 0.26.3
P2P Digital Currency
|
#include <compat.h>
#include <sync.h>
#include <util/fs.h>
#include <util/settings.h>
#include <cstdint>
#include <iosfwd>
#include <list>
#include <map>
#include <optional>
#include <set>
#include <string>
#include <vector>
Go to the source code of this file.
Classes | |
struct | SectionInfo |
class | ArgsManager |
struct | ArgsManager::Arg |
Namespaces | |
namespace | common |
Enumerations | |
enum class | OptionsCategory { OPTIONS , CONNECTION , WALLET , WALLET_DEBUG_TEST , ZMQ , DEBUG_TEST , CHAINPARAMS , NODE_RELAY , BLOCK_CREATION , RPC , GUI , COMMANDS , REGISTER_COMMANDS , AVALANCHE , CHRONIK , HIDDEN } |
Functions | |
bool | CheckDataDirOption (const ArgsManager &args) |
fs::path | GetConfigFile (const ArgsManager &args, const fs::path &configuration_file_path) |
bool | ParseKeyValue (std::string &key, std::string &val) |
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. | |
bool | IsSwitchChar (char c) |
bool | CheckValid (const std::string &key, const util::SettingsValue &val, unsigned int flags, std::string &error) |
Check settings value validity according to flags. | |
util::SettingsValue | InterpretOption (std::string §ion, std::string &key, const std::string &value) |
Interpret -nofoo as if the user supplied -foo=0. | |
std::string | SettingToString (const util::SettingsValue &, const std::string &) |
std::optional< std::string > | SettingToString (const util::SettingsValue &) |
int64_t | SettingToInt (const util::SettingsValue &, int64_t) |
std::optional< int64_t > | SettingToInt (const util::SettingsValue &) |
bool | SettingToBool (const util::SettingsValue &, bool) |
std::optional< bool > | SettingToBool (const util::SettingsValue &) |
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. | |
Variables | |
const char *const | BITCOIN_CONF_FILENAME |
const char *const | BITCOIN_SETTINGS_FILENAME |
ArgsManager | gArgs |
|
strong |
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.
args | Parsed arguments and settings. |
path | The path to be conditionally prefixed with datadir. |
net_specific | Use network specific datadir variant |
Definition at line 234 of file configfile.cpp.
bool CheckDataDirOption | ( | const ArgsManager & | args | ) |
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.
fs::path GetConfigFile | ( | const ArgsManager & | args, |
const fs::path & | configuration_file_path | ||
) |
Definition at line 29 of file configfile.cpp.
std::string HelpMessageGroup | ( | const std::string & | message | ) |
std::string HelpMessageOpt | ( | const std::string & | option, |
const std::string & | message | ||
) |
Format a string to be used as option description in help messages.
option | Option message (e.g. "-rpcuser=<user>") |
message | Option description (e.g. "Username for JSON-RPC connections") |
Definition at line 751 of file args.cpp.
bool HelpRequested | ( | const ArgsManager & | args | ) |
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.
bool ParseKeyValue | ( | std::string & | key, |
std::string & | val | ||
) |
std::optional< bool > SettingToBool | ( | const util::SettingsValue & | value | ) |
bool SettingToBool | ( | const util::SettingsValue & | value, |
bool | fDefault | ||
) |
std::optional< int64_t > SettingToInt | ( | const util::SettingsValue & | value | ) |
int64_t SettingToInt | ( | const util::SettingsValue & | value, |
int64_t | nDefault | ||
) |
std::optional< std::string > SettingToString | ( | const util::SettingsValue & | value | ) |
std::string SettingToString | ( | const util::SettingsValue & | value, |
const std::string & | strDefault | ||
) |
void SetupHelpOptions | ( | ArgsManager & | args | ) |
|
extern |