/*

* 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:

* Logging engine for USB.

*

*/

/**

 @file

 @internalTechnology

*/

#ifndef LOGGER_H

#define LOGGER_H

#include <e32base.h>

// Control function entry and exit logging using a compile-time switch.

#define __LOG_FUNCTIONS__

class TFunctionLogger;

#ifndef __COMMSDEBUGUTILITY_H__		// comms-infras/commsdebugutility.h not included

#ifdef _DEBUG						// If this is a debug build...

// Set flogging active.

#define __FLOG_ACTIVE

#endif

#endif

#ifdef __FLOG_ACTIVE

#define IF_FLOGGING(a) a

#else

#define IF_FLOGGING(a)

#endif

_LIT8(KDefaultLogFile, "USB");

#ifdef __FLOG_ACTIVE

#define LEAVEIFERRORL(a)				VerboseLeaveIfErrorL(KLogComponent, __FILE__, __LINE__, a)

#define LEAVEL(a)						VerboseLeaveL(KLogComponent, __FILE__, __LINE__, a)

#define _USB_PANIC(CAT, CODE) 			VerbosePanic(KLogComponent, __FILE__, __LINE__, CODE, (TText8*)#CODE, CAT)

#define PANIC_MSG(msg, cat, code)		VerboseMsgPanic(KLogComponent, __FILE__, __LINE__, msg, cat, code);

#define FLOG(a)							CUsbLog::Write(KDefaultLogFile, a);

#define FTRACE(a)						{a;}

#define LOGTEXT(text)						CUsbLog::Write(KLogComponent, text);

#define LOGTEXT2(text, a)					CUsbLog::WriteFormat(KLogComponent, text, a);

#define LOGTEXT3(text, a, b)				CUsbLog::WriteFormat(KLogComponent, text, a, b);

#define LOGTEXT4(text, a, b, c)				CUsbLog::WriteFormat(KLogComponent, text, a, b, c);

#define LOGTEXT5(text, a, b, c, d)			CUsbLog::WriteFormat(KLogComponent, text, a, b, c, d);

#define LOGTEXT6(text, a, b, c, d, e)		CUsbLog::WriteFormat(KLogComponent, text, a, b, c, d, e);

#define LOGTEXT7(text, a, b, c, d, e, f)	CUsbLog::WriteFormat(KLogComponent, text, a, b, c, d, e, f);

#define LOGHEXDESC(desc)				CUsbLog::HexDump(KLogComponent, 0, 0, desc.Ptr() , desc.Length());

#define LOGHEXRAW(data, len)			CUsbLog::HexDump(KLogComponent, 0, 0, data, len);

#else

#define LEAVEIFERRORL(a)				static_cast<void>(User::LeaveIfError(a))

#define LEAVEL(a)						User::Leave(a)

#define _USB_PANIC(CAT, CODE) 			User::Panic(CAT, CODE)

#define PANIC_MSG(msg, cat, code)		msg.Panic(cat, code);

#define FLOG(a)

#define FTRACE(a)

#define LOGTEXT(text)

#define LOGTEXT2(text, a)

#define LOGTEXT3(text, a, b)

#define LOGTEXT4(text, a, b, c)

#define LOGTEXT5(text, a, b, c, d)			

#define LOGTEXT6(text, a, b, c, d, e)		

#define LOGTEXT7(text, a, b, c, d, e, f)

#define LOGHEXDESC(desc)

#define LOGHEXRAW(data, len)

#endif // __FLOG_ACTIVE

#define FORCED_LOG_FUNC					TFunctionLogger __instrument(KLogComponent, TPtrC8((TUint8*)__PRETTY_FUNCTION__), (TAny*)this);

#define FORCED_LOG_STATIC_FUNC_ENTRY	TFunctionLogger __instrument(KLogComponent, TPtrC8((TUint8*)__PRETTY_FUNCTION__), (TAny*)NULL);

#if ( defined __FLOG_ACTIVE && defined __LOG_FUNCTIONS__ )

#define LOG_LINE						CUsbLog::Write(KLogComponent, KNullDesC8());

#define LOG_FUNC						FORCED_LOG_FUNC

#define LOG_STATIC_FUNC_ENTRY			FORCED_LOG_STATIC_FUNC_ENTRY

#else

#define LOG_LINE

#define LOG_FUNC

#define LOG_STATIC_FUNC_ENTRY

#endif

NONSHARABLE_CLASS(CUsbLog) : public CBase

	{

public:

	IMPORT_C static TInt Connect();

	IMPORT_C static void Close();

	IMPORT_C static void Write(const TDesC8& aCmpt, const TDesC8& aText);

	IMPORT_C static void WriteFormat(const TDesC8& aCmpt, TRefByValue<const TDesC8> aFmt, ...);

	IMPORT_C static void WriteFormat(const TDesC8& aCmpt, TRefByValue<const TDesC8> aFmt, VA_LIST& aList);

	IMPORT_C static void Write(const TDesC8& aCmpt, const TDesC16& aText);

	IMPORT_C static void WriteFormat(const TDesC8& aCmpt, TRefByValue<const TDesC16> aFmt, ...);

	IMPORT_C static void WriteFormat(const TDesC8& aCmpt, TRefByValue<const TDesC16> aFmt, VA_LIST& aList);

	IMPORT_C static void HexDump(const TDesC8& aCmpt, const TText* aHeader, const TText* aMargin, const TUint8* aPtr, TInt aLen);

	};

#ifndef NO_FPRINT

inline void FPrint(const TRefByValue<const TDesC> IF_FLOGGING(aFmt), ...)

	{

#ifdef __FLOG_ACTIVE

	VA_LIST list;

	VA_START(list,aFmt);

	CUsbLog::WriteFormat(KDefaultLogFile, aFmt, list);

#endif

	}

#endif

#ifndef NO_FHEX_PTR

inline void FHex(const TUint8* IF_FLOGGING(aPtr), TInt IF_FLOGGING(aLen))

	{

#ifdef __FLOG_ACTIVE

	CUsbLog::HexDump(KDefaultLogFile, 0, 0, aPtr, aLen);

#endif

	}

#endif

#ifndef NO_FHEX_DESC

inline void FHex(const TDesC8& IF_FLOGGING(aDes))

	{

#ifdef __FLOG_ACTIVE

	FHex(aDes.Ptr(), aDes.Length());

#endif

	}

#endif

IMPORT_C void VerboseLeaveIfErrorL(const TDesC8& aCpt, 

						  char* aFile, 

						  TInt aLine, 

						  TInt aReason);

IMPORT_C void VerboseLeaveL(const TDesC8& aCpt, 

						  char* aFile, 

						  TInt aLine, 

						  TInt aReason);

IMPORT_C void VerbosePanic(const TDesC8& aCpt, 

				  char* aFile, 

				  TInt aLine, 

				  TInt aPanicCode, 

				  TText8* aPanicName,

				  const TDesC& aPanicCategory);

IMPORT_C void VerboseMsgPanic(const TDesC8& aCpt, 

								char* aFile, 

								TInt  aLine,

								const RMessage2& aMsg,

								const TDesC& aCat, 

								TInt  aPanicCode);

NONSHARABLE_CLASS(TFunctionLogger)

	{

public:

	IMPORT_C TFunctionLogger(const TDesC8& aCpt, const TDesC8& aString, TAny* aThis);

	IMPORT_C ~TFunctionLogger();

private:

	TPtrC8 iCpt;

	TPtrC8 iString;

	};

#endif	// LOGGER_H