1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/sql/OsLayer/SqliteUtil.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,143 @@
1.4 +// Copyright (c) 2010 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 +#ifndef SQLITEUTIL_H
1.19 +#define SQLITEUTIL_H
1.20 +
1.21 +#include <e32std.h>
1.22 +
1.23 +/**
1.24 +Panic codes - used by asserts in the OS porting layer and the file buffer.
1.25 +
1.26 +@see KPanicCategory
1.27 +
1.28 +@internalComponent
1.29 +*/
1.30 +enum TSqlitePanic
1.31 + {
1.32 + ESqliteOsPanicNullOsLayerDataPtr = 1,
1.33 + ESqliteOsPanicInvalidWAmount = 2,
1.34 + ESqliteOsPanicOffset64bit = 3,
1.35 + ESqliteOsPanicInvalidOpType =11,
1.36 + ESqliteOsPanicInvalidFhStr =12,
1.37 + ESqliteOsPanicInvalidFhData =13,
1.38 + ESqliteOsPanicInvalidArg =14,
1.39 + ESqliteOsPanicInvalidRAmount =15,
1.40 + ESqliteOsPanicOsLayerDataExists =16,
1.41 + ESqliteOsPanicInvalidDrive =17,
1.42 + ESqliteOsPanicInvalidSectorSize =18,
1.43 + ESqliteOsPanicInternalError =19,
1.44 + ESqliteOsPanicNullDbFilePtr =20,
1.45 + ESqliteOsPanicFastCounterFreq =21,
1.46 + //
1.47 + EFBufPanicCapacity =101,
1.48 + EFBufPanicNullBuf =102,
1.49 + EFBufPanicBufLen =103,
1.50 + EFBufPanicFilePos =104,
1.51 + EFBufPanicFileSize =105,
1.52 + EFBufPanicFileHandle =106,
1.53 + EFBufPanicFsHandle =107,
1.54 + EFBufPanicMsgHandle =108,
1.55 + EFBufPanicMsgIndex =109,
1.56 + EFBufPanicFileNameLen =110,
1.57 + EFBufPanicNullThis =111,
1.58 + EFBufPanicDirty =112,
1.59 + EFBufPanicNextReadFilePos =113,
1.60 + EFBufPanicNextReadFilePosHits =114,
1.61 + EFBufPanicFileBlockSize =115,
1.62 + EFBufPanicRwDataLength =116,
1.63 + };
1.64 +
1.65 +////////////////////////////////////////////////////////////////////////////////////////////
1.66 +
1.67 +//All macros in this header will have a non-void definition only if the OST_TRACE_COMPILER_IN_USE macro
1.68 +//is defined.
1.69 +//In order to get the traces enabled, the OST_TRACE_COMPILER_IN_USE macro has to be defined in
1.70 +//OstTraceDefinitions.h file.
1.71 +//After that, the trace output can be redirected by defining _SQL_RDEBUG_PRINT or specific categories
1.72 +//of traces can be enabled/disabled.
1.73 +
1.74 +//Enable _SQLITE_RDEBUG_PRINT if you want to redirect the OS porting layer and file buffer tracing output via RDebug::Print()
1.75 +//#define _SQLITE_RDEBUG_PRINT
1.76 +
1.77 +//Enable _SQLITE_OS_TRACE_ENABLED if you get the OS porting layer traces compiled in the binary
1.78 +//#define _SQLITE_OS_TRACE_ENABLED
1.79 +
1.80 +//Enable _SQLITE_FBUF_TRACE_ENABLED if you get the file buffer traces compiled in the binary
1.81 +//#define _SQLITE_FBUF_TRACE_ENABLED
1.82 +
1.83 +#ifdef _DEBUG
1.84 + //Enable _SQLITE_PANIC_TRACE_ENABLED if you want to get more detailed output regarding panics
1.85 + //#define _SQLITE_PANIC_TRACE_ENABLED
1.86 +#endif
1.87 +
1.88 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.89 +
1.90 +//Wrap every string (file name, file path, etc.) you want to trace, in a __SQLITEPRNSTR()/__SQLITEPRNSTR8() macro.
1.91 +//There is a difference how RDebug::Print() and OstTraceExt<n>() work.
1.92 +#if defined _SQLITE_RDEBUG_PRINT
1.93 + const TInt KSqliteMaxPrnStrLen = 512;
1.94 + #define __SQLITEPRNSTR(des) &des
1.95 + const TDesC* SqliteDes8to16Ptr(const TDesC8& aDes);
1.96 + #define __SQLITEPRNSTR8(des) SqliteDes8to16Ptr(des)
1.97 +#else
1.98 + #define __SQLITEPRNSTR(des) des
1.99 + #define __SQLITEPRNSTR8(des) des
1.100 +#endif
1.101 +
1.102 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.103 +
1.104 +/**
1.105 +Set of useful functions to print diagnostic messages on the console when a panic occurs.
1.106 +
1.107 +@internalComponent
1.108 +*/
1.109 +class TSqliteUtil
1.110 + {
1.111 +public:
1.112 + static TInt Panic(const TText* aFile, TInt aLine, TInt aPanicCode, TUint aHandle);
1.113 +
1.114 +private:
1.115 + static TPtrC FileName(const TText* aFile);
1.116 +
1.117 + };
1.118 +
1.119 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.120 +
1.121 +#define __SQLITESTRING(str) _S(str)
1.122 +
1.123 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.124 +
1.125 +//__SQLITEPANIC/__SQLITEPANIC2 macro is used for printing out additional information when panic occurs in SQLite OS porting layer and the file buffer:
1.126 +//source file name, line number, "this" pointer, panic category.
1.127 +#define __SQLITEPANIC(aPanicCode) TSqliteUtil::Panic(__SQLITESTRING(__FILE__), __LINE__, aPanicCode, (TUint)this)
1.128 +#define __SQLITEPANIC2(aPanicCode) TSqliteUtil::Panic(__SQLITESTRING(__FILE__), __LINE__, aPanicCode, 0)
1.129 +
1.130 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.131 +
1.132 +#ifdef _SQLITE_OS_TRACE_ENABLED
1.133 + #define SQLITE_TRACE_OS(trace) trace
1.134 +#else
1.135 + #define SQLITE_TRACE_OS(trace) do {} while(0)
1.136 +#endif
1.137 +
1.138 +#ifdef _SQLITE_FBUF_TRACE_ENABLED
1.139 + #define SQLITE_TRACE_FBUF(trace) trace
1.140 +#else
1.141 + #define SQLITE_TRACE_FBUF(trace) do {} while(0)
1.142 +#endif
1.143 +
1.144 +///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
1.145 +
1.146 +#endif //SQLITEUTIL_H