/*
* 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: STIF testclass declaration
*
*/

#ifndef FORMATTERRFSPLUGINTESTMODULE_H
#define FORMATTERRFSPLUGINTESTMODULE_H

//  INCLUDES
#include <StifLogger.h>
#include <TestScripterInternal.h>
#include <StifTestModule.h>
#include <TestclassAssert.h>

class CRFSPlugin;

// CONSTANTS
//const ?type ?constant_var = ?constant;

// MACROS
//#define ?macro ?macro_def
#define TEST_CLASS_VERSION_MAJOR 0
#define TEST_CLASS_VERSION_MINOR 0
#define TEST_CLASS_VERSION_BUILD 0

// Logging path
_LIT( KFormatterRFSPluginTestModuleLogPath, "\\logs\\testframework\\FormatterRFSPluginTestModule\\" ); 
// Log file
_LIT( KFormatterRFSPluginTestModuleLogFile, "FormatterRFSPluginTestModule.txt" ); 
_LIT( KFormatterRFSPluginTestModuleLogFileWithTitle, "FormatterRFSPluginTestModule_[%S].txt" );

// FUNCTION PROTOTYPES
//?type ?function_name(?arg_list);

// FORWARD DECLARATIONS
//class ?FORWARD_CLASSNAME;
class CFormatterRFSPluginTestModule;

// DATA TYPES
//enum ?declaration
//typedef ?declaration
//extern ?data_type;

// CLASS DECLARATION

/**
*  CFormatterRFSPluginTestModule test class for STIF Test Framework TestScripter.
*  ?other_description_lines
*
*  @lib ?library
*  @since ?Series60_version
*/
NONSHARABLE_CLASS(CFormatterRFSPluginTestModule) : public CScriptBase
    {
    public:  // Constructors and destructor

        /**
        * Two-phased constructor.
        */
        static CFormatterRFSPluginTestModule* NewL( CTestModuleIf& aTestModuleIf );

        /**
        * Destructor.
        */
        virtual ~CFormatterRFSPluginTestModule();

    public: // New functions

        /**
        * ?member_description.
        * @since ?Series60_version
        * @param ?arg1 ?description
        * @return ?description
        */
        //?type ?member_function( ?type ?arg1 );

    public: // Functions from base classes

        /**
        * From CScriptBase Runs a script line.
        * @since ?Series60_version
        * @param aItem Script line containing method name and parameters
        * @return Symbian OS error code
        */
        virtual TInt RunMethodL( CStifItemParser& aItem );

    protected:  // New functions

        /**
        * ?member_description.
        * @since ?Series60_version
        * @param ?arg1 ?description
        * @return ?description
        */
        //?type ?member_function( ?type ?arg1 );

    protected:  // Functions from base classes

        /**
        * From ?base_class ?member_description
        */
        //?type ?member_function();

    private:

        /**
        * C++ default constructor.
        */
        CFormatterRFSPluginTestModule( CTestModuleIf& aTestModuleIf );

        /**
        * By default Symbian 2nd phase constructor is private.
        */
        void ConstructL();

        // Prohibit copy constructor if not deriving from CBase.
        // ?classname( const ?classname& );
        // Prohibit assigment operator if not deriving from CBase.
        // ?classname& operator=( const ?classname& );

        /**
        * Frees all resources allocated from test methods.
        * @since ?Series60_version
        */
        void Delete();

        /**
        * Test methods are listed below. 
        */
    private:    // New methods

        TInt SetupEmptyL(CStifItemParser& aItem);
        TInt SetupConditionalL(CStifItemParser& aItem);
        TInt SetupL(CStifItemParser& aItem);
        TInt SetupExcludeListOnlyL(CStifItemParser& aItem);
        TInt SetupAppSpecExcludeListOnlyL(CStifItemParser& aItem);
        TInt SetupExcludeListL(CStifItemParser& aItem);
        TInt SetupAppSpecExcludeListL(CStifItemParser& aItem);
        TInt Teardown(CStifItemParser& aItem);
        TInt TeardownExcludeList(CStifItemParser& aItem);
        TInt TeardownAppSpecExcludeList(CStifItemParser& aItem);

        TInt TestConstructorL(CStifItemParser& aItem);
        TInt TestConstructorNoMemoryL(CStifItemParser& aItem);

        TInt TestRestoreConditionalL(CStifItemParser& aItem);
        TInt TestRestoreL(CStifItemParser& aItem);
        TInt TestRestoreWithExcludeListL(CStifItemParser& aItem);
        TInt TestRestoreNoMemoryL(CStifItemParser& aItem);
        TInt TestGetScriptConditionalL(CStifItemParser& aItem);
        TInt TestGetScriptL(CStifItemParser& aItem);
        TInt TestGetScriptEmptyL(CStifItemParser& aItem);
        TInt TestCustomCommandL(CStifItemParser& aItem);
        
        void AppExcludeListsExistL();

        /**
        * Example test method.
        * @since ?Series60_version
        * @param aItem Script line containing parameters.
        * @return Symbian OS error code.
        */
        //virtual TInt ExampleL( CStifItemParser& aItem );
        
        /**
         * Method used to log version of test class
         */
        void SendTestClassVersion();

        //ADD NEW METHOD DEC HERE
        //[TestMethods] - Do not remove

    public:     // Data
        // ?one_line_short_description_of_data
        //?data_declaration;

    protected:  // Data
        // ?one_line_short_description_of_data
        //?data_declaration;

    private:    // Data
        
        /** Instance of the class that this test suite is testing. */
        CRFSPlugin* iTestObj;
        
        TBool iAppSpecificFilesExist;

    public:     // Friend classes
        //?friend_class_declaration;
    protected:  // Friend classes
        //?friend_class_declaration;
    private:    // Friend classes
        //?friend_class_declaration;

    };

#endif      // FORMATTERRFSPLUGINTESTMODULE_H

// End of File
