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 <attributes.h>
13 #include <span.h>
14 
15 #include <cstdint>
16 #include <iterator>
17 #include <string>
18 #include <vector>
19 
21 enum SafeChars {
30 };
31 
40 std::string SanitizeString(const std::string &str,
41  int rule = SAFE_CHARS_DEFAULT);
42 std::vector<uint8_t> ParseHex(const char *psz);
43 std::vector<uint8_t> ParseHex(const std::string &str);
44 signed char HexDigit(char c);
49 bool IsHex(const std::string &str);
53 bool IsHexNumber(const std::string &str);
54 std::vector<uint8_t> DecodeBase64(const char *p, bool *pf_invalid = nullptr);
55 std::string DecodeBase64(const std::string &str, bool *pf_invalid = nullptr);
56 std::string EncodeBase64(Span<const uint8_t> input);
57 std::string EncodeBase64(const std::string &str);
58 std::vector<uint8_t> DecodeBase32(const char *p, bool *pf_invalid = nullptr);
59 std::string DecodeBase32(const std::string &str, bool *pf_invalid = nullptr);
60 
66 std::string EncodeBase32(Span<const uint8_t> input, bool pad = true);
67 
73 std::string EncodeBase32(const std::string &str, bool pad = true);
74 
75 void SplitHostPort(std::string in, uint16_t &portOut, std::string &hostOut);
76 int64_t atoi64(const std::string &str);
77 int atoi(const std::string &str);
78 
84 constexpr bool IsDigit(char c) {
85  return c >= '0' && c <= '9';
86 }
87 
100 constexpr inline bool IsSpace(char c) noexcept {
101  return c == ' ' || c == '\f' || c == '\n' || c == '\r' || c == '\t' ||
102  c == '\v';
103 }
104 
110 [[nodiscard]] bool ParseInt32(const std::string &str, int32_t *out);
111 
117 [[nodiscard]] bool ParseInt64(const std::string &str, int64_t *out);
118 
126 [[nodiscard]] bool ParseUInt8(const std::string &str, uint8_t *out);
127 
135 [[nodiscard]] bool ParseUInt16(const std::string &str, uint16_t *out);
136 
143 [[nodiscard]] bool ParseUInt32(const std::string &str, uint32_t *out);
144 
151 [[nodiscard]] bool ParseUInt64(const std::string &str, uint64_t *out);
152 
158 [[nodiscard]] bool ParseDouble(const std::string &str, double *out);
159 
163 std::string HexStr(const Span<const uint8_t> s);
164 inline std::string HexStr(const Span<const char> s) {
165  return HexStr(MakeUCharSpan(s));
166 }
167 
172 std::string FormatParagraph(const std::string &in, size_t width = 79,
173  size_t indent = 0);
174 
179 template <typename T> bool TimingResistantEqual(const T &a, const T &b) {
180  if (b.size() == 0) return a.size() == 0;
181  size_t accumulator = a.size() ^ b.size();
182  for (size_t i = 0; i < a.size(); i++)
183  accumulator |= a[i] ^ b[i % b.size()];
184  return accumulator == 0;
185 }
186 
194 [[nodiscard]] bool ParseFixedPoint(const std::string &val, int decimals,
195  int64_t *amount_out);
196 
203 template <int frombits, int tobits, bool pad, typename O, typename I>
204 bool ConvertBits(const O &outfn, I it, I end) {
205  size_t acc = 0;
206  size_t bits = 0;
207  constexpr size_t maxv = (1 << tobits) - 1;
208  constexpr size_t max_acc = (1 << (frombits + tobits - 1)) - 1;
209  while (it != end) {
210  acc = ((acc << frombits) | *it) & max_acc;
211  bits += frombits;
212  while (bits >= tobits) {
213  bits -= tobits;
214  outfn((acc >> bits) & maxv);
215  }
216  ++it;
217  }
218 
219  if (pad) {
220  if (bits) {
221  outfn((acc << (tobits - bits)) & maxv);
222  }
223  } else if (bits >= frombits || ((acc << (tobits - bits)) & maxv)) {
224  return false;
225  }
226 
227  return true;
228 }
229 
240 constexpr char ToLower(char c) {
241  return (c >= 'A' && c <= 'Z' ? (c - 'A') + 'a' : c);
242 }
243 
253 std::string ToLower(const std::string &str);
254 
265 constexpr char ToUpper(char c) {
266  return (c >= 'a' && c <= 'z' ? (c - 'a') + 'A' : c);
267 }
268 
278 std::string ToUpper(const std::string &str);
279 
289 std::string Capitalize(std::string str);
290 
291 #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(MakeSpan(std::forward< V >(v))))
Like MakeSpan, but for (const) uint8_t member types only.
Definition: span.h:311
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:240
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:84
bool ConvertBits(const O &outfn, I it, I end)
Convert from one power-of-2 number base to another.
Definition: strencodings.h:204
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:265
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:179
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:100
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:21
@ SAFE_CHARS_DEFAULT
The full set of allowed chars.
Definition: strencodings.h:23
@ SAFE_CHARS_UA_COMMENT
BIP-0014 subset.
Definition: strencodings.h:25
@ SAFE_CHARS_URI
Chars allowed in URIs (RFC 3986)
Definition: strencodings.h:29
@ SAFE_CHARS_FILENAME
Chars allowed in filenames.
Definition: strencodings.h:27
std::vector< uint8_t > ParseHex(const char *psz)