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

//

/**

 @file

 @test

 @internalComponent - Internal Symbian test code

*/

#include "toutlineandshadowfonts.h"

#include <test/testexecutestepbase.h>

#include <openfont.h>

#include <test/thashreferenceimages.h>

#include <graphics/fbsdefs.h>

#include "fbsmessage.h"

//Note: This test should run with a rasterizer which supports EFourColourBlendGlyphBitmap (e.g. iType)

//otherwise the tests will fail.

//Path where reference mbm files get created, these reference bitmaps are useful when debugging.

_LIT(KPath, "c:\\bitgditest\\%S.mbm"); 

// Constructor

CTOutlineAndShadowFonts::CTOutlineAndShadowFonts(CTestStep* aStep):CTGraphicsBase(aStep),iStep(aStep) { }

void CTOutlineAndShadowFonts::ConstructL()

	{

	if (RFbsSession::Connect() != KErrNone)

		{

		FbsStartup();

		TInt conret = RFbsSession::Connect();

		TEST2(conret, KErrNone);

		}

	iFbs = RFbsSession::GetSession();

	iHashUtil = CTHashReferenceImages::NewL(iStep,iFbs,&KPath);

	}

// Destructor

CTOutlineAndShadowFonts::~CTOutlineAndShadowFonts()

	{

	FreeScreenDevice();

	RFbsSession::Disconnect();

	delete iHashUtil;

	}

/**

Creates screen device for the given display mode if supported

@param aMode display mode for which device has to be created

*/

void CTOutlineAndShadowFonts::CreateScreenDeviceL(TDisplayMode aMode)

	{

	iBitmap = new(ELeave) CFbsBitmap;

	//Considering the intersection of the screen size for both hw and emulator so that same

	//baselined hash can be used to test for both

	iBitmap->Create(TSize(KScreenWidth, KScreenHeight), aMode);

	iBitmapDevice = CFbsBitmapDevice::NewL(iBitmap);

	User::LeaveIfError(iBitmapDevice->CreateContext((CGraphicsContext*&)iGc));

	iHashUtil->SetScreenDeviceAndBitmap(iBitmapDevice,iBitmap,iGc);

	}

/**

Delete the devices created and gc.

*/

void CTOutlineAndShadowFonts::FreeScreenDevice()

	{

	delete iBitmapDevice;

	delete iBitmap;

	delete iGc;

	iBitmapDevice = NULL;

	iBitmap = NULL;

	iGc = NULL;

	}

/**

Auxilary function will be called in case of a leave to release the font

@param aCleanFont font to be released

*/

void CleanUpFont(TAny* aCleanFont)

	{

	SCleanFont* cleanFont= static_cast<SCleanFont*>(aCleanFont);

	(cleanFont->device)->ReleaseFont(cleanFont->font);

	}

TBool CTOutlineAndShadowFonts::CheckMonoTypeInstalledL()

	{

	CreateScreenDeviceL(EColor16MU);

//

	TFontSpec fontSpec;

	fontSpec.iTypeface.iName = KFontFace[0];

	fontSpec.iHeight = KHeight;

	fontSpec.iFontStyle.SetBitmapType(EAntiAliasedGlyphBitmap);

	fontSpec.iFontStyle.SetEffects(FontEffect::EDropShadow, EDropShadowOn);

	fontSpec.iFontStyle.SetEffects(FontEffect::EOutline, EOutlineOn);

	CFont* font;

	User::LeaveIfError(iBitmapDevice->GetNearestFontToDesignHeightInPixels((CFont*&)font,fontSpec));

	TBool monoTypeInstalled=font->FontSpecInTwips().iFontStyle.BitmapType()==EFourColourBlendGlyphBitmap;

	iBitmapDevice->ReleaseFont(font);

	if (!monoTypeInstalled)

		{

		INFO_PRINTF1(_L("Monotype fonts not installed, Run iType\\binaries\\ityperast.cmd to install them"));

		TEST(EFalse);

		TestComplete();

		}

	return(monoTypeInstalled);

	}

