Bitcoin ABC  0.26.3
P2P Digital Currency
strencodings.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2016 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 <span.h>
13 
14 #include <cstdint>
15 #include <iterator>
16 #include <string>
17 #include <vector>
18 
20 enum SafeChars {
29 };
30 
39 std::string SanitizeString(const std::string &str,
40  int rule = SAFE_CHARS_DEFAULT);
41 std::vector<uint8_t> ParseHex(const char *psz);
42 std::vector<uint8_t> ParseHex(const std::string &str);
43 signed char HexDigit(char c);
48 bool IsHex(const std::string &str);
52 bool IsHexNumber(const std::string &str);
53 std::vector<uint8_t> DecodeBase64(const char *p, bool *pf_invalid = nullptr);
54 std::string DecodeBase64(const std::string &str, bool *pf_invalid = nullptr);
55 std::string EncodeBase64(Span<const uint8_t> input);
56 std::string EncodeBase64(const std::string &str);
57 std::vector<uint8_t> DecodeBase32(const char *p, bool *pf_invalid = nullptr);
58 std::string DecodeBase32(const std::string &str, bool *pf_invalid = nullptr);
59 
65 std::string EncodeBase32(Span<const uint8_t> input, bool pad = true);
66 
72 std::string EncodeBase32(const std::string &str, bool pad = true);
73 
74 void SplitHostPort(std::string in, uint16_t &portOut, std::string &hostOut);
75 int64_t atoi64(const std::string &str);
76 int atoi(const std::string &str);
77 
83 constexpr bool IsDigit(char c) {
84  return c >= '0' && c <= '9';
85 }
86 
99 constexpr inline bool IsSpace(char c) noexcept {
100  return c == ' ' || c == '\f' || c == '\n' || c == '\r' || c == '\t' ||
101  c == '\v';
102 }
103 
109 [[nodiscard]] bool ParseInt32(const std::string &str, int32_t *out);
110 
116 [[nodiscard]] bool ParseInt64(const std::string &str, int64_t *out);
117 
125 [[nodiscard]] bool ParseUInt8(const std::string &str, uint8_t *out);
126 
134 [[nodiscard]] bool ParseUInt16(const std::string &str, uint16_t *out);
135 
142 [[nodiscard]] bool ParseUInt32(const std::string &str, uint32_t *out);
143 
150 [[nodiscard]] bool ParseUInt64(const std::string &str, uint64_t *out);
151 
157 [[nodiscard]] bool ParseDouble(const std::string &str, double *out);
158 
162 std::string HexStr(const Span<const uint8_t> s);
163 inline std::string HexStr(const Span<const char> s) {
164  return HexStr(MakeUCharSpan(s));
165 }
166 
171 std::string FormatParagraph(const std::string &in, size_t width = 79,
172  size_t indent = 0);
173 
178 template <typename T> bool TimingResistantEqual(const T &a, const T &b) {
179  if (b.size() == 0) {
180  return a.size() == 0;
181  }
182  size_t accumulator = a.size() ^ b.size();
183  for (size_t i = 0; i < a.size(); i++) {
184  accumulator |= size_t(a[i] ^ b[i % b.size()]);
185  }
186  return accumulator == 0;
187 }
188 
196 [[nodiscard]] bool ParseFixedPoint(const std::string &val, int decimals,
197  int64_t *amount_out);
198 
205 template <int frombits, int tobits, bool pad, typename O, typename I>
206 bool ConvertBits(const O &outfn, I it, I end) {
207  size_t acc = 0;
208  size_t bits = 0;
209  constexpr size_t maxv = (1 << tobits) - 1;
210  constexpr size_t max_acc = (1 << (frombits + tobits - 1)) - 1;
211  while (it != end) {
212  acc = ((acc << frombits) | *it) & max_acc;
213  bits += frombits;
214  while (bits >= tobits) {
215  bits -= tobits;
216  outfn((acc >> bits) & maxv);
217  }
218  ++it;
219  }
220 
221  if (pad) {
222  if (bits) {
223  outfn((acc << (tobits - bits)) & maxv);
224  }
225  } else if (bits >= frombits || ((acc << (tobits - bits)) & maxv)) {
226  return false;
227  }
228 
229  return true;
230 }
231 
242 constexpr char ToLower(char c) {
243  return (c >= 'A' && c <= 'Z' ? (c - 'A') + 'a' : c);
244 }
245 
255 std::string ToLower(const std::string &str);
256 
267 constexpr char ToUpper(char c) {
268  return (c >= 'a' && c <= 'z' ? (c - 'a') + 'A' : c);
269 }
270 
280 std::string ToUpper(const std::string &str);
281 
291 std::string Capitalize(std::string str);
292 
293 #endif // BITCOIN_UTIL_STRENCODINGS_H
A Span is an object that can refer to a contiguous sequence of objects.
Definition: span.h:93
constexpr auto MakeUCharSpan(V &&v) -> decltype(UCharSpanCast(Span{std::forward< V >(v)}))
Like the Span constructor, but for (const) uint8_t member types only.
Definition: span.h:307
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.
std::string Capitalize(std::string str)
Capitalizes the first character of the given string.
std::string HexStr(const Span< const uint8_t > s)
Convert a span of bytes to a lower-case hexadecimal string.
std::string EncodeBase64(Span< const uint8_t > input)
std::string EncodeBase32(Span< const uint8_t > input, bool pad=true)
Base32 encode.
constexpr char ToLower(char c)
Converts the given character to its lowercase equivalent.
Definition: strencodings.h:242
bool ParseUInt16(const std::string &str, uint16_t *out)
Convert decimal string to unsigned 16-bit integer with strict parse error feedback.
constexpr bool IsDigit(char c)
Tests if the given character is a decimal digit.
Definition: strencodings.h:83
bool ConvertBits(const O &outfn, I it, I end)
Convert from one power-of-2 number base to another.
Definition: strencodings.h:206
std::string SanitizeString(const std::string &str, int rule=SAFE_CHARS_DEFAULT)
Remove unsafe chars.
constexpr char ToUpper(char c)
Converts the given character to its uppercase equivalent.
Definition: strencodings.h:267
std::vector< uint8_t > DecodeBase64(const char *p, bool *pf_invalid=nullptr)
bool ParseUInt64(const std::string &str, uint64_t *out)
Convert decimal string to unsigned 64-bit integer with strict parse error feedback.
std::vector< uint8_t > DecodeBase32(const char *p, bool *pf_invalid=nullptr)
bool ParseUInt32(const std::string &str, uint32_t *out)
Convert decimal string to unsigned 32-bit integer with strict parse error feedback.
bool TimingResistantEqual(const T &a, const T &b)
Timing-attack-resistant comparison.
Definition: strencodings.h:178
bool ParseInt32(const std::string &str, int32_t *out)
Convert string to signed 32-bit integer with strict parse error feedback.
bool ParseFixedPoint(const std::string &val, int decimals, int64_t *amount_out)
Parse number as fixed point according to JSON number syntax.
bool IsHex(const std::string &str)
Returns true if each character in str is a hex character, and has an even number of hex digits.
constexpr bool IsSpace(char c) noexcept
Tests if the given character is a whitespace character.
Definition: strencodings.h:99
signed char HexDigit(char c)
int atoi(const std::string &str)
bool IsHexNumber(const std::string &str)
Return true if the string is a hex number, optionally prefixed with "0x".
int64_t atoi64(const std::string &str)
bool ParseInt64(const std::string &str, int64_t *out)
Convert string to signed 64-bit integer with strict parse error feedback.
bool ParseDouble(const std::string &str, double *out)
Convert string to double with strict parse error feedback.
void SplitHostPort(std::string in, uint16_t &portOut, std::string &hostOut)
bool ParseUInt8(const std::string &str, uint8_t *out)
Convert decimal string to unsigned 8-bit integer with strict parse error feedback.
SafeChars
Utilities for converting data from/to strings.
Definition: strencodings.h:20
@ SAFE_CHARS_DEFAULT
The full set of allowed chars.
Definition: strencodings.h:22
@ SAFE_CHARS_UA_COMMENT
BIP-0014 subset.
Definition: strencodings.h:24
@ SAFE_CHARS_URI
Chars allowed in URIs (RFC 3986)
Definition: strencodings.h:28
@ SAFE_CHARS_FILENAME
Chars allowed in filenames.
Definition: strencodings.h:26
std::vector< uint8_t > ParseHex(const char *psz)