/*

* 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 the header file of the 

* CTestModuleBase and CTestModuleIf classes. Test Module inherits 

* the CTestModuleBase and uses the CTestModuleIf for printing 

* to user interface and event system control.

*

* The initialization of this interface must be done from the Test Module Server with:

* 	CTestModuleXXX *mod = new CTestModuleXXX;

* 	RThread thread;

* 	CTestModuleIf::NewL( this, (CTestModuleBase*) mod, thread.Id() );

* 

* CTestModuleIf is deleted by destructor of the CTestModuleBase. 

*

*/

#ifndef TESTMODULE_H

#define TESTMODULE_H

// INCLUDES

#include <e32std.h>

#include <e32base.h>

#include "StifCommand.h"

// CONSTANTS

// Define Old Test Module API version - API that doesn't support version of test module

const TInt KOldTestModuleAPIMajor = 1;

const TInt KOldTestModuleAPIMinor = 1;

const TInt KOldTestModuleAPIBuild = 0;

// Define Test Module API version

const TInt KTestModuleAPIMajor = 1;

const TInt KTestModuleAPIMinor = 2;

const TInt KTestModuleAPIBuild = 0;

const TInt KStifMaxResultDes = 128; // Maximum test result description length

// Max array value for STIF macros allow result.

const TInt KSTIFMacroResultArraySize = 10;

// Test module def-file check when setting parameters.

const TUint32 KStifTestModuleParameterChanged = 0xdeadbeef;

// MACROS

// Test result description. Maximum length is 128 characters.

typedef TBuf<KStifMaxResultDes> TResultDes;

// Macro for boolean.

#ifdef TL

    #pragma message( "============================================================" )

    #pragma message( " TL macro is already defined, now using STIF TF's TL macro" )

    #pragma message( "============================================================" )

#undef TL

#endif

// Macro for integer and one expected result.

#ifdef T1L

    #pragma message( "==============================================================" )

    #pragma message( " T1L macro is already defined, now using STIF TF's T1L macro" )

    #pragma message( "==============================================================" )

#undef T1L

#endif

// Macro for integer and two expected result.

#ifdef T2L

    #pragma message( "==============================================================" )

    #pragma message( " T2L macro is already defined, now using STIF TF's T2L macro" )

    #pragma message( "==============================================================" )

#undef T2L

#endif

// Macro for integer and three expected result.

#ifdef T3L

    #pragma message( "==============================================================" )

    #pragma message( " T3L macro is already defined, now using STIF TF's T3L macro" )

    #pragma message( "==============================================================" )

#undef T3L

#endif

// Macro for integer and four expected result.

#ifdef T4L

    #pragma message( "==============================================================" )

    #pragma message( " T4L macro is already defined, now using STIF TF's T4L macro" )

    #pragma message( "==============================================================" )

#undef T4L

#endif

// Macro for integer and five expected result.

#ifdef T5L

    #pragma message( "==============================================================" )

    #pragma message( " T5L macro is already defined, now using STIF TF's T5L macro" )

    #pragma message( "==============================================================" )

#undef T5L

#endif

// Macro for boolean. Recommended use with TestScripter's test class.

#ifdef TAL

    #pragma message( "==============================================================" )

    #pragma message( " TAL macro is already defined, now using STIF TF's TAL macro" )

    #pragma message( "==============================================================" )

#undef TAL

#endif

// Macro for integer and one expected result. Recommended use with TestScripter's test

// class.

#ifdef TA1L

    #pragma message( "================================================================" )

    #pragma message( " TA1L macro is already defined, now using STIF TF's TA1L macro" )

    #pragma message( "================================================================" )

#undef TA1L

#endif

// Macro for integer and two expected result. Recommended use with TestScripter's test

// class.

#ifdef TA2L

    #pragma message( "================================================================" )

    #pragma message( " TA2L macro is already defined, now using STIF TF's TA2L macro" )

    #pragma message( "================================================================" )

#undef TA2L

#endif

// Macro for integer and three expected result. Recommended use with TestScripter's test

// class.

#ifdef TA3L

    #pragma message( "================================================================" )

    #pragma message( " TA3L macro is already defined, now using STIF TF's TA3L macro" )

    #pragma message( "================================================================" )

#undef TA3L

#endif

// Macro for integer and four expected result. Recommended use with TestScripter's test

// class.

#ifdef TA4L

    #pragma message( "================================================================" )

    #pragma message( " TA4L macro is already defined, now using STIF TF's TA4L macro" )

    #pragma message( "================================================================" )

#undef TA4L

#endif

// Macro for integer and five expected result. Recommended use with TestScripter's test

// class.

