pegasus/src/Pegasus/Common/String.h - diff

Return to String.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/String.h between version 1.20 and 1.39.2.2

version 1.20, 2001/04/27 20:44:38

version 1.39.2.2, 2001/08/02 02:15:49

Line 1

//%/////////////////////////////////////////////////////////////////////////////

// Permission is hereby granted, free of charge, to any person obtaining a

// Permission is hereby granted, free of charge, to any person obtaining a copy

// copy of this software and associated documentation files (the "Software"),

// of this software and associated documentation files (the "Software"), to

// to deal in the Software without restriction, including without limitation

// deal in the Software without restriction, including without limitation the

// the rights to use, copy, modify, merge, publish, distribute, sublicense,

// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

// and/or sell copies of the Software, and to permit persons to whom the

// sell copies of the Software, and to permit persons to whom the Software is

// Software is furnished to do so, subject to the following conditions:

// furnished to do so, subject to the following conditions:

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

// THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN

// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

// ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED

// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

// "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT

// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

// LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR

// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

// PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN

// DEALINGS IN THE SOFTWARE.

// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

//==============================================================================

Line 29

Line 30

#define Pegasus_String_h

#include <iostream>

#include <fstream>

#include <cstring>

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Char16.h>

Line 75

Line 77

String(const char* x, Uint32 n);

/// String destructor. Used by the representation of the String object

~String()

~String();

{

}

