StringUtils Namespace Reference

Utility functions to analyze or modify strings. More...

Functions
std::string	join (const std::vector< std::string > &joinable, const std::string &joint)
	Returns string obtain by joining vector elements. More...
bool	matchesPattern (const std::string &text, const std::string &wildcardPattern)
	Returns true if text matches pattern with wildcards '*' and '?'. More...
std::string	padRight (const std::string &name, size_t length)
	Returns string right-padded with blanks. More...
std::string	removeSubstring (const std::string &text, const std::string &substr)
	Removes multiple occurrences of given substring from a string and returns result. More...
void	replaceItemsFromString (std::string &text, const std::vector< std::string > &items, const std::string &replacement="")
	Replaces all occurrences of items from string text with delimiter. More...
template<typename T >
std::string	scientific (const T value, int n=10)
	Returns scientific string representing given value of any numeric type. More...
std::vector< std::string >	split (const std::string &text, const std::string &delimeter)
	Split string into vector of string using delimeter. More...
std::string	to_lower (std::string text)
	Returns new string which is lower case of text. More...
std::string	trim (const std::string &str, const std::string &whitespace=" \t")
	Cuts any of the chars given in whitespace from start and end of str. More...

Detailed Description

Utility functions to analyze or modify strings.

Function Documentation

join()

std::string StringUtils::join	(	const std::vector< std::string > &	joinable,
		const std::string &	joint
	)

Returns string obtain by joining vector elements.

Definition at line 71 of file StringUtils.cpp.

{
    std::string result;
    size_t n = joinable.size();
    if (n == 0)
        return result;
    for (size_t i = 0; i < n - 1; ++i)
        result += joinable[i] + joint;
    result += joinable[n - 1];
    return result;
}

Referenced by pyfmt2::argumentList(), and pyfmt::printImportedSymbols().

matchesPattern()

bool StringUtils::matchesPattern	(	const std::string &	text,
		const std::string &	wildcardPattern
	)

Returns true if text matches pattern with wildcards '*' and '?'.

Definition at line 20 of file StringUtils.cpp.

{
    // escape all regex special characters, except '?' and '*'
    std::string mywildcardPattern = wildcardPattern;
    boost::replace_all(mywildcardPattern, "\\", "\\\\");
    boost::replace_all(mywildcardPattern, "^", "\\^");
    boost::replace_all(mywildcardPattern, ".", "\\.");
    boost::replace_all(mywildcardPattern, "$", "\\$");
    boost::replace_all(mywildcardPattern, "|", "\\|");
    boost::replace_all(mywildcardPattern, "(", "\\(");
    boost::replace_all(mywildcardPattern, ")", "\\)");
    boost::replace_all(mywildcardPattern, "[", "\\[");
    boost::replace_all(mywildcardPattern, "]", "\\]");
    boost::replace_all(mywildcardPattern, "+", "\\+");
    boost::replace_all(mywildcardPattern, "/", "\\/");
 
    // Convert chars '*?' to their regex equivalents
    boost::replace_all(mywildcardPattern, "?", ".");
    boost::replace_all(mywildcardPattern, "*", ".*");
 
    // constructing regexp pattern
    mywildcardPattern = "^" + mywildcardPattern + "$";
    std::regex pattern(mywildcardPattern);
 
    // applaying match
    return std::regex_match(text, pattern);
}

Referenced by ParameterPool::getMatchedParameters().

padRight()

std::string StringUtils::padRight	(	const std::string &	name,
		size_t	length
	)

Returns string right-padded with blanks.

Definition at line 49 of file StringUtils.cpp.

{
    std::string result = name;
    result.resize(length, ' ');
    return result;
}

References RealSpace::Particles::name().

Referenced by FitPrintService::parameterString().

Here is the call graph for this function:

removeSubstring()

std::string StringUtils::removeSubstring	(	const std::string &	text,
		const std::string &	substr
	)

Removes multiple occurrences of given substring from a string and returns result.

Definition at line 83 of file StringUtils.cpp.

{
    std::string result = text;
    for (std::string::size_type i = result.find(substr); i != std::string::npos;
         i = result.find(substr))
        result.erase(i, substr.length());
    return result;
}

replaceItemsFromString()

void StringUtils::replaceItemsFromString	(	std::string &	text,
		const std::vector< std::string > &	items,
		const std::string &	replacement = ""
	)

Replaces all occurrences of items from string text with delimiter.

Definition at line 64 of file StringUtils.cpp.

{
    for (size_t i = 0; i < items.size(); ++i)
        boost::replace_all(text, items[i], replacement);
}

scientific()

template<typename T >

std::string StringUtils::scientific	(	const T	value,
		int	n = 10
	)

Returns scientific string representing given value of any numeric type.

Definition at line 61 of file StringUtils.h.

{
    std::ostringstream out;
    out << std::scientific << std::setprecision(n) << value;
    return out.str();
}

References mumufit::stringUtils::scientific().

Referenced by FitPrintService::iterationHeaderString(), FitPrintService::parameterString(), pyfmt::printScientificDouble(), AttLimits::toString(), OutputDataReadWriteNumpyTXT::write1DRepresentation(), OutputDataReadWriteNumpyTXT::write2DRepresentation(), and OutputDataReadWriteINT::writeOutputDataDoubles().

Here is the call graph for this function:

split()

std::vector< std::string > StringUtils::split	(	const std::string &	text,
		const std::string &	delimeter
	)

Split string into vector of string using delimeter.

Returns token vector obtained by splitting string at delimiters.

Definition at line 57 of file StringUtils.cpp.

{
    std::vector<std::string> tokens;
    boost::split(tokens, text, boost::is_any_of(delimiter));
    return tokens;
}

Referenced by mumufit::stringUtils::split().

to_lower()

std::string StringUtils::to_lower

(

std::string

text

)

Returns new string which is lower case of text.

Definition at line 92 of file StringUtils.cpp.

{
    boost::to_lower(text);
    return text;
}

trim()

std::string StringUtils::trim	(	const std::string &	str,
		const std::string &	whitespace = " \t"
	)

Cuts any of the chars given in whitespace from start and end of str.

Definition at line 98 of file StringUtils.cpp.

{
    const auto strBegin = str.find_first_not_of(whitespace);
 
    if (strBegin == std::string::npos)
        return "";
 
    const auto strEnd = str.find_last_not_of(whitespace);
    const auto strRange = strEnd - strBegin + 1;
 
    return str.substr(strBegin, strRange);
}

Referenced by OutputDataReadReflectometry::readOutputData(), OutputDataReadWriteINT::readOutputData(), and OutputDataReadWriteNumpyTXT::readOutputData().