ULIS  dev4.0.7
Utility Library for Imaging Systems
Public Types | Public Member Functions | Static Public Member Functions | List of all members
FWString Class Reference

The FWString class provides a simple dynamic string class. More...

Public Types

typedef wchar_t char_type
 

Public Member Functions

 FWString ()
 
 FWString (const char_type *iStr)
 
 FWString (const FString &iWStr)
 
 FWString (const FWString &iStr)
 
 FWString (FWString &&iStr)
 
 ~FWString ()
 
FWStringAppend (char_type iChar)
 
FWStringAppend (const char_type *iStr)
 
FWStringAppend (const FWString &iStr)
 
char_typeAt (uint64 iIndex)
 
const char_typeAt (uint64 iIndex) const
 
char_typeBack ()
 
const char_typeBack () const
 
uint64 Capacity () const
 
void Clear ()
 
FWString Copy () const
 
const char_typeData () const
 
FWStringErase (uint64 iPos, uint64 iCount)
 
int64 FindFirst (const FWString &iStr) const
 
int64 FindFrom (uint64 iPos, const FWString &iStr) const
 
int64 FindLast (const FWString &iStr) const
 
char_typeFront ()
 
const char_typeFront () const
 
FWStringInsert (uint64 iPos, const FWString &iStr)
 
bool IsEmpty () const
 
bool operator!= (const FWString &iOther)
 
FWStringoperator= (const FWString &iStr)
 
FWStringoperator= (FWString &&iStr)
 
bool operator== (const FWString &iOther)
 
char_typeoperator[] (uint64 iIndex)
 
const char_typeoperator[] (uint64 iIndex) const
 
FWStringPrepend (char_type iChar)
 
FWStringPrepend (const char_type *iStr)
 
FWStringPrepend (const FWString &iStr)
 
void ReplaceAll (const FWString &iA, const FWString &iB)
 
bool ReplaceFirst (const FWString &iA, const FWString &iB)
 
bool ReplaceFrom (uint64 iPos, const FWString &iA, const FWString &iB)
 
bool ReplaceLast (const FWString &iA, const FWString &iB)
 
void Reserve (uint64 iCapacity)
 
void Resize (uint64 iSize, char_type iChar=char_type())
 
void Shrink ()
 
uint64 Size () const
 
TArray< FWStringSplit (const FWString &iSep) const
 
FWString SubString (uint64 iPos, uint64 iCount) const
 
double ToDouble () const
 
float ToFloat () const
 
int ToInt () const
 
FWString ToLower () const
 
FString ToString () const
 
unsigned int ToUnsignedInt () const
 
FWString ToUpper () const
 
FWStringTransformLowerCase ()
 
FWStringTransformUpperCase ()
 

Static Public Member Functions

static FWString FromDouble (double iValue)
 
static FWString FromFloat (float iValue)
 
static FWString FromInt (int iValue)
 
static FWString FromString (const FString &iValue)
 
static FWString FromUnsignedInt (unsigned int iValue)
 

Detailed Description

The need of a custom FWString class rose from the fact that std:: classes cannot be exported easily accross dll boundaries when ULIS is compiled as a shared library.

See also
FString

Member Typedef Documentation

◆ char_type

typedef wchar_t FWString::char_type

Constructor & Destructor Documentation

◆ ~FWString()

FWString::~FWString ( )

◆ FWString() [1/5]

FWString::FWString ( )

◆ FWString() [2/5]

FWString::FWString ( const char_type iStr)

◆ FWString() [3/5]

FWString::FWString ( const FWString iStr)

◆ FWString() [4/5]

FWString::FWString ( FWString &&  iStr)

◆ FWString() [5/5]

FWString::FWString ( const FString iWStr)

Member Function Documentation

◆ Append() [1/3]

FWString& FWString::Append ( char_type  iChar)

Append a char.

◆ Append() [2/3]

FWString& FWString::Append ( const char_type iStr)

Append a string.

◆ Append() [3/3]

FWString& FWString::Append ( const FWString iStr)

Append a string.

◆ At() [1/2]

char_type& FWString::At ( uint64  iIndex)

Access char_type at index.

◆ At() [2/2]

const char_type& FWString::At ( uint64  iIndex) const

Access const char_type at index.

◆ Back() [1/2]

char_type& FWString::Back ( )

Access char_type at back.

◆ Back() [2/2]

const char_type& FWString::Back ( ) const

Access const char_type at back.

◆ Capacity()

uint64 FWString::Capacity ( ) const

