#include <crypto/hex_base.h>
#include <span.h>
#include <util/string.h>
#include <array>
#include <bit>
#include <charconv>
#include <cstddef>
#include <cstdint>
#include <limits>
#include <optional>
#include <string>
#include <string_view>
#include <system_error>
#include <type_traits>
#include <vector>

Include dependency graph for strencodings.h:

Classes
struct	util::detail::Hex< N >

Namespaces
namespace	util

namespace	util::detail

namespace	util::hex_literals
	""_hex is a compile-time user-defined literal returning a `std::array<std::byte>`, equivalent to ParseHex().

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

enum class	ByteUnit : uint64_t { NOOP = 1ULL , k = 1000ULL , K = 1024ULL , m = 1'000'000ULL , M = 1ULL << 20 , g = 1'000'000'000ULL , G = 1ULL << 30 , t = 1'000'000'000'000ULL , T = 1ULL << 40 }
	Used by ParseByteUnits() Lowercase base 1000 Uppercase base 1024. 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...

bool	IsHex (std::string_view str)

std::optional< std::vector< unsigned char > >	DecodeBase64 (std::string_view str)

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

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

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

std::optional< std::vector< unsigned char > >	DecodeBase32 (std::string_view str)

std::string	EncodeBase32 (std::span< const unsigned char > input, bool pad=true)
	Base32 encode. More...

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

bool	SplitHostPort (std::string_view in, uint16_t &portOut, std::string &hostOut)
	Splits socket address string into host string and port value. More...

template<typename T >
T	LocaleIndependentAtoi (std::string_view 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...

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

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

consteval uint8_t	util::ConstevalHexDigit (const char c)
	consteval version of HexDigit() without the lookup table. More...

template<util::detail::Hex str>
constexpr auto	util::hex_literals::operator""_hex ()

template<util::detail::Hex str>
constexpr auto	util::hex_literals::operator""_hex_u8 ()

template<util::detail::Hex str>
constexpr auto	util::hex_literals::operator""_hex_v ()

template<util::detail::Hex str>
auto	util::hex_literals::operator""_hex_v_u8 ()

Enumeration Type Documentation

◆ ByteUnit

enum class ByteUnit : uint64_t

strong

Used by ParseByteUnits() Lowercase base 1000 Uppercase base 1024.

Enumerator
NOOP
k
K
m
M
g
G
t
T

Definition at line 43 of file strencodings.h.

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

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

Definition at line 227 of file strencodings.h.

◆ DecodeBase32()

std::optional< std::vector< unsigned char > > DecodeBase32 ( std::string_view str )

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

Here is the caller graph for this function:

◆ EncodeBase32() [1/2]

std::string EncodeBase32	(	std::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 144 of file strencodings.cpp.

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

Here is the call graph for this function:

◆ EncodeBase64() [1/3]

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

inline

Definition at line 77 of file strencodings.h.

Here is the call graph for this function:

◆ EncodeBase64() [2/3]

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

Definition at line 98 of file strencodings.cpp.

Here is the caller graph for this function:

◆ EncodeBase64() [3/3]

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

inline

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

Here is the call graph for this function:

Here is the caller 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 149 of file strencodings.h.

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:

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

Here is the caller graph for this function:

◆ LocaleIndependentAtoi()

template<typename T >

T LocaleIndependentAtoi ( std::string_view str )

Definition at line 117 of file strencodings.h.

Here is the call 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 386 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 271 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 68 of file strencodings.h.

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 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 201 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]+. The minus sign is only permitted for signed integer types.

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 178 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 261 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 363 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 287 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 371 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 50 of file strencodings.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Classes

Namespaces

Enumerations

Functions

Enumeration Type Documentation

◆ ByteUnit

◆ SafeChars

Function Documentation

◆ Capitalize()

◆ ConvertBits()

◆ DecodeBase32()

◆ DecodeBase64()

◆ EncodeBase32() [1/2]

◆ EncodeBase32() [2/2]

◆ EncodeBase64() [1/3]

◆ EncodeBase64() [2/3]

◆ EncodeBase64() [3/3]

◆ FormatParagraph()

◆ IsDigit()

◆ IsHex()

◆ IsSpace()

◆ LocaleIndependentAtoi()

◆ ParseByteUnits()

◆ ParseFixedPoint()

◆ ParseHex()

◆ SanitizeString()

◆ SplitHostPort()

◆ TimingResistantEqual()

◆ ToIntegral()

◆ ToLower() [1/2]

◆ ToLower() [2/2]

◆ ToUpper() [1/2]

◆ ToUpper() [2/2]

◆ TryParseHex()