CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iString Struct Reference
[Utilities]

This is a SCF-compatible interface for csString. More...

#include <string.h>

Inheritance diagram for iString:

iBase scfString List of all members.

Public Methods

virtual void SetCapacity (size_t NewSize)=0
 Advise the string that it should allocate enough space to hold up to NewSize characters. More...

virtual size_t GetCapacity () const=0
 Get string capacity. More...

virtual void SetGrowsBy (size_t)=0
 Advise the string that it should grow by approximately this many bytes when more space is required. More...

virtual size_t GetGrowsBy () const=0
 Get the allocation growth increment. More...

virtual void SetGrowsExponentially (bool)=0
 Tell the string to re-size its buffer exponentially as needed. More...

virtual bool GetGrowsExponentially () const=0
 Returns true if exponential growth is enabled. More...

virtual void Truncate (size_t iPos)=0
 Truncate the string. More...

virtual void Reclaim ()=0
 Set string maximal capacity to current string length. More...

void Clear ()
 Clear the string (so that it contains only ending 0 character). More...

virtual iString * Clone () const=0
 Get a copy of this string. More...

virtual char * GetData () const=0
 Get a pointer to ASCIIZ string. More...

virtual size_t Length () const=0
 Query string length. More...

bool IsEmpty () const
 Check if string is empty. More...

virtual char & operator[] (size_t iPos)=0
 Get a reference to iPos'th character. More...

virtual void SetAt (size_t iPos, char iChar)=0
 Set characetr number iPos to iChar. More...

virtual char GetAt (size_t iPos) const=0
 Get character at position iPos. More...

virtual void Insert (size_t iPos, iString *iStr)=0
 Insert another string into this one at position iPos. More...

virtual void Overwrite (size_t iPos, iString *iStr)=0
 Overlay another string onto a part of this string. More...

virtual iString & Append (const char *iStr, size_t iCount=(size_t)-1)=0
 Append an ASCIIZ string to this one (up to iCount characters). More...

virtual iString & Append (const iString *iStr, size_t iCount=(size_t)-1)=0
 Append a string to this one (possibly iCount characters from the string). More...

virtual void SubString (iString *sub, size_t start, size_t len)=0
 SubString another string out of this one. More...

virtual size_t FindFirst (const char c, size_t p=(size_t)-1)=0
 If the character cannot be found, this function returns (size_t)-1. More...

virtual size_t FindLast (const char c, size_t p=(size_t)-1)=0
 If the character cannot be found, this function returns (size_t)-1. More...

virtual void Format (const char *format,...)=0
 Format this string using sprintf() formatting directives. More...

virtual void FormatV (const char *format, va_list args)=0
 Format this string using sprintf() formatting directives in a va_list. More...

virtual void Replace (const iString *iStr, size_t iCount=(size_t)-1)=0
 Replace contents of this string with the contents of another. More...

virtual bool Compare (const iString *iStr) const=0
 Check if two strings are equal. More...

virtual bool CompareNoCase (const iString *iStr) const=0
 Compare two strings ignoring case. More...

iString & operator+= (const iString &iStr)
 Append another string to this. More...

iString & operator+= (const char *iStr)
 Append an ASCIIZ to this string. More...

iString & operator+ (const iString &iStr) const
 Concatenate two strings and return a third one. More...

 operator const char * () const
 Convert iString into ASCIIZ. More...

bool operator== (const iString &iStr) const
 Check if two strings are equal. More...


Detailed Description

This is a SCF-compatible interface for csString.

Definition at line 34 of file string.h.


Member Function Documentation

virtual iString& iString::Append const iString *    iStr,
size_t    iCount = (size_t)-1
[pure virtual]
 

Append a string to this one (possibly iCount characters from the string).

Implemented in scfString.

virtual iString& iString::Append const char *    iStr,
size_t    iCount = (size_t)-1
[pure virtual]
 

Append an ASCIIZ string to this one (up to iCount characters).

Implemented in scfString.

Referenced by operator+, and operator+=.

void iString::Clear   [inline]
 

Clear the string (so that it contains only ending 0 character).

Definition at line 73 of file string.h.

References Truncate.

virtual iString* iString::Clone   const [pure virtual]
 

Get a copy of this string.

Implemented in scfString.

Referenced by operator+.

virtual bool iString::Compare const iString *    iStr const [pure virtual]
 

Check if two strings are equal.

Implemented in scfString.

Referenced by operator==.

virtual bool iString::CompareNoCase const iString *    iStr const [pure virtual]
 

Compare two strings ignoring case.

Implemented in scfString.

virtual size_t iString::FindFirst const char    c,
size_t    p = (size_t)-1
[pure virtual]
 

If the character cannot be found, this function returns (size_t)-1.

Implemented in scfString.

virtual size_t iString::FindLast const char    c,
size_t    p = (size_t)-1
[pure virtual]
 

If the character cannot be found, this function returns (size_t)-1.

Implemented in scfString.

virtual void iString::Format const char *    format,
...   
[pure virtual]
 

Format this string using sprintf() formatting directives.

Automatically allocates sufficient memory to hold result. Newly formatted string overwrites previous string value.

Implemented in scfString.

virtual void iString::FormatV const char *    format,
va_list    args
[pure virtual]
 

Format this string using sprintf() formatting directives in a va_list.

Automatically allocates sufficient memory to hold result. Newly formatted string overwrites previous string value.

Implemented in scfString.

virtual char iString::GetAt size_t    iPos const [pure virtual]
 

Get character at position iPos.

Implemented in scfString.

virtual size_t iString::GetCapacity   const [pure virtual]
 

Get string capacity.

Implemented in scfString.

virtual char* iString::GetData   const [pure virtual]
 

Get a pointer to ASCIIZ string.

Implemented in scfString.

Referenced by operator const char *.

virtual size_t iString::GetGrowsBy   const [pure virtual]
 

Get the allocation growth increment.

Implemented in scfString.

virtual bool iString::GetGrowsExponentially   const [pure virtual]
 

Returns true if exponential growth is enabled.

Implemented in scfString.

virtual void iString::Insert size_t    iPos,
iString *    iStr
[pure virtual]
 

Insert another string into this one at position iPos.

Implemented in scfString.

bool iString::IsEmpty   const [inline]
 

Check if string is empty.

Definition at line 86 of file string.h.

References Length.

virtual size_t iString::Length   const [pure virtual]
 

Query string length.

Implemented in scfString.

Referenced by IsEmpty.

iString::operator const char *   const [inline]
 

Convert iString into ASCIIZ.

Definition at line 163 of file string.h.

References GetData.

iString& iString::operator+ const iString &    iStr const [inline]
 

Concatenate two strings and return a third one.

Definition at line 159 of file string.h.

References Append, and Clone.

iString& iString::operator+= const char *    iStr [inline]
 

Append an ASCIIZ to this string.

Definition at line 155 of file string.h.

References Append.

iString& iString::operator+= const iString &    iStr [inline]
 

Append another string to this.

Definition at line 151 of file string.h.

References Append.

bool iString::operator== const iString &    iStr const [inline]
 

Check if two strings are equal.

Definition at line 167 of file string.h.

References Compare.

virtual char& iString::operator[] size_t    iPos [inline, pure virtual]
 

Get a reference to iPos'th character.

Implemented in scfString.

virtual void iString::Overwrite size_t    iPos,
iString *    iStr
[pure virtual]
 

Overlay another string onto a part of this string.

Implemented in scfString.

virtual void iString::Reclaim   [pure virtual]
 

Set string maximal capacity to current string length.

Implemented in scfString.

virtual void iString::Replace const iString *    iStr,
size_t    iCount = (size_t)-1
[pure virtual]
 

Replace contents of this string with the contents of another.

Implemented in scfString.

virtual void iString::SetAt size_t    iPos,
char    iChar
[pure virtual]
 

Set characetr number iPos to iChar.

Implemented in scfString.

virtual void iString::SetCapacity size_t    NewSize [pure virtual]
 

Advise the string that it should allocate enough space to hold up to NewSize characters.

After calling this method, the string's capacity will be at least NewSize + 1 (one for the implicit null terminator). Never shrinks capacity. If you need to actually reclaim memory, then use Free() or Reclaim().

Implemented in scfString.

virtual void iString::SetGrowsBy size_t    [pure virtual]
 

Advise the string that it should grow by approximately this many bytes when more space is required.

This value is only a suggestion. The actual value by which it grows may be rounded up or down to an implementation-dependent allocation multiple.

Implemented in scfString.

virtual void iString::SetGrowsExponentially bool    [pure virtual]
 

Tell the string to re-size its buffer exponentially as needed.

If set to true, the GetGrowsBy() setting is ignored.

Implemented in scfString.

virtual void iString::SubString iString *    sub,
size_t    start,
size_t    len
[pure virtual]
 

SubString another string out of this one.

The result is placed in 'sub'. The substring is from 'start', of length 'len'.

Implemented in scfString.

virtual void iString::Truncate size_t    iPos [pure virtual]
 

Truncate the string.

Implemented in scfString.

Referenced by Clear.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14