#include <fstring.h>

Inheritance diagram for Steinberg::ConstString:

Public Types
enum	CompareMode { kCaseSensitive , kCaseInsensitive }

Public Member Functions
	ConstString (const char8 *str, int32 length=-1)
	Assign from string of type char8 (length=-1: all).
	ConstString (const char16 *str, int32 length=-1)
	Assign from string of type char16 (length=-1: all).
	ConstString (const ConstString &str, int32 offset=0, int32 length=-1)
	Copy constructor (length=-1: all).
	ConstString (const FVariant &var)
	Assign a string from FVariant.
	ConstString ()
virtual	~ConstString ()
	Destructor.
virtual int32	length () const
	Return length of string.
bool	isEmpty () const
	Return true if string is empty.
	operator const char8 * () const
	Returns pointer to string of type char8 (no modification allowed).
	operator const char16 * () const
	Returns pointer to string of type char16(no modification allowed).
tchar	operator[] (short idx) const
	Returns character at 'idx'.
tchar	operator[] (long idx) const
tchar	operator[] (int idx) const
tchar	operator[] (unsigned short idx) const
tchar	operator[] (unsigned long idx) const
tchar	operator[] (unsigned int idx) const
virtual const char8 *	text8 () const
	Returns pointer to string of type char8.
virtual const char16 *	text16 () const
	Returns pointer to string of type char16.
virtual const tchar *	text () const
	Returns pointer to string of type tchar.
virtual const void *	ptr () const
	Returns pointer to string of type void.
virtual char8	getChar8 (uint32 index) const
	Returns character of type char16 at 'index'.
virtual char16	getChar16 (uint32 index) const
	Returns character of type char8 at 'index'.
tchar	getChar (uint32 index) const
	Returns character of type tchar at 'index'.
tchar	getCharAt (uint32 index) const
	Returns character of type tchar at 'index', no conversion!
bool	testChar8 (uint32 index, char8 c) const
	Returns true if character is equal at position 'index'.
bool	testChar16 (uint32 index, char16 c) const
bool	testChar (uint32 index, char8 c) const
bool	testChar (uint32 index, char16 c) const
bool	extract (String &result, uint32 idx, int32 n=-1) const
	Get n characters long substring starting at index (n=-1: until end).
int32	copyTo8 (char8 *str, uint32 idx=0, int32 n=-1) const
int32	copyTo16 (char16 *str, uint32 idx=0, int32 n=-1) const
int32	copyTo (tchar *str, uint32 idx=0, int32 n=-1) const
void	copyTo (IStringResult *result) const
	Copies whole member string.
void	copyTo (IString &string) const
	Copies whole member string.
uint32	hash (uint32 tsize) const
int32	compareAt (uint32 index, const ConstString &str, int32 n=-1, CompareMode m=kCaseSensitive) const
	Compare n characters of str with n characters of this starting at index (return: see above).
int32	compare (const ConstString &str, int32 n, CompareMode m=kCaseSensitive) const
	Compare n characters of str with n characters of this (return: see above).
int32	compare (const ConstString &str, CompareMode m=kCaseSensitive) const
	Compare all characters of str with this (return: see above).
int32	naturalCompare (const ConstString &str, CompareMode mode=kCaseSensitive) const
bool	startsWith (const ConstString &str, CompareMode m=kCaseSensitive) const
	Check if this starts with str.
bool	endsWith (const ConstString &str, CompareMode m=kCaseSensitive) const
	Check if this ends with str.
bool	contains (const ConstString &str, CompareMode m=kCaseSensitive) const
	Check if this contains str.
int32	findLast (const ConstString &str, int32 n=-1, CompareMode m=kCaseSensitive) const
	Find last occurrence of n characters of str in this (n=-1: all).
int32	findLast (char8 c, CompareMode m=kCaseSensitive) const
int32	findLast (char16 c, CompareMode m=kCaseSensitive) const
int32	countOccurences (char8 c, uint32 startIndex, CompareMode=kCaseSensitive) const
	Counts occurences of c within this starting at index.
