// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// Client / server logging for Test Framework

// NOTE : does NOT include secure API changes in EKA2

// 

//

// Test system includes

#include <testframework.h>

// do not export if Unit Testing

#if defined (__TSU_TESTFRAMEWORK__)

#undef EXPORT_C

#define EXPORT_C

#endif

/**

 *

 * HTML font formatting strings

 *

 * @xxxx

 *

 */

_LIT(KResultPass, "<font size=4 color=00AF00>");

_LIT(KResultFail, "<font size=4 color=FF0000>");

_LIT(KResultInconclusive, "<font size=4 color=0000FF>");

_LIT(KResultUndefined, "<font size=4 color=FF00FF>");

_LIT(KResultEnd, "</font>");

_LIT(KResultNonHtml, "");

_LIT(KResultKnownFailure, "<font size=4 color=008080>"); //A new TVerdict for a known failed test

// logging macro used only for verdicts - not for external use

#define VER_PRINTF(r1, r2, r3)		LogExtra(__FILE8__, __LINE__, ESevrVer, _L("%S%S%S\n"), (r1), (r2), (r3)) 

/**

 *

 * Global : start a server

 * NOTE. Function is global static as only one server will ever run at any time

 * (there may be multiple client sessions)

 *

 * @return	"TInt"

 *			Error code (KErrNone if successful)

 *

 * @xxxx

 *

 */

GLDEF_C TInt StartServer()

// Start the server process/thread which lives in an (EPOC)EXE object

	{

	const TUidType serverUid(KNullUid, KNullUid, KTestFrameworkServerUid3);

// EPOC is easy, we just create a new server process. Simultaneous launching

// of two such processes should be detected when the second one attempts to

// create the server object, failing with KErrAlreadyExists.

	RProcess server;

	TInt r = server.Create(KTestFrameworkServerImg, KNullDesC, serverUid);

	if (r != KErrNone)

		return r;

	TRequestStatus rendezvous;

	server.Rendezvous(rendezvous);

	if (rendezvous!=KRequestPending)

		{

		server.Kill(0);

		}

	else

		{

		server.Resume();

		}

	User::WaitForRequest(rendezvous);		// wait for start or death

	// we can't use the 'exit reason' if the server panicked as this

	// is the panic 'reason' and may be '0' which cannot be distinguished

	// from KErrNone

	if (rendezvous!=KErrNone)

		{

		server.Close();

		}

	// server started (at last). Cancel and consume the death-notification

	// before reporting success

	return rendezvous.Int();

	}

/**

 *

 * Constructor for RTestFrameworkClientSession

 *

 * @xxxx

 *

 */

RTestFrameworkClientSession::RTestFrameworkClientSession()

	{

	}

/**

 *

 * Client session : connect to server.

 * Will start a new server session if no server exists

 *

 * @return	"TInt"

 *			Error code (KErrNone if connect successful)

 *

 * @xxxx

 *

 */

TInt RTestFrameworkClientSession::Connect()

	{

	// NOTE : this loop is ugly and can probably be rewritten to be more graceful

	const TInt KNumRetries = 2;

	TInt retry = KNumRetries;

	for (;;)

		{

		TInt r = CreateSession(KTestFrameworkServerName, TVersion(KTestFrameworkServerMajorVersionNumber,

																  KTestFrameworkServerMinorVersionNumber,

																  KTestFrameworkServerBuildVersionNumber));

		if (r == KErrNone)

			{

#ifdef __IPC_V2_PRESENT__

			r = ShareAuto();

#else

			r = Share(RSessionBase::EAutoAttach);

#endif

			if (r!=KErrNone)

				Close();

			return r;

			}

		if (r != KErrNotFound && r != KErrServerTerminated)

			{

			return r;

			}

		if (--retry == 0)

			return r;

		r = StartServer();

		if (r != KErrNone && r != KErrAlreadyExists)

			return r;

		}

	}

/**

 *

 * Request creation of an input window.

 * NOTE. For initialisation of input console only - unlikely to

 * be required by user

 *

 * @param	"TRectBuf& aAllocatedWindow"

 *			Window dimensions

 *

 * @param	"TRequestStatus& aReqStat"

 *			Request status

 *

 * @xxxx

 *

 */

void RTestFrameworkClientSession::CreateInputWindow(TRectBuf& aAllocatedWindow, TRequestStatus& aReqStat)

	{

	SendReceiveResult(ECreateInputWindow, aAllocatedWindow, aReqStat);

	}

/**

 *

 * Request window change notifications

 * NOTE. For initialisation of input console only - unlikely to

 * be required by user

 *

 * @param	"TRectBuf& aNewWindow"

 *			New window dimensions

 *

 * @param	"TRequestStatus& aReqStat"

 *			Request status

 *

 * @xxxx

 *

 */

void RTestFrameworkClientSession::NotifyIfWindowChange(TRectBuf& aNewWindow, TRequestStatus& aReqStat)

	{

	SendReceiveResult(ENotifyIfWindowChange, aNewWindow, aReqStat);

	}

/**

 *

 * Cancel window change notifications

 * NOTE. For initialisation of input console only - unlikely to

 * be required by user

 *

 * @return	"TInt"

 *			SendReceive error code

 *

 * @xxxx

 *

 */

TInt RTestFrameworkClientSession::CancelNotifyIfWindowChange()

	{

	return SendReceive(ECancelNotifyIfWindowChange);

	}

/**

 *

 * Open a log server session

 *

 * @param	"const TDesC& aLogName"

 *			The log name

 *

 * @param	"TInt aLogMode"

 *			The log mode (a bitmask of TTestFrameworkLogMode)

 *

 * @xxxx

 *

 */

void RTestFrameworkClientSession::OpenLog(const TDesC& aLogName, TInt aLogMode)

	{

	(void) SendReceive(EOpenLog, aLogName, aLogMode);

	}

/**

 *

 * Write message string to log server session

 *

 * @param	"const TDesC& aMsg"

 *			The message string

 *

 * @param	"TInt aLogMode"

 *			The log mode (a bitmask of TTestFrameworkLogMode)

 *

 * @xxxx

 *

 */

void RTestFrameworkClientSession::WriteLog(const TDesC& aMsg, TInt aLogMode)

	{

	(void) SendReceive(EWriteLog, aMsg, aLogMode);

	}

/**

 *

 * Send close log message to server

 *

 * @xxxx

 *

 */

void RTestFrameworkClientSession::CloseLog()

	{

	SendReceive(ECloseLog);

	}

/**

 *

 * Retrieve log status from server

 *

 * @return	"TInt"

 *			The log status (a bitmask of TTestFrameworkLogMode)

 *

 * @xxxx

 *

 */

TInt RTestFrameworkClientSession::LogStatus()

	{

	TInt res = 0;

	TPckgBuf<TInt> pckg;

	TInt r = SendReceiveResult(ELogStatus, pckg);

	if (r != KErrNone)

	{

		// RTestFrameworkClientSession does not log - 

		// we can however return 0 to indicate an error (no outputs)

		res = 0;

	}

	else

		res = pckg();

	return res;

	}

/**

 *

 * Static constructor for CLog.

 *

 *

 * @return	"CLog*"

 *			The constructed CLog

 *

 * @xxxx

 *

 */

EXPORT_C CLog* CLog::NewL()

	{

	CLog* self = new(ELeave) CLog;

	self->Construct();

	return self;

	}

/**

 *

 * Static NewLC constructor for CLog.

 *

 *

 * @return	"CLog*"

 *			The constructed CLog

 *

 * @xxxx

 *

 */

EXPORT_C CLog* CLog::NewLC()

	{

	CLog* self = new(ELeave) CLog;

	CleanupStack::PushL(self);

	self->Construct();

	return self;

	}

/**

 *

 * Second-phase constructor for CLog.

 *

 * @xxxx

 *

 */

EXPORT_C void CLog::Construct()

	{

	iLogStatus = 0;		// no outputs enabled yet

	iSeverity = ESevrAll;

	//Do we need to put information about source file & #line?

	//Default is yes.

	iLogFlags = ELogPutSrcInfo | ELogHtmlMode;

	}

/**

 *

 * Destructor for CLog.

 *

 * @xxxx

 *

 */

EXPORT_C CLog::~CLog()

	{

	// tell server to close logs here

	iClientSession.Close();

	}

/**

 *

 * Open a new test log.

 *

 * @param	"const TDesC& aLogName"

 *			Log file or console name

 *

 * @param	"TInt aLogMode"

 *			Log modes (a bitmask of TTestFrameworkLogMode).

 *

 * @xxxx

 *

 */

EXPORT_C void CLog::OpenLogFileL(const TDesC& aLogName, TInt aLogMode)

	{

	User::LeaveIfError(iClientSession.Connect());

	iClientSession.OpenLog(aLogName, aLogMode);

	// get and store the log status - this will determine whether we

	// e.g. do any formatting for file output

	iLogStatus = iClientSession.LogStatus();

	}

/**

 *

 * Open an existing test log.

 *

 * @xxxx

 *

 */

EXPORT_C void CLog::OpenLogFileL()

	{

	User::LeaveIfError(iClientSession.Connect());

	iLogStatus = iClientSession.LogStatus();

	}

/**

 *

 * Set put source info (i.e. traceable logging).

 *

 * @param	"TBool aPutSrcInfo"

 *			Put source info on or off.

 *

 * @xxxx

 *

 */

EXPORT_C void CLog::SetPutSrcInfo(TBool aPutSrcInfo)

	{

	if(aPutSrcInfo)

		iLogFlags |= ELogPutSrcInfo;

	else

		iLogFlags &= ~ELogPutSrcInfo;

	}

/**

 *

 * Set HTML logging mode.

 *

 * @param	"TBool aArg"

 *			HTML mode on or off.

 *

 * @xxxx

 *

 */

EXPORT_C void CLog::SetHtmlLogMode(TBool aArg)

	{

	if(aArg)

		iLogFlags |= ELogHtmlMode;

	else

		iLogFlags &= ~ELogHtmlMode;

	}

/**

 *

 * Get HTML logging mode.

 *

 * @return	"TBool"

 *			HTML mode on or off.

 *

 * @xxxx

 *

 */

EXPORT_C TBool CLog::HtmlLogMode() const

	{

	return ((iLogFlags & ELogHtmlMode) != 0);

	}

/**

 *

 * General logging function.

 *

 * @param	"TRefByValue<const TDesC16> aFmt"

 *			Printf-style format.

 *

 * @param	"..."

 *			Variable print parameters

 *

 * @xxxx

 *

 */

EXPORT_C void CLog::Log(TRefByValue<const TDesC16> aFmt, ...)

	{

    VA_LIST aList;

	VA_START(aList, aFmt);

	TIntegrationTestLog16Overflow overflow16;

	// decode formatted data for display on console

	TBuf<KMaxLogLineLength> lineBuf;

	lineBuf = KNullDesC;

	lineBuf.AppendFormatList(aFmt, aList, &overflow16);

	// write to the console

	if(iLogStatus & ELogConsoleFull)

		iClientSession.WriteLog(lineBuf, ELogToConsole);

	// write to log file

	WriteFormat(_L("%S\n"), &lineBuf);

	VA_END(aList); 

	}

/**

 *

 * General logging function with severity.

 *

 * @param	"TInt aSeverity"

 *			Severity level required to log

 *

 * @param	"TRefByValue<const TDesC16> aFmt"

 *			Printf-style format.

 *

 * @param	"..."

 *			Variable print parameters

 *

 * @xxxx

 *

 */

EXPORT_C void CLog::Log(TInt aSeverity, TRefByValue<const TDesC16> aFmt, ...)

	{

    VA_LIST aList;

	VA_START(aList, aFmt);

	if(LogSeverity::IsActive(aSeverity, Severity()))

		{

		Log(aFmt, aList);

		}

	VA_END(aList); 

	}

/**

 *

 * General logging function.

 *

 * @param	"TRefByValue<const TDesC16> aFmt"

 *			Printf-style format.

 *

 * @param	"VA_LIST aList"

 *			Variable print parameters

 *

 * @xxxx

 *

 */

EXPORT_C void CLog::Log(TRefByValue<const TDesC16> aFmt, VA_LIST aList)

	{

	// decode formatted data for display on console

	TBuf<KMaxLogLineLength> lineBuf;

	TIntegrationTestLog16Overflow overflow16;