#ifdef TA5L

    #pragma message( "================================================================" )

    #pragma message( " TA5L macro is already defined, now using STIF TF's TA5L macro" )

    #pragma message( "================================================================" )

#undef TA5L

#endif

//  TL ========================================================================

//  Macro for verify boolean value.

//  Example for use, 1: TL( Open() == KErrNone );

//                   1: TL( VerifyString1() == VerifyString2() );

//                   2: TL( 6 <= 8 );

//  ===========================================================================

    #define TL( aIsTrue )\

        if( (!(aIsTrue)) )\

        { TestModuleIf().StifMacroError( (0), (TText8*)__FILE__, __FUNCTION__, __LINE__ );\

        User::Leave( KErrArgument ); };

//  T1L =======================================================================

//  Macro for verify integer value from the expected 1 value.

//  Example: T1L( Open(), KErrNone );

//  ===========================================================================

    #define T1L( aResult, aExpected1 )\

        {\

        TInt result = aResult;\

        if( ( (result) != (aExpected1) ) )\

            { TestModuleIf().StifMacroError(\

                (1), (TText8*)__FILE__, __FUNCTION__, __LINE__, (result), (aExpected1) );\

            User::Leave( KErrArgument ); };\

        };

//  T2L =======================================================================

//  Macro for verify integer value from the expected 1 and 2 values.

//  Example for use: T1L( Open(), KErrNone, KErrAlreadyExists );

//  ===========================================================================

    #define T2L( aResult, aExpected1, aExpected2 )\

        {\

        TInt result = aResult;\

        if( ( (result) != (aExpected1) && (result) != (aExpected2) ) )\

            { TestModuleIf().StifMacroError(\

                (2), (TText8*)__FILE__, __FUNCTION__, __LINE__, (result), (aExpected1), (aExpected2) );\

            User::Leave( KErrArgument ); };\

        };

//  T3L =======================================================================

//  Macro for verify integer value from the expected 1, 2 and 3 values.

//  Example for use: T1L( Open(), KErrNone, KErrAlreadyExists, KErrDiskFull );

//  ===========================================================================

    #define T3L( aResult, aExpected1, aExpected2, aExpected3 )\

        {\

        TInt result = aResult;\

        if( ( (result) != (aExpected1) && (result) != (aExpected2) && (result) != (aExpected3) ) )\

            { TestModuleIf().StifMacroError(\

                (3), (TText8*)__FILE__, __FUNCTION__, __LINE__, (result), (aExpected1), (aExpected2), (aExpected3) );\

            User::Leave( KErrArgument ); };\

        };

//  T4L =======================================================================

//  Macro for verify integer value from the expected 1, 2, 3 and 4 values.

//  Example for use:

//  T1L( Open(), KErrNone, KErrAlreadyExists, KErrDiskFull, KErrDisconnected );

//  ===========================================================================

    #define T4L( aResult, aExpected1, aExpected2, aExpected3, aExpected4 )\

        {\

        TInt result = aResult;\

        if( ( (result) != (aExpected1) && \

              (result) != (aExpected2) && \

              (result) != (aExpected3) && \

              (result) != (aExpected4) ) )\

            { TestModuleIf().StifMacroError(\

                (4), (TText8*)__FILE__, __FUNCTION__, __LINE__, (result), \

                (aExpected1), (aExpected2), (aExpected3), (aExpected4) );\

            User::Leave( KErrArgument ); };\

        };

//  T5L =======================================================================

//  Macro for verify integer value from the expected 1, 2, 3, 4 and 5 values.

//  Example for use:

//  T1L( Open(), KErrNone, KErrDied, KErrInUse, KErrDisconnected, KErrAbort );

//  ===========================================================================

    #define T5L( aResult, aExpected1, aExpected2, aExpected3, aExpected4, aExpected5 )\

        {\

        TInt result = aResult;\

        if( ( (result) != (aExpected1) && \

              (result) != (aExpected2) && \

              (result) != (aExpected3) && \

              (result) != (aExpected4) && \

              (result) != (aExpected5) ) )\

            { TestModuleIf().StifMacroError(\

                (5), (TText8*)__FILE__, __FUNCTION__, __LINE__, (result), \

                (aExpected1), (aExpected2), (aExpected3), (aExpected4), (aExpected5) );\

            User::Leave( KErrArgument ); };\

        };

//  TAL ========================================================================

//  Macro for verify boolean value. 

//  Recommended use with TestScripter's test class. Allowed result can be defined

//  with 'allownextresult' and 'allowerrorcodes' keywords.

//  Example for use, 1: TL( Open() == KErrNone );

