/*

* Copyright (c) 2008 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:  A wrapper for the window group list, adding additional functionality required by OOM Monitor v2

*

*/

#ifndef GOOMWINDOWGROUPLIST_H_

#define GOOMWINDOWGROUPLIST_H_

#include <e32base.h>

#include <e32hashtab.h>

#include <w32std.h>

#include <goommonitorplugin.hrh>

#include "alfdecoderserverclient.h"

class CApaWindowGroupName;

/**

 *  This class holds a snapshot of the window group tree. 

 *  

 *  The window group tree is collapsed (see CollapseWindowGroupTree) to remove child windows as we are only 

 *  interested in a single window group Id per application.

 *

 *  @lib goommonitor.lib

 *  @since S60 v5.0

 */

NONSHARABLE_CLASS(CGOomWindowGroupList) : public CBase

    {

public:

    static CGOomWindowGroupList* NewL(RWsSession& aWs);

    // Update the list of window groups

    void RefreshL(TBool aOptionalOnly = EFalse);

    // Update the list of window groups, non-leaving version

    void Refresh(TBool aOptionalOnly = EFalse);

    // Return the number of application instances in this list

    inline TUint Count() const;

    TUint AppId(TInt aIndex, TBool aResolveFromThread = EFalse) const;

    TUint AppIdfromWgId(TInt aWgId, TBool aResolveFromThread = EFalse) const;

    inline const RWsSession::TWindowGroupChainInfo& WgId(TInt aIndex) const;

    TTimeIntervalSeconds IdleTime(TInt aIndex) const;

    ~CGOomWindowGroupList();

    void SetPriorityBusy(TInt aWgId);

    void SetPriorityNormal(TInt aWgId);

    void SetPriorityHigh(TInt aWgId);

    TBool IsBusy(TInt wgIndex);

    // Returns ETrue if an application has registered itself as high priority at runtime

    TBool IsDynamicHighPriority(TInt wgIndex);

    CApaWindowGroupName* WgName() const;

    // Find the specificed application in the window group list and return the index

    TInt GetIndexFromAppId(TUint aAppId) const;

    TInt GetIndexFromWgId(TInt aWgId) const;

    // Find all the windowgroups in the list that matches application id for this window group

    void GetAllWgIdsMatchingAppId(TInt aWgId, RArray<TInt> & WgIdList) const;

    TInt LowOnMemWgs(TInt aIndex) 

        {

        if (aIndex >= iLowOnMemWgs.Count() || aIndex < 0)

            {

            return KErrNotFound;

            }    

        else

            {

            return iLowOnMemWgs[aIndex];

            }

        }

    TInt FindParentIdL(TInt aWgId);    

private:    

    void CollapseWindowGroupTree(RArray<TInt>& aWgsHavingSurfaces);

    void RemovePropertiesForClosedWindowsL();

private:

    CGOomWindowGroupList(RWsSession& aWs);

    void ConstructL();

    RArray<RWsSession::TWindowGroupChainInfo> iWgIds;

    RArray<RWsSession::TWindowGroupChainInfo> iUncollapsedWgIds;

    enum TGOomPriority

        {

        EGOomPriorityNormal,

        EGOomPriorityHigh,

        EGOomPriorityBusy

        };

    class TGOomWindowGroupProperties

        {

    public:

        TGOomWindowGroupProperties();

        TUint32 iIdleTickTime;

        TGOomPriority iDynamicPriority;

        };

    RHashMap<TInt, TGOomWindowGroupProperties> iWgToPropertiesMapping; // A mapping between window group IDs and the properties such as idle time and the high-priority flag

    RHashSet<TInt> iExistingWindowIds; // Used locally in RemoveIdleTimesForClosedWindows(), declared globally because we need to reserve space    

    RWsSession& iWs;    

    CApaWindowGroupName* iWgName;

    HBufC* iWgNameBuf;              // owned by iWgName

    RArray<TInt> iLowOnMemWgs;

    RArray<TInt> iOptionalUids;

    RAlfBridgerClient iAlfClient;

    };

#include "goomwindowgrouplist.inl"

#endif /*GOOMWINDOWGROUPLIST_H_*/