// ============================================================================
//  Copyright (C) 2001-2011 by Jozef Starosczyk
//  ixen@copyhandler.com
//
//  This program is free software; you can redistribute it and/or modify
//  it under the terms of the GNU Library General Public License
//  (version 2) as published by the Free Software Foundation;
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU Library General Public
//  License along with this program; if not, write to the
//  Free Software Foundation, Inc.,
//  59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
// ============================================================================
/// @file  TString.h
/// @date  2011/06/05
/// @brief Contains declaration of TString class.
// ============================================================================
#ifndef __TSTRING_H__
#define __TSTRING_H__

#include "libchcore.h"
#include <algorithm>

BEGIN_CHCORE_NAMESPACE

class TStringArray;

// structure containing all string data
namespace details {

// class manages the internal contents of TString
class TInternalStringData
{
private:
	TInternalStringData();
	TInternalStringData(const TInternalStringData&);
	~TInternalStringData();

public:
	// memory allocation/deallocation
	static TInternalStringData* Allocate(size_t stBufferSize);
	static void Free(TInternalStringData* pStringData);

	TInternalStringData* Clone();
	TInternalStringData* CloneWithResize(size_t stNewSize);

	TInternalStringData* CloneIfShared(bool& bCloned);

	// reference counting
	void AddRef() { ++m_lRefCount; }
	bool Release() { return (--m_lRefCount == 0); }

	// retrieving/setting data
	static TInternalStringData* GetStringDataFromTextPointer(wchar_t* pszTextPointer)
	{
		if(pszTextPointer)
			return (TInternalStringData*)((BYTE*)pszTextPointer - sizeof(TInternalStringData));
		else
			return NULL;
	}

	wchar_t* GetData() { return (wchar_t*)(((BYTE*)this) + sizeof(TInternalStringData)); }
	size_t GetBufferSize() const { return m_stBufferSize; }
	size_t GetStringLength() const { return m_stStringLength; }

	void SetStringLength(size_t stLength)
	{
		BOOST_ASSERT(stLength < m_stBufferSize);
		m_stStringLength = std::min(stLength, m_stBufferSize - 1);
	}

private:
	size_t m_stBufferSize;		// allocated buffer size (only the string part - it excludes this structure; it is really the count of wchar_t's the buffer can contain)
	long m_lRefCount;
	size_t m_stStringLength;		// string GetLength without terminating null
};

}	// end of namespace details

///////////////////////////////////////////////////////////////
// TString manipulation class
/** \brief String manipulation class
 *
 *  Class allows user to manipulate TString objects (either standard ANSI char_t*
 *  based strings or UNICODE ones - wchar_t related) with simple functions and
 *  operators.
 */
class LIBCHCORE_API TString
{
public:
	static size_t npos;
	static const size_t DefaultMaxStringSize = 65536;

public:
/** \name Construction/destruction */
/*@{*/
	TString();						///< Standard constructor
	TString(const wchar_t* pszStr);	///< Constructor that takes const wchar_t* as an initial TString
	TString(const wchar_t* pszStart, const wchar_t* pszEnd, size_t stMaxStringSize = DefaultMaxStringSize);
	TString(const wchar_t* pszStart, size_t stCount);
	TString(const TString& str);	///< Standard copy constructor
	
	~TString();						///< Standard destructor
/*@}*/

/** \name Operators */
/**@{*/
	// assignment
	const TString& operator=(const TString& src);			///< Assign operator for TString objects
	TString operator+(const TString& src) const;	///< Concatenate operator for TString objects
	const TString& operator+=(const TString& src);		///< Merge operator for TString objects
	
	const TString& operator=(const wchar_t* pszSrc);			///< Assign operator from unicode strings
	TString operator+(const wchar_t* pszSrc) const;	///< Concatenate operator for unicode strings
	const TString& operator+=(const wchar_t* pszSrc);		///< Merge operator for unicode strings
	
	/// Makes case sensitive comparison to the unicode TString ( see Compare(const wchar_t* psz) )
	bool operator<(const wchar_t* psz) const { return Compare(psz) < 0; };
	/// Makes case sensitive comparison to the unicode TString ( see Compare(const wchar_t* psz) )
	bool operator<=(const wchar_t* psz) const { return Compare(psz) <= 0; };
	/// Makes case sensitive comparison to the unicode TString ( see Compare(const wchar_t* psz) )
	bool operator==(const wchar_t* psz) const { return Compare(psz) == 0; };
	/// Makes case sensitive comparison to the unicode TString ( see Compare(const wchar_t* psz) )
	bool operator>=(const wchar_t* psz) const { return Compare(psz) >= 0; };
	/// Makes case sensitive comparison to the unicode TString ( see Compare(const wchar_t* psz) )
	bool operator>(const wchar_t* psz) const { return Compare(psz) > 0; };
	/// Makes case sensitive comparison to the unicode TString ( see Compare(const wchar_t* psz) )
	bool operator!=(const wchar_t* psz) const { return Compare(psz) != 0; };
	
	/// Makes case sensitive comparison to the TString object ( see Compare(const TString& str) )
	bool operator<(const TString& str) const { return Compare(str) < 0; };
	/// Makes case sensitive comparison to the TString object ( see Compare(const TString& str) )
	bool operator<=(const TString& str) const { return Compare(str) <= 0; };
	/// Makes case sensitive comparison to the TString object ( see Compare(const TString& str) )
	bool operator==(const TString& str) const { return Compare(str) == 0; };
	/// Makes case sensitive comparison to the TString object ( see Compare(const TString& str) )
	bool operator>=(const TString& str) const { return Compare(str) >= 0; };
	/// Makes case sensitive comparison to the TString object ( see Compare(const TString& str) )
	bool operator>(const TString& str) const { return Compare(str) >= 0; };
	/// Makes case sensitive comparison to the TString object ( see Compare(const TString& str) )
	bool operator!=(const TString& str) const { return Compare(str) != 0; };
	
	// cast operators
	operator const wchar_t*() const;		///< Cast operator to wchar_t*
/**@}*/

/** \name Standard operations */
/**@{*/
	// appends the given TString to this
	void Append(const wchar_t* pszSrc);		///< Appends an unicode TString to the TString object
	void Append(const TString& src);			///< Appends a TString object to another TString object
	
	TString Left(size_t tLen) const;		///< Returns TString with the Left part of a source TString
	TString Right(size_t tLen) const;		///< Returns TString with the Right part of a source TString
	TString Mid(size_t tStart, size_t tLen = (size_t)-1) const;	///< Returns TString with the middle part of a source TString
	TString MidRange(size_t tStart, size_t stAfterEndPos) const;	///< Returns TString with the middle part of a source TString
	
	void LeftSelf(size_t tLen);	///< Makes this TString it's Left part
	void RightSelf(size_t tLen);	///< Makes this TString it's Right part
	void MidSelf(size_t tStart, size_t tLen = (size_t)-1);	///< Makes this TString it's middle part
	
	bool Delete(size_t stIndex, size_t stCount);

	void Split(const wchar_t* pszSeparators, TStringArray& rStrings) const;

	// compare operations
	int_t Compare(const wchar_t* psz) const;	///< Comparison of this TString object with a given unicode TString
	int_t Compare(const TString& str) const;	///< Comparison of this TString object with another TString object
	
	int_t CompareNoCase(const wchar_t* psz) const;	///< Comparison (case insensitive) of this TString object with a given unicode TString
	int_t CompareNoCase(const TString& str) const;	///< Comparison (case insensitive) of this TString object with another TString object

	bool StartsWith(const wchar_t* pszText) const;
	bool StartsWithNoCase(const wchar_t* pszText) const;

	bool EndsWith(const wchar_t* pszText) const;
	bool EndsWithNoCase(const wchar_t* pszText) const;

	size_t FindFirstOf(const wchar_t* pszChars, size_t stStartFromPos = 0) const;
	size_t FindLastOf(const wchar_t* pszChars) const;

	size_t Find(const wchar_t* pszText, size_t stStartPos = 0);
	void Replace(const wchar_t* pszWhat, const wchar_t* pszWithWhat);

	bool GetAt(size_t tPos, wchar_t& wch) const;						///< Gets a character at a specified position
	wchar_t GetAt(size_t tPos) const;

	wchar_t* GetBuffer(size_t tMinSize);		///< Gives user access to the unicode internal buffer
	void ReleaseBuffer();						///< Releases the buffer get from get_bufferx functions
	void ReleaseBufferSetLength(size_t tSize);
	
	size_t GetLength() const;	///< Returns the GetLength of this TString in chars

	void Clear();			///< Clear the contents of the TString object

	bool IsEmpty() const;	///< Returns true if the TString is empty
/**@}*/

protected:
	void SetString(const wchar_t* pszStr);	///< Makes a copy of a given unicode TString and store it in internal TString buffer
	void SetString(const wchar_t* pszStart, size_t stCount);

	void EnsureWritable(size_t stRequestedSize);
	
	void AddRef();
	void Release();

	size_t GetCurrentBufferSize() const;

	details::TInternalStringData* GetInternalStringData() { return details::TInternalStringData::GetStringDataFromTextPointer(m_pszStringData); }
	const details::TInternalStringData* GetInternalStringData() const { return details::TInternalStringData::GetStringDataFromTextPointer(m_pszStringData); }

protected:
	wchar_t* m_pszStringData;		///< Pointer to an underlying c string (with prepended TInternalStringData)
};

END_CHCORE_NAMESPACE

LIBCHCORE_API chcore::TString operator+(const wchar_t* pszString, const chcore::TString& str);

#endif