// 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 the License "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:

// Test for GT0247 Bravo.

// CR0583: Apparc should allow short caption to be modified dynamically

// Test for UIKON GT0143 Typhoon Work Series 60 Changes.

// REQ758.1: Add support for short captions

// This test requires that tstapp.app has been built

// tstapp.mmp has RESOURCE tstapp_caption.rss what caption is built into the .rsc file

// tstapp_loc.rss decides what version of the caption file to include:

// tstapp01.rls

// tstapp02.rls

// tstapp03.rls

// tstapp04.rls

// tstapp05.rls

// tstappsc.rls

// 

//

/**

 @file

 @test

 @internalComponent - Internal Symbian test code

*/

#include <apgicnfl.h>

#include <hal.h>

#include <e32test.h>

#include <apgctl.h>

#include <apfctlf.h>

#include <APGCLI.H>

#include <APSSERV.H>

#include <APAFLREC.H>

#include <APFREC.H>

#include <APPARC.H>

#include <APGDOOR.H>

#include <centralrepository.h>

#include <s32file.h>

#include "tstapp.h"		// KUidTestApp defined here

#include "T_CaptionStep.h"

#include "appfwk_test_utils.h"

#include "appfwk_test.h"

#include "ticoncaptionoverride.h" //KUidTestIconCapOverride defined here

#include "TIconLoaderAndIconArrayForLeaks.h"

/////////////////////////////////////////////////////////////////////////////////

//

//		global consts and declarations

//

/////////////////////////////////////////////////////////////////////////////////

_LIT(KTestTApaAppInfoCaptionEnglish,"TstCap UK");

_LIT(KTestTApaAppInfoShortCaptionEnglish,"TC UK");

_LIT(KTestTApaAppInfoCaptionFrench,"TstCap FR");

_LIT(KTestTApaAppInfoShortCaptionFrench,"TC FR");

_LIT(KTestTApaAppInfoCaptionGerman,"TstCap GE");

_LIT(KTestTApaAppInfoShortCaptionGerman,"TC GE");

// If _loc.rss does not define Short Caption, it takes long caption

_LIT(KTestTApaAppInfoCaptionSpanish,"TstCap SP");

_LIT(KTestTApaAppInfoShortCaptionSpanish,"TstCap SP");

// If _loc.rss does not define Caption, it takes app name

_LIT(KTestTApaAppInfoCaptionItalian,"tstapp");

_LIT(KTestTApaAppInfoShortCaptionItalian,"TC IT");

_LIT(KTestTApaAppInfoCaptionDefault,"TstCap UK");

_LIT(KTestTApaAppInfoShortCaptionDefault,"TC UK");

// Cenrep configuration details for English language

_LIT(KCenRepCaption, "CRTstCap UK");

_LIT(KCenRepShortCaption, "CRTC UK");

_LIT(KCenRepIconFilename, "Z:\\resource\\apps\\ticoncapoverride.mbm");

const TUid KUidIconCaptionRepository = {0x1028583d}; // Central Repository UID.

const TInt KTextSize = 100;

/////////////////////////////////////////////////////////////////////////////////

//

//		CT_CaptionStep

//

/////////////////////////////////////////////////////////////////////////////////

void CT_CaptionStep::ChangeLocaleL(TLanguage aLanguage)

	{

	//  Change locale according to information in the HAL

	_LIT(KLitLocaleDllNameBase, "ELOCL");

	_LIT(KLitLocaleDllNameExtension, ".LOC");

	RLibrary localeDll;

	TBuf<16> localeDllName(KLitLocaleDllNameBase);

	CleanupClosePushL(localeDll);

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

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

	localeDllName.AppendFormat(TwoDigExt, aLanguage);

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

	if (error==KErrNotFound)

		{

		localeDllName=KLitLocaleDllNameBase;

		localeDllName.Append(KLitLocaleDllNameExtension);

		error=localeDll.Load(localeDllName, uidType);

		}

	User::LeaveIfError(error);

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

	CleanupStack::PopAndDestroy(&localeDll);

	}

void CT_CaptionStep::DoLanguageTestL()

	{

	TLanguage language = User::Language();	// keep a copy to restore it later on.

	TInt ch = 0;

	for (ch=0; ch < 2; ch++)

		{

		TLanguage languageToTest = ELangTest;	// init to supress compiler remark

		switch (ch)

			{

			case 0:

				languageToTest=ELangEnglish;

				INFO_PRINTF1(_L("--------- Testing English"));

				break;

			case 1:

				languageToTest=ELangFrench;

				INFO_PRINTF1(_L("--------- Testing French"));

				break;

			case 2:

				languageToTest=ELangGerman;

				INFO_PRINTF1(_L("--------- Testing German"));

				break;

			case 3:

				languageToTest=ELangSpanish;

				INFO_PRINTF1(_L("--------- Testing Spanish"));

				break;

			case 4:

				languageToTest=ELangItalian;

				INFO_PRINTF1(_L("--------- Testing Italian"));

				break;

			case 5:

				languageToTest=ELangAmerican;

				INFO_PRINTF1(_L("--------- Testing American"));

				break;

			default:

				User::LeaveIfError(KErrNotSupported);

				break;

			};

		// Change the locale

		ChangeLocaleL(languageToTest);

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

		// Force the applist to be updated (so test app gets new language settings)

		RPointerArray<TDesC> dummy;

		User::LeaveIfError(iLs.ForceRegistration(dummy));

		// Do the same set of tests for each language

		TestCApaSystemControlListL();

		TestCApaDoorL();

		TestTApaAppInfoStreamsL();

		//Skip the memory leak test

		//HEAP_TEST_LS_SESSION(iLs, 0, 0, TestTApaAppInfoL(), iLs.ClearAppInfoArray() );

		//and run this instead

		TestTApaAppInfoL();

		INFO_PRINTF1(_L("Test for that language finished..."));

		}

	// restore original locale, just in case...

	ChangeLocaleL(language);

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

	}	

/**

   @SYMTestCaseID	t_caption_TestCApaSystemControlListL

   @SYMPREQ			0

   @SYMTestCaseDesc	Check (short)caption by means of a control on the list CApaSystemControlList 

   @SYMTestPriority High

   @SYMTestStatus 	Implemented

   @SYMTestActions	The test creates a CApaSystemControlList and checks the value of (short)caption

   					by creating a CApaSystemControl from index 0 of CApaSystemControlList

   @SYMTestExpectedResults	The (short)caption is set to a value not null (length is not zero)

 */	

void CT_CaptionStep::TestCApaSystemControlListL()

	{

	INFO_PRINTF1(_L("Testing CApaSystemControlList... "));

	CApaSystemControlList* list=NULL;

	User::LeaveIfError(FbsStartup());

	RFbsSession fbs;

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

	TRAPD(ret, list=CApaSystemControlList::NewL(iFs));

	TEST(ret==KErrNone);

	CApaSystemControl* control=list->Control(0);

	TPtrC testShortCap=control->ShortCaption();

	TEST(testShortCap.Length()>0);

	TPtrC testCap=control->Caption();

	TEST(testCap.Length()>0);

	}

/**

   @SYMTestCaseID	t_caption_TestTApaAppInfoL

   @SYMPREQ			0

   @SYMTestCaseDesc Check appInfo contains the right (short)caption for the current test language.

   @SYMTestPriority High

   @SYMTestStatus 	Implemented

   @SYMTestActions	The test searches for KUidTestApp by calling GetNextApp until the UIDs match. 

   					Once the right app is found, it retrieves its details by calling GetAppInfo().

   					The (short)caption is check to ensure it matches the expected result.

   @SYMTestExpectedResults	The (short)caption matches the one specified for the application, with the

   							american one being the default one.

 */	

void CT_CaptionStep::TestTApaAppInfoL()

	{

	INFO_PRINTF1(_L("Testing GetAppInfo()... "));

	// go through the list of apps until it finds KUidTestApp

	TApaAppInfo appInfo;

	TInt ret = iLs.GetAllApps();

	TEST(ret==KErrNone);

	FOREVER

		{

		TApaAppInfo info;

		ret=iLs.GetNextApp(info);

		TEST(ret==KErrNone);

		if (info.iUid==KUidTestApp)

			{

			iLs.GetAppInfo(appInfo, info.iUid);

			break;

			}

		}

	switch (User::Language())

		{

		case ELangEnglish:

			TEST(appInfo.iCaption==KTestTApaAppInfoCaptionEnglish);

			TEST(appInfo.iShortCaption==KTestTApaAppInfoShortCaptionEnglish);

			break;

		case ELangFrench:

			TEST(appInfo.iCaption==KTestTApaAppInfoCaptionFrench);

			TEST(appInfo.iShortCaption==KTestTApaAppInfoShortCaptionFrench);

			break;

		case ELangGerman:

			TEST(appInfo.iCaption==KTestTApaAppInfoCaptionGerman);

			TEST(appInfo.iShortCaption==KTestTApaAppInfoShortCaptionGerman);

			break;

		case ELangSpanish:

			TEST(appInfo.iCaption==KTestTApaAppInfoCaptionSpanish);

			TEST(appInfo.iShortCaption==KTestTApaAppInfoShortCaptionSpanish);

			break;

		case ELangItalian:

			TEST(appInfo.iCaption==KTestTApaAppInfoCaptionItalian);

			TEST(appInfo.iShortCaption==KTestTApaAppInfoShortCaptionItalian);

			break;

		case ELangAmerican:

			TEST(appInfo.iCaption==KTestTApaAppInfoCaptionDefault);

			TEST(appInfo.iShortCaption==KTestTApaAppInfoShortCaptionDefault);

			break;

		default:

			User::Leave(KErrNotSupported);

			break;

		};

	}

/**

   @SYMTestCaseID	t_caption_TestCApaDoorL

   @SYMPREQ			0

   @SYMTestCaseDesc	Check the caption returned by a CApaDoor (a wrapper for an embedded document).

   @SYMTestPriority High

   @SYMTestStatus 	Implemented

   @SYMTestActions	The test starts by creating an active scheduler.

   					A CApaProcess is created, and a new CApaDocument is added to it using the specified 

   					application factory. This document is then used to create a CApaDoor object which 

   					is used to retrieve the test app caption.

   @SYMTestExpectedResults	The (short)caption matches the one specified for the application, with the

   							american one being the default one.

 */	

void CT_CaptionStep::TestCApaDoorL()

	{

	INFO_PRINTF1(_L("Testing CApaDoor... "));

	// create an active scheduler

	CActiveScheduler* scheduler = new(ELeave) CActiveScheduler;

	CActiveScheduler::Install(scheduler);

	CleanupStack::PushL(scheduler);

	CApaProcess* process=NULL;

	TRAPD(ret,process = CApaProcess::NewL(iFs));

	TEST(ret==KErrNone);

	CleanupStack::PushL(process);

	CApaDocument* doc=NULL;

	TApaApplicationFactory appFact(KUidTestApp);

	TRAP(ret,doc=process->AddNewDocumentL(appFact));

	TEST(ret==KErrNone);

	CApaDoor* door = NULL;

	TRAP(ret,door=CApaDoor::NewL(iFs,*doc,TSize(400,400)));

	TEST(ret==KErrNone);

	switch (User::Language())

		{

		case ELangEnglish:

			TEST(*door->Caption()==KTestTApaAppInfoCaptionEnglish);

			break;

		case ELangFrench:

			TEST(*door->Caption()==KTestTApaAppInfoCaptionFrench);

			break;

		case ELangGerman:

			TEST(*door->Caption()==KTestTApaAppInfoCaptionGerman);

			break;

		case ELangSpanish:

			TEST(*door->Caption()==KTestTApaAppInfoCaptionSpanish);

			break;

		case ELangItalian:

			TEST(*door->Caption()==KTestTApaAppInfoCaptionItalian);

			break;

		case ELangAmerican:

			TEST(*door->Caption()==KTestTApaAppInfoCaptionDefault);

			break;

		default:

			User::Leave(KErrNotSupported);

			break;

		};

	process->DestroyDocument(doc);

	CleanupStack::PopAndDestroy(2); //process,scheduler

	}

/**

   @SYMTestCaseID	t_caption_TestTApaAppInfoStreamsL

   @SYMPREQ			0

   @SYMTestCaseDesc Check TApaAppInfo streaming works as expected

   @SYMTestPriority High

   @SYMTestStatus 	Implemented

   @SYMTestActions	Create and TApaAppInfo object with the KUidTestApp test app.

   					Also, create a temporal file, associates the file with a write stream, 

   					and prepares the stream for writing. 

   					When the object is externalized to the streem, we open a file containing a 

   					read stream and prepares the stream for reading.

   @SYMTestExpectedResults	The test case is completed without any errors or panics

 */	

void CT_CaptionStep::TestTApaAppInfoStreamsL()

	{

	INFO_PRINTF1(_L("Testing TApaAppInfo streams... "));

	TApaAppInfo appInfoShort(KUidTestApp, _L("z:\\sys\\bin\\tstapp.exe"), _L("TstCap UK"),_L("TC UK"));

	TEST(appInfoShort.iShortCaption.Compare(_L("TC UK"))==0);

	TFileName tempFile=_L("c:\\system\\test\\TC_temp.txt");

	TInt ret = iFs.MkDirAll(tempFile);

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

		User::LeaveIfError(ret);

	TApaAppInfo appInfo;

	RFileWriteStream writer;

	writer.PushL();

	User::LeaveIfError(writer.Replace(iFs,tempFile,EFileWrite));

	TRAP(ret, appInfo.ExternalizeL(writer));

	TEST(ret==KErrNone);

	writer.CommitL();

	CleanupStack::PopAndDestroy(&writer);

	RFileReadStream reader;

	reader.PushL();

	User::LeaveIfError(reader.Open(iFs,tempFile,EFileRead));

	TRAP(ret, appInfo.InternalizeL(reader));

	TEST(ret==KErrNone);

	CleanupStack::PopAndDestroy(&reader);

	User::LeaveIfError(iFs.Delete(tempFile));

	}

/**

   @SYMTestCaseID APPFWK-APPARC-0041 APPFWK-APPARC-0042 APPFWK-APPARC-0043 APPFWK-APPARC-0044 APPFWK-APPARC-0045 APPFWK-APPARC-0046

   @SYMPREQ PCHY-6FTLPK

   @SYMTestCaseDesc Test the RApaLsSession::SetAppShortCaption function, used to set the app's short caption.

   @SYMTestPriority High

   @SYMTestStatus Implemented

   @SYMTestActions Call SetAppShortCaption() to set the caption and read it back using the GetApaAppInfo().

   @SYMTestExpectedResults The returned short caption must match the one set by the SetAppShortCaption function.

 */	

void CT_CaptionStep::DoShortCaptionTestL()

	{

	INFO_PRINTF1(_L("Testing SetAppShortCaptionL() for short caption changes... "));

	_LIT(KShortCaption1, "SC1");

	_LIT(KShortCaption2, "SC2");

	_LIT(KShortCaption3, "SC3");

	_LIT(KShortCaption4, "SC4");

	_LIT(KShortCaption5, "SC5");

	// keep a copy of the current language, and set it to a known one

	TLanguage language = User::Language();

	ChangeLocaleL(ELangEnglish);

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

	// Force the applist to be updated (so test app gets new language settings)

	RPointerArray<TDesC> dummy;

	User::LeaveIfError(iLs.ForceRegistration(dummy));

	// SetAppShortCaption should return KErrNotFound if it could not find the app

	INFO_PRINTF1(_L(".....setting short caption for an unknown app"));

	TInt err = iLs.SetAppShortCaption(KShortCaption1, ELangNone, TUid::Uid(0xFFF34556));

	TEST(err == KErrNotFound);

	// Set the NULL short caption i.e. "", should return KErrArgument,

	INFO_PRINTF1(_L(".....setting an empty short caption"));

	err = iLs.SetAppShortCaption(KNullDesC, ELangNone, KUidTestApp);

	TEST(err == KErrArgument);

	// SetAppShortCaption should return KErrArgument if short caption > KApaMaxAppCaption

	INFO_PRINTF1(_L(".....setting short caption of more then KApaMaxAppCaption length"));

	HBufC* longCaption = HBufC::NewL(KApaMaxAppCaption+1);

	longCaption->Des().SetLength(KApaMaxAppCaption+1);

	err = iLs.SetAppShortCaption(*longCaption, ELangNone, KUidTestApp);

	TEST(err == KErrArgument);

	delete longCaption;

	// SetAppShortCaption should return KErrNone if short caption == KApaMaxAppCaption

	INFO_PRINTF1(_L(".....setting short caption of same size as KApaMaxAppCaption"));

	longCaption = HBufC::NewL(KApaMaxAppCaption);

	longCaption->Des().SetLength(KApaMaxAppCaption);

	err = iLs.SetAppShortCaption(*longCaption, ELangCatalan, KUidTestApp);	// just testing the arg length, not actual values

	TEST(err == KErrNone);

	delete longCaption;

	// Set short caption of an app for the current locale language (ELangEnglish so far)

	INFO_PRINTF1(_L(".....setting short caption of an app for the current locale language"));

	err = iLs.SetAppShortCaption(KShortCaption1, ELangEnglish, KUidTestApp);

	TEST(err == KErrNone);

	TApaAppInfo appInfo;

	iLs.GetAppInfo(appInfo, KUidTestApp);

	TEST(appInfo.iShortCaption == KShortCaption1);

	// Check short caption remains updated after a refresh of the applist

	INFO_PRINTF1(_L(".....checking short caption remains updated after a refresh of the applist"));

	User::LeaveIfError(iLs.ForceRegistration(dummy));

	iLs.GetAppInfo(appInfo, KUidTestApp);

	TEST(appInfo.iShortCaption == KShortCaption1);

	// Check short caption remains updated after a locale change

	INFO_PRINTF1(_L(".....checking short caption remains updated after a locale change"));

	ChangeLocaleL(ELangJapanese);

	TEST(User::Language() == ELangJapanese);	// Japanese locale exists in epoc32 tree but not defined in test app

	User::LeaveIfError(iLs.ForceRegistration(dummy));

	ChangeLocaleL(ELangEnglish);				// back to English to see what happened in between

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

	User::LeaveIfError(iLs.ForceRegistration(dummy));

	iLs.GetAppInfo(appInfo, KUidTestApp);

	TEST(appInfo.iShortCaption == KShortCaption1);

	// Set short caption of an app for a language which is not the current one (ELangFrench, for example)

	INFO_PRINTF1(_L(".....setting short caption of an app for a language which is not the current one"));

	err = iLs.SetAppShortCaption(KShortCaption2, ELangFrench, KUidTestApp);

	TEST(err == KErrNone);

	iLs.GetAppInfo(appInfo, KUidTestApp);

	TEST(appInfo.iShortCaption == KShortCaption1);	// English, the current app language, doesn't change...

	ChangeLocaleL(ELangFrench);

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

	User::LeaveIfError(iLs.ForceRegistration(dummy));

	iLs.GetAppInfo(appInfo, KUidTestApp);

	TEST(appInfo.iShortCaption == KShortCaption2);	

	// Set short caption of an app for a language which the app does not include (ELangAmerican)

	INFO_PRINTF1(_L(".....setting short caption of an app for a language which the app does not include"));

	ChangeLocaleL(ELangAmerican);

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

	User::LeaveIfError(iLs.ForceRegistration(dummy));

	err = iLs.SetAppShortCaption(KShortCaption2, ELangAmerican, KUidTestApp);

	iLs.GetAppInfo(appInfo, KUidTestApp);

	TEST(appInfo.iShortCaption == KShortCaption1);	// American takes the default...so English...which has just been updated.

	// Set short caption of an app for all languages with ELangNone

	INFO_PRINTF1(_L(".....setting short caption for all languages with ELangNone"));