// Copyright (c) 1997-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:

//

/**

 @file

*/

#include <f32file.h>

#include <flogger.h>

#include "FLOGSTD.H"

/** 

Macro for Single blank space.

*/

#define BLANK	_S("")

const TInt KHexDumpWidth=16;

/**

Literal constant that hold a string and unicode hex.

*/

_LIT(KFirstFormatString,"%s%04x : ");

/**

Literal constant that hold a string and unicode hex.

*/

_LIT(KSecondFormatString,"%02x ");

/**

Character Constant.

*/

_LIT(KThirdFormatString,"%c");

/** 

Literal Constant for 3 blank spaces. 

*/

_LIT(KThreeSpaces,"   ");

/** 

Literal Constant for 2 blank spaces. 

*/

_LIT(KTwoSpaces," ");

IMPORT_C extern const TBool KFloggerSTI;

/*

RFileLogger class definition

*/

EXPORT_C RFileLogger::RFileLogger() 

	: RSessionBase(), iFormatter(), iLastError(KErrNone), iLogSTI(KFloggerSTI)

/** Creates a default RFileLogger object. */

	{}

EXPORT_C RFileLogger::~RFileLogger()

/** Empty destructor. 

Clients with open sessions must end the session by calling Close() beforehand.

Note that it does not delete the log file.*/

	{}

EXPORT_C TVersion RFileLogger::Version() const

/** Returns the version number.

@return The version number. */

	{

	return(TVersion(KFLogSrvMajorVersionNumber,KFLogSrvMinorVersionNumber,KFLogSrvBuildVersionNumber));

	}

EXPORT_C TInt RFileLogger::Connect()

/** Connects to the file logger server with the default number of message slots, which is 8.

This function does not need to be called if you are using the static versions 

of Write(), WriteFormat() or HexDump().

@return KErrNone if successful, otherwise one of the system-wide error codes. */

	{

	TInt ret=DoConnect();

	if (ret==KErrNotFound)

		{

		ret=FLogger::Start();

		if (ret==KErrNone || ret==KErrAlreadyExists)

			ret=DoConnect();

		}

	return ret;

	}

EXPORT_C void RFileLogger::SetDateAndTime(TBool aUseDate,TBool aUseTime)

/** Specifies whether time and/or date should be appended to log data.

Appending of the time and date to log entries can be switched on and off 

at anytime between creation and destruction of RFileLogger.

This function does not need to be called if you are using the static versions 

of Write(), WriteFormat() or HexDump().

@param aUseDate Use ETrue to log the date, otherwise EFalse.

@param aUseTime Use ETrue to log the time, otherwise EFalse. */

	{

	iFormatter.SetDateAndTime(aUseDate,aUseTime);

	}

EXPORT_C void RFileLogger::CreateLog(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode)

/** Creates or opens a file for logging.

When specifying a directory for logging only specify the relative path to 

'C:\\Logs\\' and do not append a '\\' to the end of the path either. CreateLog() 

only creates the specified log file if the directory exists. This means that 

switching logging on and off can be achieved without having to re-compile, 

by just removing or renaming the log directory.

aLogFile.iValid is set according to whether logging will actually occur or not. 

@param aDir The directory relative to 'C:\\Logs\\' where the log file resides 

or is to be created.

@param aName The name of the log file.

@param aMode The mode in which the log file should be opened, either EAppend 

or EOverwrite. */

	{

	iLogFile.Set(aDir,aName,aMode);

	TPckg<TLogFile> logFilePckg(iLogFile);

 	iLastError=SendReceive(ECreateLog, TIpcArgs( &logFilePckg));

	if (iLastError!=KErrNone && !LogSTI())

		iLogFile.SetValid(EFalse);

	}

EXPORT_C void RFileLogger::CloseLog()

/** Closes the log file, iLogFile.

This function closes the log file previously created or opened by CreateLog(). */

	{

	TPckg<TLogFile> logFilePckg(iLogFile);

 	iLastError=SendReceive(ECloseLog,TIpcArgs( &logFilePckg));

	}

EXPORT_C TBool RFileLogger::LogValid() const

