#include <stdint.h>
#include <string>
#include <vector>

Include dependency graph for utilstrencodings.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	BEGIN(a) ((char*)&(a))
	Utilities for converting data from/to strings. More...

#define	END(a) ((char*)&((&(a))[1]))

#define	UBEGIN(a) ((unsigned char*)&(a))

#define	UEND(a) ((unsigned char*)&((&(a))[1]))

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

Enumerations
enum	SafeChars { SAFE_CHARS_DEFAULT, SAFE_CHARS_UA_COMMENT, SAFE_CHARS_FILENAME }
	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 pfInvalid=nullptr)

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

std::string	EncodeBase64 (const unsigned char *pch, size_t len)

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

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

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

std::string	EncodeBase32 (const unsigned char *pch, size_t len)

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

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

std::string	i64tostr (int64_t n)

std::string	itostr (int n)

int64_t	atoi64 (const char *psz)

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

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

template<typename T >
std::string	HexStr (const T itbegin, const T itend, bool fSpaces=false)

template<typename T >
std::string	HexStr (const T &vch, bool fSpaces=false)

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

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

bool	ParseHDKeypath (const std::string &keypath_str, std::vector< uint32_t > &keypath)
	Parse an HD keypaths like "m/7/0'/2000". More...

constexpr unsigned char	ToLower (unsigned char c)
	Converts the given character to its lowercase equivalent. More...

void	Downcase (std::string &str)
	Converts the given string to its lowercase equivalent. More...

constexpr unsigned char	ToUpper (unsigned char c)
	Converts the given character to its uppercase equivalent. 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]))

Definition at line 20 of file utilstrencodings.h.

◆ BEGIN

#define BEGIN ( a ) ((char*)&(a))

Utilities for converting data from/to strings.

Definition at line 16 of file utilstrencodings.h.

◆ END

#define END ( a ) ((char*)&((&(a))[1]))

Definition at line 17 of file utilstrencodings.h.

◆ UBEGIN

#define UBEGIN ( a ) ((unsigned char*)&(a))

Definition at line 18 of file utilstrencodings.h.

◆ UEND

#define UEND ( a ) ((unsigned char*)&((&(a))[1]))

Definition at line 19 of file utilstrencodings.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.

Definition at line 23 of file utilstrencodings.h.

Function Documentation

◆ atoi()

int atoi ( const std::string & str )

Definition at line 424 of file utilstrencodings.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atoi64() [1/2]

int64_t atoi64 ( const char * psz )

Definition at line 406 of file utilstrencodings.cpp.

Here is the caller graph for this function:

◆ atoi64() [2/2]

int64_t atoi64 ( const std::string & str )

Definition at line 415 of file utilstrencodings.cpp.

◆ Capitalize()

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

Capitalizes the first character of the given string.

This function is locale independent. It only capitalizes the first character of the argument if it has an uppercase equivalent in the standard 7-bit ASCII range.

Parameters

[in] str the string to capitalize.

Returns: string with the first letter capitalized.

Definition at line 594 of file utilstrencodings.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,
		I	it,
		I	end
	)

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

Definition at line 179 of file utilstrencodings.h.

◆ DecodeBase32() [1/2]

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

Definition at line 212 of file utilstrencodings.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DecodeBase32() [2/2]

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

Definition at line 259 of file utilstrencodings.cpp.

Here is the call graph for this function:

◆ DecodeBase64() [1/2]

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

Definition at line 143 of file utilstrencodings.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DecodeBase64() [2/2]

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

Definition at line 190 of file utilstrencodings.cpp.

Here is the call graph for this function:

◆ Downcase()

void Downcase ( std::string & str )

Converts the given string to its lowercase equivalent.

This function is locale independent. It only converts uppercase characters in the standard 7-bit ASCII range.

Parameters

[in,out] str the string to convert to lowercase.

Definition at line 589 of file utilstrencodings.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EncodeBase32() [1/2]

std::string EncodeBase32	(	const unsigned char *	pch,
		size_t	len
	)

Definition at line 196 of file utilstrencodings.cpp.

Here is the caller graph for this function:

◆ EncodeBase32() [2/2]

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

Definition at line 207 of file utilstrencodings.cpp.

Here is the call graph for this function:

◆ EncodeBase64() [1/2]

std::string EncodeBase64	(	const unsigned char *	pch,
		size_t	len
	)

Definition at line 127 of file utilstrencodings.cpp.

Here is the caller graph for this function:

◆ EncodeBase64() [2/2]

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

Definition at line 138 of file utilstrencodings.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 355 of file utilstrencodings.cpp.

◆ HexDigit()

signed char HexDigit ( char c )

Definition at line 54 of file utilstrencodings.cpp.

Here is the caller graph for this function:

◆ HexStr() [1/2]

template<typename T >

std::string HexStr	(	const T	itbegin,
		const T	itend,
		bool	fSpaces = `false`
	)

Definition at line 125 of file utilstrencodings.h.

Here is the caller graph for this function:

◆ HexStr() [2/2]

template<typename T >

std::string HexStr	(	const T &	vch,
		bool	fSpaces = `false`
	)

inline

Definition at line 144 of file utilstrencodings.h.

Here is the call graph for this function:

◆ i64tostr()

std::string i64tostr ( int64_t n )

Definition at line 396 of file utilstrencodings.cpp.

◆ IsDigit()

constexpr bool IsDigit ( char c )

Tests if the given character is a decimal digit.

Parameters

[in] c character to test

Returns: true if the argument is a decimal digit; otherwise false.

Definition at line 69 of file utilstrencodings.h.

Here is the caller graph for this function:

◆ IsHex()

bool IsHex ( const std::string & str )

Definition at line 59 of file utilstrencodings.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 69 of file utilstrencodings.cpp.

Here is the call 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] c character to test

Returns: true if the argument is a whitespace character; otherwise false

Definition at line 85 of file utilstrencodings.h.

Here is the caller graph for this function:

◆ itostr()

std::string itostr ( int n )

Definition at line 401 of file utilstrencodings.cpp.

◆ 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 341 of file utilstrencodings.cpp.

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 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 456 of file utilstrencodings.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseHDKeypath()

bool ParseHDKeypath	(	const std::string &	keypath_str,
		std::vector< uint32_t > &	keypath
	)

Parse an HD keypaths like "m/7/0'/2000".

Definition at line 548 of file utilstrencodings.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 82 of file utilstrencodings.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 103 of file utilstrencodings.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 276 of file utilstrencodings.cpp.

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 292 of file utilstrencodings.cpp.

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 307 of file utilstrencodings.cpp.

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 324 of file utilstrencodings.cpp.

◆ 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]	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 25 of file utilstrencodings.cpp.

◆ SplitHostPort()

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

Definition at line 108 of file utilstrencodings.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 161 of file utilstrencodings.h.

◆ ToLower()

constexpr unsigned char ToLower ( unsigned 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.

Parameters

[in] c the character to convert to lowercase.

Returns: the lowercase equivalent of c; or the argument if no conversion is possible.

Definition at line 212 of file utilstrencodings.h.

Here is the caller graph for this function:

◆ ToUpper()

constexpr unsigned char ToUpper ( unsigned 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.

Parameters

[in] c the character to convert to uppercase.

Returns: the uppercase equivalent of c; or the argument if no conversion is possible.

Definition at line 233 of file utilstrencodings.h.

Here is the caller graph for this function:

Macros

Enumerations

Functions

Macro Definition Documentation

◆ ARRAYLEN

◆ BEGIN

◆ END

◆ UBEGIN

◆ UEND

Enumeration Type Documentation

◆ SafeChars

Function Documentation

◆ atoi()

◆ atoi64() [1/2]

◆ atoi64() [2/2]

◆ Capitalize()

◆ ConvertBits()

◆ DecodeBase32() [1/2]

◆ DecodeBase32() [2/2]

◆ DecodeBase64() [1/2]

◆ DecodeBase64() [2/2]

◆ Downcase()

◆ EncodeBase32() [1/2]

◆ EncodeBase32() [2/2]

◆ EncodeBase64() [1/2]

◆ EncodeBase64() [2/2]

◆ FormatParagraph()

◆ HexDigit()

◆ HexStr() [1/2]

◆ HexStr() [2/2]

◆ i64tostr()

◆ IsDigit()

◆ IsHex()

◆ IsHexNumber()

◆ IsSpace()

◆ itostr()

◆ ParseDouble()

◆ ParseFixedPoint()

◆ ParseHDKeypath()

◆ ParseHex() [1/2]

◆ ParseHex() [2/2]

◆ ParseInt32()

◆ ParseInt64()

◆ ParseUInt32()

◆ ParseUInt64()

◆ SanitizeString()

◆ SplitHostPort()

◆ TimingResistantEqual()

◆ ToLower()

◆ ToUpper()