#include "common/DataTypes.hpp"
#include <iomanip>
#include <sstream>

Namespaces
	geos

Functions
string	geos::stringutilities::toLower (string const &input)
	Return a copy of the string in lower case. More...

template<typename IT , typename S = char>
string	geos::stringutilities::join (IT first, IT last, S const &delim=S())
	Join strings or other printable objects with a delimiter. More...

template<typename CONTAINER , typename S = char>
string	geos::stringutilities::join (CONTAINER const &container, S const &delim=S())
	Join strings or other printable objects with a delimiter. More...

template<typename IT , typename S , typename LAMBDA >
string	geos::stringutilities::joinLambda (IT first, IT last, S const &delim, LAMBDA formattingFunc)
	Join strings or other printable objects returned by a formatter functor. More...

template<typename CONTAINER , typename S , typename LAMBDA >
string	geos::stringutilities::joinLambda (CONTAINER const &container, S const &delim, LAMBDA formattingFunc)
	Join strings or other printable objects returned by a formatter functor. More...

template<typename S = char, typename T , typename ... Ts>
string	geos::stringutilities::concat (S const &delim, T const &v, Ts const &... vs)
	Concatenate variadic arguments into a string with a delimiter. More...

template<template< class ... > class CONTAINER = stdVector>
CONTAINER< string >	geos::stringutilities::tokenize (string_view str, string_view delimiters, bool const treatConsecutiveDelimAsOne=true, bool const preTrimStr=false)
	Subdivide the string in substrings by the specified delimiters. More...

template<template< class ... > class CONTAINER = stdVector>
CONTAINER< string >	geos::stringutilities::tokenizeBySpaces (string_view str)
	Subdivide the string in substrings by whitespaces separators (see std::isspace()). Do not create any empty substrings. More...

string_view	geos::stringutilities::trim (string_view str, string_view charsToRemove)
	Trim the string. More...

string_view	geos::stringutilities::ltrimSpaces (string_view s)
	Trim the left string. More...

string_view	geos::stringutilities::trimSpaces (string_view str)
	Trim the string so it does not starts nor ends with any whitespaces. More...

string	geos::stringutilities::removeStringAndFollowingContent (string_view str, string_view strToRemove)
	Search for a string in the line, and return the line truncated before the string. More...

template<typename T >
string	geos::stringutilities::addCommaSeparators (T const &num)
	Add comma separators to an integral number for readability. More...

template<typename STRING_T >
stdVector< STRING_T >	geos::stringutilities::divideLines (size_t &linesWidth, string_view value)
	Divides a string by newline characters and returns a vector of strings containing each line. Also calculates the width of the widest line. More...

template<typename STRING_T >
stdVector< STRING_T >	geos::stringutilities::wrapTextToMaxLength (stdVector< STRING_T > const &lines, size_t &maxLineLength)
	Format all the lines by detecting spaces and by dividing each lines with maximum length specified. If a word has a greater size than maxLength, it will be cut in one or many parts. More...

string	geos::stringutilities::wrapTextToMaxLength (string_view text, size_t maxLineLength)
	Format all the lines by detecting spaces and by dividing each lines with maximum length specified. If a word has a greater size than maxLength, it will be cut in one or many parts. More...

template<typename T >
array1d< T >	geos::stringutilities::fromStringToArray (string const &str)
	Take a string, and return a array1d with the cast values. More...

template<typename T >
string	geos::stringutilities::toMetricPrefixString (T const &value)
	Take a numerical value and convert/scale it to a string with a metric prefix. i.e. Kilo, Mega, Giga, Tera, Peta, Exa. More...

constexpr size_t	geos::stringutilities::cstrlen (char const *const str)

constexpr bool	geos::stringutilities::startsWith (std::string_view str, std::string_view prefix)

constexpr bool	geos::stringutilities::endsWith (std::string_view str, std::string_view suffix)

template<typename T >
std::ostream &	geos::stringutilities::operator<< (std::ostream &os, std::optional< T > const &optValue)
	Overloading operator (<<) for std::optional<T>. More...

Function Documentation

◆ addCommaSeparators()

template<typename T >

string geos::stringutilities::addCommaSeparators ( T const & num )

Add comma separators to an integral number for readability.

Template Parameters

T	the integral type of the number to format.

Parameters

[in] num the integral number to format.

Returns: a string representation of the number with comma separators.

◆ concat()

template<typename S = char, typename T , typename ... Ts>

string geos::stringutilities::concat	(	S const &	delim,
		T const &	v,
		Ts const &...	vs
	)

Concatenate variadic arguments into a string with a delimiter.

Template Parameters

S	type of delimiter (printable to std::ostringstream)
T	type of first argument (printable to std::ostringstream)
Ts	types of remaining arguments (printable to std::ostringstream)

Parameters

delim	delimiter
v	first value
vs	remaining values

Returns: string containing concatenated printed arguments

Definition at line 133 of file StringUtilities.hpp.

◆ cstrlen()

constexpr size_t geos::stringutilities::cstrlen ( char const *const str )

constexpr

Returns: The length of a constant string computed at compile-time.

Parameters

str	The null-character terminated constant string

Todo:: c++17: this function is to remove in favor of std::string_view

Definition at line 317 of file StringUtilities.hpp.

◆ divideLines()

template<typename STRING_T >

stdVector< STRING_T > geos::stringutilities::divideLines	(	size_t &	linesWidth,
		string_view	value
	)

Divides a string by newline characters and returns a vector of strings containing each line. Also calculates the width of the widest line.

Parameters

linesWidth	[out] Reference to a size_t that will be set to the width of the widest line
value	The input string to divide into lines

Template Parameters

STRING_T The type of the string (string or string_view)

Returns: A vector of STRING_T objects, each containing a single line from the input

◆ endsWith()

constexpr bool geos::stringutilities::endsWith	(	std::string_view	str,
		std::string_view	suffix
	)

constexpr

Returns: true if the string ends with the suffix.

Parameters

str	The string to compare
suffix	A suffix we want to know if the string ends with.

Definition at line 348 of file StringUtilities.hpp.

◆ fromStringToArray()

template<typename T >

array1d< T > geos::stringutilities::fromStringToArray ( string const & str )

Take a string, and return a array1d with the cast values.

Template Parameters

T	the type to which the string will be cast

Parameters

[in] str the string to turn into an array1d

Returns: the array1d that stores the cast values

Definition at line 288 of file StringUtilities.hpp.

◆ join() [1/2]

template<typename CONTAINER , typename S = char>

string geos::stringutilities::join	(	CONTAINER const &	container,
		S const &	delim = `S()`
	)

Join strings or other printable objects with a delimiter.

Template Parameters

CONTAINER	type of container to join
S	the type of delimiter, usually char, char const * or string

Parameters

container	the container to join
delim	delimiter used to glue together strings

Returns: a string containing input values concatenated with a delimiter

Definition at line 74 of file StringUtilities.hpp.

◆ join() [2/2]

template<typename IT , typename S = char>

string geos::stringutilities::join	(	IT	first,
		IT	last,
		S const &	delim = `S()`
	)

Join strings or other printable objects with a delimiter.

Template Parameters

IT	type of iterator into the range of objects to join
S	type of delimiter, usually char, char const * or string

Parameters

first	iterator to start of the range
last	iterator past-the-end of the range
delim	delimiter used to glue together strings

Returns: a string containing input values concatenated with a delimiter

Definition at line 50 of file StringUtilities.hpp.

◆ joinLambda() [1/2]

template<typename CONTAINER , typename S , typename LAMBDA >

string geos::stringutilities::joinLambda	(	CONTAINER const &	container,
		S const &	delim,
		LAMBDA	formattingFunc
	)

Join strings or other printable objects returned by a formatter functor.

Template Parameters

CONTAINER	type of container to join
S	type of delimiter, usually char, char const * or string
LAMBDA	type of formatter functor, usually `[]( auto it ) -> string`

Parameters

formattingFunc	formatter function to get a formattable value from an iterator of the container
container	container to join
delim	delimiter used to glue together strings

Returns: a string containing input values concatenated with a delimiter

Definition at line 117 of file StringUtilities.hpp.

◆ joinLambda() [2/2]

template<typename IT , typename S , typename LAMBDA >

string geos::stringutilities::joinLambda	(	IT	first,
		IT	last,
		S const &	delim,
		LAMBDA	formattingFunc
	)

Join strings or other printable objects returned by a formatter functor.

Template Parameters

IT	type of iterator into the range of objects to join
S	type of delimiter, usually char, char const * or string
LAMBDA	type of formatter functor, usually `[]( auto it ) -> string`

Parameters

formattingFunc	formatter function to get a formattable value from a IT iterator
first	iterator to start of the range
last	iterator past-the-end of the range
delim	delimiter used to glue together strings

Returns: a string containing input values concatenated with a delimiter

Definition at line 91 of file StringUtilities.hpp.

◆ ltrimSpaces()

string_view geos::stringutilities::ltrimSpaces ( string_view s )

Trim the left string.

Parameters

[in] s the string to trim

Returns: the trimmed string

◆ operator<<()

template<typename T >

std::ostream& geos::stringutilities::operator<<	(	std::ostream &	os,
		std::optional< T > const &	optValue
	)

Overloading operator (<<) for std::optional<T>.

This function displays the value contained in a std::optional<T> object if one exists. Otherwise, it produces no output.

Template Parameters

T	The type of the value contained std::optional.

Parameters

os	An output stream (for example, std::cout).
optValue	std::optional<T> value to display.

Returns: The output stream

Definition at line 366 of file StringUtilities.hpp.

◆ removeStringAndFollowingContent()

string geos::stringutilities::removeStringAndFollowingContent	(	string_view	str,
		string_view	strToRemove
	)

Search for a string in the line, and return the line truncated before the string.

Parameters

[in]	str	the line to truncate
[in]	strToRemove	the string to search for in the line

Returns: the new (truncated) string

◆ startsWith()

constexpr bool geos::stringutilities::startsWith	(	std::string_view	str,
		std::string_view	prefix
	)

constexpr

Returns: true if the string starts with the prefix.

Parameters

str	The string to compare
prefix	A prefix we want to know if the string starts with.

Definition at line 337 of file StringUtilities.hpp.

◆ tokenize()

template<template< class ... > class CONTAINER = stdVector>

CONTAINER< string > geos::stringutilities::tokenize	(	string_view	str,
		string_view	delimiters,
		bool const	treatConsecutiveDelimAsOne = `true`,
		bool const	preTrimStr = `false`
	)

Subdivide the string in substrings by the specified delimiters.

Template Parameters

CONTAINER The templated class of the results container (stdVector by default).

Parameters

str	The string to subdivide.
delimiters	String that contains the list of possible delimiters.
treatConsecutiveDelimAsOne	If enabled, consecutive delimiters will be treated as one. If not enabled, consecutive delimiters will result in empty entries.
preTrimStr	If enabled, delimiters at the borders of the string will be ignored. If not enabled, those delimiters will result in in empty entries.

Returns: The container of the divided substrings.

Definition at line 155 of file StringUtilities.hpp.

◆ tokenizeBySpaces()

template<template< class ... > class CONTAINER = stdVector>

CONTAINER< string > geos::stringutilities::tokenizeBySpaces ( string_view str )

Subdivide the string in substrings by whitespaces separators (see std::isspace()). Do not create any empty substrings.

Template Parameters

CONTAINER The templated class of the results container (stdVector by default).

Parameters

str	The string to subdivide.

Returns: CONTAINER< string > The list of the subdivided substrings (stdVector< string > for instance).

Definition at line 200 of file StringUtilities.hpp.

◆ toLower()

string geos::stringutilities::toLower ( string const & input )

Return a copy of the string in lower case.

Parameters

input The input string which is not modified.

Returns: A new string instance.

◆ toMetricPrefixString()

template<typename T >

string geos::stringutilities::toMetricPrefixString ( T const & value )

Take a numerical value and convert/scale it to a string with a metric prefix. i.e. Kilo, Mega, Giga, Tera, Peta, Exa.

Template Parameters

T	Type of the value to be converted

Parameters

value The value to be converted

Returns: String containging the scaled value.

◆ trim()

string_view geos::stringutilities::trim	(	string_view	str,
		string_view	charsToRemove
	)

Trim the string.

Parameters

[in]	str	the string to trim
[in]	charsToRemove	the list of characters to remove

Returns: the trimmed string

◆ trimSpaces()

string_view geos::stringutilities::trimSpaces ( string_view str )

Trim the string so it does not starts nor ends with any whitespaces.

Parameters

[in] str the string to trim

Returns: the trimmed string

◆ wrapTextToMaxLength() [1/2]

template<typename STRING_T >

stdVector< STRING_T > geos::stringutilities::wrapTextToMaxLength	(	stdVector< STRING_T > const &	lines,
		size_t &	maxLineLength
	)

Format all the lines by detecting spaces and by dividing each lines with maximum length specified. If a word has a greater size than maxLength, it will be cut in one or many parts.

Parameters

lines	Vector containing all the lines to be formatted.
maxLineLength	[inout] The max length a line can have. The value is then set to the effective maximum line length

Template Parameters

STRING_T The type of the string (string or string_view)

Returns: A vector containing the lines wrapped.

◆ wrapTextToMaxLength() [2/2]

string geos::stringutilities::wrapTextToMaxLength	(	string_view	text,
		size_t	maxLineLength
	)

Format all the lines by detecting spaces and by dividing each lines with maximum length specified. If a word has a greater size than maxLength, it will be cut in one or many parts.

Parameters

text	The input text to wrap
maxLineLength	[inout] The max length a line can have. The value is then set to the effective maximum line length

Template Parameters

STRING_T The type of the string (string or string_view)

Returns: A vector containing the lines wrapped.

Namespaces

Functions

Function Documentation

◆ addCommaSeparators()

◆ concat()

◆ cstrlen()

◆ divideLines()

◆ endsWith()

◆ fromStringToArray()

◆ join() [1/2]

◆ join() [2/2]

◆ joinLambda() [1/2]

◆ joinLambda() [2/2]

◆ ltrimSpaces()

◆ operator<<()

◆ removeStringAndFollowingContent()

◆ startsWith()

◆ tokenize()

◆ tokenizeBySpaces()

◆ toLower()

◆ toMetricPrefixString()

◆ trim()

◆ trimSpaces()

◆ wrapTextToMaxLength() [1/2]

◆ wrapTextToMaxLength() [2/2]