rack::string Namespace Reference

Supplemental std::string functions. More...

Classes
struct	CaseInsensitiveCompare
struct	Version
	Structured version string, for comparison. More...

Functions
__attribute__((format(printf, 1, 2))) std std::string	fV (const char *format, va_list args)
	Converts a printf format string and optional arguments into a std::string.
template<typename T>
T	convertFArg (const T &t)
const char *	convertFArg (const std::string &s)
template<typename... Args>
std::string	f (Args... args)
std::string	lowercase (const std::string &s)
	Replaces all characters to lowercase letters.
std::string	uppercase (const std::string &s)
	Replaces all characters to uppercase letters.
std::string	trim (const std::string &s)
	Removes whitespace from beginning and end of string.
std::string	truncate (const std::string &s, size_t maxCodepoints)
	Truncates a string to not exceed a number of UTF-8 codepoints.
std::string	truncatePrefix (const std::string &s, size_t maxCodepoints)
	Truncates the beginning of a string to not exceed a number of UTF-8 codepoints.
std::string	ellipsize (const std::string &s, size_t maxCodepoints)
	Truncates and adds "…" to the end of a string, to not exceed a number of UTF-8 codepoints.
std::string	ellipsizePrefix (const std::string &s, size_t maxCodepoints)
	Truncates and adds "…" to the beginning of a string, to not exceed a number of UTF-8 codepoints.
bool	startsWith (const std::string &str, const std::string &prefix)
	Returns whether a string starts with the given substring.
bool	endsWith (const std::string &str, const std::string &suffix)
	Returns whether a string ends with the given substring.
std::string	toBase64 (const uint8_t *data, size_t dataLen)
	Converts a byte array to a Base64-encoded string.
std::string	toBase64 (const std::vector< uint8_t > &data)
std::vector< uint8_t >	fromBase64 (const std::string &str)
	Converts a Base64-encoded string to a byte array.
template<typename TContainer>
std::string	join (const TContainer &container, std::string seperator="")
	Joins an container (vector, list, etc) of std::strings with an optional separator string.
std::vector< std::string >	split (const std::string &s, const std::string &seperator, size_t maxTokens=0)
	Splits a string into a vector of tokens.
std::string	formatTime (const char *format, double timestamp)
	Formats a UNIX timestamp with a strftime() string.
std::string	formatTimeISO (double timestamp)
std::string	UTF32toUTF8 (const std::u32string &s32)
	Converts a UTF-32 string to a UTF-8 string.
std::u32string	UTF8toUTF32 (const std::string &s8)
	Converts a UTF-8 string to a UTF-32 string.
size_t	UTF8NextCodepoint (const std::string &s8, size_t pos)
	Finds the byte position of the next codepoint in a valid UTF-8 string.
size_t	UTF8PrevCodepoint (const std::string &s8, size_t pos)
	Finds the byte position of the previous codepoint in a valid UTF-8 string.
size_t	UTF8Length (const std::string &s8)
	Returns the number of codepoints in a valid UTF-8 string.
size_t	UTF8CodepointIndex (const std::string &s8, size_t pos)
	Returns a codepoint's index in a valid UTF-8 string.
size_t	UTF8CodepointPos (const std::string &s8, size_t index)
	Returns a codepoint's byte position in a valid UTF-8 string.
std::string	translate (const std::string &id)
	Returns translation string of the current language setting from translations/<language>.json, or English if not found.
std::string	translate (const std::string &id, const std::string &language)
	Returns translation string of the given language, or "" if not found.
std::vector< std::string >	getLanguages ()
	Returns ISO 639-1 language codes of loaded translations, sorted by name of language.
void	init ()

Detailed Description

Supplemental std::string functions.

Function Documentation

fV()

__attribute__((format(printf, 1, 2))) std std::string rack::string::fV	(	const char *	format,
		va_list	args )

Converts a printf format string and optional arguments into a std::string.

The wrapper template function below automatically converts all arguments (including format string) from std::string to const char* as needed.

convertFArg() [1/2]

template<typename T>

T rack::string::convertFArg

(

const T &

t

)

convertFArg() [2/2]

const char * rack::string::convertFArg ( const std::string & s )

inline

f()

template<typename... Args>

std::string rack::string::f

(

Args...

args

)

lowercase()

std::string rack::string::lowercase

(

const std::string &

s

)

Replaces all characters to lowercase letters.

uppercase()

std::string rack::string::uppercase

(

const std::string &

s

)

Replaces all characters to uppercase letters.

trim()

std::string rack::string::trim

(

const std::string &

s

)

Removes whitespace from beginning and end of string.

truncate()

std::string rack::string::truncate	(	const std::string &	s,
		size_t	maxCodepoints )

