commore::String Class Reference

#include <String.h>

Classes
class	Allocator

Public Types
enum	{ STRING_INCREMENT_SIZE = 16 }
typedef Allocator *	PAllocator
typedef Char	value_type
typedef size_t	size_type
typedef Char &	reference
typedef const Char &	const_reference
typedef Char *	pointer
typedef const Char *	const_pointer

Public Member Functions
	String (const String &str)
	String (const String &str, size_t pos, size_t n=(size_t) npos)
	String (const Char *str, size_t n)
	String (const Char *str)
	String (const AChar *str, size_t n)
	String (const AChar *str)
	String (size_t n, Char c)
String &	operator= (const String &str)
String &	operator= (const AChar *str)
String &	operator= (const Char *str)
String &	operator= (Char c)
bool	operator== (const AChar *str) const
bool	operator== (const String &str) const
bool	operator== (const Char *str) const
bool	operator!= (const AChar *str) const
bool	operator!= (const String &str) const
bool	operator!= (const Char *str) const
String &	operator+= (const String &str)
String	operator+ (const String &str) const
String &	operator+= (const Char *str)
String &	operator+= (const AChar *str)
String &	operator+= (Char c)
String &	operator+= (AChar c)
bool	operator< (const String &s) const
bool	operator> (const String &s) const
String &	append (const String &str)
String &	append (const String &str, size_t pos, size_t n)
String &	append (const Char *str, size_t n)
String &	append (const AChar *str, size_t n)
String &	append (const Char *str)
String &	append (const AChar *str)
String &	append (size_t n, Char c)
bool	validate_range (size_t pos, size_t *len) const
String &	assign (const String &other)
String &	assign (const String &str, size_t pos, size_t n)
String &	assign (const Char *str, size_t n)
String &	assign (const Char *str)
String &	assign (size_t n, Char c)
String &	assign (const AChar *str, size_t n)
String &	assign (const AChar *str)
String &	assign (size_t n, AChar c)
void	swap (String &str)
void	splice (String &str)
String &	insert (size_t pos1, const String &str)
String &	insert (size_t pos1, const String &str, size_t pos2, size_t n)
String &	insert (size_t pos, const Char *str, size_t n)
String &	insert (size_t pos, const Char *str)
String &	insert (size_t pos, size_t n, Char c)
String &	clear ()
String &	erase (size_t pos=0, size_t n=(size_t) npos)
String &	replace (size_t pos1, size_t n1, const String &str)
String &	replace (size_t pos1, size_t n1, const String &str, size_t pos2, size_t n2)
String &	replace (size_t pos, size_t n1, const Char *str, size_t n2)
String &	replace (size_t pos, size_t n1, const Char *str)
String &	replace (size_t pos, size_t n1, size_t n2, Char c)
Char	operator[] (size_t pos) const
Char &	operator[] (size_t pos)
Char	at (size_t pos) const
Char &	at (size_t pos)
const Char *	c_str () const
	operator const Char * () const
const Char *	data () const
const PAllocator &	get_allocator () const
size_t	length () const
size_t	size () const
size_t	max_size () const
bool	empty () const
void	resize (size_t n, Char c)
void	resize (size_t n)
size_t	capacity () const
void	reserve (size_t size)
size_t	copy (Char *str, size_t n, size_t pos=0) const
	Copy sequence of characters from string Copies a substring of the current value of the string object into the array pointed by s. This substring contains the len characters that start at position pos. The function does not append a null character at the end of the copied content. More...
size_t	find (const String &str, size_t pos=0) const
	Find content in string Searches the string for the first occurrence of the sequence specified by its arguments. When pos is specified, the search only includes characters at or after position pos, ignoring any possible occurrences that include characters before pos. Notice that unlike member find_first_of, whenever more than one character is being searched for, it is not enough that just one of these characters match, but the entire sequence must match. More...
