/* 

* Copyright (c) 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: This module contains implementation of CUIStore 

* and CModule class member functions.

*

*/

// INCLUDE FILES

#include <e32base.h>

#include <e32svr.h>

#include <f32file.h>

#include <e32uid.h>

#include <collate.h>

#include <StifLogger.h>

#include "Logging.h"

#include <stifinternal/UIStore.h>

#include <stifinternal/UIEngine.h>

#include <stifinternal/UIStoreContainer.h>

#include "UIStorePopup.h"

#include <stifinternal/UIEngineContainer.h>

// EXTERNAL DATA STRUCTURES

// EXTERNAL FUNCTION PROTOTYPES  

// CONSTANTS

//@spe _LIT(KNameTxt,"TEST FRAMEWORK");

//@spe _LIT(KNameBase,"BASE");

_LIT( KUIStore, "CUiStore" );

_LIT( KUIStoreIf, "CUiStoreIf" );

//_LIT( KUIStoreDefaultDir, "C:\\TestFramework\\" );

_LIT( KUIStoreSetStart, "[TestSetStart]" );

_LIT( KUIStoreSetEnd, "[TestSetEnd]" );

_LIT( KUIStoreSetName, "TestSetName=" );

_LIT( KUIStoreSetCaseStart, "[TestSetCaseStart]" );

_LIT( KUIStoreSetCaseEnd, "[TestSetCaseEnd]" );

_LIT( KUIStoreCaseModuleName, "ModuleName=" );

_LIT( KUIStoreTestCaseTitle, "Title=" );

_LIT( KUIStoreTestCaseFile, "TestCaseFile="); 

_LIT( KUIStoreTestCaseNum, "TestCaseNum=");

_LIT( KUIStoreCaseExpectedResult, "ExpectedResult=");

_LIT( KUIStoreCasePriority, "Priority="); 

_LIT( KUIStoreCaseTimeout, "Timeout=");

_LIT( KUIStoreLastStartedCaseIndex, "LastStartedCaseIndex=");

_LIT( KUIStoreDefaultRebootFile, "TestFrameworkUIReboot.txt" );

_LIT( KUIStoreStartTest, "[StartTestCase]" );

_LIT( KUIStoreStartTestEnd, "[StartTestCaseEnd]" );

_LIT( KUIStoreCaseStatus, "TestCaseStatus=");

_LIT( KUIStoreCaseExecutionResult, "TestCaseExecutionResult=");

_LIT( KUIStoreCaseResult, "TestCaseResult=");

_LIT( KUIStoreCaseStartTime, "TestCaseStartTime=");

_LIT( KUIStoreCaseEndTime, "TestCaseEndTime=");

const TInt KRcpHeaderLen = 16;        

const TInt KFixedStartedCaseIndex = 10;

// MACROS

#ifdef LOGGER

#undef LOGGER

#endif

#define LOGGER iLogger

// LOCAL CONSTANTS AND MACROS

static const TUid KUidTestModule = { 0x101FB3E7 };

// MODULE DATA STRUCTURES

// LOCAL FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

// ==================== LOCAL FUNCTIONS =======================================

// None

// ================= MEMBER FUNCTIONS =========================================

/*

-------------------------------------------------------------------------------

    Class: CUIStore

    Method: NewL

    Description: Construct the CUIStore class

    Parameters: None

    Return Values: CUIStore*                    New object

    Errors/Exceptions: Leaves if memory allocation fails or

                       ConstructL leaves.

    Status: Draft

-------------------------------------------------------------------------------

*/

CUIStore* CUIStore::NewL( CUIStoreIf* aUIStoreIf )

    {

    CUIStore* self = new ( ELeave ) CUIStore( aUIStoreIf );

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

/*

-------------------------------------------------------------------------------

    Class: CUIStore

    Method: ConstructL

    Description: Second level constructor.

    Construct the console

    Construct module and case containers

    Retrieve command line parameters

    Connect to test engine

    Parameters: None

    Return Values: None

    Errors/Exceptions: Leaves if memory allocation fails or fileserver or

                       test engine can't be connected.

    Status: Draft

-------------------------------------------------------------------------------

*/

void CUIStore::ConstructL( )

    {

    }

/*

-------------------------------------------------------------------------------

    Class: CUIStore

    Method: CUIStore

    Description: Constructor.

    Initialize non-zero member variables.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Draft

-------------------------------------------------------------------------------

*/

CUIStore::CUIStore( CUIStoreIf* aUIStoreIf ):

    iUIStoreIf( aUIStoreIf ),

    iUpdateNeeded( ETrue ),

    iActivePopupPriority( EPopupPriorityLow )

    {

    }

/*

-------------------------------------------------------------------------------

    Class: CUIStore

    Method: ~CUIStore

    Description: Destructor

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Draft

-------------------------------------------------------------------------------

*/

CUIStore::~CUIStore( )

    {	

    iFileList.ResetAndDestroy();

    iFileList.Close(); 

    iStartedTestSets.ResetAndDestroy();

    iStartedTestSets.Close();  

    iStartedTestCases.ResetAndDestroy();

    iStartedTestCases.Close();

    iTestSets.ResetAndDestroy();

    iTestSets.Close();  

    iTestCases.ResetAndDestroy();

    iTestCases.Close();

    iPopups.ResetAndDestroy();

    iPopups.Close();

    delete iUIEngine;    

    iUIEngine = 0;

    }

/*

-------------------------------------------------------------------------------

    Class: CStifTFwIf

    Method: Open

    Description: Open test engine.

    Parameters: TDesC& aTestFrameworkIni: in: Initialization file to Test Framework

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

-------------------------------------------------------------------------------

*/

EXPORT_C  TInt CUIStore::Open( const TDesC& aTestFrameworkIni )

    {

    if( aTestFrameworkIni.Length() > KMaxFileName )

        {

        return KErrArgument;

        }

    TRAPD( err, 

        iUIEngine = CUIEngine::NewL( this );

        );

    if( err != KErrNone )

        {

        return err;

        }

    TFileName ini( aTestFrameworkIni );

    // Check given ini file

    TRAP( err, CheckIniL( ini ) );

    // Store folder of initialization file to open it again when looking for filters

    RDebug::Print(_L("CUIStore stores name of ini file [%S]"), &ini);

    iTestFrameworkIni.Copy(ini);

    return iUIEngine->Open( ini );

    }

/*

-------------------------------------------------------------------------------

    Class: CUIStore

    Method: Close

    Description: Close test engine.

    Parameters: None

    Return Values: TInt KErrNone: Always returned KErrNone

    Errors/Exceptions: None

    Status: Draft

-------------------------------------------------------------------------------

*/

EXPORT_C TInt CUIStore::Close()

    {

    TInt ret = KErrNone;

    if( iUIEngine != NULL )

        {

        ret = iUIEngine->Close();

        delete iUIEngine;    

        iUIEngine = 0;

        }

    return ret;

    }

/*

-------------------------------------------------------------------------------

    Class: CUIStore

    Method: AddTestModule

    Description: Add test module to module list of test engine

    Parameters: TDesC& aModuleName: in: Testmodule, which is added to module list

                TDesC& aIniFile: in: Initialization file to the test module

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

-------------------------------------------------------------------------------

*/

EXPORT_C TInt CUIStore::AddTestModule( const TDesC& aModuleName, 

                                       const TDesC& aIniFile )

    {

    TInt ret = iUIEngine->AddTestModule( aModuleName, aIniFile );

    RefreshAllCases();

    return ret;

    }

/*

-------------------------------------------------------------------------------

    Class: CUIStore

    Method: RemoveTestModule

    Description: Add test module to module list of test engine

    Parameters: TDesC& aModuleName: in: Testmodule, which is removed of module list

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

-------------------------------------------------------------------------------

*/

EXPORT_C TInt CUIStore::RemoveTestModule( const TDesC& aModuleName )

    {

    TInt ret = iUIEngine->RemoveTestModule( aModuleName );

    RefreshAllCases();

    return ret;

    }

/*

-------------------------------------------------------------------------------

    Class: CUIStore

    Method: AddTestCaseFile

    Description: Add test case file to test case file list of test engine

    Parameters: TDesC& aModuleName: in: Testmodule, which own test cases of test case list.

                TDesC& aCaseFile: in: Test case list, which is added to test case list

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

-------------------------------------------------------------------------------

*/

EXPORT_C TInt CUIStore::AddTestCaseFile( const TDesC& aModuleName, 

                                         const TDesC& aCaseFile )

    {

    TInt ret = iUIEngine->AddTestCaseFile( aModuleName, aCaseFile );

    RefreshAllCases();

    return ret;

    }

/*

-------------------------------------------------------------------------------

    Class: CUIStore

    Method: RemoveTestCaseFile

    Description: Remove test case file of test case file list of test engine

    Parameters: TDesC& aModuleName: in: Testmodule, which own test cases of test case list

                TDesC& aCaseFile: in: Test case list, which is removed of test case list

    Return Values: Symbian OS error: Error code

    Errors/Exceptions: None

    Status: Draft

-------------------------------------------------------------------------------

*/

EXPORT_C TInt CUIStore::RemoveTestCaseFile( const TDesC& aModuleName, 

                                            const TDesC& aCaseFile )

    {   

    TInt ret = iUIEngine->RemoveTestCaseFile( aModuleName, aCaseFile );

    RefreshAllCases();

    return ret;

    }

/*

-------------------------------------------------------------------------------

    Class: CUIStore

    Method: StartTestCase

    Description: Start selected test case identified with CTestInfo.

                anIndex contains index in StartedTestCase array, 

                which is valid only during execution of calling 

                function.

    Parameters: const CTestInfo& aTestInfo: in: Test case info

                TInt& anIndex: out: Index to StartedTestCaseArray returned 

    Return Values: Symbian OS error code

    Errors/Exceptions: None

    Status: Draft

-------------------------------------------------------------------------------

*/

EXPORT_C TInt CUIStore::StartTestCase( const CTestInfo& aTestInfo, 

                                       TInt& anIndex )

    {

    CUIEngineContainer* container = NULL;

    TInt ret = iUIEngine->StartTestCase( container, aTestInfo );

    if( ret != KErrNone )

        {

        return ret;

        }

    CStartedTestCase* testCase = NULL;

    TRAP( ret,

        testCase = CStartedTestCase::NewL( aTestInfo, *container );

       );

    if( ret != KErrNone )

        {

        iUIEngine->AbortStartedTestCase( container );

        return ret;

        }

    ret = iStartedTestCases.Append( testCase );

    if( ret != KErrNone )

        {

        iUIEngine->AbortStartedTestCase( container );

        delete testCase;

        return ret;

        }

    anIndex =  iStartedTestCases.Find( testCase );

    if( anIndex < 0 )

        {

        User::Panic( KUIStore, KErrNotFound );

        }

    iUIStoreIf->Update( testCase, testCase->Status() ); 

    return KErrNone;

    }

/*

-------------------------------------------------------------------------------

    Class: CUIStore

    Method: TestCases

    Description: Return array of existing test cases.

    Parameters: RRefArray<CTestInfo>& aTestCases: out: Array of test cases

                TDesC& aTestModule: in: Test module name (optional)

                TDesC& aTestCaseFile: in: Test case file name (optional) 

    Return Values: Symbian OS error code

    Errors/Exceptions: None

    Status: Draft

-------------------------------------------------------------------------------

*/