sl@0: // Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: #ifndef __STRINGPOOL_H__
sl@0: #define __STRINGPOOL_H__ 
sl@0: 
sl@0: #include <e32base.h>
sl@0: 
sl@0: 
sl@0: struct TStringTable;
sl@0: class RStringF;
sl@0: class RString;
sl@0: class RStringToken;
sl@0: class RStringTokenF;
sl@0: class MStringPoolCloseCallBack;
sl@0: class RStringBase;
sl@0: class CStringPoolImplementation;
sl@0: 
sl@0: 
sl@0: class MStringPoolCloseCallBack
sl@0: /** 
sl@0: Abstract callback interface that alerts implementors to when a string pool 
sl@0: closes.
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: 	//Implement this function to perform some operation when the string pool is being closed
sl@0: 	public:
sl@0: 	/** Called when the string pool is about to close. */
sl@0: 		virtual void StringPoolClosing()=0;
sl@0: 	};
sl@0: 
sl@0: /** The string pool handle object.  A string pool can have several
sl@0: 	distinct handles associated with it, each associated with a
sl@0: 	different pre-loaded table. The difference between them is that
sl@0: 	creating a string from an enum will interpret the enum as an
sl@0: 	offset into the relevant pre-loaded table */
sl@0: class RStringPool
sl@0: /** 
sl@0: String pool handle.
sl@0: 
sl@0: A string pool can have several distinct handles associated with it, each associated 
sl@0: with a different pre-loaded table. Creating a string from an enum value interprets 
sl@0: the value as an offset into the relevant pre-loaded table. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0:  public:
sl@0: 	inline RStringPool();
sl@0: 
sl@0: 	IMPORT_C void OpenL();
sl@0: 
sl@0: 	IMPORT_C void OpenL(const TStringTable& aTable);
sl@0: 
sl@0: 	IMPORT_C void OpenL(const TStringTable& aTable,MStringPoolCloseCallBack& aCallBack);
sl@0: 
sl@0: 	IMPORT_C void Close();
sl@0: 
sl@0: 	IMPORT_C RStringF OpenFStringL(const TDesC8& aString) const;
sl@0: 
sl@0: 	IMPORT_C RString OpenStringL(const TDesC8& aString) const;
sl@0: 
sl@0: 	IMPORT_C RString String(RStringToken aString) const;
sl@0: 
sl@0: 	IMPORT_C RString String(TInt aIndex,const TStringTable& aTable) const;	
sl@0: 
sl@0: 	IMPORT_C RStringF StringF(RStringTokenF aString) const;
sl@0: 
sl@0: 	IMPORT_C RStringF StringF(TInt aIndex,const TStringTable& aTable) const;	
sl@0: 
sl@0:  private:
sl@0: 	friend class RStringBase;
sl@0: 	friend class RString;
sl@0: 	friend class RStringF;
sl@0: 	friend class CStringPoolImplementation;
sl@0: 
sl@0: 	CStringPoolImplementation* iImplementation;
sl@0: 	};
sl@0: 
sl@0: /** A compact (4 byte) representation of a string in the string pool. This
sl@0: 	class must be turned into a RStringBase (or one of its derived classes) before you can do anything
sl@0: 	useful with it. It is only intended to be used when storing strings 
sl@0: 	in situations where space matters; normaly use RStringBase.
sl@0: 	@see RStringBase
sl@0: */
sl@0: class RStringTokenBase
sl@0: /** 
sl@0: Base class for the RStringToken and RStringTokenF string representations.
sl@0: A compact (4 byte) representation of a string in the string pool. This
sl@0: class must be turned into a RStringBase (or one of its derived classes) before you can do anything
sl@0: useful with it. It is only intended to be used when storing strings 
sl@0: in situations where space matters; normaly use RStringBase.
sl@0: @see RStringBase
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0:  public:
sl@0: 	inline RStringTokenBase();
sl@0: 
sl@0: 	inline RStringTokenBase operator=(RStringBase aVal);
sl@0: 
sl@0: 	inline TBool IsNull() const;
sl@0: 
sl@0:  protected:
sl@0: 	friend class RStringPool;
sl@0: 	friend class RStringBase;
sl@0: 	friend class RStringTokenEither;
sl@0: 	friend class CStringPoolImplementation;
sl@0: 
sl@0: 	TUint32 iVal;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class RStringToken : public RStringTokenBase
sl@0: /** 
sl@0: A compact (4 byte) representation of a string in the string pool. 
sl@0: 
sl@0: This class must be turned into a RString before you can do anything useful 
sl@0: with it. It is only intended to be used when storing strings in situations 
sl@0: where space matters. You should normally use RString. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0:  public:
sl@0: 	inline TBool operator==(RStringToken aVal) const;
sl@0: 
sl@0: 	inline TBool operator!=(RStringToken aVal) const;
sl@0: 
sl@0: 	inline RStringToken operator=(RString aVal);
sl@0: 
sl@0: 	friend class RStringPool;
sl@0: 	friend class RString;
sl@0: 	friend class CStringPoolImplementation;
sl@0: 	};
sl@0: 
sl@0: class RStringTokenF  : public RStringTokenBase
sl@0: /** 
sl@0: A compact (4 byte) representation of a RStringF string in the string pool. 
sl@0: 
sl@0: This class must be turned into a RStringF before you can do anything useful 
sl@0: with it. It is only intended to be used when storing strings in situations 
sl@0: where space matters. You should normally use RStringF. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0:  public:
sl@0: 	inline TBool operator==(RStringTokenF aVal) const;
sl@0: 
sl@0: 	inline TBool operator!=(RStringTokenF aVal) const;
sl@0: 
sl@0: 	inline RStringTokenF operator=(RStringF aVal);
sl@0: 
sl@0: 	friend class RStringPool;
sl@0: 	friend class RStringF;
sl@0: 	friend class CStringPoolImplementation;
sl@0: 	};
sl@0: 
sl@0: class RStringBase
sl@0: /** 
sl@0: Base class for classes that represent a string in a string pool. 
sl@0: 
sl@0: There are sub-classes for folded and non-folded strings. Use this class when 
sl@0: you want to receive a string, but have no intention of comparing it with anything. 
sl@0: 
sl@0: 
sl@0: @see RStringPool 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0:  public:
sl@0: 	inline RStringBase();
sl@0: 
sl@0: 	IMPORT_C void Close();
sl@0: 
sl@0: 	IMPORT_C RStringBase Copy();
sl@0: 
sl@0: 	IMPORT_C const TDesC8& DesC() const;
sl@0: 
sl@0: 	inline operator RStringTokenBase() const;
sl@0: 
sl@0: 	IMPORT_C TInt Index(const TStringTable& aTable) const;
sl@0: 
sl@0: 	IMPORT_C const TStringTable*  OriginalTableRef() const;
sl@0: 
sl@0: 	inline RStringPool Pool() const;
sl@0: 
sl@0:  protected:
sl@0: 	friend class RStringPool;
sl@0: 	friend class RStringTokenBase;
sl@0: 
sl@0: 	RStringPool iPool;
sl@0: 	TUint32 iVal;
sl@0: 	};
sl@0: 
sl@0: class RString : public RStringBase
sl@0: /** 
sl@0: A string that is stored in a string pool, with case-sensitive comparisons. 
sl@0: 
sl@0: To initialise values of this class, you need to use the operator() functions 
sl@0: on the RStringPool. 
sl@0: 
sl@0: This class performs comparisons in a non-folded (case sensitive) manner. 
sl@0: 
sl@0: @see RStringPool
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0:  public:
sl@0: 	inline RString Copy();
sl@0: 
sl@0: 	inline operator RStringToken() const;
sl@0: 
sl@0: 	inline TBool operator==(const RString& aVal) const;
sl@0: 
sl@0: 	inline TBool operator!=(const RString& aVal) const;
sl@0: 
sl@0: 	friend class RStringPool;
sl@0: 	friend class RStringToken;
sl@0: 	};
sl@0: 
sl@0: class RStringF : public RStringBase
sl@0: /** 
sl@0: A string that is stored in a string pool, with case-insensitive comparisons.
sl@0: 
sl@0: To initialise values of this class, you need to use the operator() functions 
sl@0: on the RStringPool. 
sl@0: 
sl@0: Comparisons with this class use folded (case insensitive) comparisons. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0:  public:
sl@0: 	inline RStringF Copy();
sl@0: 
sl@0: 	inline operator RStringTokenF() const;
sl@0: 
sl@0: 	inline TBool operator==(const RStringF& aVal) const;
sl@0: 
sl@0: 	inline TBool operator!=(const RStringF& aVal) const;
sl@0: 
sl@0: 	friend class RStringPool;
sl@0: 	friend class RStringTokenF;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: A pointer to a string table.
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 
sl@0: struct TStringTable
sl@0: 	{
sl@0: 	// The number of elements in the table
sl@0: 	/** The number of elements in the table. */
sl@0: 	TUint iCount;
sl@0: 	// A pointer to an array of pointers to the strings
sl@0: 	/** A pointer to an array of pointers to the strings. */
sl@0: 	const void* const * iTable;	
sl@0: 
sl@0: 	// ETrue if the table should be considered case-sensitive.
sl@0: 	/** Flag that is ETrue if the table should be considered case-sensitive, otherwise 
sl@0: 	EFalse. */
sl@0: 	TBool iCaseSensitive;
sl@0: 	};
sl@0: 
sl@0: // Include the inline functions
sl@0: #include <stringpool.inl>
sl@0: 
sl@0: #endif // __STRINGPOOL_H__
sl@0: 
sl@0: