#include <util/strencodings.h>
#include <crypto/hex_base.h>
#include <span.h>
#include <array>
#include <cassert>
#include <cstring>
#include <limits>
#include <optional>
#include <ostream>
#include <string>
#include <vector>

Include dependency graph for strencodings.cpp:

Functions
std::string	SanitizeString (std::string_view str, int rule)
	Remove unsafe chars. More...

bool	IsHex (std::string_view str)

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...

template std::optional< std::vector< std::byte > >	TryParseHex (std::string_view)

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::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 []

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] str the string to capitalize.

Returns: string with the first letter capitalized.

Definition at line 431 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 165 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 110 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 145 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 160 of file strencodings.cpp.

Here is the call graph for this function:

◆ EncodeBase64()

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsHex()

bool IsHex ( std::string_view str )

Definition at line 41 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]	str	the string to convert into bytes
[in]	default_multiplier	if 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 438 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 323 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 224 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 229 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 239 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 244 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 249 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 234 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 307 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]	str	The string to sanitize
[in]	rule	The set of safe chars to choose (default: least restrictive)

Returns: A new string without unsafe chars

Definition at line 30 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]	in	The socket address string to split.
[out]	portOut	Port-portion of the input, if found and parsable.
[out]	hostOut	Host-portion of the input, if found.

Returns: true if port-portion is absent or within its allowed range, otherwise false

Definition at line 72 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] str the string to convert to lowercase.

Returns: lowercased equivalent of str

Definition at line 415 of file strencodings.cpp.

Here is the call graph for this function:

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] str the string to convert to uppercase.

Returns: UPPERCASED EQUIVALENT OF str

Definition at line 423 of file strencodings.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TryParseHex() [1/2]

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TryParseHex() [2/2]

template std::optional< std::vector< std::byte > > TryParseHex ( std::string_view )

Variable Documentation

◆ CHARS_ALPHA_NUM

const std::string CHARS_ALPHA_NUM = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"

static

Definition at line 20 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 22 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 304 of file strencodings.cpp.

Functions

Variables

Function Documentation

◆ Capitalize()

◆ DecodeBase32()

◆ DecodeBase64()

◆ EncodeBase32() [1/2]

◆ EncodeBase32() [2/2]

◆ EncodeBase64()

◆ FormatParagraph()

◆ IsHex()

◆ ParseByteUnits()

◆ ParseFixedPoint()

◆ ParseInt32()

◆ ParseInt64()

◆ ParseUInt16()

◆ ParseUInt32()

◆ ParseUInt64()

◆ ParseUInt8()

◆ ProcessMantissaDigit()

◆ SanitizeString()

◆ SplitHostPort()

◆ ToLower()

◆ ToUpper()

◆ TryParseHex() [1/2]

◆ TryParseHex() [2/2]

Variable Documentation

◆ CHARS_ALPHA_NUM

◆ SAFE_CHARS

◆ UPPER_BOUND