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.3 and 1.68

version 1.3, 2001/01/28 04:11:03

version 1.68, 2002/09/20 19:38:14

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

////////////////////////////////////////////////////////////////////////////////

// String.h

// Simple String type.

////////////////////////////////////////////////////////////////////////////////

String Header File - Defines the CIM String Class.

#ifndef Pegasus_String_h

#define Pegasus_String_h

#include <iostream>

#include <cstring>

#include <iostream>

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Char16.h>

#include <Pegasus/Common/Array.h>

#include <Pegasus/Common/Linkage.h>

PEGASUS_NAMESPACE_BEGIN

PEGASUS_COMMON_LINKAGE void ThrowNullPointer();

class String;

class StringRep;

PEGASUS_COMMON_LINKAGE Uint32 StrLen(const Char16* str);

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

inline Uint32 StrLen(const char* str)

class PEGASUS_COMMON_LINKAGE CString

{

if (!str)

public:

ThrowNullPointer();

CString();

CString(const CString& cstr);

~CString();

CString& operator=(const CString& cstr);

operator const char*() const;

private:

CString(char* cstr);

friend class String;

void* _rep;

};

return strlen(str);

}

/**

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

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

{

public:

/**

/** EMPTY - Represent an empty string.

String with no parameters

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

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

String();

static const String EMPTY;

/**

String something class definitions

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

null string

String(const String& x);

<pre>

/// Create a CIM string

String test;

String(const String& x, Uint32 n);

</pre>

/// Create a CIM String

String(const Char16* x);

/// Create a CIM String

String(const Char16* x, Uint32 n);

/** Create a CIM String

String(const char* x);

String();

String(const char* x, Uint32 n);

/// Copy constructor.

String(const String& str);

~String() { }

/// Initialize with first n characters from str.

/** method ATTN:

String(const String& str, Uint32 n);

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

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

/// Initialize with str.

/** method assign - ATTN:

String(const Char16* str);

/// Initialize with first n characters of str.

String(const Char16* str, Uint32 n);

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

String(const char* str);

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

String(const char* str, Uint32 n);

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

~String();

/** Assign this string with str.

<pre>

String t1 = "abc";

String t2 = t1;

</pre>

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

String& operator=(const String& str);

/** method assign - ATTN:

/** Assign this string with String str

@param str String to assign

@return Returns the String

String& assign(const Char16* x);

String& assign(const String& str);

/** method assign - ATTN:

/// Assign this string with str.

String& assign(const Char16* str);

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

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

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

String& assign(const char* str);

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

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

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

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

void clear();

/** method assign - ATTN:

/** reserveCapacity - Reserves memory for capacity characters. Notice

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

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

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

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

String& assign(const char* x);

void reserveCapacity(Uint32 capacity);

/** method assign - ATTN:

/** Returns the length of the String object.

@return Length of the string in characters.

<pre>

String s = "abcd";

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

</pre>

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

Uint32 size() const;

/** Method clear -- ATTN:

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

null-terminated Char16 buffer of the String object.

@return Pointer to the first character of the String object

<pre>

String t1 = "abc";

const Char16* q = t1.getChar16Data();

</pre>

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

const Char16* getChar16Data() const;

/** Method reserve - ATTN:

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

@param truncatedCharacters Output parameter specifying whether any

characters were truncated in the conversion.

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

representation

<pre>

String test = "abc";

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

</pre>

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

CString getCString() const;

/** Method getLength - ATTN:

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

@param index Index of the character to access

@exception IndexOutOfBoundsException if the index

is outside the bounds of the String.

<pre>

String t1 = "abc;

Char16 c = t1[1]; // character b

</pre>

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

Char16& operator[](Uint32 index);

/** Method getData - ATT

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

@param index Index of the character to access

@exception IndexOutOfBoundsException if the index

is outside the bounds of the String.

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

const Char16 operator[](Uint32 index) const;

/** Method allocateCString - Allocates an 8 bit representation of this

/** Append the given character to this String.

string. The user is responsible for freeing the result. If any characters

@param c Character to append.

are truncated, a TruncatedCharacter exception is thrown. This exception may

@return This String

be suppressed by passing true as the noThrow argument. */

<pre>

String t1 = "abc";

t1 += Char16('d')

assert(t1 == "abcd");

</pre>

String& append(const Char16& c);

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

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

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

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

