sl@0: // Copyright (c) 1997-2010 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:  @file
sl@0: */
sl@0: 
sl@0: #include <f32file.h>
sl@0: #include <flogger.h>
sl@0: #include "FLOGSTD.H"
sl@0: 
sl@0: /** 
sl@0: Macro for Single blank space.
sl@0: 
sl@0: */
sl@0: #define BLANK	_S("")
sl@0: 
sl@0: const TInt KHexDumpWidth=16;
sl@0: 
sl@0: /**
sl@0: Literal constant that hold a string and unicode hex.
sl@0: 
sl@0: */
sl@0: _LIT(KFirstFormatString,"%s%04x : ");
sl@0: 
sl@0: /**
sl@0: Literal constant that hold a string and unicode hex.
sl@0: 
sl@0: */
sl@0: _LIT(KSecondFormatString,"%02x ");
sl@0: 
sl@0: /**
sl@0: Character Constant.
sl@0: 
sl@0: */
sl@0: _LIT(KThirdFormatString,"%c");
sl@0: 
sl@0: /** 
sl@0: Literal Constant for 3 blank spaces. 
sl@0: 
sl@0: */
sl@0: _LIT(KThreeSpaces,"   ");
sl@0: 
sl@0: /** 
sl@0: Literal Constant for 2 blank spaces. 
sl@0: 
sl@0: */
sl@0: _LIT(KTwoSpaces," ");
sl@0: 
sl@0: 
sl@0: IMPORT_C extern const TBool KFloggerSTI;
sl@0: 
sl@0: /*
sl@0: RFileLogger class definition
sl@0: */
sl@0: 
sl@0: EXPORT_C RFileLogger::RFileLogger() 
sl@0: 	: RSessionBase(), iFormatter(), iLastError(KErrNone), iLogSTI(KFloggerSTI)
sl@0: /** Creates a default RFileLogger object. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C RFileLogger::~RFileLogger()
sl@0: /** Empty destructor. 
sl@0: Clients with open sessions must end the session by calling Close() beforehand.
sl@0: Note that it does not delete the log file.*/
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C TVersion RFileLogger::Version() const
sl@0: /** Returns the version number.
sl@0: 
sl@0: @return The version number. */
sl@0: 	{
sl@0: 
sl@0: 	return(TVersion(KFLogSrvMajorVersionNumber,KFLogSrvMinorVersionNumber,KFLogSrvBuildVersionNumber));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt RFileLogger::Connect()
sl@0: /** Connects to the file logger server with the default number of message slots, which is 8.
sl@0: 
sl@0: This function does not need to be called if you are using the static versions 
sl@0: of Write(), WriteFormat() or HexDump().
sl@0: 
sl@0: @return KErrNone if successful, otherwise one of the system-wide error codes. */
sl@0: 	{
sl@0: 
sl@0: 	TInt ret=DoConnect();
sl@0: 	if (ret==KErrNotFound)
sl@0: 		{
sl@0: 		ret=FLogger::Start();
sl@0: 		if (ret==KErrNone || ret==KErrAlreadyExists)
sl@0: 			ret=DoConnect();
sl@0: 		}
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RFileLogger::SetDateAndTime(TBool aUseDate,TBool aUseTime)
sl@0: /** Specifies whether time and/or date should be appended to log data.
sl@0: 
sl@0: Appending of the time and date to log entries can be switched on and off 
sl@0: at anytime between creation and destruction of RFileLogger.
sl@0: 
sl@0: This function does not need to be called if you are using the static versions 
sl@0: of Write(), WriteFormat() or HexDump().
sl@0: 
sl@0: @param aUseDate Use ETrue to log the date, otherwise EFalse.
sl@0: @param aUseTime Use ETrue to log the time, otherwise EFalse. */
sl@0: 	{
sl@0: 
sl@0: 	iFormatter.SetDateAndTime(aUseDate,aUseTime);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RFileLogger::CreateLog(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode)
sl@0: /** Creates or opens a file for logging.
sl@0: 
sl@0: When specifying a directory for logging only specify the relative path to 
sl@0: 'C:\\Logs\\' and do not append a '\\' to the end of the path either. CreateLog() 
sl@0: only creates the specified log file if the directory exists. This means that 
sl@0: switching logging on and off can be achieved without having to re-compile, 
sl@0: by just removing or renaming the log directory.
sl@0: 
sl@0: aLogFile.iValid is set according to whether logging will actually occur or not. 
sl@0: 
sl@0: @param aDir The directory relative to 'C:\\Logs\\' where the log file resides 
sl@0: or is to be created.
sl@0: @param aName The name of the log file.
sl@0: @param aMode The mode in which the log file should be opened, either EAppend 
sl@0: or EOverwrite. */
sl@0: 	{
sl@0: 
sl@0: 	iLogFile.Set(aDir,aName,aMode);
sl@0: 	TPckg<TLogFile> logFilePckg(iLogFile);
sl@0:  	iLastError=SendReceive(ECreateLog, TIpcArgs( &logFilePckg));
sl@0: 
sl@0: 	if (iLastError!=KErrNone && !LogSTI())
sl@0: 		iLogFile.SetValid(EFalse);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RFileLogger::CloseLog()
sl@0: /** Closes the log file, iLogFile.
sl@0: 
sl@0: This function closes the log file previously created or opened by CreateLog(). */
sl@0: 	{
sl@0: 	TPckg<TLogFile> logFilePckg(iLogFile);
sl@0:  	iLastError=SendReceive(ECloseLog,TIpcArgs( &logFilePckg));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool RFileLogger::LogValid() const
sl@0: /** Returns the status of the log.
sl@0: 
sl@0: @return ETrue if the log file is valid; otherwise EFalse. */
sl@0: 	{
sl@0: 
sl@0: 	return iLogFile.Valid();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt RFileLogger::LastError() const
sl@0: /** Returns the last error status that has been set.
sl@0: 
sl@0: @return This value can be set to any of the valid error codes from any of 
sl@0: the functions in this class. */
sl@0: 	{
sl@0: 
sl@0: 	return iLastError;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool RFileLogger::LogSTI() const
sl@0: /** Returns patchable constant value.
sl@0: 
sl@0: @return This value specify the logging output. The default value EFalse 
sl@0: cause that the logs are stored to filesystem. ETrue intorduced as in CR 1688
sl@0: is used for logging using RDebug::Print */
sl@0: 	{
sl@0: 
sl@0: 	return iLogSTI;
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // 16-bit non-static writes
sl@0: //
sl@0: 
sl@0: EXPORT_C void RFileLogger::Write(const TDesC16& aText)
sl@0: /** Writes a string of Unicode characters to an open log, iLogFile, if it is a valid file.
sl@0: 
sl@0: Note that the text will be converted to an 8 bit format for the log file. 
sl@0: 
sl@0: @param aText The Unicode string to write to the open log. */
sl@0: 	{
sl@0: 
sl@0: 	if (iLogFile.Valid() || LogSTI())
sl@0: 		{
sl@0: 		TBuf8<KLogBufferSize> buf;
sl@0: 		iLastError=iFormatter.FormatTextToWritableBuffer(buf,aText);
sl@0: 		if (iLastError==KErrNone)
sl@0: 			DoWrite(buf);
sl@0: 		}
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C void RFileLogger::WriteFormat(TRefByValue<const TDesC16> aFmt,...)
sl@0: /** Formats the remaining arguments of the function according to aFmt, and writes the 
sl@0: result to the log, iLogFile, if it is a valid file.
sl@0: 
sl@0: The format string aFmt contains literal text, embedded with directives, for converting 
sl@0: the trailing list of arguments into text. The number and type of arguments is dictated 
sl@0: by the structure of the directives in aFmt.
sl@0: 
sl@0: Note that the text will be converted to an 8 bit format for the log file. 
sl@0: 
sl@0: @param aFmt The 16-bit non modifiable descriptor containing the format string. 
sl@0: The TRefByValue class provides a constructor which takes a TDesC16 type. */
sl@0: 	{
sl@0: 
sl@0: 	VA_LIST list;
sl@0: 	VA_START(list,aFmt);
sl@0: 	DoWriteFormat(aFmt,list);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RFileLogger::WriteFormat(TRefByValue<const TDesC16> aFmt, VA_LIST& aList)
sl@0: /** Formats the arguments pointed to by aList according to aFmt, and writes the 
sl@0: result to the log, iLogFile, if it is a valid file.
sl@0: 
sl@0: The format string aFmt contains literal text, embedded with directives, 
sl@0: for converting the trailing list of arguments into text. The number and type 
sl@0: of arguments pointed to by aList is dictated by the structure of the directives 
sl@0: in aFmt.
sl@0: 
sl@0: Note that the text will be converted to an 8 bit format for the log file. 
sl@0: 
sl@0: @param aFmt The 16-bit non modifiable descriptor containing the format string. 
sl@0: The TRefByValue class provides a constructor which takes a TDesC16 type. 
sl@0: @param aList A pointer to an argument list. */
sl@0: 	{
sl@0: 
sl@0: 	DoWriteFormat(aFmt,aList);
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // 8-bit non-static writes
sl@0: //
sl@0: 
sl@0: EXPORT_C void RFileLogger::Write(const TDesC8& aText)
sl@0: /** Writes a string of 8-bit characters to an open log, iLogFile, if it is a valid file.
sl@0: 
sl@0: @param aText The 8-bit character string to write to the open log. */
sl@0: 	{
sl@0: 
sl@0: 	if (iLogFile.Valid() || LogSTI())
sl@0: 		{
sl@0: 		TBuf8<KLogBufferSize> buf;
sl@0: 		iLastError=iFormatter.FormatTextToWritableBuffer(buf,aText);
sl@0: 		if (iLastError==KErrNone)
sl@0: 			DoWrite(buf);
sl@0: 		}
sl@0: 	}
sl@0: 	
sl@0: EXPORT_C void RFileLogger::WriteFormat(TRefByValue<const TDesC8> aFmt,...)
sl@0: /** Formats the remaining arguments of the function according to aFmt, and writes the 
sl@0: result to the log, iLogFile, if it is a valid file.
sl@0: 
sl@0: The format string aFmt contains literal text, embedded with directives, 
sl@0: for converting the trailing list of arguments into text. The number and type 
sl@0: of arguments is dictated by the structure of the directives in aFmt.
sl@0: 
sl@0: @param aFmt The 8 bit non modifiable descriptor containing the format string. 
sl@0: The TRefByValue class provides a constructor which takes a TDesC8 type.*/
sl@0: 	{
sl@0: 
sl@0: 	VA_LIST list;
sl@0: 	VA_START(list,aFmt);
sl@0: 	DoWriteFormat(aFmt,list);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RFileLogger::WriteFormat(TRefByValue<const TDesC8> aFmt, VA_LIST& aList)
sl@0: /** Formats the arguments pointed to by aList according to aFmt, and writes the result 
sl@0: to the log, iLogFile, if it is a valid file.
sl@0: 
sl@0: The format string aFmt contains literal text, embedded with directives, 
sl@0: for converting the trailing list of arguments into text. The number and type 
sl@0: of arguments pointed to by aList is dictated by the structure of the directives 
sl@0: in aFmt.
sl@0: 
sl@0: @param aFmt The 8 bit non modifiable descriptor containing the format string. 
sl@0: The TRefByValue class provides a constructor which takes a TDesC8 type. 
sl@0: @param aList A pointer to an argument list. */
sl@0: 	{
sl@0: 
sl@0: 	DoWriteFormat(aFmt,aList);
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // 16-bit static writes
sl@0: //
sl@0: 
sl@0: EXPORT_C void RFileLogger::Write(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, const TDesC16& aText)
sl@0: /** Writes a string of 16-bit characters to an open log.
sl@0: 
sl@0: Connects to the logging server, creates/opens the log file and write aText to it.
sl@0: 
sl@0: This is a "static write".
sl@0: 
sl@0: Note that the text will be converted to an 8 bit format for the log file. 
sl@0: 
sl@0: @param aDir The directory relative to 'C:\\Logs\\' where the log file resides.
sl@0: @param aName The name of the log file.
sl@0: @param aMode The mode in which the log file should be opened: either EAppend or EOverwrite.
sl@0: @param aText The Unicode string to write to the log. */
sl@0: 	{
sl@0: 
sl@0: 	RFileLogger logger;
sl@0: 	TInt ret=logger.Connect();
sl@0: 	if (ret==KErrNone)
sl@0: 		{
sl@0: 		logger.SetDateAndTime(ETrue,ETrue);
sl@0: 		logger.iLogFile.Set(aDir,aName,aMode);
sl@0: 		TBuf8<KLogBufferSize> buf;
sl@0: 		ret=logger.iFormatter.FormatTextToWritableBuffer(buf,aText);
sl@0: 		if (ret==KErrNone)
sl@0: 			{
sl@0: 			if (logger.LogSTI()) 
sl@0: 				{
sl@0: 				logger.DoStaticWrite(buf);
sl@0: 				} else 
sl@0: 					{
sl@0: 					TPckg<TLogFile> logFilePckg(logger.iLogFile);
sl@0: 					logger.SendReceive(ECreateWriteAndCloseLog, TIpcArgs ( &logFilePckg, &buf));		// ignore error
sl@0: 					}
sl@0:  			}
sl@0: 		}
sl@0: 	logger.Close();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RFileLogger::WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC16> aFmt,...)
sl@0: /** Formats the remaining arguments of the function according to aFmt and writes the 
sl@0: result to the log.
sl@0: 
sl@0: The format string aFmt contains literal text, embedded with directives, 
sl@0: for converting the trailing list of arguments into text. The number and type 
sl@0: of arguments is dictated by the structure of the directives in aFmt.
sl@0: 
sl@0: Connects to the logging server, creates/opens the log file and writes the text arguments to it.
sl@0: 
sl@0: This is a "static write".
sl@0: 
sl@0: Note that the text will be converted to an 8 bit format for the log file.
sl@0: 
sl@0: @param aDir The directory relative to 'C:\\Logs\\' where the log file resides.
sl@0: @param aName The name of the log file.
sl@0: @param aMode The mode in which the log file should be opened: either EAppend 
sl@0: or EOverwrite.
sl@0: @param aFmt The 16 bit non modifiable descriptor containing the format string. 
sl@0: The TRefByValue class provides a constructor which takes a TDesC16 type. */
sl@0: 	{
sl@0: 	
sl@0: 	VA_LIST list;
sl@0: 	VA_START(list,aFmt);
sl@0: 	DoStaticWriteFormat(aDir,aName,aMode,aFmt,list);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RFileLogger::WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC16> aFmt, VA_LIST& aList)
sl@0: /** Formats the arguments pointed to by aList according to aFmt, and writes the result 
sl@0: to the log.
sl@0: 
sl@0: The format string aFmt contains literal text, embedded with directives, 
sl@0: for converting the trailing list of arguments into text. The number and type 
sl@0: of arguments pointed to by aList is dictated by the structure of the directives 
sl@0: in aFmt.
sl@0: 
sl@0: Connects to the logging server, creates/opens the log file and writes the text arguments to it.
sl@0: 
sl@0: This is a "static write".
sl@0: 
sl@0: Note that the text will be converted to an 8 bit format for the log file. 
sl@0: 
sl@0: @param aDir The directory relative to 'C:\\Logs\\' where the log file resides.
sl@0: @param aName The name of the log file.
sl@0: @param aMode The mode in which the log file should be opened: either EAppend 
sl@0: or EOverwrite.
sl@0: @param aFmt The 16 bit non modifiable descriptor containing the format string. 
sl@0: The TRefByValue class provides a constructor which takes a TDesC16 type. 
sl@0: @param aList A pointer to an argument list. */
sl@0: 	{
sl@0: 
sl@0: 	DoStaticWriteFormat(aDir,aName,aMode,aFmt,aList);
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // 8-bit static writes
sl@0: //
sl@0: 
sl@0: EXPORT_C void RFileLogger::Write(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, const TDesC8& aText)
sl@0: /** Writes a string of 8-bit characters to an open log.
sl@0: 
sl@0: Connects to the logging server, creates/opens the log file and writes aText to it.
sl@0: 
sl@0: This is a "static write".
sl@0: 
sl@0: @param aDir The directory relative to 'C:\\Logs\\' where the log file resides.
sl@0: @param aName The name of the log file.
sl@0: @param aMode The mode in which the log file should be opened: either EAppend 
sl@0: or EOverwrite.
sl@0: @param aText The 8-bit string to write to the log. */
sl@0: 
sl@0: 	{
sl@0: 
sl@0: 	RFileLogger logger;
sl@0: 	TInt ret=logger.Connect();
sl@0: 	if (ret==KErrNone)
sl@0: 		{
sl@0: 		logger.SetDateAndTime(ETrue,ETrue);
sl@0: 		logger.iLogFile.Set(aDir,aName,aMode);
sl@0: //		TBuf8<KLogBufferSize> buf;
sl@0: 		TBuf8<1600> buf; //Want at least an mtu sized buffer
sl@0: 		//PG 14/08/2002 - If mode is set to *Raw, Don't change format of client buffer
sl@0: 		if(aMode == EFileLoggingModeAppendRaw || aMode == EFileLoggingModeOverwriteRaw)
sl@0:             {
sl@0:             TPtrC8 ptr8;
sl@0:             if (logger.LogSTI()) 
sl@0:                 {
sl@0:                 ptr8.Set(aText.Left(KLogBufferSize)); //in LogSTI mode, truncate to KLogBufferSize
sl@0:                 }
sl@0:             else
sl@0:                 {
sl@0:                 ptr8.Set(aText.Left(1600)); // truncate to 1600
sl@0:                 }
sl@0:             buf.Copy(ptr8);
sl@0:             }
sl@0: 		else
sl@0:             {
sl@0: 			ret=logger.iFormatter.FormatTextToWritableBuffer(buf,aText);
sl@0:             }
sl@0: 		if (ret==KErrNone)
sl@0:             {
sl@0: 			logger.DoStaticWrite(buf);
sl@0:             }
sl@0: 		}
sl@0: 	logger.Close();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RFileLogger::WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC8> aFmt,...)
sl@0: /** Formats the remaining arguments of the function according to aFmt and writes the 
sl@0: result to the log.
sl@0: 
sl@0: The format string aFmt contains literal text, embedded with directives, 
sl@0: for converting the trailing list of arguments into text. The number and type 
sl@0: of arguments is dictated by the structure of the directives in aFmt.
sl@0: 
sl@0: Connects to the logging server, creates/opens the log file and writes the text arguments to it.
sl@0: 
sl@0: This is a "static write".
sl@0: 
sl@0: @param aDir The directory relative to 'C:\\Logs\\' where the log file resides.
sl@0: @param aName The name of the log file.
sl@0: @param aMode The mode in which the log file should be opened: either EAppend 
sl@0: or EOverwrite.
sl@0: @param aFmt The 8 bit non modifiable descriptor containing the format string. 
sl@0: The TRefByValue class provides a constructor which takes a TDesC8 type. */
sl@0: 	{
sl@0: 	
sl@0: 	VA_LIST list;
sl@0: 	VA_START(list,aFmt);
sl@0: 	DoStaticWriteFormat(aDir,aName,aMode,aFmt,list);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RFileLogger::WriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC8> aFmt, VA_LIST& aList)
sl@0: /** Formats the arguments pointed to by aList according to aFmt, and writes the 
sl@0: result to the log.
sl@0: 
sl@0: The format string aFmt contains literal text, embedded with directives, 
sl@0: for converting the trailing list of arguments into text. The number and type 
sl@0: of arguments pointed to by aList is dictated by the structure of the directives 
sl@0: in aFmt.
sl@0: 
sl@0: Connects to the logging server, creates/opens the log file and writes the text arguments to it.
sl@0: 
sl@0: This is a "static write".
sl@0: 
sl@0: @param aDir The directory relative to 'C:\\Logs\\' where the log file resides.
sl@0: @param aName The name of the log file.
sl@0: @param aMode The mode in which the log file should be opened: either EAppend 
sl@0: or EOverwrite.
sl@0: @param aFmt The 8 bit non modifiable descriptor containing the format string. 
sl@0: The TRefByValue class provides a constructor which takes a TDesC8 type. 
sl@0: @param aList A pointer to an argument list. */
sl@0: 	{
sl@0: 
sl@0: 	DoStaticWriteFormat(aDir,aName,aMode,aFmt,aList);
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // Hex Dumps
sl@0: //
sl@0: 
sl@0: EXPORT_C void RFileLogger::HexDump(const TText* aHeader, const TText* aMargin, const TUint8* aPtr, TInt aLen)
sl@0: /** Writes a hex dump of the specified data to the log.
sl@0: 
sl@0: The format of the hex dump entry is a header followed by the hex string of 
sl@0: the data followed by any printable characters (non printable characters are 
sl@0: substituted with '.'). For example,
sl@0: 
sl@0: @code
sl@0: RLog_Ex0000 : 41 42 6C 6B 0A 0A 45 46 20 20 78 7A                       ABlk..EF 
sl@0:  xz
sl@0: RL_cont0001 : 43 44 6C 6B 0A 0A 45 46 20 20 78 7A                       CDlk..EF 
sl@0:  xz
sl@0: RL_cont0002 : 45 46 6C 6B 0A 0A 47 48 20 20 78 7A                       EFlk..GH 
sl@0:  xz
sl@0: .
sl@0: .
sl@0: .
sl@0: @endcode
sl@0: @param aHeader A label for the hex dump entry. The label has a sequence number 
sl@0: appended to it automatically.
sl@0: @param aMargin A continuation label if the hex dump exceeds one line. This 
sl@0: label is displayed on all subsequent lines after line one and also has a sequence 
sl@0: number appended to it.
sl@0: @param aPtr The data that is to be converted to a hex string.
sl@0: @param aLen How many of the characters in aPtr are to be converted. Conversion 
sl@0: always starts from position 0 within aPtr. */
sl@0: 	{
sl@0: 	
sl@0: 	if (iLogFile.Valid() || LogSTI())
sl@0: 		DoHexDump(aHeader,aMargin,aPtr,aLen);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RFileLogger::HexDump(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, const TText* aHeader, const TText* aMargin, const TUint8* aPtr, TInt aLen)
sl@0: /** Writes a hex dump of the specified data to the log.
sl@0: 
sl@0: The format of the hex dump entry is a header followed by the hex string of 
sl@0: the data followed by any printable characters (non printable characters are 
sl@0: substituted with '.'). For example,
sl@0: 
sl@0: @code
sl@0: RLog_Ex0000 : 41 42 6C 6B 0A 0A 45 46 20 20 78 7A                       ABlk..EF 
sl@0:  xz
sl@0: RL_cont0001 : 43 44 6C 6B 0A 0A 45 46 20 20 78 7A                       CDlk..EF 
sl@0:  xz
sl@0: RL_cont0002 : 45 46 6C 6B 0A 0A 47 48 20 20 78 7A                       EFlk..GH 
sl@0:  xz
sl@0: .
sl@0: .
sl@0: .
sl@0: @endcode
sl@0: 
sl@0: 
sl@0: @param aDir The directory relative to 'C:\\Logs\\' where the log file resides.
sl@0: @param aName The name of the log file.
sl@0: @param aMode The mode in which the log file should be opened: either EAppend 
sl@0: or EOverwrite.
sl@0: @param aHeader A label for the hex dump entry. The label has a sequence number 
sl@0: appended to it automatically.
sl@0: @param aMargin A continuation label if the hex dump exceeds one line. This 
sl@0: label is displayed on all subsequent lines after line one and also has a sequence 
sl@0: number appended to it.
sl@0: @param aPtr The data that is to be converted to a hex string.
sl@0: @param aLen How many of the characters in aPtr are to be converted. Conversion 
sl@0: always starts from position 0 within aPtr. */
sl@0: 	{
sl@0: 
sl@0: 	RFileLogger logger;
sl@0: 	TInt ret=logger.Connect();
sl@0: 	if (ret==KErrNone)
sl@0: 		{
sl@0: 		logger.CreateLog(aDir,aName,aMode);
sl@0: 		if (logger.iLogFile.Valid())
sl@0: 			{
sl@0: 			logger.SetDateAndTime(ETrue,ETrue);
sl@0: 			logger.DoHexDump(aHeader,aMargin,aPtr,aLen);
sl@0: 			}
sl@0: 		logger.CloseLog();
sl@0: 		}
sl@0: 	logger.Close();
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // Private functions
sl@0: //
sl@0: 
sl@0: TInt RFileLogger::DoConnect()
sl@0: /**
sl@0: Connects to the flogger server - default number of message slots = 8 
sl@0: 
sl@0: @return TInt indicating success code (KErrNone) or an error code.
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	return CreateSession(KFLoggerServerName,Version(),0);	// no async IPC
sl@0: 	}
sl@0: 
sl@0: void RFileLogger::DoWrite(const TDesC8& aBuf)
sl@0: /**
sl@0: Sends the pre-formatted write string to the flogger server. 
sl@0: 
sl@0: @pre
sl@0: session is already open. 
sl@0: @param aBuf  8-bit text to be written. 
sl@0: */
sl@0: 	{
sl@0: 	if (LogSTI()) 
sl@0: 		{
sl@0: 		TBuf<KLogBufferSize> n;
sl@0: 		n.Copy(aBuf);
sl@0: 		TFileName logFileName = iLogFile.Name();
sl@0: 		RDebug::Print(_L("FLG %S %S"),&logFileName,&n);
sl@0: 		} 
sl@0: 	else 		
sl@0: 		{
sl@0: 		TPckg<TLogFile> logFilePckg(iLogFile);
sl@0: 		iLastError=SendReceive(EWriteLog,TIpcArgs (&logFilePckg, &aBuf));
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void RFileLogger::DoStaticWrite(const TDesC8& aBuf)
sl@0: /**
sl@0: Sends the pre-formatted write string to the flogger server. 
sl@0: 
sl@0: @pre 
sl@0: session is already open. aText is not longer than KLogBufferSize 
sl@0: @param aBuf  text to write  
sl@0: @post
sl@0: The text is only written if the original connection was successful. 
sl@0: No text is ever written if the directory specified in the original connection request does not exist. 
sl@0: Each line is preceded in the date and time.
sl@0: */
sl@0: 	{
sl@0:  	TPckg<TLogFile> logFilePckg(iLogFile);
sl@0:  	if (LogSTI()) 
sl@0:  		{
sl@0:  	 	TBuf<KLogBufferSize> n;
sl@0:  	 	n.Copy(aBuf);
sl@0: 		TFileName logFileName = iLogFile.Name();
sl@0: 		RDebug::Print(_L("FLG %S %S"),&logFileName,&n);
sl@0:         }
sl@0:     else
sl@0:         {
sl@0:         SendReceive(ECreateWriteAndCloseLog, TIpcArgs( &logFilePckg, &aBuf));       // ignore error
sl@0:         }
sl@0: 	}		
sl@0: 
sl@0: void RFileLogger::DoWriteFormat(TRefByValue<const TDesC16> aFmt, VA_LIST& aList)
sl@0: /**
sl@0: Trim format string before sending to the flogger server. 
sl@0: 
sl@0: @pre
sl@0: session is already open. 
sl@0: @param aFmt  c-style formatted text to be written.  
sl@0: @param aList  any variables required by the format.  
sl@0: @post
sl@0: The final string is truncated to KLogBufferSize.
sl@0: @see void RFileLogger::DoWriteFormat(TRefByValue<const TDesC8> aFmt, VA_LIST& aList)
sl@0: */
sl@0: 	{		
sl@0: 
sl@0: 	if (iLogFile.Valid() || LogSTI())
sl@0: 		{
sl@0: 		TBuf8<KLogBufferSize> buf;
sl@0: 		iLastError=iFormatter.ConvertToWritableBuffer(buf,aFmt,aList);
sl@0: 		if (iLastError==KErrNone)
sl@0: 			DoWrite(buf);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void RFileLogger::DoWriteFormat(TRefByValue<const TDesC8> aFmt, VA_LIST& aList)
sl@0: /**
sl@0: Trim format string before sending to the flogger server. 
sl@0: 
sl@0: @pre
sl@0: session is already open. 
sl@0: @param aFmt  c-style formatted text to be written.  
sl@0: @param aList  any variables required by the format.  
sl@0: @post
sl@0: The final string is truncated to KLogBufferSize.
sl@0: */
sl@0: 	{		
sl@0: 
sl@0: 	if (iLogFile.Valid() || LogSTI())
sl@0: 		{
sl@0: 		TBuf8<KLogBufferSize> buf;
sl@0: 		iLastError=iFormatter.ConvertToWritableBuffer(buf,aFmt,aList);
sl@0: 		if (iLastError==KErrNone)
sl@0: 			DoWrite(buf);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void RFileLogger::DoStaticWriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC> aFmt, VA_LIST& aList)
sl@0: /**
sl@0: Sends a format write string to the flogger server to write to the specified file.
sl@0: 
sl@0: @param aDir Path of the log file.
sl@0: @param aName Name of the log file.
sl@0: @param aFmt  c-style formatted text to be written.  
sl@0: @param aList  any variables required by the format.  
sl@0: @post
sl@0: The text is only written if the original connection was successful. 
sl@0: No text is ever written if the directory specified in the original connection request does not exist. 
sl@0: Each line is preceded in the date and time.
sl@0: @see void RFileLogger::DoStaticWriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC8> aFmt, VA_LIST& aList)
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	RFileLogger logger;
sl@0: 	TInt ret=logger.Connect();
sl@0: 	if (ret==KErrNone)
sl@0: 		{
sl@0: 		logger.SetDateAndTime(ETrue,ETrue);
sl@0: 		logger.iLogFile.Set(aDir,aName,aMode);
sl@0: 		TBuf8<KLogBufferSize> buf;
sl@0: 		ret=logger.iFormatter.ConvertToWritableBuffer(buf,aFmt,aList);
sl@0: 		if (ret==KErrNone)
sl@0: 			logger.DoStaticWrite(buf);
sl@0: 		}
sl@0: 	logger.Close();
sl@0: 	}
sl@0: 
sl@0: void RFileLogger::DoStaticWriteFormat(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode, TRefByValue<const TDesC8> aFmt, VA_LIST& aList)
sl@0: /**
sl@0: Sends a format write string to the flogger server to write to the specified file.
sl@0: There is no pre-condition.
sl@0: 
sl@0: @param aDir Path of the log file.
sl@0: @param aName Name of the log file.
sl@0: @param aFmt  c-style formatted text to be written.  
sl@0: @param aList  any variables required by the format.  
sl@0: @post 
sl@0: The text is only written if the original connection was successful. 
sl@0: No text is ever written if the directory specified in the original 
sl@0: connection request does not exist. Each line is preceded in the date and time.
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	RFileLogger logger;
sl@0: 	TInt ret=logger.Connect();
sl@0: 	if (ret==KErrNone)
sl@0: 		{
sl@0: 		logger.SetDateAndTime(ETrue,ETrue);
sl@0: 		logger.iLogFile.Set(aDir,aName,aMode);
sl@0: 		TBuf8<KLogBufferSize> buf;
sl@0: 		ret=logger.iFormatter.ConvertToWritableBuffer(buf,aFmt,aList);
sl@0: 		if (ret==KErrNone)
sl@0: 			logger.DoStaticWrite(buf);
sl@0: 		}
sl@0: 	logger.Close();
sl@0: 	}
sl@0: 
sl@0: void RFileLogger::DoHexDump(const TText* aHeader, const TText* aMargin, const TUint8* aPtr, TInt aLen)
sl@0: /**
sl@0: Static Write. Dumps arbitrary data to the log file as a standard hex dump. 
sl@0: 
sl@0: @pre 
sl@0: session is already open. 
sl@0: @param aHeader  Specify a string to be printed before the first hex line. 
sl@0: Leave as null or an empty string for no header.  
sl@0: @param aMargin  Specify a string to be printed before each subsequent line. 
sl@0: Leave as null or an empty string for no Margin.  
sl@0: @param aPtr  pointer to the data being dumped.  
sl@0: @param aLen  the number of bytes to dump  
sl@0: @post
sl@0: The text is only written if the original connection was successful. 
sl@0: No text is ever written if the directory specified in the original connection
sl@0: request does not exist. Each line is preceded in the date and time. 
sl@0: @note This function has poor performance since it performs a full connection and 
sl@0: disconnection to the flogger server. Example of aHeader/aMargin. 
sl@0: If "aHeader" is set to "Fn Output:" and "aMargin" is set to " ", then output 
sl@0: would look like (for a print of the alphabet):
sl@0: 14/11/2002	12:32:24	 Fn Output:0000 : 61 62 63 64 65 66 67 68 69 6a 6b 6c 6d 6e 6f 70 abcdefghijklmnop 
sl@0: 14/11/2002	12:32:24	  	   0010 : 71 72 73 74 75 76 77 78 79 7a qrstuvwxyz
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	if (aPtr==NULL)		// nothing to do
sl@0: 		return;
sl@0: 
sl@0: 	TBuf<KLogBufferSize> buf;
sl@0: 	TBuf8<KLogBufferSize> temp;
sl@0: 	TInt i=0;
sl@0: 	const TText* p=aHeader;
sl@0: 	while (aLen>0)
sl@0: 		{
sl@0: 		if (p==NULL)
sl@0: 			p=BLANK;	// if NULL set p to a blank string
sl@0: 		TInt n=(aLen>KHexDumpWidth ? KHexDumpWidth : aLen);
sl@0: 		buf.AppendFormat(KFirstFormatString,p,i);
sl@0: 		TInt j;
sl@0: 		for (j=0; j<n; j++)
sl@0: 			buf.AppendFormat(KSecondFormatString,aPtr[i+j]);
sl@0: 		while (j++<KHexDumpWidth)
sl@0: 			buf.Append(KThreeSpaces);
sl@0: 		buf.Append(KTwoSpaces);
sl@0: 		for (j=0; j<n; j++)
sl@0: 			buf.AppendFormat(KThirdFormatString,(aPtr[i+j]<32 || aPtr[i+j]>126) ? KFullStopChar : aPtr[i+j]);
sl@0: 		
sl@0: 		iLastError=iFormatter.FormatTextToWritableBuffer(temp,buf);
sl@0: 		if (iLastError==KErrNone)
sl@0: 			DoWrite(temp);
sl@0: 		
sl@0: 		buf.SetLength(0);
sl@0: 		temp.SetLength(0);
sl@0: 		aLen-=n;
sl@0: 		i+=n;
sl@0: 		p=aMargin;
sl@0: 		}
sl@0: 	}
sl@0: