JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
Steinberg::ConstString Class Reference

Invariant String. More...

#include "fstring.h"

Inheritance diagram for Steinberg::ConstString:
Steinberg::String Steinberg::StringObject

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.
 
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.

Definition at line 116 of file fstring.h.

Member Enumeration Documentation

◆ CompareMode

Enumerator
kCaseSensitive 

Comparison is done with regard to character's case.

kCaseInsensitive 

Comparison is done without regard to character's case.

Definition at line 169 of file fstring.h.

Constructor & Destructor Documentation

◆ ConstString() [1/5]

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

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

Definition at line 444 of file fstring.cpp.

◆ ConstString() [2/5]

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

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

Definition at line 452 of file fstring.cpp.

◆ ConstString() [3/5]

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

Copy constructor (length=-1: all).

Definition at line 460 of file fstring.cpp.

◆ ConstString() [4/5]

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

Assign a string from FVariant.

Definition at line 475 of file fstring.cpp.

◆ ConstString() [5/5]

Steinberg::ConstString::ConstString ( )

Definition at line 497 of file fstring.cpp.

◆ ~ConstString()

virtual Steinberg::ConstString::~ConstString ( )
virtual

Destructor.

Definition at line 125 of file fstring.h.

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)

Definition at line 701 of file fstring.cpp.

◆ 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)

Definition at line 659 of file fstring.cpp.

◆ 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)

Definition at line 707 of file fstring.cpp.

◆ contains()

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

Check if this contains str

Definition at line 905 of file fstring.cpp.

◆ copyTo() [1/3]

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

Copies whole member string.

Definition at line 648 of file fstring.cpp.

◆ copyTo() [2/3]

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

Copies whole member string.

Definition at line 625 of file fstring.cpp.

◆ copyTo() [3/3]

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

Definition at line 615 of file fstring.cpp.

◆ copyTo16()

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

Definition at line 587 of file fstring.cpp.

◆ copyTo8()

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

Definition at line 559 of file fstring.cpp.

◆ countOccurences() [1/2]

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

Definition at line 1242 of file fstring.cpp.

◆ countOccurences() [2/2]

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

Counts occurences of c within this starting at index.

Definition at line 1214 of file fstring.cpp.

◆ endsWith()

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

Check if this ends with str.

Definition at line 859 of file fstring.cpp.

◆ 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)

Definition at line 539 of file fstring.cpp.

◆ findFirst() [1/3]

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

Definition at line 206 of file fstring.h.

◆ findFirst() [2/3]

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

Definition at line 205 of file fstring.h.

◆ findFirst() [3/3]

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

Definition at line 204 of file fstring.h.

◆ findLast() [1/3]

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

Definition at line 223 of file fstring.h.

◆ findLast() [2/3]

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

Definition at line 222 of file fstring.h.

◆ findLast() [3/3]

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

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

Definition at line 221 of file fstring.h.

◆ findNext() [1/3]

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

Definition at line 1024 of file fstring.cpp.

◆ findNext() [2/3]

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

Definition at line 984 of file fstring.cpp.

◆ findNext() [3/3]

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

Definition at line 911 of file fstring.cpp.

◆ findPrev() [1/3]

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

Definition at line 1105 of file fstring.cpp.

◆ findPrev() [2/3]

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

Definition at line 1065 of file fstring.cpp.

◆ findPrev() [3/3]

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

Definition at line 1146 of file fstring.cpp.

◆ getChar()

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

Returns character of type tchar at 'index'.

Definition at line 539 of file fstring.h.

◆ getChar16()

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

Returns character of type char8 at 'index'.

Reimplemented in Steinberg::String.

Definition at line 531 of file fstring.h.

◆ getChar8()

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

Returns character of type char16 at 'index'.

Reimplemented in Steinberg::String.

Definition at line 523 of file fstring.h.

◆ getCharAt()

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

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

Definition at line 549 of file fstring.h.

◆ getFirstDifferent()

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

Returns position of first different character.

Definition at line 1270 of file fstring.cpp.

◆ getNumber()

int64 Steinberg::ConstString::getNumber ( ) const

Returns result of scanInt64.

Definition at line 560 of file fstring.h.

◆ getTrailingNumber()

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

Returns result of scanInt64 or the fallback.

Definition at line 1755 of file fstring.cpp.

◆ getTrailingNumberIndex()

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

Returns start index of trailing number.

Definition at line 1732 of file fstring.cpp.

◆ hash()

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

Definition at line 162 of file fstring.h.

◆ isAsciiString()

bool Steinberg::ConstString::isAsciiString ( ) const

Checks if all characters in string are in ascii range.

Definition at line 1784 of file fstring.cpp.

◆ isCharAlpha() [1/2]

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

Returns true if character is an alphabetic character.

Definition at line 1655 of file fstring.cpp.

◆ isCharAlpha() [2/2]

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

Returns true if character is an alphabetic character.

Definition at line 1649 of file fstring.cpp.

◆ isCharAlphaNum() [1/2]

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

Returns true if character is an alphanumeric character.

Definition at line 1667 of file fstring.cpp.

◆ isCharAlphaNum() [2/2]

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

Returns true if character is an alphanumeric character.

Definition at line 1661 of file fstring.cpp.

◆ isCharAscii() [1/2]

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

Returns true if character is in ASCII range.

Definition at line 1691 of file fstring.cpp.

◆ isCharAscii() [2/2]

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

Returns true if character is in ASCII range.

Definition at line 1685 of file fstring.cpp.

◆ isCharDigit() [1/2]

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

Returns true if character is a number.

Definition at line 1679 of file fstring.cpp.

◆ isCharDigit() [2/2]

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

Returns true if character is a number.

Definition at line 1673 of file fstring.cpp.

◆ isCharLower() [1/2]

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

Definition at line 1715 of file fstring.cpp.

◆ isCharLower() [2/2]

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

Definition at line 1709 of file fstring.cpp.

◆ isCharSpace() [1/2]

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

Returns true if character is a space.

Definition at line 1624 of file fstring.cpp.

◆ isCharSpace() [2/2]

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

Returns true if character is a space.

Definition at line 1618 of file fstring.cpp.

◆ isCharUpper() [1/2]

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

Definition at line 1703 of file fstring.cpp.

◆ isCharUpper() [2/2]

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

Definition at line 1697 of file fstring.cpp.

◆ isDigit()

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

Returns true if character at position is a digit.

Definition at line 1721 of file fstring.cpp.

◆ isEmpty()

bool Steinberg::ConstString::isEmpty ( ) const

Return true if string is empty.

Definition at line 129 of file fstring.h.

◆ isNormalized()

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

On PC only kUnicodeNormC is working.

Definition at line 1971 of file fstring.cpp.

◆ isWideString()

bool Steinberg::ConstString::isWideString ( ) const

Returns true if string is wide.

Definition at line 276 of file fstring.h.

◆ length()

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

Return length of string.

Definition at line 128 of file fstring.h.

◆ 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.

Definition at line 1823 of file fstring.cpp.

◆ naturalCompare()

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

Definition at line 785 of file fstring.cpp.

◆ operator const char16 *()

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

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

Definition at line 132 of file fstring.h.

◆ operator const char8 *()

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

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

Definition at line 131 of file fstring.h.

◆ operator[]() [1/6]

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

Definition at line 135 of file fstring.h.

◆ operator[]() [2/6]

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

Definition at line 134 of file fstring.h.

◆ operator[]() [3/6]

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

Returns character at 'idx'.

Definition at line 133 of file fstring.h.

◆ operator[]() [4/6]

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

Definition at line 138 of file fstring.h.

◆ operator[]() [5/6]

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

Definition at line 137 of file fstring.h.

◆ operator[]() [6/6]

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

Definition at line 136 of file fstring.h.

◆ ptr()

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

Returns pointer to string of type void.

Definition at line 143 of file fstring.h.

◆ scanFloat()

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

