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 __STRINGPOOLIMPLEMENTATION_H__
sl@0: #define __STRINGPOOLIMPLEMENTATION_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: #include <stringpool.h>
sl@0: #include <stringtablesupport.h>
sl@0: 
sl@0: /**
sl@0: This is an 8 bit value with every bit set except bit 5 (value
sl@0: 32). The ASCII codes of upper and lower case characters differ by
sl@0: 32.
sl@0: @internalComponent 
sl@0: */
sl@0: const TUint KCaseInsensitive = 223;
sl@0: 
sl@0: /**
sl@0: @internalComponent 
sl@0: */
sl@0: const TInt KHashModulo = 32;
sl@0: 
sl@0: /**
sl@0: Bit 0 represents if it is a table (set) or not (unset).
sl@0: Bit 1 represents case sensitivity (set) or not (unset)
sl@0: 
sl@0: For non-static table values (dynamic strings), the remaining bits 
sl@0: are interpreted as a pointer to a CStringPoolNode (which is assumed 
sl@0: to be word aligned). 
sl@0: 
sl@0: Bits 2-20 represent the table index.
sl@0: Bits 21-31 represent the table uid (that is the address of the table).
sl@0: */
sl@0: 
sl@0: /**
sl@0: Bit 1 is used in tokens to indicate case sensitivity. So mask it
sl@0: out to get the node.
sl@0: @internalComponent 
sl@0: */
sl@0: const TUint KTokenToNode = 0xfffffffd;
sl@0: 
sl@0: /**
sl@0: Determine if this id corresponds to a table.
sl@0: @internalComponent
sl@0: */
sl@0: #define IS_TABLE_ENTRY(tableId)(tableId & 0x01)
sl@0: 
sl@0: /**
sl@0: Obtain the Table Index.
sl@0: @internalComponent
sl@0: */
sl@0: #define TABLE_INDEX(val)((val & 0xffffc)>>2)
sl@0: 
sl@0: /**
sl@0: Obtain the Table UID.
sl@0: @internalComponent
sl@0: */
sl@0: #define TABLE_UID(val)(val>>20)
sl@0: 
sl@0: /**
sl@0: This is used to mark the reference count of a node so that is will not be deleted when closed
sl@0: @internalComponent
sl@0: */
sl@0: const TUint KMarkedForNoDeleted = 0xffff;
sl@0: 
sl@0: 
sl@0: 
sl@0: class RStringTokenEither;
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: struct TStringIdMap
sl@0: 	{
sl@0: 	TInt32 iSourceTableVal;
sl@0: 	TInt32 iTargetTableVal;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /**
sl@0: Internal node class
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CStringPoolNode) : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	~CStringPoolNode();
sl@0: 
sl@0:  public:
sl@0: 	HBufC8* iDes;
sl@0: 	TUint16 iRefcount;
sl@0: 	TUint8  iHash;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_CLASS(CStringPoolImplementation) : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	CStringPoolImplementation();
sl@0: 	// Destructor
sl@0: 	~CStringPoolImplementation();
sl@0: 
sl@0: 	// Constructs a string pool
sl@0: 	static CStringPoolImplementation* NewL();
sl@0: 
sl@0: 	// USed for cleaning up when a OpenTableL leaves
sl@0: 	static void CleanupHashCS(TAny* aImplementation);
sl@0: 	static void CleanupHashCI(TAny* aImplementation);
sl@0: 	static void CleanupIdMap(TAny* aImplementation);
sl@0: 	static void CleanUpHash(RPointerArray <RStringTokenEither>* aHashCleanup, CArrayFixSeg<RStringTokenEither>* hash[KHashModulo]);
sl@0: 
sl@0: 	// Adds a table to the pool. (Note this currently only works once)
sl@0: 	void AddTableL(const TStringTable& aTable);
sl@0: 	void AddCallBackL( MStringPoolCloseCallBack& aCallBack);
sl@0: 
sl@0: 
sl@0: 	// Find FirstVal given duplicate val
sl@0: 	TInt32 FindFirstValFromDuplicate(TInt32 aDuplicateVal) const;
sl@0: 
sl@0: 	// Find table index Val given first val & table UID
sl@0: 	TInt FindTableIndexFromFirstVal(TInt32 aDuplicateVal, TInt aTableUid) const;
sl@0: 
sl@0: 
sl@0: 	TInt16 TableUid(const TStringTable& aTable) const;
sl@0: 
sl@0: 	const TStringTable& TableRef(TInt32 aVal) const;
sl@0: 
sl@0: 	// Looks up a particular index in the pre-loaded tables
sl@0: 	const TDesC8& TableLookup(TInt aIndex, TInt aTableUid) const;
sl@0: 
sl@0: 	// Finds or creates a string. Increments the reference count if needed.
sl@0: 	RStringTokenEither OpenL( const TDesC8& aString, TBool aCaseInsensitive); 
sl@0: 
sl@0: 	// Closes a string (decrements the reference count and deletes if 0
sl@0: 	void Close(RStringTokenEither aString);
sl@0: 
sl@0: 	// Increments the reference count on a string
sl@0: 	void IncrementCount(RStringTokenEither aString);
sl@0: 
sl@0: 	inline RStringPool Handle();
sl@0: 
sl@0: private:	
sl@0: 
sl@0: 	// Check for any undeletable string and delete them now
sl@0: 	void DeleteUndeletableStrings(CArrayFixSeg<RStringTokenEither>* aArray[KHashModulo], TInt i);
sl@0: 
sl@0: private:
sl@0: 
sl@0: 	// Finds a string in the pool.
sl@0: 	RStringTokenEither FindDes( const TDesC8& aString, TBool aCaseInsensitive);
sl@0: 
sl@0: 	// Calculates a hash for a descriptor
sl@0: 	TUint Hash( const TDesC8& ) const;
sl@0: 
sl@0: 	static TBool CompareCS(const TDesC8& s1, const TDesC8& s2);
sl@0: 	static TBool CompareCI(const TDesC8& s1, const TDesC8& s2);
sl@0: 
sl@0:  private:
sl@0: 	// The table.
sl@0: 	CArrayFixSeg<RStringTokenEither>* iCSHashTable[KHashModulo];
sl@0: 	CArrayFixSeg<RStringTokenEither>* iCIHashTable[KHashModulo];	
sl@0: 	RPointerArray<TStringTable> iTablePtrs;	// Stores array of tables, where the index is the table UID
sl@0: 	RArray <TStringIdMap> iStringMapList;
sl@0: 	RArray <TStringIdMap> iStringMapListReverse;
sl@0: 
sl@0: 	// For rolling back when a leave occurs during CreateTableL
sl@0: 	RPointerArray <TStringIdMap> iRollbackMapList;	
sl@0: 	RPointerArray <RStringTokenEither> iRollbackHashListCS;
sl@0: 	RPointerArray <RStringTokenEither> iRollbackHashListCI;
sl@0: 	RPointerArray<MStringPoolCloseCallBack> iCallBacks;
sl@0: 	};
sl@0: 
sl@0: /** 
sl@0: An internal version of the string token class. This class can hold
sl@0: either folding or non-folding versions, and it is up to the user
sl@0: to get it right.
sl@0: @internalComponent
sl@0: */
sl@0: class RStringTokenEither : public RStringTokenBase
sl@0: 	{
sl@0:  public:
sl@0: 	inline RStringTokenEither();
sl@0: 
sl@0: 	inline RStringTokenEither(TUint32 aVal);
sl@0: 
sl@0: 	/** Comparison operator
sl@0: 		@param aVal The string to compare. */
sl@0: 	inline TBool operator==(RStringTokenEither aVal) const;
sl@0: 
sl@0: 	/** Comparison operator
sl@0: 		@param aVal The string to compare. */
sl@0: 	inline TBool operator!=(RStringTokenEither aVal) const;
sl@0: 
sl@0: 	/** Assignment operator; makes a string token from a string.
sl@0: 		@param aVal The string to copy */
sl@0: 	inline RStringTokenEither operator=(RStringBase aVal);
sl@0: 
sl@0: 	friend class RStringPool;
sl@0: 	friend class RStringEither;
sl@0: 	friend class CStringPoolImplementation;
sl@0: 	};
sl@0: 
sl@0: class RStringEither : public RStringBase
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0: 	public:
sl@0: 	RStringEither(CStringPoolImplementation* aPool, RStringTokenEither aVal);
sl@0: 	};
sl@0: 
sl@0: class StringUtils
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: 	{
sl@0:  public:
sl@0: 	static inline TBool IsTableEntry(TInt aVal);
sl@0: 	static inline TInt TableIndex(TInt aVal);
sl@0: 	static inline TInt16 TableUid(TInt aVal);
sl@0: 	static inline CStringPoolNode* NodePtr(TInt aVal);
sl@0: 	static TInt ValFromIndex(TInt aIndex, TUint16 aTableId);
sl@0: 	static TInt ValFromIndexF(TInt aIndex, TUint16 aTableId);
sl@0: 	static TInt ValFromIndex(TInt aIndex, TUint16 aTableId, TBool aCaseSensitive);
sl@0: 	
sl@0: 	static void LogIt(TRefByValue<const TDesC8> aFmt, ...);
sl@0: 	static void LogIt1(TRefByValue<const TDesC8> aFmt);
sl@0: 	};
sl@0: 
sl@0: #define _LOGGING
sl@0: 
sl@0: #if defined (_DEBUG) && defined (_LOGGING)
sl@0: 
sl@0: /**
sl@0: HTTP Logging macros
sl@0: @internalComponent
sl@0: */
sl@0: #define __LOG(C)			StringUtils::LogIt1(C);
sl@0: #define __LOG1(C, X)		StringUtils::LogIt(C, X);
sl@0: #define __LOG2(C, X, Y)		StringUtils::LogIt(C, X, Y);
sl@0: #define __LOG3(C, X, Y, Z)	StringUtils::LogIt(C, X, Y, Z);
sl@0: 
sl@0: #else
sl@0: 
sl@0: /**
sl@0: NULL macros
sl@0: @internalComponent
sl@0: */
sl@0: #define __LOG(C)			
sl@0: #define __LOG1(C, X)		
sl@0: #define __LOG2(C, X, Y)		
sl@0: #define __LOG3(C, X, Y, Z)	
sl@0: #endif // !_DEBUG
sl@0: 
sl@0: 
sl@0: inline TBool StringUtils::IsTableEntry(TInt aVal)
sl@0: 	{
sl@0: 	return IS_TABLE_ENTRY(aVal);
sl@0: 	}
sl@0: 
sl@0: inline TInt StringUtils::TableIndex(TInt aVal)
sl@0: 	{
sl@0: 	return TABLE_INDEX(aVal);
sl@0: 	}
sl@0: 
sl@0: inline TInt16 StringUtils::TableUid(TInt aVal)
sl@0: 	{
sl@0: 	return (TInt16) TABLE_UID(aVal);
sl@0: 	}
sl@0: 
sl@0: inline CStringPoolNode* StringUtils::NodePtr(TInt aVal)
sl@0: 	{
sl@0: 	return reinterpret_cast<CStringPoolNode*>(aVal & KTokenToNode);
sl@0: 	}
sl@0: 
sl@0: inline RStringEither::RStringEither(CStringPoolImplementation* aPool, 
sl@0: 							 RStringTokenEither aVal)
sl@0: 	{
sl@0: 	iPool = aPool->Handle();
sl@0: 	iVal = aVal.iVal;
sl@0: 	}
sl@0: 
sl@0: inline RStringPool CStringPoolImplementation::Handle()
sl@0: 	{
sl@0: 	RStringPool p;
sl@0: 	p.iImplementation = this;
sl@0: 	return p;
sl@0: 	}
sl@0: 
sl@0: inline RStringTokenEither::RStringTokenEither()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: inline RStringTokenEither::RStringTokenEither(TUint32 aVal)
sl@0: 	{
sl@0: 	iVal = aVal;
sl@0: 	}
sl@0: 
sl@0: inline TBool RStringTokenEither::operator==(RStringTokenEither aVal) const
sl@0: 	{
sl@0: 	return iVal == aVal.iVal;
sl@0: 	}
sl@0: 
sl@0: inline TBool RStringTokenEither::operator!=(RStringTokenEither aVal) const
sl@0: 	{
sl@0: 	return iVal != aVal.iVal;
sl@0: 	}
sl@0: 
sl@0: inline RStringTokenEither RStringTokenEither::operator=(RStringBase aVal)
sl@0: 	{
sl@0: 	RStringTokenBase b = aVal;
sl@0: 	iVal = b.iVal;
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: #endif // __STRINGPOOLIMPLEMENTATION_H__