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.31 and 1.58

version 1.31, 2001/06/08 00:40:42

version 1.58, 2002/08/27 23:38:44

Line 1

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

// 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 SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

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

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

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

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

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

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

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

// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

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

// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

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

// DEALINGS IN THE SOFTWARE.

// ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

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

// Modified By:

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

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

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

Line 29

Line 32

#define Pegasus_String_h

#include <iostream>

#include <fstream>

#include <cstring>

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Char16.h>

#include <Pegasus/Common/Array.h>

#include <Pegasus/Common/Linkage.h>

PEGASUS_NAMESPACE_BEGIN

class StringRep;

/**

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

This class is based on the general handle/representation pattern

Line 48

Line 54

{

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 57

Line 69

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

/** Assign this string with x.

/** Assign this string with str.

<pre>

String t1 = "abc";

String t2 = t1;

</pre>

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

String& operator=(const String& str);

/// Assign this string with Char16 x.

/** Assign this string with String str

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

@param str String to assign

/** Assign this string with String x

@param x String to assign

@return Returns the String

String& assign(const String& x);

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 - Clear this string. After calling clear(), size() will return 0.

<pre>

Line 115

Line 124

void clear();

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

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

not

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

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

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

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

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

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

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

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

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

capacity argument.

performance reasons.

@param capacity defines the capacity in characters to reserve.

void reserve(Uint32 capacity);

void reserveCapacity(Uint32 capacity);

/** Returns the length of the String object.

@return Length of the string in characters.

Line 133

Line 142

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

</pre>

Uint32 size() const { return _rep.size() - 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 of the String object.

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

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

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

characters are truncated, the truncatedCharacters argument is set

to true. Extra characters may be allocated at the end of the

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

/** AallocateCString - llocates an 8 bit representation of this string. The

user is

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

a TruncatedCharacter exception is thrown. This exception may

be suppressed by passing true as the noThrow argument. Extra

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

passing a non-zero value to the extraBytes argument.

@param extraBytes Defines the number of extra characters to be

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

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

are truncated

@param truncatedCharacters Output parameter specifying whether any

characters were truncated in the conversion.

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

char* allocateCString(

Uint32 extraBytes,

Boolean& truncatedCharacters) const;

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

/** allocateCString companion that does not require an output parameter */

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

char* allocateCString(Uint32 extraBytes = 0) const;

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

trunctated. The TruncatedCharacter exception is thrown if any characters

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

are truncated.

@param index Index of the character to access

@param str Char pointer to the string to append

@exception IndexOutOfBoundsException if the index

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

is outside the bounds of the String.

@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.size() + 1];

strcpy(tmp, STR1);

s.appendToCString(tmp, 7);

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

</pre>

void appendToCString(

char* str,

Uint32 length = PEG_NOT_FOUND,

Boolean noThrow = false) const;

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

@exception - Throws exception "OutofBounds" if the index

is outside the length of the string.

<pre>

String t1 = "abc;

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

</pre>

Char16& operator[](Uint32 i);

Char16& operator[](Uint32 index);

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

@exception - Throws exception "OutofBounds" if the index

is outside the length of the string.

