diff --git a/src/rpc/abc.cpp b/src/rpc/abc.cpp --- a/src/rpc/abc.cpp +++ b/src/rpc/abc.cpp @@ -17,7 +17,7 @@ throw std::runtime_error( RPCHelpMan{ "getexcessiveblock", "\nReturn the excessive block size.", {}} - .ToString() + + .ToStringWithArgs() + "\nResult\n" " excessiveBlockSize (integer) block size in bytes\n" "\nExamples:\n" + @@ -40,14 +40,12 @@ "used in the active chain or relayed. This discourages the " "propagation of blocks that you consider excessively large.", { - {"blockSize", RPCArg::Type::NUM, false}, + {"blockSize", RPCArg::Type::NUM, /* opt */ false, + /* default_value */ "", + "Excessive block size in bytes. Must be greater than " + + std::to_string(LEGACY_MAX_BLOCK_SIZE) + "."}, }} - .ToString() + - "\nArguments\n" - "1. blockSize (integer, required) Excessive block size in bytes. " - "Must be greater than " + - std::to_string(LEGACY_MAX_BLOCK_SIZE) + - ".\n" + .ToStringWithArgs() + "\nResult\n" " blockSize (integer) excessive block size in bytes\n" "\nExamples:\n" + diff --git a/src/rpc/util.h b/src/rpc/util.h --- a/src/rpc/util.h +++ b/src/rpc/util.h @@ -53,10 +53,41 @@ //! Only used for arrays or dicts const std::vector m_inner; const bool m_optional; + const std::string m_default_value; //!< Only used for optional args + const std::string m_description; //! Should be empty unless it is supposed to override the auto-generated //! summary line const std::string m_oneline_description; + //! Should be empty unless it is supposed to override the + //! auto-generated type strings. Vector length is either 0 + //! or 2, m_type_str.at(0) will override the type of the + //! value in a key-value pair, m_type_str.at(1) will + //! override the type in the argument description. + const std::vector m_type_str; + + RPCArg(const std::string &name, const Type &type, const bool opt, + const std::string &default_val, const std::string &description, + const std::string &oneline_description = "", + const std::vector &type_str = {}) + : m_name{name}, m_type{type}, m_optional{opt}, + m_default_value{default_val}, m_description{description}, + m_oneline_description{oneline_description}, m_type_str{type_str} { + assert(type != Type::ARR && type != Type::OBJ); + } + + RPCArg(const std::string &name, const Type &type, const bool opt, + const std::string &default_val, const std::string &description, + const std::vector &inner, + const std::string &oneline_description = "", + const std::vector &type_str = {}) + : m_name{name}, m_type{type}, m_inner{inner}, m_optional{opt}, + m_default_value{default_val}, m_description{description}, + m_oneline_description{oneline_description}, m_type_str{type_str} { + assert(type == Type::ARR || type == Type::OBJ); + } + + // Remove once PR14796 backport is completed RPCArg(const std::string &name, const Type &type, const bool optional, const std::string &oneline_description = "") : m_name{name}, m_type{type}, m_optional{optional}, @@ -64,6 +95,7 @@ assert(type != Type::ARR && type != Type::OBJ); } + // Remove once PR14796 backport is completed RPCArg(const std::string &name, const Type &type, const std::vector &inner, const bool optional, const std::string &oneline_description = "") @@ -72,9 +104,30 @@ assert(type == Type::ARR || type == Type::OBJ); } + // Remove once PR14796 backport is completed std::string ToString() const; + /** + * Return the type string of the argument. + * Set oneline to allow it to be overrided by a custom oneline type string + * (m_oneline_description). + */ + std::string ToString(bool oneline) const; + /** + * Return the type string of the argument when it is in an object (dict). + * Set oneline to get the oneline representation (less whitespace) + */ + std::string ToStringObj(bool oneline) const; + /** + * Return the description string, including the argument type and whether + * the argument is required. + * implicitly_required is set for arguments in an array, which are neither + * optional nor required. + */ + std::string ToDescriptionString(bool implicitly_required = false) const; + private: + // Remove once PR14796 backport is completed std::string ToStringObj() const; }; @@ -86,6 +139,9 @@ std::string ToString() const; + // Remove once PR14796 backport is completed + std::string ToStringWithArgs() const; + private: const std::string m_name; const std::string m_description; diff --git a/src/rpc/util.cpp b/src/rpc/util.cpp --- a/src/rpc/util.cpp +++ b/src/rpc/util.cpp @@ -115,6 +115,146 @@ return boost::apply_visitor(DescribeAddressVisitor(), dest); } +struct Section { + Section(const std::string &left, const std::string &right) + : m_left{left}, m_right{right} {} + const std::string m_left; + const std::string m_right; +}; + +struct Sections { + std::vector
m_sections; + size_t m_max_pad{0}; + + void PushSection(const Section &s) { + m_max_pad = std::max(m_max_pad, s.m_left.size()); + m_sections.push_back(s); + } + + enum class OuterType { + ARR, + OBJ, + // Only set on first recursion + NAMED_ARG, + }; + + void Push(const RPCArg &arg, const size_t current_indent = 5, + const OuterType outer_type = OuterType::NAMED_ARG) { + const auto indent = std::string(current_indent, ' '); + const auto indent_next = std::string(current_indent + 2, ' '); + switch (arg.m_type) { + case RPCArg::Type::STR_HEX: + case RPCArg::Type::STR: + case RPCArg::Type::NUM: + case RPCArg::Type::AMOUNT: + case RPCArg::Type::BOOL: { + // Nothing more to do for non-recursive types on first recursion + if (outer_type == OuterType::NAMED_ARG) { + return; + } + auto left = indent; + if (arg.m_type_str.size() != 0 && + outer_type == OuterType::OBJ) { + left += "\"" + arg.m_name + "\": " + arg.m_type_str.at(0); + } else { + left += outer_type == OuterType::OBJ + ? arg.ToStringObj(/* oneline */ false) + : arg.ToString(/* oneline */ false); + } + left += ","; + PushSection({left, arg.ToDescriptionString( + /* implicitly_required */ outer_type == + OuterType::ARR)}); + break; + } + case RPCArg::Type::OBJ: + case RPCArg::Type::OBJ_USER_KEYS: { + const auto right = + outer_type == OuterType::NAMED_ARG + ? "" + : arg.ToDescriptionString( + /* implicitly_required */ outer_type == + OuterType::ARR); + PushSection({indent + "{", right}); + for (const auto &arg_inner : arg.m_inner) { + Push(arg_inner, current_indent + 2, OuterType::OBJ); + } + if (arg.m_type != RPCArg::Type::OBJ) { + PushSection({indent_next + "...", ""}); + } + PushSection( + {indent + "}" + + (outer_type != OuterType::NAMED_ARG ? "," : ""), + ""}); + break; + } + case RPCArg::Type::ARR: { + auto left = indent; + left += outer_type == OuterType::OBJ + ? "\"" + arg.m_name + "\": " + : ""; + left += "["; + const auto right = + outer_type == OuterType::NAMED_ARG + ? "" + : arg.ToDescriptionString( + /* implicitly_required */ outer_type == + OuterType::ARR); + PushSection({left, right}); + for (const auto &arg_inner : arg.m_inner) { + Push(arg_inner, current_indent + 2, OuterType::ARR); + } + PushSection({indent_next + "...", ""}); + PushSection( + {indent + "]" + + (outer_type != OuterType::NAMED_ARG ? "," : ""), + ""}); + break; + } + + // no default case, so the compiler can warn about missing cases + } + } + + std::string ToString() const { + std::string ret; + const size_t pad = m_max_pad + 4; + for (const auto &s : m_sections) { + if (s.m_right.empty()) { + ret += s.m_left; + ret += "\n"; + continue; + } + + std::string left = s.m_left; + left.resize(pad, ' '); + ret += left; + + // Properly pad after newlines + std::string right; + size_t begin = 0; + size_t new_line_pos = s.m_right.find_first_of('\n'); + while (true) { + right += s.m_right.substr(begin, new_line_pos - begin); + if (new_line_pos == std::string::npos) { + // No new line + break; + } + right += "\n" + std::string(pad, ' '); + begin = s.m_right.find_first_not_of(' ', new_line_pos + 1); + if (begin == std::string::npos) { + break; // Empty line + } + new_line_pos = s.m_right.find_first_of('\n', begin + 1); + } + ret += right; + ret += "\n"; + } + return ret; + } +}; + +// Remove once PR14796 backport is completed std::string RPCHelpMan::ToString() const { std::string ret; @@ -146,6 +286,126 @@ return ret; } +// Rename to ToString() once PR14796 is completed +std::string RPCHelpMan::ToStringWithArgs() const { + std::string ret; + + // Oneline summary + ret += m_name; + bool is_optional{false}; + for (const auto &arg : m_args) { + ret += " "; + if (arg.m_optional) { + if (!is_optional) { + ret += "( "; + } + is_optional = true; + } else { + // Currently we still support unnamed arguments, so any argument + // following an optional argument must also be optional If support + // for positional arguments is deprecated in the future, remove this + // line + assert(!is_optional); + } + ret += arg.ToString(/* oneline */ true); + } + if (is_optional) { + ret += " )"; + } + ret += "\n"; + + // Description + ret += m_description; + + // Arguments + Sections sections; + for (size_t i{0}; i < m_args.size(); ++i) { + const auto &arg = m_args.at(i); + + if (i == 0) { + ret += "\nArguments:\n"; + } + + // Push named argument name and description + const auto str_wrapper = (arg.m_type == RPCArg::Type::STR || + arg.m_type == RPCArg::Type::STR_HEX) + ? "\"" + : ""; + sections.m_sections.emplace_back(std::to_string(i + 1) + ". " + + str_wrapper + arg.m_name + + str_wrapper, + arg.ToDescriptionString()); + sections.m_max_pad = std::max(sections.m_max_pad, + sections.m_sections.back().m_left.size()); + + // Recursively push nested args + sections.Push(arg); + } + ret += sections.ToString(); + + return ret; +} + +std::string RPCArg::ToDescriptionString(const bool implicitly_required) const { + std::string ret; + ret += "("; + if (m_type_str.size() != 0) { + ret += m_type_str.at(1); + } else { + switch (m_type) { + case Type::STR_HEX: + case Type::STR: { + ret += "string"; + break; + } + case Type::NUM: { + ret += "numeric"; + break; + } + case Type::AMOUNT: { + ret += "numeric or string"; + break; + } + case Type::BOOL: { + ret += "boolean"; + break; + } + case Type::OBJ: + case Type::OBJ_USER_KEYS: { + ret += "json object"; + break; + } + case Type::ARR: { + ret += "json array"; + break; + } + + // no default case, so the compiler can warn about missing cases + } + } + if (!implicitly_required) { + ret += ", "; + if (m_optional) { + ret += "optional"; + if (!m_default_value.empty()) { + ret += ", default=" + m_default_value; + } else { + // TODO enable this assert, when all optional parameters have + // their default value documented + // assert(false); + } + } else { + ret += "required"; + // Default value is ignored, and must not be present + assert(m_default_value.empty()); + } + } + ret += ")"; + ret += m_description.empty() ? "" : " " + m_description; + return ret; +} + +// Remove once PR14796 backport is completed std::string RPCArg::ToStringObj() const { std::string res = "\"" + m_name + "\":"; switch (m_type) { @@ -175,6 +435,43 @@ assert(false); } +std::string RPCArg::ToStringObj(const bool oneline) const { + std::string res; + res += "\""; + res += m_name; + if (oneline) { + res += "\":"; + } else { + res += "\": "; + } + switch (m_type) { + case Type::STR: + return res + "\"str\""; + case Type::STR_HEX: + return res + "\"hex\""; + case Type::NUM: + return res + "n"; + case Type::AMOUNT: + return res + "amount"; + case Type::BOOL: + return res + "bool"; + case Type::ARR: + res += "["; + for (const auto &i : m_inner) { + res += i.ToString(oneline) + ","; + } + return res + "...]"; + case Type::OBJ: + case Type::OBJ_USER_KEYS: + // Currently unused, so avoid writing dead code + assert(false); + + // no default case, so the compiler can warn about missing cases + } + assert(false); +} + +// Remove once PR14796 backport is completed std::string RPCArg::ToString() const { if (!m_oneline_description.empty()) { return m_oneline_description; @@ -217,3 +514,46 @@ } assert(false); } + +std::string RPCArg::ToString(const bool oneline) const { + if (oneline && !m_oneline_description.empty()) { + return m_oneline_description; + } + + switch (m_type) { + case Type::STR_HEX: + case Type::STR: { + return "\"" + m_name + "\""; + } + case Type::NUM: + case Type::AMOUNT: + case Type::BOOL: { + return m_name; + } + case Type::OBJ: + case Type::OBJ_USER_KEYS: { + std::string res; + for (size_t i = 0; i < m_inner.size();) { + res += m_inner[i].ToStringObj(oneline); + if (++i < m_inner.size()) { + res += ","; + } + } + if (m_type == Type::OBJ) { + return "{" + res + "}"; + } else { + return "{" + res + ",...}"; + } + } + case Type::ARR: { + std::string res; + for (const auto &i : m_inner) { + res += i.ToString(oneline) + ","; + } + return "[" + res + "...]"; + } + + // no default case, so the compiler can warn about missing cases + } + assert(false); +}