//BEGIN_LICENSE
//
// Copyright (c) 2000 The Open Group, BMC Software, Tivoli Systems, IBM
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// 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
//BEGIN_HISTORY
//
// Author:
//
// $Log: String.h,v $
// 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 <cstring>
#include <Pegasus/Common/Config.h>
#include <Pegasus/Common/Char16.h>
#include <Pegasus/Common/Array.h>

PEGASUS_NAMESPACE_BEGIN

/**
    The Pegasus String C++ Class implements the CIM string type
*/
class PEGASUS_COMMON_LINKAGE String
{
public:

    /// Default constructor.
    String();

    /// Copy constructor.
    String(const String& x);

    /// Initialize with first n characters from x.
    String(const String& x, Uint32 n);

    /// Initialize with x.
    String(const Char16* x);

    /// Initialize with first n characters of x.
    String(const Char16* x, Uint32 n);

    /// Initialize from a plain old C-String:
    String(const char* x);

    /// Initialize from the first n characters of a plain old C-String:
    String(const char* x, Uint32 n);

    /// Release all resources.
    ~String() 
    {
    }

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

    /// Assign this string with x.
    String& operator=(const Char16* x) { assign(x); return *this; }

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

    /// Assign this string with x.
    String& assign(const Char16* x);

    /// Assign this string with first n characters of x.
    String& assign(const Char16* x, Uint32 n);

    /// Assign this string with the plain old C-String x.
    String& assign(const char* x);

    /// Assign this string with first n characters of the plain old C-String x.
    String& assign(const char* x, Uint32 n);

    /// Clear this string. After calling clear(), getLength() will return 0.
    void clear() { _rep.clear(); _rep.append('\0'); }

    /** Reserves memory for capacity characters. Notice that this does not
	change the size of the string (getSize() 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.
    */
    void reserve(Uint32 capacity) { _rep.reserve(capacity + 1); }

    /// Returns the length of the string.
    Uint32 getLength() const { return _rep.getSize() - 1; }

    /// Returns a pointer to the first character in the string string.
    const Char16* getData() const { return _rep.getData(); }

    /** Allocates 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.
    */
    char* allocateCString(Uint32 extraBytes = 0, Boolean noThrow = false) const;

    /** Append the given string to a C-string. If the length is not Uint32(-1),
	then the lesser of the the length argument and the length of this 
	string is truncated. Otherwise, the entire string is trunctated. The 
	TruncatedCharacter exception is thrown if any characters are truncated.
    */
    void appendToCString(
	char* str,
	Uint32 length = Uint32(-1),
	Boolean noThrow = false) const;

    /// Returns the Ith character of the string.
    Char16& operator[](Uint32 i);

    /// Returns the Ith character of the string (const version).
    const Char16 operator[](Uint32 i) const;

    /// Append the given character to the string.
    String& append(const Char16& c)
    {
	_rep.insert(_rep.getSize() - 1, c);
	return *this;
    }

    /// Append n characters from str to this string.
    String& append(const Char16* str, Uint32 n);

    /// Append the characters of str to this string.
    String& append(const String& str)
    {
	return append(str.getData(), str.getLength());
    }

    /// Append the characters of str to this string.
    String& operator+=(const String& x)
    {
	return append(x);
    }

    /// Append the character given by c to this string.
    String& operator+=(Char16 c)
    {
	return append(c);
    }

    /// Append the character given by c to this string.
    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.
    */
    void remove(Uint32 pos, Uint32 size = Uint32(-1));

    /** 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.
	@return String with the defined substring.
    */
    String subString(Uint32 pos, Uint32 length = Uint32(-1)) const;

    /** Find the position of the first occurence of the character c.
	If the character is not found, -1 is returned.
    */
    Uint32 find(Char16 c) const;

    /** Same as find() but start looking in reverse (last character first).
    */
    Uint32 reverseFind(Char16 c) const;

    /** Compare the first n characters of the two strings. 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 the two null-terminated strings. If s1 is less than s2,
	return -1; if equal return 0; otherwise, return 1.
    */
    static int compare(const Char16* s1, const Char16* s2);

    /// Return true if the two strins are equal.
    static Boolean equal(const String& x, const String& y);

    /// Return true if the two strins are equal.
    static Boolean equal(const String& x, const Char16* y);

    /// Return true if the two strins are equal.
    static Boolean equal(const Char16* x, const String& y);

    /// Return true if the two strins are equal.
    static Boolean equal(const String& x, const char* y);

    /// Return true if the two strins are equal.
    static Boolean equal(const char* x, const String& y);

    /// Convert the plain old C-string to lower case:
    static void toLower(char* str);

    /**
	This member is used to represent empty strings. Using this member
	avoid an expensive construction of an empty string (e.g., String()).
    */
    static const String EMPTY;

private:

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

    Array<Char16> _rep;
};

inline Boolean operator==(const String& x, const String& y)
{
    return String::equal(x, y);
}

inline Boolean operator==(const String& x, const char* y)
{
    return String::equal(x, y);
}

inline Boolean operator==(const char* x, const String& y)
{
    return String::equal(x, y);
}

inline Boolean operator!=(const String& x, const String& y)
{
    return !String::equal(x, y);
}

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

inline String operator+(const String& x, const String& y)
{
    return String(x).append(y);
}

inline Boolean operator<(const String& x, const String& y)
{
    return String::compare(x.getData(), y.getData()) < 0;
}

inline Boolean operator<=(const String& x, const String& y)
{
    return String::compare(x.getData(), y.getData()) <= 0;
}

inline Boolean operator>(const String& x, const String& y)
{
    return String::compare(x.getData(), y.getData()) > 0;
}

inline Boolean operator>=(const String& x, const String& y)
{
    return String::compare(x.getData(), y.getData()) >= 0;
}

/** Return a version of this string whose characters have been shifted
    to lower case.
*/
PEGASUS_COMMON_LINKAGE String ToLower(const String& str);


PEGASUS_NAMESPACE_END

#endif /* Pegasus_String_h */