sl@0: /**
sl@0: * Copyright (c) 2005-2009 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: 
sl@0: 
sl@0: 
sl@0: /**
sl@0:  @file RFileLogger.h
sl@0: */
sl@0: 
sl@0: #if !(defined __ET_RFILELOGGER_H__)
sl@0: #define __ET_RFILELOGGER_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: 
sl@0: const TInt KMaxSizOfTag=128;
sl@0: const TInt KMaxSizOfString = 256;
sl@0: const TInt KMaxFilename = 50;
sl@0: 
sl@0: // *** Maintaince warning: the constant designed
sl@0: // used on both server side and client side. Any change shoud be
sl@0: // checked on both side
sl@0: _LIT(KMessageFormat," - %d - %S - %d - ");
sl@0: 
sl@0: _LIT(KSeperation," - ");
sl@0: _LIT8(KSeperation8," - ");
sl@0: _LIT(KTagSeperation,"LogFieldsRequiredBeingAddedToAboveLogMessage");
sl@0: _LIT(KTagSeperationEnd,"\t\t\t\t\t\t"); // make them invisible
sl@0: _LIT(KTagSeperation8,"LogFieldsRequiredBeingAddedToAboveLogMessage");
sl@0: _LIT(KTagSeperationEnd8,"\t\t\t\t\t\t"); // make them invisible
sl@0: // *** End of Maintaince warning
sl@0: 
sl@0: 
sl@0: //#if !(defined __FILELOGGER_UREL)
sl@0: _LIT(KFileLogrerServerName,"RFileLoggerServer");
sl@0: const TInt KMaxLoggerFilePath = 256;
sl@0: const TInt KMaxLoggerLineLength = 512;
sl@0: 
sl@0: const TInt KRFileLoggerMajorVersion = 1;
sl@0: const TInt KRFileLoggerMinorVersion = 1;
sl@0: const TInt KRFileLoggerBuildVersion = 1;
sl@0: 
sl@0: struct TExtraLogField
sl@0: 	{
sl@0: 	TBuf<KMaxSizOfTag> iLogFieldName;
sl@0: 	TBuf<KMaxSizOfString> iLogFieldValue;
sl@0: 	};
sl@0: /**
sl@0:  * RFileLoggerBody - class to provide internal data for the client side
sl@0:  *
sl@0:  * This class contains all data members which would otherwise be in the
sl@0:  * RFileLogger class. They are instead in this file since that because
sl@0:  * CreateSession is a protected member of RSessionBase, so we must derive
sl@0:  *from it and provide a means to call this via pass-through inline functions.
sl@0:  */
sl@0: class RFileLoggerBody : public RSessionBase
sl@0: {
sl@0: public:
sl@0: 	inline TInt DoCreateSession(const TDesC& aServer,const TVersion& aVersion,TInt aAsyncMessageSlots);
sl@0: 	inline TInt DoSendReceive(TInt aFunction,const TIpcArgs& aArgs) const;
sl@0: 	inline TInt DoSendReceive(TInt aFunction) const;
sl@0: 
sl@0: 	
sl@0: };
sl@0: 
sl@0: inline TInt RFileLoggerBody::DoCreateSession(const TDesC& aServer,const TVersion& aVersion,TInt aAsyncMessageSlots)
sl@0: 	{
sl@0: 	return CreateSession(aServer,aVersion,aAsyncMessageSlots);
sl@0: 	}
sl@0: 
sl@0: inline TInt RFileLoggerBody::DoSendReceive(TInt aFunction,const TIpcArgs& aArgs) const
sl@0: 	{
sl@0: 	return SendReceive(aFunction,aArgs);
sl@0: 	}
sl@0: 
sl@0: inline TInt RFileLoggerBody::DoSendReceive(TInt aFunction) const
sl@0: 	{
sl@0: 	return SendReceive(aFunction);
sl@0: 	}
sl@0: 
sl@0: class RFileFlogger
sl@0: /**
sl@0: @internalComponent
sl@0: @test
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	enum TLogMode{ELogModeAppend,ELogModeOverWrite};
sl@0: 	// Logging level
sl@0: 	enum TLogSeverity{ESevrErr  = 1,ESevrHigh, ESevrWarn, ESevrMedium, ESevrInfo, ESevrLow, ESevrTEFUnit, ESevrAll};
sl@0: 	enum TLogCommand{ECreateLog,EWriteLog};
sl@0: 
sl@0: 	enum TLogType{EXml,ETxt};
sl@0: 	
sl@0: 	IMPORT_C RFileFlogger();
sl@0: 	IMPORT_C ~RFileFlogger();
sl@0: 	
sl@0: 
sl@0: 	IMPORT_C TInt Connect(); 
sl@0: 	IMPORT_C TInt CreateLog(const TDesC& aLogFilePath,TLogMode aMode);
sl@0: 	IMPORT_C void Log(const TText8* aFile, TInt aLine, TLogSeverity aSeverity, TRefByValue<const TDesC> aFmt,...);
sl@0: 	IMPORT_C void Log(const TText8* aFile, TInt aLine, TLogSeverity aSeverity, TInt arraylength, TExtraLogField* aLogFields, TRefByValue<const TDesC> aFmt,...);
sl@0: 
sl@0: 	IMPORT_C void SetLogLevel(TLogSeverity aloglevel); 
sl@0: 	IMPORT_C void Close();
sl@0: 	IMPORT_C void Log(const TText8* aFile, TInt aLine, TLogSeverity aSeverity,TRefByValue<const TDesC> aFmt, VA_LIST aList);
sl@0: 	IMPORT_C void Log(const TText8* aFile, TInt aLine, TLogSeverity aSeverity, TInt arraylength, TExtraLogField* aLogFields, TRefByValue<const TDesC> aFmt, VA_LIST aList);	
sl@0: 
sl@0: private:
sl@0: 	void GetCPPModuleName(TDes& aModuleName, const TText8* aCPPFileName);
sl@0: 	void WriteL(const TDesC& aLogBuffer);
sl@0: 	void WriteL(TDes8& aLogBuffer);
sl@0: 	void AddTime(TDes8& aTime);
sl@0: 
sl@0: 	RFileLoggerBody* ilogbody;
sl@0: 
sl@0: 	TLogSeverity iloglevel;
sl@0: 	TBool iLogfileTag;
sl@0: 
sl@0: 
sl@0: 	};
sl@0: 
sl@0: 
sl@0: #endif