Bitcoin Core  21.99.0
P2P Digital Currency
Macros | Enumerations | Functions
strencodings.h File Reference
#include <attributes.h>
#include <span.h>
#include <cstdint>
#include <iterator>
#include <string>
#include <vector>
Include dependency graph for strencodings.h:

Go to the source code of this file.

Macros

#define ARRAYLEN(array)   (sizeof(array)/sizeof((array)[0]))
 Utilities for converting data from/to strings. More...
 

Enumerations

enum  SafeChars { SAFE_CHARS_DEFAULT, SAFE_CHARS_UA_COMMENT, SAFE_CHARS_FILENAME, SAFE_CHARS_URI }
 Used by SanitizeString() More...
 

Functions

std::string SanitizeString (const std::string &str, int rule=SAFE_CHARS_DEFAULT)
 Remove unsafe chars. More...
 
std::vector< unsigned char > ParseHex (const char *psz)
 
std::vector< unsigned char > ParseHex (const std::string &str)
 
signed char HexDigit (char c)
 
bool IsHex (const std::string &str)
 
bool IsHexNumber (const std::string &str)
 Return true if the string is a hex number, optionally prefixed with "0x". More...
 
std::vector< unsigned char > DecodeBase64 (const char *p, bool *pf_invalid=nullptr)
 
std::string DecodeBase64 (const std::string &str, bool *pf_invalid=nullptr)
 
std::string EncodeBase64 (Span< const unsigned char > input)
 
std::string EncodeBase64 (const std::string &str)
 
std::vector< unsigned char > DecodeBase32 (const char *p, bool *pf_invalid=nullptr)
 
std::string DecodeBase32 (const std::string &str, bool *pf_invalid=nullptr)
 
std::string EncodeBase32 (Span< const unsigned char > input, bool pad=true)
 Base32 encode. More...
 
std::string EncodeBase32 (const std::string &str, bool pad=true)
 Base32 encode. More...
 
void SplitHostPort (std::string in, int &portOut, std::string &hostOut)
 
int64_t atoi64 (const std::string &str)
 
int atoi (const std::string &str)
 
constexpr bool IsDigit (char c)
 Tests if the given character is a decimal digit. More...
 
constexpr bool IsSpace (char c) noexcept
 Tests if the given character is a whitespace character. More...
 
NODISCARD bool ParseInt32 (const std::string &str, int32_t *out)
 Convert string to signed 32-bit integer with strict parse error feedback. More...
 
NODISCARD bool ParseInt64 (const std::string &str, int64_t *out)
 Convert string to signed 64-bit integer with strict parse error feedback. More...
 
NODISCARD bool ParseUInt8 (const std::string &str, uint8_t *out)
 Convert decimal string to unsigned 8-bit integer with strict parse error feedback. More...
 
NODISCARD bool ParseUInt32 (const std::string &str, uint32_t *out)
 Convert decimal string to unsigned 32-bit integer with strict parse error feedback. More...
 
NODISCARD bool ParseUInt64 (const std::string &str, uint64_t *out)
 Convert decimal string to unsigned 64-bit integer with strict parse error feedback. More...
 
NODISCARD bool ParseDouble (const std::string &str, double *out)
 Convert string to double with strict parse error feedback. More...
 
std::string HexStr (const Span< const uint8_t > s)
 Convert a span of bytes to a lower-case hexadecimal string. More...
 
std::string HexStr (const Span< const char > s)
 
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. More...
 
template<typename T >
bool TimingResistantEqual (const T &a, const T &b)
 Timing-attack-resistant comparison. More...
 
NODISCARD bool ParseFixedPoint (const std::string &val, int decimals, int64_t *amount_out)
 Parse number as fixed point according to JSON number syntax. More...
 
template<int frombits, int tobits, bool pad, typename O , typename I >
bool ConvertBits (const O &outfn, I it, I end)
 Convert from one power-of-2 number base to another. More...
 
constexpr char ToLower (char c)
 Converts the given character to its lowercase equivalent. More...
 
std::string ToLower (const std::string &str)
 Returns the lowercase equivalent of the given string. More...
 
constexpr char ToUpper (char c)
 Converts the given character to its uppercase equivalent. More...
 
std::string ToUpper (const std::string &str)
 Returns the uppercase equivalent of the given string. More...
 
std::string Capitalize (std::string str)
 Capitalizes the first character of the given string. More...
 

Macro Definition Documentation

◆ ARRAYLEN

#define ARRAYLEN (   array)    (sizeof(array)/sizeof((array)[0]))

Utilities for converting data from/to strings.

Definition at line 20 of file strencodings.h.

Enumeration Type Documentation

◆ SafeChars

enum SafeChars

Used by SanitizeString()

Enumerator
SAFE_CHARS_DEFAULT 

The full set of allowed chars.

SAFE_CHARS_UA_COMMENT 

BIP-0014 subset.

SAFE_CHARS_FILENAME 

Chars allowed in filenames.

SAFE_CHARS_URI 

Chars allowed in URIs (RFC 3986)

Definition at line 23 of file strencodings.h.

Function Documentation

◆ atoi()

int atoi ( const std::string &  str)

Definition at line 435 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ atoi64()

int64_t atoi64 ( const std::string &  str)

Definition at line 426 of file strencodings.cpp.

Here is the caller graph for this function:

◆ Capitalize()

std::string Capitalize ( std::string  str)

Capitalizes the first character of the given string.

This function is locale independent. It only converts lowercase characters in the standard 7-bit ASCII range. This is a feature, not a limitation.

Parameters
[in]strthe string to capitalize.
Returns
string with the first letter capitalized.

Definition at line 573 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ConvertBits()

template<int frombits, int tobits, bool pad, typename O , typename I >
bool ConvertBits ( const O &  outfn,
it,
end 
)

Convert from one power-of-2 number base to another.

Definition at line 177 of file strencodings.h.

◆ DecodeBase32() [1/2]

std::vector<unsigned char> DecodeBase32 ( const char *  p,
bool *  pf_invalid = nullptr 
)

Definition at line 224 of file strencodings.cpp.

Here is the caller graph for this function:

◆ DecodeBase32() [2/2]

std::string DecodeBase32 ( const std::string &  str,
bool *  pf_invalid = nullptr 
)

Definition at line 271 of file strencodings.cpp.

Here is the call graph for this function:

◆ DecodeBase64() [1/2]

std::vector<unsigned char> DecodeBase64 ( const char *  p,
bool *  pf_invalid = nullptr 
)

Definition at line 145 of file strencodings.cpp.

Here is the caller graph for this function:

◆ DecodeBase64() [2/2]

std::string DecodeBase64 ( const std::string &  str,
bool *  pf_invalid = nullptr 
)

Definition at line 192 of file strencodings.cpp.

Here is the call graph for this function:

◆ EncodeBase32() [1/2]

std::string EncodeBase32 ( Span< const unsigned char >  input,
bool  pad = true 
)

Base32 encode.

If pad is true, then the output will be padded with '=' so that its length is a multiple of 8.

Definition at line 204 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EncodeBase32() [2/2]

std::string EncodeBase32 ( const std::string &  str,
bool  pad = true 
)

Base32 encode.

If pad is true, then the output will be padded with '=' so that its length is a multiple of 8.

Definition at line 219 of file strencodings.cpp.

Here is the call graph for this function:

◆ EncodeBase64() [1/2]

std::string EncodeBase64 ( Span< const unsigned char >  input)

Definition at line 129 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ EncodeBase64() [2/2]

std::string EncodeBase64 ( const std::string &  str)

Definition at line 140 of file strencodings.cpp.

Here is the call graph for this function:

◆ 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 at line 385 of file strencodings.cpp.

Here is the caller graph for this function:

◆ HexDigit()

signed char HexDigit ( char  c)

Definition at line 56 of file strencodings.cpp.

Here is the caller graph for this function:

◆ HexStr() [1/2]

std::string HexStr ( const Span< const uint8_t >  s)

Convert a span of bytes to a lower-case hexadecimal string.

Definition at line 580 of file strencodings.cpp.

Here is the call graph for this function:

◆ HexStr() [2/2]

std::string HexStr ( const Span< const char >  s)
inline

Definition at line 145 of file strencodings.h.

Here is the call graph for this function:

◆ IsDigit()

constexpr bool IsDigit ( char  c)

Tests if the given character is a decimal digit.

Parameters
[in]ccharacter to test
Returns
true if the argument is a decimal digit; otherwise false.

Definition at line 79 of file strencodings.h.

Here is the caller graph for this function:

◆ IsHex()

bool IsHex ( const std::string &  str)

Definition at line 61 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IsHexNumber()

bool IsHexNumber ( const std::string &  str)

Return true if the string is a hex number, optionally prefixed with "0x".

Definition at line 71 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ IsSpace()

constexpr bool IsSpace ( char  c)
inlinenoexcept

Tests if the given character is a whitespace character.

