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.10 and 1.80

version 1.10, 2001/03/29 16:40:31

version 1.80, 2003/11/15 02:49:54

Line 1

//BEGIN_LICENSE

//%2003////////////////////////////////////////////////////////////////////////

// Company, L. P., IBM Corp., The Open Group, Tivoli Systems.

// IBM Corp.; EMC Corporation, The Open Group.

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

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

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

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

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

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

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

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

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

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

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

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

// 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.

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

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

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

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

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

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

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

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

// Author: Mike Brasher (mbrasher@bmc.com)

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

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

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

// LIABILITY, WHETHER IN AN 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.

//END_LICENSE

// Modified By: Karl Schopmeyer(k.schopmeyer@opengroup.org)

//BEGIN_HISTORY

// Roger Kumpf, Hewlett-Packard Company (roger_kumpf@hp.com)

// Author:

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

// $Log$

// Revision 1.10 2001/03/29 16:40:31 karl

// add doc

// Revision 1.9 2001/02/26 04:33:28 mike

// Fixed many places where cim names were be compared with operator==(String,String).

// Changed all of these to use CIMName::equal()

// Revision 1.8 2001/02/20 14:05:24 karl

// Comments for Document

// Revision 1.7 2001/02/11 17:19:30 mike

// added reverseFind() method

// Revision 1.6 2001/02/11 05:42:33 mike

// new

// Revision 1.5 2001/01/30 08:00:43 karl

// DOC++ Documentation update for header files

// Revision 1.4 2001/01/28 07:05:18 mike

// added instance name/reference converters

// Revision 1.3 2001/01/28 04:11:03 mike

// fixed qualifier resolution

// Revision 1.2 2001/01/24 16:16:38 karl

// Incorporate Doc++ Comments as documentation into .h files

// Revision 1.1.1.1 2001/01/14 19:53:15 mike

// Pegasus import

//END_HISTORY

#ifndef Pegasus_String_h

#define Pegasus_String_h

#ifdef PEGASUS_OS_HPUX

# ifdef HPUX_IA64_NATIVE_COMPILER

# include <iostream>

# else

# include <iostream.h>

# endif

#else

#include <iostream>

#include <cstring>

#endif

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Char16.h>

#include <Pegasus/Common/Array.h>

#include <Pegasus/Common/Linkage.h>

const char STRING_FLAG_ASCII[] = "ASCII";

const char STRING_FLAG_UTF8[] = "UTF8";

PEGASUS_NAMESPACE_BEGIN

/**

class String;

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

class StringRep;

/** The CString class provides access to an 8-bit String representation.

class PEGASUS_COMMON_LINKAGE String

class PEGASUS_COMMON_LINKAGE CString

{

public:

/// Default constructor.

/** Constructs a CString object with null values (default constructor).

String();

CString();

/// Copy constructor.

/** REVIEWERS: Describe method here.

String(const String& x);

@param cstr Specifies the name of the CString instance.

CString(const CString& cstr);

/// Initialize with first n characters from x.

/** CString destructor.

String(const String& x, Uint32 n);

~CString();

/// Initialize with x.

/** Assigns the values of one CString instance to another.

String(const Char16* x);

@param cstr Specifies the name of the CString instance whose values

are assigned to CString.

CString& operator=(const CString& cstr);

/// Initialize with first n characters of x.

/** REVIEWERS: Describe constructor here.

String(const Char16* x, Uint32 n);

operator const char*() const;

/// Initialize from a plain old C-String:

private:

String(const char* x);

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

CString(char* cstr);

String(const char* x, Uint32 n);

/// Release all resources.

friend class String;

~String()

{

}

/// Assign this string with x.

void* _rep;

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

};

/// Assign this string with x.

/**

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

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

REVIEWERS: We need more definition here.

class PEGASUS_COMMON_LINKAGE String

{

public:

/// Assign this string with x.

/** This member is used to represent an empty string. Using this

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

member avoids construction of an empty string (for example, String()).

static const String EMPTY;

/// Assign this string with x.

/** Default constructor without parameters. This constructor creates a

String& assign(const Char16* x);

null string. For example,

<pre>

String test;

</pre>

String();

/// Assign this string with first n characters of x.

/** Copy constructor.

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

@param str Specifies the name of the String instance.

String(const String& str);

/// Assign this string with the plain old C-String x.

/** Initialize with first n characters from str.

String& assign(const char* x);

@param str Specifies the name of the String instance.

@param n Specifies the Uint32 size to use for the length of the string object.

String(const String& str, Uint32 n);

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

/** Initialize with str.

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

@param str Specifies the name of the String instance.

String(const Char16* str);

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

/** Initialize with first n characters of str.

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

@param str Specifies the name of the String instance.

@param n Specifies the Uint32 size.

String(const Char16* str, Uint32 n);

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

/** Initialize from a plain C-String:

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

@param str Specifies the name of the String instance.

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.

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

String(const char* str);

/// Returns the length of the string.

#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES

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

/** Initialize from a plain C-String that allows UTF-8:

@param str Specifies the name of the String instance.

@param utfFlag Specifies the name of the character constructor.

String(const char* str, const char* utfFlag);

#endif

/// Returns a pointer to the first character in the string string.

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

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

@param str Specifies the name of the String instance.

@param u Specifies the Uint32 size.

String(const char* str, Uint32 n);

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

/** String destructor.

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.

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

~String();

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

/** Assign this string with str. For example,

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

<pre>

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

String t1 = "abc";

TruncatedCharacter exception is thrown if any characters are truncated.

String t2 = t1;

</pre>

String t2 is assigned the value of t1.

@param str Specifies the name of the String to assign to another

String instance.

void appendToCString(

String& operator=(const String& str);

char* str,

Uint32 length = Uint32(-1),

Boolean noThrow = false) const;

/// Returns the Ith character of the string.

/** Assign this string with String str.

Char16& operator[](Uint32 i);

@param str String to assign.

@return Returns the String.

String& assign(const String& str);

/// Returns the Ith character of the string (const version).

/** Assign this string with str.

const Char16 operator[](Uint32 i) const;

String& assign(const Char16* str);

/// Append the given character to the string.

/** Assign this string with first n characters of str.

String& append(const Char16& c)

@param n REVIEWERS: Insert text here.

{

@param str REVIEWERS: Insert text here.

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

return *this;

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

}

/// Append n characters from str to this string.

/** Assign this string with the plain C-String str.

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

@param str REVIEWERS: Insert text here.

String& assign(const char* str);

/// Append the characters of str to this string.

/** Assign this string with first n characters of the plain C-String str.

String& append(const String& str)

@param str REVIEWERS: Insert text here.

{

@param n REVIEWERS: Insert text here.

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

}

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

/// Append the characters of str to this string.

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

String& operator+=(const String& x)

<pre>

{

String test = "abc";

return append(x);

test.clear();

}

</pre>

void clear();

/// Append the character given by c to this string.

String& operator+=(Char16 c)

{

return append(c);

}

/// Append the character given by c to this string.

/** Reserves memory for capacity characters. Notice

String& operator+=(char c)

that this does not change the size of the string (size() returns

{

what it did before). If the capacity of the string is already

return append(Char16(c));

greater or equal to the capacity argument, this method has no

}

effect. The capacity of a String object has no bearing on its

external behavior. The capacity of a String is set only for

performance reasons.

@param capacity Defines the capacity in characters to reserve.

void reserveCapacity(Uint32 capacity);

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

/** Returns the length of the String object.

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

@return Length of the String in characters. For example,

<pre>

String s = "abcd";

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

</pre>

returns a value of 4 for the length.

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

Uint32 size() const;

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

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

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

null-terminated Char16 buffer of the String object.

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

@return Pointer to the first character of the String object. For example,

substring.

<pre>

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

String test = "abc";

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

const Char16* q = test.getChar16Data();

@return String with the defined substring.

</pre>

points to the first character in the String instance named test.

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

const Char16* getChar16Data() const;

/** Create an 8-bit representation of this String object. For example,

@return CString object that provides access to the 8-bit String

representation.

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

<pre>

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

String test = "abc";

printf("test = %s\n", (const char*)test.getCString());

NOTE: Do not do the following:

const char * p = (const char *)test.getCString();

The pointer p will be invalid. This is because

the CString object is destructed, which deletes

the heap space for p.

</pre>

Uint32 find(Char16 c) const;

CString getCString() const;

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

/** 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 the index

is outside the bounds of the String.

<pre>

String test = "abc;

Char16 c = test[1];

</pre>

Uint32 reverseFind(Char16 c) const;

Char16& operator[](Uint32 index);

/** Compare the first n characters of the two strings. Return -1 if s1

/** Returns the specified character of the String object (const version).

is lexographically less than s2. If they are equavalent return 0.

@param index Index of the character to access.

Otherwise return 1.

@return Specified character of the String object.

@exception IndexOutOfBoundsException If the index

is outside the bounds of the String.

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

const Char16 operator[](Uint32 index) const;

/** Compare the two null-terminated strings. If s1 is less than s2,

/** Append the given character to this String.

return -1; if equal return 0; otherwise, return 1.

@param c Character to append.

@return This String.

<pre>

String test = "abc";

test.append(Char16('d'));

assert(test == "abcd");

</pre>

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

String& append(const Char16& c);

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

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

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

@param str REVIEWERS: Insert text here.

@param n REVIEWERS: Insert text here.

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

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

/** Append the given String to this String.

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

@param str String to append.

@return This String.

<pre>

String test = "abc";

test.append("def");

assert(test == "abcdef");

</pre>

String& append(const String& str);

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

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

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

index. If size is PEG_NOT_FOUND, then all characters after index are

removed.

@param index Position in string to start remove.

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

which causes all characters after index to be removed.

<pre>

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);

</pre>

@exception IndexOutOfBoundsException If size is greater than

length of String plus starting index for remove.

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

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

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

@param index Specifies the index in string to start getting the

substring.

@param length Specifies the number of characters to get. If length

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

string.

@return String Specifies the Sting with the defined substring.

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

/** Find the index of the first occurrence of the character c.

If the character is not found, PEG_NOT_FOUND is returned.

@param c Char to be found in the String.

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

found.

Uint32 find(Char16 c) const;

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

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

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

If the character is not found, PEG_NOT_FOUND is returned.

This begins searching from the given index.

@param c Char to be found in the String.

@return Position of the character in the string or PEG_NOT_FOUND if 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 not

found.

Uint32 find(const String& s) const;

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

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

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

@param c Char16 character to find in String.

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

found.

Uint32 reverseFind(Char16 c) const;

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

/** Converts all characters in this string to lowercase characters.

static void toLower(char* str);

void toLower();

/** EMPTY - Represent an empty string.

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

This member is used to represent empty strings. Using this member

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

avoids an expensive construction of an empty string (e.g., String()).

@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

equivalent return 0; otherwise return 1.

static const String EMPTY;

static int compare(const String& s1, const String& s2, Uint32 n);

private:

/** Compare two null-terminated strings.

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

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

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

otherwise return 1.

static Uint32 _min(Uint32 x, Uint32 y) { return x < y ? x : y; }

NOTE: Use the comparison operators <,<= > >= to compare

String objects.

static int compare(const String& s1, const String& s2);

Array<Char16> _rep;

/** Compare two null-terminated strings but ignore case.

};

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

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

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

otherwise return 1.

inline Boolean operator==(const String& x, const String& y)

NOTE: Use the comparison operators <,<= > >= to compare

{

String objects.

return String::equal(x, y);

}

static int compareNoCase(const String& s1, const String& s2);

inline Boolean operator==(const String& x, const char* y)

/** Compare two String objects for equality.

{

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

return String::equal(x, y);

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

}

inline Boolean operator==(const char* x, const String& y)

@return true If the two strings are equal; otherwise, false. For example,

{

<pre>

return String::equal(x, y);

String s1 = "Hello World";

}

String s2 = s1;

String s3(s2);

assert(String::equal(s1, s3));

</pre>

static Boolean equal(const String& str1, const String& str2);

inline Boolean operator!=(const String& x, const String& y)

/** Compares two strings and returns true if they

{

are equal indepedent of case of the characters.

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

@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);

PEGASUS_COMMON_LINKAGE std::ostream& operator<<(

#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES

std::ostream& os,

// UTF8 specific code:

const String& x);

inline String operator+(const String& x, const String& y)

/** Assign this string with a C string that may contain UTF-8.

{

@param str The C string

return String(x).append(y);

}

String& assignUTF8(const char* str);

inline Boolean operator<(const String& x, const String& y)

/** Create an 8-bit UTF-8 representation of this String object.

{

@return CString object that provides access to the 8-bit UTF-8 String

return String::compare(x.getData(), y.getData()) < 0;

representation.

}

CString getCStringUTF8() const;

inline Boolean operator<=(const String& x, const String& y)

/** Tests whether a C string contains valid UTF-8 characters.

{

@param str The C string

return String::compare(x.getData(), y.getData()) <= 0;

}

static Boolean isUTF8(const char*);

#endif

inline Boolean operator>(const String& x, const String& y)

private:

{

return String::compare(x.getData(), y.getData()) > 0;

}

inline Boolean operator>=(const String& x, const String& y)

StringRep* _rep;

{

};

return String::compare(x.getData(), y.getData()) >= 0;

}

/** Return a version of this string whose characters have been shifted

/** String operator == tests for equality between two strings of any of the

to lower case.

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.

PEGASUS_COMMON_LINKAGE Boolean operator==(

const String& str1,

const String& str2);

/** 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.

PEGASUS_COMMON_LINKAGE Boolean operator==(const char* str1, const String& str2);

/** 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 String& str2);

/** 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>

String t1 = "abc";

String t2;

t2 = t1 + "def"

assert(t2 == "abcdef");

</pre>

PEGASUS_COMMON_LINKAGE String operator+(const String& str1, const String& str2);

/** The overload operator (<) compares String obects.

<pre>

String t1 = "def";

String t2 = "a";

assert (t2 < t1);

</pre>

@param str1 REVIEWERS: Insert description here.

@param str2 REVIEWERS: Insert description here.

PEGASUS_COMMON_LINKAGE Boolean operator<(

const String& str1,

const String& str2);

/** The overload operator (<=) compares String objects.

@param str1 REVIEWERS: Insert description here.

@param str2 REVIEWERS: Insert description here.

PEGASUS_COMMON_LINKAGE Boolean operator<=(

const String& str1,

const String& str2);

/** The overload operator (>) compares String objects.

@param str1 REVIEWERS: Insert description here.

@param str2 REVIEWERS: Insert description here.

PEGASUS_COMMON_LINKAGE Boolean operator>(

const String& str1,

const String& str2);

/** The overload operator (>=) compares String objects.

@param str1 REVIEWERS: Insert description here.

@param str2 REVIEWERS: Insert description here.

PEGASUS_COMMON_LINKAGE Boolean operator>=(

const String& str1,

const String& str2);

#ifdef PEGASUS_USE_DEPRECATED_INTERFACES

/** Compares two strings but ignores any case differences.

@param s1 REVIEWERS: Insert description here.

@param s2 REVIEWERS: Insert description here.

PEGASUS_COMMON_LINKAGE String ToLower(const String& str);

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

#endif

PEGASUS_NAMESPACE_END

#endif /* Pegasus_String_h */

Legend:

Removed from v.1.10
changed lines
	Added in v.1.80

No CVS admin address has been configured