/** Returns the status of the log.

@return ETrue if the log file is valid; otherwise EFalse. */

	{

	return iLogFile.Valid();

	}

EXPORT_C TInt RFileLogger::LastError() const

/** Returns the last error status that has been set.

@return This value can be set to any of the valid error codes from any of 

the functions in this class. */

	{

	return iLastError;

	}

EXPORT_C TBool RFileLogger::LogSTI() const

/** Returns patchable constant value.

@return This value specify the logging output. The default value EFalse 

cause that the logs are stored to filesystem. ETrue intorduced as in CR 1688

is used for logging using RDebug::Print */

	{

	return iLogSTI;

	}

//

// 16-bit non-static writes

//

EXPORT_C void RFileLogger::Write(const TDesC16& aText)

/** Writes a string of Unicode characters to an open log, iLogFile, if it is a valid file.

Note that the text will be converted to an 8 bit format for the log file. 

@param aText The Unicode string to write to the open log. */

	{

	if (iLogFile.Valid() || LogSTI())

		{

		TBuf8<KLogBufferSize> buf;

		iLastError=iFormatter.FormatTextToWritableBuffer(buf,aText);

		if (iLastError==KErrNone)

			DoWrite(buf);

		}

	}

EXPORT_C void RFileLogger::WriteFormat(TRefByValue<const TDesC16> aFmt,...)

/** Formats the remaining arguments of the function according to aFmt, and writes the 

result to the log, iLogFile, if it is a valid file.

The format string aFmt contains literal text, embedded with directives, for converting 

the trailing list of arguments into text. The number and type of arguments is dictated 

by the structure of the directives in aFmt.

Note that the text will be converted to an 8 bit format for the log file. 

@param aFmt The 16-bit non modifiable descriptor containing the format string. 

The TRefByValue class provides a constructor which takes a TDesC16 type. */

	{

	VA_LIST list;

	VA_START(list,aFmt);

	DoWriteFormat(aFmt,list);

	}

EXPORT_C void RFileLogger::WriteFormat(TRefByValue<const TDesC16> aFmt, VA_LIST& aList)

/** Formats the arguments pointed to by aList according to aFmt, and writes the 

result to the log, iLogFile, if it is a valid file.

The format string aFmt contains literal text, embedded with directives, 

for converting the trailing list of arguments into text. The number and type 

of arguments pointed to by aList is dictated by the structure of the directives 

in aFmt.

Note that the text will be converted to an 8 bit format for the log file. 

@param aFmt The 16-bit non modifiable descriptor containing the format string. 

The TRefByValue class provides a constructor which takes a TDesC16 type. 

@param aList A pointer to an argument list. */

	{

	DoWriteFormat(aFmt,aList);

	}

//

// 8-bit non-static writes

//

EXPORT_C void RFileLogger::Write(const TDesC8& aText)

/** Writes a string of 8-bit characters to an open log, iLogFile, if it is a valid file.

@param aText The 8-bit character string to write to the open log. */

	{

	if (iLogFile.Valid() || LogSTI())

		{

		TBuf8<KLogBufferSize> buf;

		iLastError=iFormatter.FormatTextToWritableBuffer(buf,aText);

		if (iLastError==KErrNone)

			DoWrite(buf);

		}

	}

EXPORT_C void RFileLogger::WriteFormat(TRefByValue<const TDesC8> aFmt,...)

/** Formats the remaining arguments of the function according to aFmt, and writes the 

result to the log, iLogFile, if it is a valid file.

The format string aFmt contains literal text, embedded with directives, 

for converting the trailing list of arguments into text. The number and type 

of arguments is dictated by the structure of the directives in aFmt.

@param aFmt The 8 bit non modifiable descriptor containing the format string. 

The TRefByValue class provides a constructor which takes a TDesC8 type.*/

	{

	VA_LIST list;

	VA_START(list,aFmt);

	DoWriteFormat(aFmt,list);

	}

EXPORT_C void RFileLogger::WriteFormat(TRefByValue<const TDesC8> aFmt, VA_LIST& aList)

/** Formats the arguments pointed to by aList according to aFmt, and writes the result 

to the log, iLogFile, if it is a valid file.

The format string aFmt contains literal text, embedded with directives, 

for converting the trailing list of arguments into text. The number and type 

of arguments pointed to by aList is dictated by the structure of the directives 

in aFmt.

@param aFmt The 8 bit non modifiable descriptor containing the format string. 

The TRefByValue class provides a constructor which takes a TDesC8 type. 

@param aList A pointer to an argument list. */

	{

	DoWriteFormat(aFmt,aList);

	}

//

// 16-bit static writes

//

EXPORT_C void RFileLogger::Write(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, const TDesC16& aText)

/** Writes a string of 16-bit characters to an open log.

Connects to the logging server, creates/opens the log file and write aText to it.

This is a "static write".

Note that the text will be converted to an 8 bit format for the log file. 

@param aDir The directory relative to 'C:\\Logs\\' where the log file resides.

@param aName The name of the log file.

@param aMode The mode in which the log file should be opened: either EAppend or EOverwrite.

@param aText The Unicode string to write to the log. */

	{

	RFileLogger logger;

	TInt ret=logger.Connect();

	if (ret==KErrNone)

		{

		logger.SetDateAndTime(ETrue,ETrue);

		logger.iLogFile.Set(aDir,aName,aMode);

		TBuf8<KLogBufferSize> buf;

		ret=logger.iFormatter.FormatTextToWritableBuffer(buf,aText);

		if (ret==KErrNone)

			{

			if (logger.LogSTI()) 

				{

				logger.DoStaticWrite(buf);

				} else 

					{

					TPckg<TLogFile> logFilePckg(logger.iLogFile);

					logger.SendReceive(ECreateWriteAndCloseLog, TIpcArgs ( &logFilePckg, &buf));		// ignore error

					}

 			}

		}

	logger.Close();

	}

EXPORT_C void RFileLogger::WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC16> aFmt,...)

/** Formats the remaining arguments of the function according to aFmt and writes the 

result to the log.

The format string aFmt contains literal text, embedded with directives, 

for converting the trailing list of arguments into text. The number and type 

of arguments is dictated by the structure of the directives in aFmt.

Connects to the logging server, creates/opens the log file and writes the text arguments to it.

This is a "static write".

Note that the text will be converted to an 8 bit format for the log file.

@param aDir The directory relative to 'C:\\Logs\\' where the log file resides.

@param aName The name of the log file.

@param aMode The mode in which the log file should be opened: either EAppend 

or EOverwrite.

@param aFmt The 16 bit non modifiable descriptor containing the format string. 

The TRefByValue class provides a constructor which takes a TDesC16 type. */

	{

	VA_LIST list;

	VA_START(list,aFmt);

	DoStaticWriteFormat(aDir,aName,aMode,aFmt,list);

	}

EXPORT_C void RFileLogger::WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC16> aFmt, VA_LIST& aList)

/** Formats the arguments pointed to by aList according to aFmt, and writes the result 

to the log.

The format string aFmt contains literal text, embedded with directives, 

for converting the trailing list of arguments into text. The number and type 

of arguments pointed to by aList is dictated by the structure of the directives 

in aFmt.

Connects to the logging server, creates/opens the log file and writes the text arguments to it.

This is a "static write".

Note that the text will be converted to an 8 bit format for the log file. 

@param aDir The directory relative to 'C:\\Logs\\' where the log file resides.

@param aName The name of the log file.

@param aMode The mode in which the log file should be opened: either EAppend 

or EOverwrite.

@param aFmt The 16 bit non modifiable descriptor containing the format string. 

The TRefByValue class provides a constructor which takes a TDesC16 type. 

@param aList A pointer to an argument list. */

	{

	DoStaticWriteFormat(aDir,aName,aMode,aFmt,aList);

	}

//

// 8-bit static writes

//

EXPORT_C void RFileLogger::Write(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, const TDesC8& aText)

