sl@0: // Copyright (c) 2008-2010 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: // SqlSvrObjContainer.inl
sl@0: // Should not be a template class!
sl@0: // Constructs an empty container.
sl@0: // 
sl@0: //
sl@0: 
sl@0: template <class T> 
sl@0: RDbObjContainer<T>::RDbObjContainer() :
sl@0: 	iEntries(NULL),
sl@0: 	iSize(0),
sl@0: 	iFree(0)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Destroys the container and its content.
sl@0: */
sl@0: template <class T> 
sl@0: void RDbObjContainer<T>::Close()
sl@0: 	{
sl@0: 	if(iEntries)
sl@0: 		{
sl@0: 		for(/*RDbObjContainer<T>::*/TEntry* entry=iEntries;entry<(iEntries+iSize);++entry)
sl@0: 			{
sl@0: 			delete entry->iObj;
sl@0: 			}
sl@0: 		User::Free(iEntries);
sl@0: 		iEntries = NULL;
sl@0: 		}
sl@0: 	iFree = iSize = 0;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Ensures that the next attempt for adding a new object to the container won't fail because there 
sl@0: is no memory.
sl@0: (In other words - ensures that the container has at least one empty slot)
sl@0: 
sl@0: @leave KErrNoMemory, an out of memory condition has occured;
sl@0: 
sl@0: @panic SqlDb 7 In _DEBUG mode. Internal logic error.
sl@0: */
sl@0: template <class T> 
sl@0: void RDbObjContainer<T>::AllocL()
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iFree <= iSize, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	if(iFree == iSize)
sl@0: 		{
sl@0: 		if(iSize >= KMaxSize)
sl@0: 			{
sl@0: 			__SQLLEAVE(KErrNoMemory);
sl@0: 			}
sl@0: 		TInt size = iSize + RDbObjContainer<T>::KGranularity;
sl@0: 		iEntries = (TEntry*)User::ReAllocL(iEntries, size * sizeof(TEntry));
sl@0: 		iSize = size;
sl@0: 		for(TInt i=iFree;i<size;)
sl@0: 			{
sl@0: 			/*RDbObjContainer<T>::*/TEntry& entry = iEntries[i];
sl@0: 			entry.iObj = NULL;
sl@0: 			entry.iNext = ++i;
sl@0: 			}
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: The method adds "aObj" pointer to the container.
sl@0: 
sl@0: @param aObj A pointer to the object which will be stored in the container.
sl@0: 
sl@0: @return Handle, uniquely identifying the stored object
sl@0: 
sl@0: @panic SqlDb 4 In _DEBUG mode. aObj parameter is NULL.
sl@0: @panic SqlDb 7 In _DEBUG mode. Internal logic error.
sl@0: */
sl@0: template <class T> 
sl@0: TInt RDbObjContainer<T>::Add(T* aObj)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aObj != NULL, __SQLPANIC(ESqlPanicBadArgument));
sl@0: 	__ASSERT_DEBUG(iFree <= iSize, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	TInt idx = iFree;
sl@0: 	if(idx < iSize)
sl@0: 		{
sl@0: 		/*RDbObjContainer<T>::*/TEntry& entry = iEntries[idx];
sl@0: 		__ASSERT_DEBUG(!entry.iObj, __SQLPANIC(ESqlPanicInternalError));
sl@0: 		iFree = entry.iNext;
sl@0: 		__ASSERT_DEBUG(iFree <= iSize, __SQLPANIC(ESqlPanicInternalError));
sl@0: 		entry.iObj = aObj;
sl@0: 		return MakeHandle(idx);
sl@0: 		}
sl@0: 	return 0;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @param aIndex Valid container index.
sl@0: 
sl@0: @return Handle, uniquely identifying the object stored at aIndex index.
sl@0: */
sl@0: template <class T> 
sl@0: TInt RDbObjContainer<T>::MakeHandle(TInt aIndex) const
sl@0: 	{
sl@0: 	return aIndex + 1;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @param aHandle Unique object handle
sl@0: 
sl@0: @return Container index of the object, identified by aHandle parameter.
sl@0: */
sl@0: template <class T> 
sl@0: TInt RDbObjContainer<T>::MakeIndex(TInt aHandle) const
sl@0: 	{
sl@0: 	return aHandle - 1;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Removes an object from the container.
sl@0: The removed object will be destroyed.
sl@0: 
sl@0: @param aHandle Unique object handle
sl@0: 
sl@0: @panic SqlDb 7 In _DEBUG mode. Internal logic error or there is no such object in the container.
sl@0: */
sl@0: template <class T> 
sl@0: void RDbObjContainer<T>::Remove(TInt aHandle)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iFree <= iSize, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	if(aHandle > 0)	//It is a handle, sent by the client. It isn't a server's problem if the handle is <= 0.
sl@0: 		{
sl@0: 		TInt idx = MakeIndex(aHandle);
sl@0: 		if(idx < iSize)
sl@0: 			{
sl@0: 			/*RDbObjContainer<T>::*/TEntry& entry = iEntries[idx];
sl@0: 			delete entry.iObj;
sl@0: 			entry.iObj = NULL;
sl@0: 			entry.iNext = iFree;
sl@0: 			iFree = idx;
sl@0: 			}
sl@0: 		}
sl@0: 	__ASSERT_DEBUG(iFree <= iSize, __SQLPANIC(ESqlPanicInternalError));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Looks up for an object in the container.
sl@0: 
sl@0: @param aHandle Unique object handle
sl@0: 
sl@0: @return A pointer to the found object or NULL.
sl@0: */
sl@0: template <class T> 
sl@0: T* RDbObjContainer<T>::Find(TInt aHandle) const
sl@0: 	{
sl@0: 	/*RDbObjContainer<T>::*/TEntry* entry = NULL;
sl@0: 	if(aHandle > 0)	//It is a handle, sent by the client. It isn't a server's problem if the handle is <= 0.
sl@0: 		{
sl@0: 		TInt idx = MakeIndex(aHandle);
sl@0: 		if(idx < iSize)
sl@0: 			{
sl@0: 			entry = &iEntries[idx];
sl@0: 			}
sl@0: 		}
sl@0: 	return entry != NULL ? entry->iObj : NULL;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Counts the alive objects in the container
sl@0: 
sl@0: @return The object count
sl@0: */
sl@0: template <class T> 
sl@0: TInt RDbObjContainer<T>::Count() const
sl@0: 	{
sl@0: 	TInt count = 0;;
sl@0: 	const /*RDbObjContainer::*/TEntry* const base = iEntries;
sl@0: 	if(base)
sl@0: 		{
sl@0: 		for(const /*RDbObjContainer::*/TEntry* e=base+iSize;--e>=base;)
sl@0: 			{
sl@0: 			if(e->iObj)
sl@0: 				{
sl@0: 				++count;					
sl@0: 				}
sl@0: 			}
sl@0: 		}
sl@0: 	return count;
sl@0: 	}