#include <span.h>
#include <charconv>
#include <cstdint>
#include <iterator>
#include <optional>
#include <string>
#include <vector>

Include dependency graph for strencodings.h:

Enumerations
enum	SafeChars { SAFE_CHARS_DEFAULT , SAFE_CHARS_UA_COMMENT , SAFE_CHARS_FILENAME , SAFE_CHARS_URI }
	Utilities for converting data from/to strings. More...

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

template<typename Byte = std::byte>
std::optional< std::vector< Byte > >	TryParseHex (std::string_view str)
	Parse the hex string into bytes (uint8_t or std::byte). More...

template<typename Byte = uint8_t>
std::vector< Byte >	ParseHex (std::string_view hex_str)
	Like TryParseHex, but returns an empty vector on invalid input. More...

signed char	HexDigit (char c)

bool	IsHex (std::string_view str)
	Returns true if each character in str is a hex character, and has an even number of hex digits. More...

bool	IsHexNumber (std::string_view str)
	Return true if the string is a hex number, optionally prefixed with "0x". More...

std::optional< std::vector< uint8_t > >	DecodeBase64 (std::string_view str)

std::string	EncodeBase64 (Span< const uint8_t > input)

std::string	EncodeBase64 (Span< const std::byte > input)

std::string	EncodeBase64 (std::string_view str)

std::optional< std::vector< uint8_t > >	DecodeBase32 (std::string_view str)

std::string	EncodeBase32 (Span< const uint8_t > input, bool pad=true)
	Base32 encode. More...

std::string	EncodeBase32 (std::string_view str, bool pad=true)
	Base32 encode. More...

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

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

template<typename T >
std::optional< T >	ToIntegral (std::string_view str)
	Convert string to integral type T. More...

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	HexStr (const Span< const uint8_t > s)
	Convert a span of bytes to a lower-case hexadecimal string. More...

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

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

std::string	FormatParagraph (std::string_view 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 (std::string_view, 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 It , typename I = IntIdentity>
bool	ConvertBits (O outfn, It it, It end, I infn={})
	Convert from one power-of-2 number base to another. More...

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

std::string	ToLower (std::string_view str)
	Returns the lowercase equivalent of the given string. More...

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

Enumeration Type Documentation

◆ SafeChars

enum SafeChars

Utilities for converting data from/to strings.

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)

Definition at line 22 of file strencodings.h.

Function Documentation

◆ atoi()

int atoi ( const std::string & str )

Definition at line 347 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 339 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] str the string to capitalize.

Returns: string with the first letter capitalized.

Definition at line 517 of file strencodings.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 It , typename I = IntIdentity>

bool ConvertBits	(	O	outfn,
		It	it,
		It	end,
		I	infn = `{}`
	)

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

If padding is enabled, this always return true. If not, then it returns true of all the bits of the input are encoded in the output.

Definition at line 249 of file strencodings.h.

◆ DecodeBase32()

std::optional< std::vector< uint8_t > > DecodeBase32 ( std::string_view str )

Definition at line 208 of file strencodings.cpp.

Here is the caller graph for this function:

◆ DecodeBase64()

std::optional< std::vector< uint8_t > > DecodeBase64 ( std::string_view str )

Definition at line 148 of file strencodings.cpp.

Here is the caller graph for this function:

◆ EncodeBase32() [1/2]

std::string EncodeBase32	(	Span< const uint8_t >	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 189 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 204 of file strencodings.cpp.

Here is the call graph for this function:

◆ EncodeBase64() [1/3]

std::string EncodeBase64 ( Span< const std::byte > input )

inline

Definition at line 66 of file strencodings.h.

Here is the call graph for this function:

◆ EncodeBase64() [2/3]

std::string EncodeBase64 ( Span< const uint8_t > input )

Definition at line 134 of file strencodings.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EncodeBase64() [3/3]

std::string EncodeBase64 ( std::string_view str )

inline

Definition at line 69 of file strencodings.h.

Here is the call graph for this function:

◆ FormatParagraph()

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

Here is the caller graph for this function:

◆ HexDigit()

signed char HexDigit ( char c )

Definition at line 59 of file strencodings.cpp.

Here is the caller graph for this function:

◆ HexStr() [1/3]

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

inline

Definition at line 191 of file strencodings.h.

Here is the call graph for this function:

◆ HexStr() [2/3]

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

inline

Definition at line 194 of file strencodings.h.

Here is the call graph for this function:

◆ HexStr() [3/3]

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

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

Definition at line 543 of file strencodings.cpp.

Here is the call graph for this function:

◆ IsDigit()

constexpr bool IsDigit ( char c )

constexpr

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 98 of file strencodings.h.

Here is the caller graph for this function:

◆ IsHex()

bool IsHex ( std::string_view str )

Returns true if each character in str is a hex character, and has an even number of hex digits.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsSpace()

constexpr bool IsSpace ( char c )

inlineconstexprnoexcept

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

Definition at line 114 of file strencodings.h.

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.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseHex()

template<typename Byte = uint8_t>

std::vector< Byte > ParseHex ( std::string_view hex_str )

Like TryParseHex, but returns an empty vector on invalid input.

Definition at line 51 of file strencodings.h.

◆ 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 276 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 280 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 288 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 292 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 296 of file strencodings.cpp.

◆ 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 284 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()

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

Definition at line 109 of file strencodings.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 209 of file strencodings.h.

Here is the caller graph for this function:

◆ ToIntegral()

template<typename T >

std::optional< T > ToIntegral ( std::string_view str )

Convert string to integral type T.

Leading whitespace, a leading +, or any trailing character fail the parsing. The required format expressed as regex is -?[0-9]+.

Returns: std::nullopt if the entire string could not be parsed, or if the parsed value is not in the range representable by the type T.

Definition at line 127 of file strencodings.h.

◆ ToLower() [1/2]

constexpr char ToLower ( char c )

constexpr

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. This is a feature, not a limitation.

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 289 of file strencodings.h.

◆ ToLower() [2/2]

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ToUpper() [1/2]

constexpr char ToUpper ( char c )

constexpr

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. This is a feature, not a limitation.

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 314 of file strencodings.h.

◆ ToUpper() [2/2]

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TryParseHex()

template<typename Byte = std::byte>

std::optional< std::vector< Byte > > 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 86 of file strencodings.cpp.

Here is the call graph for this function:

Enumerations

Functions

Enumeration Type Documentation

◆ SafeChars

Function Documentation

◆ atoi()

◆ atoi64()

◆ Capitalize()

◆ ConvertBits()

◆ DecodeBase32()

◆ DecodeBase64()

◆ EncodeBase32() [1/2]

◆ EncodeBase32() [2/2]

◆ EncodeBase64() [1/3]

◆ EncodeBase64() [2/3]

◆ EncodeBase64() [3/3]

◆ FormatParagraph()

◆ HexDigit()

◆ HexStr() [1/3]

◆ HexStr() [2/3]

◆ HexStr() [3/3]

◆ IsDigit()

◆ IsHex()

◆ IsHexNumber()

◆ IsSpace()

◆ ParseFixedPoint()

◆ ParseHex()

◆ ParseInt32()

◆ ParseInt64()

◆ ParseUInt16()

◆ ParseUInt32()

◆ ParseUInt64()

◆ ParseUInt8()

◆ SanitizeString()

◆ SplitHostPort()

◆ TimingResistantEqual()

◆ ToIntegral()

◆ ToLower() [1/2]

◆ ToLower() [2/2]

◆ ToUpper() [1/2]

◆ ToUpper() [2/2]

◆ TryParseHex()