CL_StringReference< CharType, StdString > Class Template Reference
[clanCore Text]

String reference template. More...

#include <string_reference.h>

Inheritance diagram for CL_StringReference< CharType, StdString >:


Public Types
typedef unsigned int	size_type
typedef CharType	char_type
typedef CharType *	iterator
typedef const CharType *	const_iterator
Public Member Functions
iterator	begin ()
	Begin.
iterator	end ()
	End.
size_type	size () const
	Size.
size_type	length () const
	Length.
bool	empty () const
	Empty.
const CharType *	data () const
CharType *	data ()
	Data.
	CL_StringReference ()
	CL_StringReference (const StdString &source)
	Constructs a StringReference.
	CL_StringReference (const CL_StringReference &source)
	Constructs a StringReference.
	CL_StringReference (const CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString > &source)
	Constructs a StringReference.
	CL_StringReference (const char *c_str)
	Constructs a StringReference.
	CL_StringReference (const char *c_str, size_type length, bool null_terminated)
	Constructs a StringReference.
	CL_StringReference (const wchar_t *wc_str)
	Constructs a StringReference.
	CL_StringReference (const wchar_t *wc_str, size_type length, bool null_terminated)
	Constructs a StringReference.
	~CL_StringReference ()
const CharType *	c_str () const
void	set_length (size_type length)
	Set length.
CL_StringReference< CharType, StdString > &	operator= (const CL_StringReference< CharType, StdString > &source)
CL_StringReference< CharType, StdString > &	operator= (const CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString > &source)
CL_StringReference< CharType, StdString > &	operator= (const char *c_str)
CL_StringReference< CharType, StdString > &	operator= (const wchar_t *c_str)
const_iterator	begin () const
	Begin.
const_iterator	end () const
	End.
const CharType &	operator[] (size_type n) const
CharType &	operator[] (size_type n)
	operator StdString () const
	StdString.
	operator CL_StringReference< CharType, StdString > () const
	ReferenceClass.
size_type	find (const CL_StringData &s, size_type pos=0) const
	Find.
size_type	find (const CharType *s, size_type pos, size_type n) const
	Find.
size_type	find (const CharType *s, size_type pos=0) const
	Find.
size_type	find (CharTypec, size_type pos=0) const
	Find.
size_type	rfind (const CL_StringData &s, size_type pos=npos) const
	Rfind.
size_type	rfind (const CharType *s, size_type pos, size_type n) const
	Rfind.
size_type	rfind (const CharType *s, size_type pos=npos) const
	Rfind.
size_type	rfind (CharTypec, size_type pos=npos) const
	Rfind.
size_type	find_first_of (const CL_StringData &s, size_type pos=0) const
	Find first of.
size_type	find_first_of (const CharType *s, size_type pos, size_type n) const
	Find first of.
size_type	find_first_of (const CharType *s, size_type pos=0) const
	Find first of.
size_type	find_first_of (CharTypec, size_type pos=0) const
	Find first of.
size_type	find_first_not_of (const CL_StringData &s, size_type pos=0) const
	Find first not of.
size_type	find_first_not_of (const CharType *s, size_type pos, size_type n) const
	Find first not of.
size_type	find_first_not_of (const CharType *s, size_type pos=0) const
	Find first not of.
size_type	find_first_not_of (CharTypec, size_type pos=0) const
	Find first not of.
size_type	find_last_of (const CL_StringData &s, size_type pos=npos) const
	Find last of.
size_type	find_last_of (const CharType *s, size_type pos, size_type n) const
	Find last of.
size_type	find_last_of (const CharType *s, size_type pos=npos) const
	Find last of.
size_type	find_last_of (CharTypec, size_type pos=npos) const
	Find last of.
size_type	find_last_not_of (const CL_StringData &s, size_type pos=npos) const
	Find last not of.
size_type	find_last_not_of (const CharType *s, size_type pos, size_type n) const
	Find last not of.
size_type	find_last_not_of (const CharType *s, size_type pos=npos) const
	Find last not of.
