#include <stringUtils.hpp>

Static Public Member Functions
static const string	makeStringFromBytes (const byte_t *data, const size_t count)
static const byte_t *	bytesFromString (const string &str)
static const byte_t *	bytesFromString (const char *str)
static string &	appendBytesToString (string &str, const byte_t *data, const size_t count)
static bool	isStringEqualNoCase (const string &s1, const char *s2, const size_t n)
static bool	isStringEqualNoCase (const string &s1, const string &s2)
static bool	isStringEqualNoCase (const string::const_iterator begin, const string::const_iterator end, const char *s, const size_t n)
static const string	toLower (const string &str)
static const string	toUpper (const string &str)
static const string	trim (const string &str)
static size_t	countASCIIchars (const string::const_iterator begin, const string::const_iterator end)
static bool	is7bit (const string &str)
static size_t	findFirstNonASCIIchar (const string::const_iterator begin, const string::const_iterator end)
template<class TYPE>
static const string	toString (const TYPE &value)
template<class TYPE>
static const TYPE	fromString (const string &value)
static const string	unquote (const string &str)
static bool	needQuoting (const string &str, const string &specialChars=" \t\"(),:;<>@[\\‍]")
static string	quote (const string &str, const string &escapeSpecialChars, const string &escapeChar)

Detailed Description

Miscellaneous functions related to strings.

Member Function Documentation

◆ appendBytesToString()

string & appendBytesToString	(	string &	str,
		const byte_t *	data,
		const size_t	count )

static

Appends bytes to a string.

Parameters

str	string to which append data
data	pointer to buffer containing data
count	number of bytes to use from buffer

Returns: a reference to modified string

References vmime::count().

Referenced by maildirMessage::fetchPartHeader(), and outputStreamStringAdapter::writeImpl().

◆ bytesFromString() [1/2]

const byte_t * bytesFromString ( const char * str )

static

Casts a NULL-terminated string to bytes.

Parameters

str string

Returns: pointer to the first byte of the string

◆ bytesFromString() [2/2]

const byte_t * bytesFromString ( const string & str )

static

Casts a string to bytes.

Parameters

str string

Returns: pointer to the first byte of the string

Referenced by IMAPFolder::addMessage().

◆ countASCIIchars()

size_t countASCIIchars	(	const string::const_iterator	begin,
		const string::const_iterator	end )

static

Return the number of 7-bit US-ASCII characters in a string.

Parameters

begin	start position
end	end position

Returns: number of ASCII characters

References vmime::begin(), vmime::count(), vmime::end(), and parserHelpers::isAscii().

Referenced by text::createFromString(), parameter::getGeneratedSize(), wordEncoder::guessBestEncoding(), and is7bit().

◆ findFirstNonASCIIchar()

size_t findFirstNonASCIIchar	(	const string::const_iterator	begin,
		const string::const_iterator	end )

static

Returns the position of the first non 7-bit US-ASCII character in a string.

Parameters

begin	start position
end	end position

Returns: position since begin, or string::npos

References vmime::begin(), vmime::end(), and parserHelpers::isAscii().

Referenced by wordEncoder::isEncodingNeeded().

◆ fromString()

template<class TYPE>

const TYPE fromString ( const string & value )

static

Convert the specified string value to a value of the specified type.

Parameters

value value to convert

Returns: value converted into type 'TYPE'

◆ is7bit()

bool is7bit ( const string & str )

static

Returns whether the specified string is composed exclusively of 7-bit ASCII characters.

Parameters

str	string to test

Returns: true if the string is ASCII-only, false otherwise

References countASCIIchars().

Referenced by charsetConverter_idna::convert(), and emailAddress::generateImpl().

◆ isStringEqualNoCase() [1/3]

bool isStringEqualNoCase	(	const string &	s1,
		const char *	s2,
		const size_t	n )

static

Test two strings for equality (case insensitive).

Warning: Use this with ASCII-only strings.

Parameters

s1	first string
s2	second string (must be in lower-case!)
n	length of the second string

Returns: true if the two strings compare equally, false otherwise

Referenced by charset::charset(), charset::operator==(), charset::parseImpl(), relay::parseImpl(), and transport::processHeaderField().

◆ isStringEqualNoCase() [2/3]

bool isStringEqualNoCase	(	const string &	s1,
		const string &	s2 )

static

Test two strings for equality (case insensitive).

Warning: Use this with ASCII-only strings.

Parameters

s1	first string
s2	second string

Returns: true if the two strings compare equally, false otherwise

References vmime::end().

◆ isStringEqualNoCase() [3/3]

