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.15 and 1.50

version 1.15, 2001/04/11 19:53:22

version 1.50, 2002/06/01 00:56:39

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.15 2001/04/11 19:53:22 mike

// More porting

// Revision 1.14 2001/04/10 23:01:52 mike

// Added new TimeValue class and regression tests for it.

// Modified Stopwatch class to use TimeValue class.

// Revision 1.13 2001/04/10 22:42:55 karl

// Correct error in String find

// Revision 1.12 2001/04/09 20:18:47 karl

// add find substring function

// Revision 1.11 2001/04/04 20:02:27 karl

// documentation update

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

#include <iostream>

#include <fstream>

#include <cstring>

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Char16.h>

Line 96

Line 52

{

public:

/** EMPTY - Represent an empty string.

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;

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

null string

<pre>

Line 105

Line 67

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

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

~String()

~String();

{

}

/** Assign this string with x.

/** Assign this string with str.

<pre>

String t1 = "abc";

String t2 = t1;

</pre>

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

String& operator=(const String& str);

/// Assign this string with x.

/// Assign this string with Char16 str.

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

String& operator=(const Char16* str);

/// Assign this string with x.

/** Assign this string with String str

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

@param str String to assign

@return Returns the String

String& assign(const String& str);

/// Assign this string with x.

/// Assign this string with str.

String& assign(const Char16* x);

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

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

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

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

String& assign(const char* x);

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 old C-String str.

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

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

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

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

<pre>

String test = "abc";

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

</pre>

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

void clear();

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

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

/** reserve - 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. After calling reserve(),

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

capacity argument.

@param capacity defines the capacity in characters to reserve.

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

void reserve(Uint32 capacity);

/** Returns the length of the String object.

@return Length of the string in characters.

<pre>

String s = "abcd";

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

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

</pre>

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

Uint32 size() const;

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

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

string.

null-terminated string string of the String object.

@param

@return Pointer to the first character of the String object

<pre>

String t1 = "abc";

const Char16* q = t1.getData();

</pre>

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

const Char16* getData() const;

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

/** allocateCString - allocates an 8 bit representation of this String

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

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

a TruncatedCharacter exception is thrown. This exception may

characters are truncated, a TruncatedCharacter exception is thrown.

be suppressed by passing true as the noThrow argument. Extra

This exception may be suppressed by passing true as the noThrow

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

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

passing a non-zero value to the extraBytes argument.

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

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

@param extraBytes Defines the number of extra characters to be

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

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

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

are truncated

@return pointer to the new representation of the string

@exception Throws TruncatedCharacter exception if any characters are

truncated

<pre>

String test = "abc";

char* p = test.allocateCString();

...

delete [] p;

</pre>

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

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

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

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

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

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

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

TruncatedCharacter exception is thrown if any characters are truncated.

is trunctated. The TruncatedCharacter exception is thrown if any

characters are truncated.

@param str Char pointer to the string to append

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

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

any characters are truncated

@return void

@exception Throws TruncatedCharacter exception of characters are

truncated and noThrow parameter is false.

<pre>

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

String s = STR0;

const char STR1[] = "zero ";

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

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

strcpy(tmp, STR1);

s.appendToCString(tmp, 7);

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

Line 227

Line 205

void appendToCString(

char* str,

Uint32 length = Uint32(-1),

Uint32 length = PEG_NOT_FOUND,

Boolean noThrow = false) const;

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

Line 253

Line 231

s4.append(Char16(0x0000))

</pre>

String& append(const Char16& c)

String& append(const Char16& c);

{

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

return *this;

}

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

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

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

String& append(const String& str)

String& append(const String& str);

{

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

}

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

@parm String to append.

@param String to append.

@return This String

<pre>

String test = "abc";

Line 277

Line 248

assert(test == "abcdef");

</pre>

String& operator+=(const String& x)

String& operator+=(const String& str);

{

return append(x);

}

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

@param c - Single character

@param c Single character to be appended

@return String with appended character

String& operator+=(Char16 c)

String& operator+=(Char16 c);

{

return append(c);

}

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

<pre>

Line 297

Line 263

assert(t1 == "abcd");

</pre>

String& operator+=(char c)

String& operator+=(char c);

{

return append(Char16(c));

}

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

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

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

@param pos - Position in string to start remove

removed.

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

@param pos Position in string to start remove

causes all characters after pos to be removed

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

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

<pre>

String s;

s = "abc";

s.remove(0, 1);

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

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

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

s.remove(0);

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

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

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

</pre>

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

length of String plus starting position for remove.

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

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

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

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

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

substring.

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

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

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

string.

@return String with the defined substring.

<pre>

s = "abcdefg";

Line 335

Line 300

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

</pre>

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

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

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

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

If the character is not found, PEG_NOT_FOUND is returned.

@param c - Char to be found in the String

@param c Char to be found in the String

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

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

found.

Uint32 find(Char16 c) const;

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

Uint32 find(Uint32 pos, Char16 c) const;

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

This function finds one string inside another

If the matching substring is not found, -1 is returned.

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

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

@param s String object to be found in the String

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

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

found.

Uint32 find(const String& s) const;

/** Find substring

@ param - 16 bit character pointer

@ param 16 bit character pointer

@seealso find

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

found.

Uint32 find(const Char16* s) const;

/** find substring

@param char* to substring

@param s char* to substring

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

found.

Uint32 find(const char* s) const;

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

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

character first).

@param c Char16 character to find in String.

@Seealso find

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

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

found.

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

String.

Uint32 reverseFind(Char16 c) const;

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

#ifdef PEGASUS_INTERNALONLY

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

// ATTN-RK-P3-20020509: Define case-sensitivity for non-English characters

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

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

@param n - Number of characters to compare

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

void toLower();

are equavalent return 0. Otherwise return 1.

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

static void toLower(char* str);

#endif

/** Translate any occurences of fromChar to toChar.

void translate(Char16 fromChar, Char16 toChar);

/** Method for printing a string.

void print() const;

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

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

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

@param n Number of characters to compare.

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

equavalent return 0. Otherwise return 1.

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

/** Compare two null-terminated strings.

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

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

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

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

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

otherwise, return 1.

Line 393

Line 387

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

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

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

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

#ifdef PEGASUS_INTERNALONLY

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

#endif

/** Compare two String objects for equality.

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

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

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

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

@return Boolean true if the two strings are equal.

<pre>

Line 405

Line 409

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static void toLower(char* str);

/** EMPTY - Represent an empty string.

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

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

are equal indpedent of case of the characters.

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

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 const String EMPTY;

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

private:

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

Array<Char16> _rep;

};

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

types String or char*.

@return Boolean - True if the strings are equal

inline Boolean operator==(const String& 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

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

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

{

return String::equal(x, y);

}

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

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

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

{

return String::equal(x, y);

}

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

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

PEGASUS_COMMON_LINKAGE Boolean operator!=(

{

const String& str1,

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

const String& str2);

}

PEGASUS_COMMON_LINKAGE PEGASUS_STD(ostream)& operator<<(

PEGASUS_COMMON_LINKAGE std::ostream& operator<<(

PEGASUS_STD(ostream)& os,

std::ostream& os,

const String& str);

const String& x);

/** overload operator + - Concatenates String objects.

Line 482

Line 509

assert(t2 == "abcdef");

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

<pre>

Line 494

Line 518

assert (t2 < t1);

</pre>

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.

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

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

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

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

to lower case.

PEGASUS_COMMON_LINKAGE String ToLower(const String& str);

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

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

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

#ifdef PEGASUS_INTERNALONLY

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

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

representation on the fly without calling allocateCString() and

then worrying about deleting the string. The underscore before the

class name denotes that this class is internal, unsupported, undocumented,

and may be removed in future releases.

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

class _CString

{

public:

_CString(const String& str)

{

_rep = str.allocateCString();

}

_CString(const _CString& str)

{

_rep = strcpy(new char[strlen(str._rep) + 1], str._rep);

}

~_CString()

{

delete [] _rep;

}

_CString& operator=(const _CString& str)

{

if (this != &str)

_rep = strcpy(new char[strlen(str._rep) + 1], str._rep);

return *this;

}

operator const char*() const

{

return _rep;

}

const char* data() const

{

return _rep;

}

private:

char* _rep;

};

#endif

#define PEGASUS_ARRAY_T String

#include <Pegasus/Common/ArrayInter.h>

#undef PEGASUS_ARRAY_T

PEGASUS_NAMESPACE_END

#endif /* Pegasus_String_h */

Legend:

Removed from v.1.15
changed lines
	Added in v.1.50

No CVS admin address has been configured