1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/loggingservices/filelogger/SCLI/FLOGFMT.CPP Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,298 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +/**
1.20 + @file
1.21 +*/
1.22 +
1.23 +#include <utf.h>
1.24 +#include <flogger.h>
1.25 +#include "FLOGSTD.H"
1.26 +
1.27 +/**
1.28 +16-bit tab char width for symbian OS build.
1.29 +*/
1.30 +const TText KTabChar='\t';
1.31 +
1.32 +/**
1.33 +8-bit FullStop char for non-unicode
1.34 +*/
1.35 +const TText8 KFullStopChar8='.';
1.36 +
1.37 +/**
1.38 +8-bit tab char for unicode
1.39 +*/
1.40 +const TText8 KTabChar8='\t';
1.41 +
1.42 +/**
1.43 +Max length for a TBuf date or time variable.
1.44 +*/
1.45 +const TInt KDateOrTimeMaxLength=30;
1.46 +
1.47 +/**
1.48 +Constructs a 8 bit constant literal descriptor for
1.49 +end of line.
1.50 +*/
1.51 +_LIT8(KEndOfLineCharacters8,"\r\n");
1.52 +
1.53 +/**
1.54 +Constructs a 16 bit constant literal descriptor for
1.55 +end of line.
1.56 +*/
1.57 +_LIT(KEndOfLineCharacters,"\r\n");
1.58 +
1.59 +/**
1.60 +Date format for European style
1.61 +*/
1.62 +_LIT(KDateFormat,"%1%/1%2%/2%3\t");
1.63 +
1.64 +/**
1.65 +24 hour time format
1.66 +*/
1.67 +_LIT(KTimeFormat,"%J%:1%T%:2%S\t");
1.68 +
1.69 +
1.70 +/**
1.71 +TLogFile class definition
1.72 +*/
1.73 +
1.74 +TLogFile::TLogFile()
1.75 +/**
1.76 +Sets initial values for iValid and iMode.
1.77 +*/
1.78 + {
1.79 +
1.80 + iValid=EFalse;
1.81 + iMode=EFileLoggingModeUnknown;
1.82 + }
1.83 +
1.84 +TLogFile::TLogFile(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode)
1.85 +/**
1.86 +Sets initial values for iValid,iDirectory,iName and iMode.
1.87 +
1.88 +@param aDir Full Path of the log file.
1.89 +@param aName Name of the log file.
1.90 +@param aMode Specifies whether data is appended or file is truncated.
1.91 +*/
1.92 + {
1.93 +
1.94 + iValid=EFalse;
1.95 + iDirectory=aDir;
1.96 + iName=aName;
1.97 + iMode=aMode;
1.98 + }
1.99 +
1.100 +TBool TLogFile::operator==(const TLogFile& aLogFile) const
1.101 +/**
1.102 +iValid members need not be equal
1.103 +
1.104 +@param aLogFile log file.
1.105 +*/
1.106 + {
1.107 +
1.108 + if (iDirectory!=aLogFile.iDirectory)
1.109 + return EFalse;
1.110 + if (iName!=aLogFile.iName)
1.111 + return EFalse;
1.112 + if (iMode!=aLogFile.iMode)
1.113 + return EFalse;
1.114 + return ETrue;
1.115 + }
1.116 +
1.117 +void TLogFile::Set(const TDesC& aDir, const TDesC& aName, TFileLoggingMode aMode)
1.118 +/**
1.119 +Sets values for iValid,iDirectory,iName and iMode.
1.120 +
1.121 +@param aDir Full Path of the log file.
1.122 +@param aName Name of the log file.
1.123 +@param aMode Specifies whether data is appended or file is truncated.
1.124 +*/
1.125 + {
1.126 +
1.127 + iValid=EFalse;
1.128 + iDirectory=aDir;
1.129 + iName=aName;
1.130 + iMode=aMode;
1.131 + }
1.132 +
1.133 +/**
1.134 +TLogFormatterOverflow class definition
1.135 +*/
1.136 +
1.137 +void TLogFormatter16Overflow::Overflow(TDes16& /*aDes*/)
1.138 +/**
1.139 +TDes16Overflow pure virtual
1.140 +This member is internal and not intended for use.
1.141 +*/
1.142 + {
1.143 + }
1.144 +
1.145 +void TLogFormatter8Overflow::Overflow(TDes8& /*aDes*/)
1.146 +/**
1.147 +TDes16Overflow pure virtual
1.148 +This member is internal and not intended for use.
1.149 +*/
1.150 + {
1.151 + }
1.152 +
1.153 +/**
1.154 +TLogFormat class definition
1.155 +*/
1.156 +
1.157 +TLogFormatter::TLogFormatter()
1.158 + : iUseDate(ETrue), iUseTime(ETrue)
1.159 +/**
1.160 +Sets iUseDate and iUseTime to ETrue.
1.161 +*/
1.162 + {}
1.163 +
1.164 +void TLogFormatter::SetDateAndTime(TBool aUseDate, TBool aUseTime)
1.165 +/**
1.166 +Sets whether to use date and/or time
1.167 +*/
1.168 + {
1.169 +
1.170 + iUseDate=aUseDate;
1.171 + iUseTime=aUseTime;
1.172 + }
1.173 +
1.174 +TInt TLogFormatter::FormatTextToWritableBuffer(TDes8& aBuf, const TDesC16& aText) const
1.175 +/**
1.176 +Returns result in aBuf
1.177 +*/
1.178 + {
1.179 +
1.180 + TRAPD(ret,WriteL(aBuf,aText));
1.181 + return ret;
1.182 + }
1.183 +
1.184 +TInt TLogFormatter::FormatTextToWritableBuffer(TDes8& aBuf, const TDesC8& aText) const
1.185 +/**
1.186 +Returns result in aBuf
1.187 +*/
1.188 + {
1.189 +
1.190 + TRAPD(ret,WriteL(aBuf,aText));
1.191 + return ret;
1.192 + }
1.193 +
1.194 +TInt TLogFormatter::ConvertToWritableBuffer(TDes8& aBuf, TRefByValue<const TDesC16> aFmt, VA_LIST& aList)
1.195 +/**
1.196 +Formats string to aBuf
1.197 +*/
1.198 + {
1.199 +
1.200 + TBuf16<KLogBufferSize> buf;
1.201 + buf.AppendFormatList(aFmt,aList,&iOverflow16);
1.202 + TRAPD(ret,WriteL(aBuf,buf));
1.203 + return ret;
1.204 + }
1.205 +
1.206 +TInt TLogFormatter::ConvertToWritableBuffer(TDes8& aBuf, TRefByValue<const TDesC8> aFmt, VA_LIST& aList)
1.207 +/**
1.208 +Formats string to aBuf
1.209 +*/
1.210 + {
1.211 +
1.212 + TBuf8<KLogBufferSize> buf;
1.213 + buf.AppendFormatList(aFmt,aList,&iOverflow8);
1.214 + TRAPD(ret,WriteL(aBuf,buf));
1.215 + return ret;
1.216 + }
1.217 +
1.218 +void TLogFormatter::GetDateAndTimeL(TDes& aDate, TDes& aTime) const
1.219 +/**
1.220 +Gets date and time according to flags to buffer aBuf
1.221 +*/
1.222 + {
1.223 +
1.224 + aDate.SetLength(0);
1.225 + aTime.SetLength(0);
1.226 +
1.227 + if (!iUseTime && !iUseDate)
1.228 + return;
1.229 +
1.230 + TTime t;
1.231 + t.HomeTime();
1.232 + if (iUseDate)
1.233 + t.FormatL(aDate,KDateFormat);
1.234 +
1.235 + if (iUseTime)
1.236 + t.FormatL(aTime,KTimeFormat);
1.237 + }
1.238 +
1.239 +void TLogFormatter::WriteL(TDes8& aTrg, const TDesC16& aSrc) const
1.240 +/**
1.241 +Appends date/time as specified and truncate aSrc and convert
1.242 +unprintable characters to '.'. Convert unicode to UTF8 and
1.243 +return the result in aTrg
1.244 +*/
1.245 + {
1.246 +
1.247 + aTrg.SetLength(0);
1.248 + TBuf16<KDateOrTimeMaxLength> dateBuf;
1.249 + TBuf16<KDateOrTimeMaxLength> timeBuf;
1.250 + GetDateAndTimeL(dateBuf,timeBuf);
1.251 + TBuf16<KLogBufferSize> buf;
1.252 + __ASSERT_DEBUG(buf.MaxLength()>=dateBuf.Length(), User::Invariant());
1.253 + buf.Append(dateBuf);
1.254 + __ASSERT_DEBUG((buf.MaxLength()-buf.Length())>=timeBuf.Length(), User::Invariant());
1.255 + buf.Append(timeBuf);
1.256 + buf.Append(aSrc.Left(Min(aSrc.Length(),(KLogBufferSize-buf.Length()-2)))); // -2 to allow for CRLF
1.257 + TChar ch;
1.258 + for (TInt i=0; i<buf.Length(); i++)
1.259 + {
1.260 + ch=buf[i];
1.261 + if(!((ch.IsPrint()) || (ch==KTabChar)))
1.262 + buf[i]=KFullStopChar;
1.263 + }
1.264 + buf.Append(KEndOfLineCharacters);
1.265 +
1.266 + TBuf8<KLogBufferSize> utfBuf;
1.267 + CnvUtfConverter::ConvertFromUnicodeToUtf8(utfBuf,buf);
1.268 + aTrg.Copy(utfBuf.Left(Min(utfBuf.Length(),aTrg.MaxLength())));
1.269 + }
1.270 +
1.271 +void TLogFormatter::WriteL(TDes8& aTrg, const TDesC8& aSrc) const
1.272 +/**
1.273 +Append date/time as specified and truncate aSrc and convert
1.274 +unprintable characters to '.'.
1.275 +*/
1.276 + {
1.277 +
1.278 + aTrg.SetLength(0);
1.279 + TBuf16<KDateOrTimeMaxLength> dateBuf;
1.280 + TBuf16<KDateOrTimeMaxLength> timeBuf;
1.281 + GetDateAndTimeL(dateBuf,timeBuf);
1.282 + TBuf8<KDateOrTimeMaxLength> eightBitDateBuf;
1.283 + eightBitDateBuf.Copy(dateBuf);
1.284 + TBuf8<KDateOrTimeMaxLength> eightBitTimeBuf;
1.285 + eightBitTimeBuf.Copy(timeBuf);
1.286 + TBuf8<KLogBufferSize> buf;
1.287 + __ASSERT_DEBUG(buf.MaxLength()>=dateBuf.Length(), User::Invariant());
1.288 + buf.Append(eightBitDateBuf);
1.289 + __ASSERT_DEBUG((buf.MaxLength()-buf.Length())>=timeBuf.Length(), User::Invariant());
1.290 + buf.Append(eightBitTimeBuf);
1.291 + buf.Append(aSrc.Left(Min(aSrc.Length(),(KLogBufferSize-buf.Length()-2)))); // -2 to allow for CRLF
1.292 + TChar ch;
1.293 + for (TInt i=0; i<buf.Length(); i++)
1.294 + {
1.295 + ch=buf[i];
1.296 + if(!((ch.IsPrint()) || (ch==KTabChar8)))
1.297 + buf[i]=KFullStopChar8;
1.298 + }
1.299 + buf.Append(KEndOfLineCharacters8);
1.300 + aTrg.Copy(buf.Left(Min(buf.Length(),aTrg.MaxLength())));
1.301 + }