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: //
sl@0: 
sl@0: /**
sl@0:  @file
sl@0: */
sl@0: 
sl@0: #include <utf.h>
sl@0: #include <flogger.h>
sl@0: #include "FLOGSTD.H"
sl@0: 
sl@0: /**
sl@0: 16-bit tab char width for symbian OS build.
sl@0: */
sl@0: const TText KTabChar='\t';
sl@0: 
sl@0: /**
sl@0: 8-bit FullStop char for non-unicode
sl@0: */
sl@0: const TText8 KFullStopChar8='.';
sl@0: 
sl@0: /**
sl@0: 8-bit tab char for unicode
sl@0: */
sl@0: const TText8 KTabChar8='\t';
sl@0: 
sl@0: /**
sl@0: Max length for a TBuf date or time variable.
sl@0: */
sl@0: const TInt KDateOrTimeMaxLength=30;
sl@0: 
sl@0: /**
sl@0: Constructs a 8 bit constant literal descriptor for
sl@0: end of line.
sl@0: */
sl@0: _LIT8(KEndOfLineCharacters8,"\r\n");
sl@0: 
sl@0: /**
sl@0: Constructs a 16 bit constant literal descriptor for
sl@0: end of line.
sl@0: */
sl@0: _LIT(KEndOfLineCharacters,"\r\n");
sl@0: 
sl@0: /**
sl@0: Date format for European style
sl@0: */
sl@0: _LIT(KDateFormat,"%1%/1%2%/2%3\t");
sl@0: 
sl@0: /**
sl@0: 24 hour time format
sl@0: */
sl@0: _LIT(KTimeFormat,"%J%:1%T%:2%S\t");
sl@0: 
sl@0: 
sl@0: /**
sl@0: TLogFile class definition
sl@0: */
sl@0: 
sl@0: TLogFile::TLogFile()
sl@0: /**
sl@0: Sets initial values for iValid and iMode.
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	iValid=EFalse;
sl@0: 	iMode=EFileLoggingModeUnknown;
sl@0: 	}
sl@0: 
sl@0: TLogFile::TLogFile(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode)
sl@0: /**
sl@0: Sets initial values for iValid,iDirectory,iName and iMode.
sl@0: 
sl@0: @param aDir Full Path of the log file.
sl@0: @param aName Name of the log file.
sl@0: @param aMode Specifies whether data is appended or file is truncated.
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	iValid=EFalse;
sl@0: 	iDirectory=aDir;
sl@0: 	iName=aName;
sl@0: 	iMode=aMode;
sl@0: 	}
sl@0: 
sl@0: TBool TLogFile::operator==(const TLogFile& aLogFile) const
sl@0: /**
sl@0: iValid members need not be equal
sl@0: 
sl@0: @param aLogFile log file.
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	if (iDirectory!=aLogFile.iDirectory)
sl@0: 		return EFalse;
sl@0: 	if (iName!=aLogFile.iName)
sl@0: 		return EFalse;
sl@0: 	if (iMode!=aLogFile.iMode)
sl@0: 		return EFalse;
sl@0: 	return ETrue;
sl@0: 	}
sl@0: 
sl@0: void TLogFile::Set(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode)
sl@0: /**
sl@0: Sets values for iValid,iDirectory,iName and iMode.
sl@0: 
sl@0: @param aDir Full Path of the log file.
sl@0: @param aName Name of the log file.
sl@0: @param aMode Specifies whether data is appended or file is truncated.
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	iValid=EFalse;
sl@0: 	iDirectory=aDir;
sl@0: 	iName=aName;
sl@0: 	iMode=aMode;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: TLogFormatterOverflow class definition
sl@0: */
sl@0: 
sl@0: void TLogFormatter16Overflow::Overflow(TDes16& /*aDes*/)
sl@0: /** 
sl@0: TDes16Overflow pure virtual 
sl@0: This member is internal and not intended for use.
sl@0: */	
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: void TLogFormatter8Overflow::Overflow(TDes8& /*aDes*/)
sl@0: /** 
sl@0: TDes16Overflow pure virtual 
sl@0: This member is internal and not intended for use.
sl@0: */
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: TLogFormat class definition
sl@0: */
sl@0: 
sl@0: TLogFormatter::TLogFormatter()
sl@0: 	: iUseDate(ETrue), iUseTime(ETrue)
sl@0: /**
sl@0: Sets iUseDate and iUseTime to ETrue.
sl@0: */
sl@0: 	{}
sl@0: 
sl@0: void TLogFormatter::SetDateAndTime(TBool aUseDate, TBool aUseTime)
sl@0: /**
sl@0: Sets whether to use date and/or time
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	iUseDate=aUseDate;
sl@0: 	iUseTime=aUseTime;
sl@0: 	}
sl@0: 
sl@0: TInt TLogFormatter::FormatTextToWritableBuffer(TDes8& aBuf, const TDesC16& aText) const
sl@0: /**
sl@0: Returns result in aBuf
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	TRAPD(ret,WriteL(aBuf,aText));
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: TInt TLogFormatter::FormatTextToWritableBuffer(TDes8& aBuf, const TDesC8& aText) const
sl@0: /**
sl@0: Returns result in aBuf
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	TRAPD(ret,WriteL(aBuf,aText));
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: TInt TLogFormatter::ConvertToWritableBuffer(TDes8& aBuf, TRefByValue<const TDesC16> aFmt, VA_LIST& aList)
sl@0: /**
sl@0: Formats string to aBuf
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	TBuf16<KLogBufferSize> buf;
sl@0: 	buf.AppendFormatList(aFmt,aList,&iOverflow16);
sl@0: 	TRAPD(ret,WriteL(aBuf,buf));
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: TInt TLogFormatter::ConvertToWritableBuffer(TDes8& aBuf, TRefByValue<const TDesC8> aFmt, VA_LIST& aList)
sl@0: /**
sl@0: Formats string to aBuf
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	TBuf8<KLogBufferSize> buf;
sl@0: 	buf.AppendFormatList(aFmt,aList,&iOverflow8);
sl@0: 	TRAPD(ret,WriteL(aBuf,buf));
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: void TLogFormatter::GetDateAndTimeL(TDes& aDate, TDes& aTime) const
sl@0: /**
sl@0: Gets date and time according to flags to buffer aBuf
sl@0: */
sl@0: 	{
sl@0: 
sl@0: 	aDate.SetLength(0);
sl@0: 	aTime.SetLength(0);
sl@0: 		
sl@0: 	if (!iUseTime && !iUseDate)
sl@0: 		return;
sl@0: 
sl@0: 	TTime t;
sl@0: 	t.HomeTime();
sl@0: 	if (iUseDate)
sl@0: 		t.FormatL(aDate,KDateFormat);
sl@0: 	
sl@0: 	if (iUseTime)
sl@0: 		t.FormatL(aTime,KTimeFormat);
sl@0: 	}
sl@0: 
sl@0: void TLogFormatter::WriteL(TDes8& aTrg, const TDesC16& aSrc) const
sl@0: /**
sl@0: Appends date/time as specified and truncate aSrc and convert 
sl@0: unprintable characters to '.'.  Convert unicode to UTF8 and 
sl@0: return the result in aTrg
sl@0: */
sl@0: 	{	
sl@0: 
sl@0: 	aTrg.SetLength(0);
sl@0: 	TBuf16<KDateOrTimeMaxLength> dateBuf;
sl@0: 	TBuf16<KDateOrTimeMaxLength> timeBuf;
sl@0: 	GetDateAndTimeL(dateBuf,timeBuf);
sl@0: 	TBuf16<KLogBufferSize> buf;
sl@0: 	__ASSERT_DEBUG(buf.MaxLength()>=dateBuf.Length(), User::Invariant());
sl@0: 	buf.Append(dateBuf);
sl@0: 	__ASSERT_DEBUG((buf.MaxLength()-buf.Length())>=timeBuf.Length(), User::Invariant());
sl@0: 	buf.Append(timeBuf);
sl@0: 	buf.Append(aSrc.Left(Min(aSrc.Length(),(KLogBufferSize-buf.Length()-2))));	// -2 to allow for CRLF
sl@0: 	TChar ch;
sl@0: 	for (TInt i=0; i<buf.Length(); i++)
sl@0: 		{
sl@0: 		ch=buf[i];
sl@0: 		if(!((ch.IsPrint()) || (ch==KTabChar)))
sl@0: 			buf[i]=KFullStopChar;
sl@0: 		}
sl@0: 	buf.Append(KEndOfLineCharacters);
sl@0: 
sl@0: 	TBuf8<KLogBufferSize> utfBuf;
sl@0: 	CnvUtfConverter::ConvertFromUnicodeToUtf8(utfBuf,buf);
sl@0: 	aTrg.Copy(utfBuf.Left(Min(utfBuf.Length(),aTrg.MaxLength())));
sl@0: 	}
sl@0: 
sl@0: void TLogFormatter::WriteL(TDes8& aTrg, const TDesC8& aSrc) const
sl@0: /**
sl@0: Append date/time as specified and truncate aSrc and convert 
sl@0: unprintable characters to '.'.
sl@0: */
sl@0: 	{	
sl@0: 
sl@0: 	aTrg.SetLength(0);
sl@0: 	TBuf16<KDateOrTimeMaxLength> dateBuf;
sl@0: 	TBuf16<KDateOrTimeMaxLength> timeBuf;
sl@0: 	GetDateAndTimeL(dateBuf,timeBuf);
sl@0: 	TBuf8<KDateOrTimeMaxLength> eightBitDateBuf;
sl@0: 	eightBitDateBuf.Copy(dateBuf);
sl@0: 	TBuf8<KDateOrTimeMaxLength> eightBitTimeBuf;
sl@0: 	eightBitTimeBuf.Copy(timeBuf);
sl@0: 	TBuf8<KLogBufferSize> buf;
sl@0: 	__ASSERT_DEBUG(buf.MaxLength()>=dateBuf.Length(), User::Invariant());
sl@0: 	buf.Append(eightBitDateBuf);
sl@0: 	__ASSERT_DEBUG((buf.MaxLength()-buf.Length())>=timeBuf.Length(), User::Invariant());
sl@0: 	buf.Append(eightBitTimeBuf);
sl@0: 	buf.Append(aSrc.Left(Min(aSrc.Length(),(KLogBufferSize-buf.Length()-2))));	// -2 to allow for CRLF
sl@0: 	TChar ch;
sl@0: 	for (TInt i=0; i<buf.Length(); i++)
sl@0: 		{
sl@0: 		ch=buf[i];
sl@0: 		if(!((ch.IsPrint()) || (ch==KTabChar8)))
sl@0: 			buf[i]=KFullStopChar8;
sl@0: 		}
sl@0: 	buf.Append(KEndOfLineCharacters8);
sl@0: 	aTrg.Copy(buf.Left(Min(buf.Length(),aTrg.MaxLength())));
sl@0: 	}