Bitcoin Core  22.99.0
P2P Digital Currency
strencodings.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2020 The Bitcoin Core developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
9 #ifndef BITCOIN_UTIL_STRENCODINGS_H
10 #define BITCOIN_UTIL_STRENCODINGS_H
11 
12 #include <attributes.h>
13 #include <span.h>
14 #include <util/string.h>
15 
16 #include <charconv>
17 #include <cstdint>
18 #include <iterator>
19 #include <optional>
20 #include <string>
21 #include <vector>
22 
25 {
30 };
31 
39 std::string SanitizeString(const std::string& str, int rule = SAFE_CHARS_DEFAULT);
40 std::vector<unsigned char> ParseHex(const char* psz);
41 std::vector<unsigned char> ParseHex(const std::string& str);
42 signed char HexDigit(char c);
43 /* Returns true if each character in str is a hex character, and has an even
44  * number of hex digits.*/
45 bool IsHex(const std::string& str);
49 bool IsHexNumber(const std::string& str);
50 std::vector<unsigned char> DecodeBase64(const char* p, bool* pf_invalid = nullptr);
51 std::string DecodeBase64(const std::string& str, bool* pf_invalid = nullptr);
52 std::string EncodeBase64(Span<const unsigned char> input);
53 std::string EncodeBase64(const std::string& str);
54 std::vector<unsigned char> DecodeBase32(const char* p, bool* pf_invalid = nullptr);
55 std::string DecodeBase32(const std::string& str, bool* pf_invalid = nullptr);
56 
62 std::string EncodeBase32(Span<const unsigned char> input, bool pad = true);
63 
69 std::string EncodeBase32(const std::string& str, bool pad = true);
70 
71 void SplitHostPort(std::string in, uint16_t& portOut, std::string& hostOut);
72 
73 // LocaleIndependentAtoi is provided for backwards compatibility reasons.
74 //
75 // New code should use ToIntegral or the ParseInt* functions
76 // which provide parse error feedback.
77 //
78 // The goal of LocaleIndependentAtoi is to replicate the exact defined behaviour
79 // of atoi and atoi64 as they behave under the "C" locale.
80 template <typename T>
81 T LocaleIndependentAtoi(const std::string& str)
82 {
83  static_assert(std::is_integral<T>::value);
84  T result;
85  // Emulate atoi(...) handling of white space and leading +/-.
86  std::string s = TrimString(str);
87  if (!s.empty() && s[0] == '+') {
88  if (s.length() >= 2 && s[1] == '-') {
89  return 0;
90  }
91  s = s.substr(1);
92  }
93  auto [_, error_condition] = std::from_chars(s.data(), s.data() + s.size(), result);
94  if (error_condition != std::errc{}) {
95  return 0;
96  }
97  return result;
98 }
99 
105 constexpr bool IsDigit(char c)
106 {
107  return c >= '0' && c <= '9';
108 }
109 
121 constexpr inline bool IsSpace(char c) noexcept {
122  return c == ' ' || c == '\f' || c == '\n' || c == '\r' || c == '\t' || c == '\v';
123 }
124 
133 template <typename T>
134 std::optional<T> ToIntegral(const std::string& str)
135 {
136  static_assert(std::is_integral<T>::value);
137  T result;
138  const auto [first_nonmatching, error_condition] = std::from_chars(str.data(), str.data() + str.size(), result);
139  if (first_nonmatching != str.data() + str.size() || error_condition != std::errc{}) {
140  return std::nullopt;
141  }
142  return result;
143 }
144 
150 [[nodiscard]] bool ParseInt32(const std::string& str, int32_t *out);
151 
157 [[nodiscard]] bool ParseInt64(const std::string& str, int64_t *out);
158 
164 [[nodiscard]] bool ParseUInt8(const std::string& str, uint8_t *out);
165 
171 [[nodiscard]] bool ParseUInt16(const std::string& str, uint16_t* out);
172 
178 [[nodiscard]] bool ParseUInt32(const std::string& str, uint32_t *out);
179 
185 [[nodiscard]] bool ParseUInt64(const std::string& str, uint64_t *out);
186 
190 std::string HexStr(const Span<const uint8_t> s);
191 inline std::string HexStr(const Span<const char> s) { return HexStr(MakeUCharSpan(s)); }
192 
197 std::string FormatParagraph(const std::string& in, size_t width = 79, size_t indent = 0);
198 
204 template <typename T>
205 bool TimingResistantEqual(const T& a, const T& b)
206 {
207  if (b.size() == 0) return a.size() == 0;
208  size_t accumulator = a.size() ^ b.size();
209  for (size_t i = 0; i < a.size(); i++)
210  accumulator |= a[i] ^ b[i%b.size()];
211  return accumulator == 0;
212 }
213 
219 [[nodiscard]] bool ParseFixedPoint(const std::string &val, int decimals, int64_t *amount_out);
220 
222 template<int frombits, int tobits, bool pad, typename O, typename I>
223 bool ConvertBits(const O& outfn, I it, I end) {
224  size_t acc = 0;
225  size_t bits = 0;
226  constexpr size_t maxv = (1 << tobits) - 1;
227  constexpr size_t max_acc = (1 << (frombits + tobits - 1)) - 1;
228  while (it != end) {
229  acc = ((acc << frombits) | *it) & max_acc;
230  bits += frombits;
231  while (bits >= tobits) {
232  bits -= tobits;
233  outfn((acc >> bits) & maxv);
234  }
235  ++it;
236  }
237  if (pad) {
238  if (bits) outfn((acc << (tobits - bits)) & maxv);
239  } else if (bits >= frombits || ((acc << (tobits - bits)) & maxv)) {
240  return false;
241  }
242  return true;
243 }
244 
255 constexpr char ToLower(char c)
256 {
257  return (c >= 'A' && c <= 'Z' ? (c - 'A') + 'a' : c);
258 }
259 
269 std::string ToLower(const std::string& str);
270 
281 constexpr char ToUpper(char c)
282 {
283  return (c >= 'a' && c <= 'z' ? (c - 'a') + 'A' : c);
284 }
285 
295 std::string ToUpper(const std::string& str);
296 
306 std::string Capitalize(std::string str);
307 
308 #endif // BITCOIN_UTIL_STRENCODINGS_H
SanitizeString
std::string SanitizeString(const std::string &str, int rule=SAFE_CHARS_DEFAULT)
Remove unsafe chars.
Definition: strencodings.cpp:26
_
bilingual_str _(const char *psz)
Translation function.
Definition: translation.h:63
ConvertBits
bool ConvertBits(const O &outfn, I it, I end)
Convert from one power-of-2 number base to another.
Definition: strencodings.h:223
Capitalize
std::string Capitalize(std::string str)
Capitalizes the first character of the given string.
Definition: strencodings.cpp:509
SplitHostPort
void SplitHostPort(std::string in, uint16_t &portOut, std::string &hostOut)
Definition: strencodings.cpp:109
MakeUCharSpan
constexpr auto MakeUCharSpan(V &&v) -> decltype(UCharSpanCast(MakeSpan(std::forward< V >(v))))
Like MakeSpan, but for (const) unsigned char member types only.
Definition: span.h:249
string.h
IsHexNumber
bool IsHexNumber(const std::string &str)
Return true if the string is a hex number, optionally prefixed with "0x".
Definition: strencodings.cpp:70
SAFE_CHARS_UA_COMMENT
@ SAFE_CHARS_UA_COMMENT
BIP-0014 subset.
Definition: strencodings.h:27
ParseFixedPoint
bool ParseFixedPoint(const std::string &val, int decimals, int64_t *amount_out)
Parse number as fixed point according to JSON number syntax.
Definition: strencodings.cpp:403
TrimString
std::string TrimString(const std::string &str, const std::string &pattern=" \f\n\r\t\v")
Definition: string.h:18
ParseUInt16
bool ParseUInt16(const std::string &str, uint16_t *out)
Convert decimal string to unsigned 16-bit integer with strict parse error feedback.
Definition: strencodings.cpp:320
ToLower
constexpr char ToLower(char c)
Converts the given character to its lowercase equivalent.
Definition: strencodings.h:255
IsSpace
constexpr bool IsSpace(char c) noexcept
Tests if the given character is a whitespace character.
Definition: strencodings.h:121
SAFE_CHARS_FILENAME
@ SAFE_CHARS_FILENAME
Chars allowed in filenames.
Definition: strencodings.h:28
SAFE_CHARS_DEFAULT
@ SAFE_CHARS_DEFAULT
The full set of allowed chars.
Definition: strencodings.h:26
Span
A Span is an object that can refer to a contiguous sequence of objects.
Definition: span.h:92
FormatParagraph
std::string FormatParagraph(const std::string &in, size_t width=79, size_t indent=0)
Format a paragraph of text to a fixed width, adding spaces for indentation to any added line.
Definition: strencodings.cpp:335
ToIntegral
std::optional< T > ToIntegral(const std::string &str)
Convert string to integral type T.
Definition: strencodings.h:134
ParseUInt8
bool ParseUInt8(const std::string &str, uint8_t *out)
Convert decimal string to unsigned 8-bit integer with strict parse error feedback.
Definition: strencodings.cpp:315
ParseUInt64
bool ParseUInt64(const std::string &str, uint64_t *out)
Convert decimal string to unsigned 64-bit integer with strict parse error feedback.
Definition: strencodings.cpp:330
DecodeBase32
std::vector< unsigned char > DecodeBase32(const char *p, bool *pf_invalid=nullptr)
Definition: strencodings.cpp:225
span.h
ToUpper
constexpr char ToUpper(char c)
Converts the given character to its uppercase equivalent.
Definition: strencodings.h:281
ParseUInt32
bool ParseUInt32(const std::string &str, uint32_t *out)
Convert decimal string to unsigned 32-bit integer with strict parse error feedback.
Definition: strencodings.cpp:325
SAFE_CHARS_URI
@ SAFE_CHARS_URI
Chars allowed in URIs (RFC 3986)
Definition: strencodings.h:29
TimingResistantEqual
bool TimingResistantEqual(const T &a, const T &b)
Timing-attack-resistant comparison.
Definition: strencodings.h:205
EncodeBase64
std::string EncodeBase64(Span< const unsigned char > input)
Definition: strencodings.cpp:130
attributes.h
IsDigit
constexpr bool IsDigit(char c)
Tests if the given character is a decimal digit.
Definition: strencodings.h:105
ParseHex
std::vector< unsigned char > ParseHex(const char *psz)
Definition: strencodings.cpp:83
ParseInt64
bool ParseInt64(const std::string &str, int64_t *out)
Convert string to signed 64-bit integer with strict parse error feedback.
Definition: strencodings.cpp:310
IsHex
bool IsHex(const std::string &str)
Definition: strencodings.cpp:60
HexDigit
signed char HexDigit(char c)
Definition: strencodings.cpp:55
ParseInt32
bool ParseInt32(const std::string &str, int32_t *out)
Convert string to signed 32-bit integer with strict parse error feedback.
Definition: strencodings.cpp:305
LocaleIndependentAtoi
T LocaleIndependentAtoi(const std::string &str)
Definition: strencodings.h:81
DecodeBase64
std::vector< unsigned char > DecodeBase64(const char *p, bool *pf_invalid=nullptr)
Definition: strencodings.cpp:146
T
#define T(expected, seed, data)
EncodeBase32
std::string EncodeBase32(Span< const unsigned char > input, bool pad=true)
Base32 encode.
Definition: strencodings.cpp:205
SafeChars
SafeChars
Utilities for converting data from/to strings.
Definition: strencodings.h:24
HexStr
std::string HexStr(const Span< const uint8_t > s)
Convert a span of bytes to a lower-case hexadecimal string.
Definition: strencodings.cpp:516