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.68 and 1.89.2.4

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

version 1.89.2.4, 2005/09/29 02:22:39

Line 1

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

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

// The Open Group, Tivoli Systems

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

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

#include <cstring>

#ifdef PEGASUS_OS_HPUX

# ifdef HPUX_IA64_NATIVE_COMPILER

#include <iostream>

# else

# include <iostream.h>

# endif

#else

# include <iostream>

#endif

#include <Pegasus/Common/Config.h>

#include <Pegasus/Common/Char16.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;

struct StringRep;

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

Line 48

Line 61

{

public:

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

CString();

/** REVIEWERS: Describe method here.

@param cstr Specifies the name of the CString instance to copy.

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

/** Gets a pointer to the CString's data.

@return Returns a const char pointer to the CString's data.

operator const char*() const;

private:

Line 64

Line 91

friend class String;

void* _rep;

char* _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>

@exception bad_alloc Thrown if there is insufficient memory.

String();

/// Copy constructor.

/** Copy constructor.

@param str Specifies the name of the String instance.

@exception bad_alloc Thrown if there is insufficient memory.

String(const String& str);

/// Initialize with first n characters from str.

/** Initialize with first <TT>n</TT> characters from <TT>str</TT>.

@param str Specifies the name of the String instance.

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

@exception bad_alloc Thrown if there is insufficient memory.

String(const String& str, Uint32 n);

/// Initialize with str.

/** Initialize with str.

@param str Specifies the name of the String instance.

@exception NullPointer Thrown if str is NULL.

@exception bad_alloc Thrown if there is insufficient memory.

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.

@exception NullPointer Thrown if str is NULL.

@exception bad_alloc Thrown if there is insufficient memory.

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

@exception NullPointer Thrown if str is NULL.

@exception bad_alloc Thrown if there is insufficient memory.

String(const char* str);

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

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

@param str Specifies the name of the String instance.

@param u Specifies the Uint32 size.

API supports UTF8

@exception NullPointer Thrown if str is NULL.

@exception bad_alloc Thrown if there is insufficient memory.

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.

@exception bad_alloc Thrown if there is insufficient memory.

String& operator=(const String& str);

/** Assign this string with String str

/** Assign this string with String str.

@param str String to assign

@param str String to assign.

@return Returns the String

@return Returns the String.

API supports UTF8

@exception bad_alloc Thrown if there is insufficient memory.

String& assign(const String& str);

/// Assign this string with str.

/** Assign this string with str.

@exception NullPointer Thrown if str is NULL.

@exception bad_alloc Thrown if there is insufficient memory.

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.

@exception NullPointer Thrown if str is NULL.

@exception bad_alloc Thrown if there is insufficient memory.

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

@exception NullPointer Thrown if str is NULL.

@exception bad_alloc Thrown if there is insufficient memory.

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

@exception NullPointer Thrown if str is NULL.

@exception bad_alloc Thrown if there is insufficient memory.

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

/** Reserves memory for capacity characters. Notice

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

@param capacity Defines the capacity in characters to reserve.

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;

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

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

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

<pre>

String t1 = "abc";

String test = "abc";

const Char16* q = t1.getChar16Data();

const Char16* q = test.getChar16Data();

</pre>

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

const Char16* getChar16Data() const;

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

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

@param truncatedCharacters Output parameter specifying whether any

characters were truncated in the conversion.

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

@return CString object that provides access to the UTF8 String

representation

representation.

<pre>

String test = "abc";

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

NOTE: Do not do the following:

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

The pointer p will be invalid. This is because

the CString object is destructed, which deletes

the heap space for p.

</pre>

@exception bad_alloc Thrown if there is insufficient memory.

CString getCString() const;

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

@param index Index of the character to access

@param index Index of the character to access.

@exception IndexOutOfBoundsException if the index

@return Specified character of the String object.

@exception IndexOutOfBoundsException If <TT>index</TT>

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

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

@param index Index of the character to access

@param index Index of the character to access.

@exception IndexOutOfBoundsException if the index

@return Specified character of the String object.

@exception IndexOutOfBoundsException If <TT>index</TT>

is outside the bounds of the String.

const Char16 operator[](Uint32 index) const;

/** Append the given character to this String.

@param c Character to append.

@return This String

@return This String.

<pre>

String t1 = "abc";

String test = "abc";

t1 += Char16('d')

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

assert(t1 == "abcd");

assert(test == "abcd");

</pre>

@exception bad_alloc Thrown if there is insufficient memory.

String& append(const Char16& c);

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

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

@param str REVIEWERS: Insert text here.

@param n REVIEWERS: Insert text here.

@exception NullPointer Thrown if str is NULL.

@exception bad_alloc Thrown if there is insufficient memory.

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

/** Append the given String to this String.

@param str String to append.

@return This String

@return This String.

<pre>

String test = "abc";

test.append("def");

assert(test == "abcdef");

</pre>

@exception bad_alloc Thrown if there is insufficient memory.

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

index. If size is PEG_NOT_FOUND, then all characters after

removed.

<TT>index</TT> are removed.

@param index 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

which causes all characters after index to be removed

which causes all characters after <TT>index</TT> to be removed.

<pre>

String s;

s = "abc";

Line 253

Line 343

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

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

</pre>

@exception IndexOutOfBoundsException if size is greater than

@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

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

string.

@return String with the defined substring.

@return String Specifies the Sting with the defined substring.

<pre>

@exception bad_alloc Thrown if there is insufficient memory.

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.

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

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

If the character is not found, PEG_NOT_FOUND is returned.

Searching begins from the specified index.

@param c Char to be found in the String.

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

character is not found.

Uint32 find(Uint32 index, Char16 c) const;

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

This function finds one string inside another

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

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

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

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

found.

substring is not found.

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 the

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

character is not found.

found.

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

String.

Uint32 reverseFind(Char16 c) const;

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

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

void toLower();

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

#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES

/** Experimental Interface

Converts all characters in this string to uppercase characters.

void toUpper();

#endif

/** 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 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 String& s1, const String& s2);

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

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

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

String objects.

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

Line 338

Line 439

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

Line 449

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

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

/** Compares two strings and returns true if they

are equal indpedent of case of the characters.

are equal indepedent of case of the characters.

@param str1 First String parameter

@param str1 First String parameter.

@param str2 Second String parameter

@param str2 Second String parameter.

@return true if strings are equal independent of case.

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

otherwise.

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

//// {New interfaces start here:

glob matching is used.

////

@param str String to be matched against the pattern

@param pattern Pattern to use in the match

enum ASCII7Tag { ASCII7 };

@return Boolean true if str matches pattern

The pattern definition is as follows:

String(const String& s1, const String& s2);

<pre>

* Matches any number of any characters

String(const String& s1, const char* s2);

? Match exactly one character

[chars] Match any character in chars

String(const char* s1, const String& s2);

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

</pre>

String(const char* str, ASCII7Tag tag);

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

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

String(const char* str, size_t n, ASCII7Tag tag);

<pre>

examples:

String& operator=(const char* str);

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

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

String& assignASCII7(const char* str);

</pre>

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

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

Uint32 find(const char* s) const;

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

of case.

Uint32 find(char c) const;

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

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

static Boolean equal(const String& s1, const char* s2);

ignored in the match.

@parm str String containing the string to be matched\

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

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

@return Boolean true if str matches patterh

String& append(char c);

@SeeAlso match

String& append(const char* str);

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

String& append(const char* str, Uint32 size);

static Boolean equalNoCase(const String& s1, const char* s2);

private:

void _append_char_aux();

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

////

//// }New interfaces end here:

////

private:

Uint32 _find_aux(const Char16* s, Uint32 n) const;

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 436

Line 561

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

#ifndef PEGASUS_REMOVE_DEPRECATED

////

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

//// {New functions start here.

////

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

#endif

PEGASUS_COMMON_LINKAGE Boolean operator==(const String& s1, const String& s2);

PEGASUS_COMMON_LINKAGE Boolean operator==(const String& s1, const char* s2);

PEGASUS_COMMON_LINKAGE Boolean operator==(const char* s1, const String& s2);

PEGASUS_COMMON_LINKAGE Boolean operator!=(const String& s1, const String& s2);

PEGASUS_COMMON_LINKAGE Boolean operator!=(const String& s1, const char* s2);

PEGASUS_COMMON_LINKAGE Boolean operator!=(const char* s1, const String& s2);

PEGASUS_COMMON_LINKAGE Boolean operator<(const String& s1, const String& s2);

PEGASUS_COMMON_LINKAGE Boolean operator<(const String& s1, const char* s2);

PEGASUS_COMMON_LINKAGE Boolean operator<(const char* s1, const String& s2);

PEGASUS_COMMON_LINKAGE Boolean operator>(const String& s1, const String& s2);

PEGASUS_COMMON_LINKAGE Boolean operator>(const String& s1, const char* s2);

PEGASUS_COMMON_LINKAGE Boolean operator>(const char* s1, const String& s2);

PEGASUS_COMMON_LINKAGE Boolean operator<=(const String& s1, const String& s2);

PEGASUS_COMMON_LINKAGE Boolean operator<=(const String& s1, const char* s2);

PEGASUS_COMMON_LINKAGE Boolean operator<=(const char* s1, const String& s2);

PEGASUS_COMMON_LINKAGE Boolean operator>=(const String& s1, const String& s2);

PEGASUS_COMMON_LINKAGE Boolean operator>=(const String& s1, const char* s2);

PEGASUS_COMMON_LINKAGE Boolean operator>=(const char* s1, const String& s2);

PEGASUS_COMMON_LINKAGE String operator+(const String& s1, const String& s2);

PEGASUS_COMMON_LINKAGE String operator+(const String& s1, const char* s2);

PEGASUS_COMMON_LINKAGE String operator+(const char* s1, const String& s2);

////

//// }New functions end here.

////

PEGASUS_NAMESPACE_END

#ifdef PEGASUS_INTERNALONLY

# define PEGASUS_STRING_INLINE inline

# include "StringInline.h"

# undef PEGASUS_STRING_INLINE

#endif

#endif /* Pegasus_String_h */

Legend:

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

No CVS admin address has been configured