/** Append the given String to this String.

length is not Uint32(-1), then the lesser of the the length argument and the

@param str String to append.

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

@return This String

trunctated. The TruncatedCharacter exception is thrown if any characters are

<pre>

truncated.

String test = "abc";

test.append("def");

assert(test == "abcdef");

</pre>

String& append(const String& str);

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

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 <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 PEG_NOT_FOUND, then all characters after index are added to the new

string.

@return String with the defined substring.

<pre>

s = "abcdefg";

s.remove(3);

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

</pre>

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

/** Find the index of the first occurence 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.

void appendToCString(

Uint32 find(Char16 c) const;

char* str,

Uint32 length = Uint32(-1),

Boolean noThrow = false) const;

Char16& operator[](Uint32 i);

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

Uint32 find(Uint32 index, Char16 c) const;

const Char16 operator[](Uint32 i) const;

/** Find the index of the first occurence of the string object.

/// method Append

This function finds one string inside another

String& append(const Char16& c)

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

{

@param s String object to be found in the String

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

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

return *this;

found.

}

/// method append

Uint32 find(const String& s) const;

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

/// method append

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

String& append(const String& str)

character first).

{

@param c Char16 character to find in String.

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

@Seealso find

}

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

/// ATTN

found.

String& operator+=(const String& x)

{

NOTE: This function is defined only for char* input, not for

return append(x);

String.

}

/// ATTN

Uint32 reverseFind(Char16 c) const;

String& operator+=(Char16 c)

{

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

return append(c);

}

void toLower();

/// ATTN

String& operator+=(char c)

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

{

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

return append(Char16(c));

@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

/// remove a string

equavalent return 0. Otherwise return 1.

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

static int compare(const String& s1, const String& 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

String objects.

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

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

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

/** Compare two String objects for equality.

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

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

@return Boolean true if the two strings are equal.

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

/** equalNoCase - Compares two strings and returuns true if they

are equal indpedent of case of the characters.

@param str1 First String parameter

@param str2 Second String parameter

@return true if strings are equal independent of case.

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

/** match matches a string against a GLOB style pattern.

Return trues if the String parameter matches the pattern. C-Shell style

glob matching is used.

@param str String to be matched against the pattern

@param pattern Pattern to use in the match

@return Boolean true if str matches pattern

The pattern definition is as follows:

<pre>

* Matches any number of any characters

? Match exactly one character

[chars] Match any character in chars

[chara-charb] Match any character in the range between chara and charb

</pre>

The literal characters *, ?, [, ] can be included in a string by

escaping them with backslash "\". Ranges of characters can be concatenated.

<pre>

examples:

Boolean result = String::match("This is a test", "*is*");

Boolean works = String::match("abcdef123", "*[0-9]");

</pre>

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

/** matchNoCase Matches a String against a GLOB style pattern independent

of case.

Returns true if the str parameter matches the pattern. C-Shell style

glob matching is used. Ignore case in all comparisons. Case is

ignored in the match.

@parm str String containing the string to be matched\

@parm pattern GLOB style patterh to use in the match.

@return Boolean true if str matches patterh

@SeeAlso match

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

/// method subString ATTN:

private:

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

/// Method find - ATTN:

StringRep* _rep;

Uint32 find(Char16 c) const;

};

/// Method compare - Compare two CIM strings - ATTN:

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

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

types String or char*.

@return Boolean - True if the strings are equal

PEGASUS_COMMON_LINKAGE Boolean operator==(

const String& str1,

const String& str2);

/// Method compare -- Compare two CIM strings

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

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

/// ATTN

static const String EMPTY;

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

private:

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

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

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

Array<Char16> _rep;

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

};

PEGASUS_COMMON_LINKAGE Boolean operator==(const String& x, const String& y);

PEGASUS_COMMON_LINKAGE Boolean operator!=(

const String& str1,

const String& str2);

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

PEGASUS_COMMON_LINKAGE PEGASUS_STD(ostream)& operator<<(

PEGASUS_STD(ostream)& os,

const String& str);

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

/** overload operator + - Concatenates String objects.

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

<pre>

{

String t1 = "abc";

return !operator==(x, y);

String t2;

}

t2 = t1 + "def"

assert(t2 == "abcdef");

</pre>

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

PEGASUS_COMMON_LINKAGE std::ostream& operator<<(std::ostream& os, const String&

/** overload operator < - Compares String obects.

x);

<pre>

String t1 = "def";

String t2 = "a";

assert (t2 < t1);

</pre>

PEGASUS_COMMON_LINKAGE Boolean operator<(

const String& str1,

const String& str2);

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

/** overload operator <= compares String objects.

{

return String(x).append(y);

}

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

{

PEGASUS_COMMON_LINKAGE Boolean operator<=(

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

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

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

#ifndef PEGASUS_REMOVE_DEPRECATED

{

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

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

}

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

#endif

PEGASUS_NAMESPACE_END

#endif /* Pegasus_String_h */

Legend:

Removed from v.1.3
changed lines
	Added in v.1.68

No CVS admin address has been configured