size_t	find (const Char *s, size_t pos, size_t n) const
size_t	find (const Char *str, size_t pos=0) const
size_t	find (Char c, size_t pos=0) const
size_t	find_first_of (const String &str, size_t pos=0) const
size_t	find_first_of (const Char *s, size_t pos, size_t n) const
size_t	find_first_of (const Char *str, size_t pos=0) const
size_t	find_first_of (Char c, size_t pos=0) const
size_t	find_first_not_of (const String &str, size_t pos=0) const
size_t	find_first_not_of (const Char *s, size_t pos, size_t n) const
size_t	find_first_not_of (Char c, size_t pos=0) const
size_t	find_first_not_of (const Char *str, size_t pos=0) const
size_t	rfind (const Char *str, size_t pos, size_t n) const
size_t	find_last_of (const Char *s, size_t pos, size_t n) const
size_t	find_last_not_of (const Char *s, size_t pos, size_t n) const
size_t	rfind (const String &str, size_t pos=(size_t) npos) const
size_t	rfind (const Char *str, size_t pos=(size_t) npos) const
size_t	rfind (Char c, size_t pos=(size_t) npos) const
size_t	find_last_of (const String &str, size_t pos=(size_t) npos) const
size_t	find_last_of (Char c, size_t pos=(size_t) npos) const
size_t	find_last_of (const Char *str, size_t pos=(size_t) npos) const
size_t	find_last_not_of (const String &str, size_t pos=(size_t) npos) const
size_t	find_last_not_of (const Char &c, size_t pos=(size_t) npos) const
size_t	find_last_not_of (const Char *str, size_t pos=(size_t) npos) const
String	substr (size_t pos=0, size_t n=(size_t) npos) const
int	compare (const String &str) const
int	compare (size_t pos, size_t n, const String &str) const
int	compare (size_t pos1, size_t n1, const String &str, size_t pos2, size_t n2) const
int	compare (const Char *s) const
int	compare (const AChar *s) const
int	compare (size_t pos, size_t n1, const Char *str, size_t n2=(size_t) npos) const
int	icompare (const String &str) const
int	icompare (size_t pos, size_t n, const String &str) const
int	icompare (size_t pos1, size_t n1, const String &str, size_t pos2, size_t n2) const
int	icompare (const Char *s) const
int	icompare (const AChar *s) const
int	icompare (size_t pos, size_t n1, const Char *str, size_t n2=(size_t) npos) const
Int	to_int () const
String &	make_upper ()
String &	make_lower ()
bool	match (const String &pattern, String &a0) const
bool	match (const String &pattern, String &a0, String &a1) const
bool	match (const String &pattern, String &a0, String &a1, String &a2) const
bool	match (const String &pattern, String &a0, String &a1, String &a2, String &a3) const
bool	match (const String &pattern, String &a0, String &a1, String &a2, String &a3, String &a4) const
bool	match (const String &pattern, String &a0, String &a1, String &a2, String &a3, String &a4, String &a5) const
bool	match (const String &pattern, String &a0, String &a1, String &a2, String &a3, String &a4, String &a5, String &a6) const
bool	match (const String &pattern, String &a0, String &a1, String &a2, String &a3, String &a4, String &a5, String &a6, String &a7) const
long	write_xml (OBStream &o) const
long	write (CommBuffer &buffer) const
long	read_xml (IBStream &i)
long	read (const CommBuffer &buffer)
String &	from_acsii (const AChar *s)

Static Public Member Functions
static Char	eos ()
static int	compare (const Char *s1, const Char *s2, size_t n)
static int	compare (const Char *s1, const AChar *s2, size_t n)
static int	icompare (const Char *s1, const Char *s2, size_t n)
static const Char *	find (const Char *s, int n, const Char &a)
static size_t	length (const Char *s)
static size_t	length (const AChar *s)
static Char *	copy (Char *dest, const Char *src, size_t n)
static Char *	copy (Char *dest, const AChar *src, size_t n)
static Char *	move (Char *dest, const Char *src, size_t n)
static Char *	assign (Char *dest, size_t n, const Char &c)
static void	assign (Char &c1, const Char &c2)
static bool	eq (const Char &c1, const Char &c2)
static bool	ne (const Char &c1, const Char &c2)
static bool	lt (const Char &c1, const Char &c2)
static bool	ieq (const Char &c1, const Char &c2)
static bool	ine (const Char &c1, const Char &c2)
static bool	ilt (const Char &c1, const Char &c2)

Friends
class	Iterator

Detailed Description

Unicode string class. Is inspired by stl::string

Remarks

does not manage the character encoding

Todo:

keep only usefull method

Constructor & Destructor Documentation

commore::String::String	(	const String &	str,
		size_t	pos,
		size_t	n = (size_t) npos
	)

Constuctor with a substring

Parameters

str	source string
pos	start position
n	size of substrins

commore::String::String	(	const Char *	str,
		size_t	n
	)

Constuctor with a substring

Parameters

str	source null terminated string
n	size of substrins

commore::String::String

(

const Char *

str

)

Constuctor with a null terminated unicode string

Parameters

str	source null terminated unicode string

commore::String::String	(	const AChar *	str,
		size_t	n
	)