size_type	find_last_not_of (CharTypec, size_type pos=npos) const
	Find last not of.
CL_StringReference< CharType, StdString >	substr (size_type pos=0, size_type n=npos) const
	Substr.
int	compare (const CL_StringData &s) const
	Compare.
int	compare (size_type pos, size_type n, const CL_StringData &s) const
	Compare.
int	compare (size_type pos, size_type n, const CL_StringData &s, size_type pos1, size_type n1) const
	Compare.
int	compare (const CharType *s) const
	Compare.
int	compare (size_type pos, size_type n, const CharType *s, size_type len=npos) const
	Compare.
Static Public Attributes
static const size_type	npos
Protected Member Functions
void	clear () const
	Clear.
void	create_temp (const CharType *data, size_type length) const
	Create temp.
Protected Attributes
bool	null_terminated
bool	temporary
CharType *	data_ptr
size_type	data_length

Detailed Description

template<typename CharType, typename StdString>
class CL_StringReference< CharType, StdString >

String reference template.

Reference to string data. Extends the basic CL_StringData template with container functionality required when converting to or from C strings.

Member Typedef Documentation

template<typename CharType, typename StdString>

typedef CharType CL_StringReference< CharType, StdString >::char_type

Reimplemented from CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString >.

template<typename CharType, typename StdString>

typedef const CharType* CL_StringReference< CharType, StdString >::const_iterator

Reimplemented from CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString >.

template<typename CharType, typename StdString>

typedef CharType* CL_StringReference< CharType, StdString >::iterator

Reimplemented from CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString >.

template<typename CharType, typename StdString>

typedef unsigned int CL_StringReference< CharType, StdString >::size_type

Reimplemented from CL_StringDataTypes.

Constructor & Destructor Documentation

template<typename CharType, typename StdString>

CL_StringReference< CharType, StdString >::CL_StringReference ( )

template<typename CharType, typename StdString>

CL_StringReference< CharType, StdString >::CL_StringReference ( const StdString & source )

Constructs a StringReference.

Parameters:

source = Std String

template<typename CharType, typename StdString>

CL_StringReference< CharType, StdString >::CL_StringReference ( const CL_StringReference< CharType, StdString > & source )

Constructs a StringReference.

Parameters:

source = String Reference

template<typename CharType, typename StdString>

CL_StringReference< CharType, StdString >::CL_StringReference ( const CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString > & source )

Constructs a StringReference.

Parameters:

CharType = String Data

CharType = String Reference

StdString = Std String

template<typename CharType, typename StdString>

CL_StringReference< CharType, StdString >::CL_StringReference ( const char * c_str )

Constructs a StringReference.

Parameters:

c_str = char

template<typename CharType, typename StdString>

CL_StringReference< CharType, StdString >::CL_StringReference ( const char * c_str,

size_type length,

bool null_terminated

)

Constructs a StringReference.

Parameters:

c_str = char

length = size_type

null_terminated = bool

template<typename CharType, typename StdString>

CL_StringReference< CharType, StdString >::CL_StringReference ( const wchar_t * wc_str )

Constructs a StringReference.

Parameters:

wc_str = wchar_t

template<typename CharType, typename StdString>

CL_StringReference< CharType, StdString >::CL_StringReference ( const wchar_t * wc_str,

size_type length,

bool null_terminated

)

Constructs a StringReference.

Parameters:

wc_str = wchar_t

length = size_type

null_terminated = bool

template<typename CharType, typename StdString>

CL_StringReference< CharType, StdString >::~CL_StringReference ( )

Member Function Documentation

const_iterator CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::begin ( ) const [inline, inherited]

Begin.

Returns:
const_iterator

template<typename CharType, typename StdString>

iterator CL_StringReference< CharType, StdString >::begin ( ) [inline]

Begin.

Returns:
iterator

Reimplemented from CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString >.

template<typename CharType, typename StdString>

const CharType* CL_StringReference< CharType, StdString >::c_str ( ) const

