KittyUtils::String Namespace Reference

Provides utility functions for strings. More...

Functions
bool	charEqualsIgnoreCase (char a, char b)
	Helper to compare two characters case-insensitively.
bool	startsWith (const std::string &str, const std::string &prefix, bool sensitive=true)
	Checks if a string starts with a given prefix.
bool	startsWith (const std::string &str, const std::vector< std::string > &prefixes, bool sensitive=true)
	Checks if a string starts with any of the given prefixes.
bool	contains (const std::string &str, const std::string &substring, bool sensitive=true)
	Checks if a string contains a given substring.
bool	contains (const std::string &str, const std::vector< std::string > &substrings, bool sensitive=true)
	Checks if a string contains any of the given substrings.
bool	endsWith (const std::string &str, const std::string &suffix, bool sensitive=true)
	Checks if a string ends with a given suffix.
bool	endsWith (const std::string &str, const std::vector< std::string > &suffixes, bool sensitive=true)
	Checks if a string ends with any of the given suffixes.
void	trim (std::string &str)
	Trims whitespace from the beginning and end of a string.
void	removeAllWhitespace (std::string &str)
	Removes all whitespace characters from a string, not just leading/trailing.
bool	isValidHex (const std::string &hex)
	Checks if the provided string is a valid hexadecimal representation.
bool	validateHex (std::string &hex)
	Validates a hexadecimal string.
std::string	fmt (const char *fmt,...)
	Formats a string using a printf-style format.

Detailed Description

Provides utility functions for strings.

Function Documentation

contains() [1/2]

bool KittyUtils::String::contains	(	const std::string &	str,
		const std::string &	substring,
		bool	sensitive = true )

Checks if a string contains a given substring.

Parameters

str	The string to check.
substring	The substring to look for.
sensitive	Whether the comparison should be case-sensitive (default is true).

Returns

true if str contains substring, false otherwise.

contains() [2/2]

bool KittyUtils::String::contains	(	const std::string &	str,
		const std::vector< std::string > &	substrings,
		bool	sensitive = true )

Checks if a string contains any of the given substrings.

Parameters

str	The string to check.
substrings	A list of substrings to look for.
sensitive	Whether the comparison should be case-sensitive (default is true).

Returns

true if str contains at least one substring in substrings, false otherwise.

endsWith() [1/2]

bool KittyUtils::String::endsWith	(	const std::string &	str,
		const std::string &	suffix,
		bool	sensitive = true )

Checks if a string ends with a given suffix.

Parameters

str	The string to check.
suffix	The suffix to look for.
sensitive	Whether the comparison should be case-sensitive (default is true).

Returns

true if str ends with suffix, false otherwise.

endsWith() [2/2]

bool KittyUtils::String::endsWith	(	const std::string &	str,
		const std::vector< std::string > &	suffixes,
		bool	sensitive = true )

Checks if a string ends with any of the given suffixes.

Parameters

str	The string to check.
suffixes	A list of suffixes to look for.
sensitive	Whether the comparison should be case-sensitive (default is true).

Returns

true if str ends with at least one suffix in suffixes, false otherwise.

fmt()

std::string KittyUtils::String::fmt	(	const char *	fmt,
			... )

Formats a string using a printf-style format.

Parameters

fmt	The format string.
...	Variable arguments to be formatted.

Returns

The formatted string.

Here is the call graph for this function:

Here is the caller graph for this function:

isValidHex()

bool KittyUtils::String::isValidHex

(

const std::string &

hex

)

Checks if the provided string is a valid hexadecimal representation.

This function validates if the given string is a valid hexadecimal number. A valid hexadecimal number can contain characters '0'-'9' and 'A-F' or 'a-f'.

Parameters

hex	The string to validate as a hexadecimal number.

Returns

true if the string is a valid hexadecimal number, false otherwise.

removeAllWhitespace()

void KittyUtils::String::removeAllWhitespace

(

std::string &

str

)

Removes all whitespace characters from a string, not just leading/trailing.

Parameters

str	The string to strip whitespace from.

startsWith() [1/2]

bool KittyUtils::String::startsWith	(	const std::string &	str,
		const std::string &	prefix,
		bool	sensitive = true )

Checks if a string starts with a given prefix.

Parameters

str	The string to check.
prefix	The prefix to look for.
sensitive	Whether the comparison should be case-sensitive (default is true).

Returns

true if str starts with prefix, false otherwise.

startsWith() [2/2]

bool KittyUtils::String::startsWith	(	const std::string &	str,
		const std::vector< std::string > &	prefixes,
		bool	sensitive = true )

Checks if a string starts with any of the given prefixes.

Parameters

str	The string to check.
prefixes	A list of prefixes to look for.
sensitive	Whether the comparison should be case-sensitive (default is true).

Returns

true if str starts with at least one prefix in prefixes, false otherwise.

trim()

void KittyUtils::String::trim

(

std::string &

str

)

Trims whitespace from the beginning and end of a string.

Parameters

str	The string to be trimmed.

validateHex()

bool KittyUtils::String::validateHex

(

std::string &

hex

)

Validates a hexadecimal string.

Parameters

hex	The hexadecimal string to validate.

Returns

True if the string was validated, false otherwise.