sl@0: // Copyright (c) 2005-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: sl@0: #ifndef __SQLASSERT_H__ sl@0: #define __SQLASSERT_H__ sl@0: sl@0: #include sl@0: #include "SqlPanic.h" //TSqlPanic sl@0: sl@0: /////////////////////////////////////////////////////////////////////////////////////////////////////////////////// sl@0: sl@0: //Enable _SQLPROFILER if you want to use the TSqlResourceProfiler functions. Do not forget the same macro declaration in os_symbian.cpp file. 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 _SQL_RDEBUG_PRINT if you want to redirect the tracing output via RDebug::Print() sl@0: //#define _SQL_RDEBUG_PRINT sl@0: sl@0: //Enable _SQL_BORDER_TRACE_ENABLED if you want to get the entry/exit traces compiled in the binary sl@0: //#define _SQL_BORDER_TRACE_ENABLED sl@0: sl@0: //Enable _SQL_INTERNALS_TRACE_ENABLED if you want to get the internal traces compiled in the binary sl@0: //#define _SQL_INTERNALS_TRACE_ENABLED sl@0: sl@0: //Enable _SQL_BUR_TRACE_ENABLED if you want to get the backup&restore traces compiled in the binary sl@0: //#define _SQL_BUR_TRACE_ENABLED sl@0: sl@0: //Enable _SQL_COMPACT_TRACE_ENABLED if you want to get the background compaction traces compiled in the binary sl@0: //#define _SQL_COMPACT_TRACE_ENABLED sl@0: sl@0: //Enable _SQL_SESSION_TRACE_ENABLED if you want to get the client and server sessions traces compiled in the binary sl@0: //#define _SQL_SESSION_TRACE_ENABLED sl@0: sl@0: //Enable _SQL_AUTHORIZER_TRACE_ENABLED if you want to trace the authorizer parameters sl@0: //#define _SQL_AUTHORIZER_TRACE_ENABLED sl@0: sl@0: //Enable _SQL_BLOB_TRACE_ENABLED if you want to trace the server side BLOB calls sl@0: //#define _SQL_BLOB_TRACE_ENABLED sl@0: sl@0: #ifdef _DEBUG sl@0: //Enable _SQL_PANIC_TRACE_ENABLED if you want to get more detailed output regarding panics sl@0: //#define _SQL_PANIC_TRACE_ENABLED sl@0: sl@0: //Enable _SQL_LEAVE_TRACE_ENABLED if you want to get more detailed output regarding leaving locations sl@0: //#define _SQL_LEAVE_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 __SQLPRNSTR()/__SQLPRNSTR8() macro. sl@0: //There is a difference how RDebug::Print() and OstTraceExt() work. sl@0: #if defined _SQL_RDEBUG_PRINT sl@0: const TInt KSqlMaxPrnStrLen = 512; sl@0: #define __SQLPRNSTR(des) &des sl@0: const TDesC* SqlDes8to16Ptr(const TDesC8& aDes, TDes& aOut); sl@0: #define __SQLPRNSTR8(des, out) SqlDes8to16Ptr(des, out) sl@0: #else sl@0: #define __SQLPRNSTR(des) des sl@0: #define __SQLPRNSTR8(des, out) des sl@0: #endif sl@0: sl@0: /////////////////////////////////////////////////////////////////////////////////////////////////////////////////// sl@0: sl@0: //Forward declarations sl@0: class RMessage2; sl@0: sl@0: /** sl@0: Set of useful functions to print diagnostic messages on the console when an error/leaving occurs. sl@0: sl@0: @internalComponent sl@0: */ sl@0: class TSqlUtil sl@0: { sl@0: friend void UtilFileNameTest(); sl@0: sl@0: public: sl@0: static void GetTimeStr(TDes& aWhere); sl@0: static TInt Panic(const TText* aFile, TInt aLine, TInt aPanicCode, TUint aHandle); sl@0: static void Leave(const TText* aFile, TInt aLine, TInt aError, TUint aHandle); sl@0: static TInt LeaveIfError(const TText* aFile, TInt aLine, TInt aError, TUint aHandle); sl@0: static void* LeaveIfNull(const TText* aFile, TInt aLine, void* aPtr, TUint aHandle); sl@0: static TInt PanicClientL(const TText* aFile, TInt aLine, const RMessage2& aMessage, 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 __SQLSTRING(str) _S(str) sl@0: sl@0: /////////////////////////////////////////////////////////////////////////////////////////////////////////////////// sl@0: sl@0: //__SQLPANIC/__SQLPANIC2 macro is used for printing out additional information when panic occurs in SQL: sl@0: //source file name, line number, "this" pointer, panic category. sl@0: #define __SQLPANIC(aPanicCode) TSqlUtil::Panic(__SQLSTRING(__FILE__), __LINE__, aPanicCode, (TUint)this) sl@0: #define __SQLPANIC2(aPanicCode) TSqlUtil::Panic(__SQLSTRING(__FILE__), __LINE__, aPanicCode, 0) sl@0: sl@0: /////////////////////////////////////////////////////////////////////////////////////////////////////////////////// sl@0: sl@0: //This macro should be used to leave with "err" error code. sl@0: //In debug mode prints the file name and the line number where the leaving occurs and then leaves. sl@0: //In release mode only leaves. sl@0: #define __SQLLEAVE(err) TSqlUtil::Leave(__SQLSTRING(__FILE__), __LINE__, err, (TUint)this) sl@0: #define __SQLLEAVE2(err) TSqlUtil::Leave(__SQLSTRING(__FILE__), __LINE__, err, 0) sl@0: sl@0: //This macro should be used to leave with "err" error code, if the error code is negative. sl@0: //In debug mode prints the file name and the line number where the leaving occurs and then leaves. sl@0: //In release mode only leaves. sl@0: #define __SQLLEAVE_IF_ERROR(err) TSqlUtil::LeaveIfError(__SQLSTRING(__FILE__), __LINE__, err, (TUint)this) sl@0: #define __SQLLEAVE_IF_ERROR2(err) TSqlUtil::LeaveIfError(__SQLSTRING(__FILE__), __LINE__, err, 0) sl@0: sl@0: //This macro should be used to leave with KErrNoMemory if "ptr" argument is NULL. sl@0: //In debug mode prints the file name and the line number where the leaving occurs and then leaves. sl@0: //In release mode only leaves. sl@0: #define __SQLLEAVE_IF_NULL(ptr) TSqlUtil::LeaveIfNull(__SQLSTRING(__FILE__), __LINE__, ptr, (TUint)this) sl@0: sl@0: //This macro should be used to panic the client and leave if "expr" condition is not satisfied. sl@0: //In debug mode prints the file name and the line number where the leaving occurs and then sl@0: //panics the client and leaves. sl@0: //In release mode only panics the client and leaves. sl@0: #define __SQLPANIC_CLIENT(expr, msg, panicCode) (void)((expr) || TSqlUtil::PanicClientL(__SQLSTRING(__FILE__), __LINE__, msg, panicCode, (TUint)this)) sl@0: #define __SQLPANIC_CLIENT2(expr, msg, panicCode) (void)((expr) || TSqlUtil::PanicClientL(__SQLSTRING(__FILE__), __LINE__, msg, panicCode, 0)) sl@0: sl@0: //=================================================================================== sl@0: sl@0: #ifdef _SQL_BORDER_TRACE_ENABLED sl@0: #define SQL_TRACE_BORDER(trace) trace sl@0: #else sl@0: #define SQL_TRACE_BORDER(trace) do {} while(0) sl@0: #endif sl@0: sl@0: #ifdef _SQL_INTERNALS_TRACE_ENABLED sl@0: #define SQL_TRACE_INTERNALS(trace) trace sl@0: #else sl@0: #define SQL_TRACE_INTERNALS(trace) do {} while(0) sl@0: #endif sl@0: sl@0: #ifdef _SQL_BUR_TRACE_ENABLED sl@0: #define SQL_TRACE_BUR(trace) trace sl@0: #else sl@0: #define SQL_TRACE_BUR(trace) do {} while(0) sl@0: #endif sl@0: sl@0: #ifdef _SQL_COMPACT_TRACE_ENABLED sl@0: #define SQL_TRACE_COMPACT(trace) trace sl@0: #else sl@0: #define SQL_TRACE_COMPACT(trace) do {} while(0) sl@0: #endif sl@0: sl@0: #ifdef _SQL_SESSION_TRACE_ENABLED sl@0: #define SQL_TRACE_SESSION(trace) trace sl@0: #else sl@0: #define SQL_TRACE_SESSION(trace) do {} while(0) sl@0: #endif sl@0: sl@0: #ifdef _SQL_AUTHORIZER_TRACE_ENABLED sl@0: #define SQL_TRACE_AUTHORIZER(trace) trace sl@0: #else sl@0: #define SQL_TRACE_AUTHORIZER(trace) do {} while(0) sl@0: #endif sl@0: sl@0: #ifdef _SQL_BLOB_TRACE_ENABLED sl@0: #define SQL_TRACE_BLOB(trace) trace sl@0: #else sl@0: #define SQL_TRACE_BLOB(trace) do {} while(0) sl@0: #endif sl@0: sl@0: //=================================================================================== sl@0: sl@0: #endif//__SQLASSERT_H__