strencodings.h File Reference

#include <attributes.h>
#include <cstdint>
#include <iterator>
#include <string>
#include <vector>

Go to the source code of this file.

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

Enumerations
enum	SafeChars { SAFE_CHARS_DEFAULT, SAFE_CHARS_UA_COMMENT, SAFE_CHARS_FILENAME, SAFE_CHARS_URI }

Functions
std::string	SanitizeString (const std::string &str, int rule=SAFE_CHARS_DEFAULT)
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)
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 (const unsigned char *pch, size_t len)
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 (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)
constexpr bool	IsSpace (char c) noexcept
NODISCARD bool	ParseInt32 (const std::string &str, int32_t *out)
NODISCARD bool	ParseInt64 (const std::string &str, int64_t *out)
NODISCARD bool	ParseUInt32 (const std::string &str, uint32_t *out)
NODISCARD bool	ParseUInt64 (const std::string &str, uint64_t *out)
NODISCARD bool	ParseDouble (const std::string &str, double *out)
template<typename T >
std::string	HexStr (const T itbegin, const T itend)
template<typename T >
std::string	HexStr (const T &vch)
std::string	FormatParagraph (const std::string &in, size_t width=79, size_t indent=0)
template<typename T >
bool	TimingResistantEqual (const T &a, const T &b)
NODISCARD bool	ParseFixedPoint (const std::string &val, int decimals, int64_t *amount_out)
template<int frombits, int tobits, bool pad, typename O , typename I >
bool	ConvertBits (const O &outfn, I it, I end)
constexpr char	ToLower (char c)
void	Downcase (std::string &str)
constexpr char	ToUpper (char c)
std::string	Capitalize (std::string str)

Macro Definition Documentation

ARRAYLEN

#define ARRAYLEN

(

array

)

(sizeof(array)/sizeof((array)[0]))

Utilities for converting data from/to strings.

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)

Function Documentation

atoi()

int atoi

(

const std::string &

str

)

atoi64() [1/2]

int64_t atoi64

(

const char *

psz

)

atoi64() [2/2]

int64_t atoi64

(

const std::string &

str

)

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.

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.

DecodeBase32() [1/2]

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

DecodeBase32() [2/2]

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

DecodeBase64() [1/2]

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

DecodeBase64() [2/2]

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

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.

EncodeBase32() [1/2]

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

EncodeBase32() [2/2]

std::string EncodeBase32

(

const std::string &

str

)

EncodeBase64() [1/2]

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

EncodeBase64() [2/2]

std::string EncodeBase64

(

const std::string &

str

)

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.

HexDigit()

signed char HexDigit

(

char

c

)

HexStr() [1/2]

template<typename T >

std::string HexStr	(	const T	itbegin,
		const T	itend
	)

HexStr() [2/2]

template<typename T >

std::string HexStr ( const T &  vch )

inline

i64tostr()

std::string i64tostr

(

int64_t

n

)

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.

IsHex()

bool IsHex

(

const std::string &

str

)

IsHexNumber()

bool IsHexNumber

(

const std::string &

str

)

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

IsSpace()

constexpr bool IsSpace ( char  c )

inlinenoexcept

Tests if the given character is a whitespace character. The whitespace characters are: space, form-feed ('\f'), newline ('
'), carriage return ('\r'), horizontal tab ('\t'), and vertical tab ('\v').

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

itostr()

std::string itostr

(

int

n

)

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.

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.

ParseHex() [1/2]

std::vector<unsigned char> ParseHex

(

const char *

psz

)

ParseHex() [2/2]

std::vector<unsigned char> ParseHex

(

const std::string &

str

)

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.

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.

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.

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.

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

SplitHostPort()

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

TimingResistantEqual()

template<typename T >

bool TimingResistantEqual	(	const T &	a,
		const T &	b
	)

Timing-attack-resistant comparison. Takes time proportional to length of first argument.

ToLower()

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.

Parameters

[in]

c

the character to convert to lowercase.

Returns

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

ToUpper()

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.

Parameters

[in]

c

the character to convert to uppercase.

Returns

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