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.49 and 1.88

version 1.49, 2002/05/09 22:29:54

version 1.88, 2005/04/11 16:49:39

Line 1

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

//%2005////////////////////////////////////////////////////////////////////////

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

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

// IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.

// EMC Corporation; VERITAS Software Corporation; The Open Group.

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

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

Line 20

Line 27

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

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

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

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

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

#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 <fstream>

#endif

#include <cstring>

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Char16.h>

#include <Pegasus/Common/Array.h>

#include <Pegasus/Common/Linkage.h>

// Locale constants

// These constants need to be defined as follows:

// lower case language; underscore; Uppercase Country

const char ENGLISH_US[] = "en_US";

PEGASUS_NAMESPACE_BEGIN

class String;

class StringRep;

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

class PEGASUS_COMMON_LINKAGE CString

{

public:

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

CString();

/** REVIEWERS: Describe method here.

@param cstr Specifies the name of the CString instance.

CString(const CString& cstr);

/** CString destructor.

~CString();

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

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

are assigned to CString.

CString& operator=(const CString& cstr);

/** REVIEWERS: Describe constructor here.

operator const char*() const;

private:

CString(char* cstr);

friend class String;

void* _rep;

};

/**

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

This class is based on the general handle/representation pattern

REVIEWERS: We need more definition here.

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.

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

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

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

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

null string. For example,

<pre>

String test;

</pre>

String();

/// Copy constructor.

/** Copy constructor.

@param str Specifies the name of the String instance.

String(const String& str);

/// Initialize with first n characters from str.

/** Initialize with first n characters from str.

@param str Specifies the name of the String instance.

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

String(const String& str, Uint32 n);

/// Initialize with str.

/** Initialize with str.

@param str Specifies the name of the String instance.

String(const Char16* str);

/// Initialize with first n characters of str.

/** Initialize with first n characters of str.

@param str Specifies the name of the String instance.

@param n Specifies the Uint32 size.

String(const Char16* str, Uint32 n);

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

/** Initialize from a plain C-String:

@param str Specifies the name of the String instance.

API supports UTF8

String(const char* str);

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

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

@param str Specifies the name of the String instance.

@param u Specifies the Uint32 size.

API supports UTF8

String(const char* str, Uint32 n);

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

/** String destructor.

~String();

/** Assign this string with str.

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

<pre>

String t1 = "abc";

String t2 = t1;

</pre>

String t2 is assigned the value of t1.

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

String instance.

String& operator=(const String& str);

/// Assign this string with Char16 str.

/** Assign this string with String str.

String& operator=(const Char16* str);

@param str String to assign.

@return Returns the String.

/** Assign this string with String str

API supports UTF8

@param str String to assign

@return Returns the String

String& assign(const String& str);

/// Assign this string with str.

/** Assign this string with str.

String& assign(const Char16* str);

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

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

@param n REVIEWERS: Insert text here.

@param str REVIEWERS: Insert text here.

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

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

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

@param str REVIEWERS: Insert text here.

API supports UTF8

String& assign(const char* str);

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

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

@param str REVIEWERS: Insert text here.

@param n REVIEWERS: Insert text here.

API supports UTF8

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

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

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

<pre>

String test = "abc";

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

test.clear();

</pre>

void clear();

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

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

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

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

<pre>

String s = "abcd";

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

</pre>

returns a value of 4 for the length.

Uint32 size() const;

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

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

null-terminated string string of the String object.

null-terminated Char16 buffer of the String object.

@return Pointer to the first character of the String object

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

<pre>

String t1 = "abc";

String test = "abc";

const Char16* q = t1.getData();

const Char16* q = test.getChar16Data();

</pre>

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

const Char16* getData() const;

const Char16* getChar16Data() const;

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

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

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

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

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

@return CString object that provides access to the UTF8 String

are truncated

representation.

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

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

...

delete [] p;

</pre>

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

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

NOTE: Do not do the following:

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

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

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

The pointer p will be invalid. This is because

is trunctated. The TruncatedCharacter exception is thrown if any

the CString object is destructed, which deletes

characters are truncated.

the heap space for p.

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

strcpy(tmp, STR1);

s.appendToCString(tmp, 7);

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

</pre>

void appendToCString(

CString getCString() const;

char* str,

Uint32 length = PEG_NOT_FOUND,

Boolean noThrow = false) const;

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

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

@exception - Throws exception "OutofBounds" if the index

@param index Index of the character to access.

is outside the length of the string.

@return Specified character of the String object.

@exception IndexOutOfBoundsException If the index

is outside the bounds of the String.

<pre>

String t1 = "abc;

String test = "abc;

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

Char16 c = test[1];

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

@return Specified character of the String object.

@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 test = "abc";

s4.append(Char16(0x0000))

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

assert(test == "abcd");

</pre>

String& append(const Char16& c);

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

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

@param str REVIEWERS: Insert text here.

@param n REVIEWERS: Insert text here.

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

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

String& append(const String& str);

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

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

<pre>

String t1 = "abc";

t1 += 'd'

assert(t1 == "abcd");

</pre>

String& operator+=(char 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 280

Line 318

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 index Specifies the index in string to start getting the

substring.

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

@param length Specifies 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.

@return String Specifies the Sting with the defined substring.

<pre>

s = "abcdefg";

s.remove(3);

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 occurrence of the character c.

If the character is not found, PEG_NOT_FOUND is returned.

@param c Char to be found in the String

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

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

Uint32 find(Uint32 pos, Char16 c) const;

If the character is not found, PEG_NOT_FOUND is returned.

This begins searching from the given index.

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

@param c Char to be found in the String.

This function finds one string inside another

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

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;

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

Uint32 find(Uint32 index, Char16 c) const;

/** find substring

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

@param s char* to substring

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 char* s) const;

Uint32 find(const String& s) const;

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

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

character first).

@param c Char16 character to find in String.

@Seealso find

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

#ifdef PEGASUS_INTERNALONLY

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

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

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

void toLower();

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

#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES

static void toLower(char* str);

/** Experimental Interface

#endif

Converts all characters in this string to uppercase characters.

/** Translate any occurences of fromChar to toChar.

void translate(Char16 fromChar, Char16 toChar);

void toUpper();

#endif

/** Method for printing a string.

void print() const;

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

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

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

equavalent return 0. Otherwise return 1.

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

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

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

otherwise, return 1.

otherwise return 1.

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

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

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

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

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

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

otherwise return 1.

#ifdef PEGASUS_INTERNALONLY

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

String objects.

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 s2 Second <TT>String</TT> for comparison.

@return Boolean true if the two strings are equal.

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

<pre>

String s1 = "Hello World";

String s2 = s1;

Line 410

Line 423

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

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

/** Compares two strings and returns true if they

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

are equal indepedent of case of the characters.

@param str1 First String parameter.

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

@param str2 Second String parameter.

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

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

otherwise.

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

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

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

static Boolean equal(const char* 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);

private:

Array<Char16> _rep;

StringRep* _rep;

};

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

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

types String or char*.

@return Boolean - True if the strings are equal

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

@param str1 REVIEWERS: Insert description here.

@param str2 REVIEWERS: Insert description here.

PEGASUS_COMMON_LINKAGE Boolean operator==(

const String& str1,

const String& str2);

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

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

@param str1 REVIEWERS: Insert description here.

@param str2 REVIEWERS: Insert description here.

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

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

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

@param str1 REVIEWERS: Insert description here.

@param str2 REVIEWERS: Insert description here.

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

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

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

@param str1 REVIEWERS: Insert description here.

@param str2 REVIEWERS: Insert description here.

PEGASUS_COMMON_LINKAGE Boolean operator!=(

const String& str1,

const String& str2);

/** REVIEWERS: Insert description here.

@param str REVIEWERS: Insert description here.

@param os REVIEWERS: Insert description here.

PEGASUS_COMMON_LINKAGE PEGASUS_STD(ostream)& operator<<(

PEGASUS_STD(ostream)& os,

const String& str);

/** overload operator + - Concatenates String objects.

/** This overload operator (+) concatenates String objects. For example,

<pre>

String t1 = "abc";

String t2;

Line 510

Line 485

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

/** overload operator < - Compares String obects.

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

<pre>

String t1 = "def";

String t2 = "a";

assert (t2 < t1);

</pre>

@param str1 REVIEWERS: Insert description here.

@param str2 REVIEWERS: Insert description here.

PEGASUS_COMMON_LINKAGE Boolean operator<(

const String& str1,

const String& str2);

/** overload operator <= compares String objects.

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

@param str1 REVIEWERS: Insert description here.

@param str2 REVIEWERS: Insert description here.

PEGASUS_COMMON_LINKAGE Boolean operator<=(

const String& str1,

const String& str2);

/** Overload operator > compares String objects

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

@param str1 REVIEWERS: Insert description here.

@param str2 REVIEWERS: Insert description here.

PEGASUS_COMMON_LINKAGE Boolean operator>(

const String& str1,

const String& str2);

/** overload operator >= - Compares String objects

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

@param str1 REVIEWERS: Insert description here.

@param str2 REVIEWERS: Insert description here.

PEGASUS_COMMON_LINKAGE Boolean operator>=(

const String& str1,

const String& str2);

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

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

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.

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.49
changed lines
	Added in v.1.88

No CVS admin address has been configured