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: // Window server C++ Class definitions
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __SERVER_H__
sl@0: #define __SERVER_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <w32std.h>
sl@0: #include "w32cmd.h"
sl@0: #include <bitstd.h>
sl@0: #include <bitdev.h>
sl@0: #include <e32svr.h>
sl@0: #include "OBJECT.H"
sl@0: #include "CLIENT.H"
sl@0: #include "ScrDev.H"
sl@0: #include <Graphics/WSGRAPHICDRAWERINTERFACE.H>
sl@0: #include "Graphics/wsgraphicdrawerinternal.h"
sl@0: #include "WSGRAPHICDRAWERARRAY.H"
sl@0: #include "panics.h"
sl@0: 
sl@0: class CWsGc;
sl@0: class CWsDirectScreenAccess;
sl@0: class CWsAnim;
sl@0: class CWsPluginManager;
sl@0: 
sl@0: const TUid KDllUid={0x10000079};
sl@0: 
sl@0: const TUint KMaxNumberOfMsgsInQueue=20;
sl@0: const TUint KMaxNumberOfMsgsInInactiveQueue=2;
sl@0: 
sl@0: enum TWservActiveObjectPriorities
sl@0: 	{
sl@0: 	EWsGraphicAnimateAwaitIdlePriority=0, // lowest of all, when the system is really idle
sl@0: 	EWsGraphicAnimatePriority=50,		// used by the default animation scheduler; custom schedulers might use other priorities as they see fit
sl@0: 	EMainServerPriority=100,
sl@0: 	ESpriteAnimatePriority=900,			// Below normal heartbeat
sl@0: 	EPointerCursorPriority=950,
sl@0: 	EHeartBeatPriority=1000,
sl@0: 	EKeyRepeatPriority=1990,	// Just below normal events
sl@0: 	EPointerRepeatPriority=1990,// Same as for key repeats
sl@0: 	EEventPriority=2000,
sl@0: 	EWsShellLogonPriority=3000,	// Log on to the shell dying
sl@0: 	EDirectTimeOut=4000,
sl@0: 	EDirectAbort=4010,
sl@0: 	};
sl@0: 
sl@0: enum {ETidyCountSetting=8};
sl@0: 
sl@0: class CWsClient;
sl@0: class DWsScreenDevice;
sl@0: 
sl@0: GLREF_C RWsRegion *GetRegionFromClientL(CWsClient *aClient, TInt aCount);
sl@0: 
sl@0: //---------------------------
sl@0: // The event queue
sl@0: //---------------------------
sl@0: 
sl@0: #define WS_EVENT_QUEUE_SIZE 50
sl@0: 
sl@0: // Forward references
sl@0: 
sl@0: class CWsRedrawMsgWindow;
sl@0: class CWsWindowRedraw;
sl@0: class CWsWindow;
sl@0: class CWsWindowBase;
sl@0: class CWsWindowGroup;
sl@0: class CWsClientWindow;
sl@0: class CWsClient;
sl@0: class CWsBackedUpWindow;
sl@0: class CWsPointerCursor;
sl@0: class TWindowServerEvent;
sl@0: class CWsRootWindow;
sl@0: 
sl@0: enum TFlashState {EFlashOn,EFlashOff};
sl@0: 
sl@0: struct TPointerKeyList
sl@0: 	{
sl@0: 	TRect iRect;
sl@0: 	TInt iScanCode;
sl@0: 	TBool iActivatedByPointerSwitchOn;
sl@0: 	TDblQueLink iQue;
sl@0: 	};
sl@0: 
sl@0: struct TWsMessage
sl@0: 	{
sl@0: 	TUid iUid;
sl@0: 	TUint8 iTheRest[4];	// Dummy elemnt where a variable length component will be
sl@0: 	};
sl@0: 
sl@0: class WsKeyboardEmulator
sl@0: 	{
sl@0: public:
sl@0: 	static TBool PointerEvent(TPointerEvent::TType type,const TPoint &aPoint, TDblQue<TPointerKeyList> *iPointerKeyList);
sl@0: private:
sl@0: 	static void RawKeyEvent(TRawEvent::TType aType);
sl@0: private: // Private data
sl@0: 	static TBool iKeyIsDown;
sl@0: 	static TInt iCurrentKeyDown;
sl@0: 	};
sl@0: 
sl@0: struct TPointerEventInternal
sl@0: 	{
sl@0: 	TPointerEvent::TType iType;		// Type of pointer event
sl@0: 	TUint iModifiers;	// State of pointing device and associated buttons
sl@0: 	TPoint iPosition; 	// Screen co-ordinates of mouse event
sl@0: 	};
sl@0: 
sl@0: //------------------------------
sl@0: // Client object
sl@0: //------------------------------
sl@0: 
sl@0: class CWsCliObj : public CWsObject
sl@0: 	{
sl@0: public:
sl@0: 	static CWsCliObj* NewL(CWsClient *aOwner);
sl@0: private:
sl@0: 	CWsCliObj(CWsClient *aOwner);
sl@0: 	void ConstructL();
sl@0: public: //from CWsObject
sl@0: 	void CommandL(TInt aOpcode, const TAny *aCmdData);
sl@0: 	};
sl@0: 
sl@0: 
sl@0: //---------------------------
sl@0: // Capture Key
sl@0: //---------------------------
sl@0: class CWsCaptureKey : public CWsObject
sl@0: 	{
sl@0: public:
sl@0: 	CWsCaptureKey(CWsWindowGroup *owner);
sl@0: 	~CWsCaptureKey();
sl@0: 	void ConstructL(const TWsWinCmdCaptureKey &aCaptureKey);
sl@0: 	void SetL(const TWsWinCmdCaptureKey &aCaptureKey);
sl@0: 	void CommandL(TInt aOpcode, const TAny *aCmdData);
sl@0: 	inline CWsWindowGroup *WindowGroup();
sl@0: 	inline const CWsWindowGroup *WindowGroup() const;
sl@0: private:
sl@0: 	void CmdToParams(const TWsWinCmdCaptureKey &aCaptureKey, TCaptureKey &aParams);
sl@0: private:
sl@0: 	CWsWindowGroup *iWindowGroup;
sl@0: 	};
sl@0: 
sl@0: class CWsHotKey : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	CWsHotKey(TInt aHotKey, TBool aIsDefault);
sl@0: 	~CWsHotKey();
sl@0: 	void ConstructLD(const TWsWinCmdCaptureKey &aCaptureKey);
sl@0: 	inline TInt HotKeyType() const;
sl@0: 	inline TInt KeyHandle() const;
sl@0: 	inline TBool IsDefault() const;
sl@0: 	inline void SetLink(CWsHotKey *aLink);
sl@0: 	void SetL(const TWsWinCmdCaptureKey &aCaptureKey);
sl@0: public:
sl@0: 	CWsHotKey *iNext;
sl@0: private:
sl@0: 	TInt iHotKeyType;
sl@0: 	TBool iIsDefault;
sl@0: 	CWsCaptureKey *iCaptureKey;
sl@0: 	};
sl@0: 
sl@0: class CWsCaptureKeyUpsAndDowns : public CWsObject
sl@0: 	{
sl@0: public:
sl@0: 	CWsCaptureKeyUpsAndDowns(CWsWindowGroup *owner);
sl@0: 	~CWsCaptureKeyUpsAndDowns();
sl@0: 	void ConstructL(const TWsWinCmdCaptureKey &aCaptureKey);
sl@0: 	void CommandL(TInt aOpcode, const TAny *aCmdData);
sl@0: 	static CWsWindowGroup *CheckForCapture(TUint aScanCode, TUint aModifiers);
sl@0: 	inline CWsWindowGroup *WindowGroup();
sl@0: 	inline const CWsWindowGroup *WindowGroup() const;
sl@0: private:
sl@0: 	TUint iModifierValue;
sl@0: 	TUint iModifierMask;
sl@0: 	TUint iScanCode;
sl@0: 	static TPriQue<CWsCaptureKeyUpsAndDowns> iCaptureKeysUpsAndDowns;
sl@0: 	TPriQueLink iLink;
sl@0: 	CWsWindowGroup *iWindowGroup;
sl@0: 	};
sl@0: 
sl@0: class CWsCaptureLongKey : public CWsObject
sl@0: 	{
sl@0: 	friend class CKeyboardRepeat;
sl@0: public:
sl@0: 	CWsCaptureLongKey(CWsWindowGroup *owner);
sl@0: 	~CWsCaptureLongKey();
sl@0: 	void ConstructL(const TWsWinCmdCaptureLongKey &aCaptureKey);
sl@0: 	void CommandL(TInt aOpcode, const TAny *aCmdData);
sl@0: 	inline CWsWindowGroup *WindowGroup();
sl@0: 	inline const CWsWindowGroup *WindowGroup() const;
sl@0: 	static CWsCaptureLongKey* CheckForCapture(TUint aKeyCode, TInt aModifiers);
sl@0: public:
sl@0: 	static TPriQue<CWsCaptureLongKey> iCaptureLongKeys;
sl@0: private:
sl@0: 	TPriQueLink iLink;
sl@0: 	CWsWindowGroup *iWindowGroup;
sl@0: 	TWsWinCmdCaptureLongKey iData;
sl@0: 	};
sl@0: 
sl@0: //--------------------------------
sl@0: // Owner of CWsGraphicDrawer
sl@0: //--------------------------------
sl@0: 
sl@0: class CWsGraphicDrawerObject: public CWsObject
sl@0: 	{
sl@0: public:
sl@0: 	static CWsGraphicDrawerObject* NewL(CWsClient* aClient,const TWsClCmdUnion &aParams);
sl@0: 	~CWsGraphicDrawerObject();
sl@0: 	// from CWsObject
sl@0: 	void CommandL(TInt aOpcode, const TAny *aCmdData);
sl@0: 	// access
sl@0: 	CWsGraphicDrawer* Drawer();
sl@0: 	const CWsGraphicDrawer* Drawer() const;
sl@0: 	inline TInt ClientHandle() const;
sl@0: private:
sl@0: 	CWsGraphicDrawerObject(CWsClient* aOwner);
sl@0: 	void ConstructL(TUid aType,MWsGraphicDrawerEnvironment& aEnv,const TGraphicDrawerId& aId,const TDesC8& aData,TInt aClientHandle);
sl@0: private:
sl@0: 	static TInt TransientSequence;
sl@0: 	static TBool RollOver;
sl@0: 	CWsGraphicDrawer* iDrawer;
sl@0: 	TInt iClientHandle;
sl@0: 	};
sl@0: 
sl@0: //----------------------------
sl@0: // Window's
sl@0: //----------------------------
sl@0: 
sl@0: enum TWalkMode
sl@0: 	{
sl@0: 	EWalkBehind,
sl@0: 	EWalkChildren,
sl@0: 	EWalkChildrenAndBehind
sl@0: 	};
sl@0: enum TWindowFlags
sl@0: 	{
sl@0: 	EFlagHidden=0x1,			// True if the window is invisble for any reason
sl@0: 	EFlagPointerCaptured=0x2,
sl@0: 	EFlagPointerGrab=0x4,
sl@0: 	EFlagInvisible=0x8,			// True if the client has requested the window to be invisible
sl@0: 	EFlagActive=0x10,			// True if the window has been activated
sl@0: 	//0x20
sl@0: 	//0x40
sl@0: 	EFlagDrawnToScreen=0x80,    // True if the window has been drawn to the screen since it became visible
sl@0: 	//0x100
sl@0: 	EFlagPointerCaptureDragDrop=0x200,	// True if pointure capture in Drag/Drop mode
sl@0: 	EFlagPointerCaptureAllGroups=0x400,	// True if pointer capture affects all groups
sl@0: 	EFlagUsingPointerBuffer=0x800,		// True if using a pointer event buffer
sl@0: 	EFlagHasPointerBuffer=0x1000,		// True if has pointer event buffer allocated
sl@0: 	//0x2000
sl@0: 	EFlagFadeBehind=0x4000,             // True if fade behind requested for this window
sl@0: 	//0x8000
sl@0: 	EFlagNonFadingWindow=0x00010000,		//True if the window should never be faded
sl@0: 	EFlagScreenDeviceInvalid=0x00020000,
sl@0: 	EFlagShutDownInProgress=0x00040000,		// True if the window is currently being shut down
sl@0: 	//0x00080000,
sl@0: 	//0x00100000,
sl@0: 	//0x00200000,
sl@0: 	//0x00400000,
sl@0: 	//0x00800000,
sl@0: 	EFlagGeneratesVisibilityEvents=0x02000000,	// True if visibility events are enabled for this window
sl@0: 	EFlagCanBeSeen=0x04000000,					// True if the last visibility event indicated that part of the window was visible
sl@0: //	EFlagTransparencyAlphaChannel=0x08000000, // True if the window is transparent with an alpha channel (and no transparency mask)
sl@0: 	EFlagNotCantBeSeen=0x10000000,					// True if the last visibility event did not indicate that part of the window was not visible
sl@0: //	EFlagTransparencyPolicyFreezeUnder=0x20000000,	// True if the transparent window enables freezing under policy
sl@0: //	EFlagChildClippedRegionValid=0x40000000,  // True if the ChildClippedRegion is valid
sl@0: 	EFlagHasAlpha=            0x80000000,  // Equivalent to EFlagTransperencyAlphaChannel - new name to prevent confusion
sl@0: 	};
sl@0: 
sl@0: //
sl@0: // Sprites
sl@0: //
sl@0: 
sl@0: class TWsDeltaTimerEntry
sl@0: 	{
sl@0: 	friend class CWsDeltaTimer;
sl@0: public:
sl@0: 	inline TWsDeltaTimerEntry(TCallBack& aCallback);
sl@0: 	inline TWsDeltaTimerEntry();
sl@0: 	inline void Set(TCallBack& aCallback);
sl@0: 	inline TBool IsPending();
sl@0: private:
sl@0: 	TCallBack iCallBack; 
sl@0: 	TDeltaQueLink iLink;
sl@0: 	};
sl@0: class CWsDeltaTimer : public CActive
sl@0: 	{
sl@0: 	enum {CWsDeltaTimerGranularity=100000};
sl@0: public:
sl@0: 	static CWsDeltaTimer* NewL(TInt aPriority);
sl@0: 	void Queue(TTimeIntervalMicroSeconds32 aTimeInMicroSeconds,TWsDeltaTimerEntry& aHandle);
sl@0: 	void Remove(TWsDeltaTimerEntry& anEntry);
sl@0: 	void Activate();
sl@0: 	~CWsDeltaTimer();
sl@0: private:
sl@0: 	CWsDeltaTimer(TInt aPriority);
sl@0: 	void DoCancel();
sl@0: 	void RunL();
sl@0: protected:
sl@0: 	RTimer iTimer;
sl@0: 	TDeltaQue<TWsDeltaTimerEntry> iQueue;
sl@0: 	};
sl@0: 
sl@0: //---------------------------
sl@0: // Top level command class
sl@0: //---------------------------
sl@0: 
sl@0: /** The main server class.
sl@0: 
sl@0: @internalComponent
sl@0: @released
sl@0: */
sl@0: class CWindowServer : public CPolicyServer, public MWsGraphicDrawerEnvironment, public MWsMemoryRelease, public MWsRawEventServer
sl@0: 	{
sl@0: public:
sl@0: 	static CWindowServer *NewL();
sl@0: 	~CWindowServer();
sl@0: 	TInt SessionCount();
sl@0: 	MWsAnimationScheduler* AnimationScheduler();
sl@0: 	CWsPluginManager * PluginManager();
sl@0: 	TBool ReleaseMemory();
sl@0: public:	// from MWsGraphicDrawerEnvironment
sl@0: 	const CWsGraphicDrawer* ResolveGraphic(const TGraphicDrawerId& aId) const;
sl@0: 	void Invalidate(const TGraphicDrawerId& aId);
sl@0: 	TInt ScreenCount() const;
sl@0: 	MWsScreen* Screen(TInt aIndex);
sl@0: 	const MWsScreen* Screen(TInt aIndex) const;
sl@0: 	TBool SetCustomAnimationScheduler(MWsAnimationScheduler* aScheduler);
sl@0: 	TBool HasCustomAnimationScheduler() const;
sl@0: 	TBool ClearCustomAnimationScheduler(MWsAnimationScheduler* aCurrentScheduler);
sl@0: 	TInt RegisterEventHandler(CWsGraphicDrawer* aDrawer, MWsEventHandler* aHandler, TUint32 aEventMask);
sl@0: 	TInt UnregisterEventHandler(CWsGraphicDrawer* aDrawer);
sl@0: 	TInt RegisterWsEventHandler(MWsEventHandler* aHandler, TUint32 aEventMask);
sl@0: 	TInt UnregisterWsEventHandler(MWsEventHandler* aHandler);
sl@0: 	void Log(TInt aPriority,const TDesC &aFmt,TInt aParam=0);
sl@0: 	TInt RegisterMemoryRelease(MWsMemoryRelease * aMemoryRelease);
sl@0: 	void UnregisterMemoryRelease(MWsMemoryRelease * aMemoryRelease);
sl@0: 
sl@0: public: // from MWsRawEventServer
sl@0: 	TInt RegisterRawEventHandler(MEventHandler * aHandler);
sl@0: 	void UnregisterRawEventHandler(MEventHandler * aHandler);
sl@0: 	void PostRawEvent(const TRawEvent & aEvent);
sl@0: 	void PostKeyEvent(const TKeyEvent & aEvent);
sl@0: 
sl@0: public:
sl@0: 	// CWsGraphicDrawer master index
sl@0: 	TInt AddGraphicDrawer(CWsGraphicDrawer* aDrawer);
sl@0: 	TInt SwapGraphicDrawer(CWsGraphicDrawer* aDrawer);
sl@0: 	TInt RemoveGraphicDrawer(const TGraphicDrawerId& aId);
sl@0: 	TInt RemoveAllGraphicDrawers(const MWsClient& aOwner);
sl@0: public: // from MWsMemoryRelease
sl@0: 	TBool ReleaseMemory(TMemoryReleaseLevel aLevel);
sl@0: private:
sl@0: 	CWindowServer();
sl@0: 	void ConstructL();
sl@0: 	TAny* ResolveObjectInterface(TUint aTypeId);
sl@0: private:	// from CServer2
sl@0: 	CSession2* NewSessionL(const TVersion& aVersion,const RMessage2& aMessage) const;
sl@0: private:
sl@0: 	class CDefaultAnimationScheduler;
sl@0: 	CDefaultAnimationScheduler* iDefaultAnimationScheduler;
sl@0: 	CWsPluginManager* iPluginManager;
sl@0: 	RPointerArray<MWsMemoryRelease> iMemoryReleases;
sl@0: 	/** An index to all the CWsGraphicDrawer objects.
sl@0: 	
sl@0: 	All the CWsGraphicDrawer objects are created and owned by the CWsClient objects but they are
sl@0: 	indexed centrally because some operations require access to the full list.
sl@0: 	*/
sl@0: 	CWsGraphicDrawerArray iDrawerMasterIndex;
sl@0: 	};
sl@0: 
sl@0: //
sl@0: inline CWsWindowGroup *CWsCaptureKey::WindowGroup()
sl@0: 	{return(iWindowGroup);}
sl@0: inline const CWsWindowGroup *CWsCaptureKey::WindowGroup() const
sl@0: 	{return(iWindowGroup);}
sl@0: //
sl@0: inline CWsWindowGroup *CWsCaptureKeyUpsAndDowns::WindowGroup()
sl@0: 	{return(iWindowGroup);}
sl@0: inline const CWsWindowGroup *CWsCaptureKeyUpsAndDowns::WindowGroup() const
sl@0: 	{return(iWindowGroup);}
sl@0: //
sl@0: inline CWsWindowGroup *CWsCaptureLongKey::WindowGroup()
sl@0: 	{return(iWindowGroup);}
sl@0: inline const CWsWindowGroup *CWsCaptureLongKey::WindowGroup() const
sl@0: 	{return(iWindowGroup);}
sl@0: //
sl@0: inline CWsPointerCursor *CWsClient::DefaultSystemPointerCursor()
sl@0: 	{return(iDefaultSystemPointerCursor);}
sl@0: //
sl@0: inline TInt CWsHotKey::HotKeyType() const
sl@0: 	{return(iHotKeyType);}
sl@0: inline TInt CWsHotKey::KeyHandle() const
sl@0: 	{return((TInt)iCaptureKey);}
sl@0: inline TBool CWsHotKey::IsDefault() const
sl@0: 	{return(iIsDefault);}
sl@0: inline void CWsHotKey::SetLink(CWsHotKey *aLink)
sl@0: 	{iNext=aLink;}
sl@0: //
sl@0: inline TWsDeltaTimerEntry::TWsDeltaTimerEntry(TCallBack& aCallback)
sl@0: 	{iCallBack=aCallback;}
sl@0: inline TWsDeltaTimerEntry::TWsDeltaTimerEntry()
sl@0: 	{}
sl@0: inline void TWsDeltaTimerEntry::Set(TCallBack& aCallback)
sl@0: 	{iCallBack=aCallback;}
sl@0: inline TBool TWsDeltaTimerEntry::IsPending()
sl@0: 	{return(iLink.iNext!=NULL);}
sl@0: //
sl@0: inline TInt CWsGraphicDrawerObject::ClientHandle() const
sl@0: 	{return iClientHandle;}
sl@0: 
sl@0: #endif