Bitcoin Core  22.99.0
P2P Digital Currency
Functions | Variables
strencodings.cpp File Reference
#include <util/strencodings.h>
#include <util/string.h>
#include <tinyformat.h>
#include <algorithm>
#include <cstdlib>
#include <cstring>
#include <errno.h>
#include <limits>
Include dependency graph for strencodings.cpp:

Go to the source code of this file.

Functions

std::string SanitizeString (const std::string &str, int rule)
 Remove unsafe chars. More...
 
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 > ParseHex (const char *psz)
 
std::vector< unsigned char > ParseHex (const std::string &str)
 
void SplitHostPort (std::string in, uint16_t &portOut, std::string &hostOut)
 
std::string EncodeBase64 (Span< const unsigned char > input)
 
std::string EncodeBase64 (const std::string &str)
 
std::vector< unsigned char > DecodeBase64 (const char *p, bool *pf_invalid)
 
std::string DecodeBase64 (const std::string &str, bool *pf_invalid)
 
std::string EncodeBase32 (Span< const unsigned char > input, bool pad)
 Base32 encode. More...
 
std::string EncodeBase32 (const std::string &str, bool pad)
 Base32 encode. More...
 
std::vector< unsigned char > DecodeBase32 (const char *p, bool *pf_invalid)
 
std::string DecodeBase32 (const std::string &str, bool *pf_invalid)
 
static bool ParsePrechecks (const std::string &str)
 
bool ParseInt32 (const std::string &str, int32_t *out)
 Convert string to signed 32-bit integer with strict parse error feedback. More...
 
bool ParseInt64 (const std::string &str, int64_t *out)
 Convert string to signed 64-bit integer with strict parse error feedback. More...
 
bool ParseUInt8 (const std::string &str, uint8_t *out)
 Convert decimal string to unsigned 8-bit integer with strict parse error feedback. More...
 
bool ParseUInt16 (const std::string &str, uint16_t *out)
 Convert decimal string to unsigned 16-bit integer with strict parse error feedback. More...
 
bool ParseUInt32 (const std::string &str, uint32_t *out)
 Convert decimal string to unsigned 32-bit integer with strict parse error feedback. More...
 
bool ParseUInt64 (const std::string &str, uint64_t *out)
 Convert decimal string to unsigned 64-bit integer with strict parse error feedback. More...
 
bool ParseDouble (const std::string &str, double *out)
 Convert string to double with strict parse error feedback. More...
 
std::string FormatParagraph (const std::string &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...
 
int64_t atoi64 (const std::string &str)
 
int atoi (const std::string &str)
 
static bool ProcessMantissaDigit (char ch, int64_t &mantissa, int &mantissa_tzeros)
 Helper function for ParseFixedPoint. More...
 
bool ParseFixedPoint (const std::string &val, int decimals, int64_t *amount_out)
 Parse number as fixed point according to JSON number syntax. More...
 
std::string ToLower (const std::string &str)
 Returns the lowercase equivalent of the given string. 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...
 
std::string HexStr (const Span< const uint8_t > s)
 Convert a span of bytes to a lower-case hexadecimal string. 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

◆ atoi()

int atoi ( const std::string &  str)

Definition at line 449 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 440 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 587 of file strencodings.cpp.

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

◆ DecodeBase32() [1/2]

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

Definition at line 226 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 
)

Definition at line 273 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 
)

Definition at line 147 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 
)

Definition at line 194 of file strencodings.cpp.

Here is the call graph for this function:

◆ EncodeBase32() [1/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 221 of file strencodings.cpp.

Here is the call graph for this function:

◆ EncodeBase32() [2/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 206 of file strencodings.cpp.

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

◆ EncodeBase64() [1/2]

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

Definition at line 142 of file strencodings.cpp.

Here is the call graph for this function:

◆ EncodeBase64() [2/2]

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

Definition at line 131 of file strencodings.cpp.

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

◆ FormatParagraph()

std::string FormatParagraph ( const std::string &  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 399 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()

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

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

Definition at line 594 of file strencodings.cpp.

Here is the call 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:

◆ ParseDouble()

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

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

◆ ParseFixedPoint()

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

Parse number as fixed point according to JSON number syntax.

See https://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 481 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()

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

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

◆ ParseInt64()

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

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

◆ ParsePrechecks()

static bool ParsePrechecks ( const std::string &  str)
static

Definition at line 285 of file strencodings.cpp.

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

◆ ParseUInt16()

bool ParseUInt16 ( const std::string &  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 339 of file strencodings.cpp.

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

◆ ParseUInt32()

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

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

◆ ParseUInt64()

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

Here is the call graph for this function:

◆ ParseUInt8()

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

Here is the call graph for this function:
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 465 of file strencodings.cpp.

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,
uint16_t &  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:

◆ ToLower()

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

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

◆ ToUpper()

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 580 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 17 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 38 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 + "!*'();:@&=+$,/?#[]-_.~%",
}

Definition at line 19 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 462 of file strencodings.cpp.

CHARS_ALPHA_NUM
static const std::string CHARS_ALPHA_NUM
Definition: strencodings.cpp:17