API Reference

Library public interface header.

you all for your contributions!!

namespace strutil

The strutil namespace.

Functions

static inline std::string capitalize(const std::string &str)

Converts the first character of a string to uppercase letter and lowercases all other characters, if any.

Parameters:

str – - input string to be capitalized.

Returns:

A string with the first letter capitalized and all other characters lowercased. It doesn’t modify the input string.

static inline std::string capitalize_first_char(const std::string &str)

Converts only the first character of a string to uppercase letter, all other characters stay unchanged.

Parameters:

str – - input string to be modified.

Returns:

A string with the first letter capitalized. All other characters stay unchanged. It doesn’t modify the input string.

static inline bool compare_ignore_case(const std::string &str1, const std::string &str2)

Compares two std::strings ignoring their case (lower/upper).

Parameters:

• str1 – - std::string to compare

• str2 – - std::string to compare

Returns:

True if str1 and str2 are equal, false otherwise.

static inline bool contains(const std::string &str, const char character)

Checks if input std::string str contains specified character.

Parameters:

• str – - std::string to be checked.

• character – - searched character.

Returns:

True if character was found in str, false otherwise.

static inline bool contains(const std::string &str, const std::string &substring)

Checks if input std::string str contains specified substring.

Parameters:

• str – - std::string to be checked.

• substring – - searched substring.

Returns:

True if substring was found in str, false otherwise.

template<typename T>
static inline void drop_duplicate(std::vector<T> &tokens)

Inplace removal of all duplicate strings in a vector<string> where order is not to be maintained Taken from: C++ Primer V5.

Template Parameters:

T – - arbitrary datatype.

Parameters:

tokens – - vector of strings.

Returns:

vector of non-duplicate tokens.

template<typename T>
static inline std::vector<T> drop_duplicate_copy(std::vector<T> tokens)

Removal of all duplicate strings in a vector<string> where order is not to be maintained Taken from: C++ Primer V5.

Template Parameters:

T – - arbitrary datatype.

Parameters:

tokens – - vector of strings.

Returns:

vector of non-duplicate tokens.

template<template<typename, typename...> typename Container, typename ...Args>
static inline void drop_empty(Container<std::string, Args...> &tokens)

Inplace removal of all empty strings in a container of strings.

Template Parameters:

Container – - container type.

Parameters:

tokens – - container of strings.

template<template<typename, typename...> typename Container, typename ...Args>
static inline Container<std::string> drop_empty_copy(Container<std::string, Args...> tokens)

Inplace removal of all empty strings in a container of strings.

Template Parameters:

container – - container type.

Parameters:

tokens – - container of strings.

Returns:

container of non-empty tokens.

static inline bool ends_with(const std::string &str, const char suffix)

Checks if std::string str ends with specified character.

Parameters:

• str – - input std::string that will be checked.

• suffix – - searched character in str.

Returns:

True if ends with character, false otherwise.

static inline bool ends_with(const std::string &str, const std::string &suffix)

Checks if std::string str ends with specified suffix.

Parameters:

• str – - input std::string that will be checked.

• suffix – - searched suffix in str.

Returns:

True if suffix was found, false otherwise.

template<typename Container>
static inline std::string join(const Container &tokens, const std::string &delim)

Joins all elements of a container of arbitrary datatypes into one std::string with delimiter delim.

Template Parameters:

Container – - container type.

Parameters:

• tokens – - container of tokens.

• delim – - the delimiter.

Returns:

std::string with joined elements of container tokens with delimiter delim.

static inline bool matches(const std::string &str, const std::regex &regex)

Checks if input std::string str matches specified reular expression regex.

Parameters:

• str – - std::string to be checked.

• regex – - the std::regex regular expression.

Returns:

True if regex matches str, false otherwise.

template<typename T>
static inline T parse_string(const std::string &str)

Converts std::string into any datatype. Datatype must support << operator.

Template Parameters:

T –

Parameters:

str – - std::string that will be converted into datatype T.

Returns:

Variable of datatype T.

static inline std::vector<std::string> regex_split(const std::string &src, const std::string &rgx_str)

Splits input string using regex as a delimiter.

Parameters:

• src – - std::string that will be split.

• rgx_str – - the set of delimiter characters.

Returns:

vector of resulting tokens.

static inline std::map<std::string, std::string> regex_split_map(const std::string &src, const std::string &rgx_str)

Splits input string using regex as a delimiter.

Parameters:

• src – - std::string that will be split.

• dest – - map of matched delimiter and those being splitted.

• rgx_str – - the set of delimiter characters.

Returns:

True if the parsing is successfully done.

static inline std::string repeat(char c, unsigned n)

Creates new std::string with repeated n times char c.

Parameters:

• c – - char that needs to be repeated.

• n – - number of iterations.

Returns:

std::string with repeated char c.

static inline std::string repeat(const std::string &str, unsigned n)

Creates new std::string with repeated n times substring str.

Parameters:

• str – - substring that needs to be repeated.

• n – - number of iterations.

Returns:

std::string with repeated substring str.

static inline bool replace_all(std::string &str, const std::string &target, const std::string &replacement)

Replaces (in-place) all occurrences of target with replacement. Taken from: http://stackoverflow.com/questions/3418231/c-replace-part-of-a-string-with-another-string.

Parameters:

• str – - input std::string that will be modified.

• target – - substring that will be replaced with replacement.

• replacement – - substring that will replace target.

Returns:

True if replacement was successfull, false otherwise.

static inline bool replace_first(std::string &str, const std::string &target, const std::string &replacement)

Replaces (in-place) the first occurrence of target with replacement. Taken from: http://stackoverflow.com/questions/3418231/c-replace-part-of-a-string-with-another-string.

Parameters:

• str – - input std::string that will be modified.

• target – - substring that will be replaced with replacement.

• replacement – - substring that will replace target.

Returns:

True if replacement was successfull, false otherwise.

static inline bool replace_last(std::string &str, const std::string &target, const std::string &replacement)

Replaces (in-place) last occurrence of target with replacement. Taken from: http://stackoverflow.com/questions/3418231/c-replace-part-of-a-string-with-another-string.

Parameters:

• str – - input std::string that will be modified.

• target – - substring that will be replaced with replacement.

• replacement – - substring that will replace target.

Returns:

True if replacement was successfull, false otherwise.

template<typename Container>
static inline Container reverse_copy(Container strs)

Reverse input container strs.

Parameters:

strs – - container to be checked.

template<typename Container>
static inline void reverse_inplace(Container &strs)

Reverse input container strs.

Parameters:

strs – - container to be checked.

template<typename T>
static inline void sorting_ascending(std::vector<T> &strs)

Sort input std::vector<std::string> strs in ascending order.

Parameters:

strs – - std::vector<std::string> to be checked.

template<typename T>
static inline void sorting_descending(std::vector<T> &strs)

Sorted input std::vector<std::string> strs in descending order.

Parameters:

strs – - std::vector<std::string> to be checked.

static inline std::vector<std::string> split(const std::string &str, const char delim)

Splits input std::string str according to input delim.

Parameters:

• str – - std::string that will be splitted.

• delim – - the delimiter.

Returns:

std::vector<std::string> that contains all splitted tokens.

static inline std::vector<std::string> split(const std::string &str, const std::string &delim)

Splits input std::string str according to input std::string delim. Taken from: https://stackoverflow.com/a/46931770/1892346.

Parameters:

• str – - std::string that will be split.

• delim – - the delimiter.

Returns:

std::vector<std::string> that contains all splitted tokens.

static inline std::vector<std::string> split_any(const std::string &str, const std::string &delims)

Splits input string using any delimiter in the given set.

Parameters:

• str – - std::string that will be split.

• delims – - the set of delimiter characters.

Returns:

vector of resulting tokens.

static inline bool starts_with(const std::string &str, const char prefix)

Checks if std::string str starts with specified character.

Parameters:

• str – - input std::string that will be checked.

• prefix – - searched character in str.

Returns:

True if starts with character, false otherwise.

static inline bool starts_with(const std::string &str, const std::string &prefix)

Checks if std::string str starts with specified prefix.

Parameters:

• str – - input std::string that will be checked.

• prefix – - searched prefix in str.

Returns:

True if prefix was found, false otherwise.

static inline std::string to_lower(const std::string &str)

Converts std::string to lower case.

Parameters:

str – - std::string that needs to be converted.

Returns:

Lower case input std::string.

template<typename T>
static inline std::string to_string(T value)

Converts any datatype into std::string. Datatype must support << operator.

Template Parameters:

T –

Parameters:

value – - will be converted into std::string.

Returns:

Converted value as std::string.

static inline std::string to_upper(const std::string &str)

Converts std::string to upper case.

Parameters:

str – - std::string that needs to be converted.

Returns:

Upper case input std::string.

static inline void trim(std::string &str)

Trims (in-place) white spaces from the both sides of std::string. Taken from: http://stackoverflow.com/questions/216823/whats-the-best-way-to-trim-stdstring.

Parameters:

str – - input std::string to remove white spaces from.

static inline std::string trim_copy(std::string str)

Trims white spaces from the both sides of std::string. Taken from: http://stackoverflow.com/questions/216823/whats-the-best-way-to-trim-stdstring.

Parameters:

str – - input std::string to remove white spaces from.

Returns:

Copy of input str with trimmed white spaces.

static inline void trim_left(std::string &str)

Trims (in-place) white spaces from the left side of std::string. Taken from: http://stackoverflow.com/questions/216823/whats-the-best-way-to-trim-stdstring.

Parameters:

str – - input std::string to remove white spaces from.

static inline std::string trim_left_copy(std::string str)

Trims white spaces from the left side of std::string. Taken from: http://stackoverflow.com/questions/216823/whats-the-best-way-to-trim-stdstring.

Parameters:

str – - input std::string to remove white spaces from.

Returns:

Copy of input str with trimmed white spaces.

static inline void trim_right(std::string &str)

Trims (in-place) white spaces from the right side of std::string. Taken from: http://stackoverflow.com/questions/216823/whats-the-best-way-to-trim-stdstring.

Parameters:

str – - input std::string to remove white spaces from.

static inline std::string trim_right_copy(std::string str)

Trims white spaces from the right side of std::string. Taken from: http://stackoverflow.com/questions/216823/whats-the-best-way-to-trim-stdstring.

Parameters:

str – - input std::string to remove white spaces from.

Returns:

Copy of input str with trimmed white spaces.