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

// Tests to meet REQ758.2: "Captions localization must be efficient

// (i.e. not waste disk space) and extensible (i.e. support non-ROM language packs)"\n

// Test for UIKON GT0143 Typhoon Work Series 60 Changes

// REQ758.2: Captions localization must be efficient (i.e. not waste disk space)

// and extensible (i.e. support non-ROM language packs)

// Test for CR0902 - Enable Dynamic Language Switching in APPARC.

// Application's localisable information should be updated by apparc on language change event.

// 

//

/**

 @file

 @internalComponent - Internal Symbian test code 

*/

#include <e32test.h>

#include <f32file.h>

#include <apgicnfl.h>

#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS

#include <apgicnflpartner.h>

#endif //SYMBIAN_ENABLE_SPLIT_HEADERS

#include <hal.h>

#include <apgcli.h>

#include "T_LocaleStep.h"

const TUid KUidTestApp = { 10 }; //uid of tstapp.

const TUid KUidCustomiseDefaultIconApp = {0x10208181}; // uid of CustomiseDefaultIconApp.

const TInt KDelayForOnDemand = 20000; //a small delay

const TInt KDelay = 4000000; // Most apparc tests have 2.5 secs wait time to let apparc update the app-list, but on safer side let us give 4 secs.

const TInt KViewCount = 3; // Total no of views in tstapp

/**

  Auxiliary Fn for Test Case ID T-LocaleStep-TestAllLanguages

  This method loads the required DLL for the language specified as argument

  and changes the locale accordingly.

*/

void CT_LocaleStep::ChangeLocaleL(TLanguage aLanguage)

	{

#ifdef SYMBIAN_DISTINCT_LOCALE_MODEL 

	_LIT(KLitLocaleDllNameBase, "elocl_lan");

	_LIT(KLitLocaleDllNameExtension, ".loc");

#else

	_LIT(KLitLocaleDllNameBase, "ELOCL");

	_LIT(KLitLocaleDllNameExtension, ".LOC");

#endif	        

	RLibrary localeDll;

	TBuf<16> localeDllName(KLitLocaleDllNameBase);

	CleanupClosePushL(localeDll);

	const TUidType uidType(TUid::Uid(0x10000079),TUid::Uid(0x100039e6));

#ifdef SYMBIAN_DISTINCT_LOCALE_MODEL	        

	_LIT(ThreeDigExt,".%03d");

	localeDllName.AppendFormat(ThreeDigExt, aLanguage);

#else

	_LIT(TwoDigExt,".%02d");

	localeDllName.AppendFormat(TwoDigExt, aLanguage);

#endif	        

	TInt error=localeDll.Load(localeDllName, uidType);

	if (error==KErrNotFound)

	    {

        localeDllName=KLitLocaleDllNameBase;

        localeDllName.Append(KLitLocaleDllNameExtension);

        error=localeDll.Load(localeDllName, uidType);

        }

    User::LeaveIfError(error);

#ifdef 	SYMBIAN_DISTINCT_LOCALE_MODEL

    TExtendedLocale myExtendedLocale;

    User::LeaveIfError(myExtendedLocale.LoadLocaleAspect(localeDllName));

    User::LeaveIfError(myExtendedLocale.SaveSystemSettings());

#else	

	User::LeaveIfError(UserSvr::ChangeLocale(localeDllName));

#endif

	CleanupStack::PopAndDestroy(); // localeDll

	}

// CheckIcons is a function used in testcase TestLocaleDefaultIconL to check the size of the default icons

