1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/pluginfw/Test_Bed/test_bed/DataLogger.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,529 @@
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 +#include <e32def.h>
1.20 +#include <f32file.h>
1.21 +
1.22 +#include <ecom/test_bed/datalogger.h>
1.23 +
1.24 +// KLogBufferSize is the maximum line length allowed by flogger
1.25 +const TInt KMaxTBLogEntrySize = KLogBufferSize;
1.26 +
1.27 +// Common string literals for all output formats
1.28 +_LIT(KTimeFormatStr,"%J%:1%T%:2%S%.%*C3");
1.29 +// Above string will give time in format HH:MM:SS.SSS therefore max length = 12
1.30 +const TInt KTimeBufLength = 12;
1.31 +
1.32 +// Define some string literals for HTML formatting
1.33 +_LIT(KHTMLDocumentStart,"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\"><HTML><HEAD><META NAME=\"robots\" CONTENT=\"noindex\"><META NAME=\"author\" CONTENT=\"Symbian RTestBed log generator\"><TITLE>");
1.34 +// Insert title string here
1.35 +_LIT(KHTMLContentStart,"</TITLE></HEAD><BODY><P><FONT=3>");
1.36 +// Insert time string here
1.37 +_LIT(KHTMLCommentStart,"<P>");
1.38 +// Insert content here
1.39 +_LIT(KHTMLCommentEnd,"</P>");
1.40 +_LIT(KHTMLDocumentEnd,"</FONT></P></BODY></HTML>");
1.41 +
1.42 +//___________________________________________________________________________
1.43 +// Define the overflow handling classes for any log formatting methods
1.44 +// Simply record the overflow...
1.45 +//
1.46 +
1.47 +NONSHARABLE_CLASS(TLogMessageOverflow) : public TDes16Overflow
1.48 + {
1.49 + public:
1.50 +
1.51 + TLogMessageOverflow();
1.52 +
1.53 + void Overflow(TDes16&);
1.54 +
1.55 + TInt iError;
1.56 + };
1.57 +
1.58 +TLogMessageOverflow::TLogMessageOverflow()
1.59 +: TDes16Overflow(),
1.60 +iError(KErrNone)
1.61 + {
1.62 + }
1.63 +
1.64 +void TLogMessageOverflow::Overflow(TDes16&)
1.65 + {
1.66 + __DEBUGGER();
1.67 + iError = KErrOverflow;
1.68 + }
1.69 +
1.70 +
1.71 +NONSHARABLE_CLASS(TLogMessageOverflow8) : public TDes8Overflow
1.72 + {
1.73 + public:
1.74 +
1.75 + TLogMessageOverflow8();
1.76 +
1.77 + void Overflow(TDes8&);
1.78 +
1.79 + TInt iError;
1.80 + };
1.81 +
1.82 +TLogMessageOverflow8::TLogMessageOverflow8()
1.83 +: TDes8Overflow(),
1.84 +iError(KErrNone)
1.85 + {
1.86 + }
1.87 +
1.88 +void TLogMessageOverflow8::Overflow(TDes8&)
1.89 + {
1.90 + __DEBUGGER();
1.91 + iError = KErrOverflow;
1.92 + }
1.93 +
1.94 +//___________________________________________________________________________
1.95 +
1.96 +//___________________________________________________________________________
1.97 +
1.98 +CDataLogger::~CDataLogger()
1.99 + {
1.100 + if(iLogOutput != NULL)
1.101 + {
1.102 + if(iLogStyle != EText && iLogFormat.iDocumentEnd)
1.103 + Log(iLogOutput, *(iLogFormat.iDocumentEnd));
1.104 + iLogOutput->Close();
1.105 + }
1.106 +
1.107 + if(iReportOutput != NULL)
1.108 + {
1.109 + if(iLogStyle != EText && iLogFormat.iDocumentEnd)
1.110 + Log(iReportOutput, *(iLogFormat.iDocumentEnd));
1.111 + iReportOutput->Close();
1.112 + }
1.113 +
1.114 + delete iFormatBuf;
1.115 + delete iDebug;
1.116 + delete iDefaultLogOutput;
1.117 + delete iDefaultReportOutput;
1.118 + }
1.119 +
1.120 +
1.121 +CDataLogger::CDataLogger()
1.122 + {
1.123 + }
1.124 +
1.125 +CDataLogger* CDataLogger::NewLC(TLoggingInfo* aLogInfo)
1.126 + {
1.127 + CDataLogger* self = new (ELeave) CDataLogger();
1.128 + CleanupStack::PushL(self);
1.129 + self->ConstructL(aLogInfo);
1.130 + return self;
1.131 + }
1.132 +
1.133 +CDataLogger* CDataLogger::NewL(TLoggingInfo* aLogInfo)
1.134 + {
1.135 + CDataLogger* self = NewLC(aLogInfo);
1.136 + CleanupStack::Pop();
1.137 + return self;
1.138 + }
1.139 +
1.140 +
1.141 +void CDataLogger::ConstructL(TLoggingInfo* aLogInfo)
1.142 + {
1.143 + iFormatBuf = HBufC::NewL(KMaxTBLogEntrySize);
1.144 +
1.145 + SetupLoggingL(aLogInfo);
1.146 +
1.147 + iLogOutput->OpenL();
1.148 + iReportOutput->OpenL();
1.149 +
1.150 + // Record additional information : Time
1.151 + TTime time;
1.152 + time.UniversalTime();
1.153 + TBuf<KTimeBufLength> timeBuf;
1.154 + time.FormatL(timeBuf,KTimeFormatStr);
1.155 + if(iLogStyle != EText)
1.156 + {
1.157 + // Use the log format
1.158 + Log(iLogOutput, *(iLogFormat.iDocumentStart));
1.159 + if(aLogInfo->iTitle)
1.160 + Log(iLogOutput, *(aLogInfo->iTitle));
1.161 + Log(iLogOutput, *(iLogFormat.iContentStart));
1.162 + Log(iLogOutput, timeBuf);
1.163 +
1.164 + Log(iReportOutput, *(iLogFormat.iDocumentStart));
1.165 + if(aLogInfo->iTitle)
1.166 + Log(iReportOutput, *(aLogInfo->iTitle));
1.167 + Log(iReportOutput, *(iLogFormat.iContentStart));
1.168 + Log(iReportOutput, timeBuf);
1.169 + }
1.170 + else
1.171 + {
1.172 + if(aLogInfo && aLogInfo->iTitle)
1.173 + {
1.174 + Log(iLogOutput, *(aLogInfo->iTitle));
1.175 + Log(iReportOutput, *(aLogInfo->iTitle));
1.176 + }
1.177 + Log(iLogOutput, timeBuf);
1.178 + Log(iReportOutput, timeBuf);
1.179 + }
1.180 + }
1.181 +
1.182 +
1.183 +EXPORT_C void CDataLogger::DumpMemoryBlock(const TUint8* aAddress, TInt aLength)
1.184 + {
1.185 + const TInt KBytesPerRow = 16;
1.186 + const TInt KLowestAsciiPrint = 32;
1.187 + const TInt KHighestAsciiPrint = 127;
1.188 +
1.189 + // The required descriptors for outputting the data
1.190 + _LIT(KDumpLineStart, "%04x : ");
1.191 + _LIT(KDumpHexOutput, "%02x ");
1.192 + _LIT(KDumpHexBlank, " ");
1.193 + _LIT(KDumpHexEnd, ": ");
1.194 + _LIT(KDumpCharOutput, "%c");
1.195 + _LIT(KDumpCharUnknown, ".");
1.196 + _LIT(KDumpCharBlank, " ");
1.197 +
1.198 + TPtrC8 theData(aAddress, aLength);
1.199 +
1.200 + // Iterate the supplied block of data in blocks of 16 bytes
1.201 + TInt pos = 0;
1.202 + TBuf<KMaxTBLogEntrySize> logLine;
1.203 + TBuf<KMaxTBLogEntrySize> anEntry;
1.204 + while (pos < theData.Length())
1.205 + {
1.206 + TInt offset = 0;
1.207 +
1.208 + anEntry.Format(KDumpLineStart, pos);
1.209 + logLine.Append(anEntry);
1.210 +
1.211 + // Hex output
1.212 + for (offset = 0; offset < KBytesPerRow; ++offset)
1.213 + {
1.214 + if (pos + offset < theData.Length())
1.215 + {
1.216 + TInt nextByte = theData[pos + offset];
1.217 + anEntry.Format(KDumpHexOutput, nextByte);
1.218 + logLine.Append(anEntry);
1.219 + }
1.220 + else
1.221 + {
1.222 + anEntry.Format(KDumpHexBlank);
1.223 + logLine.Append(anEntry);
1.224 + }
1.225 + }
1.226 + anEntry.Format(KDumpHexEnd);
1.227 + logLine.Append(anEntry);
1.228 +
1.229 + // Char output
1.230 + for (offset = 0; offset < KBytesPerRow; ++offset)
1.231 + {
1.232 + if (pos + offset < theData.Length())
1.233 + {
1.234 + TInt nextByte = theData[pos + offset];
1.235 + if ((nextByte >= KLowestAsciiPrint) && (nextByte <= KHighestAsciiPrint))
1.236 + {
1.237 + anEntry.Format(KDumpCharOutput, nextByte);
1.238 + logLine.Append(anEntry);
1.239 + }
1.240 + else
1.241 + {
1.242 + anEntry.Format(KDumpCharUnknown);
1.243 + logLine.Append(anEntry);
1.244 + }
1.245 + }
1.246 + else
1.247 + {
1.248 + anEntry.Format(KDumpCharBlank);
1.249 + logLine.Append(anEntry);
1.250 + }
1.251 + }
1.252 +
1.253 + //Log this line to the file
1.254 + if(iLogStyle != EText)
1.255 + {
1.256 + Log(iLogOutput, *(iLogFormat.iCommentStart));
1.257 + Log(iLogOutput, logLine);
1.258 + Log(iLogOutput, *(iLogFormat.iCommentEnd));
1.259 + }
1.260 + else
1.261 + Log(iLogOutput, logLine);
1.262 +
1.263 + logLine.Zero();
1.264 +
1.265 + // Advance to next segment of size 'KBytesPerRow'
1.266 + pos += KBytesPerRow;
1.267 + }
1.268 +
1.269 + }
1.270 +
1.271 +
1.272 +EXPORT_C void CDataLogger::LogInformation(const TDesC16& aComment)
1.273 + {
1.274 + if(iLogStyle != EText)
1.275 + {
1.276 + Log(iLogOutput, *(iLogFormat.iCommentStart));
1.277 + Log(iLogOutput, aComment);
1.278 + Log(iLogOutput, *(iLogFormat.iCommentEnd));
1.279 + }
1.280 + else
1.281 + Log(iLogOutput, aComment);
1.282 + iDebug->Print(aComment);
1.283 + }
1.284 +
1.285 +EXPORT_C void CDataLogger::LogInformation(const TDesC8& aComment)
1.286 + {
1.287 + // Create a wide descriptor to copy aComment into
1.288 + HBufC* message = HBufC::NewMax(aComment.Length());
1.289 +
1.290 + // If the allocation failed then do nothing
1.291 + if(message != NULL)
1.292 + {
1.293 + TPtr message16 = message->Des();
1.294 +
1.295 + message16.Copy(aComment);
1.296 + LogInformation(message16);
1.297 + delete message;
1.298 + }
1.299 + }
1.300 +
1.301 +EXPORT_C void CDataLogger::LogInformationWithParameters(TRefByValue<const TDesC16> aFormat, ...)
1.302 + {
1.303 + // Prepare the message
1.304 + // coverity [var_decl]
1.305 + // VA_LIST is initialized in VA_START
1.306 + VA_LIST list;
1.307 + VA_START(list,aFormat);
1.308 +
1.309 + TPtr message = iFormatBuf->Des();
1.310 +
1.311 + // Catch the overflow if formatting
1.312 + TLogMessageOverflow overflowHandler;
1.313 + message.AppendFormatList(aFormat,list,&overflowHandler);
1.314 + VA_END(list);
1.315 + if(overflowHandler.iError == KErrNone)
1.316 + {
1.317 + // Ok formatted correctly so...
1.318 + // Wrap the logging level as the first parameter
1.319 + if(iLogStyle != EText)
1.320 + {
1.321 + Log(iLogOutput, *(iLogFormat.iCommentStart));
1.322 + Log(iLogOutput, message);
1.323 + Log(iLogOutput, *(iLogFormat.iCommentEnd));
1.324 + }
1.325 + else
1.326 + Log(iLogOutput, message);
1.327 + iDebug->Print(message);
1.328 + }
1.329 +
1.330 + // Clear the message buffer
1.331 + message.Zero();
1.332 + }
1.333 +
1.334 +EXPORT_C void CDataLogger::LogInformationWithParameters(TRefByValue<const TDesC8> aFormat, ...)
1.335 + {
1.336 + // Create an 8 bit descriptor to copy aFormat into
1.337 + HBufC8* message8 = HBufC8::New(KMaxTBLogEntrySize);
1.338 + if(message8)
1.339 + {
1.340 + // Prepare the message
1.341 + // coverity [var_decl]
1.342 + // VA_LIST is initialized in VA_START
1.343 + VA_LIST list;
1.344 + VA_START(list,aFormat);
1.345 + TPtr8 messagePtr8 = message8->Des();
1.346 +
1.347 + // Catch the overflow if formatting
1.348 + TLogMessageOverflow8 overflowHandler;
1.349 + messagePtr8.AppendFormatList(aFormat,list,&overflowHandler);
1.350 + VA_END(list);
1.351 + if(overflowHandler.iError == KErrNone)
1.352 + {
1.353 + TPtr message = iFormatBuf->Des();
1.354 + // Copy over the fromatted message into the 16 bit descriptor
1.355 + message.Copy(messagePtr8);
1.356 +
1.357 + // Ok formatted correctly so...
1.358 + // Wrap the logging level as the first parameter
1.359 + if(iLogStyle != EText)
1.360 + {
1.361 + Log(iLogOutput, *(iLogFormat.iCommentStart));
1.362 + Log(iLogOutput, message);
1.363 + Log(iLogOutput, *(iLogFormat.iCommentEnd));
1.364 + }
1.365 + else
1.366 + Log(iLogOutput, message);
1.367 + iDebug->Print(message);
1.368 +
1.369 + // Clear the message buffer
1.370 + message.Zero();
1.371 + }
1.372 + delete message8;
1.373 + }
1.374 + }
1.375 +
1.376 +EXPORT_C void CDataLogger::ReportInformation(const TDesC& aComment)
1.377 + {
1.378 + if(iLogStyle != EText)
1.379 + {
1.380 + Log(iReportOutput, *(iLogFormat.iCommentStart));
1.381 + Log(iReportOutput, aComment);
1.382 + Log(iReportOutput, *(iLogFormat.iCommentEnd));
1.383 + }
1.384 + else
1.385 + Log(iReportOutput, aComment);
1.386 + }
1.387 +
1.388 +EXPORT_C void CDataLogger::ReportInformationWithParameters(TRefByValue<const TDesC> aFormat, ...)
1.389 + {
1.390 + // Prepare the message
1.391 + // coverity [var_decl]
1.392 + // VA_LIST is initialized in VA_START
1.393 + VA_LIST list;
1.394 + VA_START(list,aFormat);
1.395 +
1.396 + TPtr message = iFormatBuf->Des();
1.397 +
1.398 + // Catch the overflow if formatting
1.399 + TLogMessageOverflow overflowHandler;
1.400 + message.AppendFormatList(aFormat,list,&overflowHandler);
1.401 + VA_END(list);
1.402 + if(overflowHandler.iError == KErrNone)
1.403 + {
1.404 + // Ok formatted correctly so...
1.405 + // Wrap the logging level as the first parameter
1.406 + if(iLogStyle != EText)
1.407 + {
1.408 + Log(iReportOutput, *(iLogFormat.iCommentStart));
1.409 + Log(iReportOutput, message);
1.410 + Log(iReportOutput, *(iLogFormat.iCommentEnd));
1.411 + }
1.412 + else
1.413 + Log(iReportOutput, message);
1.414 + }
1.415 +
1.416 + // Clear the message buffer
1.417 + message.Zero();
1.418 + }
1.419 +
1.420 +
1.421 +void CDataLogger::SetupRDebugL(TBool aRequest)
1.422 + {
1.423 + delete iDebug;
1.424 + iDebug = 0;
1.425 +
1.426 + if(aRequest)
1.427 + iDebug = new(ELeave) TDebugPrint; // Print to RDebug
1.428 + else
1.429 + iDebug = new(ELeave) TNullDebugPrint; // Ignore prints
1.430 + }
1.431 +
1.432 +void CDataLogger::TDebugPrint::Print(const TDesC& aMessage)
1.433 + {
1.434 + _LIT(KRDebugFormatStr,"%S");
1.435 + RDebug::Print(KRDebugFormatStr, &aMessage);
1.436 + }
1.437 +
1.438 +void CDataLogger::Log(MLogOutput* aLogOutput, const TDesC16& aMessage)
1.439 + {
1.440 + // If the message is short enough then log it in one go
1.441 + if(aMessage.Length() < KMaxTBLogEntrySize)
1.442 + aLogOutput->Write(aMessage);
1.443 + else
1.444 + {
1.445 + // Start at the beginning and log out short blocks until finished
1.446 + TInt outIndex = 0;
1.447 + while(outIndex < aMessage.Length())
1.448 + {
1.449 + if((outIndex+KMaxTBLogEntrySize) > aMessage.Length())
1.450 + {
1.451 + aLogOutput->Write(aMessage.Right(aMessage.Length() - outIndex));
1.452 + outIndex = aMessage.Length();
1.453 + }
1.454 + else
1.455 + {
1.456 + // The -1 is required to ensure that the submessage is not too long
1.457 + TPtrC subMessage = aMessage.Mid(outIndex, KMaxTBLogEntrySize - 1);
1.458 + // Find the space nearest the end for a convenient break point
1.459 + TInt spaceLoc = subMessage.LocateReverse(TChar(' '));
1.460 + if(spaceLoc != KErrNotFound)
1.461 + outIndex = spaceLoc;
1.462 + else
1.463 + outIndex = KMaxTBLogEntrySize - 1;
1.464 + aLogOutput->Write(subMessage.Left(++outIndex));
1.465 + }
1.466 + }
1.467 + }
1.468 + }
1.469 +
1.470 +void CDataLogger::SetupLoggingL(TLoggingInfo* aLogInfo)
1.471 + {
1.472 + // The possible log filenames
1.473 + _LIT(KTestBedLogName, "RTestBed.log");
1.474 + _LIT(KTestBedHtmlLogName, "TestBedLog.html");
1.475 + // The possible report file names
1.476 + _LIT(KTestBedReportName, "RTestBed.rep");
1.477 + _LIT(KTestBedHtmlReportName, "TestBedReport.html");
1.478 +
1.479 + if(aLogInfo)
1.480 + {
1.481 + iLogStyle = aLogInfo->iStyle;
1.482 +
1.483 + if(aLogInfo->iLogOutput)
1.484 + iLogOutput = aLogInfo->iLogOutput;
1.485 + else
1.486 + {
1.487 + if(iLogStyle==EHtml)
1.488 + iDefaultLogOutput = new(ELeave) CDefaultLogOutput(KTestBedHtmlLogName);
1.489 + else
1.490 + iDefaultLogOutput = new(ELeave) CDefaultLogOutput(KTestBedLogName);
1.491 +
1.492 + iLogOutput = iDefaultLogOutput;
1.493 + }
1.494 +
1.495 + if(aLogInfo->iReportOutput)
1.496 + iReportOutput = aLogInfo->iReportOutput;
1.497 + else
1.498 + {
1.499 + if(iLogStyle==EHtml)
1.500 + iDefaultReportOutput = new(ELeave) CDefaultLogOutput(KTestBedHtmlReportName);
1.501 + else
1.502 + iDefaultReportOutput = new(ELeave) CDefaultLogOutput(KTestBedReportName);
1.503 +
1.504 + iReportOutput = iDefaultReportOutput;
1.505 + }
1.506 +
1.507 + SetupRDebugL(aLogInfo->iUseRDebug);
1.508 + }
1.509 + else
1.510 + {
1.511 + iLogStyle = EText;
1.512 + iDefaultLogOutput = new(ELeave) CDefaultLogOutput(KTestBedLogName);
1.513 + iLogOutput = iDefaultLogOutput;
1.514 + iDefaultReportOutput = new(ELeave) CDefaultLogOutput(KTestBedReportName);
1.515 + iReportOutput = iDefaultReportOutput;
1.516 +
1.517 + SetupRDebugL(ETrue);
1.518 + }
1.519 +
1.520 + // If the user has specified a custom logging style then use their LogFormat
1.521 + if(iLogStyle == ECustom)
1.522 + iLogFormat = *(aLogInfo->iLogFormat);
1.523 + else if(iLogStyle == EHtml)
1.524 + {
1.525 + // Output as HTML
1.526 + iLogFormat.iDocumentStart = &(KHTMLDocumentStart());
1.527 + iLogFormat.iContentStart = &(KHTMLContentStart());
1.528 + iLogFormat.iCommentStart = &(KHTMLCommentStart());
1.529 + iLogFormat.iCommentEnd = &(KHTMLCommentEnd());
1.530 + iLogFormat.iDocumentEnd = &(KHTMLDocumentEnd());
1.531 + }
1.532 + }