Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
CP_PropertyList::String

CP_PropertyList::String Class Reference

Inheritance diagram for CP_PropertyList::String:

CP_PropertyList::Node CP_String CP_M_RefCounted List of all members.

Public Types

typedef CFStringRef StringRef
typedef std::reverse_iterator<
const_iterator > 		const_reverse_iterator
typedef std::reverse_iterator<
iterator > 		reverse_iterator
enum  { kCP_E_String_BufferSize = 32, npos = MAX_UINT_32 }

Public Member Functions

 String ()
 String (const String &inSrc)
 String (const CP_String &inSrc)
 String (CFStringRef inRef, bool inRetain)
virtual ~String () throw ()
virtual void PrintToLog (CP_LogFile &inLogFile, SInt32 inLevel=0, SInt32 inIndentLevel=0) const
virtual NodeType_t NodeType () const throw ()
virtual CFTypeRef GetNodeCFRef () const
virtual void WriteXMLData (CP_OutStream &inXMLDataStream) const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Accessors
const char * c_str (bool inLossy=false, const CP_TextEncoder *inTextEncoder=NULL) const
const CPUniChar * w_str () const
const char * utf8_str () const
CPUniChar operator[] (UInt32 inIndex) const
reference operator[] (UInt32 inIndex)
CPUniChar at (UInt32 inIndex) const
reference at (UInt32 inIndex)
CPUniChar front () const
reference front ()
CPUniChar back () const
reference back ()
StringRef Ref () const
Appending
CP_String & operator+= (char inChar)
CP_String & operator+= (unsigned char inChar)
CP_String & operator+= (CPUniChar inChar)
CP_String & operator+= (const char *inString)
CP_String & operator+= (const CPUniChar *inString)
CP_String & operator+= (const CP_String &inString)
CP_String & append (char ch, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & append (unsigned char ch, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & append (CPUniChar ch)
CP_String & append (UInt32 inCount, CPUniChar inChar)
CP_String & append (const char *inString, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & append (const char *inString, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & append (const CPUniChar *inString)
CP_String & append (const CPUniChar *inString, UInt32 inLength)
CP_String & append (const CP_String &inString, UInt32 inStartIndex=0, UInt32 inLength=npos)
void push_back (CPUniChar inChar)
Compare
SInt32 compare (const char *inChar, const CP_TextEncoder *inTextEncoder=NULL) const
SInt32 compare (const CPUniChar *inChar) const
SInt32 compare (const CP_String &inString) const
SInt32 compare (UInt32 inIndex, UInt32 inCount, const CPUniChar *inString, UInt32 inLength) const
SInt32 compare (UInt32 inIndex, UInt32 inCount, const CP_String &inString, UInt32 inStartIndex=0, UInt32 inLength=npos) const
Erasing
CP_String & erase (UInt32 inIndex=0, UInt32 inCount=npos)
void pop_back ()
Finding
UInt32 find (CPUniChar inChar, UInt32 inIndex=0) const
UInt32 find (const char *inString, UInt32 inIndex=0, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find (const char *inString, UInt32 inIndex, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find (const CPUniChar *inString, UInt32 inndex=0) const
UInt32 find (const CPUniChar *inString, UInt32 inIndex, UInt32 inLength) const
UInt32 find (const CP_String &inString, UInt32 inndex=0) const
UInt32 rfind (CPUniChar inChar, UInt32 inIndex=npos) const
UInt32 rfind (const char *inString, UInt32 inIndex=npos, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 rfind (const char *inString, UInt32 inIndex, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 rfind (const CPUniChar *inString, UInt32 inIndex=npos) const
UInt32 rfind (const CPUniChar *inString, UInt32 inIndex, UInt32 inLength) const
UInt32 rfind (const CP_String &inString, UInt32 inIndex=npos) const
UInt32 find_first_of (CPUniChar inChar, UInt32 inIndex=0) const
UInt32 find_first_of (const char *inString, UInt32 inIndex=0, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_first_of (const char *inString, UInt32 inIndex, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_first_of (const CPUniChar *inString, UInt32 inIndex=0) const
UInt32 find_first_of (const CPUniChar *inString, UInt32 inIndex, UInt32 inLength) const
UInt32 find_first_of (const CP_String &inString, UInt32 inIndex=0) const
UInt32 find_last_of (CPUniChar inChar, UInt32 inIndex=npos) const
UInt32 find_last_of (const char *inString, UInt32 inIndex=npos, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_last_of (const char *inString, UInt32 inIndex, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_last_of (const CPUniChar *inString, UInt32 inIndex=npos) const
UInt32 find_last_of (const CPUniChar *inString, UInt32 inIndex, UInt32 inLength) const
UInt32 find_last_of (const CP_String &inString, UInt32 inIndex=npos) const
UInt32 find_first_not_of (CPUniChar inChar, UInt32 inIndex=0) const
UInt32 find_first_not_of (const char *inString, UInt32 inIndex=0, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_first_not_of (const char *inString, UInt32 inIndex, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_first_not_of (const CPUniChar *inString, UInt32 inIndex=0) const
UInt32 find_first_not_of (const CPUniChar *inString, UInt32 inIndex, UInt32 inLength) const
UInt32 find_first_not_of (const CP_String &inString, UInt32 inIndex=0) const
UInt32 find_last_not_of (CPUniChar inChar, UInt32 inIndex=npos) const
UInt32 find_last_not_of (const char *inString, UInt32 inIndex=npos, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_last_not_of (const char *inString, UInt32 inIndex, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_last_not_of (const CPUniChar *inString, UInt32 inIndex=npos) const
UInt32 find_last_not_of (const CPUniChar *inString, UInt32 inIndex, UInt32 inLength) const
UInt32 find_last_not_of (const CP_String &inString, UInt32 inIndex=npos) const
Inserting
CP_String & insert (UInt32 inIndex, CPUniChar inChar)
CP_String & insert (UInt32 inIndex, UInt32 inCount, CPUniChar inChar)
CP_String & insert (UInt32 inIndex, const char *inString, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & insert (UInt32 inIndex, const char *inString, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & insert (UInt32 inIndex, const CPUniChar *inString)
CP_String & insert (UInt32 inIndex, const CPUniChar *inString, UInt32 inLength)
CP_String & insert (UInt32 inIndex, const CP_String &inString, UInt32 inStartIndex=0, UInt32 inLength=npos)
Replacing
CP_String & replace (UInt32 inIndex, UInt32 inCount, UInt32 inCharCount, CPUniChar inChar)
CP_String & replace (UInt32 inIndex, UInt32 inCount, const char *inString, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & replace (UInt32 inIndex, UInt32 inCount, const char *inString, UInt32 InLength, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & replace (UInt32 inIndex, UInt32 inCount, const CPUniChar *inString)
CP_String & replace (UInt32 inIndex, UInt32 inCount, const CPUniChar *inString, UInt32 inLength)
CP_String & replace (UInt32 inIndex, UInt32 inCount, const CP_String &inString, UInt32 inStartIndex=0, UInt32 inLength=npos)
Size
UInt32 length () const
UInt32 size () const
void resize (UInt32 inNewSize)
void resize (UInt32 inNewSize, CPUniChar inChar)
UInt32 capacity () const
bool Empty () const
bool empty () const
void clear ()
Iterators
iterator begin ()
const_iterator begin () const
iterator end ()
const_iterator end () const
reverse_iterator rbegin ()
const_reverse_iterator rbegin () const
reverse_iterator rend ()
const_reverse_iterator rend () const
Misc
CP_String substr (UInt32 inIndex=0, UInt32 inCount=npos) const
UInt32 copy (char *inOutBuffer, UInt32 inBufferSize, UInt32 inCount, UInt32 *outUsedBufferSize, UInt32 inIndex=0, const CP_TextEncoder *inTextEncoder=NULL, bool inLossy=false) const
UInt32 copy (CPUniChar *inOutBuffer, UInt32 inCount, UInt32 inIndex=0) const
void swap (CP_String &inString)
void reserve (UInt32 inCapacity)
Setters
void Set (const unsigned char *inPString, CFStringEncoding inEncoding)
Substring
void Substring (CFRange inRange, CPUniChar *inOutBuffer) const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Reference
UInt32 AddReference () const
UInt32 RemoveReference () const
Autorelease
void Autorelease () const
Getters
UInt32 GetRefCount () const
Accessors
const char * c_str (bool inLossy=false, const CP_TextEncoder *inTextEncoder=NULL) const
const CPUniChar * w_str () const
const char * utf8_str () const
CPUniChar operator[] (UInt32 inIndex) const
reference operator[] (UInt32 inIndex)
CPUniChar at (UInt32 inIndex) const
reference at (UInt32 inIndex)
CPUniChar front () const
reference front ()
CPUniChar back () const
reference back ()
StringRef Ref () const
Appending
CP_String & operator+= (char inChar)
CP_String & operator+= (unsigned char inChar)
CP_String & operator+= (CPUniChar inChar)
CP_String & operator+= (const char *inString)
CP_String & operator+= (const CPUniChar *inString)
CP_String & operator+= (const CP_String &inString)
CP_String & append (char ch, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & append (unsigned char ch, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & append (CPUniChar ch)
CP_String & append (UInt32 inCount, CPUniChar inChar)
CP_String & append (const char *inString, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & append (const char *inString, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & append (const CPUniChar *inString)
CP_String & append (const CPUniChar *inString, UInt32 inLength)
CP_String & append (const CP_String &inString, UInt32 inStartIndex=0, UInt32 inLength=npos)
void push_back (CPUniChar inChar)
Assignment
CP_String & assign (char inChar, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & assign (CPUniChar inChar)
CP_String & assign (UInt32 inCount, char inChar, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & assign (UInt32 inCount, CPUniChar inChar)
CP_String & assign (const char *inString, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & assign (const char *inString, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & assign (const CPUniChar *inString)
CP_String & assign (const CPUniChar *inString, UInt32 inLength)
CP_String & assign (const CP_String &inString, UInt32 inStartIndex=0, UInt32 inLength=npos)
Compare
SInt32 compare (const char *inChar, const CP_TextEncoder *inTextEncoder=NULL) const
SInt32 compare (const CPUniChar *inChar) const
SInt32 compare (const CP_String &inString) const
SInt32 compare (UInt32 inIndex, UInt32 inCount, const CPUniChar *inString, UInt32 inLength) const
SInt32 compare (UInt32 inIndex, UInt32 inCount, const CP_String &inString, UInt32 inStartIndex=0, UInt32 inLength=npos) const
Erasing
CP_String & erase (UInt32 inIndex=0, UInt32 inCount=npos)
void pop_back ()
Finding
UInt32 find (CPUniChar inChar, UInt32 inIndex=0) const
UInt32 find (const char *inString, UInt32 inIndex=0, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find (const char *inString, UInt32 inIndex, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find (const CPUniChar *inString, UInt32 inndex=0) const
UInt32 find (const CPUniChar *inString, UInt32 inIndex, UInt32 inLength) const
UInt32 find (const CP_String &inString, UInt32 inndex=0) const
UInt32 rfind (CPUniChar inChar, UInt32 inIndex=npos) const
UInt32 rfind (const char *inString, UInt32 inIndex=npos, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 rfind (const char *inString, UInt32 inIndex, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 rfind (const CPUniChar *inString, UInt32 inIndex=npos) const
UInt32 rfind (const CPUniChar *inString, UInt32 inIndex, UInt32 inLength) const
UInt32 rfind (const CP_String &inString, UInt32 inIndex=npos) const
UInt32 find_first_of (CPUniChar inChar, UInt32 inIndex=0) const
UInt32 find_first_of (const char *inString, UInt32 inIndex=0, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_first_of (const char *inString, UInt32 inIndex, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_first_of (const CPUniChar *inString, UInt32 inIndex=0) const
UInt32 find_first_of (const CPUniChar *inString, UInt32 inIndex, UInt32 inLength) const
UInt32 find_first_of (const CP_String &inString, UInt32 inIndex=0) const
UInt32 find_last_of (CPUniChar inChar, UInt32 inIndex=npos) const
UInt32 find_last_of (const char *inString, UInt32 inIndex=npos, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_last_of (const char *inString, UInt32 inIndex, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_last_of (const CPUniChar *inString, UInt32 inIndex=npos) const
UInt32 find_last_of (const CPUniChar *inString, UInt32 inIndex, UInt32 inLength) const
UInt32 find_last_of (const CP_String &inString, UInt32 inIndex=npos) const
UInt32 find_first_not_of (CPUniChar inChar, UInt32 inIndex=0) const
UInt32 find_first_not_of (const char *inString, UInt32 inIndex=0, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_first_not_of (const char *inString, UInt32 inIndex, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_first_not_of (const CPUniChar *inString, UInt32 inIndex=0) const
UInt32 find_first_not_of (const CPUniChar *inString, UInt32 inIndex, UInt32 inLength) const
UInt32 find_first_not_of (const CP_String &inString, UInt32 inIndex=0) const
UInt32 find_last_not_of (CPUniChar inChar, UInt32 inIndex=npos) const
UInt32 find_last_not_of (const char *inString, UInt32 inIndex=npos, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_last_not_of (const char *inString, UInt32 inIndex, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL) const
UInt32 find_last_not_of (const CPUniChar *inString, UInt32 inIndex=npos) const
UInt32 find_last_not_of (const CPUniChar *inString, UInt32 inIndex, UInt32 inLength) const
UInt32 find_last_not_of (const CP_String &inString, UInt32 inIndex=npos) const
Inserting
CP_String & insert (UInt32 inIndex, CPUniChar inChar)
CP_String & insert (UInt32 inIndex, UInt32 inCount, CPUniChar inChar)
CP_String & insert (UInt32 inIndex, const char *inString, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & insert (UInt32 inIndex, const char *inString, UInt32 inLength, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & insert (UInt32 inIndex, const CPUniChar *inString)
CP_String & insert (UInt32 inIndex, const CPUniChar *inString, UInt32 inLength)
CP_String & insert (UInt32 inIndex, const CP_String &inString, UInt32 inStartIndex=0, UInt32 inLength=npos)
Replacing
CP_String & replace (UInt32 inIndex, UInt32 inCount, UInt32 inCharCount, CPUniChar inChar)
CP_String & replace (UInt32 inIndex, UInt32 inCount, const char *inString, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & replace (UInt32 inIndex, UInt32 inCount, const char *inString, UInt32 InLength, const CP_TextEncoder *inTextEncoder=NULL)
CP_String & replace (UInt32 inIndex, UInt32 inCount, const CPUniChar *inString)
CP_String & replace (UInt32 inIndex, UInt32 inCount, const CPUniChar *inString, UInt32 inLength)
CP_String & replace (UInt32 inIndex, UInt32 inCount, const CP_String &inString, UInt32 inStartIndex=0, UInt32 inLength=npos)
Size
UInt32 length () const
UInt32 size () const
void resize (UInt32 inNewSize)
void resize (UInt32 inNewSize, CPUniChar inChar)
UInt32 capacity () const
bool Empty () const
bool empty () const
void clear ()
Iterators
iterator begin ()
const_iterator begin () const
iterator end ()
const_iterator end () const
reverse_iterator rbegin ()
const_reverse_iterator rbegin () const
reverse_iterator rend ()
const_reverse_iterator rend () const
Misc
CP_String substr (UInt32 inIndex=0, UInt32 inCount=npos) const
UInt32 copy (char *inOutBuffer, UInt32 inBufferSize, UInt32 inCount, UInt32 *outUsedBufferSize, UInt32 inIndex=0, const CP_TextEncoder *inTextEncoder=NULL, bool inLossy=false) const
UInt32 copy (CPUniChar *inOutBuffer, UInt32 inCount, UInt32 inIndex=0) const
void swap (CP_String &inString)
void reserve (UInt32 inCapacity)
Conversion
CFStringRef GetCFStringRef () const
CFMutableStringRef GetMutableCFStringRef ()
CP_ResourcePtr< CFStringRef > GetCFStringRefPtr () const
CP_ResourcePtr< CFMutableStringRef > GetMutableCFStringRefPtr ()
Setters
void Set (const unsigned char *inPString, CFStringEncoding inEncoding)
Substring
void Substring (CFRange inRange, CPUniChar *inOutBuffer) const

Static Public Member Functions

static String * FromXMLData (CP_InStream &inXMLDataStream)
static Node * FromXMLData (CP_InStream &inXMLDataStream, NodeType_t inExpectedNodeType=NodeType_Any)
static Node * CreateNodeForCFObject (CFTypeRef inObject)
Creating strings using printf-style format + parameters
static CP_String StringWithFormat (const char *inFormat,...)
 Create a string using printf-style format + parameters.
static CP_String StringWithFormatAndArguments (const CP_String &inFormat, va_list args)
 Create a string using printf-style format + parameter list.
Creating strings using printf-style format + parameters
static CP_String StringWithFormat (const char *inFormat,...)
 Create a string using printf-style format + parameters.
static CP_String StringWithFormatAndArguments (const CP_String &inFormat, va_list args)
 Create a string using printf-style format + parameter list.

Static Public Attributes

static const CP_String emptyString

Protected Member Functions

void AssertUniqueMutableCFStringRef ()

Protected Attributes

char * fCStringDataPtr
UInt32 fCStringDataCapacity
bool fDirty
CFStringRef fImmutableString
CFMutableStringRef fMutableString
CPUniChar * fStringData
UInt32 fStringDataCapacity

Friends

Concatenation
CP_String operator+ (const CP_String &inLeftSide, const CP_String &inRightSide)
CP_String operator+ (const CPUniChar *inLeftSide, const CP_String &inRightSide)
CP_String operator+ (CPUniChar inLeftSide, const CP_String &inRightSide)
CP_String operator+ (const CP_String &inLeftSide, const CPUniChar *inRightSide)
CP_String operator+ (const CP_String &inLeftSide, CPUniChar inRightSide)
Comparisons
bool operator== (char inLeftSide, const CP_String &inRightSide)
bool operator== (const char *inLeftSide, const CP_String &inRightSide)
bool operator== (CPUniChar inLeftSide, const CP_String &inRightSide)
bool operator== (const CPUniChar *inLeftSide, const CP_String &inRightSide)
bool operator== (const CP_String &inLeftSide, CPUniChar inRightSide)
bool operator== (const CP_String &inLeftSide, const char *inRightSide)
bool operator== (const CP_String &inLeftSide, const CPUniChar *inRightSide)
bool operator== (const CP_String &inLeftSide, const CP_String &inRightSide)
bool operator!= (CPUniChar inLeftSide, const CP_String &inRightSide)
bool operator!= (const CPUniChar *inLeftSide, const CP_String &inRightSide)
bool operator!= (const CP_String &inLeftSide, CPUniChar inRightSide)
bool operator!= (const CP_String &inLeftSide, const char *inRightSide)
bool operator!= (const CP_String &inLeftSide, const CPUniChar *inRightSide)
bool operator!= (const CP_String &inLeftSide, const CP_String &inRightSide)
bool operator< (const CP_String &inLeftSide, const CP_String &inRightSide)
bool operator<= (const CP_String &inLeftSide, const CP_String &inRightSide)
bool operator> (const CP_String &inLeftSide, const CP_String &inRightSide)
bool operator>= (const CP_String &inLeftSide, const CP_String &inRightSide)
Concatenation
CP_String operator+ (const CP_String &inLeftSide, const CP_String &inRightSide)
CP_String operator+ (const CPUniChar *inLeftSide, const CP_String &inRightSide)
CP_String operator+ (CPUniChar inLeftSide, const CP_String &inRightSide)
CP_String operator+ (const CP_String &inLeftSide, const CPUniChar *inRightSide)
CP_String operator+ (const CP_String &inLeftSide, CPUniChar inRightSide)
Comparisons
bool operator== (char inLeftSide, const CP_String &inRightSide)
bool operator== (const char *inLeftSide, const CP_String &inRightSide)
bool operator== (CPUniChar inLeftSide, const CP_String &inRightSide)
bool operator== (const CPUniChar *inLeftSide, const CP_String &inRightSide)
bool operator== (const CP_String &inLeftSide, CPUniChar inRightSide)
bool operator== (const CP_String &inLeftSide, const char *inRightSide)
bool operator== (const CP_String &inLeftSide, const CPUniChar *inRightSide)
bool operator== (const CP_String &inLeftSide, const CP_String &inRightSide)
bool operator!= (CPUniChar inLeftSide, const CP_String &inRightSide)
bool operator!= (const CPUniChar *inLeftSide, const CP_String &inRightSide)
bool operator!= (const CP_String &inLeftSide, CPUniChar inRightSide)
bool operator!= (const CP_String &inLeftSide, const char *inRightSide)
bool operator!= (const CP_String &inLeftSide, const CPUniChar *inRightSide)
bool operator!= (const CP_String &inLeftSide, const CP_String &inRightSide)
bool operator< (const CP_String &inLeftSide, const CP_String &inRightSide)
bool operator<= (const CP_String &inLeftSide, const CP_String &inRightSide)
bool operator> (const CP_String &inLeftSide, const CP_String &inRightSide)
bool operator>= (const CP_String &inLeftSide, const CP_String &inRightSide)

Member Typedef Documentation

typedef CFStringRef CP_String::StringRef [inherited]
 

typedef std::reverse_iterator<const_iterator> CP_String::const_reverse_iterator [inherited]
 

typedef std::reverse_iterator<iterator> CP_String::reverse_iterator [inherited]
 

Member Enumeration Documentation

anonymous enum [inherited]
 

Enumeration values:
kCP_E_String_BufferSize 
npos 

Constructor & Destructor Documentation

CP_PropertyList::String::String (   ) 
 

CP_PropertyList::String::String (  const String &  inSrc  )  [explicit]
 

CP_PropertyList::String::String (  const CP_String &  inSrc  ) 
 

CP_PropertyList::String::String (  CFStringRef  inRef,
bool  inRetain
) 
 

CP_PropertyList::String::~String (   )  throw () [virtual]
 

Member Function Documentation

void CP_PropertyList::String::PrintToLog (  CP_LogFile &  inLogFile,
SInt32  inLevel = 0,
SInt32  inIndentLevel = 0
)  const [virtual]
 

Implements CP_PropertyList::Node.

NodeType_t CP_PropertyList::String::NodeType (   )  const throw () [virtual]
 

Implements CP_PropertyList::Node.

String * CP_PropertyList::String::FromXMLData (  CP_InStream &  inXMLDataStream  )  [static]
 

virtual CFTypeRef CP_PropertyList::String::GetNodeCFRef (   )  const [virtual]
 

Implements CP_PropertyList::Node.

void CP_PropertyList::Node::WriteXMLData (  CP_OutStream &  inXMLDataStream  )  const [virtual, inherited]
 

Node * CP_PropertyList::Node::FromXMLData (  CP_InStream &  inXMLDataStream,
NodeType_t  inExpectedNodeType = NodeType_Any
)  [static, inherited]
 

static Node* CP_PropertyList::Node::CreateNodeForCFObject (  CFTypeRef  inObject  )  [static, inherited]
 

UInt32 CP_M_RefCounted::AddReference (   )  const [inherited]
 

Add a reference to our object, returning the new reference count.

Exceptions:
none 
Returns:
UInt32 const Returns the new reference count.

UInt32 CP_M_RefCounted::RemoveReference (   )  const [inherited]
 

Remove a reference to our object, returning the new reference count. If the count is 0, then this object is also deleted, and 0 is returned.

Exceptions:
none 
Returns:
UInt32 const Returns the new reference count.

void CP_M_RefCounted::Autorelease (   )  const [inherited]
 

Add the object to the topmost auto-release pool. This will ensure that the object is eventually released.

See also:
CP_AutoReleasePool
Exceptions:
none 
Returns:
void

UInt32 CP_M_RefCounted::GetRefCount (   )  const [inherited]
 

Returns the current ref count.

Exceptions:
none 
Returns:
UInt32 The current referencce count.

CP_String CP_String::StringWithFormat (  const char *  inFormat,
  ...
)  [static, inherited]
 

Creates a string from the given format and parameters. Same as CP_String::StringWithFormatAndArguments, except that the parameters are passed as C-style variable argument list.

See also:
CP_String::StringWithFormatAndArguments for more information about using format strings and parameters.
Exceptions:
Any exception raised by CP_String constructors and accessors.
Parameters:
inFormat The format string defining the skeleton for the generated string.
... The parameters to replace the placeholders in the skeleton string.
Returns:
CP_String The formatted string.

CP_String CP_String::StringWithFormatAndArguments (  const CP_String &  inFormat,
va_list  args
)  [static, inherited]
 

Creates a string from the given format and parameter list.
The format string is a printf-style format string that specifies the skeleton string and argument placeholders. The function will create a string that has the skeleton format string with argument placeholders replaced from the string representations of the remaining parameters.
Enhancements w.r.t. printf format strings are:

  • support for CP_String parameters (see below) using the "%@" placeholder
  • reordering arguments (see below) using a n$ prefix for the placeholder (e.g. "%2$@")

CP_String Parameters
You can use CP_Strings as replacement arguments, by using the "%@" format placeholder and passing a CP_String::StringRef as the replacement value: 
	 CP_String	aString;
	 CP_String	formattedString = CP_String::StringWithFormat(CP_String("Hello %@"), aString.Ref());
Reordering Arguments
You can specify the index of the argument to use for a specific placeholder in the skeleton string by using a modifier of the form "n$" with the format specifier (e.g. 2$d). This will use the n-th argument parameter to replace the placeholder in the skeleton string. These modifiers are very useful when localizing format strings, since they allow to reorder the placeholders in the format string.
See also:
printf for basic format string information
Exceptions:
Any exception raised by CP_String constructors and accessors. Also an exception will be thrown if the format string is not correct
Parameters:
inFormat The format string defining the skeleton for the generated string.
args The parameters to replace the placeholders in the skeleton string.
Returns:
CP_String The formatted string.

const char * CP_String::c_str (  bool  inLossy = false,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Returns a pointer to the first character of the string and the end of the string is NULL terminated.

Note:
Since the C string is kept in a temporary buffer, don't expect it to remain valid past the next call...
Exceptions:
bad_cast exception is raised if string can't be converted into specified encoding.
Parameters:
inLossy Specifies whether to use replacement character for characters that can't be encoded in specified encoding. If , a replacement character will be used, if false a bad_cast exception will be raised if a character can't be encoded.
inTextEncoder Text encoder used to encode the characters into plain c style characters. Pass NULL to use default encoder.
Returns:
const char * C style string of characters that is NULL terminated.

const CPUniChar * CP_String::w_str (   )  const [inherited]
 

Returns a pointer to the first character of the string and the end of the string is NULL terminated. The characters returns are Unicode characters.

Note:
Since the string is kept in a temporary buffer, don't expect it to remain valid past the next call...
Exceptions:
none 
Returns:
const CPUniChar * C style string of Unicode characters that is NULL terminated.

const char * CP_String::utf8_str (   )  const [inherited]
 

Returns a pointer to a buffer or characters that contains a UTF-8 encoded representation of the string.

Note:
Since the C string is kept in a temporary buffer, don't expect it to remain valid past the next call...
Exceptions:
none 
Returns:
const char * UTF-8 encoded C string.

CPUniChar CP_String::operator[] (  UInt32  inIndex  )  const [inherited]
 

Returns the Unicode character at the passed in 0 based index. Const version.

Parameters:
inIndex 0 based index of the character to return.
Exceptions:
std::out_of_range if index is out of range (i.e. >= length())
Returns:
const CPUniChar Unicode character.

reference CP_String::operator[] (  UInt32  inIndex  )  [inherited]
 

CPUniChar CP_String::at (  UInt32  inIndex  )  const [inherited]
 

Returns the Unicode character at the passed in 0 (zero) based index. Const version.

Parameters:
inIndex 0 (zero) based index of the character to return. If the passed in inIndex is greater than or equal to the length of the string a std::out_of_range exception is thrown.
Exceptions:
none 
Returns:
const CPUniChar Unicode character.

reference CP_String::at (  UInt32  inIndex  )  [inherited]
 

CPUniChar CP_String::front (   )  const [inherited]
 

Returns the first character in our string as a Unicode character. Const version.

Exceptions:
std::out_of_range exception raised when called for an empty string
Returns:
CPUniChar First Unicode character of string.

reference CP_String::front (   )  [inherited]
 

CPUniChar CP_String::back (   )  const [inherited]
 

Returns the last character in our string as a Unicode character. Const version.

Exceptions:
std::out_of_range exception raised when called for an empty string
Returns:
CPUniChar Last Unicode character of string.

reference CP_String::back (   )  [inherited]
 

CP_String::StringRef CP_String::Ref (   )  const [inherited]
 

CP_String & CP_String::operator+= (  char  inChar  )  [inherited]
 

* Adds the passed in inChar to the end of our string.

Parameters:
inChar The char to be added to the string.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::operator+= (  unsigned char  inChar  )  [inherited]
 

Adds the passed in inChar to the end of our string.

Parameters:
nChar The unsigned char to be added to the string.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::operator+= (  CPUniChar  inChar  )  [inherited]
 

Adds the passed in inChar to the end of our string.

Parameters:
inChar The Unicode char to be added to the string.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String& CP_String::operator+= (  const char *  inString  )  [inherited]
 

Adds the passed in c style (NULL terminated) string to the end of our string.

Parameters:
inChar The c style (NULL terminated) string to be added to the string.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String& CP_String::operator+= (  const CPUniChar *  inString  )  [inherited]
 

Adds the passed in Unicode (NULL terminated) string to the end of our string.

Parameters:
inChar The Unicode (NULL terminated) string to be added to the string.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String& CP_String::operator+= (  const CP_String &  inString  )  [inherited]
 

Adds the passed in CP_String string to the end of our string.

Parameters:
inChar The CP_String string to be added to the string.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::append (  char  inChar,
const CP_TextEncoder *  inTextEncoder = NULL
)  [inherited]
 

Appends the passed in inChar to the end of our string.

Parameters:
inChar The char to be appended to the string.
inTextEncoder The text encoder to use to encode the character. Pass NULL to use the default text encoder.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::append (  unsigned char  inChar,
const CP_TextEncoder *  inTextEncoder = NULL
)  [inherited]
 

Appends the passed in inChar to the end of our string.

Parameters:
inChar The unsigned char to be appended to the string.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::append (  CPUniChar  inChar  )  [inherited]
 

Appends the passed in inChar to the end of our string.

Parameters:
inChar The Unicode char to be appended to the string.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::append (  UInt32  inCount,
CPUniChar  inChar
)  [inherited]
 

Appends the passed in inChar to the end of our string repeating inCount times.

Parameters:
inCount The number of times to repeat inChar in the string.
inChar The char to be appended to the string.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::append (  const char *  inString,
const CP_TextEncoder *  inTextEncoder = NULL
)  [inherited]
 

Appends the passed in c style string to the end of our string.

Parameters:
inString C style (NULL terminated) string to append from.
inTextEncoder Text encoder to use to encode the C style string into UTF-16. Pass NULL to use the default encoder.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::append (  const char *  inString,
UInt32  inLength,
const CP_TextEncoder *  inTextEncoder = NULL
)  [inherited]
 

Appends the passed in c style string to the end of our string starting at the beginning and copying inLength characters.

Parameters:
inString C style string to append from.
inLength Number of characters to add to the string.
inTextEncoder Text encoder to use to encode the C style string into UTF-16. Pass NULL to use the default encoder.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::append (  const CPUniChar *  inString  )  [inherited]
 

Appends the passed in NULL terminated string of Unicode characters to the end of our string.

Parameters:
inString Unicode string of NULL terminated characters to append from.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::append (  const CPUniChar *  inString,
UInt32  inLength
)  [inherited]
 

Appends the passed in NULL terminated string of Unicode characters to the end of our string, copying the number of characters specified in inLength.

Parameters:
inString Unicode string of NULL terminated characters to append from.
inLength Number of characters to copy from the passed in string.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::append (  const CP_String &  inString,
UInt32  inStartIndex = 0,
UInt32  inLength = npos
)  [inherited]
 

Appends characters from the passed in string starting at the character specified in inStartIndex and going for the number of characters specified in inLength.

Parameters:
inString CP_String to append the characters from.
inStartIndex First character to start copying from (zero based index).
inLength Number of characters to copy from inString.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

void CP_String::push_back (  CPUniChar  inChar  )  [inherited]
 

Add the CPUniChar to the end of this string.

Parameters:
inChar Unicode character being added.
Exceptions:
none 
Returns:
void

CP_String & CP_String::assign (  char  inChar,
const CP_TextEncoder *  inTextEncoder = NULL
)  [inherited]
 

Replaces the current contents of the string with the passed in char.

Parameters:
inChar char to replace string contents with
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::assign (  CPUniChar  inChar  )  [inherited]
 

Replaces the current contents of the string with the passed in Unicode char.

Parameters:
inChar Unicode char to replace string contents with
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::assign (  UInt32  inCount,
char  inChar,
const CP_TextEncoder *  inTextEncoder = NULL
)  [inherited]
 

Replaces the current contents of the string with the passed in char repeating inCount number of times.

Parameters:
inCount number of times to repeat the passed in char.
inChar char to repeat in string
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::assign (  UInt32  inCount,
CPUniChar  inChar
)  [inherited]
 

Replaces the current contents of the string with the passed in Unicode char repeating inCount number of times.

Parameters:
inCount number of times to repeat the passed in char.
inChar Unicode char to repeat in string
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::assign (  const char *  inString,
const CP_TextEncoder *  inTextEncoder = NULL
)  [inherited]
 

Replaces the current contents of the string with the passed in c style (NULL terminated) string.

Parameters:
inString C style string to assign contents from.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::assign (  const char *  inString,
UInt32  inLength,
const CP_TextEncoder *  inTextEncoder = NULL
)  [inherited]
 

Replaces the current contents of the string with the passed in c style (NULL terminated) string, using inLength characters from the string. If the string is shorter than the number of characters, then the string will only contain the actual characers and be shorter than the passed in length.

Parameters:
inString C style string to assign contents from.
inLength number of characters to assign to the new string.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::assign (  const CPUniChar *  inString  )  [inherited]
 

Replaces the current contents of the string with the passed in NULL terminated string of Unicode characters.

Parameters:
inString NULL terminated string of Unicode characters
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::assign (  const CPUniChar *  inString,
UInt32  inLength
)  [inherited]
 

Replaces the current contents of the string with the passed in NULL terminated string of Unicode characters, copying inLength characters from the passed in string.

Parameters:
inString NULL terminated string of Unicode characters
inLength Number of characters to copy from the passed in string.
Exceptions:
none 
Returns:
P_String& Returns a reference to ourselves.

CP_String & CP_String::assign (  const CP_String &  inString,
UInt32  inStartIndex = 0,
UInt32  inLength = npos
)  [inherited]
 

Replaces the current contents of the string with the passed in CP_String. We start from the source string in the passed in inStartIndex and copy inLength characters.

Parameters:
inString CP_String containing the data to be copied.
inStartIndex First character to start coping from in the source string (zero based index).
inLength Number of characters to copy from the source string.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

SInt32 CP_String::compare (  const char *  inChar,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Compare the contents of the passed in string to the contents of this string.

Parameters:
inChar c style (NULL terminated) string to compare against.
inTextEncoder Text encoder to use to encode the C style string into UTF-16. Pass NULL to use the default encoder.
Exceptions:
none 
Returns:
SInt32 Returns the result of the compare as follows: 0 - strings are equal -1 - this string is less than passed in string. +1 - this string is greater than passed in string.

SInt32 CP_String::compare (  const CPUniChar *  inChar  )  const [inherited]
 

Compare the contents of the passed in string to the contents of this string.

Parameters:
inChar Unicode (NULL terminated) string to compare against.
Exceptions:
none 
Returns:
SInt32 Returns the result of the compare as follows: 0 - strings are equal -1 - this string is less than passed in string. +1 - this string is greater than passed in string.

SInt32 CP_String::compare (  const CP_String &  inString  )  const [inherited]
 

Compare the contents of the passed in string to the contents of this string.

Parameters:
inChar CP_String string to compare against.
Exceptions:
none 
Returns:
SInt32 Returns the result of the compare as follows: 0 - strings are equal -1 - this string is less than passed in string. +1 - this string is greater than passed in string.

SInt32 CP_String::compare (  UInt32  inIndex,
UInt32  inCount,
const CPUniChar *  inString,
UInt32  inLength
)  const [inherited]
 

Compare the contents of the passed in string to the contents of this string. This version uses only a portion of both strings to compare against as listed below in the parameters.

Parameters:
inIndex First character in this string to start comparing with.
inCount Number of characters in this string to compare with.
inString Unicode string to compare against this string.
inLength Number of characters in the passed in Unicode string to to compare with in the string portion constructed from the first 2 parameters.
Exceptions:
none 
Returns:
SInt32 Returns the result of the compare as follows: 0 - strings are equal -1 - this string is less than passed in string. +1 - this string is greater than passed in string.

SInt32 CP_String::compare (  UInt32  inIndex,
UInt32  inCount,
const CP_String &  inString,
UInt32  inStartIndex = 0,
UInt32  inLength = npos
)  const [inherited]
 

Compare the contents of the passed in string to the contents of this string. This version uses only a portion of both strings to compare against as listed below in the parameters.

Parameters:
inIndex First character in this string to start comparing with.
inCount Number of characters in this string to compare with.
inString CP_String to compare against this string.
inStartIndex First character to start with in the passed in string.
inLength Number of characters in the passed in string to to compare with in the string portion constructed from the first 2 parameters.
Exceptions:
none 
Returns:
SInt32 Returns the result of the compare as follows: 0 - strings are equal -1 - this string is less than passed in string. +1 - this string is greater than passed in string.

CP_String & CP_String::erase (  UInt32  inIndex = 0,
UInt32  inCount = npos
)  [inherited]
 

Erase some of the characters in this string. The erasure begins at inIndex and goes for inCount number of characters.

Parameters:
inIndex Location to begin erasing from.
inCount Number of characters to remove from string, or npos to remove the remaining characters up to the end.
Exceptions:
CP_BoundsException raised if index is out of bounds.
Returns:
iterator reverse_iterator non const version

void CP_String::pop_back (   )  [inherited]
 

Erases the last character in the string.

Exceptions:
none 
Returns:
void

UInt32 CP_String::find (  CPUniChar  inChar,
UInt32  inIndex = 0
)  const [inherited]
 

Return the index into this string of the passed in character starting at the passed in starting location.

Parameters:
inChar The Unicode character we are looking for.
inIndex Starting position of this string to begin the search at.
Exceptions:
none 
Returns:
UInt32 Returns the position that inChar is located at within this string. If the characrer is not found, then the index of npos (ULONG_MAX) will be returned.

UInt32 CP_String::find (  const char *  inString,
UInt32  inIndex = 0,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Return the index into this string of the passed in c style (NULL terminated) string starting at the passed in starting location.

Parameters:
inString c style (NULL terminated) string to match in this string.
inIndex Starting position of this string to begin the search at.
Exceptions:
none 
Returns:
UInt32 Returns the position that inString is located at within this string. If the string is not found, then the index of npos (ULONG_MAX) will be returned.

UInt32 CP_String::find (  const char *  inString,
UInt32  inIndex,
UInt32  inLength,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Return the index into this string of the passed in c style (NULL terminated) string starting at the passed in starting location and using inLength characters from the passed in string.

Parameters:
inString c style (NULL terminated) string to match in this string.
inIndex Starting position of this string to begin the search at.
inLength Number of characters to use from the passed in string.
Exceptions:
none 
Returns:
UInt32 Returns the position that inString is located at within this string. If the string is not found, then the index of npos (ULONG_MAX) will be returned.

UInt32 CP_String::find (  const CPUniChar *  inString,
UInt32  inIndex = 0
)  const [inherited]
 

Return the index into this string of the passed in Unicode (NULL terminated) string starting at the passed in starting location.

Parameters:
inString Unicode (NULL terminated) string to match in this string.
inIndex Starting position of this string to begin the search at.
Exceptions:
none 
Returns:
UInt32 Returns the position that inString is located at within this string. If the string is not found, then the index of npos (ULONG_MAX) will be returned.

UInt32 CP_String::find (  const CPUniChar *  inString,
UInt32  inIndex,
UInt32  inLength
)  const [inherited]
 

Return the index into this string of the passed in Unicode (NULL terminated) string starting at the passed in starting location and using inLength characters from the passed in string.

Parameters:
inString Unicode (NULL terminated) string to match in this string.
inIndex Starting position of this string to begin the search at.
inLength Number of characters to use from the passed in string.
Exceptions:
none 
Returns:
UInt32 Returns the position that inString is located at within this string. If the string is not found, then the index of npos (ULONG_MAX) will be returned.

UInt32 CP_String::find (  const CP_String &  inString,
UInt32  inIndex = 0
)  const [inherited]
 

Return the index into this string of the passed in CP_String string starting at the passed in starting location.

Parameters:
inString CP_String string to match in this string.
inIndex Starting position of this string to begin the search at.
Exceptions:
none 
Returns:
UInt32 Returns the position that inString is located at within this string. If the string is not found, then the index of npos (ULONG_MAX) will be returned.

UInt32 CP_String::rfind (  CPUniChar  inChar,
UInt32  inIndex = npos
)  const [inherited]
 

Return the index into this string of the passed in Unicode character, searching the string backwards and starting at inIndex.

Parameters:
inChar Unicode character to match in this string.
inIndex Starting position of this char to begin the search at. If inIndex is npos it will search from the end of the string.
Exceptions:
none 
Returns:
UInt32 Returns the position that inChar is located at within this string. If the char is not found, then the index of npos (ULONG_MAX) will be returned.

UInt32 CP_String::rfind (  const char *  inString,
UInt32  inIndex = npos,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Return the index into this string of the passed in c style (NULL terminated) string, searching the string backwards and starting at inIndex.

Parameters:
inString c style (NULL terminated) string to match in this string.
inIndex Starting position of this string to begin the search at. If inIndex is npos it will search from the end of the string.
Exceptions:
none 
Returns:
UInt32 Returns the position that inString is located at within this string. If the string is not found, then the index of npos (ULONG_MAX) will be returned.

UInt32 CP_String::rfind (  const char *  inString,
UInt32  inIndex,
UInt32  inLength,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Return the index into this string of the passed in c style (NULL terminated) string, searching the string backwards and starting at inIndex and using inLength characters from the source string.

Parameters:
inString c style (NULL terminated) string to match in this string.
inIndex Starting position of this string to begin the search at. If inIndex is npos it will search from the end of the string.
inLength Number of characters from the soruce string to use.
Exceptions:
none 
Returns:
UInt32 Returns the position that inString is located at within this string. If the string is not found, then the index of npos (ULONG_MAX) will be returned.

UInt32 CP_String::rfind (  const CPUniChar *  inString,
UInt32  inIndex = npos
)  const [inherited]
 

Return the index into this string of the passed in Unicode (NULL terminated) string, searching the string backwards and starting at inIndex.

Parameters:
inString Unicode (NULL terminated) string to match in this string.
inIndex Starting position of this string to begin the search at. If inIndex is npos it will search from the end of the string.
Exceptions:
none 
Returns:
UInt32 Returns the position that inString is located at within this string. If the string is not found, then the index of npos (ULONG_MAX) will be returned.

UInt32 CP_String::rfind (  const CPUniChar *  inString,
UInt32  inIndex,
UInt32  inLength
)  const [inherited]
 

Return the index into this string of the passed in Unicode (NULL terminated) string, searching the string backwards and starting at inIndex and using inLength characters from the source string.

Parameters:
inString Unicode (NULL terminated) string to match in this string.
inIndex Starting position of this string to begin the search at. If inIndex is npos it will search from the end of the string.
inLength Number of characters from the soruce string to use.
Exceptions:
none 
Returns:
UInt32 Returns the position that inString is located at within this string. If the string is not found, then the index of npos (ULONG_MAX) will be returned.

UInt32 CP_String::rfind (  const CP_String &  inString,
UInt32  inIndex = npos
)  const [inherited]
 

Return the index into this string of the passed in CP_String string, searching the string backwards and starting at inIndex.

Parameters:
inString CP_String string to match in this string.
inIndex Starting position of this string to begin the search at. If inIndex is npos it will search from the end of the string.
Exceptions:
none 
Returns:
UInt32 Returns the position that inString is located at within this string. If the string is not found, then the index of npos (ULONG_MAX) will be returned.

UInt32 CP_String::find_first_of (  CPUniChar  inChar,
UInt32  inIndex = 0
)  const [inherited]
 

Return the index of the first occurrance of inChar in this string.

Parameters:
inChar Unicode character we are looking for.
inIndex Starting index to being search at, default is the beginning.
Exceptions:
none 
Returns:
UInt32 Location of first occurrance of inChar in this string. npos if not found.

UInt32 CP_String::find_first_of (  const char *  inString,
UInt32  inIndex = 0,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Return the index of the first occurrance of inSting in this string.

Parameters:
inString c style (NULL terminated) we are looking for.
inIndex Starting index to being search at, default is the beginning.
inTextEncoder Text encoder used to convert c style string into UTF-16 representation if needed.
Exceptions:
none 
Returns:
UInt32 Location of first occurrance of inChar in this string. npos if not found.

UInt32 CP_String::find_first_of (  const char *  inString,
UInt32  inIndex,
UInt32  inLength,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Return the index of the first occurrance of inSting in this string.

Parameters:
inString c style (NULL terminated) we are looking for.
inIndex Starting index to being search at, default is the beginning.
inLength Number of characters in inString to use in the search.
inTextEncoder Text encoder used to convert c style string into UTF-16 representation if needed.
Exceptions:
none 
Returns:
UInt32 Location of first occurrance of inChar in this string. npos if not found.

UInt32 CP_String::find_first_of (  const CPUniChar *  inString,
UInt32  inIndex = 0
)  const [inherited]
 

Return the index of the first occurrance of inSting in this string.

Parameters:
inString Unicode (NULL terminated) we are looking for.
inIndex Starting index to being search at, default is the beginning.
Exceptions:
none 
Returns:
UInt32 Location of first occurrance of inChar in this string. npos if not found.

UInt32 CP_String::find_first_of (  const CPUniChar *  inString,
UInt32  inIndex,
UInt32  inLength
)  const [inherited]
 

Return the index of the first occurrance of inSting in this string.

Parameters:
inString Unicode (NULL terminated) we are looking for.
inIndex Starting index to being search at, default is the beginning.
inLength Number of characters in inString to use in the search.
Exceptions:
none 
Returns:
UInt32 Location of first occurrance of inString in this string. npos if not found.

UInt32 CP_String::find_first_of (  const CP_String &  inString,
UInt32  inIndex = 0
)  const [inherited]
 

Return the index of the first occurrance of inSting in this string.

Parameters:
inString CP_String we are looking for.
inIndex Starting index to being search at, default is the beginning.
Exceptions:
none 
Returns:
UInt32 Location of first occurrance of inString in this string. npos if not found.

UInt32 CP_String::find_last_of (  CPUniChar  inChar,
UInt32  inIndex = npos
)  const [inherited]
 

Return the index of the last occurrance of inChar in this string. The search is backwards in the string

Parameters:
inString Unicode character we are looking for.
inIndex Starting index to being search at, default is the end of the string.
Exceptions:
none 
Returns:
UInt32 Location of last occurrance of inChar in this string. npos if not found.

UInt32 CP_String::find_last_of (  const char *  inString,
UInt32  inIndex = npos,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Return the index of the last occurrance of inChar in this string. The search is backwards in the string

Parameters:
inString c style (NULL terminated) string we are looking for.
inIndex Starting index to being search at, default is the end of the string.
inTextEncoder Text encoder used to convert c style string into UTF-16 representation if needed.
Exceptions:
none 
Returns:
UInt32 Location of last occurrance of inString in this string. npos if not found.

UInt32 CP_String::find_last_of (  const char *  inString,
UInt32  inIndex,
UInt32  inLength,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Return the index of the last occurrance of inString in this string. The search is backwards in the string

Parameters:
inString c style (NULL terminated) string we are looking for.
inIndex Starting index to being search at, default is the end of the string.
inLength Number of characters from inString to use in search.
inTextEncoder Text encoder used to convert c style string into UTF-16 representation if needed.
Exceptions:
none 
Returns:
UInt32 Location of last occurrance of inString in this string. npos if not found.

UInt32 CP_String::find_last_of (  const CPUniChar *  inString,
UInt32  inIndex = npos
)  const [inherited]
 

Return the index of the last occurrance of inString in this string. The search is backwards in the string

Parameters:
inString Unicode (NULL terminated) string we are looking for.
inIndex Starting index to being search at, default is the end of the string.
Exceptions:
none 
Returns:
UInt32 Location of last occurrance of inString in this string. npos if not found.

UInt32 CP_String::find_last_of (  const CPUniChar *  inString,
UInt32  inIndex,
UInt32  inLength
)  const [inherited]
 

Return the index of the last occurrance of inString in this string. The search is backwards in the string

Parameters:
inString Unicode (NULL terminated) string we are looking for.
inIndex Starting index to being search at, default is the end of the string.
inLength Number of characters from inString to use in search.
Exceptions:
none 
Returns:
UInt32 Location of last occurrance of inString in this string. npos if not found.

UInt32 CP_String::find_last_of (  const CP_String &  inString,
UInt32  inIndex = npos
)  const [inherited]
 

Return the index of the last occurrance of inString in this string. The search is backwards in the string

Parameters:
inString CP_String string we are looking for.
inIndex Starting index to being search at, default is the end of the string.
Exceptions:
none 
Returns:
UInt32 Location of last occurrance of inString in this string. npos if not found.

UInt32 CP_String::find_first_not_of (  CPUniChar  inChar,
UInt32  inIndex = 0
)  const [inherited]
 

Return the index of the first occurrance of inChar that is not in this string.

Parameters:
inChar Unicode character string we are looking for.
inIndex Starting index to being search at, default is the beginning of the string.
Exceptions:
none 
Returns:
UInt32 Location of first occurrance that is not in this string. npos if not found.

UInt32 CP_String::find_first_not_of (  const char *  inString,
UInt32  inIndex = 0,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Return the index of the first occurrance of inString that is not in this string.

Parameters:
inString c style (NULL terminated) character string we are looking for.
inIndex Starting index to being search at, default is the beginning of the string.
inTextEncoder Text encoder used to convert c style string into UTF-16 representation if needed.
Exceptions:
none 
Returns:
UInt32 Location of first occurrance that is not in this string. npos if not found.

UInt32 CP_String::find_first_not_of (  const char *  inString,
UInt32  inIndex,
UInt32  inLength,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Return the index of the first occurrance of inString that is not in this string.

Parameters:
inString c style (NULL terminated) character string we are looking for.
inIndex Starting index to being search at, default is the beginning of the string.
inLength Number of characters from passed in string to use in search.
inTextEncoder Text encoder used to convert c style string into UTF-16 representation if needed.
Exceptions:
none 
Returns:
UInt32 Location of first occurrance that is not in this string. npos if not found.

UInt32 CP_String::find_first_not_of (  const CPUniChar *  inString,
UInt32  inIndex = 0
)  const [inherited]
 

Return the index of the first occurrance of inString that is not in this string.

Parameters:
inString Unicode (NULL terminated) character string we are looking for.
inIndex Starting index to being search at, default is the beginning of the string.
Exceptions:
none 
Returns:
UInt32 Location of first occurrance that is not in this string. npos if not found.

UInt32 CP_String::find_first_not_of (  const CPUniChar *  inString,
UInt32  inIndex,
UInt32  inLength
)  const [inherited]
 

Return the index of the first occurrance of inString that is not in this string.

Parameters:
inString Unicode (NULL terminated) character string we are looking for.
inIndex Starting index to being search at, default is the beginning of the string.
inLength Number of characters from passed in string to use in search.
Exceptions:
none 
Returns:
UInt32 Location of first occurrance that is not in this string. npos if not found.

UInt32 CP_String::find_first_not_of (  const CP_String &  inString,
UInt32  inIndex = 0
)  const [inherited]
 

Return the index of the first occurrance of inString that is not in this string.

Parameters:
inString CP_String character string we are looking for.
inIndex Starting index to being search at, default is the beginning of the string.
Exceptions:
none 
Returns:
UInt32 Location of first occurrance that is not in this string. npos if not found.

UInt32 CP_String::find_last_not_of (  CPUniChar  inChar,
UInt32  inIndex = npos
)  const [inherited]
 

Return the index of the last occurrance of inChar that is not in this string. The search is backwards in the string

Parameters:
inChar Unicode character we are looking for.
inIndex Starting index to being search at, default is the end of the string.
Exceptions:
none 
Returns:
UInt32 Location of last occurrance that is not in this string.

UInt32 CP_String::find_last_not_of (  const char *  inString,
UInt32  inIndex = npos,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Return the index of the last occurrance of inString that is not in this string. The search is backwards in the string

Parameters:
inString c style (NULL terminated) string we are looking for.
inIndex Starting index to being search at, default is the end of the string.
inTextEncoder Text encoder used to convert c style string into UTF-16 representation if needed.
Exceptions:
none 
Returns:
UInt32 Location of last occurrance that is not in this string.

UInt32 CP_String::find_last_not_of (  const char *  inString,
UInt32  inIndex,
UInt32  inLength,
const CP_TextEncoder *  inTextEncoder = NULL
)  const [inherited]
 

Return the index of the last occurrance of inString that is not in this string. The search is backwards in the string

Parameters:
inString c style (NULL terminated) string we are looking for.
inIndex Starting index to being search at, default is the end of the string.
inLength Number of characters from inString to use in search.
inTextEncoder Text encoder used to convert c style string into UTF-16 representation if needed.
Exceptions:
none 
Returns:
UInt32 Location of last occurrance that is not in this string.

UInt32 CP_String::find_last_not_of (  const CPUniChar *  inString,
UInt32  inIndex = npos
)  const [inherited]
 

Return the index of the last occurrance of inString that is not in this string. The search is backwards in the string

Parameters:
inString Unicode (NULL terminated) string we are looking for.
inIndex Starting index to being search at, default is the end of the string.
Exceptions:
none 
Returns:
UInt32 Location of last occurrance that is not in this string.

UInt32 CP_String::find_last_not_of (  const CPUniChar *  inString,
UInt32  inIndex,
UInt32  inLength
)  const [inherited]
 

Return the index of the last occurrance of inString that is not in this string. The search is backwards in the string

Parameters:
inString Unicode (NULL terminated) string we are looking for.
inIndex Starting index to being search at, default is the end of the string.
inLength Number of characters in string to use in search.
Exceptions:
none 
Returns:
UInt32 Location of last occurrance that is not in this string.

UInt32 CP_String::find_last_not_of (  const CP_String &  inString,
UInt32  inIndex = npos
)  const [inherited]
 

Return the index of the last occurrance of inString that is not in this string. The search is backwards in the string

Parameters:
inString CP_String string we are looking for.
inIndex Starting index to being search at, default is the end of the string.
Exceptions:
none 
Returns:
UInt32 Location of last occurrance that is not in this string.

CP_String & CP_String::insert (  UInt32  inIndex,
CPUniChar  inChar
)  [inherited]
 

Insert the passed in Unicode character into this string starting at inIndex.

Parameters:
inIndex Location to begin inserting into this string.
inChar Unicode character to insert.
Exceptions:
CP_BoundsException raised if index is out of bounds.
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::insert (  UInt32  inIndex,
UInt32  inCount,
CPUniChar  inChar
)  [inherited]
 

Insert the passed in Unicode character into this string starting at inIndex and repeating inCount number of times.

Parameters:
inIndex Location to begin inserting into this string.
inIndex Number of times to insert the character.
inChar Unicode character to insert.
Exceptions:
CP_BoundsException raised if index is out of bounds.
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::insert (  UInt32  inIndex,
const char *  inString,
const CP_TextEncoder *  inTextEncoder = NULL
)  [inherited]
 

Insert the passed in c style (NULL terminated) string into this string starting at inIndex.

Parameters:
inIndex Location to begin inserting into this string.
inString c style (NULL terminated) string to insert.
Exceptions:
CP_BoundsException raised if index is out of bounds.
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::insert (  UInt32  inIndex,
const char *  inString,
UInt32  inLength,
const CP_TextEncoder *  inTextEncoder = NULL
)  [inherited]
 

Insert the passed in c style (NULL terminated) string into this string starting at inIndex and using inLength number of characters from the source string.

Parameters:
inIndex Location to begin inserting into this string.
inString c style (NULL terminated) string to insert.
inLength Number of characters to insert into this string from passed in string.
Exceptions:
CP_BoundsException raised if index is out of bounds.
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::insert (  UInt32  inIndex,
const CPUniChar *  inString
)  [inherited]
 

Insert the passed in Unicode (NULL terminated) string into this string starting at inIndex.

Parameters:
inIndex Location to begin inserting into this string.
inString Unicode (NULL terminated) string to insert.
Exceptions:
CP_BoundsException raised if index is out of bounds.
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::insert (  UInt32  inIndex,
const CPUniChar *  inString,
UInt32  inLength
)  [inherited]
 

Insert the passed in Unicode (NULL terminated) string into this string starting at inIndex and using inLength characters from the soruce string.

Parameters:
inIndex Location to begin inserting into this string.
inString Unicode (NULL terminated) string to insert.
inLength Number of characters to copy from the source string.
Exceptions:
CP_BoundsException raised if index is out of bounds.
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::insert (  UInt32  inIndex,
const CP_String &  inString,
UInt32  inStartIndex = 0,
UInt32  inLength = npos
)  [inherited]
 

Insert a portion of the passed in CP_String string into this string starting at inIndex in this string. The portion of the string begin used begins at inStartIndex into the passed in string, and uses inLength characters from that string.

Parameters:
inIndex Location to begin inserting into this string.
inString CP_String string to insert.
inStartIndex Number of characters to copy from the source string.
Exceptions:
CP_BoundsException raised if index is out of bounds.
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::replace (  UInt32  inIndex,
UInt32  inCount,
UInt32  inCharCount,
CPUniChar  inChar
)  [inherited]
 

Replaces some of the characers in this string with the passed in Unicode character. The passed in character replaces the characters in this string starting at inIndex and going for inCount length in this string. The passed in character is repeated inCharCount times.

Parameters:
inIndex Location to begin replacing in source from.
inCount Number of characters to remove in this string.
inCharCount Number of characters to copy in this string.
inChar The character that is replacing the contents with.
Exceptions:
CP_BoundsException raised if index is out of bounds.
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::replace (  UInt32  inIndex,
UInt32  inCount,
const char *  inString,
const CP_TextEncoder *  inTextEncoder = NULL
)  [inherited]
 

Replaces some of the characers in this string with the passed in c style (NULL terminated) string. The passed in character replaces the characters in this string starting at inIndex and going for inCount length in this string.

Parameters:
inIndex Location to begin replacing in source from.
inCount Number of characters to remove in this string.
inString c style (NULL terminated) string to replace characters from.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::replace (  UInt32  inIndex,
UInt32  inCount,
const char *  inString,
UInt32  inLength,
const CP_TextEncoder *  inTextEncoder = NULL
)  [inherited]
 

Replaces some of the characers in this string with the passed in c style (NULL terminated) string. The passed in character replaces the characters in this string starting at inIndex and going for inCount length in this string. Only the number of characters specified in inLength are used from the source string.

Parameters:
inIndex Location to begin replacing in source from.
inCount Number of characters to remove in this string.
inString c style (NULL terminated) string to replace characters from.
inLength Number of characters from source string to use.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::replace (  UInt32  inIndex,
UInt32  inCount,
const CPUniChar *  inString
)  [inherited]
 

Replaces some of the characers in this string with the passed in Unicode (NULL terminated) string. The passed in character replaces the characters in this string starting at inIndex and going for inCount length in this string.

Parameters:
inIndex Location to begin replacing in source from.
inCount Number of characters to remove in this string.
inString Unicode (NULL terminated) string to replace characters from.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::replace (  UInt32  inIndex,
UInt32  inCount,
const CPUniChar *  inString,
UInt32  inLength
)  [inherited]
 

Replaces some of the characers in this string with the passed in Unicode (NULL terminated) string. The passed in character replaces the characters in this string starting at inIndex and going for inCount length in this string. Only the number of characters specified in inLength are used from the source string.

Parameters:
inIndex Location to begin replacing in source from.
inCount Number of characters to remove in this string.
inString Unicode (NULL terminated) string to replace characters from.
inLength Number of characters from source string to use.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

CP_String & CP_String::replace (  UInt32  inIndex,
UInt32  inCount,
const CP_String &  inString,
UInt32  inStartIndex = 0,
UInt32  inLength = npos
)  [inherited]
 

Replaces some of the characers in this string with the passed in CP_String string. The passed in character replaces the characters in this string starting at inIndex and going for inCount length in this string. Only the number of characters specified in inLength are used from the source string, and starting at inStartIndex in the source string.

Parameters:
inIndex Location to begin replacing in source from.
inCount Number of characters to remove in this string.
inString CP_String string to replace characters from.
inStartIndex Beginning position in passed in string to copy from.
inLength Number of characters from source string to use.
Exceptions:
none 
Returns:
CP_String& Returns a reference to ourselves.

UInt32 CP_String::length (   )  const [inherited]
 

Returns the number of characters in this string.

Exceptions:
none 
Returns:
UInt32 Returns a count of the characters in this string.

UInt32 CP_String::size (   )  const [inherited]
 

void CP_String::resize (  UInt32  inNewSize  )  [inherited]
 

Resizes this string to hold the passed in number of characters. If the string is made shorter, then any extra characters are removed, and if the string is made longer, then extra space is added to the end of the existing string.

Parameters:
inNewSize Size (i.e. number of characters) to make this string.
Exceptions:
none 
Returns:
void

void CP_String::resize (  UInt32  inNewSize,
CPUniChar  inChar
)  [inherited]
 

Resizes this string to hold the passed in number of characters. If the string is made shorter, then any extra characters are remved, and if the string is made longer, then extra space is added to the end of the existing string.

Parameters:
inNewSize Size to make this string.
inChar Unicode character to insert in any blank space if string is made bigger.
Exceptions:
none 
Returns:
void

UInt32 CP_String::capacity (   )  const [inherited]
 

Return the capacity of this string. This is the amount of memory allocated at the moment, and might not be the same as the length/size returned.

Note:
For the Carbon implementation, the capacity is always equivalent to the size, since there is no notion of reserving space.
Exceptions:
none 
Returns:
UInt32 Capacity of the string. const version.

bool CP_String::Empty (   )  const [inherited]
 

Return true if this string contains 0 characters.

Exceptions:
none 
Returns:
bool const True if length == 0

bool CP_String::empty (   )  const [inherited]
 

Return true if this string contains 0 characters.

Exceptions:
none 
Returns:
bool const True if length == 0

void CP_String::clear (   )  [inherited]
 

Clears out or erases all of the current content of the string, and makes this into a zero length string.

Exceptions:
none 
Returns:
void

CP_String::iterator CP_String::begin (   )  [inherited]
 

Returns an iterator for accessing the contents of this string. The iterator points to the beginning of the string and is a forward_iterator.

Exceptions:
none 
Returns:
iterator forward_iterator non const version

CP_String::const_iterator CP_String::begin (   )  const [inherited]
 

Returns an iterator for accessing the contents of this string. The iterator points to the beginning of the string and is a forward_iterator.

Exceptions:
none 
Returns:
iterator forward_iterator const version

CP_String::iterator CP_String::end (   )  [inherited]
 

Returns an iterator for accessing the contents of this string. The iterator points to the end of the string and is a forward_iterator.

Exceptions:
none 
Returns:
iterator forward_iterator non const version

CP_String::const_iterator CP_String::end (   )  const [inherited]
 

Returns an iterator for accessing the contents of this string. The iterator points to the end of the string and is a forward_iterator.

Exceptions:
none 
Returns:
iterator forward_iterator const version

CP_String::reverse_iterator CP_String::rbegin (   )  [inherited]
 

Returns a reverse_iterator for accessing the contents of this string. The iterator points to the end of the string and is a reverse_iterator.

Exceptions:
none 
Returns:
iterator reverse_iterator non const version

CP_String::const_reverse_iterator CP_String::rbegin (   )  const [inherited]
 

Returns a reverse_iterator for accessing the contents of this string. The iterator points to the end of the string and is a reverse_iterator.

Exceptions:
none 
Returns:
iterator reverse_iterator const version

CP_String::reverse_iterator CP_String::rend (   )  [inherited]
 

Returns a reverse_iterator for accessing the contents of this string. The iterator points to the end of the string and is a reverse_iterator.

Exceptions:
none 
Returns:
iterator reverse_iterator non const version

CP_String::const_reverse_iterator CP_String::rend (   )  const [inherited]
 

Returns a reverse_iterator for accessing the contents of this string. The iterator points to the end of the string and is a reverse_iterator.

Exceptions:
none 
Returns:
iterator reverse_iterator const version

CP_String CP_String::substr (  UInt32  inIndex = 0,
UInt32  inCount = npos
)  const [inherited]
 

Return a string containing a portion of this string.

Parameters:
inIndex Starting index to return. Defaults to beginning of string.
inLength Number of characters to return. Default is to use entire string.
Exceptions:
none 
Returns:
CP_String const String containing a the substring of this string.

UInt32 CP_String::copy (  char *  inOutBuffer,
UInt32  inBufferSize,
UInt32  inCount,
UInt32 *  outUsedBufferSize,
UInt32  inIndex = 0,
const CP_TextEncoder *  inTextEncoder = NULL,
bool  inLossy = false
)  const [inherited]
 

Copy some characters from our string into the passed in char * inOutBuffer.

Parameters:
inOutBuffer Buffer to hold the data we are copying.
inBufferSize The maximum number of bytes the provided buffer can hold.
inCount Number of characters to copy to the passed in buffer. Pass npos to copy all remaining characters.
outUsedBufferSize On exit will hold the number of bytes actually copied into the buffer. Pass NULL if you're not interested.
inIndex Location of first character to begin copying from.
inTextEncoder Text encoder to use when encoding the characters from UTF-16. Pass NULL to use the default text encoder.
inLossy If true, characters that can't be encoded in the specified encoding will be replaced by a replacement character. If false an exception will be raised in that case.
Exceptions:
std::bad_cast if non-lossy conversion fails because some characters can't be encoded in the specified encoding.
CP_BoundsException if index is out of range.
Returns:
UInt32 Number of actual characters copied. This number could be less than inCount if the string hold less data than requested.

UInt32 CP_String::copy (  CPUniChar *  inOutBuffer,
UInt32  inCount,
UInt32  inIndex = 0
)  const [inherited]
 

Copy some characters from our string into the passed in Unicode * inOutBuffer. Determines the effective length rlen of the string to copy as the smaller of inCount and size(). inOutBuffer shall designate an array of at least rlen elements. The function then copies rlen characters starting at index into the buffer provided.

Parameters:
inOutBuffer Buffer to hold the data we are copying.
inCount Number of characters to copy to the passed in buffer.
inIndex Location of first character to begin copying from.
Exceptions:
CP_BoundsException if index is out of bounds.
Returns:
UInt32 Number of actual characters copied. This number could be less than inCount if the string hold less data than requested.

void CP_String::swap (  CP_String &  inString  )  [inherited]
 

Swap the contents of the passed in string with the contents of ourselves.

Parameters:
inString CP_String to swap the contents with.
Exceptions:
none 
Returns:
void

void CP_String::reserve (  UInt32  inCapacity  )  [inherited]
 

Reserve space to hold the passed in number of characters in our string.

Note:
For the Carbon implementation, this function does nothing as there is no notion of reserving space in CoreFoundation strings.
Parameters:
inCapacity Amount of space we want to reserve.
Exceptions:
none 
Returns:
void

CFStringRef CP_String::GetCFStringRef (   )  const [inherited]
 

Return the CFStringRef containing the string data.

Exceptions:
none 
Returns:
CFStringRef The CFStringRef for our strings data.

CFMutableStringRef CP_String::GetMutableCFStringRef (   )  [inherited]
 

Return the CFMutableStringRef containing the string data.

Exceptions:
CP_OSErrorException(coreFoundationUnknownErr) raised if converting immutable string to mutable string fails.
Returns:
CFMutableStringRef The CFMutableStringRef for our strings data.

CP_ResourcePtr<CFStringRef> CP_String::GetCFStringRefPtr (   )  const [inherited]
 

Return the CFStringRef containing the string data as a CP_ResourcePtr wrapped resource.

Exceptions:
none 
Returns:
CP_ResourcePtr const A CP_ResourcePtr that contains the CFStringRef for the string.

CP_ResourcePtr<CFMutableStringRef> CP_String::GetMutableCFStringRefPtr (   )  [inherited]
 

Return the CFMutableStringRef containing the string data as a CP_ResourcePtr wrapped resource.

Exceptions:
CP_OSErrorException(coreFoundationUnknownErr) raised if converting immutable string to mutable string fails.
Returns:
CP_ResourcePtr const A CP_ResourcePtr that contains the CFMutableStringRef for the string.

void CP_String::Set (  const unsigned char *  inPString,
CFStringEncoding  inEncoding
)  [inherited]
 

void CP_String::Substring (  CFRange  inRange,
CPUniChar *  outBuffer
)  const [inherited]
 

Return a portion of this string in the passed in outBuffer.

Parameters:
inRange CFRange of characters to retrieve.
outBuffer Buffer to hold the returned data.
Exceptions:
none 
Returns:
void

void CP_String::AssertUniqueMutableCFStringRef (   )  [protected, inherited]
 

Make sure our CoreFoundation string ref is mutable and has a retain count of 1 (i.e. we're the only one referencing it). If it isn't, create a mutable copy that we can work on (copy-on-write).
When this function completes, fMutableString points to a CFMutableStringRef that is used by nobody else and can freely be modified.

Exceptions:
CP_OSErrorException(coreFoundationUnknownErr) raised if converting immutable string to mutable string fails.
Returns:
CP_ResourcePtr const A CP_ResourcePtr that contains the CFMutableStringRef for the string.

Friends And Related Function Documentation

CP_String operator+ (  const CP_String &  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Combines the contents of the passed in strings to each other and returns a new string.

Parameters:
inLeftSide First portion of the string.
inRightSide Second portion of the string. This is the portion of the string added to the passed in inLeftSide.
Exceptions:
none 
Returns:
CP_String Returns a new string containing the 2 passed in strings.

CP_String operator+ (  const CPUniChar *  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Combines the contents of the passed in strings to each other and returns a new string.

Parameters:
inLeftSide First portion of the string as a Unicode string.
inRightSide Second portion of the string. This is the portion of the string added to the passed in inLeftSide.
Exceptions:
none 
Returns:
CP_String Returns a new string containing the 2 passed in strings.

CP_String operator+ (  CPUniChar  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Combines the contents of the passed in strings to each other and returns a new string.

Parameters:
inLeftSide Single Unicode character to start new string.
inRightSide Second portion of the string. This is the portion of the string added to the passed in inLeftSide.
Exceptions:
none 
Returns:
CP_String Returns a new string containing the 2 passed in strings.

CP_String operator+ (  const CP_String &  inLeftSide,
const CPUniChar *  inRightSide
)  [friend, inherited]
 

Combines the contents of the passed in strings to each other and returns a new string.

Parameters:
inLeftSide First portion of the string.
inRightSide Second portion of the string. This is the portion of the string added to the passed in inLeftSide. The contents are a Unicode NULL terminated string.
Exceptions:
none 
Returns:
CP_String Returns a new string containing the 2 passed in strings.

CP_String operator+ (  const CP_String &  inLeftSide,
CPUniChar  inRightSide
)  [friend, inherited]
 

Combines the contents of the passed in strings to each other and returns a new string.

Parameters:
inLeftSide First portion of the string as a CP_String.
inRightSide Second portion of the string. This is the portion of the string added to the passed in inLeftSide. This is a single CPUniChar.
Exceptions:
none 
Returns:
CP_String Returns a new string containing the 2 passed in strings.

bool operator== (  char  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide character to the contents of the passed in CP_String.

Parameters:
inLeftSide Character to compare against second parameter.
inRightSide CP_String that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide == inRightSide, otherwise false is returned.

bool operator== (  const char *  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide Unicode character string to the contents of the passed in CP_String.

Parameters:
inLeftSide Character string to compare against second parameter.
inRightSide CP_String that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide == inRightSide, otherwise false is returned.

bool operator== (  CPUniChar  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide character to the contents of the passed in CP_String.

Parameters:
inLeftSide Unicode character to compare against second parameter.
inRightSide CP_String that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide == inRightSide, otherwise false is returned.

bool operator== (  const CPUniChar *  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide Unicode character string to the contents of the passed in CP_String.

Parameters:
inLeftSide Unicode character string to compare against second parameter.
inRightSide CP_String that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide == inRightSide, otherwise false is returned.

bool operator== (  const CP_String &  inLeftSide,
CPUniChar  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide CP_String to the Unicode character.

Parameters:
inLeftSide CP_String to compare against second parameter.
inRightSide Unicode character that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide == inRightSide, otherwise false is returned.

bool operator== (  const CP_String &  inLeftSide,
const char *  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide CP_String to the Unicode character.

Parameters:
inLeftSide CP_String to compare against second parameter.
inRightSide char * string (NULL terminated) that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide == inRightSide, otherwise false is returned.

bool operator== (  const CP_String &  inLeftSide,
const CPUniChar *  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide CP_String to the Unicode character string.

Parameters:
inLeftSide CP_String to compare against second parameter.
inRightSide Unicode character string (NULL terminated) that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide == inRightSide, otherwise false is returned.

bool operator== (  const CP_String &  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide CP_String to the passed in CP_String.

Parameters:
inLeftSide CP_String to compare against second parameter.
inRightSide CP_String that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide == inRightSide, otherwise false is returned.

bool operator!= (  CPUniChar  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide character to the contents of the passed in CP_String.

Parameters:
inLeftSide Unicode character to compare against second parameter.
inRightSide CP_String that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide != inRightSide, otherwise false is returned.

bool operator!= (  const CPUniChar *  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide Unicode character string to the contents of the passed in CP_String.

Parameters:
inLeftSide Unicode character string to compare against second parameter.
inRightSide CP_String that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide != inRightSide, otherwise false is returned.

bool operator!= (  const CP_String &  inLeftSide,
CPUniChar  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide CP_String to the Unicode character.

Parameters:
inLeftSide CP_String to compare against second parameter.
inRightSide Unicode character that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide != inRightSide, otherwise false is returned.

bool operator!= (  const CP_String &  inLeftSide,
const char *  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide CP_String to the Unicode character.

Parameters:
inLeftSide CP_String to compare against second parameter.
inRightSide char * string (NULL terminated) that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide != inRightSide, otherwise false is returned.

bool operator!= (  const CP_String &  inLeftSide,
const CPUniChar *  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide CP_String to the Unicode character string.

Parameters:
inLeftSide CP_String to compare against second parameter.
inRightSide Unicode character string (NULL terminated) that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide != inRightSide, otherwise false is returned.

bool operator!= (  const CP_String &  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide CP_String to the passed in CP_String.

Parameters:
inLeftSide CP_String to compare against second parameter.
inRightSide CP_String that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide != inRightSide, otherwise false is returned.

bool operator< (  const CP_String &  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide CP_String to the passed in CP_String.

Parameters:
inLeftSide CP_String to compare against second parameter.
inRightSide CP_String that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide < inRightSide, otherwise false is returned.

bool operator<= (  const CP_String &  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide CP_String to the passed in CP_String.

Parameters:
inLeftSide CP_String to compare against second parameter.
inRightSide CP_String that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide <= inRightSide, otherwise false is returned.

bool operator> (  const CP_String &  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide CP_String to the passed in CP_String.

Parameters:
inLeftSide CP_String to compare against second parameter.
inRightSide CP_String that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide > inRightSide, otherwise false is returned.

bool operator>= (  const CP_String &  inLeftSide,
const CP_String &  inRightSide
)  [friend, inherited]
 

Compares the passed in inLeftSide CP_String to the passed in CP_String.

Parameters:
inLeftSide CP_String to compare against second parameter.
nRightSide CP_String that is compared against.
Exceptions:
none 
Returns:
bool Returns true if inLeftSide >= inRightSide, otherwise false is returned.

Member Data Documentation

const CP_String CP_String::emptyString [static, inherited]
 

char* CP_String::fCStringDataPtr [mutable, protected, inherited]
 

Pointer to buffer returned for calls to c_str().

UInt32 CP_String::fCStringDataCapacity [mutable, protected, inherited]
 

Amount of data our c style string member can hold (excluding terminating zero character).

bool CP_String::fDirty [mutable, protected, inherited]
 

Flag to indicate if our return buffers need to be rebuilt.

CFStringRef CP_String::fImmutableString [protected, inherited]
 

CoreFoundation CFString holding our string data. Only one of fImmutableString and fMutableString are != NULL at any time, depending on the mutability of the string.

CFMutableStringRef CP_String::fMutableString [protected, inherited]
 

CoreFoundation CFString holding our string data. Only one of fImmutableString and fMutableString are != NULL at any time, depending on the mutability of the string.

CPUniChar* CP_String::fStringData [mutable, protected, inherited]
 

Pointer to buffer returned for calls to w_str().

UInt32 CP_String::fStringDataCapacity [mutable, protected, inherited]
 

Number of characters our fStringData member can hold (excluding terminating zero character).

The documentation for this class was generated from the following files:
Generated on Sat Sep 17 20:02:39 2005 for CPLAT by  doxygen 1.4.0