void CT_LocaleStep::CheckIcons(CArrayFixFlat<TSize>* aNewIconSizes,TSize aSmall,TSize aMedium,TSize aLarge, TSize& afstIcon, TSize& asecIcon, TSize& atrdIcon)

	{

	afstIcon = (*aNewIconSizes)[0];

	asecIcon = (*aNewIconSizes)[1];

	atrdIcon = (*aNewIconSizes)[2];

	TEST((afstIcon==aSmall) || (afstIcon==aMedium) || (afstIcon==aLarge) && ((afstIcon!=asecIcon) && (afstIcon!=atrdIcon)));

	TEST((asecIcon==aSmall) || (asecIcon==aMedium) || (asecIcon==aLarge) && ((asecIcon!=afstIcon) && (asecIcon!=atrdIcon)));

	TEST((atrdIcon==aSmall) || (atrdIcon==aMedium) || (atrdIcon==aLarge) && ((atrdIcon!=afstIcon) && (atrdIcon!=asecIcon)));	

	}

/**

  @SYMTestCaseID APPFWK-APPARC-0070

  @SYMPREQ

  @SYMTestCaseDesc Test whether the default app icons change with respect to the locale/language.

  This testcase checks whether BaflUtils::NearestLanguageFile is called when the locale has been changed.

  @SYMTestPriority High  

  @SYMTestStatus Implemented

  @SYMTestActions  Call User::Language() to check that the default locale is English; Call CT_LocaleStep::CheckIcons 

  to check the size of the current default icons; Call UserSvr::ChangeLocale to change the Locale to French; 

  Call CT_LocaleStep::CheckIcons to check the size of the new icons; Restore the file system and the locale 

  and check if the icons are restored.

  API Calls:\n	

  @SYMTestExpectedResults Returns KErrNone

 */	

void CT_LocaleStep::TestLocaleDefaultIconL()

	{

	INFO_PRINTF1(_L("APPFWK-APPARC-0070: TestLocaleDefaultIconL started..."));	

	TInt ret = 0;

	//first checks that language is not currently set to French (any other language except English since English is the default language

	TEST(User::Language()!=ELangFrench);

	// getappiconsizes must be called to check if the icons are the default ones

	// KUidCustomiseDefaultIconApp - uid of CustomiseDefaultIconApp_reg.RSS; this app has a localisable resource file, CustomiseDefaultIconApp_loc.RSS, that does not define any icon

	// Hence, the default icons must be picked up when the language changes to French. The default icons for French are defined in default_app_icon.m02

	CArrayFixFlat<TSize>* newIconSizes = new(ELeave) CArrayFixFlat<TSize>(3);

	CleanupStack::PushL(newIconSizes);

	TRAP(ret,iLs.GetAppIconSizes(KUidCustomiseDefaultIconApp, *newIconSizes));

	TEST(ret==KErrNone);

	TEST(newIconSizes->Count()!=0);

	// these are the sizes of the default icons

	TSize small(24,24);

	TSize medium(32,32);

	TSize large(48,48);

	TSize fstIcon;

	TSize secIcon;

	TSize trdIcon;

	CheckIcons(newIconSizes, small, medium,large, fstIcon, secIcon, trdIcon);

	// Change the locale to French

	TRAP(ret,ChangeLocaleL(ELangFrench));

	TEST(ret==KErrNone);

	TEST(User::Language()==ELangFrench);//checks that the language has been set to French

	//Wait for a small period to let apparc receive language change notification

	User::After(KDelayForOnDemand);

	//call getappiconsizes to see if the new icons have been changed as as expected 

	// The size of the icons indicates whether the icon corresponding to French Locale has been picked up

	newIconSizes->Reset();

	TRAP(ret,iLs.GetAppIconSizes(KUidCustomiseDefaultIconApp, *newIconSizes));

	TEST(ret==KErrNone);

	TEST(newIconSizes->Count()!=0);

	small.SetSize(25,25);

	medium.SetSize(35,35);

	large.SetSize(50,50);

	CheckIcons(newIconSizes, small, medium,large, fstIcon, secIcon, trdIcon);

	//have to restore the locale before exiting the testcase

	TRAP(ret,ChangeLocaleL(ELangEnglish));

	TEST(ret==KErrNone);

	TEST(User::Language()==ELangEnglish);

	//Again wait for a small period to let apparc receive language change notification

	User::After(KDelayForOnDemand);

	//call getappiconsizes to see if the new icons have been changed as as expected 

	// The size of the icons indicates whether the icon corresponding to English Locale has been picked up

	newIconSizes->Reset();

	TRAP(ret,iLs.GetAppIconSizes(KUidCustomiseDefaultIconApp, *newIconSizes));

	TEST(ret==KErrNone);

	TEST(newIconSizes->Count()!=0);

	small.SetSize(24,24);

	medium.SetSize(32,32);

	large.SetSize(48,48);

	CheckIcons(newIconSizes, small, medium,large, fstIcon, secIcon, trdIcon);

	// Icon cleanup

	CleanupStack::PopAndDestroy(newIconSizes);

	newIconSizes=NULL;

	INFO_PRINTF1(_L("APPFWK-APPARC-0070: TestLocaleDefaultIconL finished..."));	

	}

/**

  @SYMTestCaseID APPFWK-APPARC-0061

  @SYMPREQ CR0902 - Enable Dynamic Language Switching in APPARC.

  @SYMTestCaseDesc Test whether caption, short caption and app icon, is updated with respect to the change 

  in locale/language. This test case checks on language change event apparc updates application 

  localisable information for all installed applications, without forcing a change in the part of 

  file system which apparc monitors. 

  This test also tests, on a language change event, application's localisable information is 

  updated immediately, if not yet updated by the re-scan (On demand loading). This is done by not 

  giving enough time to finish rescan of app-list.

  @SYMTestPriority Critical 

  @SYMTestStatus Implemented

  @SYMTestActions  Check if language is English by calling User::Language(). 

  1. Call GetAppInfo() by passing an application's UID which provides support for multiple languages.

  Check if the caption and short caption, both are in English. Change locale to French.

  2. Call GetAppIcon() by passing same application's UID. Check app icons are same as sepcified in 

  app icon file for English locale.

  Wait for a small period (20 milli seconds) to let apparc receive language change notification. 

  Again - 

  1. Call GetAppInfo() by passing same application's UID and check if the caption and short caption, 

  both are in French.

  2. Call GetAppIcon() by passing same application's UID. Check app icons are same as sepcified in 

  app icon file for French locale.

  Restore locale to English and again check - 

  1. If caption and short caption are in English after a call to GetAppInfo() for the same application.

  2. Call GetAppIcon() by passing same application's UID. Check app icons are same as sepcified in 

  app icon file for English locale.

  @SYMTestExpectedResults 

  1. GetAppInfo() should fetch caption and short caption in the newly-set language.

  2. GetAppIcon() should fetch icons from the icon file selected for current locale.

 */	

void CT_LocaleStep::TestLocaleApplicationInfoOnDemandL()

	{

	INFO_PRINTF1(_L("APPFWK-APPARC-0061: TestLocaleApplicationInfoOnDemandL started..."));

	TestAppInfoL(ETrue);

	INFO_PRINTF1(_L("APPFWK-APPARC-0061: TestLocaleApplicationInfoOnDemandL finished..."));	

	}

/**

  @SYMTestCaseID APPFWK-APPARC-0062

  @SYMPREQ CR0902 - Enable Dynamic Language Switching in APPARC.

  @SYMTestCaseDesc Test whether caption, short caption and app icon, is updated with respect to the change in 

  locale/language. This test case checks on language change event apparc updates application localisable

  information for all installed applications, without forcing a change in the part of file system which 

  apparc monitors.

  @SYMTestPriority Critical

  @SYMTestStatus Implemented

  @SYMTestActions  Check if language is English by calling User::Language(). 

  1. Call GetAppInfo() by passing an application's UID which provides support for multiple languages.

  Check if the caption and short caption, both are in English. Change locale to French.

  2. Call GetAppIcon by passing same application's UID. Check app icons are same as sepcified in 

  app icon file for English locale.

  Change locale to French. Wait for some time (e.g. 4 seconds) to let apparc complete rescanning of app-list.

  Again - 

  1. Call GetAppInfo() by passing same application's UID and check if the caption and short caption, 

  both are in French.

  2. Call GetAppIcon() by passing same application's UID. Check app icons are same as sepcified in 

  app icon file for French locale.

  Restore locale to English and again check - 

  1. If caption and short caption are in English after a call to GetAppInfo() for the same application.

  2. Call GetAppIcon() by passing same application's UID. Check app icons are same as sepcified in 

  app icon file for English locale.

  @SYMTestExpectedResults 

  1. GetAppInfo() should fetch caption and short caption in the newly-set language.

  2. GetAppIcon() should fetch icons from the icon file selected for current locale.  

 */	

void CT_LocaleStep::TestLocaleApplicationInfoL()

	{

	INFO_PRINTF1(_L("APPFWK-APPARC-0062: TestLocaleApplicationInfoL started..."));	

	TestAppInfoL(EFalse);	

	INFO_PRINTF1(_L("APPFWK-APPARC-0062: TestLocaleApplicationInfoL finished..."));	

	}

/** 

  This function performs steps to test application related information (caption, short caption and app icon)

  on language change event . 

  It is called from TestLocaleApplicationInfoOnDemandL and TestLocaleApplicationInfoL.

  @param aOnDemand Pass true if on demand loading is required, otherwise false.

*/

void CT_LocaleStep::TestAppInfoL(TBool aOnDemand)

	{

	TInt ret = RFbsSession::Connect();

	TEST(ret == KErrNone);

	// If it is on-demand loading delay would be very less.

	TInt delay = aOnDemand ? KDelayForOnDemand : KDelay;

	// Check language is not currently set to French (any other language except English since English is the default language.

	TEST(User::Language() != ELangFrench);

	// Caption and Short-caption should be same as defined in English localisable strings file (tstapp01.rls)

	_LIT(KCaptionEng, "TstCap UK"); 

	_LIT(KShortCaptionEng, "TC UK");

	// Call GetAppInfo() by passing KUidTestApp as tstapp's UID. tstapp provides support for multiple languages.

	TApaAppInfo appInfo;

	ret = iLs.GetAppInfo(appInfo, KUidTestApp);

	TEST(ret == KErrNone);

	// Caption and short-caption should be in English.

	TEST(appInfo.iCaption == KCaptionEng);

	TEST(appInfo.iShortCaption == KShortCaptionEng);

	// Test application's icons, should be same as sepcified in app icon file for English locale.

	TestAppIconL(TSize(40,55));

	// Change the locale to French

	TRAP(ret, ChangeLocaleL(ELangFrench));

	TEST(ret == KErrNone);

	TEST(User::Language() == ELangFrench);//check language is set to French

	// Caption and Short-caption should be same as defined in French localisable strings file (tstapp02.rls)

	_LIT(KCaptionFrench, "TstCap FR");

	_LIT(KShortCaptionFrench, "TC FR");

	User::After(delay);

	// Again call GetAppInfo() by passing KUidTestApp as UID. 	

	ret = iLs.GetAppInfo(appInfo, KUidTestApp);

	TEST(ret == KErrNone);

	// Caption and short-caption should be in French.

	TEST(appInfo.iCaption == KCaptionFrench);

	TEST(appInfo.iShortCaption == KShortCaptionFrench);

	// Test application's icons, should be same as sepcified in app icon file for French locale.

	TestAppIconL(TSize(50,50));

	// Restore locale before exiting the testcase.

	TRAP(ret, ChangeLocaleL(ELangEnglish));

	TEST(ret == KErrNone);

	TEST(User::Language() == ELangEnglish);

	User::After(delay);

	ret = iLs.GetAppInfo(appInfo, KUidTestApp);

	TEST(ret == KErrNone);

	// Caption and short-caption should again be in English.

	TEST(appInfo.iCaption == KCaptionEng);

	TEST(appInfo.iShortCaption == KShortCaptionEng);

	// Test application's icons, should be same as sepcified in app icon file for English locale.

	TestAppIconL(TSize(40,55));

	RFbsSession::Disconnect();

	}

/**

  This function tests application's icon. It is called from TestAppInfoL function.

*/	

void CT_LocaleStep::TestAppIconL(TSize aSize)

	{

	CApaMaskedBitmap* icon = CApaMaskedBitmap::NewLC();

	TSize lastSize(0,0);

	TInt ret = iLs.GetAppIcon(KUidTestApp, aSize, *icon);

	TEST(ret == KErrNone);

	// Returned icon size should be exactly same as asked.

	TEST(icon->SizeInPixels().iWidth * icon->SizeInPixels().iHeight == aSize.iWidth * aSize.iHeight);

	CleanupStack::PopAndDestroy(icon);

	}

/**

  @SYMTestCaseID APPFWK-APPARC-0063

  @SYMPREQ CR0902 - Enable Dynamic Language Switching in APPARC.

  @SYMTestCaseDesc Test whether caption and short caption remains same on language change, if application

   does not provide support for multiple languages. 

  @SYMTestPriority Critical 

  @SYMTestStatus Implemented

  @SYMTestActions  Check if language is English by calling User::Language(). Call GetAppInfo() by passing an

  application's UID which does not provide support for multiple languages. Check if the caption and short 

  caption, both are in English. Change locale to French.Wait for a small period (20 milli seconds) to let 

  apparc receive language change notification. Again Call GetAppInfo() by passing same application's UID and 

  check if the caption and short caption, both are still in English. Restore locale to English and again check 

  if caption and short caption are in English after a call to GetAppInfo() for the same application.

  @SYMTestExpectedResults GetAppInfo() should fetch caption and short caption in the same language. 

 */	

void CT_LocaleStep::TestLocaleApplicationInfo1L()

	{

	INFO_PRINTF1(_L("APPFWK-APPARC-0063: TestLocaleApplicationInfo1L started..."));	

	TInt ret = KErrNotFound;	

	// Check language is not currently set to French (any other language except English since English is the default language.

	TEST(User::Language() != ELangFrench);

	// Caption and Short-caption should be same as defined in the localisable resource file. (CustomiseDefaultIconApp_loc.RSS)

	_LIT(KCaptionEng, "CustomiseDefaultIconAppLong"); 

	_LIT(KShortCaptionEng, "CustomiseDefaultIconApp");

	// KUidCustomiseDefaultIconApp - uid of CustomiseDefaultIconApp_reg.RSS; this app does not provide support for multiple languages.

	// Call GetAppInfo() by passing above UID.

	TApaAppInfo appInfo;

	ret = iLs.GetAppInfo(appInfo, KUidCustomiseDefaultIconApp);

	TEST(ret == KErrNone);

	// Caption and short-caption should be in English.	

	TEST(appInfo.iCaption == KCaptionEng);

	TEST(appInfo.iShortCaption == KShortCaptionEng);

	// Change the locale to French

	TRAP(ret,ChangeLocaleL(ELangFrench));

	TEST(ret == KErrNone);

	TEST(User::Language() == ELangFrench);//check language is set to French.

	// Wait for a small period (20 milli seconds) to let apparc receive language change notification. 

	User::After(KDelayForOnDemand);	

	// Again call GetAppInfo() by passing KUidTestApp as UID. 	

	ret = iLs.GetAppInfo(appInfo, KUidCustomiseDefaultIconApp);

	TEST(ret == KErrNone);

	// Caption and short-caption should be in English.

	TEST(appInfo.iCaption == KCaptionEng);

	TEST(appInfo.iShortCaption == KShortCaptionEng);	

	// Restore locale before exiting the testcase.

	TRAP(ret,ChangeLocaleL(ELangEnglish));

	TEST(ret == KErrNone);

	TEST(User::Language() == ELangEnglish);

	User::After(KDelayForOnDemand);

	ret = iLs.GetAppInfo(appInfo, KUidCustomiseDefaultIconApp);

	TEST(ret == KErrNone);

	// Caption and short-caption should be in English again.

	TEST(appInfo.iCaption == KCaptionEng);

	TEST(appInfo.iShortCaption == KShortCaptionEng);

	INFO_PRINTF1(_L("APPFWK-APPARC-0063: TestLocaleApplicationInfo1L finished..."));	

	}

/**

  @SYMTestCaseID APPFWK-APPARC-0064 APPFWK-APPARC-0066 APPFWK-APPARC-0068

  @SYMPREQ CR0902 - Enable Dynamic Language Switching in APPARC.

  @SYMTestCaseDesc Test whether 

  1. View's caption is updated with respect to the change in locale/language. 

  2. View's icons is updated with respect to the change in locale/language. 

  3. View's icon file name changes with respect to the change in locale/language. 

  This test case checks apparc updates application localisable information for all installed applications 

  on language change event without forcing a change in the part of file system which apparc monitors.

  This test also tests, on a language change event, application's localisable information is updated 

  immediately, if not yet updated by the re-scan (On demand loading). This is done by not giving enough 

  time to finish rescan of app-list.

  @SYMTestPriority High 

  @SYMTestStatus Implemented

  @SYMTestActions  Check if language is English by calling User::Language(). Call GetAppViews() by passing 

  an application's UID which provides support for multiple languages and different size icons for French 

  language. 

  1. Check if all view captions are same as specified in localisable file and in English.  

  2. Call GetAppViewIcon() passing above application's ID. Check view icon size, it should be as 

  specified in English icon file.

  3. Call overload of GetAppViewIcon() which returns view's icon file, passing above application's ID. 

  Change locale to French.Wait for a small period (20 milli seconds) to let apparc receive language change 

  notification. Again - 

  1. Call GetAppViews() by passing same application's UID and check if the view captions for all views 

  are in French.

  2. Call GetAppViewIcon() by passing same application's UID.Check view icon size, it should be as specified 

  in French icon file.

  3. Call GetAppViewIcon() by passing same application's UID. Check view icon file, it should be same as 

  specified in French locale.

  Restore locale to English and again check 

  1. if view captions are same as specified in English resource file.

  2. if view icon size is same as specified in English icon file.

  3. if view icon file is same as specified in English resource file.

  @SYMTestExpectedResults Following are the expected results.

  1. GetAppViews() should fetch captions for all views in the newly-set language.

  2. GetAppViewIcon() should fetch icons specified in the newly-set language.

  3. GetAppViewIcon() should fetch view's icon file specified in the newly-set language.

 */	

void CT_LocaleStep::TestLocaleViewCaptionAndIconOnDemandL()

	{

	INFO_PRINTF1(_L("APPFWK-APPARC-0064: TestLocaleViewCaptionOnDemandL started..."));		

	INFO_PRINTF1(_L("APPFWK-APPARC-0066: TestLocaleViewIconSizeOnDemandL started..."));

	INFO_PRINTF1(_L("APPFWK-APPARC-0068: TestLocaleViewIconFileOnDemandL started..."));

	TestViewCaptionAndIconL(ETrue);

	INFO_PRINTF1(_L("APPFWK-APPARC-0064: TestLocaleViewCaptionOnDemandL finished..."));

	INFO_PRINTF1(_L("APPFWK-APPARC-0066: TestLocaleViewIconSizeOnDemandL finished..."));

	INFO_PRINTF1(_L("APPFWK-APPARC-0068: TestLocaleViewIconFileOnDemandL finished..."));	

	}

/**

  @SYMTestCaseID APPFWK-APPARC-0065 APPFWK-APPARC-0067 APPFWK-APPARC-0069

  @SYMPREQ CR0902 - Enable Dynamic Language Switching in APPARC.

  @SYMDEF PDEF113054 - Apparc fails to detect the presence of localized Mbm files

  @SYMTestCaseDesc Test whether 

  1. View's caption changes with respect to the change in locale/language.

  2. View's icons is updated with respect to the change in locale/language. 

  3. View's icon file name changes with respect to the change in locale/language. 

  This test case checks apparc updates application localisable information for all installed applications 

  on language change event without forcing a change in the part of file system which apparc monitors.