version 1.26, 2001/05/07 13:51:05
|
version 1.96, 2006/01/30 16:17:08
|
|
|
//%///////////////////////////////////////////////////////////////////////////// |
//%2006//////////////////////////////////////////////////////////////////////// |
// | // |
// Copyright (c) 2000 The Open Group, BMC Software, Tivoli Systems, IBM |
// Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
|
// Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
|
// Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.; |
|
// IBM Corp.; EMC Corporation, The Open Group. |
|
// Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
|
// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; VERITAS Software Corporation; The Open Group. |
|
// Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
|
// EMC Corporation; Symantec Corporation; The Open Group. |
// | // |
// 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. |
// | // |
//============================================================================== | //============================================================================== |
// | // |
// Author: Mike Brasher (mbrasher@bmc.com) |
|
// |
|
// Modified By: |
|
// |
|
//%///////////////////////////////////////////////////////////////////////////// | //%///////////////////////////////////////////////////////////////////////////// |
| |
#ifndef Pegasus_String_h | #ifndef Pegasus_String_h |
#define Pegasus_String_h | #define Pegasus_String_h |
| |
|
#ifdef PEGASUS_OS_HPUX |
|
# ifdef HPUX_IA64_NATIVE_COMPILER |
#include <iostream> | #include <iostream> |
#include <cstring> |
# else |
|
# include <iostream.h> |
|
# endif |
|
#else |
|
# include <iostream> |
|
#endif |
#include <Pegasus/Common/Config.h> | #include <Pegasus/Common/Config.h> |
#include <Pegasus/Common/Char16.h> | #include <Pegasus/Common/Char16.h> |
#include <Pegasus/Common/Array.h> |
#include <Pegasus/Common/Linkage.h> |
| |
PEGASUS_NAMESPACE_BEGIN | PEGASUS_NAMESPACE_BEGIN |
| |
|
class String; |
|
struct StringRep; |
|
|
|
/** The CString class provides access to an 8-bit String representation. |
|
*/ |
|
class PEGASUS_COMMON_LINKAGE CString |
|
{ |
|
public: |
|
|
|
/** Constructs a CString object with null values (default constructor). |
|
*/ |
|
CString(); |
|
|
|
/** REVIEWERS: Describe method here. |
|
@param cstr Specifies the name of the CString instance to copy. |
|
*/ |
|
CString(const CString& cstr); |
|
|
|
/** CString destructor. |
|
*/ |
|
~CString(); |
|
|
|
/** Assigns the values of one CString instance to another. |
|
@param cstr Specifies the name of the CString instance whose values |
|
are assigned to CString. |
|
*/ |
|
CString& operator=(const CString& cstr); |
|
|
|
/** Gets a pointer to the CString's data. |
|
@return Returns a const char pointer to the CString's data. |
|
*/ |
|
operator const char*() const; |
|
|
|
private: |
|
|
|
CString(char* cstr); |
|
|
|
friend class String; |
|
|
|
char* _rep; |
|
}; |
|
|
/** | /** |
The Pegasus String C++ Class implements the CIM string type. | The Pegasus String C++ Class implements the CIM string type. |
This class is based on the general handle/representation pattern |
REVIEWERS: We need more definition here. |
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. |
|
*/ | */ |
class PEGASUS_COMMON_LINKAGE String | class PEGASUS_COMMON_LINKAGE String |
{ | { |
public: | public: |
| |
|
/** This member is used to represent an empty string. Using this |
|
member avoids construction of an empty string (for example, String()). |
|
*/ |
|
static const String EMPTY; |
|
|
/** Default constructor without parameters. This constructor creates a | /** Default constructor without parameters. This constructor creates a |
null string |
null string. For example, |
<pre> | <pre> |
String test; | String test; |
</pre> | </pre> |
|
@exception bad_alloc Thrown if there is insufficient memory. |
*/ | */ |
String(); | String(); |
| |
/// Copy constructor. |
/** Copy constructor. |
String(const String& x); |
@param str Specifies the name of the String instance. |
|
@exception bad_alloc Thrown if there is insufficient memory. |
|
*/ |
|
String(const String& str); |
| |
/// Initialize with first n characters from x. |
/** Initialize with first <TT>n</TT> characters from <TT>str</TT>. |
String(const String& x, Uint32 n); |
@param str Specifies the name of the String instance. |
|
@param n Specifies Uint32 size to use for the length of the string object. |
|
@exception bad_alloc Thrown if there is insufficient memory. |
|
*/ |
|
String(const String& str, Uint32 n); |
| |
/// Initialize with x. |
/** Initialize with str. |
String(const Char16* x); |
@param str Specifies the name of the String instance. |
|
@exception NullPointer Thrown if str is NULL. |
|
@exception bad_alloc Thrown if there is insufficient memory. |
|
*/ |
|
String(const Char16* str); |
| |
/// Initialize with first n characters of x. |
/** Initialize with first n characters of str. |
String(const Char16* x, Uint32 n); |
@param str Specifies the name of the String instance. |
|
@param n Specifies the Uint32 size. |
|
@exception NullPointer Thrown if str is NULL. |
|
@exception bad_alloc Thrown if there is insufficient memory. |
|
*/ |
|
String(const Char16* str, Uint32 n); |
| |
/// Initialize from a plain old C-String: |
/** Initialize from a plain C-String: |
String(const char* x); |
@param str Specifies the name of the String instance. |
|
API supports UTF8 |
|
@exception NullPointer Thrown if str is NULL. |
|
@exception bad_alloc Thrown if there is insufficient memory. |
|
*/ |
|
String(const char* str); |
| |
/// Initialize from the first n characters of a plain old C-String: |
/** Initialize from the first <TT>n</TT> characters of a plain C-String: |
String(const char* x, Uint32 n); |
@param str Specifies the name of the String instance. |
|
@param u Specifies the Uint32 size. |
|
API supports UTF8 |
|
@exception NullPointer Thrown if str is NULL. |
|
@exception bad_alloc Thrown if there is insufficient memory. |
|
*/ |
|
String(const char* str, Uint32 n); |
| |
/// String destructor. Used by the representation of the String object |
/** String destructor. |
~String() |
*/ |
{ |
~String(); |
} |
|
| |
/** Assign this string with x. |
/** Assign this string with str. For example, |
<pre> | <pre> |
String t1 = "abc"; | String t1 = "abc"; |
String t2 = t1; | String t2 = t1; |
</pre> | </pre> |
|
String t2 is assigned the value of t1. |
|
@param str Specifies the name of the String to assign to another |
|
String instance. |
|
@exception bad_alloc Thrown if there is insufficient memory. |
*/ | */ |
String& operator=(const String& x) { _rep = x._rep; return *this; } |
String& operator=(const String& str); |
|
|
/// Assign this string with Char16 x. |
|
String& operator=(const Char16* x) { assign(x); return *this; } |
|
| |
/** Assign this string with String x |
/** Assign this string with String str. |
@param x String to assign |
@param str String to assign. |
@return Returns the String |
@return Returns the String. |
|
API supports UTF8 |
|
@exception bad_alloc Thrown if there is insufficient memory. |
*/ | */ |
String& assign(const String& x) { _rep = x._rep; return *this; } |
String& assign(const String& str); |
| |
/// Assign this string with x. |
/** Assign this string with str. |
String& assign(const Char16* x); |
@exception NullPointer Thrown if str is NULL. |
|
@exception bad_alloc Thrown if there is insufficient memory. |
|
*/ |
|
String& assign(const Char16* str); |
| |
/// Assign this string with first n characters of x. |
/** Assign this string with first n characters of str. |
String& assign(const Char16* x, Uint32 n); |
@param n REVIEWERS: Insert text here. |
|
@param str REVIEWERS: Insert text here. |
|
@exception NullPointer Thrown if str is NULL. |
|
@exception bad_alloc Thrown if there is insufficient memory. |
|
*/ |
|
String& assign(const Char16* str, Uint32 n); |
| |
/// Assign this string with the plain old C-String x. |
/** Assign this string with the plain C-String str. |
String& assign(const char* x); |
@param str REVIEWERS: Insert text here. |
|
API supports UTF8 |
|
@exception NullPointer Thrown if str is NULL. |
|
@exception bad_alloc Thrown if there is insufficient memory. |
|
*/ |
|
String& assign(const char* str); |
| |
/// Assign this string with first n characters of the plain old C-String x. |
/** Assign this string with first n characters of the plain C-String str. |
String& assign(const char* x, Uint32 n); |
@param str REVIEWERS: Insert text here. |
|
@param n REVIEWERS: Insert text here. |
|
API supports UTF8 |
|
@exception NullPointer Thrown if str is NULL. |
|
@exception bad_alloc Thrown if there is insufficient memory. |
|
*/ |
|
String& assign(const char* str, Uint32 n); |
| |
/** clear - Clear this string. After calling clear(), size() will return 0. |
/** Clear this string. After calling clear(), size() will return 0. |
<pre> | <pre> |
String test = "abc"; | String test = "abc"; |
test.clear(); // String test is now NULL (length == 0) |
test.clear(); |
</pre> | </pre> |
*/ | */ |
void clear() { _rep.clear(); _rep.append('\0'); } |
void clear(); |
| |
/** reserve - Reserves memory for capacity characters. Notice that this does |
/** Reserves memory for capacity characters. Notice |
not |
that this does not change the size of the string (size() returns |
change the size of the string (size() returns what it did before). |
what it did before). If the capacity of the string is already |
If the capacity of the string is already greater or equal to the |
greater or equal to the capacity argument, this method has no |
capacity argument, this method has no effect. After calling reserve(), |
effect. The capacity of a String object has no bearing on its |
getCapicty() returns a value which is greater or equal to the |
external behavior. The capacity of a String is set only for |
capacity argument. |
performance reasons. |
@param capacity defines the capacity in characters to reserve. |
@param capacity Defines the capacity in characters to reserve. |
*/ | */ |
void reserve(Uint32 capacity) { _rep.reserve(capacity + 1); } |
void reserveCapacity(Uint32 capacity); |
| |
/** Returns the length of the String object. | /** Returns the length of the String object. |
@return Length of the string in characters. |
@return Length of the String in characters. For example, |
<pre> | <pre> |
String s = "abcd"; | String s = "abcd"; |
assert(s.size() == 4); | assert(s.size() == 4); |
</pre> | </pre> |
|
returns a value of 4 for the length. |
*/ | */ |
Uint32 size() const { return _rep.size() - 1; } |
Uint32 size() const; |
| |
/** Returns a pointer to the first character in the null-terminated string |
/** Returns a pointer to the first character in the |
string. |
null-terminated Char16 buffer of the String object. |
@return Pointer to the first character of the String object |
@return Pointer to the first character of the String object. For example, |
<pre> | <pre> |
String t1 = "abc"; |
String test = "abc"; |
const Char16* q = t1.getData(); |
const Char16* q = test.getChar16Data(); |
</pre> | </pre> |
|
points to the first character in the String instance named test. |
*/ | */ |
const Char16* getData() const { return _rep.getData(); } |
const Char16* getChar16Data() const; |
|
|
|
/** Create an 8-bit representation of this String object. For example, |
|
|
|
@return CString object that provides access to the UTF8 String |
|
representation. |
| |
/** AallocateCString - llocates an 8 bit representation of this string. 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. |
|
@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 |
|
are truncated |
|
@return pointer to the new representation of the string |
|
@exception Throws TruncatedCharacter exception if any characters are |
|
truncated |
|
<pre> | <pre> |
String test = "abc"; | String test = "abc"; |
char* p = test.allocateCString(); |
printf("test = %s\n", (const char*)test.getCString()); |
</pre> |
|
*/ |
|
char* allocateCString(Uint32 extraBytes = 0, Boolean noThrow = false) const; |
|
| |
/** appendToCString - Append the given string to a C-string. If the length |
USAGE WARNING: Do not do the following: |
is not Uint32(-1), |
|
then the lesser of the the length argument and the length of this |
|
string is truncated. Otherwise, the entire string is trunctated. The |
|
TruncatedCharacter exception is thrown if any characters are truncated. |
|
<pre> |
|
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); |
|
</pre> |
|
*/ |
|
void appendToCString( |
|
char* str, |
|
Uint32 length = Uint32(-1), |
|
Boolean noThrow = false) const; |
|
| |
/** Returns the Ith character of the String object. |
const char * p = (const char *)test.getCString(); |
@exception - Throws exception "OutofBounds" if the index |
|
is outside the length of the string. |
The pointer p will be invalid. This is because |
<pre> |
the Compiler casues the CString object to be created on the |
String t1 = "abc; |
callers stack as a temporary object. The deletion is therefore |
Char16 c = t1[1]; // character b |
also the responsibility of the Compiler. The Compiler may cause |
</pre> |
it to be deleted at anytime after the return. Typically it is |
*/ |
done at the closeof the next scope. When it is deleted the |
Char16& operator[](Uint32 i); |
"const char *p" above will become a dangling pointer. |
|
|
|
The correct usage to achieve the "const char * p" is |
|
as follows: |
|
|
|
String str = "hello"; |
|
... |
|
CString cstr = str.getCString(); |
|
|
|
const char* p = (const char*)cstr; |
| |
/** Returns the Ith character of the String (const version). |
This tells the compiler to create a CString object on the callers |
@exception - Throws exception "OutofBounds" if the index |
stack that is the deleted at the discretion of the caller rather |
is outside the length of the string. |
than the compiler. The "const char *p" above will be good until |
|
the caller explicity deletes the CString object. |
| |
|
|
|
</pre> |
|
@exception bad_alloc Thrown if there is insufficient memory. |
*/ | */ |
const Char16 operator[](Uint32 i) const; |
CString getCString() const; |
| |
/** Append the given character to the string. |
/** Returns the specified character of the String object. |
|
@param index Index of the character to access. |
|
@return Specified character of the String object. |
|
@exception IndexOutOfBoundsException If <TT>index</TT> |
|
is outside the bounds of the String. |
<pre> | <pre> |
String s4 = "Hello"; |
String test = "abc; |
s4.append(Char16(0x0000)) |
Char16 c = test[1]; |
</pre> | </pre> |
*/ | */ |
String& append(const Char16& c) |
Char16& operator[](Uint32 index); |
{ |
|
_rep.insert(_rep.size() - 1, c); |
|
return *this; |
|
} |
|
| |
/// Append n characters from str to this String object. |
/** Returns the specified character of the String object (const version). |
String& append(const Char16* str, Uint32 n); |
@param index Index of the character to access. |
|
@return Specified character of the String object. |
/// Append the characters of str to this String object. |
@exception IndexOutOfBoundsException If <TT>index</TT> |
String& append(const String& str) |
is outside the bounds of the String. |
{ |
*/ |
return append(str.getData(), str.size()); |
const Char16 operator[](Uint32 index) const; |
} |
|
| |
/** Overload operator += appends the parameter String to this String. |
/** Append the given character to this String. |
@param String to append. |
@param c Character to append. |
@return This String |
@return This String. |
<pre> | <pre> |
String test = "abc"; | String test = "abc"; |
test += "def"; |
test.append(Char16('d')); |
assert(test == "abcdef"); |
assert(test == "abcd"); |
</pre> | </pre> |
|
@exception bad_alloc Thrown if there is insufficient memory. |
*/ | */ |
String& operator+=(const String& x) |
String& append(const Char16& c); |
{ |
|
return append(x); |
|
} |
|
| |
/** Append the character given by c to this String object. |
/** Append n characters from str to this String. |
@param c Single character to be appended |
@param str REVIEWERS: Insert text here. |
@return String with appended character |
@param n REVIEWERS: Insert text here. |
|
@exception NullPointer Thrown if str is NULL. |
|
@exception bad_alloc Thrown if there is insufficient memory. |
*/ | */ |
String& operator+=(Char16 c) |
String& append(const Char16* str, Uint32 n); |
{ |
|
return append(c); |
|
} |
|
| |
/** Append the character given by c to this string. |
/** Append the given String to this String. |
|
@param str String to append. |
|
@return This String. |
<pre> | <pre> |
String t1 = "abc"; |
String test = "abc"; |
t1 += 'd' |
test.append("def"); |
assert(t1 == "abcd"); |
assert(test == "abcdef"); |
</pre> | </pre> |
|
@exception bad_alloc Thrown if there is insufficient memory. |
*/ | */ |
String& operator+=(char c) |
String& append(const String& str); |
{ |
|
return append(Char16(c)); |
|
} |
|
| |
/** Remove size characters from the string starting at the given | /** Remove size characters from the string starting at the given |
position. If size is -1, then all characters after pos are removed. |
index. If size is PEG_NOT_FOUND, then all characters after |
@param pos Position in string to start remove |
<TT>index</TT> are removed. |
@param size Number of characters to remove. Default is -1 which |
@param index 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 |
|
which causes all characters after <TT>index</TT> to be removed. |
<pre> | <pre> |
String s; | String s; |
s = "abc"; | s = "abc"; |
|
|
assert(String::equal(s, "")); | assert(String::equal(s, "")); |
assert(s.size() == 0); | assert(s.size() == 0); |
</pre> | </pre> |
@exception throws "OutOfBounds" exception if size is greater than |
@exception IndexOutOfBoundsException If size is greater than |
length of String plus starting position for remove. |
length of String plus starting index for remove. |
*/ | */ |
void remove(Uint32 pos, Uint32 size = Uint32(-1)); |
void remove(Uint32 index, Uint32 size = PEG_NOT_FOUND); |
| |
/** Return a new String which is initialzed with <TT>length</TT> | /** Return a new String which is initialzed with <TT>length</TT> |
characters from this string starting at <TT>pos</TT>. |
characters from this string starting at <TT>index</TT>. |
@param <TT>pos</TT> is the positon in string to start getting the |
@param index Specifies the index in string to start getting the |
substring. | substring. |
@param <TT>length</TT> is the number of characters to get. If length |
@param length Specifies 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 index are added to the new |
@return String with the defined substring. |
string. |
<pre> |
@return String Specifies the Sting with the defined substring. |
s = "abcdefg"; |
@exception bad_alloc Thrown if there is insufficient memory. |
s.remove(3); |
|
assert(String::equal(s, "abc")); |
|
</pre> |
|
*/ | */ |
String subString(Uint32 pos, Uint32 length = Uint32(-1)) const; |
String subString(Uint32 index, Uint32 length = PEG_NOT_FOUND) const; |
| |
/** Find the position of the first occurence of the character c. |
/** Find the index of the first occurrence 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; | Uint32 find(Char16 c) const; |
| |
/** Find the position of the first occurence of the string object. |
/** Find the index of the first occurence of the character c. |
This function finds one string inside another |
If the character is not found, PEG_NOT_FOUND is returned. |
If the matching substring is not found, -1 is returned. |
Searching begins from the specified index. |
@param s String object to be found in the String |
@param c Char to be found in the String. |
@return Position of the substring in the String or -1 if not |
@return Position of the character in the string or PEG_NOT_FOUND if the |
found. |
character is not found. |
|
*/ |
|
Uint32 find(Uint32 index, Char16 c) const; |
|
|
|
/** Find the index 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. |
|
@param s String object to be found in the String. |
|
@return Position of the substring in the String or PEG_NOT_FOUND if the |
|
substring is not found. |
*/ | */ |
Uint32 find(const String& s) const; | Uint32 find(const String& s) const; |
| |
/** Find substring |
/** Same as find() but start looking in reverse (last character first). |
@ param 16 bit character pointer |
|
@seealso find |
|
@return Position of the substring in the String or -1 if not |
|
found. |
|
*/ |
|
Uint32 find(const Char16* s) const; |
|
|
|
/** find substring |
|
@param s char* to substring |
|
@return Position of the substring in the String or -1 if not |
|
found. |
|
*/ |
|
Uint32 find(const char* s) const; |
|
|
|
/** reverseFind - Same as find() but start looking in reverse (last |
|
character first). |
|
@param c Char16 character to find in String. | @param c Char16 character to find in String. |
@Seealso find |
@return Position of the character in the string or PEG_NOT_FOUND if the |
@return Position of the character in the string or -1 if not found. |
character is not found. |
|
|
NOTE: This function is defined only for char* input, not for |
|
String. |
|
*/ | */ |
Uint32 reverseFind(Char16 c) const; | Uint32 reverseFind(Char16 c) const; |
| |
/** Converts all characters in this string to lower case. |
/** Converts all characters in this string to lowercase characters, |
*/ | */ |
void toLower(); | void toLower(); |
| |
/** Translate any occurences of fromChar to toChar. |
#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES |
|
/** <I><B>Experimental Interface</B></I><BR> |
|
Converts all characters in this string to uppercase characters. |
|
*/ |
|
void toUpper(); |
|
#endif |
|
|
|
/** |
|
Compares the first n characters of two String objects. |
|
@param s1 The first String to compare. |
|
@param s2 The second String to compare. |
|
@param n The maximum number of characters to compare. |
|
@return Returns a negative integer if the first n characters of s1 |
|
are lexographically less than s2, 0 if the first n characters of s1 |
|
and s2 are equal, and a positive integer otherwise. |
*/ | */ |
void translate(Char16 fromChar, Char16 toChar); |
static int compare(const String& s1, const String& s2, Uint32 n); |
| |
/** Compare the first n characters of the two strings. |
/** |
@param s1 First null-terminated string for the comparison |
Compares two String objects. |
@param s2 Second null-terminated string for the comparison |
@param s1 The first String to compare. |
@param n Number of characters to compare |
@param s2 The second String to compare. |
@return Return -1 if s1 is lexographically less than s2. If they |
@return Returns a negative integer if s1 is lexographically less |
are equavalent return 0. Otherwise return 1. |
than s2, 0 if s1 and s2 are equal, and a positive integer otherwise. |
*/ |
|
static int compare(const Char16* s1, const Char16* s2, Uint32 n); |
|
|
|
/** Compare two null-terminated strings. |
|
@param s1 First 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. |
|
| |
NOTE: Use the comparison operators <,<= > >= to compare | NOTE: Use the comparison operators <,<= > >= to compare |
String objects. | String objects. |
*/ | */ |
static int compare(const Char16* s1, const Char16* s2); |
static int compare(const String& s1, const String& s2); |
|
|
|
/** |
|
Compares two String objects, ignoring case differences. |
|
@param s1 The first String to compare. |
|
@param s2 The second String to compare. |
|
@return Returns a negative integer if s1 is lexographically less |
|
than s2, 0 if s1 and s2 are equal, and a positive integer otherwise. |
|
(Case differences are ignored in all cases.) |
|
*/ |
|
static int compareNoCase(const String& s1, const String& s2); |
| |
/** Compare two String objects for equality. | /** 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. |
@return true If the two strings are equal; otherwise, false. For example, |
<pre> | <pre> |
String s1 = "Hello World"; | String s1 = "Hello World"; |
String s2 = s1; | String s2 = s1; |
|
|
assert(String::equal(s1, s3)); | assert(String::equal(s1, s3)); |
</pre> | </pre> |
*/ | */ |
static Boolean equal(const String& x, const String& y); |
static Boolean equal(const String& str1, const String& str2); |
| |
/// Return true if the two strings are equal. |
/** Compares two strings and returns true if they |
static Boolean equal(const String& x, const Char16* y); |
are equal indepedent of case of the characters. |
|
@param str1 First String parameter. |
|
@param str2 Second String parameter. |
|
@return true If strings are equal independent of case, flase |
|
otherwise. |
|
*/ |
|
static Boolean equalNoCase(const String& str1, const String& str2); |
| |
/// Return true if the two strings are equal. |
#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES |
static Boolean equal(const Char16* x, const String& y); |
|
| |
/// Return true if the two strings are equal. |
String(const String& s1, const String& s2); |
static Boolean equal(const String& x, const char* y); |
|
| |
/// Return true if the two strings are equal. |
String(const String& s1, const char* s2); |
static Boolean equal(const char* x, const String& y); |
|
| |
static Boolean equalIgnoreCase(const String& x, const String& y); |
String(const char* s1, const String& s2); |
| |
/// Convert the plain old C-string to lower case: |
String& operator=(const char* str); |
static void toLower(char* str); |
|
| |
/** EMPTY - Represent an empty string. |
Uint32 find(const char* s) const; |
This member is used to represent empty strings. Using this member |
|
avoids an expensive construction of an empty string (e.g., String()). |
|
*/ |
|
static const String EMPTY; |
|
| |
private: |
static Boolean equal(const String& s1, const char* s2); |
| |
static Uint32 _min(Uint32 x, Uint32 y) { return x < y ? x : y; } |
static int compare(const String& s1, const char* s2); |
| |
Array<Char16> _rep; |
String& append(const char* str); |
}; |
|
| |
/** String operator ==. Test for equality between two strings of any of the |
String& append(const char* str, Uint32 size); |
types String or char*. |
|
@return Boolean - True if the strings are equal |
|
| |
*/ |
static Boolean equalNoCase(const String& s1, const char* s2); |
inline Boolean operator==(const String& x, const String& y) |
|
{ |
|
return String::equal(x, y); |
|
} |
|
| |
/** String operator ==. Test for equality between two strings |
#endif /* PEGASUS_USE_EXPERIMENTAL_INTERFACES */ |
| |
*/ |
private: |
inline Boolean operator==(const String& x, const char* y) |
|
{ |
|
return String::equal(x, y); |
|
} |
|
| |
/** String operator ==. Test for equality between two strings |
StringRep* _rep; |
|
}; |
| |
|
/** String operator == tests for equality between two strings of any of the |
|
types String or char*. |
|
@return true If the strings are equal; otherwise, false. |
|
@param str1 REVIEWERS: Insert description here. |
|
@param str2 REVIEWERS: Insert description here. |
*/ | */ |
inline Boolean operator==(const char* x, const String& y) |
PEGASUS_COMMON_LINKAGE Boolean operator==( |
{ |
const String& str1, |
return String::equal(x, y); |
const String& str2); |
} |
|
| |
/** String operator ==. Test for equality between two strings |
/** String operator ==. Test for equality between two strings. |
|
@param str1 REVIEWERS: Insert description here. |
|
@param str2 REVIEWERS: Insert description here. |
|
*/ |
|
PEGASUS_COMMON_LINKAGE Boolean operator==(const String& str1, const char* str2); |
| |
|
/** String operator ==. Test for equality between two strings. |
|
@param str1 REVIEWERS: Insert description here. |
|
@param str2 REVIEWERS: Insert description here. |
*/ | */ |
inline Boolean operator!=(const String& x, const String& y) |
PEGASUS_COMMON_LINKAGE Boolean operator==(const char* str1, const String& str2); |
{ |
|
return !String::equal(x, y); |
|
} |
|
| |
PEGASUS_COMMON_LINKAGE std::ostream& operator<<( |
/** String operator ==. Test for equality between two strings. |
std::ostream& os, |
@param str1 REVIEWERS: Insert description here. |
const String& x); |
@param str2 REVIEWERS: Insert description here. |
|
*/ |
|
PEGASUS_COMMON_LINKAGE Boolean operator!=( |
|
const String& str1, |
|
const String& str2); |
| |
/** overload operator + - Concatenates String objects. |
/** REVIEWERS: Insert description here. |
|
@param str REVIEWERS: Insert description here. |
|
@param os REVIEWERS: Insert description here. |
|
*/ |
|
PEGASUS_COMMON_LINKAGE PEGASUS_STD(ostream)& operator<<( |
|
PEGASUS_STD(ostream)& os, |
|
const String& str); |
| |
|
/** This overload operator (+) concatenates String objects. For example, |
<pre> | <pre> |
String t1 = "abc"; | String t1 = "abc"; |
String t2; | String t2; |
|
|
assert(t2 == "abcdef"); | assert(t2 == "abcdef"); |
</pre> | </pre> |
*/ | */ |
inline String operator+(const String& x, const String& y) |
PEGASUS_COMMON_LINKAGE String operator+(const String& str1, const String& str2); |
{ |
|
return String(x).append(y); |
|
} |
|
| |
/** overload operator < - Compares String obects. |
/** The overload operator (<) compares String obects. |
<pre> | <pre> |
String t1 = "def"; | String t1 = "def"; |
String t2 = "a"; | String t2 = "a"; |
assert (t2 < t1); | assert (t2 < t1); |
</pre> | </pre> |
|
@param str1 REVIEWERS: Insert description here. |
|
@param str2 REVIEWERS: Insert description here. |
*/ | */ |
inline Boolean operator<(const String& x, const String& y) |
PEGASUS_COMMON_LINKAGE Boolean operator<( |
{ |
const String& str1, |
return String::compare(x.getData(), y.getData()) < 0; |
const String& str2); |
} |
|
|
|
/** overload operator <= compares String objects. |
|
| |
|
/** The overload operator (<=) compares String objects. |
|
@param str1 REVIEWERS: Insert description here. |
|
@param str2 REVIEWERS: Insert description here. |
*/ | */ |
inline Boolean operator<=(const String& x, const String& y) |
PEGASUS_COMMON_LINKAGE Boolean operator<=( |
{ |
const String& str1, |
return String::compare(x.getData(), y.getData()) <= 0; |
const String& str2); |
} |
|
| |
/** Overload operator > compares String objects |
/** The overload operator (>) compares String objects. |
|
@param str1 REVIEWERS: Insert description here. |
|
@param str2 REVIEWERS: Insert description here. |
*/ | */ |
inline Boolean operator>(const String& x, const String& y) |
PEGASUS_COMMON_LINKAGE Boolean operator>( |
{ |
const String& str1, |
return String::compare(x.getData(), y.getData()) > 0; |
const String& str2); |
} |
|
| |
/** overload operator >= - Compares String objects |
/** The overload operator (>=) compares String objects. |
|
@param str1 REVIEWERS: Insert description here. |
|
@param str2 REVIEWERS: Insert description here. |
*/ | */ |
inline Boolean operator>=(const String& x, const String& y) |
PEGASUS_COMMON_LINKAGE Boolean operator>=( |
{ |
const String& str1, |
return String::compare(x.getData(), y.getData()) >= 0; |
const String& str2); |
} |
|
| |
/** Return a version of this string whose characters have been shifted |
#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES |
to lower case. |
|
*/ |
|
PEGASUS_COMMON_LINKAGE String ToLower(const String& str); |
|
| |
/** Compare two strings but ignore any case differences. |
PEGASUS_COMMON_LINKAGE Boolean operator==(const String& s1, const String& s2); |
*/ |
|
PEGASUS_COMMON_LINKAGE int CompareIgnoreCase(const char* s1, const char* s2); |
|
| |
/** Get the next line from the input file. |
PEGASUS_COMMON_LINKAGE Boolean operator==(const String& s1, const char* s2); |
*/ |
|
PEGASUS_COMMON_LINKAGE Boolean GetLine(std::istream& is, String& line); |
|
| |
/* This is an internal class not to be used by the internal Pegasus |
PEGASUS_COMMON_LINKAGE Boolean operator==(const char* s1, const String& s2); |
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 |
|
class name denotes that this class is internal, unsupported, undocumented, |
|
and may be removed in future releases. |
|
*/ |
|
class _CString |
|
{ |
|
public: |
|
| |
_CString(const String& x) |
PEGASUS_COMMON_LINKAGE Boolean operator!=(const String& s1, const String& s2); |
{ |
|
_rep = x.allocateCString(); |
|
} |
|
| |
_CString(const _CString& x) |
PEGASUS_COMMON_LINKAGE Boolean operator!=(const String& s1, const char* s2); |
{ |
|
_rep = strcpy(new char[strlen(x._rep) + 1], x._rep); |
|
} |
|
| |
~_CString() |
PEGASUS_COMMON_LINKAGE Boolean operator!=(const char* s1, const String& s2); |
{ |
|
delete [] _rep; |
|
} |
|
| |
_CString& operator=(const _CString& x) |
PEGASUS_COMMON_LINKAGE Boolean operator<(const String& s1, const String& s2); |
{ |
|
if (this != &x) |
|
_rep = strcpy(new char[strlen(x._rep) + 1], x._rep); |
|
| |
return *this; |
PEGASUS_COMMON_LINKAGE Boolean operator<(const String& s1, const char* s2); |
} |
|
| |
operator const char*() const |
PEGASUS_COMMON_LINKAGE Boolean operator<(const char* s1, const String& s2); |
{ |
|
return _rep; |
|
} |
|
| |
const char* data() const |
PEGASUS_COMMON_LINKAGE Boolean operator>(const String& s1, const String& s2); |
{ |
|
return _rep; |
|
} |
|
| |
private: |
PEGASUS_COMMON_LINKAGE Boolean operator>(const String& s1, const char* s2); |
| |
char* _rep; |
PEGASUS_COMMON_LINKAGE Boolean operator>(const char* s1, const String& s2); |
}; |
|
| |
inline Uint32 _Length(const String& s1) { return s1.size(); } |
PEGASUS_COMMON_LINKAGE Boolean operator<=(const String& s1, const String& s2); |
| |
inline Uint32 _Length(const char* s1) { return strlen(s1); } |
PEGASUS_COMMON_LINKAGE Boolean operator<=(const String& s1, const char* s2); |
| |
inline Uint32 _Length(const char) { return 1; } |
PEGASUS_COMMON_LINKAGE Boolean operator<=(const char* s1, const String& s2); |
| |
template<class S1, class S2> |
PEGASUS_COMMON_LINKAGE Boolean operator>=(const String& s1, const String& 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> |
PEGASUS_COMMON_LINKAGE Boolean operator>=(const String& s1, const char* s2); |
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) + |
PEGASUS_COMMON_LINKAGE Boolean operator>=(const char* s1, const String& s2); |
_Length(s5)); |
|
| |
tmp.append(s1); |
PEGASUS_COMMON_LINKAGE String operator+(const String& s1, const String& s2); |
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) + |
PEGASUS_COMMON_LINKAGE String operator+(const String& s1, const char* s2); |
_Length(s5) + _Length(s6)); |
|
| |
tmp.append(s1); |
PEGASUS_COMMON_LINKAGE String operator+(const char* s1, const String& s2); |
tmp.append(s2); |
|
tmp.append(s3); |
|
tmp.append(s4); |
|
tmp.append(s5); |
|
tmp.append(s6); |
|
| |
return tmp; |
#endif /* PEGASUS_USE_EXPERIMENTAL_INTERFACES */ |
} |
|
| |
PEGASUS_NAMESPACE_END | PEGASUS_NAMESPACE_END |
| |
#endif /* Pegasus_String_h */ |
#if defined(PEGASUS_INTERNALONLY) && !defined(PEGASUS_DISABLE_INTERNAL_INLINES) |
|
# include "StringInline.h" |
|
#endif |
| |
|
#endif /* Pegasus_String_h */ |