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.9 and 1.74

version 1.9, 2001/02/26 04:33:28

version 1.74, 2003/03/12 21:02:53

Line 1

//BEGIN_LICENSE

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

// The Open Group, Tivoli Systems

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

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

//END_LICENSE

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

//BEGIN_HISTORY

// Author:

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

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

// $Log$

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

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

PEGASUS_NAMESPACE_BEGIN

class String;

class StringRep;

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

class PEGASUS_COMMON_LINKAGE CString

{

public:

///

CString();

///

CString(const CString& cstr);

///

~CString();

///

CString& operator=(const CString& cstr);

operator const char*() const;

private:

CString(char* cstr);

friend class String;

void* _rep;

};

/**

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

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

class PEGASUS_COMMON_LINKAGE String

{

public:

/// Default constructor.

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

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

static const String EMPTY;

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

null string.

<pre>

String test;

</pre>

String();

/// Copy constructor.

String(const String& x);

String(const String& str);

/// Initialize with first n characters from x.

/// Initialize with first n characters from str.

String(const String& x, Uint32 n);

String(const String& str, Uint32 n);

/// Initialize with x.

/// Initialize with str.

String(const Char16* x);

String(const Char16* str);

/// Initialize with first n characters of x.

/// Initialize with first n characters of str.

String(const Char16* x, Uint32 n);

String(const Char16* str, Uint32 n);

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

String(const char* x);

String(const char* str);

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

String(const char* x, Uint32 n);

String(const char* str, Uint32 n);

/// Release all resources.

/// Destructor.

~String()

~String();

{

}

/// Assign this string with x.

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

/// Assign this string with x.

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

/// Assign this string with x.

/** Assign this string with str.

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

<pre>

String t1 = "abc";

String t2 = t1;

</pre>

String& operator=(const String& str);

/// Assign this string with x.

/** Assign this string with String str.

String& assign(const Char16* x);

@param str String to assign.

@return Returns the String.

String& assign(const String& str);

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

/// Assign this string with str.

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

String& assign(const Char16* str);

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

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

String& assign(const char* x);

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

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

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

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

String& assign(const char* str);

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

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

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

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

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

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

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

<pre>

If the capacity of the string is already greater or equal to the

String test = "abc";

capacity argument, this method has no effect. After calling reserve(),

test.clear();

getCapicty() returns a value which is greater or equal to the

</pre>

capacity argument.

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

void clear();

/// Returns the length of the string.

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

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

/** Reserves memory for capacity characters. Notice

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

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

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

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

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

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

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

a TruncatedCharacter exception is thrown. This exception may

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

be suppressed by passing true as the noThrow argument. Extra

performance reasons.

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

@param capacity defines the capacity in characters to reserve.

passing a non-zero value to the extraBytes argument.

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

void reserveCapacity(Uint32 capacity);

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

/** Returns the length of the String object.

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

@return Length of the string in characters.

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

<pre>

TruncatedCharacter exception is thrown if any characters are truncated.

String s = "abcd";

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

</pre>

void appendToCString(

Uint32 size() const;

char* str,

Uint32 length = Uint32(-1),

Boolean noThrow = false) const;

/// Returns the Ith character of the string.

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

Char16& operator[](Uint32 i);

null-terminated Char16 buffer of the String object.

@return Pointer to the first character of the String object.

<pre>

String test = "abc";

const Char16* q = test.getChar16Data();

</pre>

const Char16* getChar16Data() const;

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

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

const Char16 operator[](Uint32 i) const;

/// Append the given character to the string.

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

String& append(const Char16& c)

representation.

{

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

return *this;

}

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

<pre>

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

String test = "abc";

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

</pre>

CString getCString() const;

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

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

String& append(const String& str)

@param index Index of the character to access.

{

@return specified character of the String object.

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

@exception IndexOutOfBoundsException if the index

}

is outside the bounds of the String.

<pre>

String test = "abc;

Char16 c = test[1];

</pre>

Char16& operator[](Uint32 index);

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

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

String& operator+=(const String& x)

@param index Index of the character to access.

{

@return specified character of the String object.

return append(x);

@exception IndexOutOfBoundsException if the index

}

is outside the bounds of the String.

const Char16 operator[](Uint32 index) const;

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

/** Append the given character to this String.

String& operator+=(Char16 c)

@param c Character to append.

{

@return This String.

return append(c);

<pre>

}

String test = "abc";

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

assert(test == "abcd");

</pre>

String& append(const Char16& c);

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

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

String& operator+=(char c)

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

{

return append(Char16(c));

}

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

/** Append the given String to this String.

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

@param str String to append.

@return This String.

<pre>

String test = "abc";

test.append("def");

assert(test == "abcdef");

</pre>

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

String& append(const String& str);

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

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

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

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

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

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 <TT>index</TT> is the index 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 index are added to the new

string.

@return String with the defined substring.

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

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

found.

Uint32 find(Char16 c) const;

/** Same as above but starts searching from the given index.

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;

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

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

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

/** Converts all characters in this string to lower case.

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

void toLower();

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

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

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

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

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

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

/** Compare two null-terminated strings.

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

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

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

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

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

String objects.

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

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

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

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

/** Just like the compare method defined above except that

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

the compareNoCase ignores case differences.

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

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

/** Compare two String objects for equality.

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

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

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

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

@return true if the two strings are equal, false otherwise.

static void toLower(char* str);

<pre>

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

/**

/** Compares two strings and returns true if they

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

are equal indepedent of case of the characters.

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

@param str1 First String parameter.

@param str2 Second String parameter.

@return true if strings are equal independent of case, flase

otherwise.

static const String EMPTY;

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

private:

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

StringRep* _rep;

Array<Char16> _rep;

};

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

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

{

types String or char*.

return String::equal(x, y);

@return true if the strings are equal, false otherwise.

}

PEGASUS_COMMON_LINKAGE Boolean operator==(

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

const String& str1,

{

const String& str2);

return String::equal(x, y);

}

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

/** String operator ==. Test for equality between two strings.

{

return String::equal(x, y);

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

}

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

/** String operator ==. Test for equality between two strings.

{

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

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

}

PEGASUS_COMMON_LINKAGE std::ostream& operator<<(

/** String operator ==. Test for equality between two strings.

std::ostream& os,

const String& x);

PEGASUS_COMMON_LINKAGE Boolean operator!=(

const String& str1,

const String& str2);

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

///

{

PEGASUS_COMMON_LINKAGE PEGASUS_STD(ostream)& operator<<(

return String(x).append(y);

PEGASUS_STD(ostream)& os,

}

const String& str);

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

/** overload operator + - Concatenates String objects.

{

<pre>

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

String t1 = "abc";

}

String t2;

t2 = t1 + "def"

assert(t2 == "abcdef");

</pre>

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

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

/** overload operator < - Compares String obects.

{

<pre>

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

String t1 = "def";

}

String t2 = "a";

assert (t2 < t1);

</pre>

PEGASUS_COMMON_LINKAGE Boolean operator<(

const String& str1,

const String& str2);

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

/** overload operator <= compares String objects.

{

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

PEGASUS_COMMON_LINKAGE Boolean operator<=(

}

const String& str1,

const String& str2);

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

/** Overload operator > compares String objects

{

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

PEGASUS_COMMON_LINKAGE Boolean operator>(

}

const String& str1,

const String& str2);

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

/** overload operator >= - Compares String objects

to lower case.

PEGASUS_COMMON_LINKAGE String ToLower(const String& str);

PEGASUS_COMMON_LINKAGE Boolean operator>=(

const String& str1,

const String& str2);

#ifndef PEGASUS_REMOVE_DEPRECATED

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

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

#endif

PEGASUS_NAMESPACE_END

#endif /* Pegasus_String_h */

Legend:

Removed from v.1.9
changed lines
	Added in v.1.74

No CVS admin address has been configured