Cpl::Text::String_ Class Reference

This partially concrete class implements the portions of the String Api that is independent of the internal storage mechanisms. More...

Detailed Description

This partially concrete class implements the portions of the String Api that is independent of the internal storage mechanisms.

#include <String_.h>

Inheritance diagram for Cpl::Text::String_:

Collaboration diagram for Cpl::Text::String_:

Public Member Functions
void	clear ()
	See Cpl::Text::String.
	operator char () const
	See Cpl::Text::String.
int	length () const
	See Cpl::Text::String.
bool	isEmpty () const
	See Cpl::Text::String.
bool	truncated () const
	See Cpl::Text::String.
bool	operator== (const char *string) const
	See Cpl::Text::String.
bool	operator== (const String &string) const
	See Cpl::Text::String.
bool	operator!= (const char *string) const
	See Cpl::Text::String.
bool	operator!= (const String &string) const
	See Cpl::Text::String.
bool	isEqualIgnoreCase (const char *string) const
	See Cpl::Text::String.
int	compare (const char *string) const
	See Cpl::Text::String.
int	compareIgnoreCase (const char *string) const
	See Cpl::Text::String.
bool	operator== (char c) const
	See Cpl::Text::String.
bool	isEqualSubstring (int startpos, int endpos, const char *string) const
	See Cpl::Text::String.
bool	isEqualSubstringIgnoreCase (int startpos, int endpos, const char *string) const
	See Cpl::Text::String.
bool	startsWith (const char *string) const
	See Cpl::Text::String.
bool	startsWith (const char *string, int startOffset) const
	See Cpl::Text::String.
bool	endsWith (const char *string) const
	See Cpl::Text::String.
void	format (const char *format,...)
	See Cpl::Text::String.
void	formatAppend (const char *format,...)
	See Cpl::Text::String.
void	formatOpt (bool appendFlag, const char *format,...)
	See Cpl::Text::String.
void	vformat (const char *format, va_list ap)
	See Cpl::Text::String.
void	vformatAppend (const char *format, va_list ap)
	See Cpl::Text::String.
void	vformatOpt (bool appendFlag, const char *format, va_list ap)
	See Cpl::Text::String.
int	indexOf (char c) const
	See Cpl::Text::String.
int	indexOf (char c, int startpos) const
	See Cpl::Text::String.
int	indexOf (const char *str) const
	See Cpl::Text::String.
int	indexOf (const char *str, int startpos) const
	See Cpl::Text::String.
int	lastIndexOf (char c) const
	See Cpl::Text::String.
int	count (char c) const
	See Cpl::Text::String.
const char *	toUpper ()
	See Cpl::Text::String.
const char *	toLower ()
	See Cpl::Text::String.
void	removeLeadingSpaces ()
	See Cpl::Text::String.
void	removeTrailingSpaces ()
	See Cpl::Text::String.
void	removeLeadingChars (const char *charsSet)
	See Cpl::Text::String.
void	removeTrailingChars (const char *charsSet)
	See Cpl::Text::String.
void	cut (int startpos, int endpos)
	See Cpl::Text::String.
void	trimRight (int n)
	See Cpl::Text::String.
void	setChar (int atPosition, char newchar)
	See Cpl::Text::String.
int	replace (char targetChar, char newChar)
	See Cpl::Text::String.
const char *	getString () const
	See Cpl::Text::String.
char *	getBuffer (int &maxAllowedLength)
	See Cpl::Text::String.
Cpl::Text::String &	operator= (const String &string)
	Assignment.
Cpl::Text::String &	operator= (const char *string)
	Assignment.
Cpl::Text::String &	operator= (char c)
	Assignment.
Cpl::Text::String &	operator+= (const String &string)
	Append.
Cpl::Text::String &	operator+= (const char *string)
	Append.
Cpl::Text::String &	operator+= (char c)
	Append.
int	compareKey (const Key &key) const
	See Cpl::Container::Key.
const void *	getRawKey (unsigned *returnRawKeyLenPtr=0) const
	See Cpl::Container::Key.
Public Member Functions inherited from Cpl::Text::String
virtual	~String ()
	Virtual destructor!
virtual Cpl::Text::String &	operator= (int num)=0
	Converts the 'number' to a string and stores its in the internal storage of the object.
virtual Cpl::Text::String &	operator= (unsigned int num)=0
	Converts the 'number' to a string and stores its in the internal storage of the object.
virtual Cpl::Text::String &	operator= (long num)=0
	Converts the 'number' to a string and stores its in the internal storage of the object.
virtual Cpl::Text::String &	operator= (long long num)=0
	Converts the 'number' to a string and stores its in the internal storage of the object.
virtual Cpl::Text::String &	operator= (unsigned long num)=0
	Converts the 'number' to a string and stores its in the internal storage of the object.
virtual Cpl::Text::String &	operator= (unsigned long long num)=0
	Converts the 'number' to a string and stores its in the internal storage of the object.
virtual void	copyIn (const char *string, int n)=0
	This method copies the content of the source string, up to 'n' characters, into internal storage of the object.
virtual void	insertAt (int insertOffset, const char *stringToInsert)=0
	This method inserts the specified string starting at the specified offset.
virtual Cpl::Text::String &	operator+= (int num)=0
	Converts the 'number' to a string and appends its to the end of the string.
virtual Cpl::Text::String &	operator+= (unsigned int num)=0
	Converts the 'number' to a string and appends its to the end of the string.
virtual Cpl::Text::String &	operator+= (long num)=0
	Converts the 'number' to a string and appends its to the end of the string.
virtual Cpl::Text::String &	operator+= (long long num)=0
	Converts the 'number' to a string and appends its to the end of the string.
virtual Cpl::Text::String &	operator+= (unsigned long num)=0
	Converts the 'number' to a string and appends its to the end of the string.
virtual Cpl::Text::String &	operator+= (unsigned long long num)=0
	Converts the 'number' to a string and appends its to the end of the string.
virtual void	appendTo (const char *string, int n)=0
	This method appends the content of the source string, up to 'n' characters, into internal storage of the object.
	operator const char * () const
	Cast to read-only character string pointer.
const char *	operator() () const
	Returns a Read-only pointer to the "raw" (short-hand for getString())
char	operator[] (int i) const
	Returns the specified character. If n is out-bounds, then '\0' is returned.
virtual int	maxLength () const =0
	Returns the max allowed size of the string.
int	availLength ()
	Returns the available space left in the internal buffer.
void	trimLeft (int n)
	Removes 'n' characters from the start-of-string.
Public Member Functions inherited from Cpl::Container::Key
virtual	~Key ()
	Ensure a Virtual destructor.
virtual int	compareKey (const Key &key) const =0
	Key Compare function.

Protected Member Functions
	String_ (char *internalStringPtr)
	Constructor.
void	validateSizeAfterFormat (int availableLen, int formattedLen, int maxlen)
	Sets the truncated flag if needed and insures string is null terminated.

Protected Attributes
bool	m_truncated
	Flag to track when the internal string get truncated.
char *	m_strPtr
	Pointer to the actual internal string.

Constructor & Destructor Documentation

String_()

Cpl::Text::String_::String_ ( char *  internalStringPtr )

protected

Constructor.

Member Function Documentation

clear()

void Cpl::Text::String_::clear ( )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

compare()

int Cpl::Text::String_::compare ( const char *  string ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

compareIgnoreCase()

int Cpl::Text::String_::compareIgnoreCase ( const char *  string ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

compareKey()

int Cpl::Text::String_::compareKey

(

const Key &

key

)

const

See Cpl::Container::Key.

count()

int Cpl::Text::String_::count ( char  c ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

cut()

void Cpl::Text::String_::cut ( int  startpos, int  endpos  )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

endsWith()

bool Cpl::Text::String_::endsWith ( const char *  string ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

format()

void Cpl::Text::String_::format ( const char *  format,   ...  )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

formatAppend()

void Cpl::Text::String_::formatAppend ( const char *  format,   ...  )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

formatOpt()

void Cpl::Text::String_::formatOpt ( bool  appendFlag, const char *  format,   ...  )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

getBuffer()

char * Cpl::Text::String_::getBuffer ( int &  maxAllowedLength )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

getRawKey()

const void * Cpl::Text::String_::getRawKey ( unsigned *  returnRawKeyLenPtr = 0 ) const

virtual

See Cpl::Container::Key.

Implements Cpl::Container::Key.

getString()

const char * Cpl::Text::String_::getString ( ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

indexOf() [1/4]

int Cpl::Text::String_::indexOf ( char  c ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

indexOf() [2/4]

int Cpl::Text::String_::indexOf ( char  c, int  startpos  ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

indexOf() [3/4]

int Cpl::Text::String_::indexOf ( const char *  str ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

indexOf() [4/4]

int Cpl::Text::String_::indexOf ( const char *  str, int  startpos  ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

isEmpty()

bool Cpl::Text::String_::isEmpty ( ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

isEqualIgnoreCase()

bool Cpl::Text::String_::isEqualIgnoreCase ( const char *  string ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

isEqualSubstring()

bool Cpl::Text::String_::isEqualSubstring ( int  startpos, int  endpos, const char *  string  ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

isEqualSubstringIgnoreCase()

bool Cpl::Text::String_::isEqualSubstringIgnoreCase ( int  startpos, int  endpos, const char *  string  ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

lastIndexOf()

int Cpl::Text::String_::lastIndexOf ( char  c ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

length()

int Cpl::Text::String_::length ( ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

operator char()

Cpl::Text::String_::operator char ( ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

operator!=() [1/2]

bool Cpl::Text::String_::operator!= ( const char *  string ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

operator!=() [2/2]

bool Cpl::Text::String_::operator!= ( const String &  string ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

operator+=() [1/3]

Cpl::Text::String & Cpl::Text::String_::operator+= ( char  c )

virtual

Append.

Implements Cpl::Text::String.

operator+=() [2/3]

Cpl::Text::String & Cpl::Text::String_::operator+= ( const char *  string )

virtual

Append.

Implements Cpl::Text::String.

operator+=() [3/3]

Cpl::Text::String & Cpl::Text::String_::operator+= ( const String &  string )

virtual

Append.

Implements Cpl::Text::String.

operator=() [1/3]

Cpl::Text::String & Cpl::Text::String_::operator= ( char  c )

virtual

Assignment.

Implements Cpl::Text::String.

operator=() [2/3]

Cpl::Text::String & Cpl::Text::String_::operator= ( const char *  string )

virtual

Assignment.

Implements Cpl::Text::String.

operator=() [3/3]

Cpl::Text::String & Cpl::Text::String_::operator= ( const String &  string )

virtual

Assignment.

Implements Cpl::Text::String.

operator==() [1/3]

bool Cpl::Text::String_::operator== ( char  c ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

operator==() [2/3]

bool Cpl::Text::String_::operator== ( const char *  string ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

operator==() [3/3]

bool Cpl::Text::String_::operator== ( const String &  string ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

removeLeadingChars()

void Cpl::Text::String_::removeLeadingChars ( const char *  charsSet )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

removeLeadingSpaces()

void Cpl::Text::String_::removeLeadingSpaces ( )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

removeTrailingChars()

void Cpl::Text::String_::removeTrailingChars ( const char *  charsSet )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

removeTrailingSpaces()

void Cpl::Text::String_::removeTrailingSpaces ( )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

replace()

int Cpl::Text::String_::replace ( char  targetChar, char  newChar  )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

setChar()

void Cpl::Text::String_::setChar ( int  atPosition, char  newchar  )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

startsWith() [1/2]

bool Cpl::Text::String_::startsWith ( const char *  string ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

startsWith() [2/2]

bool Cpl::Text::String_::startsWith ( const char *  string, int  startOffset  ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

toLower()

const char * Cpl::Text::String_::toLower ( )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

toUpper()

const char * Cpl::Text::String_::toUpper ( )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

trimRight()

void Cpl::Text::String_::trimRight ( int  n )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

truncated()

bool Cpl::Text::String_::truncated ( ) const

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

validateSizeAfterFormat()

void Cpl::Text::String_::validateSizeAfterFormat ( int  availableLen, int  formattedLen, int  maxlen  )

protected

Sets the truncated flag if needed and insures string is null terminated.

vformat()

void Cpl::Text::String_::vformat ( const char *  format, va_list  ap  )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

vformatAppend()

void Cpl::Text::String_::vformatAppend ( const char *  format, va_list  ap  )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

vformatOpt()

void Cpl::Text::String_::vformatOpt ( bool  appendFlag, const char *  format, va_list  ap  )

virtual

See Cpl::Text::String.

Implements Cpl::Text::String.

Member Data Documentation

m_strPtr

char* Cpl::Text::String_::m_strPtr

protected

Pointer to the actual internal string.

m_truncated

bool Cpl::Text::String_::m_truncated

protected

Flag to track when the internal string get truncated.

---

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

• Cpl/Text/String_.h