/*

* Copyright (c) 2002 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:  CCommonTestClass header for STIF Test Framework TestScripter.

*

*/

#ifndef COMMONTESTCLASS_H

#define COMMONTESTCLASS_H

//  INCLUDES

#include <StifLogger.h>

#include <TestScripterInternal.h>

#include <StifTestModule.h>

#include <aknviewappui.h>

#include "timeoutcontroller.h"

#include "debug.h"

#include <mpxpluginmonitor.h>

#include <mpxpluginmonitorobserver.h>

#include <mpxcenrepwatcher.h>

#include <mpxcenrepobserver.h>

#include <mpxparameter.h>

#include <mpxcollectiontype.h>

#include <mpxpskeywatcher.h>

#include <mpxpskeyobserver.h>

#include <mpxdrmmediautility.h>

#include <mpxmessage.h>

#include <mpxplaybackmessage.h>

#include <mpxmessagequeue.h>

#include <mpxattribute.h>

#include <mpxitemid.h>

#include <mpxsession.h>

#include <mpxmessagemonitor.h>

#include <mpxtaskqueue.h>

#include <mpxtaskqueueobserver.h>

#include <mpxuser.h>

#include <mpxclientlist.h>

#include <mpxviewplugin.h>

#include <mpxcustomcommandobserver.h>

#include <mpxplugininfo.h>

#include <mpxsubscription.h>

// CONSTANTS

const TInt KErrBadTestParameter= -1000;         // Error on configuration file

const TInt KErrEventPending =-2000;             // Timeout and not callback 

const TInt KErrCallbackErrorCode = -2001;       // Callback return error code

const TInt KErrUnexpectedValue =-2002;          // Unexpected value at setting    

const TInt KErrTimeoutController = -2007;		// Unexpected notification

const TInt KShortTimeout = 1000;

const TInt KMediumTimeout = 4000;

const TInt KLongTimeout = 100000;

const TInt KFailTOInstanceClass = -3000;

#ifdef __WINSCW__

_LIT( KCommonTestClassLogPath, "\\testing\\log\\" ); 

#else

_LIT( KCommonTestClassLogPath, "e:\\testing\\log\\" );

#endif

_LIT( KCommonTestClassLogFile, "CommonTestClass.log" ); 

_LIT( KMsgBadTestParameters, "[Error] No valid test case parameters");

_LIT( KTagCompareNotEqual, "<>");

_LIT( KTagCompareEqual, "==");

_LIT( KTagvalue, "value");

// FORWARD DECLARATIONS

//class CMPXPluginMonitor;

//class CMPXCenRepWatcher;

// CLASS DECLARATION

class CMPXMedia;

class CMPXMediaArray;

class CMPXCollectionPath;

class CMPXSubscription;

/**

*  CCommonTestClass test class for STIF Test Framework TestScripter.

*

*  @lib RadioUtilityTestClass.lib

*  @since 5.0

*/

NONSHARABLE_CLASS(CCommonTestClass) : public CScriptBase, 

									public MTimeoutObserver,

									public MMPXPluginMonitorObserver,

									public MMPXCenRepObserver,

									public MMPXPSKeyObserver,

									public MMPXMessageObserver,

									public MMPXTaskQueueObserver,

									public MMPXCustomCommandObserver

    {

    public:  // Constructors and destructor

        /**

        * Two-phased constructor.

        */

        static CCommonTestClass* NewL( CTestModuleIf& aTestModuleIf );

        /**

        * Destructor.

        */

        virtual ~CCommonTestClass();

    public: // Functions from base classes

		enum TMPXTestExpectedEvent

		{

		};

        /**

        * From CScriptBase Runs a script line.

        * @since 3.2

        * @param aItem Script line containing method name and parameters

        * @return Symbian OS error code

        */

        virtual TInt RunMethodL( CStifItemParser& aItem );

	    // From MTimeoutObserver

	    /**

	    * @since 3.2

	    * Review if all the expected events have ocurred once the time is over

	    */

	    void HandleTimeout(TInt error);

    private:

        /**

        * C++ default constructor.

        */

        CCommonTestClass( CTestModuleIf& aTestModuleIf );

        /**

        * By default Symbian 2nd phase constructor is private.

        */

        void ConstructL();

        /**

        * Delete the resources before exit

        * @since S60 3.2

        * @param aItem Script line containing parameters.

        * @return Symbian OS error code.

        */

        void Delete();

	    /**

	    * Set an event as expected and set default timeout

	    * @since S60 3.2

	    */

	    void AddExpectedEvent(TMPXTestExpectedEvent event, TInt ms);

	    /**

	    * Unset an event as expected

	    * @since S60 3.2

	    */

	    TBool RemoveExpectedEvent(TMPXTestExpectedEvent event);

	    /**

	    * @since S60 3.2

	    * Removes all expected events

	    */

	    void RemoveAllExpectedEvents();

	    /**

	    * Verify that the event was expected, removes it from the list

	    * Signal the TestScripter with the returned error code

	    * @since S60 3.2

	    */

	    void ProcessEvent(TMPXTestExpectedEvent aEvent, TInt aError);

	    /**

	    * Maps a event with a descriptor with its name

	    * @since S60 3.2

	    */

	    TPtrC EventName( TInt aKey );

	    /**

	    * Sets a timeout different since the default

	    * @since S60 3.2

	    * @param aItem Script line containing parameters.

	    * @return Symbian OS error code.

	    */

	    TInt SetTimeout( CStifItemParser& aItem );

	    /**

	    *

	    * @since S60 3.2

	    * @param aItem Script line containing parameters.

	    * @return Symbian OS error code.

	    */

	    TInt SetExpectedEvents( CStifItemParser& aItem );

	    /**

	    *

	    * @since S60 3.2

	    * @param aItem Script line containing parameters.

	    * @return Symbian OS error code.

	    */

	    TInt SetAllowedPanic( CStifItemParser& aItem );

	    /**

	    * To test CMPXPluginMonitor::NewL

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

	    TInt CreatePluginMonitorL();///

	    /**

	    * To test CMPXPluginMonitor::~

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

	    TInt DeletePluginMonitorL();

        /*

         * From MMPXPluginMonitorObserver

         */

        void PluginsChangedL();

        void HandlePluginUnload(const TUid& aPluginUid);////add

	    /**

	    * To test CMPXCenRepWatcher::NewL

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

	    TInt CreateCenRepWatcherL();

	    /**

	    * To test CMPXCenRepWatcher::~

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

	    TInt DeleteCenRepWatcherL();

        /*

         * From MMPXCenRepObserver

         *

         */

        void HandleSettingChange(const TUid& aRepositoryUid,

                                         TUint32 aSettingId);

        /**

        * Get current value as integer.

        *

        * @since 5.0

	    * @return Symbian OS error code.

        */

        TInt CenRepCurrentValueL(CStifItemParser& aItem);

        /**

        * Set integer value

        *

        * @since 5.0

	    * @return Symbian OS error code.

        */

        TInt CenRepSetValueL(CStifItemParser& aItem);

	    /**

	    * To test CMPXParameter::CMPXParameter()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

	    TInt CreateMPXParameter();

	    /**

	    * To test CMPXParameter::~

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

	    TInt DeleteMPXParameter();

	    /**

	    * To test CMPXParameter::InternalizeL

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

	    TInt InternalizeMPXParameterL();

	    /**

	    * To test CMPXParameter::ExternalizeL

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

	    TInt ExternalizeMPXParameterL();

	    /**

	    * To test CMPXCollectionType::MPXCollectionType(...)

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

	    //TInt CreateMPXCollectionType();

	    /**

	    * To test CMPXCollectionType::MPXCollectionType()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

	    TInt CreateMPXCollectionTypeWOParam();

	    /**

	    * To test CMPXCollectionType::InternalizeMPXCollectionTypeL()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

	    TInt InternalizeMPXCollectionTypeL();

	    /**

	    * To test CMPXCollectionType::ExternalizeMPXCollectionTypeL()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

	    TInt ExternalizeMPXCollectionTypeL();

	    /**

	    * To test CMPXPSKeyWatcherL::NewL()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt CreateCMPXPSKeyWatcherL();

	    /**

	    * To test CMPXPSKeyWatcherL::~

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt DeleteCMPXPSKeyWatcherL();

	    /**

	    * To test CMPXPSKeyWatcherL::GetValue()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt GetTntValue();

	    /**

	    * To test CMPXPSKeyWatcherL::GetDes8Value()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt GetDes8Value();

	    /**

	    * To test CMPXPSKeyWatcherL::GetDes16Value()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt GetDes16Value();

	    /**

	    * To test CMPXPSKeyWatcherL::SetValue()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt SetTntValue();

	    /**

	    * To test CMPXPSKeyWatcherL::SetDes8Value()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt SetDes8Value();

	    /**

	    * To test CMPXPSKeyWatcherL::SetDes16Value()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt SetDes16Value();

	    /**

	    * From MMPXPSKeyObserver

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        void HandlePSEvent(TUid aUid, TInt aKey);

	    /**

	    * To test CMPXDrmMediaUtilityL::NewL()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt CreateCMPXDrmMediaUtilityL();

	    /**

	    * To test CMPXDrmMediaUtilityL::NewLC()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt CreateCMPXDrmMediaUtilityLC();

	    /**

	    * To test CMPXDrmMediaUtilityL::~

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt DeleteCMPXDrmMediaUtilityL();

	    /**

	    * To test CMPXDrmMediaUtilityL::InitL

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt InitFileNameL();

	    /**

	    * To test CMPXDrmMediaUtilityL::InitL

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt InitRFileL();

	    /**

	    * To test CMPXDrmMediaUtilityL::Close

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt Close();

	    /**

	    * To test CMPXDrmMediaUtilityL::GetMediaL

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt GetMediaL();

	    /**

	    * To test CMPXDrmMediaUtilityL::ConsumeL

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt ConsumeL();

	    /**

	    * To test TMPXMessage::TMPXMessageL(...)

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt TMPXMessage3L();

	    /**

	    * To test TMPXMessage::TMPXMessageL(...)

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt TMPXMessage1L();

	    /**

	    * To test TMPXMessage::TMPXMessageL()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt TMPXMessageL();

	    /**

	    * To test TMPXMessage::EqualTMPXMessage()

	    *

	    * @since S60 5.0

	    * @return Symbian OS error code.

	    */

        TInt EqualTMPXMessage();