/** Assign this string with x.

<pre>

Line 85

String t2 = t1;

</pre>

String& operator=(const String& x) { _rep = x._rep; return *this; }

String& operator=(const String& x) { return assign(x); }

/// Assign this string with x.

/// Assign this string with Char16 x.

String& operator=(const Char16* x) { assign(x); return *this; }

/// Assign this string with x.

/** Assign this string with String x

String& assign(const String& x) { _rep = x._rep; return *this; }

@param x String to assign

@return Returns the String

String& assign(const String& x);

/// Assign this string with x.

String& assign(const Char16* x);

Line 105

Line 108

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

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

/** Clear this string. After calling clear(), getLength() will return 0.

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

<pre>

String test = "abc";

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

</pre>

void clear() { _rep.clear(); _rep.append('\0'); }

void clear();

/** Reserves memory for capacity characters. Notice that this does not

/** reserve - Reserves memory for capacity characters. Notice that this does

change the size of the string (getSize() returns what it did before).

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.

@param capacity defines the capacity in characters to reserve.

void reserve(Uint32 capacity) { _rep.reserve(capacity + 1); }

void reserve(Uint32 capacity);

/** Returns the length of the String object.

@return Length of the string in characters.

<pre>

String s = "abcd";

assert(s.getLength() == 4);

assert(s.size() == 4);

</pre>

Uint32 getLength() const { return _rep.getSize() - 1; }

Uint32 size() const { return _rep.size() - 1; }

/** Returns a pointer to the first character in the null-terminated string

/** getData Returns a pointer to the first character in the

string.

null-terminated string string of the String object.

@param

@return Pointer to the first character of the String object

<pre>

String t1 = "abc";

Line 143

Line 147

const Char16* getData() const { return _rep.getData(); }

/** Allocates an 8 bit representation of this string. The user is

/** AallocateCString - llocates an 8 bit representation of this String

responsible for freeing the result. If any characters are truncated,

object. The user is responsible for freeing the result. If any

a TruncatedCharacter exception is thrown. This exception may

characters are truncated, a TruncatedCharacter exception is thrown.

be suppressed by passing true as the noThrow argument. Extra

This exception may be suppressed by passing true as the noThrow

characters may be allocated at the end of the new string by

argument. Extra characters may be allocated at the end of the

passing a non-zero value to the extraBytes argument.

new string by passing a non-zero value to the extraBytes argument.

@param extraBytes - Defines the number of extra characters to be

@param extraBytes Defines the number of extra characters to be

allocated at the end of the new string. Default is zero.

@param noThrow - If true, no exception will be thrown if characters

@param noThrow If true, no exception will be thrown if characters

are truncated

@return pointer to the new representation of the string

@exception Throws TruncatedCharacter exception if any characters are

truncated

<pre>

String test = "abc";

char* p = test.allocateCString();

...

delete [] p;

</pre>

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

/** Append the given string to a C-string. If the length is not Uint32(-1),

/** appendToCString - Append the given String object to a C-string. If the

then the lesser of the the length argument and the length of this

length is not PEG_NOT_FOUND, then the lesser of the the length argument

string is truncated. Otherwise, the entire string is trunctated. The

and he length of this string is truncated. Otherwise, the entire string

TruncatedCharacter exception is thrown if any characters are truncated.

is trunctated. The TruncatedCharacter exception is thrown if any

characters are truncated.

@param str Char pointer to the string to append

@param length Length to append or PEG_NOT_FOUND (Uint32(-1)

@param noThrow - If false, throw the "TruncatedCharacter" exception of

any characters are truncated

@return void

@exception Throws TruncatedCharacter exception of characters are

truncated and noThrow parameter is false.

<pre>

const char STR0[] = "one two three four";

String s = STR0;

const char STR1[] = "zero ";

char* tmp = new char[strlen(STR1) + s.getLength() + 1];

char* tmp = new char[strlen(STR1) + s.size() + 1];

strcpy(tmp, STR1);

s.appendToCString(tmp, 7);

assert(strcmp(tmp, "zero one two") == 0);

Line 179

Line 197

void appendToCString(

char* str,

Uint32 length = Uint32(-1),

Uint32 length = PEG_NOT_FOUND,

Boolean noThrow = false) const;

/** Returns the Ith character of the String object.

Line 205

Line 223

s4.append(Char16(0x0000))

</pre>

String& append(const Char16& c)

String& append(const Char16& c);

{

_rep.insert(_rep.getSize() - 1, c);

return *this;

}

/// Append n characters from str to this String object.

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

Line 217

Line 231

/// Append the characters of str to this String object.

String& append(const String& str)

{

return append(str.getData(), str.getLength());

return append(str.getData(), str.size());

}

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

@parm String to append.

@param String to append.

@return This String

<pre>

String test = "abc";

Line 235

Line 249

}

/** Append the character given by c to this String object.

@param c - Single character

@param c Single character to be appended

@return String with appended character

String& operator+=(Char16 c)

{

Line 255

Line 270

}

/** Remove size characters from the string starting at the given

position. If size is -1, then all characters after pos are removed.

position. If size is PEG_NOT_FOUND, then all characters after pos are

@param pos - Position in string to start remove

removed.

@param size - Number of characters to remove. Default is -1 which

@param pos Position in string to start remove

causes all characters after pos to be removed

@param size Number of characters to remove. Default is PEG_NOT_FOUND

(Uint32(-1) which causes all characters after pos to be removed

<pre>

String s;

s = "abc";

s.remove(0, 1);

assert(String::equal(s, "bc"));

assert(s.getLength() == 2);

assert(s.size() == 2);

s.remove(0);

assert(String::equal(s, ""));

assert(s.getLength() == 0);

assert(s.size() == 0);

</pre>

@exception throws "OutOfBounds" exception if size is greater than

length of String plus starting position for remove.

void remove(Uint32 pos, Uint32 size = Uint32(-1));

void remove(Uint32 pos, Uint32 size = PEG_NOT_FOUND);

/** Return a new String which is initialzed with <TT>length</TT>

characters from this string starting at <TT>pos</TT>.

@param <TT>pos</TT> is the positon in string to start getting the

substring.

@param <TT>length</TT> is the number of characters to get. If length

is -1, then all characters after pos are added to the new string.

is PEG_NOT_FOUND, then all characters after pos are added to the new

string.

@return String with the defined substring.

<pre>

s = "abcdefg";

Line 287

Line 304

assert(String::equal(s, "abc"));

</pre>

String subString(Uint32 pos, Uint32 length = Uint32(-1)) const;

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

/** Find the position of the first occurence of the character c.

If the character is not found, -1 is returned.

If the character is not found, PEG_NOT_FOUND is returned.

@param c - Char to be found in the String

@param c Char to be found in the String

@return Position of the character in the string or -1 if not found.

@return Position of the character in the string or PEG_NOT_FOUND if not

found.

Uint32 find(Char16 c) 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, -1 is returned.

If the matching substring is not found, PEG_NOT_FOUND is returned.

@param s - String object to be found in the String

@param s String object to be found in the String

@return Position of the substring in the String or -1 if not

@return Position of the substring in the String or PEG_NOT_FOUND if not

found.

Uint32 find(const String& s) const;

/** Find substring

@ param - 16 bit character pointer

@ param 16 bit character pointer

@seealso find

@return Position of the substring in the String or PEG_NOT_FOUND if not

found.

Uint32 find(const Char16* s) const;

/** find substring

@param char* to substring

@param s char* to substring

@return Position of the substring in the String or PEG_NOT_FOUND if not

found.

Uint32 find(const char* s) const;

/** Same as find() but start looking in reverse (last character first).

/** reverseFind - Same as find() but start looking in reverse (last

character first).

@param c Char16 character to find in String.

@Seealso find

@return Position of the character in the string or -1 if not found.

@return 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.

Line 329

Line 355

void toLower();

/** Compare the first n characters of the two strings.

/** Translate any occurences of fromChar to toChar.

@param s1 - First null-terminated string for the comparison

@param s2 - Second null-terminated string for the comparison

void translate(Char16 fromChar, Char16 toChar);

@param n - Number of characters to compare

@return Return -1 if s1 is lexographically less than s2. If they

/** Method for printing a string.

are equavalent return 0. Otherwise return 1.

void print() const;

/** Compare the first n characters of the two strings..

@param s1 First null-terminated string for the comparison.

@param s2 Second null-terminated string for the comparison.

@param n Number of characters to compare.

@return Return -1 if s1 is lexographically less than s2. If they are

equavalent return 0. Otherwise return 1.

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

/** Just like one above except ignores case differences.

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

static int compareNoCase(const char* s1, const char* s2);

/** Compare two null-terminated strings.

@param s1 - First null-terminated string for the comparison

@param s1 First null-terminated string for the comparison.

@param s2 - Second null-terminated string for the comparison

@param s2 Second null-terminated string for the comparison.

@return If s1 is less than s2, return -1; if equal return 0;

otherwise, return 1.

Line 350

Line 390

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

/** Compare two String objects for equality.

@param s1 - First <TT>String</TT> for comparison.

@param s1 First <TT>String</TT> for comparison.

@param s2 - Second <TT>String</TT> for comparison.

@param s2 Second <TT>String</TT> for comparison.

@return Boolean true if the two strings are equal.

<pre>

Line 375

Line 415

/// Return true if the two strings are equal.

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

static Boolean equalIgnoreCase(const String& x, const String& y);

static Boolean equalNoCase(const String& x, const String& y);

/// Convert the plain old C-string to lower case:

static void toLower(char* str);

Line 427

Line 467

return !String::equal(x, y);

}

PEGASUS_COMMON_LINKAGE std::ostream& operator<<(

PEGASUS_COMMON_LINKAGE PEGASUS_STD(ostream)& operator<<(

std::ostream& os,

PEGASUS_STD(ostream)& os,

const String& x);

/** overload operator + - Concatenates String objects.

Line 486

Line 526

/** Compare two strings but ignore any case differences.

PEGASUS_COMMON_LINKAGE int CompareIgnoreCase(const char* s1, const char* s2);

PEGASUS_COMMON_LINKAGE int CompareNoCase(const char* s1, const char* s2);

/** Get the next line from the input file.

PEGASUS_COMMON_LINKAGE Boolean GetLine(std::istream& is, String& line);

PEGASUS_COMMON_LINKAGE Boolean GetLine(PEGASUS_STD(istream)& is, String& line);

/* This is an internal class not to be used by the internal Pegasus

/* This is an internal class to be used by the internal Pegasus

components only. It provides an easy way to create an 8-bit string

representation on the fly without calling allocateCString() and

then worrying about deleting the string. The underscore before the

Line 541

Line 581

char* _rep;

};

inline Uint32 _Length(const String& s1) { return s1.size(); }

inline Uint32 _Length(const char* s1) { return strlen(s1); }

inline Uint32 _Length(const char) { return 1; }

template<class S1, class S2>

inline String Cat(const S1& s1, const S2& s2)

{

String tmp;

tmp.reserve(_Length(s1) + _Length(s2));

tmp.append(s1);

tmp.append(s2);

return tmp;

}

template<class S1, class S2, class S3>

inline String Cat(const S1& s1, const S2& s2, const S3& s3)

{

String tmp;

tmp.reserve(_Length(s1) + _Length(s2) + _Length(s3));

tmp.append(s1);

tmp.append(s2);

tmp.append(s3);

return tmp;

}

template<class S1, class S2, class S3, class S4>

inline String Cat(const S1& s1, const S2& s2, const S3& s3, const S4& s4)

{

String tmp;

tmp.reserve(_Length(s1) + _Length(s2) + _Length(s3) + _Length(s4));

tmp.append(s1);

tmp.append(s2);

tmp.append(s3);

tmp.append(s4);

return tmp;

}

template<class S1, class S2, class S3, class S4, class S5>

inline String Cat(

const S1& s1,

const S2& s2,

const S3& s3,

const S4& s4,

const S5& s5)

{

String tmp;

tmp.reserve(_Length(s1) + _Length(s2) + _Length(s3) + _Length(s4) +

_Length(s5));

tmp.append(s1);

tmp.append(s2);

tmp.append(s3);

tmp.append(s4);

tmp.append(s5);

return tmp;

}

template<class S1, class S2, class S3, class S4, class S5, class S6>

inline String Cat(

const S1& s1,

const S2& s2,

const S3& s3,

const S4& s4,

const S5& s5,

const S6& s6)

{

String tmp;

tmp.reserve(_Length(s1) + _Length(s2) + _Length(s3) + _Length(s4) +

_Length(s5) + _Length(s6));

tmp.append(s1);

tmp.append(s2);

tmp.append(s3);

tmp.append(s4);

tmp.append(s5);

tmp.append(s6);

return tmp;

}

PEGASUS_COMMON_LINKAGE const Array<String>& EmptyStringArray();

PEGASUS_COMMON_LINKAGE Boolean Equal(const String& x, const String& y);

inline Boolean Open(PEGASUS_STD(ifstream)& is, const String& path)

{

char* tmpPath = path.allocateCString();

is.open(tmpPath);

delete [] tmpPath;

return !!is;

}

inline Boolean Open(PEGASUS_STD(ofstream)& os, const String& path)

{

char* tmpPath = path.allocateCString();

os.open(tmpPath);

delete [] tmpPath;

return !!os;

}

inline Boolean OpenAppend(PEGASUS_STD(ofstream)& os, const String& path)

{

char* tmpPath = path.allocateCString();

os.open(tmpPath, PEGASUS_STD(ios::app));

delete [] tmpPath;

return !!os;

}

#define PEGASUS_ARRAY_T String

#include <Pegasus/Common/ArrayInter.h>

#undef PEGASUS_ARRAY_T

PEGASUS_NAMESPACE_END

#endif /* Pegasus_String_h */

Legend:

Removed from v.1.20
changed lines
	Added in v.1.39.2.2

No CVS admin address has been configured