/*

* 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 CMenu 

* derived classes.

*

*/

#ifndef CONSOLE_MENUS_H

#define CONSOLE_MENUS_H

//  INCLUDES

#include <e32std.h>

#include <e32base.h>

#include <stifinternal/UIStoreIf.h>

#include <stifinternal/UIStoreContainer.h>

#include <stifinternal/UIEngineContainer.h>

#include "CallBack.h"

// CONSTANTS

const TInt KMenuOverhead = 4;

// Numeric key ascii code values for ConsoleUI's menu

const TInt KMyKeyDownAsciiCode = 56; // Ascii code for number '8'

const TInt KMyKeyLeftAsciiCode = 52; // Ascii code for number '4'

const TInt KMyKeyRightAsciiCode = 54; // Ascii code for number '6'

const TInt KMyKeyUpAsciiCode = 50;  // Ascii code for number '2'

// MACROS

// DATA TYPES

// FUNCTION PROTOTYPES

// FORWARD DECLARATIONS

class CMenu;

class CConsoleMain;

class CCaseOperationMenu;

class CCaseExecutionView;

// CLASS DECLARATION

// DESCRIPTION

// Main menu

class CMenu

        :public CBase

    {

    public:  // Enumerations

        enum TUpdateType

            {

            EMenuPrint,

            EMenuRefresh,

            };

        // None

    private: // Enumerations

        // None

    public:  // Constructors and destructor

        // None

        /**

        * NewL is first phase of two-phased constructor.

        */

        static CMenu* NewL( CConsoleMain* aConsole,

                            CMenu* aParent,

                            const TDesC& aName);

       /**

        * Destructor of CConsoleMain.

        */

        virtual ~CMenu();

    public: // New functions

        /** 

        * Return menu name

        */

        virtual const TDesC& Name() const;

        /** 

        * Return item texts.

        */

        virtual TInt ItemTexts( RRefArray<TDesC>& aArray );

        /** 

        * Prints the menu

        */

        virtual void PrintMenuL( TUpdateType  aType );

        /** 

        * Process keypresses on this menu

        */

        virtual CMenu* SelectL( TKeyCode aSelectLion, TBool& aContinue );

        /** 

        * Set parent menu

        */

        virtual void SetParent ( CMenu* aMenu );

        /** 

        * Print line

        */

        virtual void Print( const TDesC& aPrint);

        /** 

        * Multi line print

        */

        virtual void PrintMulti( const TDesC& aPrint );

        /** 

        * Add item to menu

        */

        virtual void AddItemL ( CMenu* aItem );

        /** 

        * Signals test completion

        */

        virtual void SignalL ( CStartedTestCase* /*aContainer*/ ){};

        /** 

        * Update display from timer

        */

		virtual void TimerUpdate();

		/**

		* Append text before original text.

		*/

		virtual void AppendBefore(  TInt aLineNum, TDes& aLine );

		/**

		* Get menu type.

		*/

		inline TInt Type(){ return iType; };

		/**

		* Map KeyCode 

		*/

		void MapKeyCode(TKeyCode &aSelection);

		/**

		 * Recalculates visible menu elements.

		 */

		void Recalculate( TInt aItemCount );

    public: // Functions from base classes

        // None

    protected:  // New functions

        // None

    private:   // New functions

        /**

        * Changes internal variables to move cursor in the menu.

        */

        void MovePosition(TInt aDelta);

    protected:  // Functions from base classes

        // None    

        /** 

        * C++ default constructor.

        */

        CMenu();

        /**

        * By default Symbian OS constructor is private.

        */

        void ConstructL( CConsoleMain* aConsole,

                         CMenu* aParent,

                         const TDesC& aName,

                         const TDesC& aHeader = KNullDesC);

    private:   // Functions from base classes

        // None

    public:   // Data

        // None

    protected:  // Data    

        CConsoleBase*           iConsole;      // Pointer to console

        CConsoleMain*           iMain;         // Pointer to main console

        CMenu*                  iParent;       // Pointer to parent menu

        TName                   iName;         // Menu name

    	TName					iHeader;	   // Used to display STIF version information

        RPointerArray<CMenu>    iItems;        // Menu items

        TInt                    iPosOnScreen;  // Position on display

        TInt                    iPrevPosOnScreen; // Previous position on display

        TInt                    iMenuItemsListStartIndex;    // Y-index of the first line containing menu item

        TInt                    iMenuItemsListEndIndex;    // Y-index of the last line containing menu item

        TInt                    iFirst;        // First displayed item

        TInt                    iLast;         // Last displayed item

        TBool                   iPreventClearScreen;  // In case of moving cursor "in screen" cleaning screen is not needed

        TInt                    iItemCount;    // Last Item

        TSize                   iSize;         // Display size

        TInt                    iScreenSize;   // "Work area" size

		TInt                    iDirection;    // Scrolling direction

		TInt                    iStart;        // Scrolling position

		TInt                    iPrevPos;      // Previous position in scrolling

        // Menu type (which updates must cause console update) 

        // Flags from CUIStoreIf::TUpdateFlags 

        TInt                    iType;

        // Update type set from PrintMenuL

		TUpdateType             iUpdateType;

    private:    // Data

        TName           iScrolledLine; //Original value of line, that was recently scrolled

    public:     // Friend classes

        // None

    protected:  // Friend classes

        // None

    private:    // Friend classes

        // None

    };

// CONSTANTS

_LIT( KSelectMenuTxt, "Select module to load, if using ini or test case file use testframework.ini" );

// DESCRIPTION

// Filename query menu

