Utility class for manipulating Strings. More...

#include <OgreString.h>

Public Types
typedef StringStream	StrStreamType

Static Public Member Functions
static bool	endsWith (const String &str, const String &pattern, bool lowerCase=true)
	Returns whether the string ends with the pattern passed in. More...

static String	format (const char *fmt,...) OGRE_FORMAT_PRINTF(1
	create a string from a printf expression More...

static bool	match (const String &str, const String &pattern, bool caseSensitive=true)
	Simple pattern-matching routine allowing a wildcard pattern. More...

static String	normalizeFilePath (const String &init, bool makeLowerCase=true)
	Returns a normalized version of a file path This method can be used to make file path strings which point to the same directory but have different texts to be normalized to the same text. More...

static const String	replaceAll (const String &source, const String &replaceWhat, const String &replaceWithWhat)
	Replace all instances of a sub-string with a another sub-string. More...

static std::vector< String >	split (const String &str, const String &delims="\ ", unsigned int maxSplits=0, bool preserveDelims=false)
	Returns a StringVector that contains all the substrings delimited by the characters in the passed `delims` argument. More...

static void	splitBaseFilename (const Ogre::String &fullName, Ogre::String &outBasename, Ogre::String &outExtention)
	Method for splitting a filename into the base name and extension. More...

static void	splitFilename (const String &qualifiedName, String &outBasename, String &outPath)
	Method for splitting a fully qualified filename into the base name and path. More...

static void	splitFullFilename (const Ogre::String &qualifiedName, Ogre::String &outBasename, Ogre::String &outExtention, Ogre::String &outPath)
	Method for splitting a fully qualified filename into the base name, extension and path. More...

static String	standardisePath (const String &init)
	Method for standardising paths - use forward slashes only, end with slash. More...

static bool	startsWith (const String &str, const String &pattern, bool lowerCase=true)
	Returns whether the string begins with the pattern passed in. More...

static std::vector< String >	tokenise (const String &str, const String &delims="\ ", const String &doubleDelims="\, unsigned int maxSplits=0)
	Returns a StringVector that contains all the substrings delimited by the characters in the passed `delims` argument, or in the `doubleDelims` argument, which is used to include (normal) delimeters in the tokenised string. More...

static void	toLowerCase (String &str)
	Lower-cases all the characters in the string. More...

static void	toTitleCase (String &str)
	Upper-cases the first letter of each word. More...

static void	toUpperCase (String &str)
	Upper-cases all the characters in the string. More...

static void	trim (String &str, bool left=true, bool right=true)
	Removes any whitespace characters, be it standard space or TABs and so on. More...

Static Public Attributes
static const String &	BLANK

Detailed Description

Utility class for manipulating Strings.

Member Typedef Documentation

◆ StrStreamType

typedef StringStream Ogre::StringUtil::StrStreamType

Deprecated:: use Ogre::StringStream instead

Member Function Documentation

◆ trim()

static void Ogre::StringUtil::trim	(	String &	str,
		bool	left = `true`,
		bool	right = `true`
	)

static

Removes any whitespace characters, be it standard space or TABs and so on.

Remarks: The user may specify whether they want to trim only the beginning or the end of the String ( the default action is to trim both).

◆ split()

static std::vector<String> Ogre::StringUtil::split	(	const String &	str,
		const String &	delims = `"\ "`,
		unsigned int	maxSplits = `0`,
		bool	preserveDelims = `false`
	)

static

Returns a StringVector that contains all the substrings delimited by the characters in the passed delims argument.

Parameters

str
delims	A list of delimiter characters to split by
maxSplits	The maximum number of splits to perform (0 for unlimited splits). If this parameters is > 0, the splitting process will stop after this many splits, left to right.
preserveDelims	Flag to determine if delimiters should be saved as substrings

Referenced by Ogre::DriverVersion::fromString(), and Ogre::StringConverter::parseStringVector().

◆ tokenise()

static std::vector<String> Ogre::StringUtil::tokenise	(	const String &	str,
		const String &	delims = `"\ "`
	)

static

Returns a StringVector that contains all the substrings delimited by the characters in the passed delims argument, or in the doubleDelims argument, which is used to include (normal) delimeters in the tokenised string.

For example, "strings like this".

Parameters

str
delims	A list of delimiter characters to split by
doubleDelims	A list of double delimeters characters to tokenise by
maxSplits	The maximum number of splits to perform (0 for unlimited splits). If this parameters is > 0, the splitting process will stop after this many splits, left to right.

◆ toLowerCase()

static void Ogre::StringUtil::toLowerCase ( String & str )

static

Lower-cases all the characters in the string.

◆ toUpperCase()

static void Ogre::StringUtil::toUpperCase ( String & str )

static

Upper-cases all the characters in the string.

◆ toTitleCase()

static void Ogre::StringUtil::toTitleCase ( String & str )

static

Upper-cases the first letter of each word.

◆ startsWith()

static bool Ogre::StringUtil::startsWith	(	const String &	str,
		const String &	pattern,
		bool	lowerCase = `true`
	)

static

Returns whether the string begins with the pattern passed in.

Parameters

str
pattern	The pattern to compare with.
lowerCase	If true, the start of the string will be lower cased before comparison, pattern should also be in lower case.

◆ endsWith()

static bool Ogre::StringUtil::endsWith	(	const String &	str,
		const String &	pattern,
		bool	lowerCase = `true`
	)

static

Returns whether the string ends with the pattern passed in.

Parameters

str
pattern	The pattern to compare with.
lowerCase	If true, the end of the string will be lower cased before comparison, pattern should also be in lower case.

◆ standardisePath()

static String Ogre::StringUtil::standardisePath ( const String & init )

static

Method for standardising paths - use forward slashes only, end with slash.

◆ normalizeFilePath()

static String Ogre::StringUtil::normalizeFilePath	(	const String &	init,
		bool	makeLowerCase = `true`
	)

static

Returns a normalized version of a file path This method can be used to make file path strings which point to the same directory but have different texts to be normalized to the same text.

The function:

Transforms all backward slashes to forward slashes.
Removes repeating slashes.
Removes initial slashes from the beginning of the path.
Removes ".\" and "..\" meta directories.
Sets all characters to lowercase (if requested)
Parameters

init The file path to normalize.

makeLowerCase If true, transforms all characters in the string to lowercase.

◆ splitFilename()

static void Ogre::StringUtil::splitFilename	(	const String &	qualifiedName,
		String &	outBasename,
		String &	outPath
	)

static

Method for splitting a fully qualified filename into the base name and path.

Remarks: Path is standardised as in standardisePath

◆ splitFullFilename()

static void Ogre::StringUtil::splitFullFilename	(	const Ogre::String &	qualifiedName,
		Ogre::String &	outBasename,
		Ogre::String &	outExtention,
		Ogre::String &	outPath
	)

static

Method for splitting a fully qualified filename into the base name, extension and path.

Remarks: Path is standardised as in standardisePath

◆ splitBaseFilename()

static void Ogre::StringUtil::splitBaseFilename	(	const Ogre::String &	fullName,
		Ogre::String &	outBasename,
		Ogre::String &	outExtention
	)

static

Method for splitting a filename into the base name and extension.

◆ match()

static bool Ogre::StringUtil::match	(	const String &	str,
		const String &	pattern,
		bool	caseSensitive = `true`
	)

static

Simple pattern-matching routine allowing a wildcard pattern.

Parameters

str	String to test
pattern	Pattern to match against; can include simple '*' wildcards
caseSensitive	Whether the match is case sensitive or not

◆ replaceAll()

static const String Ogre::StringUtil::replaceAll	(	const String &	source,
		const String &	replaceWhat,
		const String &	replaceWithWhat
	)

static

Replace all instances of a sub-string with a another sub-string.

Parameters

source	Source string
replaceWhat	Sub-string to find and replace
replaceWithWhat	Sub-string to replace with (the new sub-string)

Returns: An updated string with the sub-string replaced

◆ format()

static String Ogre::StringUtil::format	(	const char *	fmt,
			...
	)

static

create a string from a printf expression

Note: this function - like printf - uses a locale dependent decimal point

Member Data Documentation

◆ BLANK

const String& Ogre::StringUtil::BLANK

static

Deprecated:: use Ogre::BLANKSTRING instead

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

OgreString.h

init	The file path to normalize.
makeLowerCase	If true, transforms all characters in the string to lowercase.

Public Types

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ StrStreamType

Member Function Documentation

◆ trim()

◆ split()

◆ tokenise()

◆ toLowerCase()

◆ toUpperCase()

◆ toTitleCase()

◆ startsWith()

◆ endsWith()

◆ standardisePath()

◆ normalizeFilePath()

◆ splitFilename()

◆ splitFullFilename()

◆ splitBaseFilename()

◆ match()

◆ replaceAll()

◆ format()

Member Data Documentation

◆ BLANK