sl@0: // Copyright (c) 1997-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: // FLogger Client side header
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0: @file
sl@0: @publishedAll
sl@0: @deprecated Migrate to Open System Trace Instrumentation API instead
sl@0: */
sl@0: 
sl@0: #ifndef __FLOGGER_H__
sl@0: #define __FLOGGER_H__
sl@0: 
sl@0: #include <e32base.h>
sl@0: 
sl@0: /** Maximum log buffer size.
sl@0: @publishedAll
sl@0: @deprecated Migrate to Open System Trace Instrumentation API instead
sl@0: */
sl@0: const TInt KLogBufferSize=150;
sl@0: 
sl@0: // [All of this start up stuff copied from DBMS]
sl@0: 
sl@0: class FLogger
sl@0: /** Controls the flogger server.
sl@0: @publishedAll
sl@0: @deprecated Migrate to Open System Trace Instrumentation API instead
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	class TSignal
sl@0: /**
sl@0: @publishedAll
sl@0: @deprecated Migrate to Open System Trace Instrumentation API instead
sl@0: */
sl@0: 		{
sl@0: 		friend class FLogger;
sl@0: 	public:
sl@0: 		inline TSignal() {}
sl@0: 		inline TInt Set(const TDesC& aCommand);
sl@0: 	
sl@0: 		inline TSignal(TRequestStatus& aStatus);
sl@0: 
sl@0: 		inline TPtrC Command() const;
sl@0: 
sl@0: 	private:
sl@0: 		TRequestStatus* iStatus;
sl@0: 		TThreadId iId;
sl@0: 		};
sl@0: public:
sl@0: 	static TInt Start();
sl@0: 
sl@0: 	IMPORT_C static TInt Run(TSignal& aSignal);
sl@0: 
sl@0: private:
sl@0: 	static TInt Init();
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /** The mode used to write to the log file.
sl@0: @publishedAll
sl@0: @deprecated Migrate to Open System Trace Instrumentation API instead
sl@0: */
sl@0: enum TFileLoggingMode 
sl@0: 	{
sl@0: 	/** Log file mode has not been explicitly set. */
sl@0: 	EFileLoggingModeUnknown =0,
sl@0: 	/** Open the log file in append mode. */
sl@0: 	EFileLoggingModeAppend,
sl@0: 	/** Open the log file in overwrite mode. */
sl@0: 	EFileLoggingModeOverwrite,
sl@0: 	EFileLoggingModeAppendRaw,
sl@0: 	EFileLoggingModeOverwriteRaw	
sl@0: 	};
sl@0: 
sl@0: NONSHARABLE_CLASS(TLogFormatter16Overflow) :public TDes16Overflow
sl@0: /** Unicode overflow handler.
sl@0: @publishedAll
sl@0: @deprecated Migrate to Open System Trace Instrumentation API instead
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	virtual void Overflow(TDes16& aDes);
sl@0: 	};
sl@0: 
sl@0: NONSHARABLE_CLASS(TLogFormatter8Overflow) :public TDes8Overflow
sl@0: /** Overflow handler.
sl@0: @publishedAll
sl@0: @deprecated Migrate to Open System Trace Instrumentation API instead
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	virtual void Overflow(TDes8& aDes);
sl@0: 	};
sl@0: 
sl@0: class TLogFormatter
sl@0: /** Formatting methods for log file data.
sl@0: @publishedAll
sl@0: @deprecated Migrate to Open System Trace Instrumentation API instead
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	TLogFormatter();
sl@0: 	void SetDateAndTime(TBool aUseDate,TBool aUseTime);
sl@0: 	TInt FormatTextToWritableBuffer(TDes8& aBuf, const TDesC16& aText) const;
sl@0: 	TInt FormatTextToWritableBuffer(TDes8& aBuf, const TDesC8& aText) const;
sl@0: 	TInt ConvertToWritableBuffer(TDes8& aBuf, TRefByValue<const TDesC16> aFmt, VA_LIST& aList);
sl@0: 	TInt ConvertToWritableBuffer(TDes8& aBuf, TRefByValue<const TDesC8> aFmt, VA_LIST& aList);
sl@0: private:
sl@0: 	void GetDateAndTimeL(TDes& aDate, TDes& aTime) const;
sl@0: 	void WriteL(TDes8& aTrg, const TDesC16& aSrc) const;
sl@0: 	void WriteL(TDes8& aTrg, const TDesC8& aSrc) const;
sl@0: private:
sl@0: 	TBool iUseDate;
sl@0: 	TBool iUseTime;
sl@0: 	TLogFormatter16Overflow iOverflow16;
sl@0: 	TLogFormatter8Overflow iOverflow8;
sl@0: 	};
sl@0: 
sl@0: class TLogFile
sl@0: /** General access to packaged log files.
sl@0: @publishedAll
sl@0: @deprecated Migrate to Open System Trace Instrumentation API instead
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	TLogFile();
sl@0: 	TLogFile(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode);
sl@0: 	TBool operator==(const TLogFile& aLogFile) const;
sl@0: 	void Set(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode);
sl@0: 	inline TBool Valid() const;
sl@0: 	inline TFileName Directory() const;
sl@0: 	inline TFileName Name() const;
sl@0: 	inline TFileLoggingMode Mode() const;
sl@0: 	inline void SetValid(TBool aValid);
sl@0: private:
sl@0: 	TBool iValid;
sl@0: 	TFileName iDirectory;
sl@0: 	TFileName iName;
sl@0: 	TFileLoggingMode iMode;
sl@0: 	};
sl@0: 
sl@0: #include <flogger.inl>
sl@0: 
sl@0: class RFileLogger : public RSessionBase
sl@0: /** Provides access methods to file logging.
sl@0: 
sl@0: The file logger API contains both static and non-static versions of access 
sl@0: functions to the file logging system. 
sl@0: @publishedAll
sl@0: @deprecated Migrate to Open System Trace Instrumentation API instead
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C RFileLogger();
sl@0: 	IMPORT_C ~RFileLogger();
sl@0: 	IMPORT_C TVersion Version() const;
sl@0: 	IMPORT_C TInt Connect();
sl@0: 	IMPORT_C void SetDateAndTime(TBool aUseDate,TBool aUseTime);
sl@0: 	IMPORT_C void CreateLog(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode);
sl@0: 	IMPORT_C void CloseLog();
sl@0: 	IMPORT_C void Write(const TDesC16& aText);
sl@0: 	IMPORT_C void WriteFormat(TRefByValue<const TDesC16> aFmt,...);
sl@0: 	IMPORT_C void WriteFormat(TRefByValue<const TDesC16> aFmt, VA_LIST& aList);
sl@0: 	IMPORT_C void Write(const TDesC8& aText);
sl@0: 	IMPORT_C void WriteFormat(TRefByValue<const TDesC8> aFmt,...);
sl@0: 	IMPORT_C void WriteFormat(TRefByValue<const TDesC8> aFmt, VA_LIST& aList);
sl@0: 	IMPORT_C void HexDump(const TText* aHeader, const TText* aMargin, const TUint8* aPtr, TInt aLen);
sl@0: 	IMPORT_C static void Write(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, const TDesC16& aText);
sl@0: 	IMPORT_C static void WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC16> aFmt,...);
sl@0: 	IMPORT_C static void WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC16> aFmt, VA_LIST& aList);
sl@0: 	IMPORT_C static void Write(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, const TDesC8& aText);
sl@0: 	IMPORT_C static void WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC8> aFmt,...);
sl@0: 	IMPORT_C static void WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC8> aFmt, VA_LIST& aList);
sl@0: 	IMPORT_C static void HexDump(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, const TText* aHeader, const TText* aMargin, const TUint8* aPtr, TInt aLen);
sl@0: 	IMPORT_C TInt LastError() const;
sl@0: 	IMPORT_C TBool LogValid() const;
sl@0: 	IMPORT_C TBool LogSTI() const;
sl@0: 
sl@0: private:
sl@0: 	TInt DoConnect();
sl@0: 	void DoWrite(const TDesC8& aBuf);
sl@0: 	void DoStaticWrite(const TDesC8& aBuf);
sl@0: 	void DoWriteFormat(TRefByValue<const TDesC16> aFmt, VA_LIST& aList);
sl@0: 	void DoWriteFormat(TRefByValue<const TDesC8> aFmt, VA_LIST& aList);
sl@0: 	static void DoStaticWriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC16> aFmt, VA_LIST& aList);
sl@0: 	static void DoStaticWriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC8> aFmt, VA_LIST& aList);
sl@0: 	void DoHexDump(const TText* aHeader, const TText* aMargin, const TUint8* aPtr, TInt aLen);
sl@0: private:
sl@0: 	TLogFormatter iFormatter;
sl@0: 	TLogFile iLogFile;
sl@0: 	TInt iLastError;
sl@0: 	TBool iLogSTI;	/* CR1688  	Flogger to use RDebug::Print */
sl@0: 	
sl@0: 	};
sl@0: 
sl@0: #endif