Converts string to double value starting at offset.

Definition at line 1501 of file fstring.cpp.

◆ 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.

Definition at line 1491 of file fstring.cpp.

◆ 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.

Definition at line 1356 of file fstring.cpp.

◆ 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.

Definition at line 1479 of file fstring.cpp.

◆ 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.

Definition at line 1461 of file fstring.cpp.

◆ scanInt32() [1/2]

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

Converts string of type tchar to int32 value.

Definition at line 592 of file fstring.h.

◆ scanInt32() [2/2]

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

Converts string to int32 value starting at offset.

Definition at line 1367 of file fstring.cpp.

◆ scanInt32_16()

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

Converts string of type char16 to int32 value.

Definition at line 580 of file fstring.h.

◆ scanInt32_8()

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

Converts string of type char8 to int32 value.

Definition at line 568 of file fstring.h.

◆ scanInt64() [1/2]

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

Converts string of type tchar to int64 value.

Definition at line 1441 of file fstring.cpp.

◆ scanInt64() [2/2]

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

Converts string to int64 value starting at offset.

Definition at line 1334 of file fstring.cpp.

◆ scanInt64_16()

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

Converts string of type char16 to int64 value.

Definition at line 1403 of file fstring.cpp.

◆ scanInt64_8()

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

Converts string of type char8 to int64 value.

Definition at line 1389 of file fstring.cpp.

◆ scanUInt32() [1/2]

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

Converts string of type tchar to int32 value.

Definition at line 628 of file fstring.h.

◆ scanUInt32() [2/2]

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

Converts string to uint32 value starting at offset.

Definition at line 1378 of file fstring.cpp.

◆ scanUInt32_16()

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

Converts string of type char16 to int32 value.

Definition at line 616 of file fstring.h.

◆ scanUInt32_8()

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

Converts string of type char8 to int32 value.

Definition at line 604 of file fstring.h.

◆ scanUInt64() [1/2]

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

Converts string of type tchar to uint64 value.

Definition at line 1451 of file fstring.cpp.

◆ scanUInt64() [2/2]

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

Converts string to uint64 value starting at offset.

Definition at line 1345 of file fstring.cpp.

◆ scanUInt64_16()

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

Converts string of type char16 to uint64 value.

Definition at line 1429 of file fstring.cpp.

◆ scanUInt64_8()

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

Converts string of type char8 to uint64 value.

Definition at line 1415 of file fstring.cpp.

◆ startsWith()

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

Check if this starts with str.

Definition at line 813 of file fstring.cpp.

◆ testChar() [1/2]

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

Definition at line 153 of file fstring.h.

◆ testChar() [2/2]

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

Definition at line 152 of file fstring.h.

◆ testChar16()

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

Definition at line 522 of file fstring.cpp.

◆ testChar8()

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

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

Definition at line 505 of file fstring.cpp.

◆ text()

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

Returns pointer to string of type tchar.

Definition at line 501 of file fstring.h.

◆ text16()

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

Returns pointer to string of type char16.

Reimplemented in Steinberg::String.

Definition at line 517 of file fstring.h.

◆ text8()

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

Returns pointer to string of type char8.

Reimplemented in Steinberg::String.

Definition at line 511 of file fstring.h.

◆ toLower() [1/2]

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

Definition at line 1534 of file fstring.cpp.

◆ toLower() [2/2]

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

Converts to lower case.

Definition at line 1590 of file fstring.cpp.

◆ toUpper() [1/2]

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

Definition at line 1562 of file fstring.cpp.

◆ toUpper() [2/2]

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

Converts to upper case.

Definition at line 1604 of file fstring.cpp.

◆ toVariant()

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

Definition at line 1771 of file fstring.cpp.

◆ 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.

Definition at line 1889 of file fstring.cpp.

Member Data Documentation

◆ isWide

uint32 Steinberg::ConstString::isWide
protected

Definition at line 301 of file fstring.h.

◆ len

uint32 Steinberg::ConstString::len
protected

Definition at line 300 of file fstring.h.


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