Pegasus Developers Manual

In file ..\..\src\Pegasus\Common\String.h:

class PEGASUS_COMMON_LINKAGE String

The Pegasus String C++ Class implements the CIM string type.

Documentation

The Pegasus String C++ Class implements the CIM string type. This class is based on the general handle/representation pattern defined for all the Pegasus objects. However, it differes from most in that it implements "copy on assign" all of the others implement "no copy on assign" semantics. The string class uses the Array class and implements an array of characters.

Inheritance:

Public Fields
Public Methods

String()

Default constructor without parameters. This constructor creates a null string

	    String test;

String(const String& x)

Copy constructor

String(const String& x, Uint32 n)

Initialize with first n characters from x

String(const Char16* x)

Initialize with x

String(const Char16* x, Uint32 n)

Initialize with first n characters of x

String(const char* x)

Initialize from a plain old C-String:

String(const char* x, Uint32 n)

Initialize from the first n characters of a plain old C-String:

~String()

String destructor. Used by the representation of the String object

String& operator=(const String& x)

Assign this string with x.

	    String t1 = "abc";
	    String t2 = t1;

String& operator=(const Char16* x)

Assign this string with Char16 x

String& assign(const String& x)

Assign this string with String x


Parameters:: - x String to assign
Returns:: Returns the String

String& assign(const Char16* x)

Assign this string with x

String& assign(const Char16* x, Uint32 n)

Assign this string with first n characters of x

String& assign(const char* x)

Assign this string with the plain old C-String x

String& assign(const char* x, Uint32 n)

Assign this string with first n characters of the plain old C-String x

void clear()

clear - Clear this string. After calling clear(), size() will return 0.

	    String test = "abc";
	    test.clear();	 String test is now NULL (length == 0)

void reserve(Uint32 capacity)

reserve - Reserves memory for capacity characters. Notice that this does not change the size of the string (size() returns what it did before). If the capacity of the string is already greater or equal to the capacity argument, this method has no effect. After calling reserve(), getCapicty() returns a value which is greater or equal to the capacity argument.


Parameters:: capacity - defines the capacity in characters to reserve.

Uint32 size() const

Returns the length of the String object.

Returns:

Length of the string in characters.

String s = "abcd";
assert(s.size() == 4);

const Char16* getData() const

getData Returns a pointer to the first character in the null-terminated string string of the String object.

Returns:

Pointer to the first character of the String object

String t1 = "abc";
const Char16* q = t1.getData();

char* allocateCString(Uint32 extraBytes = 0, Boolean noThrow = false) const

AallocateCString - llocates an 8 bit representation of this String object. The user is responsible for freeing the result. If any characters are truncated, a TruncatedCharacter exception is thrown. This exception may be suppressed by passing true as the noThrow argument. Extra characters may be allocated at the end of the new string by passing a non-zero value to the extraBytes argument.

Throws:

Throws TruncatedCharacter exception if any characters are truncated

String test = "abc";
char* p = test.allocateCString();
...
delete [] p;

Parameters:

extraBytes - Defines the number of extra characters to be allocated at the end of the new string. Default is zero.
noThrow - If true, no exception will be thrown if characters are truncated

Returns:

pointer to the new representation of the string

void appendToCString( char* str, Uint32 length = PEG_NOT_FOUND, Boolean noThrow = false) const

appendToCString - Append the given String object to a C-string. If the length is not PEG_NOT_FOUND, then the lesser of the the length argument and he length of this string is truncated. Otherwise, the entire string is trunctated. The TruncatedCharacter exception is thrown if any characters are truncated.

Throws:

Throws TruncatedCharacter exception of characters are truncated and noThrow parameter is false.

const char STR0[] = "one two three four";
String s = STR0;
const char STR1[] = "zero ";
char* tmp = new char[strlen(STR1) + s.size() + 1];
strcpy(tmp, STR1);
s.appendToCString(tmp, 7);
assert(strcmp(tmp, "zero one two") == 0);

Parameters:

str - Char pointer to the string to append
length - Length to append or PEG_NOT_FOUND (Uint32(-1)
noThrow - - If false, throw the "TruncatedCharacter" exception of any characters are truncated

Returns:

void

Char16& operator[](Uint32 i)

Returns the Ith character of the String object.

Throws:

- Throws exception "OutofBounds" if the index is outside the length of the string.

String t1 = "abc;
Char16 c = t1[1];	 character b

const Char16 operator[](Uint32 i) const

Returns the Ith character of the String (const version).


Throws:: - Throws exception "OutofBounds" if the index is outside the length of the string.

String& append(const Char16& c)

Append the given character to the string.

	     String s4 = "Hello";
	    s4.append(Char16(0x0000))

String& append(const Char16* str, Uint32 n)

Append n characters from str to this String object

String& append(const String& str)

Append the characters of str to this String object

String& operator+=(const String& x)

Overload operator += appends the parameter String to this String.

Parameters:

- String to append.

Returns:

This String

String test = "abc";
test += "def";
assert(test == "abcdef");

String& operator+=(Char16 c)

Append the character given by c to this String object.


Parameters:: c - Single character to be appended
Returns:: String with appended character

String& operator+=(char c)

Append the character given by c to this string.

	    String t1 = "abc";
	    t1 += 'd'
	    assert(t1 == "abcd");

void remove(Uint32 pos, Uint32 size = PEG_NOT_FOUND)

Remove size characters from the string starting at the given position. If size is PEG_NOT_FOUND, then all characters after pos are removed.

Throws:

throws "OutOfBounds" exception if size is greater than length of String plus starting position for remove.

Parameters:

pos - Position in string to start remove
- size Number of characters to remove. Default is PEG_NOT_FOUND (Uint32(-1) which causes all characters after pos to be removed

String s;
s = "abc";
s.remove(0, 1);
assert(String::equal(s, "bc"));
assert(s.size() == 2);
s.remove(0);
assert(String::equal(s, ""));
assert(s.size() == 0);

String subString(Uint32 pos, Uint32 length = PEG_NOT_FOUND) const

Return a new String which is initialzed with length characters from this string starting at pos.

Parameters:

- pos is the positon in string to start getting the substring.
- length is the number of characters to get. If length is PEG_NOT_FOUND, then all characters after pos are added to the new string.

Returns:

String with the defined substring.

s = "abcdefg";
s.remove(3);
assert(String::equal(s, "abc"));

Uint32 find(Char16 c) const

Find the position of the first occurence of the character c. If the character is not found, PEG_NOT_FOUND is returned.


Parameters:: c - Char to be found in the String
Returns:: Position of the character in the string or PEG_NOT_FOUND if not found.

Uint32 find(Uint32 pos, Char16 c) const

Same as above but starts searching from the given position.

Uint32 find(const String& s) const

Find the position of the first occurence of the string object. This function finds one string inside another If the matching substring is not found, PEG_NOT_FOUND is returned.


Parameters:: s - String object to be found in the String
Returns:: Position of the substring in the String or PEG_NOT_FOUND if not found.

Uint32 find(const Char16* s) const

Find substring @ param 16 bit character pointer


Returns:: Position of the substring in the String or PEG_NOT_FOUND if not found.
See Also:: also find

Uint32 find(const char* s) const

find substring


Parameters:: s - char* to substring
Returns:: Position of the substring in the String or PEG_NOT_FOUND if not found.

Uint32 reverseFind(Char16 c) const

reverseFind - Same as find() but start looking in reverse (last character first).


Parameters:: c - Char16 character to find in String. @Seealso find
Returns:: Position of the character in the string or PEG_NOT_FOUND if not found. NOTE: This function is defined only for char* input, not for String.

void toLower()

Converts all characters in this string to lower case

void translate(Char16 fromChar, Char16 toChar)

Translate any occurences of fromChar to toChar

void print() const

Method for printing a string

static int compare(const Char16* s1, const Char16* s2, Uint32 n)

Compare the first n characters of the two strings.


Parameters:: s1 - First null-terminated string for the comparison.
s2 - Second null-terminated string for the comparison.
n - Number of characters to compare.
Returns:: Return -1 if s1 is lexographically less than s2. If they are equavalent return 0. Otherwise return 1.

static int compareNoCase(const char* s1, const char* s2, Uint32 n)

Just like one above except ignores case differences

static int compare(const Char16* s1, const Char16* s2)

Compare two null-terminated strings.


Parameters:: s1 - First null-terminated string for the comparison.
s2 - Second null-terminated string for the comparison.
Returns:: If s1 is less than s2, return -1; if equal return 0; otherwise, return 1. NOTE: Use the comparison operators <,<= > >= to compare String objects.

static Boolean equal(const String& x, const String& y)

Compare two String objects for equality.

Parameters:

s1 - First String for comparison.
s2 - Second String for comparison.

Returns:

Boolean true if the two strings are equal.

String s1 = "Hello World";
String s2 = s1;
String s3(s2);
assert(String::equal(s1, s3));

static Boolean equal(const String& x, const Char16* y)

Return true if the two strings are equal

static Boolean equal(const Char16* x, const String& y)

Return true if the two strings are equal

static Boolean equal(const String& x, const char* y)

Return true if the two strings are equal

static Boolean equal(const char* x, const String& y)

Return true if the two strings are equal

static void toLower(char* str)

Convert the plain old C-string to lower case:

static const String EMPTY

EMPTY - Represent an empty string. This member is used to represent empty strings. Using this member avoids an expensive construction of an empty string (e.g., String()).

static Boolean match(const String& str, const String& pattern)

Return true if the str parameter matches the pattern. C-Shell style glob matching is used.

static Boolean matchNoCase(const String& str, const String& pattern)

Return true if the str parameter matches the pattern. C-Shell style glob matching is used. Ignore case in all comparisons.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java

class PEGASUS_COMMON_LINKAGE String

Documentation

Inheritance:

Public Fields

Public Methods