int32	countOccurences (char16 c, uint32 startIndex, CompareMode=kCaseSensitive) const
int32	getFirstDifferent (const ConstString &str, CompareMode=kCaseSensitive) const
	Returns position of first different character.
bool	isDigit (uint32 index) const
	Returns true if character at position is a digit.
bool	scanFloat (double &value, uint32 offset=0, bool scanToEnd=true) const
	Converts string to double value starting at offset.
bool	scanInt64 (int64 &value, uint32 offset=0, bool scanToEnd=true) const
	Converts string to int64 value starting at offset.
bool	scanUInt64 (uint64 &value, uint32 offset=0, bool scanToEnd=true) const
	Converts string to uint64 value starting at offset.
bool	scanInt32 (int32 &value, uint32 offset=0, bool scanToEnd=true) const
	Converts string to int32 value starting at offset.
bool	scanUInt32 (uint32 &value, uint32 offset=0, bool scanToEnd=true) const
	Converts string to uint32 value starting at offset.
bool	scanHex (uint8 &value, uint32 offset=0, bool scanToEnd=true) const
	Converts string to hex/uint8 value starting at offset.
int32	getTrailingNumberIndex (uint32 width=0) const
	Returns start index of trailing number.
int64	getTrailingNumber (int64 fallback=0) const
	Returns result of scanInt64 or the fallback.
int64	getNumber () const
	Returns result of scanInt64.
void	toVariant (FVariant &var) const
bool	isWideString () const
	Returns true if string is wide.
bool	isAsciiString () const
	Checks if all characters in string are in ascii range.
bool	isNormalized (UnicodeNormalization=kUnicodeNormC)
	On PC only kUnicodeNormC is working.
Find first occurrence of n characters of str in this (n=-1: all) ending at endIndex (endIndex = -1: all)
int32	findFirst (const ConstString &str, int32 n=-1, CompareMode m=kCaseSensitive, int32 endIndex=-1) const
int32	findFirst (char8 c, CompareMode m=kCaseSensitive, int32 endIndex=-1) const
int32	findFirst (char16 c, CompareMode m=kCaseSensitive, int32 endIndex=-1) const
Find next occurrence of n characters of str starting at startIndex in this (n=-1: all) ending at endIndex (endIndex = -1: all)
int32	findNext (int32 startIndex, const ConstString &str, int32 n=-1, CompareMode=kCaseSensitive, int32 endIndex=-1) const
int32	findNext (int32 startIndex, char8 c, CompareMode=kCaseSensitive, int32 endIndex=-1) const
int32	findNext (int32 startIndex, char16 c, CompareMode=kCaseSensitive, int32 endIndex=-1) const
Find previous occurrence of n characters of str starting at startIndex in this (n=-1: all)
int32	findPrev (int32 startIndex, const ConstString &str, int32 n=-1, CompareMode=kCaseSensitive) const
int32	findPrev (int32 startIndex, char8 c, CompareMode=kCaseSensitive) const
int32	findPrev (int32 startIndex, char16 c, CompareMode=kCaseSensitive) const

Static Public Member Functions
static bool	isCharSpace (char8 character)
	Returns true if character is a space.
static bool	isCharSpace (char16 character)
	Returns true if character is a space.
static bool	isCharAlpha (char8 character)
	Returns true if character is an alphabetic character.
static bool	isCharAlpha (char16 character)
	Returns true if character is an alphabetic character.
static bool	isCharAlphaNum (char8 character)
	Returns true if character is an alphanumeric character.
static bool	isCharAlphaNum (char16 character)
	Returns true if character is an alphanumeric character.
static bool	isCharDigit (char8 character)
	Returns true if character is a number.
static bool	isCharDigit (char16 character)
	Returns true if character is a number.
static bool	isCharAscii (char8 character)
	Returns true if character is in ASCII range.
static bool	isCharAscii (char16 character)
	Returns true if character is in ASCII range.
static bool	isCharUpper (char8 character)
static bool	isCharUpper (char16 character)
static bool	isCharLower (char8 character)
static bool	isCharLower (char16 character)
static bool	scanInt64_8 (const char8 *text, int64 &value, bool scanToEnd=true)
	Converts string of type char8 to int64 value.
static bool	scanInt64_16 (const char16 *text, int64 &value, bool scanToEnd=true)
	Converts string of type char16 to int64 value.
static bool	scanInt64 (const tchar *text, int64 &value, bool scanToEnd=true)
	Converts string of type tchar to int64 value.
static bool	scanUInt64_8 (const char8 *text, uint64 &value, bool scanToEnd=true)
	Converts string of type char8 to uint64 value.
static bool	scanUInt64_16 (const char16 *text, uint64 &value, bool scanToEnd=true)
	Converts string of type char16 to uint64 value.
static bool	scanUInt64 (const tchar *text, uint64 &value, bool scanToEnd=true)
	Converts string of type tchar to uint64 value.
static bool	scanInt32_8 (const char8 *text, int32 &value, bool scanToEnd=true)
	Converts string of type char8 to int32 value.
static bool	scanInt32_16 (const char16 *text, int32 &value, bool scanToEnd=true)
	Converts string of type char16 to int32 value.
static bool	scanInt32 (const tchar *text, int32 &value, bool scanToEnd=true)
	Converts string of type tchar to int32 value.
static bool	scanUInt32_8 (const char8 *text, uint32 &value, bool scanToEnd=true)
	Converts string of type char8 to int32 value.
static bool	scanUInt32_16 (const char16 *text, uint32 &value, bool scanToEnd=true)
	Converts string of type char16 to int32 value.
static bool	scanUInt32 (const tchar *text, uint32 &value, bool scanToEnd=true)
	Converts string of type tchar to int32 value.
static bool	scanHex_8 (const char8 *text, uint8 &value, bool scanToEnd=true)
	Converts string of type char8 to hex/unit8 value.
static bool	scanHex_16 (const char16 *text, uint8 &value, bool scanToEnd=true)
	Converts string of type char16 to hex/unit8 value.
static bool	scanHex (const tchar *text, uint8 &value, bool scanToEnd=true)
	Converts string of type tchar to hex/unit8 value.
static char8	toLower (char8 c)
	Converts to lower case.
static char8	toUpper (char8 c)
	Converts to upper case.
static char16	toLower (char16 c)
static char16	toUpper (char16 c)
static int32	multiByteToWideString (char16 dest, const char8 source, int32 wcharCount, uint32 sourceCodePage=kCP_Default)
	If dest is zero, this returns the maximum number of bytes needed to convert source.
static int32	wideStringToMultiByte (char8 dest, const char16 source, int32 char8Count, uint32 destCodePage=kCP_Default)
	If dest is zero, this returns the maximum number of bytes needed to convert source.

Protected Attributes
union {
void * buffer
char8 * buffer8
char16 * buffer16
};
uint32	len: 30
uint32	isWide: 1

Detailed Description

Invariant String.

A base class which provides methods to work with its member string. Neither of the operations allows modifying the member string and that is why all operation are declared as const.

There are operations for access, comparison, find, numbers and conversion.

Almost all operations exist in three versions for char8, char16 and the polymorphic type tchar. The type tchar can either be char8 or char16 depending on whether UNICODE is activated or not.

Member Enumeration Documentation

◆ CompareMode

enum Steinberg::ConstString::CompareMode

Enumerator
kCaseSensitive	Comparison is done with regard to character's case.
kCaseInsensitive	Comparison is done without regard to character's case.

Constructor & Destructor Documentation

◆ ConstString() [1/5]

Steinberg::ConstString::ConstString	(	const char8 *	str,
		int32	length = -1 )

Assign from string of type char8 (length=-1: all).

◆ ConstString() [2/5]

Steinberg::ConstString::ConstString	(	const char16 *	str,
		int32	length = -1 )

Assign from string of type char16 (length=-1: all).

◆ ConstString() [3/5]

Steinberg::ConstString::ConstString	(	const ConstString &	str,
		int32	offset = 0,
		int32	length = -1 )

Copy constructor (length=-1: all).

◆ ConstString() [4/5]

Steinberg::ConstString::ConstString ( const FVariant & var )

Assign a string from FVariant.

◆ ConstString() [5/5]

Steinberg::ConstString::ConstString ( )

◆ ~ConstString()

virtual Steinberg::ConstString::~ConstString ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ compare() [1/2]

int32 Steinberg::ConstString::compare	(	const ConstString &	str,
		CompareMode	m = kCaseSensitive ) const

Compare all characters of str with this (return: see above).

◆ compare() [2/2]

int32 Steinberg::ConstString::compare	(	const ConstString &	str,
		int32	n,
		CompareMode	m = kCaseSensitive ) const

Compare n characters of str with n characters of this (return: see above).

◆ compareAt()

int32 Steinberg::ConstString::compareAt	(	uint32	index,
		const ConstString &	str,
		int32	n = -1,
		CompareMode	m = kCaseSensitive ) const

Compare n characters of str with n characters of this starting at index (return: see above).

◆ contains()

bool Steinberg::ConstString::contains	(	const ConstString &	str,
		CompareMode	m = kCaseSensitive ) const

Check if this contains str.

◆ copyTo() [1/3]

void Steinberg::ConstString::copyTo ( IString & string ) const

Copies whole member string.

◆ copyTo() [2/3]

void Steinberg::ConstString::copyTo ( IStringResult * result ) const

Copies whole member string.

◆ copyTo() [3/3]

int32 Steinberg::ConstString::copyTo	(	tchar *	str,
		uint32	idx = 0,
		int32	n = -1 ) const

◆ copyTo16()

int32 Steinberg::ConstString::copyTo16	(	char16 *	str,
		uint32	idx = 0,
		int32	n = -1 ) const

◆ copyTo8()

int32 Steinberg::ConstString::copyTo8	(	char8 *	str,
		uint32	idx = 0,
		int32	n = -1 ) const

◆ countOccurences() [1/2]

int32 Steinberg::ConstString::countOccurences	(	char16	c,
		uint32	startIndex,
		CompareMode	mode = kCaseSensitive ) const

◆ countOccurences() [2/2]

int32 Steinberg::ConstString::countOccurences	(	char8	c,
		uint32	startIndex,
		CompareMode	mode = kCaseSensitive ) const

Counts occurences of c within this starting at index.

◆ endsWith()

bool Steinberg::ConstString::endsWith	(	const ConstString &	str,
		CompareMode	m = kCaseSensitive ) const

Check if this ends with str.

◆ extract()

bool Steinberg::ConstString::extract	(	String &	result,
		uint32	idx,
		int32	n = -1 ) const

Get n characters long substring starting at index (n=-1: until end).

◆ findFirst() [1/3]

int32 Steinberg::ConstString::findFirst	(	char16	c,
		CompareMode	m = kCaseSensitive,
		int32	endIndex = -1 ) const

inline

◆ findFirst() [2/3]

int32 Steinberg::ConstString::findFirst	(	char8	c,
		CompareMode	m = kCaseSensitive,
		int32	endIndex = -1 ) const

inline

◆ findFirst() [3/3]

int32 Steinberg::ConstString::findFirst	(	const ConstString &	str,
		int32	n = -1,
		CompareMode	m = kCaseSensitive,
		int32	endIndex = -1 ) const

inline

◆ findLast() [1/3]

int32 Steinberg::ConstString::findLast	(	char16	c,
		CompareMode	m = kCaseSensitive ) const

inline

◆ findLast() [2/3]

int32 Steinberg::ConstString::findLast	(	char8	c,
		CompareMode	m = kCaseSensitive ) const

inline

◆ findLast() [3/3]

int32 Steinberg::ConstString::findLast	(	const ConstString &	str,
		int32	n = -1,
		CompareMode	m = kCaseSensitive ) const

inline

Find last occurrence of n characters of str in this (n=-1: all).

◆ findNext() [1/3]

int32 Steinberg::ConstString::findNext	(	int32	startIndex,
		char16	c,
		CompareMode	mode = kCaseSensitive,
		int32	endIndex = -1 ) const

◆ findNext() [2/3]

