cbsatplugin/atmisccmdplugin/inc/debug.h
branchRCL_3
changeset 16 b23265fb36da
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/cbsatplugin/atmisccmdplugin/inc/debug.h	Tue Apr 27 16:49:44 2010 +0300
@@ -0,0 +1,236 @@
+/*
+ * Copyright (c) 2010 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 :tracing and debuging definitions.
+ *
+ */
+
+
+#ifndef DEBUG_H
+#define DEBUG_H
+
+#include <e32base.h>
+#include <e32svr.h>
+
+_LIT8(KDebugPrintS, "ATCmd: %s%S\r\n");
+_LIT8(KDebugPrintD, "ATCmd: %s%d\r\n");
+
+#ifdef _DEBUG
+
+#include <flogger.h>
+
+_LIT(KLogFile,"atmiscmdplugin.txt");
+_LIT(KLogDir,"atmiscmdplugin");
+_LIT(KATDebugFile, "log.txt" );
+_LIT(KATDebugDir, "atmiscmdplugin" );
+
+_LIT(KTracePrefix16, "[atmiscmdplugin] ");
+_LIT8(KTracePrefix8, "[atmiscmdplugin] ");
+_LIT8(KFuncFormat8, ">< %S");
+_LIT8(KFuncThisFormat8, ">< %S, [0x%08X]");
+_LIT8(KFuncEntryFormat8, "-> %S");
+_LIT8(KFuncEntryThisFormat8, "-> %S, [0x%08X]");
+_LIT8(KFuncEntryArgFormat8, "-> %S, (%S)");
+_LIT8(KFuncExitFormat8, "<- %S");
+_LIT(KPanicCategory, "atmiscmdplugin");
+_LIT8(KPanicPrefix8, "PANIC code ");
+_LIT8(KLeavePrefix8, "LEAVE code ");
+
+const TInt KMaxLogLineLength = 256;
+
+// Trace options
+#define KPRINTERROR		0x00000001 // Print error
+#define KPRINTINFO	    0x00000002 // Print function trace
+#define KPRINTSTATE		0x00000004 // Print state machine infos
+#define KPRINTWARNING  0x00000008 // Print warnings
+
+#define USE_FILE_LOGGING
+
+const TInt KTraceMask = KPRINTERROR | KPRINTINFO | KPRINTSTATE | KPRINTWARNING;
+
+NONSHARABLE_CLASS(TOverflowTruncate16) : public TDes16Overflow
+	{
+public:
+	void Overflow(TDes16& /*aDes*/) {}
+	};
+
+NONSHARABLE_CLASS(TOverflowTruncate8) : public TDes8Overflow
+	{
+public:
+	void Overflow(TDes8& /*aDes*/) {}
+	};
+
+inline void Trace(TRefByValue<const TDesC16> aFmt, ...)
+    {
+	VA_LIST list;
+	VA_START(list,aFmt);
+    RBuf16 buf;
+    buf.Create(KMaxLogLineLength);
+    buf.Zero();    
+	buf.Append(KTracePrefix16);
+	TOverflowTruncate16 overflow;
+	buf.AppendFormatList(aFmt,list,&overflow);
+	RDebug::Print(buf);
+#ifdef USE_FILE_LOGGING
+    RFileLogger::Write(KLogDir, KLogFile, EFileLoggingModeAppend, buf);
+#endif
+	buf.Close();
+    }
+
+inline void Trace(TRefByValue<const TDesC8> aFmt, ...)
+    {
+    VA_LIST list;
+    VA_START(list, aFmt);
+	TOverflowTruncate8 overflow;
+    RBuf8 buf8;
+    buf8.Create(KMaxLogLineLength);
+    buf8.Zero();    
+    buf8.Append(KTracePrefix8);
+	buf8.AppendFormatList(aFmt, list, &overflow);
+    RDebug::RawPrint(buf8);
+#ifdef USE_FILE_LOGGING
+    RFileLogger::Write(KLogDir, KLogFile, EFileLoggingModeAppend, buf8);
+#endif
+    buf8.Close();
+    }
+
+inline void TracePanic(
+	char* aFile, 
+	TInt aLine,
+	TInt aPanicCode,
+	const TDesC& aPanicCategory)
+    {
+	TPtrC8 fullFileName((const TUint8*)aFile);
+	TPtrC8 fileName(fullFileName.Ptr()+fullFileName.LocateReverse('\\')+1);
+    RBuf8 buf;
+    buf.Create(KMaxLogLineLength);
+    buf.Zero();    
+	buf.Append(KPanicPrefix8);
+	buf.AppendFormat(_L8("%d at line %d in file %S"), aPanicCode, aLine, &fileName);
+	Trace(buf);
+	buf.Close();
+	User::Panic(aPanicCategory, aPanicCode); 
+    }
+
+inline void TraceLeave(char* aFile, TInt aLine, TInt aReason)
+	{
+	TPtrC8 fullFileName((const TUint8*)aFile);
+	TPtrC8 fileName(fullFileName.Ptr()+fullFileName.LocateReverse('\\')+1);
+    RBuf8 buf;
+    buf.Create(KMaxLogLineLength);
+    buf.Zero();    
+	buf.Append(KLeavePrefix8);
+	buf.AppendFormat(_L8("%d at line %d in file %S"), aReason, aLine, &fileName);
+	Trace(buf);
+	buf.Close();
+	User::LeaveIfError(aReason);
+	}
+
+inline TBuf8<64> ArgFormat(TRefByValue<const TDesC8> aFmt, ...)
+    {
+    TOverflowTruncate8 overflow;
+    TBuf8<64> buf8;
+    buf8.Format(aFmt, &overflow);
+    return buf8;
+    }
+
+#define TRACE_INFO(p) {if(KTraceMask & KPRINTINFO) Trace p;}
+
+#define TRACE_ERROR(p) {if(KTraceMask & KPRINTERROR) Trace p;}
+
+#define TRACE_STATE(p) {if(KTraceMask & KPRINTSTATE) Trace p;}
+
+#define TRACE_WARNING(p) {if(KTraceMask & KPRINTWARNING) Trace p;}
+
+#define TRACE_INFO_SEG(p) {if(KTraceMask & KPRINTINFO) p;}
+
+#define TRACE_ASSERT(GUARD, CODE) {if (!(GUARD)) \
+         TracePanic(__FILE__, __LINE__, CODE, KPanicCategory);}
+
+#define PANIC(CODE) TracePanic(__FILE__, __LINE__, CODE, KPanicCategory)
+
+#define LEAVE_IF_ERROR(REASON) {if (REASON) \
+         TraceLeave(__FILE__, __LINE__, REASON);}
+
+#define LEAVE(REASON) TraceLeave(__FILE__, __LINE__, REASON)
+
+#define TRACE_FUNC_ENTRY {if(KTraceMask & KPRINTINFO) { \
+                            TPtrC8 ptr8((TUint8*)__PRETTY_FUNCTION__); \
+                            Trace(KFuncEntryFormat8, &ptr8);}}
+
+#define TRACE_FUNC_ENTRY_THIS {if(KTraceMask & KPRINTINFO) {\
+                            TPtrC8 ptr8((TUint8*)__PRETTY_FUNCTION__); \
+                            Trace(KFuncEntryThisFormat8, &ptr8, this);}}
+
+#define	 TRACE_FUNC_EXIT {if(KTraceMask & KPRINTINFO) {\
+                            TPtrC8 ptr8((TUint8*)__PRETTY_FUNCTION__); \
+                            Trace(KFuncExitFormat8, &ptr8);}}
+
+#define TRACE_FUNC {if(KTraceMask & KPRINTINFO) { \
+                            TPtrC8 ptr8((TUint8*)__PRETTY_FUNCTION__); \
+                            Trace(KFuncFormat8, &ptr8);}}
+
+#define TRACE_FUNC_THIS {if(KTraceMask & KPRINTINFO) {\
+                            TPtrC8 ptr8((TUint8*)__PRETTY_FUNCTION__); \
+                            Trace(KFuncThisFormat8, &ptr8, this);}}
+
+#define TRACE_FUNC_ARG(a) { if(KTraceMask & KPRINTINFO) { \
+                            TPtrC8 func( (TUint8*) __PRETTY_FUNCTION__ ); \
+                            TPtrC8 arg( ArgFormat a ); \
+                            Trace( KFuncEntryArgFormat8, &func, &arg ); } }
+
+#define RETURN_IF_ERR(ERR) {if(ERR) {Trace(_L8(" RETURN %d at file %S line %d"), ERR, &(TPtrC8((const TUint8*)__FILE__)), __LINE__); return ERR;}}
+
+#else // ! _DEBUG
+
+#define TRACE_INFO(p)
+
+#define TRACE_ERROR(p)
+
+#define TRACE_STATE(p)
+
+#define TRACE_WARNING(p)
+
+#define TRACE_INFO_SEG(p)
+
+#define TRACE_ASSERT(GUARD, CODE)
+
+#define PANIC(CODE) {User::Panic(KPanicCategory, CODE);}
+
+#define LEAVE_IF_ERROR(REASON) {static_cast<void>(User::LeaveIfError(REASON));}
+
+#define LEAVE(REASON) {static_cast<void>(User::Leave(REASON));}
+
+#define TRACE_FUNC_ENTRY
+
+#define TRACE_FUNC_ENTRY_THIS
+
+#define TRACE_FUNC_EXIT
+
+#define TRACE_FUNC
+
+#define TRACE_FUNC_THIS
+
+#define TRACE_FUNC_ARG(a)
+
+#define RETURN_IF_ERR(ERR) {if(ERR) return ERR;}
+
+inline void Trace(TRefByValue<const TDesC16> aFmt, ...)
+    {
+    }
+
+inline void Trace(TRefByValue<const TDesC8> aFmt, ...)
+    {
+    }
+#endif // _DEBUG
+
+#endif // DEBUG_H
+