/*

* 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: CUIEngine: This object executes test cases from 

* STIF Test Framework.

* 

*/

// INCLUDE FILES

#include <e32base.h>

#include <e32svr.h>

#include <collate.h>

#include "UIEngineEvent.h"

#include <stifinternal/UIEngineContainer.h>

#include "UIEngineError.h"

#include <stifinternal/UIEngine.h>

#include "Logging.h"

// EXTERNAL DATA STRUCTURES

// None

// EXTERNAL FUNCTION PROTOTYPES

// None

// CONSTANTS

_LIT( KUIEngine, "CUIEngine" );

// MACROS

#ifdef LOGGER

#undef LOGGER

#endif

#define LOGGER iLogger

// LOCAL CONSTANTS AND MACROS

// None

// MODULE DATA STRUCTURES

// None

// LOCAL FUNCTION PROTOTYPES

// None

// FORWARD DECLARATIONS

// None

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

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

/*

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

    Class: CUIEngine

    Method: CUIEngine

    Description: Default constructor

    C++ default constructor can NOT contain any code, that

    might leave.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Draft

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

*/

CUIEngine::CUIEngine( CUIIf* aUi  ):

    iUi( aUi )

    {

    __RDEBUG( _L( "CUIEngine::CUIEngine()" ) );

    }

/*

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

    Class: CUIEngine

    Method: ConstructL

    Description: Symbian OS second phase constructor

    Symbian OS default constructor can leave.

    Parameters: None

    Return Values: None

    Errors/Exceptions: Leaves if called Open method returns error

    Status: Draft

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

*/

void CUIEngine::ConstructL()

    {

    // Logger's setting definitions

    TLoggerSettings loggerSettings;

    loggerSettings.iCreateLogDirectories = EFalse;

    loggerSettings.iOverwrite = ETrue;

    loggerSettings.iTimeStamp = ETrue;

    loggerSettings.iLineBreak = ETrue;

    loggerSettings.iEventRanking = EFalse;

    loggerSettings.iThreadId = EFalse;

    loggerSettings.iHardwareFormat = CStifLogger::ETxt;

    loggerSettings.iHardwareOutput = CStifLogger::EFile;

    loggerSettings.iEmulatorFormat = CStifLogger::ETxt;

    loggerSettings.iEmulatorOutput = CStifLogger::EFile;

    loggerSettings.iUnicode = EFalse;

    loggerSettings.iAddTestCaseTitle = EFalse;

    // Create Logger, Note: Use protected NewL because initialization file not

    // readed yet.

    iLogger = CStifLogger::NewL( KUiLogDir, KUiLogFile, loggerSettings );

    // Initialize logger    

    iUi->InitializeLogger( iLogger );

    }

/*

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

    Class: CUIEngine

    Method: NewL

    Description: Two-phased constructor.

    Parameters: None

    Return Values: CUIEngine* : Pointer to created UI engine object

    Errors/Exceptions: Leaves if memory allocation for CUIEngine fails

                       Leaves if ConstructL leaves

    Status: Draft

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

*/

CUIEngine* CUIEngine::NewL( CUIIf* aUi )

    {

    CUIEngine* self =  

        new ( ELeave ) CUIEngine( aUi );

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop();

    return self;

    }

/*

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

    Class: CUIEngine

    Method: ~CUIEngine

    Description: Destructor

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Draft

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

*/

CUIEngine::~CUIEngine()

    {

    __RDEBUG( _L( "CUIEngine::~CUIEngine()" ) );

    // Delete all containers, cannot use ResetAndDestroy,

    // because destructor is private

    TInt count = iContainerArray.Count();

    for( TInt i=0; i< count; i++ )

        {

        delete iContainerArray[i];

        }

    iContainerArray.Reset();    

    iContainerArray.Close();

    delete iLogger;

    iLogger = NULL;

    delete iError;

    iError = 0;

    }

/*

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

    Class: VUIEngine

    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

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

*/

TInt CUIEngine::Open( const TDesC& aTestFrameworkIni )

    {

    if( ( iTestEngine.SubSessionHandle() != 0 ) ||

        ( iTestEngineServ.Handle() != 0 ) )

        {

        __TRACE( KError, ( CStifLogger::EError, _L( "CUIEngine::Open() Already open" ) ) );

        return KErrInUse;     

        }

    // Check aTestFrameworkIni max length

    if( aTestFrameworkIni.Length() > KMaxFileName )

        {

        __TRACE( KPrint, ( CStifLogger::EError, _L( "CUIEngine::Open() method's parameter length is incorrect" ) ) );

        return KErrArgument;        

        }

    // Create Test Engine

    TInt ret = iTestEngineServ.Connect();

    if ( ret != KErrNone )

        {

        __TRACE( KPrint, ( _L( "CUIEngine::Open. Engine server open failed: ret = %d"), ret ) );

        return ret;

        }

    ret = iTestEngine.Open( iTestEngineServ, aTestFrameworkIni );

    if ( ret != KErrNone )

        {

        __TRACE( KPrint, ( _L( "CUIEngine::Open. Engine. Open failed: ret = %d"), ret ) );

        return ret;

        }

    TErrorNotification error;

    if( ErrorPrint( error ) != KErrNotSupported )

        {

        // Start printer

        iError = CUIEngineErrorPrinter::NewL( this );

        iError->StartL( iTestEngine );

        }

    return ret;

    }

/*

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

    Class: CUIEngine

    Method: Close

    Description: Close test engine.

    Parameters: None

    Return Values: TInt KErrNone: Always returned KErrNone

    Errors/Exceptions: None

    Status: Draft

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

*/

TInt CUIEngine::Close()

    {

    delete iError;

    iError = 0;

    // Delete all containers, cannot use ResetAndDestroy,

    // because destructor is private

    TInt count = iContainerArray.Count();

    for( TInt i=0; i< count; i++ )

        {

        delete iContainerArray[i];

		iContainerArray[i] = NULL;

        }

    iContainerArray.Reset();

    iTestEngine.Close();

    iTestEngineServ.Close();

    __TRACE( KPrint, ( _L( "CUIEngine::Close." ) ) );

    return KErrNone;

    }

/*

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

    Class: CUIEngine

    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

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

*/

TInt CUIEngine::AddTestModule( const TDesC& aModuleName, 

                               const TDesC& aIniFile )

    {

    // Check aModuleName max length

    if( aModuleName.Length() > KMaxName )

        {

        __TRACE( KPrint, ( CStifLogger::EError, _L( "CUIEngine::AddTestModule() method's first parameter length is incorrect" ) ) );

        return KErrArgument;        

        }

    // Check aIniFile max length

    if( aIniFile.Length() > KMaxFileName )

        {

        __TRACE( KPrint, ( CStifLogger::EError, _L( "CUIEngine::AddTestModule() method's second parameter length is incorrect" ) ) );

        return KErrArgument;        

        }    

    TInt ret = iTestEngine.AddTestModule( aModuleName, aIniFile );

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

        {

		__TRACE( KPrint, ( _L( "CUIEngine::AddTestModule. Add module failed: ret = %d" ), ret  ) );

        return ret;

        }

    return KErrNone;

    }

/*

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

    Class: CUIEngine

    Method: RemoveTestModule

    Description: Remove test module from 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

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

*/

TInt CUIEngine::RemoveTestModule( const TDesC& aModuleName )

    {

    // Remove test module of module list of test engine

    TInt ret = iTestEngine.RemoveTestModule( aModuleName );

    if ( ret != KErrNone )

        {

        __TRACE( KPrint, ( _L( "CUIEngine::RemoveTestModule. Remove module failed: ret = %d"), ret  ) );

        return ret;

        }

    return ret;

    }

/*

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

    Class: CUIEngine

    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

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

*/

TInt CUIEngine::AddTestCaseFile( const TDesC& aModuleName, 

                                 const TDesC& aCaseFile )

    {

    // Check aModuleName max length

    if( aModuleName.Length() > KMaxName )

        {

        __TRACE( KPrint, ( CStifLogger::EError, _L( "CUIEngine::AddTestCaseFile() method's first parameter length is incorrect" ) ) );

        return KErrArgument;        

        }

    // Check aCaseFile max length

    if( aCaseFile.Length() > KMaxFileName )

        {

        __TRACE( KPrint, ( CStifLogger::EError, _L( "CUIEngine::AddTestCaseFile() method's second parameter length is incorrect" ) ) );

        return KErrArgument;        

        }

    TInt ret( KErrNone );

    // Add given test case file to test module

    if ( aCaseFile.Length() == 0 )

        {

        ret = KErrArgument;

        __TRACE( KPrint, (  _L( "CUIEngine::AddTestCaseFile. Test case file not defined: ret = %d"), ret  ) );

        }

    else

        {

        // Add test case file to test case file list of test engine 

        ret = iTestEngine.AddConfigFile( aModuleName, aCaseFile );

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

            {

            __TRACE( KPrint, ( _L( "CUIEngine::AddTestCaseFile. Add test case file failed: ret = %d"), ret  ) );

            }

        }

    return ret;

    }

/*

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

    Class: CUIEngine

    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

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

*/

TInt CUIEngine::RemoveTestCaseFile( const TDesC& aModuleName, 

                                    const TDesC& aCaseFile )

    {   

    TInt ret( KErrNone );

    // Remove given test case file from test module

    if ( aCaseFile.Length() == 0 )

        {

        ret = KErrArgument;

        __TRACE( KPrint, (  _L( "CUIEngine::RemoveTestCaseFile. Test case file not defined: ret = %d"), ret  ) );

        }

    else

        {

        // Remove test case file  

        ret = iTestEngine.RemoveConfigFile( aModuleName, aCaseFile );

        if ( ret != KErrNone )

            {

            __TRACE( KPrint, ( _L( "CUIEngine::RemoveTestCaseFile. Remove test case file failed: ret = %d"), ret  ) );

            }

        }

    return ret;

    }

/*

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

    Class: CUIEngine

    Method: GetTestCases

    Description: Get test cases of enumerated list of test engine. Method is copied 

                 list of test cases to aTestCaseInfo. Copied tests are test cases 

                 of test module (aTestModule) and defined

                 in test case file (aTestCaseFile), which are given as argument