sl@0: // Copyright (c) 2005-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 __SQLITESYMBIAN_H__
sl@0: #define __SQLITESYMBIAN_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: 
sl@0: //Forward declarations
sl@0: class RFs;
sl@0: typedef struct sqlite3 sqlite3;
sl@0: 
sl@0: TInt sqlite3SymbianLastOsError(void);
sl@0: TInt sqlite3SymbianLibInit(void);
sl@0: void sqlite3SymbianLibFinalize(void);
sl@0: RFs& sqlite3SymbianFs(void);
sl@0: 
sl@0: TInt sqlite3SymbianProfilerStart(TInt aCounterType);
sl@0: TInt sqlite3SymbianProfilerStop(TInt aCounterType);
sl@0: TInt sqlite3SymbianProfilerReset(TInt aCounterType);
sl@0: TInt sqlite3SymbianProfilerQuery(TInt aCounterType, TDes8& aResult);
sl@0: 
sl@0: /**
sl@0: The operation code for registering a free page callback.
sl@0: 
sl@0: @see TSqlFreePageCallback
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: const TInt KSqlFcntlRegisterFreePageCallback = 1000001;
sl@0: 
sl@0: /**
sl@0: This structure is used for sending a request (via TVfs::FileControl()) to the OS porting layer to
sl@0: register a free page callback - TSqlFreePageCallback::iCallback, which will be called when the number of 
sl@0: the free pages reaches or is above the threshold - TSqlFreePageCallback::iThreshold.
sl@0: 
sl@0: @see TSqlFreePageCallback
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: NONSHARABLE_STRUCT(TSqlFreePageCallback)
sl@0: 	{
sl@0: 	/**
sl@0: 	"Free page" callback type definition.
sl@0: 	*/
sl@0: 	typedef void (*TCallback)(void* aThis, TInt aFreePageCount);
sl@0: 	
sl@0: 	inline TSqlFreePageCallback();
sl@0: 	inline TSqlFreePageCallback(void* aThis, TInt aFreePageThreshold, TCallback aCallback);
sl@0: 	inline TBool IsValid() const;
sl@0: 	inline void CheckAndCallback(TInt aFreePageCount) const;
sl@0: 
sl@0: 	void*		iThis;		//"this" pointer of the object that has to be called back
sl@0: 	TInt		iThreshold;	//"free page threshold" in pages
sl@0: 	TCallback	iCallback;	//a pointer to the callback function
sl@0: 
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: Initalizes TSqlFreePageCallback data members with their default values.
sl@0: */
sl@0: inline TSqlFreePageCallback::TSqlFreePageCallback() :
sl@0: 	iThis(NULL),
sl@0: 	iThreshold(0),
sl@0: 	iCallback(NULL)
sl@0: 	{
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Initalizes TSqlFreePageCallback data members with the supplied callback values.
sl@0: 
sl@0: @param aThis		"this" pointer of the object that has to be called back,
sl@0: @param aThreshold 	"free page threshold" in pages,
sl@0: @param aCallback	a pointer to the callback function;
sl@0: */
sl@0: inline TSqlFreePageCallback::TSqlFreePageCallback(void* aThis, TInt aFreePageThreshold, TSqlFreePageCallback::TCallback aCallback) :
sl@0: 	iThis(aThis),
sl@0: 	iThreshold(aFreePageThreshold),
sl@0: 	iCallback(aCallback)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @return True if this is a valid (initialized) callback object.
sl@0: */
sl@0: inline TBool TSqlFreePageCallback::IsValid() const
sl@0: 	{
sl@0: 	return 	iThis && iThreshold >= 0 && iCallback;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Calls the callback if aFreePageCount value is above the threshold.
sl@0: 
sl@0: @param aFreePageCount Database free pages count
sl@0: */	
sl@0: inline void TSqlFreePageCallback::CheckAndCallback(TInt aFreePageCount) const
sl@0: 	{
sl@0: 	if(aFreePageCount > 0 && aFreePageCount >= iThreshold)
sl@0: 		{
sl@0: 		(*iCallback)(iThis, aFreePageCount);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: #endif//__SQLITESYMBIAN_H__