template<typename CharType, typename StdString>

void CL_StringReference< CharType, StdString >::clear ( ) const [protected]

Clear.

int CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::compare ( size_type pos,

size_type n,

const CharType * s,

size_type len = npos

) const [inherited]

Compare.

Parameters:

pos = size_type

n = size_type

s = Char Type

len = size_type

Returns:
int

int CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::compare ( const CharType * s ) const [inherited]

Compare.

Parameters:

s = Char Type

Returns:
int

int CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::compare ( size_type pos,

size_type n,

const CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString > & s,

size_type pos1,

size_type n1

) const [inherited]

Compare.

Parameters:

pos = size_type

n = size_type

s = String Data

pos1 = size_type

n1 = size_type

Returns:
int

int CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::compare ( size_type pos,

size_type n,

const CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString > & s

) const [inherited]

Compare.

Parameters:

pos = size_type

n = size_type

s = String Data

Returns:
int

int CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::compare ( const CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString > & s ) const [inherited]

Compare.

Parameters:

s = String Data

Returns:
int

template<typename CharType, typename StdString>

void CL_StringReference< CharType, StdString >::create_temp ( const CharType * data,

size_type length

) const [protected]

Create temp.

Parameters:

data = Char Type

length = size_type

template<typename CharType, typename StdString>

CharType* CL_StringReference< CharType, StdString >::data ( ) [inline]

Data.

Returns:
Char Type

Reimplemented from CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString >.

template<typename CharType, typename StdString>

const CharType* CL_StringReference< CharType, StdString >::data ( ) const [inline]

Reimplemented from CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString >.

template<typename CharType, typename StdString>

bool CL_StringReference< CharType, StdString >::empty ( ) const [inline]

Empty.

Returns:
bool

Reimplemented from CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString >.

const_iterator CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::end ( ) const [inline, inherited]

End.

Returns:
const_iterator

template<typename CharType, typename StdString>

iterator CL_StringReference< CharType, StdString >::end ( ) [inline]

End.

Returns:
iterator

Reimplemented from CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString >.

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find ( CharType c,

size_type pos = 0

) const [inherited]

Find.

Parameters:

c = Char Type

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find ( const CharType * s,

size_type pos = 0

) const [inherited]

Find.

Parameters:

s = Char Type

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find ( const CharType * s,

size_type pos,

size_type n

) const [inherited]

Find.

Parameters:

s = Char Type

pos = size_type

n = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find ( const CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString > & s,

size_type pos = 0

) const [inherited]

Find.

Parameters:

s = String Data

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_first_not_of ( CharType c,

size_type pos = 0

) const [inherited]

Find first not of.

Parameters:

c = Char Type

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_first_not_of ( const CharType * s,

size_type pos = 0

) const [inherited]

Find first not of.

Parameters:

s = Char Type

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_first_not_of ( const CharType * s,

size_type pos,

size_type n

) const [inherited]

Find first not of.

Parameters:

s = Char Type

pos = size_type

n = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_first_not_of ( const CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString > & s,

size_type pos = 0

) const [inherited]

Find first not of.

Parameters:

s = String Data

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_first_of ( CharType c,

size_type pos = 0

) const [inherited]

Find first of.

Parameters:

c = Char Type

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_first_of ( const CharType * s,

size_type pos = 0

) const [inherited]

Find first of.

Parameters:

s = Char Type

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_first_of ( const CharType * s,

size_type pos,

size_type n

) const [inherited]

Find first of.

Parameters:

s = Char Type

pos = size_type

n = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_first_of ( const CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString > & s,

size_type pos = 0

) const [inherited]

Find first of.

Parameters:

s = String Data

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_last_not_of ( CharType c,

size_type pos = npos

) const [inherited]

Find last not of.

Parameters:

c = Char Type

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_last_not_of ( const CharType * s,

size_type pos = npos

) const [inherited]

Find last not of.

Parameters:

s = Char Type

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_last_not_of ( const CharType * s,

size_type pos,

size_type n

) const [inherited]

