sl@0: // Copyright (c) 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: //
sl@0: #ifndef SQLITEUTIL_H
sl@0: #define SQLITEUTIL_H
sl@0: 
sl@0: #include <e32std.h>
sl@0: 
sl@0: /**
sl@0: Panic codes - used by asserts in the OS porting layer and the file buffer.
sl@0: 
sl@0: @see KPanicCategory
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: enum TSqlitePanic
sl@0: 	{
sl@0: 	ESqliteOsPanicNullOsLayerDataPtr	= 1,
sl@0: 	ESqliteOsPanicInvalidWAmount 		= 2,
sl@0: 	ESqliteOsPanicOffset64bit 			= 3,
sl@0: 	ESqliteOsPanicInvalidOpType			=11,
sl@0: 	ESqliteOsPanicInvalidFhStr			=12,
sl@0: 	ESqliteOsPanicInvalidFhData			=13,
sl@0: 	ESqliteOsPanicInvalidArg			=14,
sl@0: 	ESqliteOsPanicInvalidRAmount 		=15,
sl@0: 	ESqliteOsPanicOsLayerDataExists		=16,
sl@0: 	ESqliteOsPanicInvalidDrive			=17,
sl@0: 	ESqliteOsPanicInvalidSectorSize		=18,
sl@0: 	ESqliteOsPanicInternalError			=19,
sl@0: 	ESqliteOsPanicNullDbFilePtr			=20,
sl@0: 	ESqliteOsPanicFastCounterFreq		=21,
sl@0: 	//
sl@0: 	EFBufPanicCapacity					=101,
sl@0: 	EFBufPanicNullBuf					=102,
sl@0: 	EFBufPanicBufLen					=103,
sl@0: 	EFBufPanicFilePos					=104,
sl@0: 	EFBufPanicFileSize					=105,
sl@0: 	EFBufPanicFileHandle				=106,
sl@0: 	EFBufPanicFsHandle					=107,
sl@0: 	EFBufPanicMsgHandle					=108,
sl@0: 	EFBufPanicMsgIndex					=109,
sl@0: 	EFBufPanicFileNameLen				=110,
sl@0: 	EFBufPanicNullThis					=111,
sl@0: 	EFBufPanicDirty						=112,
sl@0: 	EFBufPanicNextReadFilePos			=113,
sl@0: 	EFBufPanicNextReadFilePosHits		=114,
sl@0: 	EFBufPanicFileBlockSize				=115,
sl@0: 	EFBufPanicRwDataLength				=116,
sl@0: 	};
sl@0: 
sl@0: ////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: //All macros in this header will have a non-void definition only if the OST_TRACE_COMPILER_IN_USE macro
sl@0: //is defined. 
sl@0: //In order to get the traces enabled, the OST_TRACE_COMPILER_IN_USE macro has to be defined in
sl@0: //OstTraceDefinitions.h file. 
sl@0: //After that, the trace output can be redirected by defining _SQL_RDEBUG_PRINT or specific categories
sl@0: //of traces can be enabled/disabled.
sl@0: 
sl@0: //Enable _SQLITE_RDEBUG_PRINT if you want to redirect the OS porting layer and file buffer tracing output via RDebug::Print()
sl@0: //#define _SQLITE_RDEBUG_PRINT
sl@0: 
sl@0: //Enable _SQLITE_OS_TRACE_ENABLED if you get the OS porting layer traces compiled in the binary
sl@0: //#define _SQLITE_OS_TRACE_ENABLED
sl@0: 
sl@0: //Enable _SQLITE_FBUF_TRACE_ENABLED if you get the file buffer traces compiled in the binary
sl@0: //#define _SQLITE_FBUF_TRACE_ENABLED
sl@0: 
sl@0: #ifdef _DEBUG
sl@0: 	//Enable _SQLITE_PANIC_TRACE_ENABLED if you want to get more detailed output regarding panics
sl@0: 	//#define _SQLITE_PANIC_TRACE_ENABLED
sl@0: #endif
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: //Wrap every string (file name, file path, etc.) you want to trace, in a __SQLITEPRNSTR()/__SQLITEPRNSTR8() macro. 
sl@0: //There is a difference how RDebug::Print() and OstTraceExt<n>() work.
sl@0: #if defined _SQLITE_RDEBUG_PRINT
sl@0:     const TInt KSqliteMaxPrnStrLen = 512;    
sl@0:     #define __SQLITEPRNSTR(des)  &des
sl@0:     const TDesC* SqliteDes8to16Ptr(const TDesC8& aDes);
sl@0: 	#define __SQLITEPRNSTR8(des)  SqliteDes8to16Ptr(des) 
sl@0: #else
sl@0:     #define __SQLITEPRNSTR(des)  des
sl@0:     #define __SQLITEPRNSTR8(des) des
sl@0: #endif
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: /**
sl@0: Set of useful functions to print diagnostic messages on the console when a panic occurs.
sl@0: 
sl@0: @internalComponent
sl@0: */
sl@0: class TSqliteUtil
sl@0: 	{
sl@0: public:
sl@0: 	static TInt Panic(const TText* aFile, TInt aLine, TInt aPanicCode, TUint aHandle);
sl@0: 	
sl@0: private:
sl@0: 	static TPtrC FileName(const TText* aFile);
sl@0: 	
sl@0: 	};
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: #define __SQLITESTRING(str) _S(str)
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: //__SQLITEPANIC/__SQLITEPANIC2 macro is used for printing out additional information when panic occurs in SQLite OS porting layer and the file buffer:
sl@0: //source file name, line number, "this" pointer, panic category.
sl@0: #define __SQLITEPANIC(aPanicCode)      TSqliteUtil::Panic(__SQLITESTRING(__FILE__), __LINE__, aPanicCode, (TUint)this)
sl@0: #define __SQLITEPANIC2(aPanicCode)     TSqliteUtil::Panic(__SQLITESTRING(__FILE__), __LINE__, aPanicCode, 0)
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: #ifdef _SQLITE_OS_TRACE_ENABLED
sl@0:     #define SQLITE_TRACE_OS(trace)   trace
sl@0: #else
sl@0:     #define SQLITE_TRACE_OS(trace)   do {} while(0)
sl@0: #endif
sl@0: 
sl@0: #ifdef _SQLITE_FBUF_TRACE_ENABLED
sl@0:     #define SQLITE_TRACE_FBUF(trace)   trace
sl@0: #else
sl@0:     #define SQLITE_TRACE_FBUF(trace)   do {} while(0)
sl@0: #endif
sl@0: 
sl@0: ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: 
sl@0: #endif //SQLITEUTIL_H