/*

* 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 file contains TestModuleIf implementation.

*

*/

// INCLUDE FILES

#include <e32svr.h>

#include "StifTFwIfProt.h"

#include "StifTestInterface.h"

#include "TestServerModuleIf.h"

#include "StifTestModule.h"

#include "TestThreadContainer.h"

#include "STIFMeasurement.h"

// EXTERNAL DATA STRUCTURES

// None

// EXTERNAL FUNCTION PROTOTYPES  

// None

// CONSTANTS

// None

// MACROS

// Debugging is enabled with next define

#define __TRACING_ENABLED

#ifdef __TRACING_ENABLED

#define __RDEBUG(p) RDebug::Print p 

#else

#define __RDEBUG(p)

#endif

// LOCAL CONSTANTS AND MACROS

// None

// MODULE DATA STRUCTURES

// None

// LOCAL FUNCTION PROTOTYPES

// None

// FORWARD DECLARATIONS

// None

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

/*

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

    DESCRIPTION

    TDesOverflowHandler class contains a simple overflow handler implementation.

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

*/

class TDesOverflowHandler : public TDes16Overflow

    {

    public:

        TDesOverflowHandler( CTestModuleIf* aModuleIf, 

                             const TInt aPriority, 

                             const TDesC& aDefinition)

            {

            iModuleIf = aModuleIf;

            iPriority = aPriority;

            iDefinition = aDefinition;

            }

        void Overflow(TDes16& /*aDes*/ )

            { 

            }

        CTestModuleIf* iModuleIf;

        TInt iPriority;

        TStifInfoName iDefinition;

    };

/*

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

    DESCRIPTION

    This module contains the implementation of CTestModuleIf class 

    member functions.

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

*/

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

/*

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

    Class: CTestModuleIf

    Method: CTestModuleIf

    Description: Default constructor

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

    might leave.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

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

*/

CTestModuleIf::CTestModuleIf( CTestThreadContainer* aTestExecution ) :

    iTestExecution( aTestExecution )

    {

    }

/*

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

    Class: CTestModuleIf

    Method: ConstructL

    Description: Symbian OS second phase constructor

    Symbian OS default constructor can leave.

    Parameters: CTestExecution* aTestExecution: in: Pointer to TestExecution

                CTestModuleBase* aTestModule: in: Pointer to TestModule

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

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

*/

void CTestModuleIf::ConstructL( CTestModuleBase* aTestModule )

    {

    if ( aTestModule->iTestModuleIf != NULL)

        {

        delete aTestModule->iTestModuleIf;

        aTestModule->iTestModuleIf = NULL;

        }

    aTestModule->iTestModuleIf = this; 

    iIsRebootReady = EFalse;

    iStoreStateCounter = 0;

    // Used to "resets" iTestCaseResults array

    iAllowTestCaseResultsCount = 0;

    }

/*

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

    Class: CTestModuleIf

    Method: NewL

    Description: Two-phased constructor.

    Parameters: CTestExecution* aTestExecution: in: Pointer to TestExecution

                CTestModuleBase* aTestModule: in: Pointer to TestModule

    Return Values: CTestModuleIf object.

    Errors/Exceptions: Leaves if memory allocation fails

                       Leaves if ConstructL leaves

    Status: Approved

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

*/

EXPORT_C CTestModuleIf* CTestModuleIf::NewL( CTestThreadContainer* aExecutionSession, 

                                             CTestModuleBase* aTestModule )

    {

    CTestModuleIf* self = 

        new (ELeave) CTestModuleIf( aExecutionSession );

    CleanupStack::PushL( self );

    self->ConstructL( aTestModule );

    CleanupStack::Pop();

    return self;

    }

/*

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

    Class: CTestModuleIf

    Method: ~CTestModuleIf

    Description: Destructor

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

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

*/    

CTestModuleIf::~CTestModuleIf()

    {

    iTestExecution = NULL;

    // Used to "resets" iTestCaseResults array

    iAllowTestCaseResultsCount = 0;

    }

/*

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

    Class: CTestModuleIf

    Method: Printf

    Description: Printing

    Printf is used to provide different information up to the UI 

    that can be then printed e.g. to the Console Screen. 

    The priority can be used in the UI to decide if the information 

    received from the Test DLL will be discarded or not in 

    the different performance situations. The priority is also 

    used in the Test DLL server and in the Test Engine to queue 

    the Printf responses.

    This method is implemented in Test DLL Server and the Test DLL 

    can call it to provide printable information to the UI.

    Parameters:  const TInt aPriority: in: 

                    Importance of the returned information

                 const TDesC& aDefinition: in: 

                    Definition of data to be printed 

                 TRefByValue<const TDesC> aFmt: in: Printed data

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

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

*/

