/*

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

*       Provides methods for phonebook contact view list control.

*

*/

// INCLUDE FILES

#include <CPbkContactViewListControl.h>  // This class

#include <barsread.h>    // TResourceReader

#include <eikclbd.h>     // CColumnListBoxData

#include <aknsfld.h>     // CAknSearchField

#include <aknlists.h>    // AknListBoxUtils

#include <AknsDrawUtils.h>

#include <featmgr.h>

#include <bldvariant.hrh>

#include <AknDef.h>      // KEikDynamicLayoutVariantSwitch

#include <AknUtils.h>

// PbkView classes

#include <PbkView.hrh>

#include "CPbkViewState.h"

#include "CPbkThumbnailPopup.h"

#include <CPbkIconArray.h>

#include <MPbkContactViewListControlObserver.h>

#include "PbkFindPrimitivesFactory.h"

#include "PbkContactViewListModelFactory.h"

#include "MPbkFetchDlgSelection.h"

// PbkEng classes

#include <CPbkContactEngine.h>

#include <CPbkConstants.h>

#include <CPbkContactFindView.h>

// PbkExt classes

#include <CPbkExtGlobals.h>

#include <MPbkViewExtension.h>

#include <MPbkContactUiControlExtension.h>

#include <MPbkExtensionFactory.h>

// Phonebook common include files

#include <PbkDebug.h>        // Phonebook debugging support

// Unnamed namespace for local definitions

namespace {

// LOCAL CONSTANTS AND MACROS

/// Listbox model's entry cache size

const TInt KCacheSize = 32;

const TUint16 KZwsChar = 0x200b;

const TUint16 KZwnjChar = 0x200c;

enum TPanicCode

    {

    EPanicPostCond_Constructor = 1,

    EPanicPreCond_ConstructFromResourceL,

    EPanicInvalidListBoxType_ConstructFromResourceL,

    EPanicPostCond_ConstructFromResource,

    EPanicPreCond_ConstructL,

    EPanicPostCond_ConstructL,

    EPanicListBoxNull,

    EPanicLogic_ComponentControl,

    EPanicPostCond_EnableFindBoxL,

    EPanicPostCond_DisableFindBoxL,

    EPanicLogic_FindTextL,

    EPanicPre_SetControlExtensionL

    };

// MODULE DATA STRUCTURES

NONSHARABLE_CLASS(TCleanupEnableListBoxViewRedraw)

    {

    public:  // Interface

        inline TCleanupEnableListBoxViewRedraw(CListBoxView& aListBoxView)

            : iCleanupItem(CleanupOp,&aListBoxView)

            {

            }

        inline operator TCleanupItem() const

            {

            return iCleanupItem;

            }

    private:  // Implementation

        static void CleanupOp(TAny* aPtr);

    private:  // Data

        TCleanupItem iCleanupItem;

    };

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

/**

 * Returns index of aValue in aArray or KErrNotFound.

 */

template<class T>

TInt Find(const CArrayFix<T>& aArray, const T& aValue)

    {

    const TInt count = aArray.Count();

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

        {

        if (aArray[i] == aValue)

            {

            return i;

            }

        }

    return KErrNotFound;

    }

/**

 * Returns CPbkIconArray icon array from aListBox.

 */

inline CPbkIconArray* IconArray(CEikColumnListBox& aListBox)

    {

    return static_cast<CPbkIconArray*>

        (aListBox.ItemDrawer()->ColumnData()->IconArray());

    }

/**

 * Sets aIconArray as aListBox'es icon array.

 */

inline void SetIconArray

        (CEikColumnListBox& aListBox, CPbkIconArray* aIconArray)

    {

    aListBox.ItemDrawer()->ColumnData()->SetIconArray(aIconArray);

    }

void Panic(TPanicCode aReason)

    {

    _LIT(KPanicText, "CPbkContactViewListControl");

    User::Panic(KPanicText, aReason);

    }

/**

 * Returns ETrue, if a character is to be included in the search string

 */

inline TBool IsSearchableChar( const TChar aChar )