int32 Steinberg::ConstString::findNext	(	int32	startIndex,
		char8	c,
		CompareMode	mode = kCaseSensitive,
		int32	endIndex = -1 ) const

◆ findNext() [3/3]

int32 Steinberg::ConstString::findNext	(	int32	startIndex,
		const ConstString &	str,
		int32	n = -1,
		CompareMode	mode = kCaseSensitive,
		int32	endIndex = -1 ) const

◆ findPrev() [1/3]

int32 Steinberg::ConstString::findPrev	(	int32	startIndex,
		char16	c,
		CompareMode	mode = kCaseSensitive ) const

◆ findPrev() [2/3]

int32 Steinberg::ConstString::findPrev	(	int32	startIndex,
		char8	c,
		CompareMode	mode = kCaseSensitive ) const

◆ findPrev() [3/3]

int32 Steinberg::ConstString::findPrev	(	int32	startIndex,
		const ConstString &	str,
		int32	n = -1,
		CompareMode	mode = kCaseSensitive ) const

◆ getChar()

tchar Steinberg::ConstString::getChar ( uint32 index ) const

inline

Returns character of type tchar at 'index'.

◆ getChar16()

char16 Steinberg::ConstString::getChar16 ( uint32 index ) const

inlinevirtual

Returns character of type char8 at 'index'.

Reimplemented in Steinberg::String.

◆ getChar8()

char8 Steinberg::ConstString::getChar8 ( uint32 index ) const

inlinevirtual

Returns character of type char16 at 'index'.

Reimplemented in Steinberg::String.

◆ getCharAt()

tchar Steinberg::ConstString::getCharAt ( uint32 index ) const

inline

Returns character of type tchar at 'index', no conversion!

◆ getFirstDifferent()

int32 Steinberg::ConstString::getFirstDifferent	(	const ConstString &	str,
		CompareMode	mode = kCaseSensitive ) const

Returns position of first different character.

◆ getNumber()

int64 Steinberg::ConstString::getNumber ( ) const

inline

Returns result of scanInt64.

◆ getTrailingNumber()

int64 Steinberg::ConstString::getTrailingNumber ( int64 fallback = 0 ) const

Returns result of scanInt64 or the fallback.

◆ getTrailingNumberIndex()

int32 Steinberg::ConstString::getTrailingNumberIndex ( uint32 width = 0 ) const

Returns start index of trailing number.

◆ hash()

uint32 Steinberg::ConstString::hash ( uint32 tsize ) const

inline

◆ isAsciiString()

bool Steinberg::ConstString::isAsciiString ( ) const

Checks if all characters in string are in ascii range.

◆ isCharAlpha() [1/2]

bool Steinberg::ConstString::isCharAlpha ( char16 character )

static

Returns true if character is an alphabetic character.

◆ isCharAlpha() [2/2]

bool Steinberg::ConstString::isCharAlpha ( char8 character )

static

Returns true if character is an alphabetic character.

◆ isCharAlphaNum() [1/2]

bool Steinberg::ConstString::isCharAlphaNum ( char16 character )

static

Returns true if character is an alphanumeric character.

◆ isCharAlphaNum() [2/2]

bool Steinberg::ConstString::isCharAlphaNum ( char8 character )

static

Returns true if character is an alphanumeric character.

◆ isCharAscii() [1/2]

bool Steinberg::ConstString::isCharAscii ( char16 character )

static

Returns true if character is in ASCII range.

◆ isCharAscii() [2/2]

bool Steinberg::ConstString::isCharAscii ( char8 character )

static

Returns true if character is in ASCII range.

◆ isCharDigit() [1/2]

bool Steinberg::ConstString::isCharDigit ( char16 character )

static

Returns true if character is a number.

◆ isCharDigit() [2/2]

bool Steinberg::ConstString::isCharDigit ( char8 character )

static

Returns true if character is a number.

◆ isCharLower() [1/2]

bool Steinberg::ConstString::isCharLower ( char16 character )

static

◆ isCharLower() [2/2]

bool Steinberg::ConstString::isCharLower ( char8 character )

static

◆ isCharSpace() [1/2]

bool Steinberg::ConstString::isCharSpace ( char16 character )

static

Returns true if character is a space.

◆ isCharSpace() [2/2]

bool Steinberg::ConstString::isCharSpace ( char8 character )

static

Returns true if character is a space.

◆ isCharUpper() [1/2]

bool Steinberg::ConstString::isCharUpper ( char16 character )

static

◆ isCharUpper() [2/2]

bool Steinberg::ConstString::isCharUpper ( char8 character )

static

◆ isDigit()

bool Steinberg::ConstString::isDigit ( uint32 index ) const

Returns true if character at position is a digit.

◆ isEmpty()

bool Steinberg::ConstString::isEmpty ( ) const

inline

Return true if string is empty.

◆ isNormalized()

bool Steinberg::ConstString::isNormalized ( UnicodeNormalization n = kUnicodeNormC )

On PC only kUnicodeNormC is working.

◆ isWideString()

bool Steinberg::ConstString::isWideString ( ) const

inline

Returns true if string is wide.

◆ length()

virtual int32 Steinberg::ConstString::length ( ) const

inlinevirtual

Return length of string.

◆ multiByteToWideString()

int32 Steinberg::ConstString::multiByteToWideString	(	char16 *	dest,
		const char8 *	source,
		int32	wcharCount,
		uint32	sourceCodePage = kCP_Default )

static

If dest is zero, this returns the maximum number of bytes needed to convert source.

◆ naturalCompare()

Steinberg::int32 Steinberg::ConstString::naturalCompare	(	const ConstString &	str,
		CompareMode	mode = kCaseSensitive ) const

◆ operator const char16 *()

Steinberg::ConstString::operator const char16 * ( ) const

inline

Returns pointer to string of type char16(no modification allowed).

◆ operator const char8 *()

Steinberg::ConstString::operator const char8 * ( ) const

inline

Returns pointer to string of type char8 (no modification allowed).

◆ operator[]() [1/6]

tchar Steinberg::ConstString::operator[] ( int idx ) const

inline

◆ operator[]() [2/6]

tchar Steinberg::ConstString::operator[] ( long idx ) const

inline

◆ operator[]() [3/6]

tchar Steinberg::ConstString::operator[] ( short idx ) const

inline

Returns character at 'idx'.

◆ operator[]() [4/6]

tchar Steinberg::ConstString::operator[] ( unsigned int idx ) const

inline

◆ operator[]() [5/6]

tchar Steinberg::ConstString::operator[] ( unsigned long idx ) const

inline

◆ operator[]() [6/6]

tchar Steinberg::ConstString::operator[] ( unsigned short idx ) const

inline

◆ ptr()

virtual const void * Steinberg::ConstString::ptr ( ) const

inlinevirtual

Returns pointer to string of type void.

◆ scanFloat()

bool Steinberg::ConstString::scanFloat	(	double &	value,
		uint32	offset = 0,
		bool	scanToEnd = true ) const

Converts string to double value starting at offset.

◆ scanHex() [1/2]

bool Steinberg::ConstString::scanHex	(	const tchar *	text,
		uint8 &	value,
		bool	scanToEnd = true )

static

Converts string of type tchar to hex/unit8 value.

◆ scanHex() [2/2]

bool Steinberg::ConstString::scanHex	(	uint8 &	value,
		uint32	offset = 0,
		bool	scanToEnd = true ) const

Converts string to hex/uint8 value starting at offset.

◆ scanHex_16()

bool Steinberg::ConstString::scanHex_16	(	const char16 *	text,
		uint8 &	value,
		bool	scanToEnd = true )

static

Converts string of type char16 to hex/unit8 value.

◆ scanHex_8()

bool Steinberg::ConstString::scanHex_8	(	const char8 *	text,
		uint8 &	value,
		bool	scanToEnd = true )

static

Converts string of type char8 to hex/unit8 value.

◆ scanInt32() [1/2]

bool Steinberg::ConstString::scanInt32	(	const tchar *	text,
		int32 &	value,
		bool	scanToEnd = true )

inlinestatic

Converts string of type tchar to int32 value.

◆ scanInt32() [2/2]

bool Steinberg::ConstString::scanInt32	(	int32 &	value,
		uint32	offset = 0,
		bool	scanToEnd = true ) const

Converts string to int32 value starting at offset.

◆ scanInt32_16()

bool Steinberg::ConstString::scanInt32_16	(	const char16 *	text,
		int32 &	value,
		bool	scanToEnd = true )

inlinestatic

Converts string of type char16 to int32 value.

◆ scanInt32_8()

bool Steinberg::ConstString::scanInt32_8	(	const char8 *	text,
		int32 &	value,
		bool	scanToEnd = true )

inlinestatic

Converts string of type char8 to int32 value.

◆ scanInt64() [1/2]

bool Steinberg::ConstString::scanInt64	(	const tchar *	text,
		int64 &	value,
		bool	scanToEnd = true )

static

Converts string of type tchar to int64 value.

◆ scanInt64() [2/2]

bool Steinberg::ConstString::scanInt64	(	int64 &	value,
		uint32	offset = 0,
		bool	scanToEnd = true ) const

Converts string to int64 value starting at offset.

◆ scanInt64_16()

bool Steinberg::ConstString::scanInt64_16	(	const char16 *	text,
		int64 &	value,
		bool	scanToEnd = true )

static

Converts string of type char16 to int64 value.

◆ scanInt64_8()

bool Steinberg::ConstString::scanInt64_8	(	const char8 *	text,
		int64 &	value,
		bool	scanToEnd = true )

static

Converts string of type char8 to int64 value.

◆ scanUInt32() [1/2]

bool Steinberg::ConstString::scanUInt32	(	const tchar *	text,
		uint32 &	value,
		bool	scanToEnd = true )

inlinestatic

Converts string of type tchar to int32 value.

◆ scanUInt32() [2/2]

bool Steinberg::ConstString::scanUInt32	(	uint32 &	value,
		uint32	offset = 0,
		bool	scanToEnd = true ) const

Converts string to uint32 value starting at offset.

◆ scanUInt32_16()

bool Steinberg::ConstString::scanUInt32_16	(	const char16 *	text,
		uint32 &	value,
		bool	scanToEnd = true )

inlinestatic

Converts string of type char16 to int32 value.

◆ scanUInt32_8()

bool Steinberg::ConstString::scanUInt32_8	(	const char8 *	text,
		uint32 &	value,
		bool	scanToEnd = true )

inlinestatic

Converts string of type char8 to int32 value.

◆ scanUInt64() [1/2]

bool Steinberg::ConstString::scanUInt64	(	const tchar *	text,
		uint64 &	value,
		bool	scanToEnd = true )

static

Converts string of type tchar to uint64 value.

◆ scanUInt64() [2/2]

bool Steinberg::ConstString::scanUInt64	(	uint64 &	value,
		uint32	offset = 0,
		bool	scanToEnd = true ) const

Converts string to uint64 value starting at offset.

◆ scanUInt64_16()

bool Steinberg::ConstString::scanUInt64_16	(	const char16 *	text,
		uint64 &	value,
		bool	scanToEnd = true )

static

Converts string of type char16 to uint64 value.

◆ scanUInt64_8()

bool Steinberg::ConstString::scanUInt64_8	(	const char8 *	text,
		uint64 &	value,
		bool	scanToEnd = true )

static

Converts string of type char8 to uint64 value.

◆ startsWith()

bool Steinberg::ConstString::startsWith	(	const ConstString &	str,
		CompareMode	m = kCaseSensitive ) const

Check if this starts with str.

◆ testChar() [1/2]

bool Steinberg::ConstString::testChar	(	uint32	index,
		char16	c ) const

inline

◆ testChar() [2/2]

bool Steinberg::ConstString::testChar	(	uint32	index,
		char8	c ) const

inline

◆ testChar16()

bool Steinberg::ConstString::testChar16	(	uint32	index,
		char16	c ) const

◆ testChar8()

bool Steinberg::ConstString::testChar8	(	uint32	index,
		char8	c ) const

Returns true if character is equal at position 'index'.

◆ text()

const tchar * Steinberg::ConstString::text ( ) const

inlinevirtual

Returns pointer to string of type tchar.

◆ text16()

const char16 * Steinberg::ConstString::text16 ( ) const

inlinevirtual

Returns pointer to string of type char16.

Reimplemented in Steinberg::String.

◆ text8()

const char8 * Steinberg::ConstString::text8 ( ) const

inlinevirtual

Returns pointer to string of type char8.

Reimplemented in Steinberg::String.

◆ toLower() [1/2]

char16 Steinberg::ConstString::toLower ( char16 c )

static

◆ toLower() [2/2]

char8 Steinberg::ConstString::toLower ( char8 c )

static

Converts to lower case.

◆ toUpper() [1/2]

char16 Steinberg::ConstString::toUpper ( char16 c )

static

◆ toUpper() [2/2]

char8 Steinberg::ConstString::toUpper ( char8 c )

static

Converts to upper case.

◆ toVariant()

void Steinberg::ConstString::toVariant ( FVariant & var ) const

◆ wideStringToMultiByte()

int32 Steinberg::ConstString::wideStringToMultiByte	(	char8 *	dest,
		const char16 *	source,
		int32	char8Count,
		uint32	destCodePage = kCP_Default )

static

If dest is zero, this returns the maximum number of bytes needed to convert source.

Member Data Documentation

◆ [union]

union { ... } Steinberg::ConstString

◆ buffer

void* Steinberg::ConstString::buffer

◆ buffer16

char16* Steinberg::ConstString::buffer16

◆ buffer8

char8* Steinberg::ConstString::buffer8

◆ isWide

uint32 Steinberg::ConstString::isWide

protected

◆ len

uint32 Steinberg::ConstString::len

protected

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

/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/base/source/fstring.h
/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/base/source/fstring.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ CompareMode

Constructor & Destructor Documentation

◆ ConstString() [1/5]

◆ ConstString() [2/5]

◆ ConstString() [3/5]

◆ ConstString() [4/5]

◆ ConstString() [5/5]

◆ ~ConstString()

Member Function Documentation

◆ compare() [1/2]

◆ compare() [2/2]

◆ compareAt()

◆ contains()

◆ copyTo() [1/3]

◆ copyTo() [2/3]

◆ copyTo() [3/3]

◆ copyTo16()

◆ copyTo8()

◆ countOccurences() [1/2]

◆ countOccurences() [2/2]

◆ endsWith()

◆ extract()

◆ findFirst() [1/3]

◆ findFirst() [2/3]

◆ findFirst() [3/3]

◆ findLast() [1/3]

◆ findLast() [2/3]

◆ findLast() [3/3]

◆ findNext() [1/3]

◆ findNext() [2/3]

◆ findNext() [3/3]

◆ findPrev() [1/3]

◆ findPrev() [2/3]

◆ findPrev() [3/3]

◆ getChar()

◆ getChar16()

◆ getChar8()

◆ getCharAt()

◆ getFirstDifferent()

◆ getNumber()

◆ getTrailingNumber()

◆ getTrailingNumberIndex()

◆ hash()

◆ isAsciiString()

◆ isCharAlpha() [1/2]

◆ isCharAlpha() [2/2]

◆ isCharAlphaNum() [1/2]

◆ isCharAlphaNum() [2/2]

◆ isCharAscii() [1/2]

◆ isCharAscii() [2/2]

◆ isCharDigit() [1/2]

◆ isCharDigit() [2/2]

◆ isCharLower() [1/2]

◆ isCharLower() [2/2]

◆ isCharSpace() [1/2]

◆ isCharSpace() [2/2]

◆ isCharUpper() [1/2]

◆ isCharUpper() [2/2]

◆ isDigit()

◆ isEmpty()

◆ isNormalized()

◆ isWideString()

◆ length()

◆ multiByteToWideString()

◆ naturalCompare()

◆ operator const char16 *()

◆ operator const char8 *()

◆ operator[]() [1/6]

◆ operator[]() [2/6]

◆ operator[]() [3/6]

◆ operator[]() [4/6]

◆ operator[]() [5/6]

◆ operator[]() [6/6]

◆ ptr()