sl@0: // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Definition of classes related event queues
sl@0: // 
sl@0: //
sl@0: 
sl@0: #if !defined(__EVQUEUE_H__)
sl@0: #define __EVQUEUE_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <e32base.h>
sl@0: #include <graphics/WSGRAPHICDRAWERINTERFACE.H>
sl@0: #include "W32STD.H"
sl@0: 
sl@0: class CWsClient;
sl@0: class CWsWindowRedraw;
sl@0: class CWsGraphicDrawer;
sl@0: 
sl@0: enum TEventQueueWalkRet
sl@0: 	{
sl@0: 	EEventQueueWalkOk,
sl@0: 	EEventQueueWalkDeleteEvent,
sl@0: 	EEventQueueWalkRestart,
sl@0: 	};
sl@0: class TWsEvent;
sl@0: 
sl@0: typedef TEventQueueWalkRet (*EventQueueWalk)(TAny* aPtr, TWsEvent* aEvent);
sl@0: 
sl@0: enum TWservEventPriorities
sl@0: 	{
sl@0: 	EEventPriorityHigh,
sl@0: 	EEventPriorityLow,
sl@0: 	};
sl@0: 
sl@0: struct TRedraw
sl@0: 	{
sl@0: 	CWsWindowRedraw* iRedraw;
sl@0: 	TUint iPriority;
sl@0: 	};
sl@0: 
sl@0: class CEventBase : public CBase
sl@0: 	{
sl@0: private:
sl@0: 	enum TEventSignalledState
sl@0: 		{
sl@0: 		EEventFlagSignalled=0x1,
sl@0: 		EEventFlagCancelled=0x2
sl@0: 		};
sl@0: public:
sl@0: 	CEventBase(CWsClient* aOwner);
sl@0: 	~CEventBase();
sl@0: 	void CancelRead();
sl@0: 	void EventReadyCheck();
sl@0: 	virtual void EventReady(const RMessagePtr2& aEventMsg);
sl@0: 	void GetData(TAny* aData, TInt aLen);
sl@0: protected:
sl@0: 	void SignalEvent(TInt aCode = KErrNone);
sl@0: 	inline TBool IsEventCancelled();
sl@0: protected:
sl@0: 	TInt iEventSignalledState;
sl@0: 	CWsClient* iWsOwner;
sl@0: 	RMessagePtr2 iEventMsg;
sl@0: 	};
sl@0: 
sl@0: class CEventQueue : public CEventBase
sl@0: 	{
sl@0: private:
sl@0: 	enum {EExtraQueueSize=16};
sl@0: 	enum {EMaxQueueSize=32};
sl@0: 	enum {EMinQueueSize=2};
sl@0: 	enum {EQueueGranularity=4};
sl@0: 	enum TCompressMode
sl@0: 		{
sl@0: 		ECompressNoPurge,	// Compress only free space
sl@0: 		ECompressPurge1,	// Purge from only non-foreground queues
sl@0: 		ECompressPurge2,	// Purge from all queues
sl@0: 		};
sl@0: // Functions
sl@0: public:
sl@0: 	CEventQueue(CWsClient* aOwner);
sl@0: 	~CEventQueue();
sl@0: 	void ConstructL();
sl@0: 	TBool QueueEvent(const TWsEvent &event);
sl@0: 	TBool QueueEvent(const TWsEvent &event, TWservEventPriorities aPriority);
sl@0: 	TBool QueueEvent(TUint32 aTarget, TInt aEvent, TInt aIntVal = 0);
sl@0: 	TBool CheckRoom();
sl@0: 	void GetData();
sl@0: 	void UpdateLastEvent(const TWsEvent &event);
sl@0: 	TBool UpdateLastPointerEvent(const TWsEvent &event);
sl@0: 	void RemoveEvent(TInt index);
sl@0: 	void PurgePointerEvents();
sl@0: 	const TWsEvent* PeekLastEvent();
sl@0: 	void WalkEventQueue(EventQueueWalk aFunc, TAny* aFuncParam);
sl@0: 	void MoveToFront();
sl@0: 	static void Wait();
sl@0: 	static void Signal();
sl@0: 	static void InitStaticsL();
sl@0: 	static void DeleteStaticsL();
sl@0: 	//void LogUpDownEvents(TChar aChar);
sl@0: public:// from CEventBase
sl@0: 	void EventReady(const RMessagePtr2& aEventMsg);
sl@0: private:
sl@0: 	static void EventCopy(TWsEvent* aStart, TWsEvent* aEnd, TInt aNumEvents);
sl@0: 	static TInt RequiredQueueSize(TInt aNumConnections);
sl@0: 	void AdjustQueueSizeL(TInt aNewSize);
sl@0: 	void IncreaseQueueSize(TInt aNumSpaces);
sl@0: 	TInt FollowingGap() const;
sl@0: 	void Purge();
sl@0: 	TInt PurgeInactiveEvents(const TInt& aSizeRequired);
sl@0: 	void Compress(TCompressMode aCompressMode);
sl@0: 	void AddQueueL();
sl@0: 	void RemoveQueue();
sl@0: 	TBool Expand(TWservEventPriorities aPriority);
sl@0: 	TBool doExpand(TCompressMode aCompressMode);
sl@0: 	TInt SqueezeUp();
sl@0: 	void SqueezeDown();
sl@0: 	void MoveUp(TInt aMove);
sl@0: 	void MoveDown(TInt aMove);
sl@0: 	TBool MoveDownAndExpand(TDblQueIter<CEventQueue> &aIter, TInt aExpand);
sl@0: #if defined(_DEBUG)
sl@0: 	void CheckQueue();
sl@0: 	void ZapEvent(TWsEvent* aTarget);
sl@0: 	void ZapEvents(TWsEvent* aTarget, TInt aLen);
sl@0: #endif
sl@0: private:
sl@0: 	void QueueActive();
sl@0: 	TWsEvent* EventPtr(TInt index);
sl@0: 	void RemoveEvent(TWsEvent* aEvToRemove);
sl@0: 	inline void IncEventPointer(TWsEvent*& aEventPtr);	
sl@0: 	inline void DecEventPointer(TWsEvent*& aEventPtr);	
sl@0: 	void PurgeEventPairs(TWsEvent* aEventToPurge, TPointerEvent::TType aMatchingType, TPointerEvent::TType aSearchTerminator);
sl@0: 	TWsEvent* NextPointerEvent(TWsEvent* aBaseEvent);
sl@0: 	TBool CheckPurgePointerEvent(TWsEvent* aEventToPurge);
sl@0: private:
sl@0:     /** Position of head in local queue relative to iEventPtr. 
sl@0:         First event to send to the Client. */ 
sl@0: 	TInt iHead;
sl@0: 	
sl@0: 	/** Number of events waiting in local queue */
sl@0:     TInt iCount;
sl@0:     
sl@0:     /** Size of local queue = maximum number of events */
sl@0:     TInt iQueueSize;
sl@0:     
sl@0:     /** Beginning of local queue */
sl@0:     TWsEvent* iEventPtr;
sl@0:     
sl@0:     /** Used by iQueueList to link local queues */
sl@0: 	TDblQueLink iLink;
sl@0: 	
sl@0: 	/** Mutex for operations on global event queue */
sl@0: 	static RMutex iMutex;
sl@0: 	
sl@0: 	/** Always filled with zeros */
sl@0: 	static TWsEvent iNullEvent;
sl@0: 	
sl@0: 	/** List of event queues */
sl@0: 	static TDblQue<CEventQueue> iQueueList;
sl@0: 	
sl@0: 	/** Global queue that keeps all events queues */
sl@0: 	static TWsEvent* iGlobalEventQueue;
sl@0: 	
sl@0: 	/** Size of global queue */
sl@0: 	static TInt iGlobalEventQueueSize;
sl@0: 	
sl@0: 	/** Number of event queues */
sl@0: 	static TInt iNumConnections;
sl@0: 	};
sl@0: 
sl@0: class TWsRedrawEvent;
sl@0: 
sl@0: class CRedrawQueue : public CEventBase
sl@0: 	{
sl@0: // Functions
sl@0: public:
sl@0: 	CRedrawQueue(CWsClient *aOwner);
sl@0: 	~CRedrawQueue();
sl@0: 	void ConstructL();
sl@0: 	TBool TriggerRedraw();
sl@0: 	void ReCalcOrder();
sl@0: 	void AddInvalid(CWsWindowRedraw *redrawWin);
sl@0: 	void RemoveInvalid(CWsWindowRedraw *redrawWin);
sl@0: 	void GetData();
sl@0: 	TUint RedrawPriority(CWsWindowRedraw *aRedrawWin);
sl@0: public:// from CEventBase
sl@0: 	void EventReady(const RMessagePtr2& aEventMsg);
sl@0: private:
sl@0: 	void DeleteFromQueue(TInt aIndex);
sl@0: 	void QueueActive();
sl@0: 	TBool FindOutstandingRedrawEvent(CWsWindowRedraw& aRedraw, TWsRedrawEvent& aEvent);
sl@0: 	TBool FindWindowNeedingRedrawEvent(TWsRedrawEvent& aEvent);
sl@0: private:
sl@0: // Data
sl@0: 	CArrayFixSeg<TRedraw> *iRedraws;	// List of windows and their areas that require redraws
sl@0: 	TBool iAllocError;
sl@0: 	TBool iRedrawTrigger;
sl@0: 	TKeyArrayFix *iKeyPriority;
sl@0: 	TKeyArrayFix *iKeyWindow;
sl@0: 	static TWsRedrawEvent iNullRedrawEvent;
sl@0: 	};
sl@0: 
sl@0: class CWsGraphicMessageQueue: public CEventBase
sl@0: 	{
sl@0: public:
sl@0: 	class CMessage: public CWsMessageData
sl@0: 		{
sl@0: 	public:
sl@0: 		static CMessage* New(const TDesC8& aData);
sl@0: 		~CMessage();
sl@0: 	public: // From CWsMessageData
sl@0: 		TPtrC8 Data() const;
sl@0: 		void Release();
sl@0: 	private:
sl@0: 		CMessage(const TDesC8& aData);
sl@0: 	private:
sl@0: 		TPtr8 iData;
sl@0: 		};
sl@0: public:
sl@0: 	CWsGraphicMessageQueue(CWsClient *aOwner);
sl@0: 	~CWsGraphicMessageQueue();
sl@0: 	void GetGraphicMessage();
sl@0: 	void AbortMessage(TInt aError);
sl@0: 	void EventReady(const RMessagePtr2& aEventMsg);
sl@0: 	void Queue(CWsMessageData* aMessage);
sl@0: 	TInt TopClientHandle() const;
sl@0: private:
sl@0: 	CWsMessageData* iHead;
sl@0: 	CWsMessageData* iTail;
sl@0: 	CWsMessageData* Pop();
sl@0: 	void GetDataWithHeader(TUint aHeader, const TDesC8& aData, TInt aDataLen);
sl@0: 	};
sl@0: 
sl@0: #endif