/*

* 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 module contains implementation of 

* CMenu-derived classes.

*

*/

// INCLUDE FILES

#include <e32base.h>

#include <e32cons.h>

#include <e32svr.h>

#include <f32file.h>

#include <stifinternal/UIEngineContainer.h>

#include "ConsoleUI.h"

#include "ConsoleMenus.h"

// EXTERNAL DATA STRUCTURES

// EXTERNAL FUNCTION PROTOTYPES  

// CONSTANTS

// MACROS

// LOCAL CONSTANTS AND MACROS

// MODULE DATA STRUCTURES

// LOCAL FUNCTION PROTOTYPES

LOCAL_C void LimitedAppend( TDes& aOriginal, const TDesC& aAppend);

// FORWARD DECLARATIONS

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

LOCAL_C void LimitedAppend( TDes& aOriginal, const TDesC& aAppend)

    {

    TInt spaceLeft = aOriginal.MaxLength() - aOriginal.Length();

    if (spaceLeft > aAppend.Length())

        {

        aOriginal.Append ( aAppend );

        }

    else

        {       

        aOriginal.Append ( aAppend.Left ( spaceLeft ) );

        }

    }

// None

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

/*

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

    Class: CMenu

    Method: NewL

    Description: Constructs new menu.

    Parameters: CConsoleMain* aConsole    :in:      Pointer to main console

                CMenu* aParent            :in:      Parent menu

                const TDesC& aName        :in:      Menu name

    Return Values: CMenu*                           New menu

    Errors/Exceptions: Leaves if memory allocation fails

                       Leaves if ConstructL leaves.

    Status: Draft

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

*/

CMenu* CMenu::NewL( CConsoleMain* aConsole,

                    CMenu* aParent,

                    const TDesC& aName

                  )

    {

    CMenu* self = new ( ELeave ) CMenu();

    CleanupStack::PushL( self );

    self->ConstructL( aConsole, aParent, aName );

    CleanupStack::Pop( self );

    return self;

    }

/*

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

    Class: CMenu

    Method: ConstructL

    Description: Second level constructor.

    Parameters: CConsoleMain* aConsole    :in:      Pointer to main console

                CMenu* aParent            :in:      Parent menu

                const TDesC& aName        :in:      Menu name

				const TDesC& aHeader	  :in:		Text containing STIF version info

    Return Values: None

    Errors/Exceptions: None

    Status: Draft

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

*/

void CMenu::ConstructL( CConsoleMain* aConsole,

                        CMenu* aParent,

                        const TDesC& aName,

                        const TDesC& aHeader

                      )

    {

    // Store the parameters

    iMain = aConsole;

    iConsole = aConsole->GetConsole();

    iParent = aParent;

    iName = aName;

    iHeader = aHeader;

    // Get display size

    const TInt KOverHead = 5;

    iSize = iConsole->ScreenSize();

    iScreenSize = iSize.iHeight - KOverHead;   // Size available for menus

    }

/*

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

    Class: CMenu

    Method: CMenu

    Description: Constructor

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Draft

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

*/

CMenu::CMenu()

    {

    iDirection = 1;

    iPrevPos  = -1;     // Invalid starting value

    }

/*

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

    Class: CMenu

    Method: ~CMenu

    Description: Destructor

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Draft

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

*/

CMenu::~CMenu()

    {

    iItems.ResetAndDestroy();

    }

/*

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

    Class: CMenu

    Method: TimerUpdate

    Description: TimerUpdate

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Draft

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

*/

void CMenu::TimerUpdate()

    {    

    iScrolledLine.Zero();

    RRefArray<TDesC> texts;

    User::LeaveIfError( ItemTexts( texts ) );

    TInt count = texts.Count();

    // If list is empty, do not scroll.

    if ( count < 1 )

        {

        texts.Close();

        return;

        }

    // Recalculate visible part of menu

    Recalculate( count );

    // If menu selection is updated, then restart scrolling

    if (iPrevPos != iFirst + iPosOnScreen)

        {

        iPrevPos = iFirst + iPosOnScreen;

        iStart = 0;

        iDirection = 1;

        }

    // If menu item have not been changed after last timer, then

    // start scrolling  

    const TDesC& name = texts[ iFirst + iPosOnScreen ];

    if ( name.Length() > ( iSize.iWidth - KMenuOverhead ) )

        {

        TInt y = iConsole->WhereY();

        TInt x = iConsole->WhereX();

        TBuf<80> iTmp;              

        iStart = iStart + iDirection;

        // "Right end"

        if ( iStart + iSize.iWidth > name.Length() + KMenuOverhead + 2)

            {

            iStart--;

            iDirection = -1;

            }

        // "Left end"

        if ( iStart == -1 )

            {

            iStart++;

            iDirection = 1;

            }

        if( iStart > name.Length() )

            {

            iStart = 0;

            }

        iTmp=_L(" *");

        LimitedAppend( iTmp, name.Mid ( iStart ) );

        iConsole->SetPos( 0, iPosOnScreen+1);       

        Print(iTmp);

        iScrolledLine.Copy(texts[iFirst + iPosOnScreen].Left(iScrolledLine.MaxLength())); 

        iConsole->SetPos(x,y);

        }

    texts.Close();

    }

/*

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

    Class: CMenu

    Method: AppendBefore

    Description: Append text before line.

    Parameters: TInt aLine: in: line number 

                TDes& aLine: in: line text

    Return Values: None

    Errors/Exceptions: None

    Status: Draft

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

*/

void CMenu::AppendBefore( TInt aLineNum, TDes& aLine )

    {

    if( ( aLine.MaxLength() - aLine.Length() ) < 2 )

        {

        return;

        }        

    // If printing active line, print the marker

    if ( aLineNum == iPosOnScreen + iFirst )

        {

        aLine.Append( _L(" *") );

        }

    else

        {

        aLine.Append( _L("  ") );

        }

    }

/*

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

    Class: CMenu

    Method: PrintMenuL

    Description: Prints the menu

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Draft

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

*/

void CMenu::PrintMenuL( TUpdateType aType )

    {

    iUpdateType = aType;

    TBuf<KMaxLineLength> line;

    //if we are moving between items located on the same page clearing screen is not needed

    if(!iPreventClearScreen)

        {

        // Clear display

        iConsole->ClearScreen();

        //Print STIF version information, only when defined (i.e. in main menu)

        if(iHeader != _L(""))

           Print(iHeader);

        // Print menu title

        Print( Name() );

        RRefArray<TDesC> texts;

        User::LeaveIfError( ItemTexts( texts ) );

        // Recalculate visible part of menu

        Recalculate( texts.Count() );

        //needed for setting cursor at correct line 

        iMenuItemsListStartIndex = iConsole->CursorPos().iY;

        // Print items

        for ( TInt i = iFirst; i <= iLast; i++ )

            {

            line.Zero();

            // Append text before line

            AppendBefore( i, line );

            // Get the menu line

            LimitedAppend ( line, texts[i] );

            // Print the line

            Print(line);

            }

        texts.Close();

        //needed for setting cursor at correct line 

        iMenuItemsListEndIndex = iConsole->CursorPos().iY;

        }

    else

        {

        //removing "*" sign from the previous cursor position

        iConsole->SetPos(0, iPrevPosOnScreen + iMenuItemsListStartIndex);

        //line.Append( _L("  ") );

        AppendBefore(iPrevPosOnScreen + iFirst, line);

        LimitedAppend(line, iScrolledLine);

        //iConsole->Printf(line);

        Print(line);

        iConsole->SetPos(0, iPosOnScreen + iMenuItemsListStartIndex);

        line.Zero();

        iScrolledLine.Zero();

        //writing "*" sign before the currently selected line

        line.Append( _L(" *") );

        iConsole->Printf(line);

        iConsole->SetPos(0, iMenuItemsListEndIndex);

        iPreventClearScreen = EFalse;

        }

    }

/*

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

    Class: CMenu

    Method: SelectL

    Description: Common method to count all variables needed for printing

                 page of the screen.

    Parameters: TInt aDelta       :in:      where to move current position

                 Value > 0 stands for moving down the menu.

                 Value < 0 stands for moving up the menu.

    Return Values: 

    Errors/Exceptions: None

    Status: Draft

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

*/

void CMenu::MovePosition(TInt aDelta)

    {

    if(iItemCount > 0 && aDelta != 0)

        {

        // Valid screen size

        TInt screenSize = iScreenSize + 1;

        TInt realPosition = iFirst + iPosOnScreen;

        // Number of all pages and items in the last page

        TInt rest = iItemCount % screenSize;

        TInt pages = (iItemCount / screenSize) + ((rest == 0) ? (0) : (1));

        // Current page

        TInt currPage = realPosition / screenSize;

        // New page

        TInt newRealPosition = realPosition + aDelta;

        while(newRealPosition < 0)

            newRealPosition += iItemCount;

        newRealPosition %= iItemCount;

        TInt newPage = newRealPosition / screenSize;

        // Change position

        iFirst = newPage * screenSize;

        iLast = iFirst + screenSize - 1;

        if(iLast >= iItemCount)

            iLast = iItemCount - 1;

        iPrevPosOnScreen = iPosOnScreen;

        iPosOnScreen = newRealPosition % screenSize;

        if(newPage == pages - 1 && iPosOnScreen >= rest)

            iPosOnScreen = rest - 1;

        // Prevent refreshing

        iPreventClearScreen = (currPage == newPage);

        }

    else

        iPreventClearScreen = ETrue;    

    }

/*

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

    Class: CMenu

    Method: SelectL

    Description: Process keypresses in menu. Either updates position in

    menu or returns new menu.

    Parameters: TKeyCode aSelection       :in:      Key

                TBool& aContinue          :out:     Has user pressed "Quit"

    Return Values: CMenu*                           New menu

    Errors/Exceptions: None

    Status: Draft

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

*/

CMenu* CMenu::SelectL( TKeyCode aSelection, TBool& aContinue )

    {

    MapKeyCode(aSelection);

    switch ( (TInt) aSelection )

    {

    // Exit

    case EKeyEscape:

        aContinue = EFalse;

        return this;

    // SelectL item

    case EKeyEnter:

    case EKeyRightArrow:

        return iItems[iPosOnScreen];

    // Going back

    case EKeyLeftArrow:

        return iParent;

    // Go down

    case EKeyDownArrow:

        MovePosition(1);

        break;

    // Go Up

    case EKeyUpArrow:

        MovePosition(-1);

        break;