/**

@SYMTestCaseID GRAPHICS-BITGDI-OUTLINESHA-0008

@SYMPREQ PREQ1543

@SYMTestCaseDesc Checks the fonts metrics. Tests the metrics with and without outline and shadow effects

for different typefaces and screen modes

@SYMTestPriority Critical

@SYMTestStatus Implemented

@SYMTestActions Create two fonts, one with and without shadow and outline effects on.

Get the font metrics using GetNearestFontToDesignHeightInPixels

Compare the different font metrics for both the fonts.

API Calls:

CTOutlineAndShadowFonts::DoOutlineandShadowFontsMetrics()

@SYMTestExpectedResults font metrics with and without outline and shadow effects should not vary by more than 3.

*/

void CTOutlineAndShadowFonts::TestOutlineandShadowFontsMetricsL()

	{

	INFO_PRINTF1(_L("TestOutlineandShadowFontsMetricsL()"));

	FreeScreenDevice();

	CreateScreenDeviceL(EColor16MU); //Create device for EColor16MU

	for (TInt fontFaceIndex = 0; fontFaceIndex < KNumOfFontFaces; fontFaceIndex++)

		{

		for (TInt numOfSubTests = 0; numOfSubTests < KNumberOfSubTestsInTest0008; numOfSubTests++)

			{

			DoOutlineandShadowFontsMetrics(KTestSettingsToTestFontMetrics[numOfSubTests], fontFaceIndex);

			}

		}

	}

/** 

Utility function to determine whether a specified value lies within a defined range of values.

@param aMin The lower value of the range.

@param aValue The value to be compared.

@param aMax The higher value of the range.

@return ETrue, if the specified value lies within the range; EFalse, otherwise.

*/

TBool CTOutlineAndShadowFonts::TestRange(TInt aMin, TInt aValue, TInt aMax)

	{

	if (Rng(aMin, aValue, aMax))

		{

		return ETrue;

		}

	else

		{

		INFO_PRINTF4(_L("TestRange: !(%i !<= %i !<= %i)"), aMin, aValue, aMax);

		return EFalse;

		}

	}

/** 

Utility function to determine whether a specified value is below a certain value.

@param aValue The value to be compared.

@param aMax The highest permitted value.

@return ETrue, if the specified value is below the maximum; EFalse, otherwise.

*/

TBool CTOutlineAndShadowFonts::TestLessThanOrEqual(TInt aValue, TInt aMax)

	{

	if (aValue <= aMax)

		{

		return ETrue;

		}

	else

		{

		INFO_PRINTF3(_L("TestLessThanOrEqual: !(%i !<= %i)"), aValue, aMax);

		return EFalse;

		}

	}

/**

Auxilary function called from TestOutlineandShadowFontsMetricsL

@param aSettings holds the effects settings (outline, shadow etc...)

@param aFontIndex holds the font index

*/

void CTOutlineAndShadowFonts::DoOutlineandShadowFontsMetrics(const STestFontParameters &aSettings, TInt aFontIndex)

	{

	TFontSpec fontSpecWithOutEffects;

	//Create fontspec without shadow and outline effects on

	PrepareTestEnvironment(fontSpecWithOutEffects, aSettings , aFontIndex, EFalse, EFalse);

	CFbsFont* font1 = NULL;

	TEST(iBitmapDevice->GetNearestFontToDesignHeightInPixels((CFont*&)font1,fontSpecWithOutEffects) == KErrNone);

	TEST(font1 != NULL);

	TFontSpec fontSpecWithEffects;

	//Create fontspec with shadow and outline effects on if asked for

	PrepareTestEnvironment(fontSpecWithEffects, aSettings, aFontIndex, ETrue, EFalse);

	CFbsFont* font2 = NULL;

	TEST(iBitmapDevice->GetNearestFontToDesignHeightInPixels((CFont*&)font2,fontSpecWithEffects) == KErrNone);

	TEST(font2 != NULL);

	//get the name of the fonts

	TOpenFontFaceAttrib font1Attrib;

	TBool haveFont1Attrib;

	haveFont1Attrib = font1->GetFaceAttrib(font1Attrib);

	INFO_PRINTF1(_L("Font names"));

	if (haveFont1Attrib)

		{

		INFO_PRINTF1(font1Attrib.FullName());

		}

	TOpenFontFaceAttrib font2Attrib;

	TBool haveFont2Attrib;

	haveFont2Attrib = font2->GetFaceAttrib(font2Attrib);

	if (haveFont2Attrib)

		{

		INFO_PRINTF1(font2Attrib.FullName());

		}

	//Check different font metrics with and without outline and shadow effects

	TUid uid1 = font1->TypeUid();

	TUid uid2 = font2->TypeUid();

	ASSERT_EQUALS(KCFbsFontUid, uid1);

	ASSERT_EQUALS(KCFbsFontUid, uid2);

	TInt valueFontWithoutEffects = font1->AscentInPixels();

	TInt valueFontWithEffects = font2->AscentInPixels();

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	valueFontWithoutEffects = font1->BaselineOffsetInPixels();

	valueFontWithEffects = font2->BaselineOffsetInPixels();

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	for (TInt c=0;c<256;c++)

		{

		valueFontWithoutEffects = font1->CharWidthInPixels(c);

		valueFontWithEffects = font2->CharWidthInPixels(c);

		TEST(valueFontWithoutEffects == valueFontWithEffects);

		}

	//CharactersJoin

	valueFontWithoutEffects = font1->DescentInPixels();

	valueFontWithEffects = font2->DescentInPixels();

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	//Extended function

	valueFontWithoutEffects = font1->FontCapitalAscent();

	valueFontWithEffects = font2->FontCapitalAscent();

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	valueFontWithoutEffects = font1->FontLineGap();

	valueFontWithEffects = font2->FontLineGap();

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	valueFontWithoutEffects = font1->FontMaxAscent();

	valueFontWithEffects = font2->FontMaxAscent();

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	valueFontWithoutEffects = font1->FontMaxDescent();

	valueFontWithEffects = font2->FontMaxDescent();

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	valueFontWithoutEffects = font1->FontMaxHeight();

	valueFontWithEffects = font2->FontMaxHeight();

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	//FontSpecInTwips -  will be different

	TFontSpec spec = font1->FontSpecInTwips();

	TFontSpec spec2 = font2->FontSpecInTwips();

	TEST(spec.iHeight == spec2.iHeight);

	valueFontWithoutEffects = font1->FontStandardDescent();

	valueFontWithEffects = font2->FontStandardDescent();

	TEST(valueFontWithoutEffects+KDifferByOne >= valueFontWithEffects);

	valueFontWithoutEffects = font1->HeightInPixels();

	valueFontWithEffects = font2->HeightInPixels();

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	valueFontWithoutEffects = font1->MaxCharWidthInPixels();

	valueFontWithEffects = font2->MaxCharWidthInPixels();

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	valueFontWithoutEffects = font1->MaxNormalCharWidthInPixels();

	valueFontWithEffects = font2->MaxNormalCharWidthInPixels();

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	_LIT(KMeasureText,"ABCdef456");

	CFont::TMeasureTextOutput out1;

	CFont::TMeasureTextOutput out2;

	valueFontWithoutEffects = font1->MeasureText(KMeasureText,NULL,&out1);

	valueFontWithEffects = font2->MeasureText(KMeasureText,NULL,&out2);

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	TEST(out1.iChars == out2.iChars);

	TEST(out1.iGlyphs == out2.iGlyphs);

	TEST(out1.iGroups == out2.iGroups);

	TEST(out1.iSpaces == out2.iSpaces);

	TEST(TestLessThanOrEqual(out1.iBounds.iTl.iX-KDifferByOne, out2.iBounds.iTl.iX));

	TEST(TestLessThanOrEqual(out1.iBounds.iTl.iY-KDifferByOne, out2.iBounds.iTl.iY));

	TEST(TestLessThanOrEqual(out1.iBounds.iBr.iX-KDifferByOne, out2.iBounds.iBr.iX));

	TEST(TestLessThanOrEqual(out1.iBounds.iBr.iY-KDifferByOne, out2.iBounds.iBr.iY));

	TEST(TestLessThanOrEqual(out1.iMaxGlyphSize.iHeight-KDifferByOne, out2.iMaxGlyphSize.iHeight));

	TEST(TestLessThanOrEqual(out1.iMaxGlyphSize.iWidth-KDifferByOne, out2.iMaxGlyphSize.iWidth));

	valueFontWithoutEffects = font1->TextCount(KMeasureText, 30);

	valueFontWithEffects = font2->TextCount(KMeasureText, 30);

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	TInt val3;

	TInt val4;

	valueFontWithoutEffects = font1->TextCount(KMeasureText, 30, val3);

	valueFontWithEffects = font2->TextCount(KMeasureText, 30, val4);

	TEST(val3 == val4);

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	valueFontWithoutEffects = font1->TextWidthInPixels(KMeasureText);

	valueFontWithEffects = font2->TextWidthInPixels(KMeasureText);

	TEST(TestRange(valueFontWithoutEffects, valueFontWithEffects, valueFontWithoutEffects+KDifferByThree));

	uid1 = font1->TypeUid();

	uid2 = font2->TypeUid();

	TEST(uid1 == uid2);

	for (TInt c=0;c<256;c++)

		{

		const TUint8 *p1 = NULL;

		const TUint8 *p2 = NULL;

		TCharacterMetrics m1 = font1->CharacterMetrics(c, p1);

		TCharacterMetrics m2 = font2->CharacterMetrics(c, p2);

		TEST(TestLessThanOrEqual(m1.iAscentInPixels-KDifferByOne, m2.iAscentInPixels));

		TEST(TestLessThanOrEqual(m1.iHeightInPixels-KDifferByOne, m2.iHeightInPixels));

		TEST(TestLessThanOrEqual(m1.iLeftAdjustInPixels-KDifferByTwo, m2.iLeftAdjustInPixels));

		TEST(m1.iMoveInPixels == m2.iMoveInPixels);

		TEST(TestLessThanOrEqual(m1.iRightAdjustInPixels-KDifferByTwo, m2.iRightAdjustInPixels));

		}

	TOpenFontMetrics ofm1;

	TOpenFontMetrics ofm2;

	TBool r1 = font1->GetFontMetrics(ofm1);

	TBool r2 = font2->GetFontMetrics(ofm2);

	TEST(ofm1.Size() == ofm2.Size());

	TEST(ofm1.Ascent() == ofm2.Ascent());

	TEST(ofm1.Descent() == ofm2.Descent());

	TEST(ofm1.MaxHeight() == ofm2.MaxHeight());

	TEST(ofm1.MaxDepth() == ofm2.MaxDepth());

	TEST(ofm1.MaxWidth() == ofm2.MaxWidth());

	valueFontWithoutEffects = font1->RawTextWidthInPixels(KMeasureText);

	valueFontWithEffects = font2->RawTextWidthInPixels(KMeasureText);

	TEST(valueFontWithoutEffects == valueFontWithEffects);

	valueFontWithoutEffects = font1->TextWidthInPixels(KMeasureText);

	valueFontWithEffects = font2->TextWidthInPixels(KMeasureText);

	TEST(TestLessThanOrEqual(valueFontWithoutEffects, valueFontWithEffects));

	SCharWidth scw1;

	SCharWidth scw2;

	font1->TextWidthInPixels(KMeasureText,scw1);

	font2->TextWidthInPixels(KMeasureText,scw2);

	TEST(TestLessThanOrEqual(scw1.iLeftAdjust-KDifferByOne, scw2.iLeftAdjust));

	TEST(scw1.iMove == scw2.iMove);

	TEST(TestLessThanOrEqual(scw1.iRightAdjust-KDifferByTwo, scw2.iRightAdjust));

	TEST(TestLessThanOrEqual(scw1.iWidth-KDifferByOne, scw2.iWidth));

	iBitmapDevice->ReleaseFont(font2);

	iBitmapDevice->ReleaseFont(font1);

	}

/**

@SYMTestCaseID GRAPHICS-BITGDI-OUTLINESHA-0009

@SYMPREQ PREQ1543

@SYMTestCaseDesc Test the setter and getters for pen colour, brush colour and shadow colour.

@SYMTestPriority Critical

@SYMTestStatus Implemented

@SYMTestActions Set colors to pen, brush and shadow call SetPenColor(), SetBrushColor(), SetShadowColor() respectively

Get colors of pen, brush and shadow using PenColor(), BrushColor() and GetShadowColor() respectively

@SYMTestExpectedResults pen, brush and shadow colour should return default colours if not set,

else should return the colour set using SetPenColor(), SetBrushColor() and SetShadowColor() respectively

*/

void CTOutlineAndShadowFonts::TestOutlinePenAndShadowColorL()

	{

	INFO_PRINTF1(_L("TestOutlinePenAndShadowColorL()"));

	for(TInt displayMode = ENone; displayMode < KNumOfDisplayModes; displayMode++)

		{

		FreeScreenDevice();

		CreateScreenDeviceL(KDisplayModes[displayMode]);

		DoOutlinePenAndShadowColor();

		}

	}

/**

Auxilary function called from TestOutlinePenAndShadowColorL

API Calls:

CFbsBitGc::PenColor()

CFbsBitGc::SetPenColor()

CFbsBitGc::BrushColor()

CFbsBitGc::SetBrushColor()

CFbsBitGc::GetShadowColor()

CFbsBitGc::SetShadowColor()

*/

void CTOutlineAndShadowFonts::DoOutlinePenAndShadowColor()

	{

	//iGc->Reset();

	TRgb color;

	color = iGc->PenColor();

	//Pen colour is used for drawing outline

	TEST(color == KDefaultOutlinePenColor);

	color = iGc->BrushColor();

	//Brush colour is used as fill colour

	TEST(color == KDefaultFillColor);

	iGc->GetShadowColor(color);

	TEST(color == KDefaultShadowColor);

	iGc->SetShadowColor(KRgbGreen);

	iGc->GetShadowColor(color);

	TEST(color == KRgbGreen);

	iGc->SetPenColor(KRgbYellow);

	color = iGc->PenColor();

	TEST(color == KRgbYellow);

	iGc->SetBrushColor(KRgbRed);

	color = iGc->BrushColor();

	TEST(color == KRgbRed);

	}

/**

@SYMTestCaseID GRAPHICS-BITGDI-OUTLINESHA-0010

@SYMPREQ PREQ1543

@SYMTestCaseDesc Tests the text drawn using DrawTextVertical and DrawText with shadow and outline effects on

with different display modes and orientations.

@SYMTestPriority Critical

@SYMTestStatus Implemented

@SYMTestActions Call DrawTextVertical and DrawText with different effect on, display modes and orientations.

API Calls:

CFbsBitGc::DrawTextVertical()

CFbsBitGc::DrawText()

CTOutlineAndShadowFonts::CompareHashValuesL()

@SYMTestExpectedResults Hash generated for the drawn text should be same with the baselined hash value.

*/

void CTOutlineAndShadowFonts::TestDrawTextWithOutlineAndShadowL()

	{

	INFO_PRINTF1(_L("TestDrawTextWithOutlineAndShadowL()"));

	for(TInt displayMode = 0; displayMode < KNumOfDisplayModes; displayMode++)

		{

		FreeScreenDevice();

		CreateScreenDeviceL(KDisplayModes[displayMode]);

		INFO_PRINTF2(_L("Display mode: %S"), &KDisplayModeNames[displayMode]);

		for (TInt orient = CFbsBitGc::EGraphicsOrientationNormal; orient <= CFbsBitGc::EGraphicsOrientationRotated270; orient++)

			{

			iGc->SetOrientation((CFbsBitGc::TGraphicsOrientation)orient);

			for (TInt fontFaceIndex = 0; fontFaceIndex < KNumOfFontFaces; fontFaceIndex++)

				{

				for (TInt numOfSubTests = 0; numOfSubTests < KNumberOfSubTestsInTest0010; numOfSubTests++)

					{

					//Test with only one display mode i.e. EColor16MU for EMonochromeGlyphBitmap to reduce test execution time

					if ((KTestSettingsToTestOutlineAndShadow[numOfSubTests].fSpecAndGcSettings & ESetMonochromeGlyphBitmap) && (displayMode != EColor16MU))

						{

						continue;

						}

					//Test transparency for display mode EColor64K and above as it is not supported in other display modes

					if (KTestSettingsToTestOutlineAndShadow[numOfSubTests].penColor.Alpha() < 255 && displayMode < 6)

						{

						continue;

						}

					HBufC* hashIdString = iHashUtil->GenerateHashIdStringLC(KTestName0010, numOfSubTests, KFontFaceShortName, fontFaceIndex, displayMode, orient);

					DoDrawTextWithOutlineAndShadowL(KTestSettingsToTestOutlineAndShadow[numOfSubTests], *hashIdString, fontFaceIndex);

					CleanupStack::PopAndDestroy(hashIdString);

					}

				}

			}

		}

	iGc->SetOrientation(CFbsBitGc::EGraphicsOrientationNormal);

	}

/**

Auxilary function called TestDrawTextWithOutlineAndShadowL.

@param aSettings holds the effects settings (Outline, Shadow, Bitmap type etc...)

@param aHashIdString holds the HashID string

@param aFontIndex holds the font index

*/

void CTOutlineAndShadowFonts::DoDrawTextWithOutlineAndShadowL(const STestFontParameters &aSettings, const TDesC& aHashIdString, const TInt aFontIndex)

	{

	TFontSpec fontSpec;

	PrepareTestEnvironment(fontSpec, aSettings, aFontIndex, ETrue, ETrue);

	CFont* font;

	TEST(iBitmapDevice->GetNearestFontToDesignHeightInPixels((CFont*&)font, fontSpec) == KErrNone);

	SCleanFont cleanupFont = {iBitmapDevice, font};

	CleanupStack::PushL(TCleanupItem(CleanUpFont, &cleanupFont));

	iGc->UseFont(font);

	if(EVerticalDraw & aSettings.fSpecAndGcSettings)

		{

		iGc->DrawTextVertical(KTextPhrase, TPoint(20,60), ERotate90Degrees & aSettings.fSpecAndGcSettings);

		}

	else

		{

		iGc->DrawText(KTextPhrase, KPoint);

		}

	iHashUtil->CompareHashValuesL(aHashIdString);

	CleanupStack::Pop();//font

	iBitmapDevice->ReleaseFont(font);

	iGc->DiscardFont();

	}

/**

@SYMTestCaseID GRAPHICS-BITGDI-OUTLINESHA-0011

@SYMPREQ PREQ1543

@SYMTestCaseDesc Tests outline and shadow effects with strikethrough, softedge and underLine

for different orientations.

@SYMTestPriority Critical

@SYMTestStatus Implemented