"); sl@0: // Insert title string here sl@0:

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: #include sl@0: #include sl@0: sl@0: #include sl@0: sl@0: // KLogBufferSize is the maximum line length allowed by flogger sl@0: const TInt KMaxTBLogEntrySize = KLogBufferSize; sl@0: sl@0: // Common string literals for all output formats sl@0: _LIT(KTimeFormatStr,"%J%:1%T%:2%S%.%*C3"); sl@0: // Above string will give time in format HH:MM:SS.SSS therefore max length = 12 sl@0: const TInt KTimeBufLength = 12; sl@0: sl@0: // Define some string literals for HTML formatting sl@0: _LIT(KHTMLDocumentStart,""); sl@0: // Insert title string here sl@0: _LIT(KHTMLContentStart,"

"); sl@0: // Insert time string here sl@0: _LIT(KHTMLCommentStart,"

"); sl@0: // Insert content here sl@0: _LIT(KHTMLCommentEnd,"

"); sl@0: _LIT(KHTMLDocumentEnd,"

"); sl@0: sl@0: //___________________________________________________________________________ sl@0: // Define the overflow handling classes for any log formatting methods sl@0: // Simply record the overflow... sl@0: // sl@0: sl@0: NONSHARABLE_CLASS(TLogMessageOverflow) : public TDes16Overflow sl@0: { sl@0: public: sl@0: sl@0: TLogMessageOverflow(); sl@0: sl@0: void Overflow(TDes16&); sl@0: sl@0: TInt iError; sl@0: }; sl@0: sl@0: TLogMessageOverflow::TLogMessageOverflow() sl@0: : TDes16Overflow(), sl@0: iError(KErrNone) sl@0: { sl@0: } sl@0: sl@0: void TLogMessageOverflow::Overflow(TDes16&) sl@0: { sl@0: __DEBUGGER(); sl@0: iError = KErrOverflow; sl@0: } sl@0: sl@0: sl@0: NONSHARABLE_CLASS(TLogMessageOverflow8) : public TDes8Overflow sl@0: { sl@0: public: sl@0: sl@0: TLogMessageOverflow8(); sl@0: sl@0: void Overflow(TDes8&); sl@0: sl@0: TInt iError; sl@0: }; sl@0: sl@0: TLogMessageOverflow8::TLogMessageOverflow8() sl@0: : TDes8Overflow(), sl@0: iError(KErrNone) sl@0: { sl@0: } sl@0: sl@0: void TLogMessageOverflow8::Overflow(TDes8&) sl@0: { sl@0: __DEBUGGER(); sl@0: iError = KErrOverflow; sl@0: } sl@0: sl@0: //___________________________________________________________________________ sl@0: sl@0: //___________________________________________________________________________ sl@0: sl@0: CDataLogger::~CDataLogger() sl@0: { sl@0: if(iLogOutput != NULL) sl@0: { sl@0: if(iLogStyle != EText && iLogFormat.iDocumentEnd) sl@0: Log(iLogOutput, *(iLogFormat.iDocumentEnd)); sl@0: iLogOutput->Close(); sl@0: } sl@0: sl@0: if(iReportOutput != NULL) sl@0: { sl@0: if(iLogStyle != EText && iLogFormat.iDocumentEnd) sl@0: Log(iReportOutput, *(iLogFormat.iDocumentEnd)); sl@0: iReportOutput->Close(); sl@0: } sl@0: sl@0: delete iFormatBuf; sl@0: delete iDebug; sl@0: delete iDefaultLogOutput; sl@0: delete iDefaultReportOutput; sl@0: } sl@0: sl@0: sl@0: CDataLogger::CDataLogger() sl@0: { sl@0: } sl@0: sl@0: CDataLogger* CDataLogger::NewLC(TLoggingInfo* aLogInfo) sl@0: { sl@0: CDataLogger* self = new (ELeave) CDataLogger(); sl@0: CleanupStack::PushL(self); sl@0: self->ConstructL(aLogInfo); sl@0: return self; sl@0: } sl@0: sl@0: CDataLogger* CDataLogger::NewL(TLoggingInfo* aLogInfo) sl@0: { sl@0: CDataLogger* self = NewLC(aLogInfo); sl@0: CleanupStack::Pop(); sl@0: return self; sl@0: } sl@0: sl@0: sl@0: void CDataLogger::ConstructL(TLoggingInfo* aLogInfo) sl@0: { sl@0: iFormatBuf = HBufC::NewL(KMaxTBLogEntrySize); sl@0: sl@0: SetupLoggingL(aLogInfo); sl@0: sl@0: iLogOutput->OpenL(); sl@0: iReportOutput->OpenL(); sl@0: sl@0: // Record additional information : Time sl@0: TTime time; sl@0: time.UniversalTime(); sl@0: TBuf timeBuf; sl@0: time.FormatL(timeBuf,KTimeFormatStr); sl@0: if(iLogStyle != EText) sl@0: { sl@0: // Use the log format sl@0: Log(iLogOutput, *(iLogFormat.iDocumentStart)); sl@0: if(aLogInfo->iTitle) sl@0: Log(iLogOutput, *(aLogInfo->iTitle)); sl@0: Log(iLogOutput, *(iLogFormat.iContentStart)); sl@0: Log(iLogOutput, timeBuf); sl@0: sl@0: Log(iReportOutput, *(iLogFormat.iDocumentStart)); sl@0: if(aLogInfo->iTitle) sl@0: Log(iReportOutput, *(aLogInfo->iTitle)); sl@0: Log(iReportOutput, *(iLogFormat.iContentStart)); sl@0: Log(iReportOutput, timeBuf); sl@0: } sl@0: else sl@0: { sl@0: if(aLogInfo && aLogInfo->iTitle) sl@0: { sl@0: Log(iLogOutput, *(aLogInfo->iTitle)); sl@0: Log(iReportOutput, *(aLogInfo->iTitle)); sl@0: } sl@0: Log(iLogOutput, timeBuf); sl@0: Log(iReportOutput, timeBuf); sl@0: } sl@0: } sl@0: sl@0: sl@0: EXPORT_C void CDataLogger::DumpMemoryBlock(const TUint8* aAddress, TInt aLength) sl@0: { sl@0: const TInt KBytesPerRow = 16; sl@0: const TInt KLowestAsciiPrint = 32; sl@0: const TInt KHighestAsciiPrint = 127; sl@0: sl@0: // The required descriptors for outputting the data sl@0: _LIT(KDumpLineStart, "%04x : "); sl@0: _LIT(KDumpHexOutput, "%02x "); sl@0: _LIT(KDumpHexBlank, " "); sl@0: _LIT(KDumpHexEnd, ": "); sl@0: _LIT(KDumpCharOutput, "%c"); sl@0: _LIT(KDumpCharUnknown, "."); sl@0: _LIT(KDumpCharBlank, " "); sl@0: sl@0: TPtrC8 theData(aAddress, aLength); sl@0: sl@0: // Iterate the supplied block of data in blocks of 16 bytes sl@0: TInt pos = 0; sl@0: TBuf logLine; sl@0: TBuf anEntry; sl@0: while (pos < theData.Length()) sl@0: { sl@0: TInt offset = 0; sl@0: sl@0: anEntry.Format(KDumpLineStart, pos); sl@0: logLine.Append(anEntry); sl@0: sl@0: // Hex output sl@0: for (offset = 0; offset < KBytesPerRow; ++offset) sl@0: { sl@0: if (pos + offset < theData.Length()) sl@0: { sl@0: TInt nextByte = theData[pos + offset]; sl@0: anEntry.Format(KDumpHexOutput, nextByte); sl@0: logLine.Append(anEntry); sl@0: } sl@0: else sl@0: { sl@0: anEntry.Format(KDumpHexBlank); sl@0: logLine.Append(anEntry); sl@0: } sl@0: } sl@0: anEntry.Format(KDumpHexEnd); sl@0: logLine.Append(anEntry); sl@0: sl@0: // Char output sl@0: for (offset = 0; offset < KBytesPerRow; ++offset) sl@0: { sl@0: if (pos + offset < theData.Length()) sl@0: { sl@0: TInt nextByte = theData[pos + offset]; sl@0: if ((nextByte >= KLowestAsciiPrint) && (nextByte <= KHighestAsciiPrint)) sl@0: { sl@0: anEntry.Format(KDumpCharOutput, nextByte); sl@0: logLine.Append(anEntry); sl@0: } sl@0: else sl@0: { sl@0: anEntry.Format(KDumpCharUnknown); sl@0: logLine.Append(anEntry); sl@0: } sl@0: } sl@0: else sl@0: { sl@0: anEntry.Format(KDumpCharBlank); sl@0: logLine.Append(anEntry); sl@0: } sl@0: } sl@0: sl@0: //Log this line to the file sl@0: if(iLogStyle != EText) sl@0: { sl@0: Log(iLogOutput, *(iLogFormat.iCommentStart)); sl@0: Log(iLogOutput, logLine); sl@0: Log(iLogOutput, *(iLogFormat.iCommentEnd)); sl@0: } sl@0: else sl@0: Log(iLogOutput, logLine); sl@0: sl@0: logLine.Zero(); sl@0: sl@0: // Advance to next segment of size 'KBytesPerRow' sl@0: pos += KBytesPerRow; sl@0: } sl@0: sl@0: } sl@0: sl@0: sl@0: EXPORT_C void CDataLogger::LogInformation(const TDesC16& aComment) sl@0: { sl@0: if(iLogStyle != EText) sl@0: { sl@0: Log(iLogOutput, *(iLogFormat.iCommentStart)); sl@0: Log(iLogOutput, aComment); sl@0: Log(iLogOutput, *(iLogFormat.iCommentEnd)); sl@0: } sl@0: else sl@0: Log(iLogOutput, aComment); sl@0: iDebug->Print(aComment); sl@0: } sl@0: sl@0: EXPORT_C void CDataLogger::LogInformation(const TDesC8& aComment) sl@0: { sl@0: // Create a wide descriptor to copy aComment into sl@0: HBufC* message = HBufC::NewMax(aComment.Length()); sl@0: sl@0: // If the allocation failed then do nothing sl@0: if(message != NULL) sl@0: { sl@0: TPtr message16 = message->Des(); sl@0: sl@0: message16.Copy(aComment); sl@0: LogInformation(message16); sl@0: delete message; sl@0: } sl@0: } sl@0: sl@0: EXPORT_C void CDataLogger::LogInformationWithParameters(TRefByValue aFormat, ...) sl@0: { sl@0: // Prepare the message sl@0: // coverity [var_decl] sl@0: // VA_LIST is initialized in VA_START sl@0: VA_LIST list; sl@0: VA_START(list,aFormat); sl@0: sl@0: TPtr message = iFormatBuf->Des(); sl@0: sl@0: // Catch the overflow if formatting sl@0: TLogMessageOverflow overflowHandler; sl@0: message.AppendFormatList(aFormat,list,&overflowHandler); sl@0: VA_END(list); sl@0: if(overflowHandler.iError == KErrNone) sl@0: { sl@0: // Ok formatted correctly so... sl@0: // Wrap the logging level as the first parameter sl@0: if(iLogStyle != EText) sl@0: { sl@0: Log(iLogOutput, *(iLogFormat.iCommentStart)); sl@0: Log(iLogOutput, message); sl@0: Log(iLogOutput, *(iLogFormat.iCommentEnd)); sl@0: } sl@0: else sl@0: Log(iLogOutput, message); sl@0: iDebug->Print(message); sl@0: } sl@0: sl@0: // Clear the message buffer sl@0: message.Zero(); sl@0: } sl@0: sl@0: EXPORT_C void CDataLogger::LogInformationWithParameters(TRefByValue aFormat, ...) sl@0: { sl@0: // Create an 8 bit descriptor to copy aFormat into sl@0: HBufC8* message8 = HBufC8::New(KMaxTBLogEntrySize); sl@0: if(message8) sl@0: { sl@0: // Prepare the message sl@0: // coverity [var_decl] sl@0: // VA_LIST is initialized in VA_START sl@0: VA_LIST list; sl@0: VA_START(list,aFormat); sl@0: TPtr8 messagePtr8 = message8->Des(); sl@0: sl@0: // Catch the overflow if formatting sl@0: TLogMessageOverflow8 overflowHandler; sl@0: messagePtr8.AppendFormatList(aFormat,list,&overflowHandler); sl@0: VA_END(list); sl@0: if(overflowHandler.iError == KErrNone) sl@0: { sl@0: TPtr message = iFormatBuf->Des(); sl@0: // Copy over the fromatted message into the 16 bit descriptor sl@0: message.Copy(messagePtr8); sl@0: sl@0: // Ok formatted correctly so... sl@0: // Wrap the logging level as the first parameter sl@0: if(iLogStyle != EText) sl@0: { sl@0: Log(iLogOutput, *(iLogFormat.iCommentStart)); sl@0: Log(iLogOutput, message); sl@0: Log(iLogOutput, *(iLogFormat.iCommentEnd)); sl@0: } sl@0: else sl@0: Log(iLogOutput, message); sl@0: iDebug->Print(message); sl@0: sl@0: // Clear the message buffer sl@0: message.Zero(); sl@0: } sl@0: delete message8; sl@0: } sl@0: } sl@0: sl@0: EXPORT_C void CDataLogger::ReportInformation(const TDesC& aComment) sl@0: { sl@0: if(iLogStyle != EText) sl@0: { sl@0: Log(iReportOutput, *(iLogFormat.iCommentStart)); sl@0: Log(iReportOutput, aComment); sl@0: Log(iReportOutput, *(iLogFormat.iCommentEnd)); sl@0: } sl@0: else sl@0: Log(iReportOutput, aComment); sl@0: } sl@0: sl@0: EXPORT_C void CDataLogger::ReportInformationWithParameters(TRefByValue aFormat, ...) sl@0: { sl@0: // Prepare the message sl@0: // coverity [var_decl] sl@0: // VA_LIST is initialized in VA_START sl@0: VA_LIST list; sl@0: VA_START(list,aFormat); sl@0: sl@0: TPtr message = iFormatBuf->Des(); sl@0: sl@0: // Catch the overflow if formatting sl@0: TLogMessageOverflow overflowHandler; sl@0: message.AppendFormatList(aFormat,list,&overflowHandler); sl@0: VA_END(list); sl@0: if(overflowHandler.iError == KErrNone) sl@0: { sl@0: // Ok formatted correctly so... sl@0: // Wrap the logging level as the first parameter sl@0: if(iLogStyle != EText) sl@0: { sl@0: Log(iReportOutput, *(iLogFormat.iCommentStart)); sl@0: Log(iReportOutput, message); sl@0: Log(iReportOutput, *(iLogFormat.iCommentEnd)); sl@0: } sl@0: else sl@0: Log(iReportOutput, message); sl@0: } sl@0: sl@0: // Clear the message buffer sl@0: message.Zero(); sl@0: } sl@0: sl@0: sl@0: void CDataLogger::SetupRDebugL(TBool aRequest) sl@0: { sl@0: delete iDebug; sl@0: iDebug = 0; sl@0: sl@0: if(aRequest) sl@0: iDebug = new(ELeave) TDebugPrint; // Print to RDebug sl@0: else sl@0: iDebug = new(ELeave) TNullDebugPrint; // Ignore prints sl@0: } sl@0: sl@0: void CDataLogger::TDebugPrint::Print(const TDesC& aMessage) sl@0: { sl@0: _LIT(KRDebugFormatStr,"%S"); sl@0: RDebug::Print(KRDebugFormatStr, &aMessage); sl@0: } sl@0: sl@0: void CDataLogger::Log(MLogOutput* aLogOutput, const TDesC16& aMessage) sl@0: { sl@0: // If the message is short enough then log it in one go sl@0: if(aMessage.Length() < KMaxTBLogEntrySize) sl@0: aLogOutput->Write(aMessage); sl@0: else sl@0: { sl@0: // Start at the beginning and log out short blocks until finished sl@0: TInt outIndex = 0; sl@0: while(outIndex < aMessage.Length()) sl@0: { sl@0: if((outIndex+KMaxTBLogEntrySize) > aMessage.Length()) sl@0: { sl@0: aLogOutput->Write(aMessage.Right(aMessage.Length() - outIndex)); sl@0: outIndex = aMessage.Length(); sl@0: } sl@0: else sl@0: { sl@0: // The -1 is required to ensure that the submessage is not too long sl@0: TPtrC subMessage = aMessage.Mid(outIndex, KMaxTBLogEntrySize - 1); sl@0: // Find the space nearest the end for a convenient break point sl@0: TInt spaceLoc = subMessage.LocateReverse(TChar(' ')); sl@0: if(spaceLoc != KErrNotFound) sl@0: outIndex = spaceLoc; sl@0: else sl@0: outIndex = KMaxTBLogEntrySize - 1; sl@0: aLogOutput->Write(subMessage.Left(++outIndex)); sl@0: } sl@0: } sl@0: } sl@0: } sl@0: sl@0: void CDataLogger::SetupLoggingL(TLoggingInfo* aLogInfo) sl@0: { sl@0: // The possible log filenames sl@0: _LIT(KTestBedLogName, "RTestBed.log"); sl@0: _LIT(KTestBedHtmlLogName, "TestBedLog.html"); sl@0: // The possible report file names sl@0: _LIT(KTestBedReportName, "RTestBed.rep"); sl@0: _LIT(KTestBedHtmlReportName, "TestBedReport.html"); sl@0: sl@0: if(aLogInfo) sl@0: { sl@0: iLogStyle = aLogInfo->iStyle; sl@0: sl@0: if(aLogInfo->iLogOutput) sl@0: iLogOutput = aLogInfo->iLogOutput; sl@0: else sl@0: { sl@0: if(iLogStyle==EHtml) sl@0: iDefaultLogOutput = new(ELeave) CDefaultLogOutput(KTestBedHtmlLogName); sl@0: else sl@0: iDefaultLogOutput = new(ELeave) CDefaultLogOutput(KTestBedLogName); sl@0: sl@0: iLogOutput = iDefaultLogOutput; sl@0: } sl@0: sl@0: if(aLogInfo->iReportOutput) sl@0: iReportOutput = aLogInfo->iReportOutput; sl@0: else sl@0: { sl@0: if(iLogStyle==EHtml) sl@0: iDefaultReportOutput = new(ELeave) CDefaultLogOutput(KTestBedHtmlReportName); sl@0: else sl@0: iDefaultReportOutput = new(ELeave) CDefaultLogOutput(KTestBedReportName); sl@0: sl@0: iReportOutput = iDefaultReportOutput; sl@0: } sl@0: sl@0: SetupRDebugL(aLogInfo->iUseRDebug); sl@0: } sl@0: else sl@0: { sl@0: iLogStyle = EText; sl@0: iDefaultLogOutput = new(ELeave) CDefaultLogOutput(KTestBedLogName); sl@0: iLogOutput = iDefaultLogOutput; sl@0: iDefaultReportOutput = new(ELeave) CDefaultLogOutput(KTestBedReportName); sl@0: iReportOutput = iDefaultReportOutput; sl@0: sl@0: SetupRDebugL(ETrue); sl@0: } sl@0: sl@0: // If the user has specified a custom logging style then use their LogFormat sl@0: if(iLogStyle == ECustom) sl@0: iLogFormat = *(aLogInfo->iLogFormat); sl@0: else if(iLogStyle == EHtml) sl@0: { sl@0: // Output as HTML sl@0: iLogFormat.iDocumentStart = &(KHTMLDocumentStart()); sl@0: iLogFormat.iContentStart = &(KHTMLContentStart()); sl@0: iLogFormat.iCommentStart = &(KHTMLCommentStart()); sl@0: iLogFormat.iCommentEnd = &(KHTMLCommentEnd()); sl@0: iLogFormat.iDocumentEnd = &(KHTMLDocumentEnd()); sl@0: } sl@0: }