Find last not of.

Parameters:

s = Char Type

pos = size_type

n = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_last_not_of ( const CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString > & s,

size_type pos = npos

) const [inherited]

Find last not of.

Parameters:

s = String Data

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_last_of ( CharType c,

size_type pos = npos

) const [inherited]

Find last of.

Parameters:

c = Char Type

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_last_of ( const CharType * s,

size_type pos = npos

) const [inherited]

Find last of.

Parameters:

s = Char Type

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_last_of ( const CharType * s,

size_type pos,

size_type n

) const [inherited]

Find last of.

Parameters:

s = Char Type

pos = size_type

n = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::find_last_of ( const CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString > & s,

size_type pos = npos

) const [inherited]

Find last of.

Parameters:

s = String Data

pos = size_type

Returns:
size_type

template<typename CharType, typename StdString>

size_type CL_StringReference< CharType, StdString >::length ( ) const [inline]

Length.

Returns:
size_type

Reimplemented from CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString >.

CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::operator CL_StringReference< CharType, StdString > ( ) const [inherited]

ReferenceClass.

Returns:
operator

CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::operator StdString ( ) const [inherited]

StdString.

Returns:
operator

template<typename CharType, typename StdString>

CL_StringReference<CharType, StdString>& CL_StringReference< CharType, StdString >::operator= ( const wchar_t * c_str )

template<typename CharType, typename StdString>

CL_StringReference<CharType, StdString>& CL_StringReference< CharType, StdString >::operator= ( const char * c_str )

template<typename CharType, typename StdString>

CL_StringReference<CharType, StdString>& CL_StringReference< CharType, StdString >::operator= ( const CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString > & source )

template<typename CharType, typename StdString>

CL_StringReference<CharType, StdString>& CL_StringReference< CharType, StdString >::operator= ( const CL_StringReference< CharType, StdString > & source )

CharType & CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::operator[] ( size_type n ) [inline, inherited]

const CharType & CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::operator[] ( size_type n ) const [inline, inherited]

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::rfind ( CharType c,

size_type pos = npos

) const [inherited]

Rfind.

Parameters:

c = Char Type

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::rfind ( const CharType * s,

size_type pos = npos

) const [inherited]

Rfind.

Parameters:

s = Char Type

pos = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::rfind ( const CharType * s,

size_type pos,

size_type n

) const [inherited]

Rfind.

Parameters:

s = Char Type

pos = size_type

n = size_type

Returns:
size_type

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::rfind ( const CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString > & s,

size_type pos = npos

) const [inherited]

Rfind.

Parameters:

s = String Data

pos = size_type

Returns:
size_type

template<typename CharType, typename StdString>

void CL_StringReference< CharType, StdString >::set_length ( size_type length )

Set length.

Parameters:

length = size_type

template<typename CharType, typename StdString>

size_type CL_StringReference< CharType, StdString >::size ( ) const [inline]

Size.

Returns:
size_type

Reimplemented from CL_StringData< CharType, CL_StringReference< CharType, StdString >, StdString >.

CL_StringReference< CharType, StdString > CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::substr ( size_type pos = 0,

size_type n = npos

) const [inherited]

Substr.

Parameters:

pos = size_type

n = size_type

Returns:
Reference Class

Member Data Documentation

size_type CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::data_length [mutable, protected, inherited]

CharType * CL_StringData< CharType , CL_StringReference< CharType, StdString > , StdString >::data_ptr [mutable, protected, inherited]

const size_type CL_StringDataTypes::npos [static, inherited]

template<typename CharType, typename StdString>

bool CL_StringReference< CharType, StdString >::null_terminated [mutable, protected]

template<typename CharType, typename StdString>

bool CL_StringReference< CharType, StdString >::temporary [mutable, protected]

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

string_reference.h

Generated on Thu Dec 3 02:39:41 2009 for ClanLib by

1.4.6

CL_StringReference< CharType, StdString > Class Template Reference [clanCore Text]

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes