foster/bitcoin-core
0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-03-05 14:06:27 -05:00
Code Issues Activity

refactor: Add explicit DISALLOW_NEGATION ArgsManager flag to clarify flag usage

Browse source 
Currently, ALLOW_{INT|BOOL|STRING} flags don't do any real validation,
so current uses of these flags are misleading and will also break
backwards compatibility whenever these flags are implemented in a future
PR (draft PR is #16545).

An additional complication is that while these flags don't do any real
settings validation, they do affect whether setting negation syntax is
allowed.

Fix this mess by disabling ALLOW_{INT|BOOL|STRING} flags until they are
implemented, and adding an unambiguous DISALLOW_NEGATION flag. This is
done in two commits, with this commit adding the DISALLOW_NEGATION flag,
and the next commit disabling the ALLOW_{INT|BOOL|STRING} flags.
This commit is contained in:
Russell Yanofsky 2021-08-21 14:06:49 -04:00
parent 26a50ab322
commit b8c069b7a9
2 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/util/system.cpp
View file

@ -230,7 +230,7 @@ static std::optional<util::SettingsValue> InterpretValue(const KeyInfo& key, con
{ {
// Return negated settings as false values. // Return negated settings as false values.
if (key.negated) { if (key.negated) {
if (!(flags & ArgsManager::ALLOW_BOOL)) { if (flags & ArgsManager::DISALLOW_NEGATION) {
error = strprintf("Negating of -%s is meaningless and therefore forbidden", key.name); error = strprintf("Negating of -%s is meaningless and therefore forbidden", key.name);
return std::nullopt; return std::nullopt;
} }
@ -652,6 +652,7 @@ void ArgsManager::AddArg(const std::string& name, const std::string& help, unsig
LOCK(cs_args); LOCK(cs_args);
std::map<std::string, Arg>& arg_map = m_available_args[cat]; std::map<std::string, Arg>& arg_map = m_available_args[cat];
if ((flags & (ALLOW_ANY | ALLOW_BOOL)) == 0) flags |= DISALLOW_NEGATION; // Temporary, removed in next scripted-diff
auto ret = arg_map.emplace(arg_name, Arg{name.substr(eq_index, name.size() - eq_index), help, flags}); auto ret = arg_map.emplace(arg_name, Arg{name.substr(eq_index, name.size() - eq_index), help, flags});
assert(ret.second); // Make sure an insertion actually happened assert(ret.second); // Make sure an insertion actually happened

16
src/util/system.h
View file

@ -158,12 +158,18 @@ struct SectionInfo
class ArgsManager class ArgsManager
{ {
public: public:
/**
* Flags controlling how config and command line arguments are validated and
* interpreted.
*/
enum Flags : uint32_t { enum Flags : uint32_t {
// Boolean options can accept negation syntax -noOPTION or -noOPTION=1 ALLOW_ANY = 0x01, //!< disable validation
ALLOW_BOOL = 0x01, ALLOW_BOOL = 0x02, //!< unimplemented, draft implementation in #16545
ALLOW_INT = 0x02, ALLOW_INT = 0x04, //!< unimplemented, draft implementation in #16545
ALLOW_STRING = 0x04, ALLOW_STRING = 0x08, //!< unimplemented, draft implementation in #16545
ALLOW_ANY = ALLOW_BOOL | ALLOW_INT | ALLOW_STRING, ALLOW_LIST = 0x10, //!< unimplemented, draft implementation in #16545
DISALLOW_NEGATION = 0x20, //!< disallow -nofoo syntax
DEBUG_ONLY = 0x100, DEBUG_ONLY = 0x100,
/* Some options would cause cross-contamination if values for /* Some options would cause cross-contamination if values for
* mainnet were used while running on regtest/testnet (or vice-versa). * mainnet were used while running on regtest/testnet (or vice-versa).