    {

    switch (aChar)

        {

        case KZwsChar:  // FALLTHROUGH

        case KZwnjChar:

            {

            return EFalse;

            }

        }

    return ETrue;

    }

// MACROS

/// Define this to print find performance data to debug output

#ifdef PBK_BENCHMARK_FIND

  #pragma message("Warning: PBK_BENCHMARK_FIND is set")

#endif

// MODULE DATA STRUCTURES

#ifdef PBK_BENCHMARK_FIND

/// Benchmarking helper class.

template<class NumT>

NONSHARABLE_CLASS(TRunningTimes)

    {

    public:  // Interface

        /**

         * Constructor.

         */

        inline TRunningTimes()

            {

            Reset();

            }

        /**

         * () operator.

         */

        inline NumT operator()() const

            {

            return iTotal;

            }

        inline void Start()

            {

            iStart.UniversalTime();

            }

        inline void Stop()

            {

            iStop.UniversalTime();

            const TInt timeDiff =

                I64LOW(iStop.MicroSecondsFrom(iStart).Int64()) / 1000;

            iTotal += timeDiff;

            iCount++;

            }

        inline TInt Count() const

            {

            return iCount;

            }

        /**

         * Returns total time

         */

        inline NumT Total() const

            {

            return iTotal;

            }

        /**

         * Reset.

         */

        inline void Reset()

            {

            iTotal=0; iCount=0;

            }

    private:  // Data

        TTime iStart;

        TTime iStop;

        /// Own: count

        TInt iCount;

        /// Own: total time

        NumT iTotal;

    };

#endif  // PBK_BENCHMARK_FIND

}  // namespace

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

//

// CPbkContactViewListControl

//

inline CEikColumnListBox& CPbkContactViewListControl::ListBox() const

    {

    __ASSERT_DEBUG(iListBox, Panic(EPanicListBoxNull));

    return(*iListBox);

    }

inline MPbkContactViewListModel& CPbkContactViewListControl::Model() const

    {

    return(*static_cast<MPbkContactViewListModel*>

        (iListBox->Model()->ItemTextArray()));

    }

inline TBool CPbkContactViewListControl::PostCond_Constructor()

    {

    return

        (!iListBox && !iFindBox && !iFindTextBuf && !iBaseView && !iView &&

        !iResourceData.iUnnamedText && !iResourceData.iFindEmptyText &&

        !iMarkedItemsArray && !iThumbnailPopup);

    }

inline TBool CPbkContactViewListControl::PostCond_ConstructFromResource()

    {

    return

        (iListBox && !iFindBox && !iFindTextBuf &&

        iResourceData.iUnnamedText && !iMarkedItemsArray);

    }

EXPORT_C CPbkContactViewListControl* CPbkContactViewListControl::NewL

        (CPbkContactEngine& aEngine,

        CContactViewBase& aView,

        TInt aResourceId,

        const CCoeControl* aParent)

    {

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING("CPbkContactViewListControl::NewL()"));

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

    CleanupStack::PushL(self);

    self->ConstructL(aEngine, aView, aResourceId, aParent);

    CleanupStack::Pop(self);

    return self;

    }

EXPORT_C CPbkContactViewListControl::CPbkContactViewListControl() :

    iLastFocusId(KNullContactId),

    iChangedIndexes(1 /*allocation granularity*/)

    {

    // CBase::operator new(TLeave) resets other members

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING

        ("CPbkContactViewListControl::CPbkContactViewListControl(0x%x)"),

            this);

    __ASSERT_DEBUG(PostCond_Constructor(), Panic(EPanicPostCond_Constructor));

    }

void CPbkContactViewListControl::ConstructFromResourceL

        (TResourceReader& aReader)

    {

    __ASSERT_DEBUG(PostCond_Constructor(),

        Panic(EPanicPreCond_ConstructFromResourceL));

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING

        ("CPbkContactViewListControl::ConstructFromResourceL(0x%x)"),this);

    // emptyText

    TPtrC emptyText = aReader.ReadTPtrC();

    // unnamedText

    iResourceData.iUnnamedText = aReader.ReadHBufCL();

    // flags

    iResourceData.iFlags = aReader.ReadUint32();

    // Empty text in find state

    TResourceReader rr;

    iEikonEnv->CreateResourceReaderLC(rr, R_AVKON_FIND_NO_MATCHES);

    iResourceData.iFindEmptyText = rr.ReadHBufCL();

    CleanupStack::PopAndDestroy(); // rr

    // listboxType

    TInt listBoxType = aReader.ReadInt16();

    iListBox = static_cast<CEikColumnListBox*>

        (EikControlFactory::CreateByTypeL(listBoxType).iControl);

    __ASSERT_ALWAYS(iListBox, Panic

        (EPanicInvalidListBoxType_ConstructFromResourceL));

    iListBox->SetContainerWindowL(*this);

    // listbox

    iListBox->ConstructFromResourceL(aReader);

    iListBox->View()->SetListEmptyTextL(emptyText);

    iListBox->CreateScrollBarFrameL(ETrue);

    iListBox->ScrollBarFrame()->SetScrollBarVisibilityL

        (CEikScrollBarFrame::EOff, CEikScrollBarFrame::EAuto);

    iListBox->SetObserver(this);

    iListBox->MakeVisible(EFalse);

    // iconArray, use granularity of 4

    CPbkIconArray* iconArray = new(ELeave) CPbkIconArray(4);

    CleanupStack::PushL(iconArray);

    const TInt iconArrayRes = aReader.ReadInt32();

    iconArray->ConstructFromResourceL(iconArrayRes);

    // get extension factory for setting extension icons

    CPbkExtGlobals* extGlobal = CPbkExtGlobals::InstanceL();

    extGlobal->PushL();

    MPbkExtensionFactory& factory = extGlobal->FactoryL();

    factory.AddPbkFieldIconsL(NULL, iconArray);

    CleanupStack::PopAndDestroy(extGlobal);

    CleanupStack::Pop(iconArray);

    SetIconArray(*iListBox,iconArray);

    // emptyIconId

    iResourceData.iEmptyIconId =

        static_cast<TPbkIconId>(aReader.ReadInt16());

    // defaultIconId

    iResourceData.iDefaultIconId =

        static_cast<TPbkIconId>(aReader.ReadInt16());

    // Preallocate space for the one required integer

    iChangedIndexes.AppendL(-1);

    __ASSERT_DEBUG(PostCond_ConstructFromResource(),

        Panic(EPanicPostCond_ConstructFromResource));

    }

EXPORT_C void CPbkContactViewListControl::ConstructL

        (CPbkContactEngine& aEngine,

        CContactViewBase& aView)

    {

    // Check that ConstructFromResourceL is executed

    __ASSERT_DEBUG(PostCond_ConstructFromResource() && !iBaseView && !iView,

        Panic(EPanicPreCond_ConstructL));

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING

        ("CPbkContactViewListControl::ConstructL(0x%x)"),this);

    iFindPrimitives = PbkFindPrimitivesFactory::CreateL(

        aEngine.ContactNameFormat());

    iBaseView = &aView;

    iView = CPbkContactFindView::NewL(

        aEngine, *iBaseView, *this, *iFindPrimitives);

    // Set aParams for MPbkContactViewListModel

    PbkContactViewListModelFactory::TParams params;

    params.iEngine = &aEngine;

    params.iView = iView;

    params.iCacheSize = KCacheSize;

    params.iIconArray = IconArray(*iListBox);

    params.iEmptyId = iResourceData.iEmptyIconId;

    params.iDefaultId = iResourceData.iDefaultIconId;

    // Listbox model

    MPbkContactViewListModel* model = PbkContactViewListModelFactory::

                                            CreateL(params);

    model->SetUnnamedText(iResourceData.iUnnamedText);

    iListBox->Model()->SetItemTextArray(model);

    iListBox->Model()->SetOwnershipType(ELbmOwnsItemArray);

    // thumbnail handler

    if (iResourceData.iFlags & KPbkContactViewListControlUpdateContextPane)

        {

        iThumbnailPopup = CPbkThumbnailPopup::NewL(aEngine);

        }

    // Sets up TLS, must be done before FeatureManager is used.

    FeatureManager::InitializeLibL();

    // iEngine != NULL means that Featuremanager has been initialized

    iEngine = &aEngine;

    __ASSERT_DEBUG(PostCond_ConstructFromResource() && iBaseView && iView &&

        iThumbnailPopup || !(iResourceData.iFlags &

        KPbkContactViewListControlUpdateContextPane),

        Panic(EPanicPostCond_ConstructL));

    }

CPbkContactViewListControl::~CPbkContactViewListControl()

    {

    PBK_DEBUG_PRINT(PBK_DEBUG_STRING

        ("CPbkContactViewListControl::~CPbkContactViewListControl(0x%x)"),

        this);

    // This should be done before listbox delete

    // (which deletes dummy control extension)

    Release(iControlExtension);

    // Fetch dialog pages might delay calling ConstructL and thus Feature

    // manager might not be initialized if destructing early.

    if (iEngine)

        {

        // iEngine != NULL means that Featuremanager has been initialized

        FeatureManager::UnInitializeLib();

        }

    delete iOriginalEmptyText;

    iObservers.Reset();

    delete iFindTextBuf;

    if (iView)

        {

        iView->Close(*this);

        }

    delete iFindPrimitives;

    delete iThumbnailPopup;

    delete iMarkedItemsArray;

    delete iFindBox;

    delete iListBox;

    delete iResourceData.iFindEmptyText;

    delete iResourceData.iUnnamedText;

    }

EXPORT_C TContactItemId CPbkContactViewListControl::ContactIdAtL

        (TInt aIndex) const

    {

    return iView->AtL(aIndex);

    }

EXPORT_C TInt CPbkContactViewListControl::FindContactIdL

        (TContactItemId aId) const

    {

    return iView->FindL(aId);

    }

EXPORT_C TInt CPbkContactViewListControl::CurrentItemIndex() const

    {

    return ListBox().CurrentItemIndex();

    }

EXPORT_C void CPbkContactViewListControl::SetCurrentItemIndex(TInt aIndex)

    {

    if (ListBox().CurrentItemIndex() != aIndex)

        {

        ListBox().SetCurrentItemIndex(aIndex);

        HandleFocusChange();

        }

    }

EXPORT_C void CPbkContactViewListControl::SetCurrentItemIndexAndDraw

        (TInt aIndex)

    {

    if (ListBox().CurrentItemIndex() != aIndex)

        {

        ListBox().SetCurrentItemIndexAndDraw(aIndex);

        HandleFocusChange();

        }

    }

EXPORT_C void CPbkContactViewListControl::HandleMarkableListProcessCommandL

        (TInt aCommandId)

    {

    AknSelectionService::HandleMarkableListProcessCommandL

        (aCommandId, &ListBox());

    }

EXPORT_C void CPbkContactViewListControl::HandleMarkableListDynInitMenuPane

        (TInt aResourceId,

        CEikMenuPane *aMenu)

    {

    AknSelectionService::HandleMarkableListDynInitMenuPane

        (aResourceId, aMenu, &ListBox());

    }

EXPORT_C void

    CPbkContactViewListControl::HandleMarkableListUpdateAfterCommandExecution()

    {

    AknSelectionService::HandleMarkableListUpdateAfterCommandExecution

        (&ListBox());

    }

EXPORT_C const TDesC& CPbkContactViewListControl::FindTextL() const

    {

    // Initial minimum size for the find text buffer

    const TInt KInitialBufSize = 8;

    if (iFindBox)

        {

        const TInt findBoxTextLength = iFindBox->TextLength();

        if (findBoxTextLength > 0)

            {

            TInt bufCapacity = 0;

            if (iFindTextBuf)

                {

                bufCapacity = iFindTextBuf->Des().MaxLength();

                }