/** Writes a string of 8-bit characters to an open log.

Connects to the logging server, creates/opens the log file and writes aText to it.

This is a "static write".

@param aDir The directory relative to 'C:\\Logs\\' where the log file resides.

@param aName The name of the log file.

@param aMode The mode in which the log file should be opened: either EAppend 

or EOverwrite.

@param aText The 8-bit string to write to the log. */

	{

	RFileLogger logger;

	TInt ret=logger.Connect();

	if (ret==KErrNone)

		{

		logger.SetDateAndTime(ETrue,ETrue);

		logger.iLogFile.Set(aDir,aName,aMode);

//		TBuf8<KLogBufferSize> buf;

		TBuf8<1600> buf; //Want at least an mtu sized buffer

		//PG 14/08/2002 - If mode is set to *Raw, Don't change format of client buffer

		if(aMode == EFileLoggingModeAppendRaw || aMode == EFileLoggingModeOverwriteRaw)

            {

            TPtrC8 ptr8;

            if (logger.LogSTI()) 

                {

                ptr8.Set(aText.Left(KLogBufferSize)); //in LogSTI mode, truncate to KLogBufferSize

                }

            else

                {

                ptr8.Set(aText.Left(1600)); // truncate to 1600

                }

            buf.Copy(ptr8);

            }

		else

            {

			ret=logger.iFormatter.FormatTextToWritableBuffer(buf,aText);

            }

		if (ret==KErrNone)

            {

			logger.DoStaticWrite(buf);

            }

		}

	logger.Close();

	}

EXPORT_C void RFileLogger::WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC8> aFmt,...)

/** Formats the remaining arguments of the function according to aFmt and writes the 

result to the log.

The format string aFmt contains literal text, embedded with directives, 

for converting the trailing list of arguments into text. The number and type 

of arguments is dictated by the structure of the directives in aFmt.

Connects to the logging server, creates/opens the log file and writes the text arguments to it.

This is a "static write".

@param aDir The directory relative to 'C:\\Logs\\' where the log file resides.

@param aName The name of the log file.

@param aMode The mode in which the log file should be opened: either EAppend 

or EOverwrite.

@param aFmt The 8 bit non modifiable descriptor containing the format string. 

The TRefByValue class provides a constructor which takes a TDesC8 type. */

	{

	VA_LIST list;

	VA_START(list,aFmt);

	DoStaticWriteFormat(aDir,aName,aMode,aFmt,list);

	}

EXPORT_C void RFileLogger::WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC8> aFmt, VA_LIST& aList)

/** Formats the arguments pointed to by aList according to aFmt, and writes the 

result to the log.

The format string aFmt contains literal text, embedded with directives, 

for converting the trailing list of arguments into text. The number and type 

of arguments pointed to by aList is dictated by the structure of the directives 

in aFmt.

Connects to the logging server, creates/opens the log file and writes the text arguments to it.

This is a "static write".

@param aDir The directory relative to 'C:\\Logs\\' where the log file resides.

@param aName The name of the log file.

@param aMode The mode in which the log file should be opened: either EAppend 

or EOverwrite.

@param aFmt The 8 bit non modifiable descriptor containing the format string. 

The TRefByValue class provides a constructor which takes a TDesC8 type. 

@param aList A pointer to an argument list. */

	{

	DoStaticWriteFormat(aDir,aName,aMode,aFmt,aList);

	}

//

// Hex Dumps

//

EXPORT_C void RFileLogger::HexDump(const TText* aHeader, const TText* aMargin, const TUint8* aPtr, TInt aLen)

/** Writes a hex dump of the specified data to the log.

The format of the hex dump entry is a header followed by the hex string of 

the data followed by any printable characters (non printable characters are 

substituted with '.'). For example,

@code

RLog_Ex0000 : 41 42 6C 6B 0A 0A 45 46 20 20 78 7A                       ABlk..EF 

 xz

RL_cont0001 : 43 44 6C 6B 0A 0A 45 46 20 20 78 7A                       CDlk..EF 

 xz

RL_cont0002 : 45 46 6C 6B 0A 0A 47 48 20 20 78 7A                       EFlk..GH 

 xz

.

.

.

@endcode

@param aHeader A label for the hex dump entry. The label has a sequence number 

appended to it automatically.

@param aMargin A continuation label if the hex dump exceeds one line. This 

label is displayed on all subsequent lines after line one and also has a sequence 

number appended to it.

@param aPtr The data that is to be converted to a hex string.