Constuctor with a unicode substring

Parameters

str	source null terminated string
n	size of substrins

commore::String::String

(

const AChar *

str

)

Constuctor with a null terminated string

Parameters

str	source null terminated string

commore::String::String	(	size_t	n,
		Char	c
	)

Fill Constructor Fills the string with n consecutive copies of unicode character c.

Parameters

n
c

Member Function Documentation

String& commore::String::append ( const String &  str )

inline

Append unicode string

String& commore::String::append ( const String &  str, size_t  pos, size_t  n  )

inline

Append unicode substring

Parameters

str	source string
pos	begin of substring
n	size of substring

String& commore::String::append ( const Char *  str, size_t  n  )

inline

Append unicode substring

Parameters

str	source string
n	size of substring

String& commore::String::append ( const AChar *  str, size_t  n  )

inline

Append null terminated substring

Parameters

str	source string
n	size of substring

String& commore::String::append ( const Char *  str )

inline

Append null terminated unicode substring

Parameters

str	source string

String& commore::String::append ( const AChar *  str )

inline

Append null terminated substring

Parameters

str	source string

String& commore::String::append ( size_t  n, Char  c  )

inline

Append n consecutive copies of character c.

Parameters

n
c

String& commore::String::assign

(

const String &

other

)

Assign string content

String& commore::String::assign ( const String &  str, size_t  pos, size_t  n  )

inline

Assign string content with a substring

String& commore::String::assign ( const Char *  str, size_t  n  )

inline

Assign string content with a null terminated substring

String& commore::String::assign ( const Char *  str )

inline

Assign string content with null terminated string

String& commore::String::assign ( size_t  n, Char  c  )

inline

Assign string content with n consecutive copies of character c.

String& commore::String::assign ( const AChar *  str, size_t  n  )

inline

Assign string content with null terminated string

String& commore::String::assign ( const AChar *  str )

inline

Assign string content with null terminated string

String& commore::String::assign ( size_t  n, AChar  c  )

inline

Assign string content with n consecutive copies of character c.

Char commore::String::at ( size_t  pos ) const

inline

See also

const get_at

Char& commore::String::at ( size_t  pos )

inline

See also

get_at

const Char* commore::String::c_str ( ) const

inline

Get C unicode string equivalent

Returns

a pointer to an array that contains a null-terminated sequence of characters (i.e., a C-string) representing the current value of the string object.

size_t commore::String::capacity ( ) const

inline

Returns

string capacity (real allocated size)

String& commore::String::clear ( )

inline

Clear string content

size_t commore::String::copy ( Char *  str, size_t  n, size_t  pos = 0  ) const

inline

Copy sequence of characters from string Copies a substring of the current value of the string object into the array pointed by s. This substring contains the len characters that start at position pos. The function does not append a null character at the end of the copied content.

Parameters

str	Pointer to an array of characters. The array shall contain enough storage for the copied characters.
n	Number of characters to copy (if the string is shorter, as many characters as possible are copied).
pos	Position of the first character to be copied.

const Char* commore::String::data ( ) const

inline

Convesion operator to null terminated string

bool commore::String::empty ( ) const

inline

Returns

true if string is empty

String& commore::String::erase ( size_t  pos = 0, size_t  n = (size_t)npos  )

inline

Delete substring

Parameters

pos	start position
n	substring size

size_t commore::String::find ( const String &  str, size_t  pos = 0  ) const

inline

Find content in string Searches the string for the first occurrence of the sequence specified by its arguments. When pos is specified, the search only includes characters at or after position pos, ignoring any possible occurrences that include characters before pos. Notice that unlike member find_first_of, whenever more than one character is being searched for, it is not enough that just one of these characters match, but the entire sequence must match.

Parameters

str	Another string with the subject to search for.
pos	Position of the first character in the string to be considered in the search. If this is greater than the string length, the function never finds matches. Note: The first character is denoted by a value of 0 (not 1): A value of 0 means that the entire string is searched.
s	Pointer to an array of characters. If argument n is specified (3), the sequence to match are the first n characters in the array. Otherwise (2), a null-terminated sequence is expected: the length of the sequence to match is determined by the first occurrence of a null character.
n	Length of sequence of characters to match.
c	Individual character to be searched for.

const PAllocator& commore::String::get_allocator ( ) const

inline

Reference to allocator

String& commore::String::insert ( size_t  pos1, const String &  str  )

inline

Insert string

Parameters

pos1	insert position
str	string to insert

String& commore::String::insert ( size_t  pos1, const String &  str, size_t  pos2, size_t  n  )

inline

Insert substring

Parameters

pos1	insert position
str	string to insert
pos2	start substring position
n	substring size

String& commore::String::insert ( size_t  pos, const Char *  str, size_t  n  )

inline

Insert null terminated substring

Parameters

pos	insert position
str	null terminated string to insert
n	substring size

String& commore::String::insert ( size_t  pos, const Char *  str  )

inline

Insert null terminated substring

Parameters

pos	insert position
str	null terminated string to insert

String& commore::String::insert ( size_t  pos, size_t  n, Char  c  )

inline

Insert n consecutive copies of character c.

Parameters

pos	insert position
n
c

size_t commore::String::length ( ) const

inline

Returns

string length

size_t commore::String::max_size ( ) const

inline

Returns

max string length

commore::String::operator const Char * ( ) const

inline

Implicit convesion operator to null terminated string

bool commore::String::operator!= ( const AChar *  str ) const

inline

Tests the difference with a null terminated string

bool commore::String::operator!= ( const String &  str ) const

inline

Tests difference with an unicode string

bool commore::String::operator!= ( const Char *  str ) const

inline

Tests the difference with a null terminated string

String commore::String::operator+ ( const String &  str ) const

inline

String concatenation operator

String& commore::String::operator+= ( const String &  str )

inline

Append string operator

String& commore::String::operator+= ( const Char *  str )

inline

Append string operator

String& commore::String::operator+= ( const AChar *  str )

inline

Append string operator

String& commore::String::operator+= ( Char  c )

inline

Append string operator

String& commore::String::operator+= ( AChar  c )

inline

Append string operator

bool commore::String::operator< ( const String &  s ) const

inline

Compare string operator with lexical order

String& commore::String::operator= ( const AChar *  str )

inline

Assigment operator with null terminated unicode string

Parameters

str	source null terminated string

String& commore::String::operator= ( const Char *  str )

inline

Assigment operator with null terminated string

Parameters

str	source nult terminated string

String& commore::String::operator= ( Char  c )

inline

Assigment operator with an unicode caracter

Parameters

c	source caracter

bool commore::String::operator== ( const AChar *  str ) const

inline

Tests the equality with a null terminated string

bool commore::String::operator== ( const String &  str ) const

inline

Tests equality with an unicode string

bool commore::String::operator== ( const Char *  str ) const

inline

Tests the equality with a null terminated unicode string

bool commore::String::operator> ( const String &  s ) const

inline

Compare string operator with lexical order

Char commore::String::operator[] ( size_t  pos ) const

inline

Get character of string

Returns

the character at position pos in the string.

Char& commore::String::operator[] ( size_t  pos )

inline

Get character of string

Returns

a reference to the character at position pos in the string.

String& commore::String::replace ( size_t  pos1, size_t  n1, const String &  str  )

inline

Replace a substring

Parameters

pos	start position
n	substring size
str	replacement string

String& commore::String::replace ( size_t  pos1, size_t  n1, const String &  str, size_t  pos2, size_t  n2  )

inline

Replace a substring

Parameters

pos1	start position
n1	substring size
str	replacement string
pos2	substring start position
n2	substring size

String& commore::String::replace ( size_t  pos, size_t  n1, const Char *  str, size_t  n2  )

inline

Replace a substring

Parameters

pos1	start position
n1	substring size
str	replacement null terminated string
n2	substring size

String& commore::String::replace ( size_t  pos, size_t  n1, const Char *  str  )

inline

Replace a substring

Parameters

pos1	start position
n1	substring size
str	replacement null terminated string

String& commore::String::replace ( size_t  pos, size_t  n1, size_t  n2, Char  c  )

inline

Replace a substring by n2 consecutive copies of character c.

Parameters

pos1	start position
n1	substring size
n2
c

void commore::String::reserve ( size_t  size )

inline

Allocate a new string capacity

void commore::String::resize ( size_t  n, Char  c  )

inline

Resize string,fill with character c

void commore::String::resize ( size_t  n )

inline

Resize string

size_t commore::String::size ( ) const

inline

Returns

string length

void commore::String::splice

(

String &

str

)

Swap string content

void commore::String::swap

(

String &

str

)

Swap string content

bool commore::String::validate_range ( size_t  pos, size_t *  len  ) const

inline

Check that interval is a substring

Parameters

pos	interval start position
len	interval length

Returns

true if interval is in string

Remarks

this methode should be private

---

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

• commore/String.h