sl@0: // Copyright (c) 2003-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: #include <e32std.h>
sl@0: #include "StringPoolImplementation.h"
sl@0: 
sl@0: 
sl@0: 
sl@0: EXPORT_C void RStringBase::Close()
sl@0: /** Closes a string. 
sl@0: 
sl@0: You must close every string you open. In other words, every call to RStringBase::Copy(), 
sl@0: RStringPool::OpenStringL() and RStringPool::OpenFStringL() must be matched 
sl@0: by a close.
sl@0: 
sl@0: Strings created through RStringPool::String() or RStringPool::StringF() with 
sl@0: an integer argument need not be closed (but closing is harmless). 
sl@0: 
sl@0: Strings created through RStringPool::String() or RStringPool::StringF() with 
sl@0: a StringToken or StringTokenF argument must not be closed, as they're just 
sl@0: changing the external representation. */
sl@0: 	{
sl@0: 	if (iVal)
sl@0: 		//harmless for empty strings
sl@0: 		iPool.iImplementation->Close(RStringTokenEither(iVal));
sl@0: 	// invalidate the string if it's a dinamic one	otherwise do nothing
sl@0: 	if(!StringUtils::IsTableEntry(this->iVal))
sl@0: 		iVal=NULL;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C RStringBase RStringBase::Copy()
sl@0: /** Copies a string.
sl@0: 
sl@0: Both the original and the copy string must be separately closed.
sl@0: 
sl@0: @return The string base. */
sl@0: 	{
sl@0: 	if (iVal)
sl@0: 		iPool.iImplementation->IncrementCount(RStringTokenEither(iVal));
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** Returns the content of the string
sl@0:  */
sl@0: EXPORT_C const TDesC8& RStringBase::DesC() const
sl@0: /** Gets the content of the string.
sl@0: 
sl@0: @return Descriptor containing the content of the string. */
sl@0: 	{
sl@0: 	// check for empty string
sl@0: 	if (iVal == 0)
sl@0: 		return KNullDesC8();
sl@0: 	if (StringUtils::IsTableEntry(iVal))
sl@0: 		{
sl@0: 		TInt index = StringUtils::TableIndex(iVal);
sl@0: 		TInt tableUid= StringUtils::TableUid(iVal);
sl@0: 		return iPool.iImplementation->TableLookup(index, tableUid);
sl@0: 		}
sl@0: 	else
sl@0: 		return *StringUtils::NodePtr(iVal)->iDes;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C TInt RStringBase::Index(const TStringTable& aTable) const
sl@0: /** Gets the enumeration value corresponding to this string.
sl@0: 
sl@0: @param	aTable String table to look in
sl@0: @return	The string's enumeration value, or -1 if there is no such value 
sl@0: @panic	EStringTableNotFound If the table supplied is not found. This panic is raised in debug builds only, in release mode the behaviour is undefined*/
sl@0: 	{
sl@0: 	//return an error for empty strings(i.e. with iVal=0 )
sl@0: 	if(!this->iVal)
sl@0: 	   return KErrNotFound;
sl@0: 	TInt tableId=iPool.iImplementation->TableUid(aTable);
sl@0: 	__ASSERT_DEBUG(tableId!=KErrNotFound,StringPoolPanic::Panic(StringPoolPanic::EStringTableNotFound));
sl@0: 	// First check the iVal is part of the same table
sl@0: 	if (StringUtils::IsTableEntry(iVal))
sl@0: 	   {		
sl@0: 	   if (tableId==StringUtils::TableUid(iVal))
sl@0: 		   return StringUtils::TableIndex(iVal);
sl@0: 	   }		
sl@0: 	// Then check if the iVal is in the reverse duplicate list
sl@0: 	TInt index=iPool.iImplementation->FindTableIndexFromFirstVal(iVal, tableId);
sl@0: 	return index;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C const TStringTable* RStringBase::OriginalTableRef() const
sl@0: /** Gets the table (if any) that first added the current string to the pool.
sl@0: 
sl@0: Note there multiple tables can contain the same string.
sl@0: 
sl@0: @return The table or NULL if the string was created dynamically (not from 
sl@0: a table) */
sl@0: 	{
sl@0: 	if(StringUtils::IsTableEntry(iVal))
sl@0: 		return &iPool.iImplementation->TableRef(iVal);
sl@0: 	else 
sl@0: 		return NULL;
sl@0: 	}
sl@0: 	
sl@0: /** Implementation of RStringPool class*/
sl@0: 
sl@0: EXPORT_C void RStringPool::OpenL()
sl@0: /** Creates an initialised string pool with no pre-loaded string tables.
sl@0: 
sl@0: @leave KErrNoMemory Not enough memory to open the pool */
sl@0: 	{
sl@0: 	iImplementation = new (ELeave) CStringPoolImplementation;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStringPool::OpenL(const TStringTable& aTable,MStringPoolCloseCallBack& aCallBack)
sl@0: /** Creates an initialised string pool with a pre-loaded string table, and a string-pool-closing 
sl@0: callback.
sl@0: 
sl@0: @param aTable The pre-loaded string table.
sl@0: @param aCallBack Callback interface that is called when the string pool closes
sl@0: @leave KErrNoMemory Not enough memory to open the pool */
sl@0: 	{
sl@0: 	if (!iImplementation)
sl@0: 		{
sl@0: 		iImplementation = new (ELeave) CStringPoolImplementation;
sl@0: 		CleanupClosePushL(*this);
sl@0: 		iImplementation->AddTableL(aTable);
sl@0: 		iImplementation->AddCallBackL(aCallBack);
sl@0: 		CleanupStack::Pop(); //this
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		iImplementation->AddTableL(aTable);
sl@0: 		iImplementation->AddCallBackL(aCallBack);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RStringPool::OpenL(const TStringTable& aTable)
sl@0: /** Creates an initialised string pool with a pre-loaded string table.
sl@0: 
sl@0: @param aTable The pre-loaded string table.
sl@0: @leave KErrNoMemory Not enough memory to open the pool */
sl@0: 	{
sl@0: 	if (!iImplementation)
sl@0: 		{
sl@0: 		iImplementation = new (ELeave) CStringPoolImplementation;
sl@0: 		CleanupClosePushL(*this);
sl@0: 		iImplementation->AddTableL(aTable);
sl@0: 		CleanupStack::Pop(); //this
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		iImplementation->AddTableL(aTable);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C void RStringPool::Close()
sl@0: /** Closes the string pool table.
sl@0: 
sl@0: This invalidates all other handles to the table. */
sl@0: 	{
sl@0: 	delete iImplementation;
sl@0: 	iImplementation = NULL;	 
sl@0: 	}
sl@0: 
sl@0: EXPORT_C RStringF RStringPool::OpenFStringL(const TDesC8& aString) const
sl@0: /** Creates an RStringF using the current string pool.
sl@0: 
sl@0: The string is opened as case-insensitive. 
sl@0: 
sl@0: @param aString The value of the string.
sl@0: @leave KErrNoMemory Not enough memory to open the string
sl@0: @return Initialised RStringF object */
sl@0: 	{
sl@0: 	RStringTokenEither newString = iImplementation->OpenL(aString, ETrue);
sl@0: 	RStringF r;
sl@0: 	r.iPool = *this;
sl@0: 	r.iVal = newString.iVal;
sl@0: 	return r;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C RString RStringPool::OpenStringL(const TDesC8& aString) const
sl@0: /** Creates an RString using the current string pool.
sl@0: 
sl@0: The string is opened as case-sensitive. 
sl@0: 
sl@0: @param aString The value of the string.
sl@0: @leave KErrNoMemory Not enough memory to open the string
sl@0: @return Initialised RString object */
sl@0: 	{
sl@0: 	RStringTokenEither newString = iImplementation->OpenL(aString, EFalse);
sl@0: 	RString r;
sl@0: 	r.iPool = *this;
sl@0: 	r.iVal = newString.iVal;
sl@0: 	return r;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C RString RStringPool::String(RStringToken aString) const
sl@0: /** Creates an RString from the supplied RStringToken. 
sl@0: 
sl@0: @param aString The string token
sl@0: @return Initialised RString object */
sl@0: 	{
sl@0: 	RString r;
sl@0: 	r.iPool = *this;
sl@0: 	r.iVal = aString.iVal;
sl@0: 	return r;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C RString RStringPool::String(TInt aIndex,const TStringTable& aTable) const
sl@0: /** Gets a case-sensitive string specified by a string table enumeration value.
sl@0: 
sl@0: aIndex is interpreted as an offset into the handle's pre-loaded string table. 
sl@0: 
sl@0: @param	aIndex The string table enumeration value
sl@0: @param	aTable The string table from which to read the string
sl@0: @return	Initialised RString object
sl@0: @panic	EStringTableNotFound If the table supplied is not found. This panic is raised in debug builds only, in release mode the behaviour is undefined*/
sl@0: 	{	
sl@0: 	__ASSERT_DEBUG(aTable.iCaseSensitive==1,StringPoolPanic::Panic(StringPoolPanic::ECreatingStringWithWrongCase));
sl@0: 	if(aIndex <(TInt)aTable.iCount)
sl@0: 		{//the index is in valid range the index 
sl@0: 		RString r;
sl@0: 		r.iPool = *this;
sl@0: 		TInt16 tableUid = iImplementation->TableUid(aTable);
sl@0: 		__ASSERT_DEBUG(tableUid!=KErrNotFound,StringPoolPanic::Panic(StringPoolPanic::EStringTableNotFound));
sl@0: 		r.iVal = StringUtils::ValFromIndex(aIndex, tableUid);
sl@0: 		TInt originalVal;	
sl@0: 		if (KErrNotFound!=(originalVal=iImplementation->FindFirstValFromDuplicate(r.iVal)))
sl@0: 			{
sl@0: 			r.iVal=originalVal;
sl@0: 			}
sl@0: 		return r;
sl@0: 		}
sl@0: 	else // the index is out of range 
sl@0: 	return RString();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C RStringF RStringPool::StringF(RStringTokenF aString) const
sl@0: /** Creates a RStringF from the supplied RStringToken. 
sl@0: 
sl@0: @param aString The value of the string 
sl@0: @return Initialised RStringF object */
sl@0: 	{
sl@0: 	RStringF r;
sl@0: 	r.iPool = *this;
sl@0: 	r.iVal = aString.iVal;
sl@0: 	return r;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C RStringF RStringPool::StringF(TInt aIndex,const TStringTable& aTable) const
sl@0: /** Gets a case-insensitive string specified by a string table enumeration value.
sl@0: 
sl@0: Creates an RStringF from a string table enumeration value.
sl@0: 
sl@0: aIndex is interpreted as an offset into the handle's pre-loaded string table. 
sl@0: 
sl@0: @param	aIndex The string table enumeration value
sl@0: @param	aTable The string table from which to read the string
sl@0: @return	Initialised RStringF object
sl@0: @panic	EStringTableNotFound If the table supplied is not found. This panic is raised in debug builds only, in release mode the behaviour is undefined*/
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aTable.iCaseSensitive==0,StringPoolPanic::Panic(StringPoolPanic::ECreatingStringWithWrongCase));
sl@0: 	if(aIndex <(TInt)aTable.iCount)
sl@0: 		{//the index is in valid range the index 
sl@0: 		RStringF r;
sl@0: 		r.iPool = *this;
sl@0: 		TInt16 tableUid = iImplementation->TableUid(aTable);
sl@0: 		__ASSERT_DEBUG(tableUid!=KErrNotFound,StringPoolPanic::Panic(StringPoolPanic::EStringTableNotFound));
sl@0: 		r.iVal = StringUtils::ValFromIndexF(aIndex, tableUid);
sl@0: 		TInt originalVal;	
sl@0: 		if (KErrNotFound!=(originalVal=iImplementation->FindFirstValFromDuplicate(r.iVal)))
sl@0: 			{
sl@0: 			r.iVal=originalVal;
sl@0: 			}
sl@0: 		return r;
sl@0: 		}
sl@0: 	else // the index is out of range so return an empty string
sl@0: 	return RStringF();
sl@0: 	}