Bitcoin Core  26.99.0
P2P Digital Currency
Functions | Variables
strencodings.cpp File Reference
#include <span.h>
#include <util/strencodings.h>
#include <array>
#include <cassert>
#include <cstring>
#include <limits>
#include <optional>
#include <ostream>
#include <string>
#include <vector>
Include dependency graph for strencodings.cpp:

Go to the source code of this file.

Functions

std::string SanitizeString (std::string_view str, int rule)
 Remove unsafe chars. More...
 
signed char HexDigit (char c)
 
bool IsHex (std::string_view str)
 
bool IsHexNumber (std::string_view str)
 Return true if the string is a hex number, optionally prefixed with "0x". More...
 
template<typename Byte >
std::optional< std::vector< Byte > > TryParseHex (std::string_view str)
 Parse the hex string into bytes (uint8_t or std::byte). More...
 
bool SplitHostPort (std::string_view in, uint16_t &portOut, std::string &hostOut)
 Splits socket address string into host string and port value. More...
 
std::string EncodeBase64 (Span< const unsigned char > input)
 
std::optional< std::vector< unsigned char > > DecodeBase64 (std::string_view str)
 
std::string EncodeBase32 (Span< const unsigned char > input, bool pad)
 Base32 encode. More...
 
std::string EncodeBase32 (std::string_view str, bool pad)
 Base32 encode. More...
 
std::optional< std::vector< unsigned char > > DecodeBase32 (std::string_view str)
 
bool ParseInt32 (std::string_view str, int32_t *out)
 Convert string to signed 32-bit integer with strict parse error feedback. More...
 
bool ParseInt64 (std::string_view str, int64_t *out)
 Convert string to signed 64-bit integer with strict parse error feedback. More...
 
bool ParseUInt8 (std::string_view str, uint8_t *out)
 Convert decimal string to unsigned 8-bit integer with strict parse error feedback. More...
 
bool ParseUInt16 (std::string_view str, uint16_t *out)
 Convert decimal string to unsigned 16-bit integer with strict parse error feedback. More...
 
bool ParseUInt32 (std::string_view str, uint32_t *out)
 Convert decimal string to unsigned 32-bit integer with strict parse error feedback. More...
 
bool ParseUInt64 (std::string_view str, uint64_t *out)
 Convert decimal string to unsigned 64-bit integer with strict parse error feedback. More...
 
std::string FormatParagraph (std::string_view in, size_t width, size_t indent)
 Format a paragraph of text to a fixed width, adding spaces for indentation to any added line. More...
 
static bool ProcessMantissaDigit (char ch, int64_t &mantissa, int &mantissa_tzeros)
 Helper function for ParseFixedPoint. More...
 
bool ParseFixedPoint (std::string_view val, int decimals, int64_t *amount_out)
 Parse number as fixed point according to JSON number syntax. More...
 
std::string ToLower (std::string_view str)
 Returns the lowercase equivalent of the given string. More...
 
std::string ToUpper (std::string_view 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...
 
std::string HexStr (const Span< const uint8_t > s)
 Convert a span of bytes to a lower-case hexadecimal string. More...
 
std::optional< uint64_t > ParseByteUnits (std::string_view str, ByteUnit default_multiplier)
 Parse a string with suffix unit [k|K|m|M|g|G|t|T]. More...
 

Variables

static const std::string CHARS_ALPHA_NUM = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
 
static const std::string SAFE_CHARS []
 
const signed char p_util_hexdigit [256]
 
static const int64_t UPPER_BOUND = 1000000000000000000LL - 1LL
 Upper bound for mantissa. More...
 

Function Documentation

◆ 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 458 of file strencodings.cpp.

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

◆ DecodeBase32()

std::optional<std::vector<unsigned char> > DecodeBase32 ( std::string_view  str)

Definition at line 194 of file strencodings.cpp.

Here is the caller graph for this function:

◆ DecodeBase64()

std::optional<std::vector<unsigned char> > DecodeBase64 ( std::string_view  str)

Definition at line 139 of file strencodings.cpp.

Here is the caller 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 174 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 ( std::string_view  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 189 of file strencodings.cpp.

Here is the call graph for this function:

◆ EncodeBase64()

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

Definition at line 128 of file strencodings.cpp.

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

◆ FormatParagraph()

std::string FormatParagraph ( std::string_view  in,
size_t  width,
size_t  indent 
)

Format a paragraph of text to a fixed width, adding spaces for indentation to any added line.

Definition at line 283 of file strencodings.cpp.

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

◆ HexDigit()

signed char HexDigit ( char  c)

Definition at line 57 of file strencodings.cpp.

Here is the caller graph for this function:

◆ HexStr()

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

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

Definition at line 483 of file strencodings.cpp.

Here is the call graph for this function:

◆ IsHex()

bool IsHex ( std::string_view  str)

Definition at line 62 of file strencodings.cpp.

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

◆ IsHexNumber()

bool IsHexNumber ( std::string_view  str)

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

Definition at line 70 of file strencodings.cpp.

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

◆ ParseByteUnits()

std::optional<uint64_t> ParseByteUnits ( std::string_view  str,
ByteUnit  default_multiplier 
)

Parse a string with suffix unit [k|K|m|M|g|G|t|T].

Must be a whole integer, fractions not allowed (0.5t), no whitespace or +- Lowercase units are 1000 base. Uppercase units are 1024 base. Examples: 2m,27M,19g,41T

Parameters
[in]strthe string to convert into bytes
[in]default_multiplierif no unit is found in str use this unit
Returns
optional uint64_t bytes from str or nullopt if ToIntegral is false, str is empty, trailing whitespace or overflow

Definition at line 499 of file strencodings.cpp.

Here is the caller graph for this function:

◆ ParseFixedPoint()

bool ParseFixedPoint ( std::string_view  val,
int  decimals,
int64_t *  amount_out 
)

Parse number as fixed point according to JSON number syntax.

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 352 of file strencodings.cpp.

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

◆ ParseInt32()

bool ParseInt32 ( std::string_view  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 253 of file strencodings.cpp.

Here is the caller graph for this function:

◆ ParseInt64()

bool ParseInt64 ( std::string_view  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 258 of file strencodings.cpp.

Here is the caller graph for this function:

◆ ParseUInt16()

bool ParseUInt16 ( std::string_view  str,
uint16_t *  out 
)

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

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

Definition at line 268 of file strencodings.cpp.

Here is the caller graph for this function:

◆ ParseUInt32()

bool ParseUInt32 ( std::string_view  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 273 of file strencodings.cpp.

Here is the caller graph for this function:

◆ ParseUInt64()

bool ParseUInt64 ( std::string_view  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 278 of file strencodings.cpp.

Here is the caller graph for this function:

◆ ParseUInt8()

bool ParseUInt8 ( std::string_view  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 263 of file strencodings.cpp.

Here is the caller graph for this function:

◆ ProcessMantissaDigit()

static bool ProcessMantissaDigit ( char  ch,
int64_t &  mantissa,
int &  mantissa_tzeros 
)
inlinestatic

Helper function for ParseFixedPoint.

Definition at line 336 of file strencodings.cpp.

Here is the caller graph for this function:

◆ SanitizeString()

std::string SanitizeString ( std::string_view  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 28 of file strencodings.cpp.

Here is the caller graph for this function:

◆ SplitHostPort()

bool SplitHostPort ( std::string_view  in,
uint16_t &  portOut,
std::string &  hostOut 
)

Splits socket address string into host string and port value.

Validates port value.

Parameters
[in]inThe socket address string to split.
[out]portOutPort-portion of the input, if found and parsable.
[out]hostOutHost-portion of the input, if found.
Returns
true if port-portion is absent or within its allowed range, otherwise false

Definition at line 101 of file strencodings.cpp.

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

◆ ToLower()

std::string ToLower ( std::string_view  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 444 of file strencodings.cpp.

Here is the caller graph for this function:

◆ ToUpper()

std::string ToUpper ( std::string_view  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 451 of file strencodings.cpp.

Here is the caller graph for this function:

◆ TryParseHex()

template<typename Byte >
template std::optional< std::vector< uint8_t > > TryParseHex ( std::string_view  str)

Parse the hex string into bytes (uint8_t or std::byte).

Ignores whitespace. Returns nullopt on invalid input.

Definition at line 81 of file strencodings.cpp.

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

Variable Documentation

◆ CHARS_ALPHA_NUM

const std::string CHARS_ALPHA_NUM = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
static

Definition at line 18 of file strencodings.cpp.

◆ p_util_hexdigit

const signed char p_util_hexdigit[256]
Initial value:
=
{ -1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
0,1,2,3,4,5,6,7,8,9,-1,-1,-1,-1,-1,-1,
-1,0xa,0xb,0xc,0xd,0xe,0xf,-1,-1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
-1,0xa,0xb,0xc,0xd,0xe,0xf,-1,-1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1, }

Definition at line 39 of file strencodings.cpp.

◆ SAFE_CHARS

const std::string SAFE_CHARS[]
static
Initial value:
=
{
CHARS_ALPHA_NUM + " .,;-_/:?@()",
CHARS_ALPHA_NUM + " .,;-_?@",
CHARS_ALPHA_NUM + ".-_",
CHARS_ALPHA_NUM + "!*'();:@&=+$,/?#[]-_.~%",
}
static const std::string CHARS_ALPHA_NUM

Definition at line 20 of file strencodings.cpp.

◆ UPPER_BOUND

const int64_t UPPER_BOUND = 1000000000000000000LL - 1LL
static

Upper bound for mantissa.

10^18-1 is the largest arbitrary decimal that will fit in a signed 64-bit integer. Larger integers cannot consist of arbitrary combinations of 0-9:

999999999999999999 1^18-1 9223372036854775807 (1<<63)-1 (max int64_t) 9999999999999999999 1^19-1 (would overflow)

Definition at line 333 of file strencodings.cpp.