//                   1: TL( VerifyString1() == VerifyString2() );

//                   2: TL( 6 <= 8 );

//  =============================================================================

    #define TAL( aIsTrue )\

        if( ( !(aIsTrue) ) && TestModuleIf().CheckAllowResult( 0 /* = EFalse*/ ) )\

            { TestModuleIf().StifMacroError( (0), (TText8*)__FILE__, __FUNCTION__, __LINE__ );\

            User::Leave( KErrArgument ); };

//  TA1L =======================================================================

//  Macro for verify integer value from the expected 1 value. 

//  Recommended use with TestScripter's test class. Allowed result can be defined

//  with 'allownextresult' and 'allowerrorcodes' keywords.

//  Example: T1L( Open(), KErrNone );

//  =============================================================================

    #define TA1L( aResult, aExpected1 )\

        {\

        TInt result = aResult;\

        if( ( (result) != (aExpected1) ) && \

               TestModuleIf().CheckAllowResult( result ) ) \

            { TestModuleIf().StifMacroError(\

                (1), (TText8*)__FILE__, __FUNCTION__, __LINE__, (result), (aExpected1) );\

            User::Leave( KErrArgument ); };\

        };

//  TA2L =======================================================================

//  Macro for verify integer value from the expected 1 and 2 values.

//  Recommended use with TestScripter's test class. Allowed result can be defined

//  with 'allownextresult' and 'allowerrorcodes' keywords.

//  Example for use: T1L( Open(), KErrNone, KErrAlreadyExists );

//  =============================================================================

    #define TA2L( aResult, aExpected1, aExpected2 )\

        {\

        TInt result = aResult;\

        if( ( (result) != (aExpected1) && (result) != (aExpected2) ) && \

               TestModuleIf().CheckAllowResult( result ) ) \

            { TestModuleIf().StifMacroError(\

                (2), (TText8*)__FILE__, __FUNCTION__, __LINE__, (result), (aExpected1), (aExpected2) );\

            User::Leave( KErrArgument ); };\

        };

//  TA3L =======================================================================

//  Macro for verify integer value from the expected 1, 2 and 3 values. 

//  Recommended use with TestScripter's test class. Allowed result can be defined

//  with 'allownextresult' and 'allowerrorcodes' keywords.

//  Example for use: T1L( Open(), KErrNone, KErrAlreadyExists, KErrDiskFull );

//  =============================================================================

    #define TA3L( aResult, aExpected1, aExpected2, aExpected3 )\

        {\

        TInt result = aResult;\

        if( ( (result) != (aExpected1) && (result) != (aExpected2) && (result) != (aExpected3) ) && \

              TestModuleIf().CheckAllowResult( result ) )\

            { TestModuleIf().StifMacroError(\

                (3), (TText8*)__FILE__, __FUNCTION__, __LINE__, (result), (aExpected1), (aExpected2), (aExpected3) );\

            User::Leave( KErrArgument ); };\

        };

//  TA4L =======================================================================

//  Macro for verify integer value from the expected 1, 2, 3 and 4 values.

//  Recommended use with TestScripter's test class. Allowed result can be defined

//  with 'allownextresult' and 'allowerrorcodes' keywords.

//  Example for use:

//  T1L( Open(), KErrNone, KErrAlreadyExists, KErrDiskFull, KErrDisconnected );

//  =============================================================================

    #define TA4L( aResult, aExpected1, aExpected2, aExpected3, aExpected4 )\

        {\

        TInt result = aResult;\

        if( ( (result) != (aExpected1) && \

              (result) != (aExpected2) && \

              (result) != (aExpected3) && \

              (result) != (aExpected4) ) && \

               TestModuleIf().CheckAllowResult( result ) ) \

            { TestModuleIf().StifMacroError(\

                (4), (TText8*)__FILE__, __FUNCTION__, __LINE__, (result), \

                (aExpected1), (aExpected2), (aExpected3), (aExpected4) );\

            User::Leave( KErrArgument ); };\

        };

//  TA5L =======================================================================

//  Macro for verify integer value from the expected 1, 2, 3, 4 and 5 values.

//  Recommended use with TestScripter's test class. Allowed result can be defined

//  with 'allownextresult' and 'allowerrorcodes' keywords.

//  Example for use:

//  T1L( Open(), KErrNone, KErrDied, KErrInUse, KErrDisconnected, KErrAbort );

