contextframework/cfwplugins/cenrepsourceplugin/inc/cenreptrace.h
changeset 0 2e3d3ce01487
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/contextframework/cfwplugins/cenrepsourceplugin/inc/cenreptrace.h	Tue Feb 02 10:12:00 2010 +0200
@@ -0,0 +1,350 @@
+/*
+* Copyright (c) 2007-2007 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:  Trace definitions.
+*
+*/
+
+
+#ifndef SENSORTRACE_H
+#define SENSORTRACE_H
+
+#include <e32debug.h>
+#include <flogger.h>
+#include "cenreptraceconfiguration.hrh"
+
+//-----------------------------------------------------------------------------
+// Enable file trace macros
+//-----------------------------------------------------------------------------
+//
+#ifdef TRACE_INTO_FILE
+
+#include <flogger.h>
+#include <f32file.h>
+
+    /**
+    * Constants
+    */
+    _LIT( KDir, "contextframework" );
+    _LIT( KFile, "cenrepsource_log.txt" );
+    _LIT( KFullPath, "c:\\logs\\contextframework\\" );
+
+    /**
+    * Enables logging by creating the log folder.
+    */
+    LOCAL_C void EnableLog()
+        {
+        RFs fs;
+        if( fs.Connect() == KErrNone )
+            {
+            fs.MkDirAll( KFullPath );
+            fs.Close();
+            }
+        }
+    #define ENABLE_LOG\
+        {\
+        EnableLog();\
+        }
+        
+#else//TRACE_INTO_FILE not defined
+
+    #define ENABLE_LOG
+
+#endif//TRACE_INTO_FILE
+ 
+//-----------------------------------------------------------------------------
+// Error trace macros
+//-----------------------------------------------------------------------------
+//
+#ifdef ERROR_TRACE
+
+    /**
+    * Error trace definitions. Does not automatically log the error code!
+    */
+    #ifdef TRACE_INTO_FILE
+
+        #define ERROR( aErr, aMsg )\
+            {\
+            if( aErr < KErrNone )\
+                {\
+                _LIT( KMsg, aMsg );\
+                RFileLogger::Write( KDir, KFile, EFileLoggingModeAppend, KMsg );\
+                }\
+            }
+        #define ERROR_1( aErr, aMsg, aP1 )\
+            {\
+            if( aErr < KErrNone )\
+                {\
+                _LIT( KMsg, aMsg );\
+                RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, KMsg, aP1 );\
+                }\
+            }
+        #define ERROR_2( aErr, aMsg, aP1, aP2 )\
+            {\
+            if( aErr < KErrNone )\
+                {\
+                _LIT( KMsg, aMsg );\
+                RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, KMsg, aP1, aP2 );\
+                }\
+            }
+        #define ERROR_3( aErr, aMsg, aP1, aP2, aP3 )\
+            {\
+            if( aErr < KErrNone )\
+                {\
+                _LIT( KMsg, aMsg );\
+                RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, KMsg, aP1, aP2, aP3 );\
+                }\
+            }
+        #define ERROR_GEN( aMsg ) ERROR( KErrGeneral, aMsg )
+        #define ERROR_GEN_1( aMsg, aP1 ) ERROR_1( KErrGeneral, aMsg, aP1 )
+            
+    #else//TRACE_INTO_FILE not defined
+    
+        #define ERROR( aErr, aMsg )\
+            {\
+            if( aErr < KErrNone )\
+                {\
+                _LIT( KMsg, aMsg ); RDebug::Print( KMsg );\
+                }\
+            }
+        #define ERROR_1( aErr, aMsg, aP1 )\
+            {\
+            if( aErr < KErrNone )\
+                {\
+                _LIT( KMsg, aMsg ); RDebug::Print( KMsg, aP1 );\
+                }\
+            }
+        #define ERROR_2( aErr, aMsg, aP1, aP2 )\
+            {\
+            if( aErr < KErrNone )\
+                {\
+                _LIT( KMsg, aMsg ); RDebug::Print( KMsg, aP1, aP2 );\
+                }\
+            }
+        #define ERROR_3( aErr, aMsg, aP1, aP2, aP3 )\
+            {\
+            if( aErr < KErrNone )\
+                {\
+                _LIT( KMsg, aMsg ); RDebug::Print( KMsg, aP1, aP2, aP3 );\
+                }\
+            }
+        #define ERROR_GEN( aMsg ) ERROR( KErrGeneral, aMsg )
+        #define ERROR_GEN_1( aMsg, aP1 ) ERROR_1( KErrGeneral, aMsg, aP1 )
+    
+    #endif//TRACE_INTO_FILE
+
+#else//ERROR_TRACE not defined
+
+    #define ERROR( aErr, aMsg )
+    #define ERROR_1( aErr, aMsg, aP1 )
+    #define ERROR_2( aErr, aMsg, aP1, aP2 )
+    #define ERROR_3( aErr, aMsg, aP1, aP2, aP3 )
+    #define ERROR_GEN( aMsg )
+    #define ERROR_GEN_1( aMsg, aP1 )
+
+#endif//ERROR_TRACE
+
+//-----------------------------------------------------------------------------
+// Info trace macros
+//-----------------------------------------------------------------------------
+//
+#ifdef INFO_TRACE
+
+    /**
+    * Info log message definitions.
+    */
+    #ifdef TRACE_INTO_FILE
+    
+        #define INFO( aMsg )\
+            {\
+            _LIT( KMsg, aMsg );\
+            RFileLogger::Write( KDir, KFile, EFileLoggingModeAppend, KMsg );\
+            }
+        #define INFO_1( aMsg, aP1 )\
+            {\
+            _LIT( KMsg, aMsg );\
+            RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, KMsg, aP1 );\
+            }
+        #define INFO_2( aMsg, aP1, aP2 )\
+            {\
+            _LIT( KMsg, aMsg );\
+            RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, KMsg, aP1, aP2 );\
+            }
+        #define INFO_3( aMsg, aP1, aP2, aP3 )\
+            {\
+            _LIT( KMsg, aMsg );\
+            RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, KMsg, aP1, aP2, aP3 );\
+            }
+
+    #else//TRACE_INTO_FILE not defined
+
+        #define INFO( aMsg )\
+            {\
+            _LIT( KMsg, aMsg ); RDebug::Print( KMsg );\
+            }
+        #define INFO_1( aMsg, aP1 )\
+            {\
+            _LIT( KMsg, aMsg ); RDebug::Print( KMsg, aP1 );\
+            }
+        #define INFO_2( aMsg, aP1, aP2 )\
+            {\
+            _LIT( KMsg, aMsg ); RDebug::Print( KMsg, aP1, aP2 );\
+            }
+        #define INFO_3( aMsg, aP1, aP2, aP3 )\
+            {\
+            _LIT( KMsg, aMsg ); RDebug::Print( KMsg, aP1, aP2, aP3 );\
+            }
+
+    #endif//TRACE_INTO_FILE
+        
+#else//INFO_TRACE not defined
+
+    #define INFO( aMsg )
+    #define INFO_1( aMsg, aP1 )
+    #define INFO_2( aMsg, aP1, aP2 )
+    #define INFO_3( aMsg, aP1, aP2, aP3 )
+
+#endif//INFO_TRACE
+
+//-----------------------------------------------------------------------------
+// Trace current client thread name and process id
+//-----------------------------------------------------------------------------
+//
+#ifdef CLIENT_TRACE
+
+    #define CLIENT( aMessage )\
+        {\
+        RThread thread;\
+        TInt err = aMessage.Client( thread );\
+        if( err == KErrNone )\
+            {\
+            RProcess process;\
+            err = thread.Process( process );\
+            if( err == KErrNone )\
+                {\
+                TPtrC thredName( thread.Name() );\
+                TUid processUid( process.SecureId() );\
+                INFO_2( "Current client process UID: [%x], thread name: [%S]",\
+                    processUid,\
+                    &thredName );\
+                }\
+            process.Close();\
+            }\
+        thread.Close();\
+        }
+
+#else
+
+    #define CLIENT( aMessage )
+
+#endif
+
+//-----------------------------------------------------------------------------
+// Function trace macros
+//-----------------------------------------------------------------------------
+//
+#ifdef FUNC_TRACE
+
+    // Constants
+    _LIT8( KEllipse, "(" );
+
+    /**
+    * Function logging definitions.
+    */
+    #ifdef TRACE_INTO_FILE
+    
+        #define FUNC( aMsg, aP1 )\
+            {\
+            _LIT8( KMsg, aMsg ); RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, KMsg, aP1 );\
+            }\
+    
+    #else//TRACE_INTO_FILE not defined
+    
+        #define FUNC( aMsg, aP1 )\
+            {\
+            RDebug::Printf( aMsg, aP1 );\
+            }\
+    
+    #endif//TRACE_INTO_FILE
+        
+    /**
+    * Function trace helper class.
+    */
+    class TFuncLog
+        {
+        public:
+            inline TFuncLog( const char* aFunc ): iFunc( (TUint8*)aFunc )
+                {
+                TInt pos = iFunc.Find( KEllipse );
+                if( pos != KErrNotFound )
+                    {
+                    iFunc.Set( iFunc.Left( iFunc.Find( KEllipse ) ) );
+                    }
+                FUNC( "%S-START", &iFunc );
+                }
+            inline ~TFuncLog()
+                {
+                FUNC( "%S-END", &iFunc );
+                }
+            TPtrC8 iFunc;
+        };
+
+    #define FUNC_LOG TFuncLog _fl( __PRETTY_FUNCTION__ );
+    
+#else//FUNC_TRACE not defined
+
+    #define FUNC_LOG
+
+#endif//FUNC_TRACE
+
+//-----------------------------------------------------------------------------
+// Timestamp trace macros
+//-----------------------------------------------------------------------------
+//
+#ifdef TIMESTAMP_TRACE
+
+    #ifdef TRACE_INTO_FILE
+    
+        #define TIMESTAMP( aCaption )\
+            {\
+            TTime t;\
+            t.HomeTime();\
+            TDateTime dt = t.DateTime();\
+            _LIT( KMsg, aCaption );\
+            _LIT( KFormat, "[TIMESTAMP] %S %d:%02d:%02d.%d us");\
+            RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, KFormat,\
+                &KMsg, dt.Hour(), dt.Minute(), dt.Second(), dt.MicroSecond() );\
+            }
+
+    #else//TRACE_INTO_FILE not defined
+    
+        #define TIMESTAMP( aCaption )\
+            {\
+            TTime t;\
+            t.HomeTime();\
+            TDateTime dt = t.DateTime();\
+            _LIT( KMsg, aCaption );\
+            _LIT( KFormat, "[TIMESTAMP] %S %d:%02d:%02d.%d us");\
+            RDebug::Print( KFormat,\
+                &KMsg, dt.Hour(), dt.Minute(), dt.Second(), dt.MicroSecond() );\
+            }
+
+    #endif//TRACE_INTO_FILE
+
+#else//TIMESTAMP_TRACE not defined
+
+    #define TIMESTAMP( aCaption )
+
+#endif//TIMESTAMP_TRACE
+
+#endif