EXPORT_C void CTestModuleIf::Printf( const TInt aPriority, 

                                     const TDesC& aDefinition, 

                                     TRefByValue<const TDesC> aFmt,

                                     ... 

                                   )

    {           

    if( !IsServerAlive() )

        {

        return;

        }

    VA_LIST list;

    VA_START(list,aFmt);

    TName aBuf;

    RBuf buf;

    TInt ret = buf.Create(1024);

    if(ret != KErrNone)

        {

        __RDEBUG((_L("STF: Printf: Buffer creation failed [%d]"), ret));

        return;

        }

    // Cut the description length

    TInt len = aDefinition.Length();

    if ( len > KMaxInfoName )

        {

        len = KMaxInfoName;

        }

    TStifInfoName shortDescription = aDefinition.Left(len);

    // Create overflow handler

    TDesOverflowHandler overFlowHandler (this, aPriority, shortDescription);

    // Parse parameters

    buf.AppendFormatList(aFmt, list, &overFlowHandler);

    if(buf.Length() == 0)

        {

        __RDEBUG((_L("STF: Printf: Unable to prepare print buffer (probably printed string is too long)")));

        }

    // Print

    aBuf.Copy(buf.Left(aBuf.MaxLength()));

    buf.Close();

    iTestExecution->DoNotifyPrint( aPriority, shortDescription, aBuf );

    }

/*

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

    Class: CTestModuleIf

    Method: Event

    Description: Event control.

    Event function is used to control and use the event system. 

    TEventIf &aEvent encapsulates the request type and 

    the event name, see StifTestEventInterface.h for more information.

    This method is implemented in Test DLL Server and the Test DLL 

    can call it to control the event system.

    Parameters: TEventIf& aEvent: in: Event command

    Return Values: Symbian OS error code.

    Errors/Exceptions: None

    Status: Approved

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

*/      

EXPORT_C TInt CTestModuleIf::Event( TEventIf& aEvent )

    {

    if( !IsServerAlive() )

        {

        return KErrGeneral;

        }

    // All event commands are handled in testserver and testengine

    return iTestExecution->DoNotifyEvent( aEvent );

    }

/*

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

    Class: CTestModuleIf

    Method: Event

    Description: Event control.

    Asynchronous version of event control function.

    It is used to control and use the event system asynchronously. 

    TEventIf &aEvent encapsulates the request type and 

    the event number, see StifTestEventInterface.h for more information.

    This method is implemented in Test DLL Server and the Test DLL 

    can call it to control the event system.

    Parameters: TEventIf& aEvent: in: Event command

                TRequestStatus& aStatus: in: Request status parameter

    Return Values: None. 

    Errors/Exceptions: None

    Status: Approved

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

*/      

EXPORT_C void CTestModuleIf::Event( TEventIf& aEvent, TRequestStatus& aStatus )

    {

    TInt ret = KErrNone;

    if( !IsServerAlive() )

        {

        __RDEBUG( (_L("iTestExecution not initialised")));

        ret = KErrGeneral;

        }

    else

        {        

        aStatus = KRequestPending;

        // All event commands are handled in testserver and testengine

        ret = iTestExecution->DoNotifyEvent( aEvent, &aStatus );

        }

    if( ret != KErrNone )

        {

        TRequestStatus* rs = &aStatus;

        User::RequestComplete( rs, ret );

        }

    }

/*

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

    Class: CTestModuleIf

    Method: CancelEvent

    Description: Cancel asynchronous event control call.

    Parameters: TEventIf& aEvent: in: Event command to be cancelled.

                const TRequestStatus* aStatus: in: 

                    Pointer to TRequestStatus parameter that is cancelled

    Return Values: Symbian OS error code.

    Errors/Exceptions: None

    Status: Approved

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

*/      

EXPORT_C TInt CTestModuleIf::CancelEvent( TEventIf& aEvent,

                                          TRequestStatus* aStatus )

    {

     if( !IsServerAlive() )

        {

        __RDEBUG( (_L("iTestExecution not initialised")));

        return KErrGeneral;

        }

    // All event commands are handled in testserver and testengine

    iTestExecution->CancelEvent( aEvent, aStatus );

    return KErrNone;

    }

/*

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

    Class: CTestModuleIf

    Method: SetExitReason

    Description: Set exit reason

    Parameters: const TExitReason aExitReason in: Exit reason

                const TInt aExitCode in: Exit code

    Return Values: None

    Errors/Exceptions: None

    Status: Proposal

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

*/      

EXPORT_C void CTestModuleIf::SetExitReason( const CTestModuleIf::TExitReason aExitReason, 

                                            const TInt aExitCode )

    {

     if( !IsServerAlive() )

        {

        __RDEBUG( (_L("iTestExecution not initialised")));

        return;

        }

    iTestExecution->SetExitReason( aExitReason, aExitCode );

    }

/*

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

    Class: CTestModuleIf

    Method: RemoteSend

    Description: RemoteSend is used to send control protocol messages to slaves

        (e.g. another phone, call box, ...). 

    Parameters:  const TDesC& aRemoteMsg: in: 

                    Remote command protocol message 

    Return Values: None

    Errors/Exceptions: None

    Status: Proposal

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

*/

EXPORT_C TInt CTestModuleIf::RemoteSend( const TDesC& aRemoteMsg )

    {           

    if( !IsServerAlive() )

        {

        __RDEBUG( ( _L("iTestExecution not initialised") ) );

        return KErrNotReady;

        }

    TParams params;

    params.aRemoteMsgConstRef = &aRemoteMsg;

    TRequestStatus status = KRequestPending; 

    // Forward

    iTestExecution->DoRemoteReceive( EStifCmdSend, params, 

                                     aRemoteMsg.Length(), status );

    User::WaitForRequest( status );

    return status.Int();

    }

/*

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