The whitespace characters are: space, form-feed (''), newline ('
'), carriage return (''), horizontal tab (''), and vertical tab ('').

This function is locale independent. Under the C locale this function gives the same result as std::isspace.

Parameters
[in]ccharacter to test
Returns
true if the argument is a whitespace character; otherwise false

Definition at line 95 of file strencodings.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ParseDouble()

NODISCARD bool ParseDouble ( const std::string &  str,
double *  out 
)

Convert string to double with strict parse error feedback.

Returns
true if the entire string could be parsed as valid double, false if not the entire string could be parsed or when overflow or underflow occurred.

Definition at line 371 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ParseFixedPoint()

NODISCARD bool ParseFixedPoint ( const std::string &  val,
int  decimals,
int64_t *  amount_out 
)

Parse number as fixed point according to JSON number syntax.

See http://json.org/number.gif

Returns
true on success, false on error.
Note
The result must be in the range (-10^18,10^18), otherwise an overflow error will trigger.

Definition at line 467 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ParseHex() [1/2]

std::vector<unsigned char> ParseHex ( const char *  psz)

Definition at line 84 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ParseHex() [2/2]

std::vector<unsigned char> ParseHex ( const std::string &  str)

Definition at line 105 of file strencodings.cpp.

Here is the call graph for this function:

◆ ParseInt32()

NODISCARD bool ParseInt32 ( const std::string &  str,
int32_t *  out 
)

Convert string to signed 32-bit integer with strict parse error feedback.

Returns
true if the entire string could be parsed as valid integer, false if not the entire string could be parsed or when overflow or underflow occurred.

Definition at line 294 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ParseInt64()

NODISCARD bool ParseInt64 ( const std::string &  str,
int64_t *  out 
)

Convert string to signed 64-bit integer with strict parse error feedback.

Returns
true if the entire string could be parsed as valid integer, false if not the entire string could be parsed or when overflow or underflow occurred.

Definition at line 310 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ParseUInt32()

NODISCARD bool ParseUInt32 ( const std::string &  str,
uint32_t *  out 
)

Convert decimal string to unsigned 32-bit integer with strict parse error feedback.

Returns
true if the entire string could be parsed as valid integer, false if not the entire string could be parsed or when overflow or underflow occurred.

Definition at line 337 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ParseUInt64()

NODISCARD bool ParseUInt64 ( const std::string &  str,
uint64_t *  out 
)

Convert decimal string to unsigned 64-bit integer with strict parse error feedback.

Returns
true if the entire string could be parsed as valid integer, false if not the entire string could be parsed or when overflow or underflow occurred.

Definition at line 354 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ParseUInt8()

NODISCARD bool ParseUInt8 ( const std::string &  str,
uint8_t *  out 
)

Convert decimal string to unsigned 8-bit integer with strict parse error feedback.

Returns
true if the entire string could be parsed as valid integer, false if not the entire string could be parsed or when overflow or underflow occurred.

Definition at line 325 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ SanitizeString()

std::string SanitizeString ( const std::string &  str,
int  rule = SAFE_CHARS_DEFAULT 
)

Remove unsafe chars.

Safe chars chosen to allow simple messages/URLs/email addresses, but avoid anything even possibly remotely dangerous like & or >

Parameters
[in]strThe string to sanitize
[in]ruleThe set of safe chars to choose (default: least restrictive)
Returns
A new string without unsafe chars

Definition at line 27 of file strencodings.cpp.

Here is the caller graph for this function:

◆ SplitHostPort()

void SplitHostPort ( std::string  in,
int &  portOut,
std::string &  hostOut 
)

Definition at line 110 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TimingResistantEqual()

template<typename T >
bool TimingResistantEqual ( const T &  a,
const T &  b 
)

Timing-attack-resistant comparison.

Takes time proportional to length of first argument.

Definition at line 159 of file strencodings.h.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ToLower() [1/2]

constexpr char ToLower ( char  c)

Converts the given character to its lowercase equivalent.

This function is locale independent. It only converts uppercase characters in the standard 7-bit ASCII range. This is a feature, not a limitation.

Parameters
[in]cthe character to convert to lowercase.
Returns
the lowercase equivalent of c; or the argument if no conversion is possible.

Definition at line 209 of file strencodings.h.

◆ ToLower() [2/2]

std::string ToLower ( const std::string &  str)

Returns the lowercase equivalent of the given string.

This function is locale independent. It only converts uppercase characters in the standard 7-bit ASCII range. This is a feature, not a limitation.

Parameters
[in]strthe string to convert to lowercase.
Returns
lowercased equivalent of str

Definition at line 559 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ToUpper() [1/2]

constexpr char ToUpper ( char  c)

Converts the given character to its uppercase equivalent.

This function is locale independent. It only converts lowercase characters in the standard 7-bit ASCII range. This is a feature, not a limitation.

Parameters
[in]cthe character to convert to uppercase.
Returns
the uppercase equivalent of c; or the argument if no conversion is possible.

Definition at line 235 of file strencodings.h.

Here is the call graph for this function:

◆ ToUpper() [2/2]

std::string ToUpper ( const std::string &  str)

Returns the uppercase equivalent of the given string.

This function is locale independent. It only converts lowercase characters in the standard 7-bit ASCII range. This is a feature, not a limitation.

Parameters
[in]strthe string to convert to uppercase.
Returns
UPPERCASED EQUIVALENT OF str

Definition at line 566 of file strencodings.cpp.

Here is the call graph for this function:
Here is the caller graph for this function: