BaseUtils::String Namespace Reference

Description

Utility functions to analyze or modify strings.

Functions
std::string	join (const std::vector< std::string > &joinable, const std::string &joint)
	Returns string obtain by joining vector elements. More...
std::string	padRight (const std::string &name, size_t length)
	Returns string right-padded with blanks. 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 (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 &delimiter)
	Split string into vector of string using delimiter. More...
bool	startsWith (const std::string &str, const std::string &substr)
	True if the string starts with substr. The comparison is case sensitive. More...
bool	to_int (const std::string &str, int *result)
	Interprets the contained text as an integer and returns it in result. Space chars at its begin and end will be ignored. If the conversion result is of no interest, but only the convertibility, then you can set result to nullptr. The conversion is assumed to be successful if: 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...
std::string	trimFront (const std::string &str, const std::string &whitespace=" \t")
	Cuts any of the chars given in whitespace from start. More...

Function Documentation

join()

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

Returns string obtain by joining vector elements.

Definition at line 45 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 Py::Fmt::printArguments(), and Py::Fmt::printImportedSymbols().

padRight()

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

Returns string right-padded with blanks.

Definition at line 21 of file StringUtils.cpp.

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

Referenced by FitPrintService::parameterString().

replaceItemsFromString()

void BaseUtils::String::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 37 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 BaseUtils::String::scientific	(	T	value,
		int	n = 10
	)

Returns scientific string representing given value of any numeric type.

Definition at line 75 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(), Py::Fmt::printScientificDouble(), AttLimits::toString(), ReadWriteNumpyTXT::write1DRepresentation(), ReadWriteNumpyTXT::write2DRepresentation(), and ReadWriteINT::writeDatafieldDoubles().

Here is the call graph for this function:

split()

std::vector< std::string > BaseUtils::String::split	(	const std::string &	text,
		const std::string &	delimiter
	)

Split string into vector of string using delimiter.

Returns token vector obtained by splitting string at delimiters.

Definition at line 29 of file StringUtils.cpp.

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

Referenced by IO::readNicosData(), and mumufit::stringUtils::split().

startsWith()

bool BaseUtils::String::startsWith	(	const std::string &	str,
		const std::string &	substr
	)

True if the string starts with substr. The comparison is case sensitive.

Definition at line 110 of file StringUtils.cpp.

{
    return str.rfind(substr, 0) == 0;
}

Referenced by IO::readNicosData().

to_int()

bool BaseUtils::String::to_int	(	const std::string &	str,
		int *	result
	)

Interprets the contained text as an integer and returns it in result. Space chars at its begin and end will be ignored. If the conversion result is of no interest, but only the convertibility, then you can set result to nullptr. The conversion is assumed to be successful if:

• every character was consumed by the conversion
• the value is not too big for int
• the text is not empty Returns true if successful. If not successful, the value in result is not changed. Does not throw anything.

Definition at line 64 of file StringUtils.cpp.

{
    const char* first = str.data() + str.find_first_not_of(' ');
    const char* last = str.data() + str.size();
    int _result = 0;
    auto [p, ec] = std::from_chars(first, last, _result);
 
    if (ec != std::errc())
        return false;
 
    if (p != last) {
        // not all was consumed. Check whether only space characters left
        const size_t pos = p - str.data();
        const auto hasNonSpaceLeft = str.find_first_not_of(' ', pos) != std::string::npos;
        if (hasNonSpaceLeft)
            return false;
    }
 
    if (result != nullptr)
        *result = _result;
    return true;
}

Referenced by IO::readNicosData().

to_lower()

std::string BaseUtils::String::to_lower

(

std::string

text

)

Returns new string which is lower case of text.

Definition at line 58 of file StringUtils.cpp.

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

Referenced by BaseUtils::Filesystem::hasExtension().

trim()

std::string BaseUtils::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.

Definition at line 87 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 ReadWriteINT::readDatafield(), ReadWriteNumpyTXT::readDatafield(), ReadReflectometry::readDatafield(), and IO::readNicosData().

trimFront()

std::string BaseUtils::String::trimFront	(	const std::string &	str,
		const std::string &	whitespace = " \t"
	)

Cuts any of the chars given in whitespace from start.

Definition at line 100 of file StringUtils.cpp.

{
    const auto strBegin = str.find_first_not_of(whitespace);
 
    if (strBegin == std::string::npos)
        return "";
 
    return str.substr(strBegin);
}

Referenced by IO::readNicosData().