/** 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 operator[](Uint32 i) const;

const Char16 operator[](Uint32 index) const;

/** Append the given character to the string.

/** Append the given character to this String.

@param c Character to append.

@return This String

<pre>

String s4 = "Hello";

String t1 = "abc";

s4.append(Char16(0x0000))

t1 += Char16('d')

assert(t1 == "abcd");

</pre>

String& append(const Char16& c);

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

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

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

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

/** Append the given String to this String.

String& append(const String& str)

@param str String to append.

{

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

}

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

@param String to append.

@return This String

<pre>

String test = "abc";

test += "def";

test.append("def");

assert(test == "abcdef");

</pre>

String& operator+=(const String& x)

String& append(const String& str);

{

return append(x);

}

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

@param c Single character to be appended

@return String with appended character

String& operator+=(Char16 c)

{

return append(c);

}

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

<pre>

String t1 = "abc";

t1 += 'd'

assert(t1 == "abcd");

</pre>

String& operator+=(char c)

{

return append(Char16(c));

}

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

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

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

removed.

@param pos Position in string to start remove

@param index Position in string to start remove

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

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

which causes all characters after index to be removed

<pre>

String s;

s = "abc";

Line 278

Line 241

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

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

</pre>

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

@exception IndexOutOfBoundsException if size is greater than

length of String plus starting position for remove.

length of String plus starting index for remove.

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

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

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

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

@param <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 pos are added to the new

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

string.

@return String with the defined substring.

<pre>

Line 297

Line 260

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

</pre>

String subString(Uint32 pos, Uint32 length = PEG_NOT_FOUND) 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, 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

Line 307

Line 270

Uint32 find(Char16 c) const;

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

Uint32 find(Uint32 index, Char16 c) const;

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

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

Line 317

Line 282

Uint32 find(const String& s) const;

/** Find substring

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

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

character first).

@param c Char16 character to find in String.

Line 344

Line 294

Uint32 reverseFind(Char16 c) const;

#ifdef PEGASUS_INTERNALONLY

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

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

void toLower();

#endif

/** Translate any occurences of fromChar to toChar.

void translate(Char16 fromChar, Char16 toChar);

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

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

Line 359

Line 308

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

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

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

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

/** Compare two null-terminated strings.

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

Line 374

Line 319

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

String objects.

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

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

#ifdef PEGASUS_INTERNALONLY

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

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

#endif

/** Compare two String objects for equality.

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

Line 388

Line 339

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

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

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

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

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

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

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

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

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

static void toLower(char* str);

/** Split the given string into fields. Fields are separated by

whitespace. Fields containing whitespace must be surrounded

by quotes. This method modifies the original string (while

unescaping embedded quote characters).

static void split(const String& line, Array<String>& fields);

/** Joins fields into a single string (the reverse of the split() method.

static void join(Array<String>& fields, String& line);

/** Escape special characters in a string. This method is used by

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

join(). It escapes newlines, returns, tabs, form-feeds, and full quotes.

are equal indpedent of case of the characters.

If the string has spaces, then full quotes will be placed around it.

@param str1 First String parameter

@param in input string

@param str2 Second String parameter

@param in output string (which is appended to).

@return true if strings are equal independent of case.

@returns true if string has spaces.

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

static Boolean escape(const String& in, String& out);

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

/** EMPTY - Represent an empty string.

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

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

glob matching is used.

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

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

StringRep* _rep;

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_STD(ostream)& os,

const String& x);

const String& str);

/** overload operator + - Concatenates String objects.

Line 487

Line 427

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 499

Line 436

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

to lower case.

PEGASUS_COMMON_LINKAGE String ToLower(const String& str);

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

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

/** Get the next line from the input file.

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

PEGASUS_COMMON_LINKAGE Boolean GetLine(PEGASUS_STD(istream)& is, String& line);

#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

Line 550

Line 477

{

public:

_CString(const String& x)

_CString(const String& str)

{

_rep = x.allocateCString();

_rep = str.allocateCString();

}

_CString(const _CString& x)

{

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

}

~_CString()

Line 565

Line 487

delete [] _rep;

}

_CString& operator=(const _CString& x)

{

if (this != &x)

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

return *this;

}

operator const char*() const

{

return _rep;

}

const char* data() const

{

return _rep;

}

private:

char* _rep;

};

#endif

inline Uint32 _Length(const String& s1) { return s1.size(); }

inline Uint32 _Length(const char* s1) { return strlen(s1); }

inline Uint32 _Length(const char) { return 1; }

template<class S1, class S2>

inline String Cat(const S1& s1, const S2& s2)

{

String tmp;

tmp.reserve(_Length(s1) + _Length(s2));

tmp.append(s1);

tmp.append(s2);

return tmp;

}

template<class S1, class S2, class S3>

inline String Cat(const S1& s1, const S2& s2, const S3& s3)

{

String tmp;

tmp.reserve(_Length(s1) + _Length(s2) + _Length(s3));

tmp.append(s1);

tmp.append(s2);

tmp.append(s3);

return tmp;

}

template<class S1, class S2, class S3, class S4>

inline String Cat(const S1& s1, const S2& s2, const S3& s3, const S4& s4)

{

String tmp;

tmp.reserve(_Length(s1) + _Length(s2) + _Length(s3) + _Length(s4));

tmp.append(s1);

tmp.append(s2);

tmp.append(s3);

tmp.append(s4);

return tmp;

}

template<class S1, class S2, class S3, class S4, class S5>

inline String Cat(

const S1& s1,

const S2& s2,

const S3& s3,

const S4& s4,

const S5& s5)

{

String tmp;

tmp.reserve(_Length(s1) + _Length(s2) + _Length(s3) + _Length(s4) +

_Length(s5));

tmp.append(s1);

tmp.append(s2);

tmp.append(s3);

tmp.append(s4);

tmp.append(s5);

return tmp;

}

template<class S1, class S2, class S3, class S4, class S5, class S6>

inline String Cat(

const S1& s1,

const S2& s2,

const S3& s3,

const S4& s4,

const S5& s5,

const S6& s6)

{

String tmp;

tmp.reserve(_Length(s1) + _Length(s2) + _Length(s3) + _Length(s4) +

_Length(s5) + _Length(s6));

tmp.append(s1);

tmp.append(s2);

tmp.append(s3);

tmp.append(s4);

tmp.append(s5);

tmp.append(s6);

return tmp;

}

PEGASUS_COMMON_LINKAGE const Array<String>& EmptyStringArray();

PEGASUS_COMMON_LINKAGE Boolean Equal(const String& x, const String& y);

#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.31
changed lines
	Added in v.1.58

No CVS admin address has been configured