Returns the string capacity.

◆ Clear()

void FWString::Clear ( )

Clear the string, deallocating everything.

◆ Copy()

FWString FWString::Copy ( ) const

◆ Data()

const char_type* FWString::Data ( ) const

Returns the const raw storage.

◆ Erase()

FWString& FWString::Erase ( uint64  iPos,
uint64  iCount 
)

◆ FindFirst()

int64 FWString::FindFirst ( const FWString iStr) const

◆ FindFrom()

int64 FWString::FindFrom ( uint64  iPos,
const FWString iStr 
) const

◆ FindLast()

int64 FWString::FindLast ( const FWString iStr) const

◆ FromDouble()

static FWString FWString::FromDouble ( double  iValue)
static

◆ FromFloat()

static FWString FWString::FromFloat ( float  iValue)
static

◆ FromInt()

static FWString FWString::FromInt ( int  iValue)
static

◆ FromString()

static FWString FWString::FromString ( const FString iValue)
static

◆ FromUnsignedInt()

static FWString FWString::FromUnsignedInt ( unsigned int  iValue)
static

◆ Front() [1/2]

char_type& FWString::Front ( )

Access char_type at front.

◆ Front() [2/2]

const char_type& FWString::Front ( ) const

Access const char_type at front.

◆ Insert()

FWString& FWString::Insert ( uint64  iPos,
const FWString iStr 
)

◆ IsEmpty()

bool FWString::IsEmpty ( ) const

Returns wether the array is empty or not.

◆ operator!=()

bool FWString::operator!= ( const FWString iOther)

◆ operator=() [1/2]

FWString& FWString::operator= ( const FWString iStr)

◆ operator=() [2/2]

FWString& FWString::operator= ( FWString &&  iStr)

◆ operator==()

bool FWString::operator== ( const FWString iOther)

◆ operator[]() [1/2]

char_type& FWString::operator[] ( uint64  iIndex)

Access char_type at index.

◆ operator[]() [2/2]

const char_type& FWString::operator[] ( uint64  iIndex) const

Access const char_type at index.

◆ Prepend() [1/3]

FWString& FWString::Prepend ( char_type  iChar)

Prepend a char.

◆ Prepend() [2/3]

FWString& FWString::Prepend ( const char_type iStr)

Prepend a string.

◆ Prepend() [3/3]

FWString& FWString::Prepend ( const FWString iStr)

Prepend a string.

◆ ReplaceAll()

void FWString::ReplaceAll ( const FWString iA,
const FWString iB 
)

◆ ReplaceFirst()

bool FWString::ReplaceFirst ( const FWString iA,
const FWString iB 
)

◆ ReplaceFrom()

bool FWString::ReplaceFrom ( uint64  iPos,
const FWString iA,
const FWString iB 
)

◆ ReplaceLast()

bool FWString::ReplaceLast ( const FWString iA,
const FWString iB 
)

◆ Reserve()

void FWString::Reserve ( uint64  iCapacity)

Reserve some capacity for future usage, if iCapacity is bigger than the current capacity. If iCapacity is lower or equal to capacity, this function does nothing. This function might invalid the underlying buffer. The size doesn't change.

◆ Resize()

void FWString::Resize ( uint64  iSize,
char_type  iChar = char_type() 
)

Resize the actual usage size of the container. This function might invalid the underlying buffer.

◆ Shrink()

void FWString::Shrink ( )

Shrink the capacity to fit the size. If the capacity is already the same as the size, the function does nothing. This function might invalid the underlying buffer. The size doesn't change.

◆ Size()

uint64 FWString::Size ( ) const

Returns the string size.

◆ Split()

TArray< FWString > FWString::Split ( const FWString iSep) const

Split the string.

◆ SubString()

FWString FWString::SubString ( uint64  iPos,
uint64  iCount 
) const

◆ ToDouble()

double FWString::ToDouble ( ) const

◆ ToFloat()

float FWString::ToFloat ( ) const

◆ ToInt()

int FWString::ToInt ( ) const

◆ ToLower()

FWString FWString::ToLower ( ) const

◆ ToString()

FString FWString::ToString ( ) const

Convert to WString.

◆ ToUnsignedInt()

unsigned int FWString::ToUnsignedInt ( ) const

◆ ToUpper()

FWString FWString::ToUpper ( ) const

◆ TransformLowerCase()

FWString& FWString::TransformLowerCase ( )

◆ TransformUpperCase()

FWString& FWString::TransformUpperCase ( )