//  =============================================================================

    #define TA5L( aResult, aExpected1, aExpected2, aExpected3, aExpected4, aExpected5 )\

        {\

        TInt result = aResult;\

        if( ( (result) != (aExpected1) && \

              (result) != (aExpected2) && \

              (result) != (aExpected3) && \

              (result) != (aExpected4) && \

              (result) != (aExpected5) ) && \

               TestModuleIf().CheckAllowResult( result ) ) \

            { TestModuleIf().StifMacroError(\

                (5), (TText8*)__FILE__, __FUNCTION__, __LINE__, (result), \

                (aExpected1), (aExpected2), (aExpected3), (aExpected4), (aExpected5) );\

            User::Leave( KErrArgument ); };\

        };

// Workaround for ARM RVCT compiler error. This added because if some

// environment do not include this definition.

#if !defined (NONSHARABLE_CLASS)

#define NONSHARABLE_CLASS(x) class x

#endif

// DATA TYPES

// None

// FUNCTION PROTOTYPES

// None

// FORWARD DECLARATIONS

class CTestModuleBase;

class TEventIf;

class CTestThreadContainer;

class MSTIFTestInterference;

class CSTIFTestMeasurement;

class CSTIFTestMeasurementImplementation;

class CUiEnvProxy;

// CLASS DECLARATION

// DESCRIPTION

// Base class for test case measurement . User can start measurement operations

// via this class.

NONSHARABLE_CLASS( CSTIFTestMeasurement )

        :public CBase 

    {

    public: // Enumerations

        /**

        * Enumeration for different measurement types.

        */

        enum TSTIFMeasurementType

            {

            KStifMeasurementEnableAll,

            KStifMeasurementPlugin01,

            KStifMeasurementPlugin02,

            KStifMeasurementPlugin03,

            KStifMeasurementPlugin04,

            KStifMeasurementPlugin05,

            KStifMeasurementBappeaProfiler,

            KStifMeasurementDisableAll,

            };

        /**

        * Enumeration for different measurement operations.

        */

        enum TSTIFMeasurementOperation

            {

            KMeasurementNew,

            KMeasurementStart,

            KMeasurementStop,

            };

        /**

        * Struct for measurement.

        */

        struct TStifMeasurementStruct

            {

            TSTIFMeasurementType        iMeasurementType;

            TFileName                   iConfigurationInfo;

            TSTIFMeasurementOperation   iMeasurementOperation;

            TInt                        iOperationResult;

            CTestModuleBase*            iPointerToMeasurementModule;

            };

    private: // Enumerations

    public: // Constructors and destructor

        /**

        * Two-phased constructor. Intializes test measurement module.

        */

        IMPORT_C static CSTIFTestMeasurement* NewL( 

                                            CTestModuleBase* aTestModuleBase,

                                            TSTIFMeasurementType aType,

                                            const TDesC& aConfigurationInfo );

    public: // New functions

        /**

        * Start commant for test measurement module.

        * Returns Symbian error code.

        */

        IMPORT_C TInt Start();

        /**

        * Stop command for test measurement module.

        * Returns Symbian error code.

        */

        IMPORT_C TInt Stop();

    public: // Functions from base classes

        /**

        * Destructor 

        */

        virtual ~CSTIFTestMeasurement();

    protected: // New functions

    protected: // Functions from base classes

    private:

        /**

        * C++ default constructor.

        */

        CSTIFTestMeasurement( CTestModuleBase* aTestModuleBase );

        /**

        * By default Symbian OS constructor is private.

        */

        void ConstructL( TSTIFMeasurementType aType,

                         const TDesC& aConfigurationInfo );

    public: //Data

    protected: // Data

    private: // Data

        // Pointer to STIF side

        CTestModuleBase*        iTestModuleBase;

        // Stuct that includes measurement related information

        TStifMeasurementStruct  iMeasurementStruct;

        // Indicates is measurement disable

        TInt                    iMeasurementOption;

    public: // Friend classes

    protected: // Friend classes

    private: // Friend classes

        friend class CTestModuleBase;

    };

// CLASS DECLARATION

// DESCRIPTION

// TTestResult defines the test case result information.

class TTestResult 

    {

    public:

        /**

        * Default constructor of TTestResult.

        */

        IMPORT_C TTestResult();

        /**

        * Sets result and result description of the test case.

        */

        IMPORT_C void SetResult( TInt aResultCode, const TDesC& aResultDes );

    public:

        // Test case result as Symbian OS error code.

        TInt iResult;

        // Descriptive test case result.

        TResultDes iResultDes;

    };

// CLASS DECLARATION

// DESCRIPTION

// TTestCaseInfo defines the information for test case execution.

class TTestCaseInfo

    {

    public:

        // Default test case priority values

        enum TPriority

            {    

            EPriorityLow = -100,

            EPriorityNormal = 0,

            EPriorityHigh = 100,

            };

    public: