/*

* Copyright (c) 2007 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:   Class used to deal with the items of the Main view

*

*/

// INCLUDE FILES

#include "mediafiledialogstate.h"

#include "mediafiledialogutils.h"

#include <mediafilelist.rsg>  // for .rss resource enums

#include <StringLoader.h>

/******************************************************************************

 * class TMFListItem

 ******************************************************************************/

// -------------------------------------------------------------------------------

// TMFListItem::TMFListItem

//

// -------------------------------------------------------------------------------

//

TMFListItem::TMFListItem()

 : iListIndex(KErrNotFound), iFolderId(KErrNotFound), iParentFolderId(KErrNotFound),

   iChildFolderId(KErrNotFound), iPersistent(ETrue),

   iHidden(EFalse), iIconId(EEIconEmpty), iChildIconId(EEIconEmpty),

   iUnknownCount(KErrNotFound)

	 {

	 }

/******************************************************************************

 * class TMFCurrentItemInfo

 ******************************************************************************/

// -------------------------------------------------------------------------------

// TMFCurrentItemInfo::TMFCurrentItemInfo

//

// -------------------------------------------------------------------------------

//

void TMFCurrentItemInfo::Reset()

    {

    iIndexCheckNeeded = EFalse;

    iItemIndex = KErrNotFound;

    iMediaFileId = KErrNotFound;

    iFolderId = KErrNotFound;

    iFolderText = KNullDesC;

    }

/******************************************************************************

 * class CMediaFileDialogState

 ******************************************************************************/

// -----------------------------------------------------------------------------

// CMediaFileDialogState::NewL

//

// -----------------------------------------------------------------------------

CMediaFileDialogState* CMediaFileDialogState::NewL()

    {

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

    CleanupStack::PushL( self );

    self->ConstructL();

    CleanupStack::Pop( self );

    return self;

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::CMediaFileDialogState

// 

// -----------------------------------------------------------------------------

//

CMediaFileDialogState::CMediaFileDialogState()

	{

	iCurrentFolderId = EEFolderRoot;

	iCurrentFolderIndex = 0;

	iListPosition = KErrNotFound;

    iQueryFolderId = EEFolderRoot;

    iQueryDirection = EEQueryDown;

    iQueryText = KNullDesC;

    iPreviousFolderId = KErrNotFound;

    iCurrentItemInfo.Reset();

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::ConstructL

//

// -----------------------------------------------------------------------------

//

void CMediaFileDialogState::ConstructL()

    {

    AddPermanentItemsL();

    } 

// ----------------------------------------------------------------------------

// Destructor

//

// ----------------------------------------------------------------------------

//

CMediaFileDialogState::~CMediaFileDialogState()

    {

    iList.Close();

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::Init

//

// -----------------------------------------------------------------------------

//

void CMediaFileDialogState::Init()

    {

    // initialize non-persistent folders

    TInt count = iList.Count();

    for ( TInt i=0; i<count; i++ )

        {

        TMFListItem& item = iList[i];

        if ( !item.iPersistent )

            {

            item.iListIndex = KErrNotFound;

            item.iText = KNullDesC;

            item.iTitle = KNullDesC;

            }

        }

	iCurrentFolderId = EEFolderRoot;

	iCurrentFolderIndex = 0;

	iListPosition = KErrNotFound;

    iQueryFolderId = EEFolderRoot;

    iQueryDirection = EEQueryDown;

    iQueryText = KNullDesC;

    iPreviousFolderId = KErrNotFound;

    iCurrentItemInfo.Reset();

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::HideRootFolder

//

// -----------------------------------------------------------------------------

//

void CMediaFileDialogState::HideRootFolder( TInt aFolderId, TBool aHidden,

                                            const TDesC& aText, TInt aIconId )

    {

    TInt index = IndexFromId( aFolderId );

    TMFListItem& item = iList[index];

    if ( item.iParentFolderId != EEFolderRoot )

        {

        return; // only root folders can be variated

        }

    item.iHidden = aHidden;

    if ( aText != KNullDesC )

        {

        TMFDialogUtil::StrCopy( item.iText, aText );

        }

    if ( aIconId != KErrNotFound )

        {

        item.iIconId = aIconId;

        }

    // update root folder indexes. Note that root folders must be

    // created in the same order they appear in UI (see AddPermanentItemsL).

    TInt listIndex = 0;

    TInt count = iList.Count();

    for ( TInt i=0; i<count; i++ )

        {

        TMFListItem& temp = iList[i];

        if ( temp.iParentFolderId == EEFolderRoot )

            {

            if ( !temp.iHidden )

                {

                temp.iListIndex = listIndex;

                listIndex++;

                }

            }

        }

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::ResetUnknownCount

//

// -----------------------------------------------------------------------------

//

void CMediaFileDialogState::ResetUnknownCount()

    {

    SetUnknownCount( EEFolderArtistRoot, KErrNotFound );

    SetUnknownCount( EEFolderAlbumRoot, KErrNotFound );

    SetUnknownCount( EEFolderGenreRoot, KErrNotFound );

    SetUnknownCount( EEFolderComposerRoot, KErrNotFound );

    SetUnknownCount( EEFolderArtist, KErrNotFound );

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::SetUnknownCount

//

// -----------------------------------------------------------------------------

//

void CMediaFileDialogState::SetUnknownCount( TInt aFolderId, TInt aCount )

    {

    TInt index = IndexFromId( aFolderId );

    TMFListItem& item = iList[index];

    item.iUnknownCount = aCount;

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::UnknownCount

//

// -----------------------------------------------------------------------------

//

TInt CMediaFileDialogState::UnknownCount( TInt aFolderId )

    {

    TInt index = IndexFromId( aFolderId );

    TMFListItem& item = iList[index];

    return item.iUnknownCount;

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::HideUnknownFolder

//

// -----------------------------------------------------------------------------

//

void CMediaFileDialogState::HideUnknownFolder( TInt aFolderId, TInt aUnknownCount )

    {

    TInt index = IndexFromId( aFolderId );

    TMFListItem& item = iList[index];

    item.iHidden = EFalse;

    if ( aUnknownCount < 1 )

        {

        item.iHidden = ETrue;

        }

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::HideUnknownFolders

//

// -----------------------------------------------------------------------------

//

void CMediaFileDialogState::HideUnknownFolders()

    {

    TInt count = UnknownCount( EEFolderArtistRoot );

    HideUnknownFolder( EEFolderArtistUnknown, count );

    count = UnknownCount( EEFolderAlbumRoot );

    HideUnknownFolder( EEFolderAlbumUnknown, count );

    count = UnknownCount( EEFolderGenreRoot );

    HideUnknownFolder( EEFolderGenreUnknown, count );

    count = UnknownCount( EEFolderComposerRoot );

    HideUnknownFolder( EEFolderComposerUnknown, count );

    count = UnknownCount( EEFolderArtist );

    HideUnknownFolder( EEFolderArtistAlbumUnknown, count );

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::SetUnknownFolderPosition

//

// -----------------------------------------------------------------------------

//

void CMediaFileDialogState::SetUnknownFolderPosition( TInt aQueryCount )

    {

    //

    // Unknown folder is the last list item (after query result items)

    //

    if ( iCurrentFolderId == EEFolderArtistRoot|| 

         iCurrentFolderId == EEFolderAlbumRoot ||

         iCurrentFolderId == EEFolderGenreRoot ||

         iCurrentFolderId == EEFolderComposerRoot ||

         iCurrentFolderId == EEFolderArtist )

        {

        SetListIndex( EEFolderArtistUnknown, aQueryCount );

        SetListIndex( EEFolderAlbumUnknown, aQueryCount );

        SetListIndex( EEFolderGenreUnknown, aQueryCount );

        SetListIndex( EEFolderComposerUnknown, aQueryCount );

        // folder EEFolderArtist has persistent "All" folder as a first item

        SetListIndex( EEFolderArtistAlbumUnknown, aQueryCount + 1 );

        }

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::IndexFromId

//

// -----------------------------------------------------------------------------

//

TInt CMediaFileDialogState::IndexFromId( TInt aFolderId )

    {

    TInt index = KErrNotFound;

    TInt count = iList.Count();

    for (TInt i=0; i<count; i++)

        {

        TMFListItem& item = iList[i];

        if ( item.iFolderId == aFolderId )

            {

            index = i;

            break;

            }

        }

    __ASSERT_ALWAYS( index != KErrNotFound, Panic( KErrGeneral ) );

    return index;

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::PersistentFolderCount

//

// Get count of persistent subfolders in folder aFolderId.

// -----------------------------------------------------------------------------

//

TInt CMediaFileDialogState::PersistentFolderCount( TInt aFolderId )

    {

    TInt folderCount = 0;

    TInt count = iList.Count();

    for ( TInt i=0; i<count; i++ )

        {

        TMFListItem& item = iList[i];

        if ( item.iParentFolderId == aFolderId )

            {

            if ( item.iHidden )

                {

                continue;

                }

            if ( item.iPersistent )

                {

                folderCount++;

                }

            }

        }

    return folderCount;

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::PersistentFolderCount

//

// -----------------------------------------------------------------------------

//

TInt CMediaFileDialogState::PersistentFolderCount()

    {

    return PersistentFolderCount( iCurrentFolderId );

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::LeadingPersistentFolderCount

//

// -----------------------------------------------------------------------------

//

TInt CMediaFileDialogState::LeadingPersistentFolderCount()

    {

    // how many persisten folders in the beginning of list

    if ( iCurrentFolderId == EEFolderArtist )

        {

        return 1;

        }

    return 0;    

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::CurrentItemIndex

//

// -----------------------------------------------------------------------------

//

TInt CMediaFileDialogState::CurrentItemIndex()

    {

    return iListPosition;

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::SetCurrentItemIndex

//

// -----------------------------------------------------------------------------

//

void CMediaFileDialogState::SetCurrentItemIndex( TInt aIndex )

    {

    iListPosition = aIndex;

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::PreviousFolderId

//

// -----------------------------------------------------------------------------

//

TInt CMediaFileDialogState::PreviousFolderId()

    {

    return iPreviousFolderId;

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::GetCurrentItemInfo

//

// -----------------------------------------------------------------------------

//

TMFCurrentItemInfo& CMediaFileDialogState::CurrentItemInfo()

    {

    return iCurrentItemInfo;

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::QueryDirection

//

// -----------------------------------------------------------------------------

//

TInt CMediaFileDialogState::QueryDirection()

    {

    return iQueryDirection;

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::IsPersistent

//

// -----------------------------------------------------------------------------

//

TInt CMediaFileDialogState::IsPersistent( TInt aFolderId )

    {

    TInt index = IndexFromId( aFolderId );

    TMFListItem& item = iList[index];

    return item.iPersistent;

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::SetListIndex

//

// -----------------------------------------------------------------------------

//

void CMediaFileDialogState::SetListIndex( TInt aFolderId, TInt aListIndex )

    {

    TInt count = iList.Count();

    for ( TInt i=0; i<count; i++ )

        {

        TMFListItem& item = iList[i];

        if ( item.iFolderId == aFolderId )

            {

            if ( item.iParentFolderId == EEFolderRoot || 

                 item.iParentFolderId == EEFolderMusic )

                {

                // root and music folder indexes cannot change after initialization

                break;

                }

            item.iListIndex = aListIndex;

            break;

            }

        }

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::ListIndex

//

// -----------------------------------------------------------------------------

//

TInt CMediaFileDialogState::ListIndex( TInt aFolderId )

    {

    TInt count = iList.Count();

    for ( TInt i=0; i<count; i++ )

        {

        TMFListItem& item = iList[i];

        if ( item.iFolderId == aFolderId )

            {

            return item.iListIndex;

            }

        }

    return KErrNotFound;

    }

// -----------------------------------------------------------------------------

// CMediaFileDialogState::FindBoxNeeded

//

// -----------------------------------------------------------------------------

//

TBool CMediaFileDialogState::FindBoxNeeded()

    {

    //return ETrue;  // find box used in every folder

    if ( iCurrentFolderId == EEFolderSearch ||

         iCurrentFolderId == EEFolderRoot )

        {