bool isStringEqualNoCase	(	const string::const_iterator	begin,
		const string::const_iterator	end,
		const char *	s,
		const size_t	n )

static

Test two strings for equality (case insensitive).

Warning: Use this with ASCII-only strings.

Parameters

begin	start position of the first string
end	end position of the first string
s	second string (must be in lower-case!)
n	length of the second string

Returns: true if the two strings compare equally, false otherwise

References vmime::begin(), and vmime::end().

◆ makeStringFromBytes()

const string makeStringFromBytes	(	const byte_t *	data,
		const size_t	count )

static

Makes a string from bytes.

Parameters

data	pointer to buffer containing data
count	number of bytes to use from buffer

Returns: a string object containing a copy of the specified data

References vmime::count().

Referenced by SASLSocket::receive().

◆ needQuoting()

bool needQuoting	(	const string &	str,
		const string &	specialChars = " \t\"(),:;<>@[\\]" )

static

Determines whether the specified string needs to be quoted.

Parameters

str	string to test
specialChars	list of characters that will cause the string to be quoted

Returns: true if the string needs to be quoted, false otherwise

◆ quote()

string quote	(	const string &	str,
		const string &	escapeSpecialChars,
		const string &	escapeChar )

static

Quotes the specified string.

Parameters

str	string to quote
escapeSpecialChars	list of characters that will be escaped
escapeChar	character that will be used for escaping (eg. '\')

Returns: quoted string

◆ toLower()

const string toLower ( const string & str )

static

Transform all the characters in a string to lower-case.

Warning: Use this with ASCII-only strings.

Parameters

str	the string to transform

Returns: a new string in lower-case

Referenced by fetchAttributes::add(), disposition::addModifier(), headerFieldFactory::create(), messageDigestFactory::create(), headerFieldFactory::createValue(), header::findAllFields(), header::findField(), parameterizedHeaderField::findParameter(), encoderFactory::getEncoderByName(), header::getField(), importanceHelper::getImportanceHeader(), parameterizedHeaderField::getParameter(), charset::getRecommendedEncoding(), serviceFactory::getServiceByProtocol(), fetchAttributes::has(), header::hasField(), disposition::hasModifier(), parameterizedHeaderField::hasParameter(), headerFieldFactory::isValueTypeValid(), contentDisposition::operator=(), encoding::operator=(), contentDisposition::operator==(), encoding::operator==(), contentDisposition::parseImpl(), encoding::parseImpl(), mediaType::parseImpl(), messageDigestFactory::registerAlgorithm(), headerFieldFactory::registerField(), headerFieldFactory::registerFieldValue(), encoderFactory::registerName(), disposition::removeModifier(), mediaType::setSubType(), mediaType::setType(), and propertySet::valueFromString().

◆ toString()

template<class TYPE>

const string toString ( const TYPE & value )

static

Convert the specified value to a string value.

Parameters

value to convert

Returns: value converted from type 'TYPE'

Referenced by messageSet::byUID().

◆ toUpper()

const string toUpper ( const string & str )

static

Transform all the characters in a string to upper-case.

Warning: Use this with ASCII-only strings.

Parameters

str	the string to transform

Returns: a new string in upper-case

Referenced by SASLMechanismFactory::create().

◆ trim()

const string trim ( const string & str )

static

Strip the space characters (SPC, TAB, CR, LF) at the beginning and at the end of the specified string.

Parameters

str	string in which to strip spaces

Returns: a new string with space characters removed

References parserHelpers::isSpace().

Referenced by disposition::generateImpl(), importanceHelper::getImportanceHeader(), maildirStore::isValidFolderName(), charset::parseImpl(), contentDisposition::parseImpl(), encoding::parseImpl(), mailboxGroup::parseImpl(), mediaType::parseImpl(), and POP3Response::readMultilineResponse().

◆ unquote()

const string unquote ( const string & str )

static

Unquote the specified string and transform escaped characters.

Parameters

str	string from which to remove quotes

Returns: unquoted string

References vmime::end().

Referenced by encoding::parseImpl().

The documentation for this class was generated from the following files:

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ appendBytesToString()

◆ bytesFromString() [1/2]

◆ bytesFromString() [2/2]

◆ countASCIIchars()

◆ findFirstNonASCIIchar()

◆ fromString()

◆ is7bit()

◆ isStringEqualNoCase() [1/3]

◆ isStringEqualNoCase() [2/3]

◆ isStringEqualNoCase() [3/3]

◆ makeStringFromBytes()

◆ needQuoting()

◆ quote()

◆ toLower()

◆ toString()

◆ toUpper()

◆ trim()

◆ unquote()