alarmui/inc/pim_trace.h
changeset 0 f979ecb2b13e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/alarmui/inc/pim_trace.h	Tue Feb 02 10:12:19 2010 +0200
@@ -0,0 +1,158 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description: Debug file of AlarmUI.
+*
+*/
+
+/**
+*
+**/
+#ifndef PIM_TRACE_H
+#define PIM_TRACE_H
+
+/**
+* Define our own trap and assert macros to prevent compiler warnings.
+*/
+#ifdef _DEBUG
+    #define PIM_TRAP_ASSERT( err, _s ) \
+    { \
+        TRAP( _err, _s; ); \
+        if( _err ) RDebug::Print( _L("### alarmui assert: %d"), _err ); \
+        ASSERT( !_err ); \
+    }
+    #define PIM_TRAPD_ASSERT( _s ) \
+    { \
+        TRAPD( _err, _s; ); \
+        if( _err ) RDebug::Print( _L("### alarmui assert: %d"), _err ); \
+        ASSERT( !_err ); \
+    }
+    #define PIM_ASSERT( _s ) \
+    { \
+        const TInt _err = _s; \
+        if( _err ) RDebug::Print( _L("### alarmui assert: %d"), _err ); \
+        ASSERT( !_err ); \
+    }
+#else // urel
+    #define PIM_TRAP_ASSERT( _err, _s )   TRAP_IGNORE( _s; );
+    #define PIM_TRAPD_ASSERT( _s )  TRAP_IGNORE( _s; );
+    #define PIM_ASSERT( _s )  _s;
+#endif // _DEBUG
+
+
+/**
+* Trace.
+*/
+#ifdef _DEBUG
+    /********************************************************************************************************************/
+    //Inlude & define common data
+    #include <e32base.h>
+    #include <e32std.h>
+    #include <e32svr.h>
+
+    const TInt KMaxLogLineLength = 512;
+
+    /********************************************************************************************************************/
+
+    #if defined( TRACE_MODULE_ALMALERT ) // MACRO IN MMP FILE
+        _LIT8( KModuleName8, "AlmAlert" );
+    #elif defined( TRACE_ENTRY_AKNALARMSERVICE ) // MACRO IN MMP FILE
+        _LIT8( KModuleName8, "AlarmService" );
+    #else // default
+        _LIT8( KModuleName8, "AlarmUI" );
+    #endif
+
+    // traces
+    // [module_name]_ENTR;[thread_id];[function_name];[filename]:[line_number];
+    _LIT8( KFuncEntryFormat8, ";%S_ENTR;%d;%S;%S:%d;");
+    // [module_name]_EXIT;[thread_id];[function_name];[filename]:[line_number];
+    _LIT8( KFuncExitFormat8,  ";%S_EXIT;%d;%S;%S:%d;");
+
+    /********************************************************************************************************************/
+    NONSHARABLE_CLASS(TOverflowTruncate8) : public TDes8Overflow
+        {
+    public:
+        void Overflow(TDes8& /*aDes*/) {}
+        };
+
+    //Trace macro 8bit
+    inline void TraceDebugPrint( TRefByValue<const TDesC8> aFmt, ...)
+        {
+        VA_LIST list;
+        VA_START( list, aFmt );
+
+        TOverflowTruncate8 overflow;
+        TBuf8<KMaxLogLineLength> buf8;
+        buf8.AppendFormatList( aFmt, list, &overflow );
+        TBuf16<KMaxLogLineLength> buf16( buf8.Length() );
+        buf16.Copy( buf8 );
+        TRefByValue<const TDesC> tmpFmt( _L("%S") );
+        RDebug::Print( tmpFmt, &buf16 );
+        }
+
+    /********************************************************************************************************************/
+    //Debug print
+    #ifdef TRACE_ENTRY_EXIT_POINT // MACRO IN MMP FILE
+        #ifdef __ARMCC__
+            #define TRACE_FUNC_ENTRY_DEBUG_PRINT                                                                \
+            {                                                                                                   \
+                const TUint threadId( RThread().Id() );                                                         \
+                TPtrC8 ptr8File( (TUint8*)__MODULE__ );                                                         \
+                TPtrC8 ptr8PF( (TUint8*)__FUNCTION__ );                                                  \
+                TraceDebugPrint( KFuncEntryFormat8, &KModuleName8, threadId, &ptr8PF, &ptr8File, __LINE__ );    \
+            }
+            #define TRACE_FUNC_EXIT_DEBUG_PRINT                                                                 \
+            {                                                                                                   \
+                const TUint threadId( RThread().Id() );                                                         \
+                TPtrC8 ptr8File( (TUint8*)__MODULE__ );                                                         \
+                TPtrC8 ptr8PF( (TUint8*)__FUNCTION__ );                                                  \
+                TraceDebugPrint( KFuncExitFormat8, &KModuleName8, threadId, &ptr8PF, &ptr8File, __LINE__ );     \
+            }
+        #else // __WINS__
+            #define TRACE_FUNC_ENTRY_DEBUG_PRINT                                                                \
+            {                                                                                                   \
+                const TUint threadId( RThread().Id() );                                                         \
+                TPtrC8 ptr8File( (TUint8*)__FILE__ );                                                           \
+                TPtrC8 ptr8PF( (TUint8*)__FUNCTION__ );                                                  \
+                TraceDebugPrint( KFuncEntryFormat8, &KModuleName8, threadId, &ptr8PF, &ptr8File, __LINE__ );    \
+            }
+            #define TRACE_FUNC_EXIT_DEBUG_PRINT                                                                 \
+            {                                                                                                   \
+                const TUint threadId( RThread().Id() );                                                         \
+                TPtrC8 ptr8File( (TUint8*)__FILE__ );                                                           \
+                TPtrC8 ptr8PF( (TUint8*)__FUNCTION__ );                                                  \
+                TraceDebugPrint( KFuncExitFormat8, &KModuleName8, threadId, &ptr8PF, &ptr8File, __LINE__ );     \
+            }
+        #endif
+    #endif
+
+    /********************************************************************************************************************/
+    //Check if trace should be activated 
+    #ifdef TRACE_ENTRY_EXIT_POINT // MACRO IN MMP FILE
+        #define TRACE_ENTRY_POINT TRACE_FUNC_ENTRY_DEBUG_PRINT
+        #define TRACE_EXIT_POINT TRACE_FUNC_EXIT_DEBUG_PRINT
+    #else
+        #define TRACE_ENTRY_POINT
+        #define TRACE_EXIT_POINT
+    #endif
+
+#else
+    #define TRACE_ENTRY_POINT
+    #define TRACE_EXIT_POINT
+
+#endif // _DEBUG
+
+#endif // PIM_TRACE_H
+
+
+// End of File