1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/persistentdata/persistentstorage/sql/OsLayer/SqliteSymbian.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,116 @@
     1.4 +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +#ifndef __SQLITESYMBIAN_H__
    1.20 +#define __SQLITESYMBIAN_H__
    1.21 +
    1.22 +#include <e32std.h>
    1.23 +
    1.24 +//Forward declarations
    1.25 +class RFs;
    1.26 +typedef struct sqlite3 sqlite3;
    1.27 +
    1.28 +TInt sqlite3SymbianLastOsError(void);
    1.29 +TInt sqlite3SymbianLibInit(void);
    1.30 +void sqlite3SymbianLibFinalize(void);
    1.31 +RFs& sqlite3SymbianFs(void);
    1.32 +
    1.33 +TInt sqlite3SymbianProfilerStart(TInt aCounterType);
    1.34 +TInt sqlite3SymbianProfilerStop(TInt aCounterType);
    1.35 +TInt sqlite3SymbianProfilerReset(TInt aCounterType);
    1.36 +TInt sqlite3SymbianProfilerQuery(TInt aCounterType, TDes8& aResult);
    1.37 +
    1.38 +/**
    1.39 +The operation code for registering a free page callback.
    1.40 +
    1.41 +@see TSqlFreePageCallback
    1.42 +
    1.43 +@internalComponent
    1.44 +*/
    1.45 +const TInt KSqlFcntlRegisterFreePageCallback = 1000001;
    1.46 +
    1.47 +/**
    1.48 +This structure is used for sending a request (via TVfs::FileControl()) to the OS porting layer to
    1.49 +register a free page callback - TSqlFreePageCallback::iCallback, which will be called when the number of 
    1.50 +the free pages reaches or is above the threshold - TSqlFreePageCallback::iThreshold.
    1.51 +
    1.52 +@see TSqlFreePageCallback
    1.53 +
    1.54 +@internalComponent
    1.55 +*/
    1.56 +NONSHARABLE_STRUCT(TSqlFreePageCallback)
    1.57 +	{
    1.58 +	/**
    1.59 +	"Free page" callback type definition.
    1.60 +	*/
    1.61 +	typedef void (*TCallback)(void* aThis, TInt aFreePageCount);
    1.62 +	
    1.63 +	inline TSqlFreePageCallback();
    1.64 +	inline TSqlFreePageCallback(void* aThis, TInt aFreePageThreshold, TCallback aCallback);
    1.65 +	inline TBool IsValid() const;
    1.66 +	inline void CheckAndCallback(TInt aFreePageCount) const;
    1.67 +
    1.68 +	void*		iThis;		//"this" pointer of the object that has to be called back
    1.69 +	TInt		iThreshold;	//"free page threshold" in pages
    1.70 +	TCallback	iCallback;	//a pointer to the callback function
    1.71 +
    1.72 +	};
    1.73 +
    1.74 +/**
    1.75 +Initalizes TSqlFreePageCallback data members with their default values.
    1.76 +*/
    1.77 +inline TSqlFreePageCallback::TSqlFreePageCallback() :
    1.78 +	iThis(NULL),
    1.79 +	iThreshold(0),
    1.80 +	iCallback(NULL)
    1.81 +	{
    1.82 +	}
    1.83 +	
    1.84 +/**
    1.85 +Initalizes TSqlFreePageCallback data members with the supplied callback values.
    1.86 +
    1.87 +@param aThis		"this" pointer of the object that has to be called back,
    1.88 +@param aThreshold 	"free page threshold" in pages,
    1.89 +@param aCallback	a pointer to the callback function;
    1.90 +*/
    1.91 +inline TSqlFreePageCallback::TSqlFreePageCallback(void* aThis, TInt aFreePageThreshold, TSqlFreePageCallback::TCallback aCallback) :
    1.92 +	iThis(aThis),
    1.93 +	iThreshold(aFreePageThreshold),
    1.94 +	iCallback(aCallback)
    1.95 +	{
    1.96 +	}
    1.97 +
    1.98 +/**
    1.99 +@return True if this is a valid (initialized) callback object.
   1.100 +*/
   1.101 +inline TBool TSqlFreePageCallback::IsValid() const
   1.102 +	{
   1.103 +	return 	iThis && iThreshold >= 0 && iCallback;
   1.104 +	}
   1.105 +
   1.106 +/**
   1.107 +Calls the callback if aFreePageCount value is above the threshold.
   1.108 +
   1.109 +@param aFreePageCount Database free pages count
   1.110 +*/	
   1.111 +inline void TSqlFreePageCallback::CheckAndCallback(TInt aFreePageCount) const
   1.112 +	{
   1.113 +	if(aFreePageCount > 0 && aFreePageCount >= iThreshold)
   1.114 +		{
   1.115 +		(*iCallback)(iThis, aFreePageCount);
   1.116 +		}
   1.117 +	}
   1.118 +
   1.119 +#endif//__SQLITESYMBIAN_H__