// Copyright (c) 2007-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:

//

#include "tdirectgdi_test_step_base.h"

#include <graphics/directgdiextensioninterfaces.h>

//These reference and test bitmaps are used for image comparison

//These are saved at

_LIT(KRefPath, "\\img\\ref\\%S.mbm");

_LIT(KTestPath, "\\img\\test\\%S.mbm");

//The default image cache size to use for the tests.

const TInt KDriverImageCacheSizeTests = 0x400000;

/**

Position iterator constructor.

@param aStartX Start x position.

@param aEndX End x position.

@param aStepX Step for x position.

@param aStartY Start y position.

@param aEndY End y position.

@param aStepY Step for y position.

*/

TPositionIterator::TPositionIterator(TInt aStartX, TInt aEndX, TInt aStepX,

	TInt aStartY, TInt aEndY, TInt aStepY) :

	iStartX(aStartX), iEndX(aEndX), iStepX(aStepX),

	iStartY(aStartY), iEndY(aEndY), iStepY(aStepY),

	iPosX(aStartX), iPosY(aStartY), iIndexX(0), iIndexY(0)

	{

	}

/**

Begin iteration.

All needed variables are initialized to start iteration.

*/

void TPositionIterator::Begin()

	{

	iPosX = iStartX;

	iPosY = iStartY;

	iIndexX = 0;

	iIndexY = 0;

	}

/**

Next iteration.

Generates next position and position indices.

@return EFalse is returned if end of iterations else ETrue.

*/

TBool TPositionIterator::Next()

	{

	if(iPosX < iEndX)

		{

		iPosX += iStepX;

		iIndexX++;

		return ETrue;

		}

	else

		{

		if(iPosY < iEndY)

			{

			iPosX = iStartX;

			iIndexX = 0;

			iPosY += iStepY;

			iIndexY++;

			return ETrue;

			}

		else

			{

			return EFalse;

			}

		}

	}

CBitmapDevice* CTImageTarget::BitmapDevice() const

	{

	return iBitmapDevice;

	}

/**

Create a new bitgdi target

@param aPixelFormat The pixel format for the target

@param aSize The size of the target to create

@return On return, contains a pointer to a bitgdi target object

*/

CTBitGdiTarget*  CTBitGdiTarget::NewL(TUidPixelFormat aPixelFormat, const TSize& aSize)

	{

	CTBitGdiTarget* self = new(ELeave) CTBitGdiTarget();

	CleanupStack::PushL(self);

	self->ConstructL(aPixelFormat, aSize);

	CleanupStack::Pop(); // self

	return self;

	}

/**

Second phase constructor of CTBitGdiTarget. Creates a bitmap for use as a target.

@param aPixelFormat The pixel format for the target to be created

@param aSize The size of the target to be created

*/

void CTBitGdiTarget::ConstructL(TUidPixelFormat aPixelFormat, const TSize& aSize)

	{	

	// create a bitmap

	iBitmap = new(ELeave) CFbsBitmap;

	iBitmap->Create(aSize, TDisplayModeMapping::MapPixelFormatToDisplayMode(aPixelFormat));

	// create an off screen bitmap device

	iBitmapDevice = CFbsBitmapDevice::NewL(iBitmap);

	}

/**

Create a bitgdi context

@param aGc A pointer to the created graphics context

@param aActivate ETrue to create and activate the context aGc, EFalse to just create it.

@return On return, contains a pointer to the created bitgdi context

*/

TInt CTBitGdiTarget::CreateContext(CTContextBase*& aGc, TBool aActivate)

	{

	TInt result = KErrGeneral;

	TRAP(result, aGc = CTBitGdiContext::NewL((CFbsBitmapDevice*)iBitmapDevice, aActivate));

   	return result;

   	}

/**

Sets the object to draw to a particular device 

@param aGc A pointer to the created graphics context

*/

TInt CTBitGdiTarget::Activate(CTContextBase*& aGc)

	{

	CTBitGdiContext* gc = (CTBitGdiContext*)aGc;

	// Activate the context on a rendering target.

	return gc->Activate(iBitmapDevice);

	}

/**

Get the size of the device area in pixels

@return On return, The width and height of the target, in pixels 

*/

TSize CTBitGdiTarget::SizeInPixels() const 

	{

	return iBitmapDevice->SizeInPixels();

	}

/**

Get a target FBsBitmap

@return The target FBsBitmap

*/

CFbsBitmap* CTBitGdiTarget::GetTargetFbsBitmapL()

	{

	return iBitmap;

	}

/**

Nothing to be implemented for BitGdi Finish()

*/

void CTBitGdiTarget::Finish ()

	{

	}

void CTBitGdiTarget::Close() 

	{	

	}

/**

Destructor of CTBitGdiTarget

*/

CTBitGdiTarget::~CTBitGdiTarget()

	{

	delete iBitmapDevice;

	delete iBitmap;

	}

/**

Default constructor.

*/

CTDirectGdiTarget::CTDirectGdiTarget()

	{

	}

/**

Create a new directgdi target

@param aPixelFormat The pixel format for the target

@param aSize The size of the target to create

@return On return, contains a pointer to a directgdi target object

*/

CTDirectGdiTarget*  CTDirectGdiTarget::NewL(TUidPixelFormat aPixelFormat, const TSize& aSize)

	{

	CTDirectGdiTarget* self = new(ELeave) CTDirectGdiTarget();

	CleanupStack::PushL(self);

	self->ConstructL(aPixelFormat, aSize);

	CleanupStack::Pop(); // self

	return self;

	}

/**

Second phase constructor of CTDirectGdiTarget

@param aPixelFormat The pixel format for the target

@param aSize The size of the target to create

*/

void CTDirectGdiTarget::ConstructL(TUidPixelFormat aPixelFormat, const TSize& aSize)

	{	

	// open the driver

	User::LeaveIfError(CDirectGdiDriver::Open());

	iDGdiDriver = CDirectGdiDriver::Static();

	if (iDGdiDriver == NULL)

		User::Leave(KErrNoMemory);

	// set a large cache size (if available to do so) so the tests execute more quickly.

	MDirectGdiDriverCacheSize* driverCacheInterface = NULL;

	if (KErrNone == iDGdiDriver->GetInterface(TUid::Uid(KDirectGdiDriverCacheSizeUid), (TAny*&)driverCacheInterface))

		{

		User::LeaveIfError(driverCacheInterface->SetMaxImageCacheSize(KDriverImageCacheSizeTests));

		}

	iDGdiImageTarget = new (ELeave) RDirectGdiImageTarget(*iDGdiDriver);

	// create a bitmap which is used to save the image data from an RSgImage to a file.

	iBitmap = new(ELeave) CFbsBitmap;

	User::LeaveIfError(iBitmap->Create(aSize, TDisplayModeMapping::MapPixelFormatToDisplayMode(aPixelFormat)));

	iBitmapDevice = CFbsBitmapDevice::NewL(iBitmap);

	// Set up image attributes

	iImageInfo.iSizeInPixels = aSize;

	iImageInfo.iPixelFormat = aPixelFormat;

	iImageInfo.iUsage = ESgUsageDirectGdiTarget;

	User::LeaveIfError(iRSgImage.Create(iImageInfo, NULL,0));

	User::LeaveIfError(iDGdiImageTarget->Create(iRSgImage));

	}

/**

Create a Direct GDI graphics context.

@param aGc	A reference to a pointer to the created graphics context. If return is anything 

			other than KErrNone then aGc is set to NULL.

@param aActivate ETrue to create and activate the context aGc, EFalse to just create it.

@return KErrNone, if successful; otherwise, another of the system-wide error codes.

*/

TInt CTDirectGdiTarget::CreateContext(CTContextBase*& aGc, TBool aActivate)

	{	

	TInt result = KErrGeneral;

	aGc = NULL;

    TRAP(result, aGc = CTestDirectGdiContext::NewL());

    CTestDirectGdiContext* gc = (CTestDirectGdiContext*)aGc;

    // If the GC is not NULL, make sure the return code indicates

    // success.

    if (aActivate && aGc)

    	{

		if(result != KErrNone)

			{

			return result;

			}		

		else

			{

			// Activate the context on a rendering target.

			result = gc->Activate(*iDGdiImageTarget);

			}

    	}	

	return result;

	}

/**

Sets the object to draw to a particular device 

@param aGc A pointer to the created graphics context

*/

TInt CTDirectGdiTarget::Activate(CTContextBase*& aGc)

	{

    CTestDirectGdiContext* gc = (CTestDirectGdiContext*)aGc;

	// Activate the context on a rendering target.

    return gc->Activate(*iDGdiImageTarget);

	}

/**

Get the size of the device area in pixels

@return On return, The width and height of the target, in pixels 

*/

TSize CTDirectGdiTarget::SizeInPixels() const 

	{

	return iImageInfo.iSizeInPixels;

	}

/**

Get a target FBsBitmap.

@return The target FBsBitmap

*/

CFbsBitmap* CTDirectGdiTarget::GetTargetFbsBitmapL()

	{

	// Create a copy of the RSgImage that is CPU-accessible for mapping.

	RSgImage cpuAccessibleImage;

	TSgImageInfo imageInfo;

	imageInfo.iSizeInPixels = iImageInfo.iSizeInPixels;

	imageInfo.iPixelFormat = iImageInfo.iPixelFormat;

	imageInfo.iCpuAccess = ESgCpuAccessReadOnly;

	User::LeaveIfError(cpuAccessibleImage.Create(imageInfo, iRSgImage));

	CleanupClosePushL(cpuAccessibleImage);

	iBitmap->BeginDataAccess();

	const TInt bitmapDataStride = iBitmap->DataStride();

	const TInt numScanlines = imageInfo.iSizeInPixels.iHeight;

	const TAny* sgImageDataAddress;

	TInt sgImageDataStride = 0;

	User::LeaveIfError(cpuAccessibleImage.MapReadOnly(sgImageDataAddress, sgImageDataStride));

    TUint32* bitmapDataAddress = iBitmap->DataAddress();

    for (TInt scanline = 0; scanline < numScanlines; ++scanline)

    	{

    	Mem::Copy((TUint8*)bitmapDataAddress + (scanline*bitmapDataStride), (TUint8*)sgImageDataAddress + (scanline*sgImageDataStride), bitmapDataStride);

    	}

    iBitmap->EndDataAccess();

    cpuAccessibleImage.Unmap();

	CleanupStack::PopAndDestroy(1);

    return iBitmap;

	}

/**

Force completion of all batched rendering operations. Will not return

until rendering is complete.

@pre	Fully initialised image target.

*/

void CTDirectGdiTarget::Finish ()

	{	

	if (iDGdiDriver)

		iDGdiDriver->Finish();

	}

void CTDirectGdiTarget::Close() 

	{

	if (iDGdiImageTarget)

		iDGdiImageTarget->Close();

	}

/**

Destructor of CTDirectGdiTarget

*/

CTDirectGdiTarget::~CTDirectGdiTarget()

	{

	delete iBitmapDevice;

	delete iBitmap;

	if (iDGdiImageTarget)

		{

		iDGdiImageTarget->Close();	

		delete iDGdiImageTarget;

		}

	if (iDGdiDriver)

		iDGdiDriver->Close();

	iRSgImage.Close();

	}

/**

Implementation of CTestStep base class virtual

It is used for doing all common initialisation to derived classes.

Make it being able to leave 

The leave will be picked up by the framework.

@leave Gets system wide error code

@return - TVerdict code

*/

TVerdict CTDirectGdiStepBase::doTestStepPreambleL()

	{

	SetTestStepResult(EPass);

	// Create and install Active Scheduler in case tests require active objects

	iScheduler = new(ELeave) CActiveScheduler;

	CActiveScheduler::Install(iScheduler);

	TPtrC targetPixelFormatInput;

	TPtrC sourcePixelFormatInput;

	TPtrC sourceResourcePixelFormatInput;

	// get input for tests from .ini file

	_LIT(KDirectgdiTestInput, "DirectgdiTestInput");

	_LIT(KTargetPixelFormatEnums, "TargetPixelFormatEnums ");

	_LIT(KSourcePixelFormatEnums, "SourcePixelFormatEnums ");

	_LIT(KSourceResourcePixelFormatEnums, "SourceResourcePixelFormatEnums ");

	_LIT(KDoRefImg, "DoRefImg");

	_LIT(KDoDirectGdi, "DoDirectGdi");

	_LIT(KRunOomTests, "RunOomTests");

	TEST(GetStringFromConfig(KDirectgdiTestInput, KTargetPixelFormatEnums, targetPixelFormatInput));

	TEST(GetStringFromConfig(KDirectgdiTestInput, KSourcePixelFormatEnums, sourcePixelFormatInput));

	TEST(GetStringFromConfig(KDirectgdiTestInput, KSourceResourcePixelFormatEnums, sourceResourcePixelFormatInput));

	TEST(GetIntFromConfig(KDirectgdiTestInput, KDoRefImg, iMakeRefImg));

	TEST(GetIntFromConfig(KDirectgdiTestInput, KDoDirectGdi, iUseDirectGdi));

	TEST(GetIntFromConfig(KDirectgdiTestInput, KRunOomTests, iDoOomTests));

	#ifndef _DEBUG

	if(iDoOomTests)

		{

		iDoOomTests = EFalse;

		INFO_PRINTF1(_L("WARNING: Can't run out of memory tests under a release build. OOM tests set to run in ini file so turning OOM tests off."));

		}

	#endif

	ConvertPixelFormats(targetPixelFormatInput, iTargetPixelFormatArray);

	ConvertPixelFormats(sourcePixelFormatInput, iSourcePixelFormatArray);

	ConvertPixelFormats(sourceResourcePixelFormatInput, iSourceResourcePixelFormatArray);

	iRunningOomTests = EFalse;

	Logger().ShareAuto();

	__UHEAP_MARK;		

	User::LeaveIfError(SgDriver::Open());

	User::LeaveIfError(RFbsSession::Connect());	

	return TestStepResult();

	}

/**

Convert the pixel format strings to pixel format enums

@param aPixelFormatInput The pixel format string for testing

@param aPixelFormatArray The array of converted pixel formats is returned here

*/

void CTDirectGdiStepBase::ConvertPixelFormats(TPtrC aPixelFormatInput, RArray<TUidPixelFormat>& aPixelFormatArray)

	{

	TPtrC tempBuf = aPixelFormatInput;

	TInt position = tempBuf.Find(_L(","));

	while(KErrNotFound != position)

		{

		aPixelFormatArray.Append(TDisplayModeMapping::ConvertPixelFormatStringToPixelFormat(tempBuf.Left(position)));

		tempBuf.Set(tempBuf.Mid(position + 2));

		position = tempBuf.Find(_L(","));

		}	

	if (position == KErrNotFound)

		{

		aPixelFormatArray.Append(TDisplayModeMapping::ConvertPixelFormatStringToPixelFormat(tempBuf));

		}

	}

/**

Implementation of CTestStep base class virtual

It is used for doing all after test treatment common to derived classes in here.

Make it being able to leave

The leave will be picked up by the framework.

@leave Gets system wide error code

@return - TVerdict

*/

 TVerdict CTDirectGdiStepBase::doTestStepPostambleL()

	{

	if(iFontStore)

		{

		if(iFontId)

			{

			iFontStore->RemoveFile(iFontId);

			iFontId = 0;

			}

		delete iFontStore;

		iFontStore = NULL;

		}

	delete iGc;

	iGc = NULL;

	delete iGc2;

	iGc2 = NULL;

	delete iGdiTarget;

	iGdiTarget = NULL;

	delete iGdiTarget2;

	iGdiTarget2 = NULL;	

	SgDriver::Close();

	RFbsSession::Disconnect();

	__UHEAP_MARKEND;

	delete iScheduler;

	iScheduler = NULL;

	return TestStepResult();

	}

CTDirectGdiStepBase::~CTDirectGdiStepBase()

	{

	if(iFontStore)

		{

		if(iFontId)

			{

			iFontStore->RemoveFile(iFontId);			

			}

		delete iFontStore;

		}

	delete iScheduler;

	delete iGc;

	delete iGc2;

	delete iGdiTarget;

	delete iGdiTarget2;

	iTargetPixelFormatArray.Close();

	iSourcePixelFormatArray.Close();

	iSourceResourcePixelFormatArray.Close();

	}

CTDirectGdiStepBase::CTDirectGdiStepBase()

	{

	}

/**

Create a name in the format of <TestImage / RefImage>_< TestCase Name >_<DisplayModeName>_<Orientation>_<PostFix(optional)>

@param aParams A structure object of parameters to be passed through

@param aTestName The test name to be generated 

@param aTestCaseName The test case name passed in, to be used in the resultant filename

@param aNamePostfix If this is not NULL, it is appended to filename with an underscore in front of it

*/

void CTDirectGdiStepBase::CreateFileName(TTestParams& aParams, TDes& aTestName, TPtrC& aTestCaseName, TDesC* aNamePostfix)

	{	

	if (iUseDirectGdi)

		{

		aTestName.Append(KDirectGc);

		}

	else

		{

		aTestName.Append(KBitGc);		

		}

	if (aParams.iDoCompressed)

		{

		aTestName.Append(KSeparator);	

		aTestName.Append(KCom);

		}