Truncates a string to not exceed a number of UTF-8 codepoints.

truncatePrefix()

std::string rack::string::truncatePrefix	(	const std::string &	s,
		size_t	maxCodepoints )

Truncates the beginning of a string to not exceed a number of UTF-8 codepoints.

ellipsize()

std::string rack::string::ellipsize	(	const std::string &	s,
		size_t	maxCodepoints )

Truncates and adds "…" to the end of a string, to not exceed a number of UTF-8 codepoints.

ellipsizePrefix()

std::string rack::string::ellipsizePrefix	(	const std::string &	s,
		size_t	maxCodepoints )

Truncates and adds "…" to the beginning of a string, to not exceed a number of UTF-8 codepoints.

startsWith()

bool rack::string::startsWith	(	const std::string &	str,
		const std::string &	prefix )

Returns whether a string starts with the given substring.

endsWith()

bool rack::string::endsWith	(	const std::string &	str,
		const std::string &	suffix )

Returns whether a string ends with the given substring.

toBase64() [1/2]

std::string rack::string::toBase64	(	const uint8_t *	data,
		size_t	dataLen )

Converts a byte array to a Base64-encoded string.

https://en.wikipedia.org/wiki/Base64

toBase64() [2/2]

std::string rack::string::toBase64

(

const std::vector< uint8_t > &

data

)

fromBase64()

std::vector< uint8_t > rack::string::fromBase64

(

const std::string &

str

)

Converts a Base64-encoded string to a byte array.

Throws std::runtime_error if string is invalid.

join()

template<typename TContainer>

std::string rack::string::join	(	const TContainer &	container,
		std::string	seperator = "" )

Joins an container (vector, list, etc) of std::strings with an optional separator string.

split()

std::vector< std::string > rack::string::split	(	const std::string &	s,
		const std::string &	seperator,
		size_t	maxTokens = 0 )

Splits a string into a vector of tokens.

If maxTokens > 0, limits the number of tokens. Tokens do not include the separator string. Examples: split("a+b+c", "+") // {"a", "b", "c"} split("abc", "+") // {"abc"} split("a++c", "+") // {"a", "", "c"} split("", "+") // {} split("abc", "") // throws rack::Exception

formatTime()

std::string rack::string::formatTime	(	const char *	format,
		double	timestamp )

Formats a UNIX timestamp with a strftime() string.

formatTimeISO()

std::string rack::string::formatTimeISO

(

double

timestamp

)

UTF32toUTF8()

std::string rack::string::UTF32toUTF8

(

const std::u32string &

s32

)

Converts a UTF-32 string to a UTF-8 string.

Skips invalid UTF-32 codepoints (greater than 0x10FFFF).

UTF8toUTF32()

std::u32string rack::string::UTF8toUTF32

(

const std::string &

s8

)

Converts a UTF-8 string to a UTF-32 string.

Skips invalid, overlong, and surrogate pair UTF-8 sequences.

UTF8NextCodepoint()

size_t rack::string::UTF8NextCodepoint	(	const std::string &	s8,
		size_t	pos )

Finds the byte position of the next codepoint in a valid UTF-8 string.

pos is the byte position of the start of a codepoint. Returns s8.size() if given codepoint is the last.

UTF8PrevCodepoint()

size_t rack::string::UTF8PrevCodepoint	(	const std::string &	s8,
		size_t	pos )

Finds the byte position of the previous codepoint in a valid UTF-8 string.

pos is the byte position of the start of a codepoint. Returns 0 if given codepoint is the first.

UTF8Length()

size_t rack::string::UTF8Length

(

const std::string &

s8

)

Returns the number of codepoints in a valid UTF-8 string.

O(len) time

UTF8CodepointIndex()

size_t rack::string::UTF8CodepointIndex	(	const std::string &	s8,
		size_t	pos )

Returns a codepoint's index in a valid UTF-8 string.

pos is the byte position of the start of a codepoint. O(pos) time

UTF8CodepointPos()

size_t rack::string::UTF8CodepointPos	(	const std::string &	s8,
		size_t	index )

Returns a codepoint's byte position in a valid UTF-8 string.

Returns s8.size() if index is beyond the last codepoint. O(index) time

translate() [1/2]

std::string rack::string::translate

(

const std::string &

id

)

Returns translation string of the current language setting from translations/<language>.json, or English if not found.

translate() [2/2]

std::string rack::string::translate	(	const std::string &	id,
		const std::string &	language )

Returns translation string of the given language, or "" if not found.

getLanguages()

std::vector< std::string > rack::string::getLanguages

(

)

Returns ISO 639-1 language codes of loaded translations, sorted by name of language.

init()

void rack::string::init

(

)