class CFileNameQueryView 

    :public CMenu

    {

    public:  // Enumerations

        // None

    private: // Enumerations

        // None

    public:  // Constructors and destructor

        // None

        /**

        * NewL is first phase of two-phased constructor.

        */

        static CFileNameQueryView* NewL( CConsoleMain* aConsole, 

                                         CMenu* aParent, 

                                         const TDesC& aName);

        ~CFileNameQueryView();

    public: // New functions

       // None

    public: // Functions from base classes

        /** 

        * Return item texts.

        */

        virtual TInt ItemTexts( RRefArray<TDesC>& aArray );

        /** 

        * Process keypresses on this menu

        */

        virtual CMenu* SelectL( TKeyCode aSelectLion, TBool& aContinue );

    protected:  // New functions

        /**

        * By default Symbian OS constructor is private.

        */

        void ConstructL( CConsoleMain* aConsole, 

                         CMenu* aParent, 

                         const TDesC& aName );

    protected:  // Functions from base classes

        // None

    private:

    public:   // Data

        // None

    protected:  // Data

        // None

    private:    // Data

        // List of module names

        RPointerArray<TDesC>    iTestModuleNames;

    public:     // Friend classes

        // None

    protected:  // Friend classes

        // None

    private:    // Friend classes

        // None

    };

// CONSTANTS

_LIT( KAddMenuTxt,  "Add test module" );

_LIT( KLoadMenuTxt,  "Load all test modules" );

// DESCRIPTION

// Module list menu

class CModuleListView 

    :public CMenu

    {

    public:  // Enumerations

        // None

    private: // Enumerations

        enum TModuleListMenu

            {

            EAddMenuTxtItem,

            ELoadMenuTxtItem,

            };

    public:  // Constructors and destructor

        /**

        * NewL is first phase of two-phased constructor.

        */

        static CModuleListView* NewL( CConsoleMain* aConsole,

                                      CMenu* aParent,

                                      const TDesC& aName );

       /**

        * Destructor

        */

        ~CModuleListView();

    public: // New functions

        // None

    public: // Functions from base classes

        /** 

        * Return item texts.

        */

        virtual TInt ItemTexts( RRefArray<TDesC>& aArray );

        /** 

        * Process keypresses on this menu

        */

        virtual CMenu* SelectL( TKeyCode aSelectLion, 

                                TBool& aContinue );

        /** 

        * Prints the menu

        */

        virtual void PrintMenuL( TUpdateType  aType );

    protected:  // New functions

        // None

    protected:  // Functions from base classes

        // None

        /**

        * By default Symbian OS constructor is private.

        */

        void ConstructL( CConsoleMain* aConsole, 

                         CMenu* aParent,

                         const TDesC& aName );

    private:

    public:   //Data

        // None

    protected:  // Data

        // None

    private:    // Data

        CMenu*                     iModuleAdd;

    public:     // Friend classes

         // None

    protected:  // Friend classes

        // None

    private:    // Friend classes

        // None

    };

// DESCRIPTION

// Test case starting menu

class CCaseStartMenu 

    :public CMenu

    {

    public:  // Enumerations

        // None

    private: // Enumerations

        // None

    public:  // Constructors and destructor

        /**

        * NewL is first phase of two-phased constructor.

        */

        static CCaseStartMenu* NewL( CConsoleMain* aConsole, 

                                     CMenu* aParent, 

                                     const TDesC& aName,

                                     TBool aShowOutput = EFalse);

        /**

        * Destructor.

        */

		~CCaseStartMenu();

    public: // New functions

       // None

    public: // Functions from base classes

        /** 

        * Process keypresses on this menu

        */

        virtual CMenu* SelectL( TKeyCode aSelectLion, 

                                TBool& aContinue );

        /** 

        * Return item texts.

        */

        virtual TInt ItemTexts( RRefArray<TDesC>& aArray );

    protected:  // New functions

        // None

    protected:  // Functions from base classes

        /**

        * By default Symbian OS constructor is private.

        */

        void ConstructL( CConsoleMain* aConsole,

                         CMenu* aParent,

                         const TDesC& aName,

                         TBool aShowOutput = EFalse);

    private:

        // None

    public:     // Data

        // None

    protected:  // Data

        // Test case array

        RRefArray<CTestInfo> iTestCases;

    private:    // Data

        // Show output automaticly after test case is started

        TBool iShowOutput;

        // Map table. Translates indexes from filtered to all loaded from module  

        RArray<TInt> iMapFilteredToAll;

        // Keeps filter name converted to lower case

        TFileName iFilterLowerCase;

        // Keeps title of test case converted to lower case

        TFileName iTitleLowerCase;

    public:     // Friend classes

        // None

    protected:  // Friend classes

        // None

    private:    // Friend classes

        // None

    };

// CONSTANTS

_LIT( KChangeAll, "Change all");

_LIT( KCancelSet, "Cancel set execution" );

// Test set creation menu

class CMultipleBaseMenu 

    :public CCaseStartMenu

    {

    public:  // Enumerations

         enum TMenuIndex

		    {  

		    EChangeAll = 0,

		    ECancelSet = 0,

		    };

        enum TRunType

            {

            ERunSequential,

            ERunParallel,

            ERunRepeatSequential,

            };

    protected: // Enumerations

    public:  // Constructors and destructor

        /**

        * NewL is first phase of two-phased constructor.

        */

        static CMultipleBaseMenu* NewL( CConsoleMain* aConsole, 

                                        CMenu* aParent, 

                                        const TDesC& aName);

        /**

        * Destructor.