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 for the class that deals with client communication
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __CLIENT_H__
sl@0: #define __CLIENT_H__
sl@0: 
sl@0: #include <graphics/wsgraphicdrawerinterface.h>
sl@0: #include "WSGRAPHICDRAWERARRAY.H"
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <e32base.h>
sl@0: #include <w32std.h>
sl@0: #include "w32cmd.h"
sl@0: #include "WSOBJIX.H"
sl@0: #include "EVQUEUE.H"
sl@0: #include "PRIKEY.H"
sl@0: #include "wstypes.h"
sl@0: 
sl@0: class CWsWindowBase;
sl@0: class CWsClientWindow;
sl@0: class CWsPointerCursor;
sl@0: class CWsCustomTextCursor;
sl@0: class CWsSpriteBase;
sl@0: class DWsScreenDevice;
sl@0: class CScreen;
sl@0: class RHandleBase;
sl@0: class CWindowServer;
sl@0: class CWsGraphicDrawerObject;
sl@0: class CWsGraphicDrawer;
sl@0: 
sl@0: class TWsCursorArrayItem
sl@0: 	{
sl@0: public:
sl@0: 	CWsSpriteBase *iCursor;
sl@0: 	TInt iIndex;
sl@0: 	};
sl@0: 
sl@0: /** Server-side object for a client session.
sl@0: 
sl@0: @internalComponent
sl@0: @released
sl@0: */
sl@0: class CWsClient : public CSession2, public MWsClient
sl@0: 	{
sl@0: private:
sl@0: 	enum{EObjectGranularity=5};
sl@0: 	enum{ENoDefaultSystemPointerCursor=-1};
sl@0: public:
sl@0: 	enum{EPanicLeave=1};
sl@0: public:
sl@0: 	CWsClient(RThread aClient);
sl@0: 	~CWsClient();
sl@0: 	inline const RThread& Client() const;
sl@0: 	inline CWindowServer& WindowServer();
sl@0: 	void CommandL(TInt aOpcode, const TAny *aCmdData);
sl@0: 	void StartInitializationL(TUint aConnectionHandle);
sl@0: 	static const TUint8 *EndOfCommandBuffer();
sl@0: 	static const TPtrC BufferTPtr(TText *aStart,TInt aLen);
sl@0: 	static TBool BufferTPtrGc(TText* aStart,TInt aLen,TPtrC& aPtr);
sl@0: 	static const TPtrC8 BufferTPtr8(TUint8* aStart,TInt aLen);
sl@0: 	void CommandBufL();
sl@0: 	static void ReplyBuf(const TAny *aSource, TInt aLength);
sl@0: 	static void ReplyBuf(const TDesC8 &aDes);
sl@0: 	static void ReplyBuf(const TDesC16 &aDes);
sl@0: 	static void ReplySize(const TSize &aSize);
sl@0: 	static void ReplyPoint(const TPoint &aPoint);
sl@0: 	static void ReplyRect(const TRect &aRect);
sl@0: 	static void SetReply(TInt reply);
sl@0: 	static void PanicCurrentClient(TClientPanic aPanic);
sl@0: 	void PPanic(TClientPanic aPanic) const;
sl@0: 	void HandleToWindow(TInt handle,CWsWindowBase **pWin);
sl@0: 	void HandleToClientWindow(TInt handle,CWsClientWindow **pWin);
sl@0: 	inline CEventQueue *EventQueue() const;
sl@0: 	inline CRedrawQueue *RedrawQueue() const;
sl@0: 	inline CWsObjectIx *ObjectIndex();
sl@0: 	CWsObject *HandleToObjUntyped(TInt aHandle);
sl@0: 	CWsObject *HandleToObj(TInt aHandle, WH_HANDLES aType);
sl@0: 	void RequestComplete(TRequestStatus * &aStatus, TInt aErr);
sl@0: //
sl@0: 	inline void EventReady(const RMessagePtr2& aEventMsg);
sl@0: 	inline void GetEventData();
sl@0: 	inline void CancelEvent();
sl@0: 	inline void PurgePointerEvents();
sl@0: 
sl@0: 	inline void RedrawEventReady(const RMessagePtr2& aEventMsg);
sl@0: 	inline void CancelRedrawEvent();
sl@0: 	inline void GetRedrawData();
sl@0: 
sl@0: 	inline void PriorityKeyEventReady(const RMessagePtr2& aEventMsg);
sl@0: 	inline void CancelPriorityKeyEvent();
sl@0: 	inline void GetPriorityKeyData();
sl@0: 	inline void PriorityKeyPressed(TInt aHandle, const TKeyData &aKey, TInt aScanCode);
sl@0: 
sl@0: 	void TriggerRedraw();
sl@0: 	void SessionPanic(TClientPanic aReason) const;
sl@0: 	void SessionTerminate();
sl@0: 	void UpdateWindowOrdinalPrioritys();
sl@0: 	void CreateNewWindowGroupL(const TWsClCmdCreateWindowGroup &aCmd);
sl@0: 	void CreateNewWindowL(const TWsClCmdCreateWindow &aCmd);
sl@0: 	void CreateNewAnimDllL(const TWsClCmdUnion &aParams);
sl@0: //
sl@0: 	void CreateNewSpriteL(const TWsClCmdCreateSprite &aCmd);
sl@0: 	void CreateNewPointerCursorL(const TWsClCmdCreatePointerCursor &aCmd);
sl@0: 	void StartSetCustomTextCursorL(const TWsClCmdCustomTextCursorData& aCmd);
sl@0: 	void CompleteSetCustomTextCursorL(TInt aErr);
sl@0: 	static CWsCustomTextCursor* FindCustomTextCursor(TInt aIdentifier);
sl@0: 
sl@0: 	void CreateNewScreenDeviceL( TInt aDefaultScreenNumber, TUint aClientScreenDevicePointer);
sl@0: 	void CreateNewBitmapL(const TWsClCmdCreateBitmap &aCmd);
sl@0: 	void CreateNewClickL(const TUid& aUid);
sl@0: //
sl@0: 	void ReplyGroupName(HBufC *aName, TInt aMaxLength) const;
sl@0: 	inline TInt ObjectHandle(const CWsObject *aThis);
sl@0: 	void SetSystemPointerCursorL(TInt aIndex, CWsPointerCursor *aCursor);
sl@0: 	void ClearSystemPointerCursor(TInt aIndex);
sl@0: 	void ClaimSystemPointerCursorListL();
sl@0: 	void FreeSystemPointerCursorList();
sl@0: 	static CWsPointerCursor *SystemPointerCursor(TInt aIndex);
sl@0: 	static inline CWsPointerCursor *DefaultSystemPointerCursor();
sl@0: 	void SetDefaultSystemPointerCursor(TInt aIndex);
sl@0: 	void SetComputeMode(RWsSession::TComputeMode aComputeMode);
sl@0: 	void SetClientPriority();
sl@0: 	inline TInt ConnectionHandle() const;
sl@0: 	inline DWsScreenDevice *PrimaryScreenDevice() const;
sl@0:  	inline void NotifyScreenDeviceDeleted(DWsScreenDevice* aDeletedScreenDevice);
sl@0: 	inline CScreen* Screen() const;
sl@0: 	inline TBool NotClosing() const;
sl@0: 	inline const RMessage2& ClientMessage() const;
sl@0: 	void RemoteRead(TDes16& aDes, TInt aOffset);
sl@0: 	void RemoteRead(TDes8& aDes, TInt aOffset);
sl@0: 	void RemoteReadL(TDes16& aDes, TInt aOffset);
sl@0: 	void RemoteReadL(TDes8& aDes, TInt aOffset);
sl@0: 	static void DeleteStatics();
sl@0: 	void SetResponseHandle(RHandleBase* aHandle);
sl@0: 
sl@0: 	// from MWsClient
sl@0: 	TBool HasCapability(TCapability aCapability) const;
sl@0: 	TSecureId SecureId() const;
sl@0: 	TVendorId VendorId() const;
sl@0: 	TInt SendMessage(const CWsGraphicDrawer* aOnBehalfOf,const TDesC8& aData);
sl@0: 	TInt SendMessage(const CWsGraphicDrawer* aOnBehalfOf,CWsMessageData& aData);
sl@0: 
sl@0: 	CWsGraphicDrawerObject* DrawerObject(const CWsGraphicDrawer* aDrawer);
sl@0: 	const CWsGraphicDrawerObject* DrawerObject(const CWsGraphicDrawer* aDrawer) const;
sl@0: 	static inline CWsClient* CurrentClient();
sl@0: 	static inline TBool CheckBuffer(TInt aLength, TInt aMaxLength);
sl@0:  	static TBool DebugEnforceRedrawCallingConvention();
sl@0: private: // from CSession2
sl@0: 	void ServiceL(const RMessage2 &aMessage);
sl@0: 	void ServiceError(const RMessage2& aMessage,TInt aError);
sl@0: private:
sl@0: 	void CompleteInitializationL();
sl@0: 	static void DeleteSystemPointerListEntry(TInt aIndex);
sl@0: 	static TBool FindCursorArrayItem (CArrayFixFlat<TWsCursorArrayItem>* aCursorArray,
sl@0: 									  TInt aIndex, TInt& aPosition);
sl@0: 	static inline CWsPointerCursor*& PointerCursor (TInt aPosition);
sl@0: 	static inline CWsCustomTextCursor*& TextCursor (TInt aPosition);
sl@0: 	void CommandL(TInt aOpcode, const RMessage2& aMessage);
sl@0: 	void DoServiceL(const RMessage2& aMessage, TBool& aCompleteRequest);
sl@0: 	void CompleteMessage(const RMessage2& aMessage,TInt aReason);
sl@0: 	void InitialiseScreenDevices();
sl@0: 	inline TBool IsInitialised();
sl@0: 	void DebugInfoL(TInt aFunction, TInt aParam, TBool aHasReplyBuf) const;
sl@0: public:
sl@0: 	static TWsCmdHeaderBase iCurrentCommand;
sl@0: private:
sl@0: 	enum TInternalFlags
sl@0: 		{
sl@0: 		EPanicClientAsSoonAsPossible	=0x01,		//The client should be panicked, but we have no way to panic him now
sl@0: 		EClientIsClosing		=0x02,		//The client is closing down, so the screen device may no longer be valid
sl@0: 		};
sl@0: private:	// Private data
sl@0: 	RThread iClient;
sl@0: 	TUint iConnectionHandle; // Connection ID, only needed for logging, could bin this
sl@0: 	CEventQueue *iEventQueue;
sl@0: 	CRedrawQueue *iRedrawQueue;
sl@0: 	CPriorityKey *iPriorityKeyEvent;
sl@0: 	CWsGraphicMessageQueue iGraphicMessageQueue;
sl@0: 	RWsSession::TComputeMode iComputeMode;
sl@0: 	CWsObjectIx *iObjectIndex;
sl@0: 	DWsScreenDevice *iPrimaryScreenDevice;
sl@0: 	TWsCursorArrayItem iTempCustomTextCursor;
sl@0: 	CScreen* iScreen;		//## This needs updating
sl@0: 	mutable TInt iPanicReason;
sl@0: 	mutable TInt iInternalFlags;
sl@0: 	RMessage2 iClientMessage;
sl@0: 	RHandleBase* iResponseHandle;
sl@0: 	TInt iMessageIdSeq;
sl@0: 	TBool iIsInitialised;
sl@0: #if defined(_DEBUG)
sl@0: 	TBool iLastCommand;
sl@0: #endif
sl@0: 	static CWsClient *iCurrentClient;	// Client who's buffer is currently being processed
sl@0: 	static TInt iReply;					// Value to reply
sl@0: 	static TInt iReplyOffset;			// Offset into reply to write next block of data
sl@0: 	static TInt iDefaultSystemPointerCursorIndex;		//Negative when there isn't one
sl@0: 	static CWsPointerCursor *iDefaultSystemPointerCursor;
sl@0: 	static CArrayFixFlat<TWsCursorArrayItem> *iSystemPointerCursors;
sl@0: 	static CWsClient *iSystemPointerCursorListOwner;
sl@0: 	static CArrayFixFlat<TWsCursorArrayItem> *iTextCursorArray;
sl@0: 	static TBuf8<EClientBufferMaxSize> iCmdBuf;
sl@0: 	static TUint iConnectionId;
sl@0:  	static TBool iDebug_EnforceRedrawCallingConvention;
sl@0: #if defined(__WINS__)
sl@0: 	TBool iRemoveKeyCode;
sl@0: public:
sl@0: 	inline TBool RemoveKeyCode();
sl@0: #endif
sl@0: 	};
sl@0: 
sl@0: 
sl@0: //
sl@0: // inlines			//
sl@0: //
sl@0: 
sl@0: //
sl@0: inline const RThread& CWsClient::Client() const
sl@0: 	{return iClient;}
sl@0: inline CWindowServer& CWsClient::WindowServer()
sl@0: 	{return *reinterpret_cast<CWindowServer*>(const_cast<CServer2*>(Server()));}
sl@0: inline void CWsClient::EventReady(const RMessagePtr2& aEventMsg)
sl@0: 	{iEventQueue->EventReady(aEventMsg);}
sl@0: inline void CWsClient::GetEventData()
sl@0:     {iEventQueue->GetData();}
sl@0: inline void CWsClient::PurgePointerEvents()
sl@0: 	{iEventQueue->PurgePointerEvents();}
sl@0: inline void CWsClient::CancelEvent()
sl@0: 	{iEventQueue->CancelRead();}
sl@0: inline void CWsClient::RedrawEventReady(const RMessagePtr2& aEventMsg)
sl@0:     {iRedrawQueue->EventReady(aEventMsg);}
sl@0: inline void CWsClient::GetRedrawData()
sl@0:     {iRedrawQueue->GetData();}
sl@0: inline void CWsClient::CancelRedrawEvent()
sl@0: 	{iRedrawQueue->CancelRead();}
sl@0: inline void CWsClient::PriorityKeyEventReady(const RMessagePtr2& aEventMsg)
sl@0:     {iPriorityKeyEvent->EventReady(aEventMsg);}
sl@0: inline void CWsClient::CancelPriorityKeyEvent()
sl@0: 	{iPriorityKeyEvent->CancelRead();}
sl@0: inline void CWsClient::GetPriorityKeyData()
sl@0: 	{iPriorityKeyEvent->GetData();}
sl@0: inline void CWsClient::PriorityKeyPressed(TInt aHandle, const TKeyData &aKey, TInt aScanCode)
sl@0: 	{iPriorityKeyEvent->PriorityKey(aHandle,aKey,aScanCode);}
sl@0: inline TInt CWsClient::ObjectHandle(const CWsObject *aThis)
sl@0: 	{return(iObjectIndex->At(aThis));}
sl@0: #if defined(__WINS__)
sl@0: inline TBool CWsClient::RemoveKeyCode()
sl@0: 	{return iRemoveKeyCode;}
sl@0: #endif
sl@0: //
sl@0: inline CEventQueue *CWsClient::EventQueue() const
sl@0: 	{return(iEventQueue);}
sl@0: inline CRedrawQueue *CWsClient::RedrawQueue() const
sl@0: 	{return(iRedrawQueue);}
sl@0: inline CWsObjectIx *CWsClient::ObjectIndex()
sl@0: 	{return(iObjectIndex);}
sl@0: inline TInt CWsClient::ConnectionHandle() const
sl@0: 	{return(iConnectionHandle);}
sl@0: inline DWsScreenDevice *CWsClient::PrimaryScreenDevice() const
sl@0: 	{return(iPrimaryScreenDevice);}
sl@0: inline void CWsClient::NotifyScreenDeviceDeleted(DWsScreenDevice* aDeletedScreenDevice)
sl@0: 	{
sl@0: 	if (iPrimaryScreenDevice == aDeletedScreenDevice)
sl@0: 		iPrimaryScreenDevice = NULL;
sl@0: 	}
sl@0: inline CWsPointerCursor*& CWsClient::PointerCursor(TInt aIndex)
sl@0: 	{return (CWsPointerCursor*&)(*iSystemPointerCursors)[aIndex].iCursor;}
sl@0: inline CWsCustomTextCursor*& CWsClient::TextCursor(TInt aIndex)
sl@0: 	{return (CWsCustomTextCursor*&)(*iTextCursorArray)[aIndex].iCursor;}
sl@0: inline const RMessage2& CWsClient::ClientMessage() const
sl@0: 	{return iClientMessage;}
sl@0: inline CScreen* CWsClient::Screen() const
sl@0: 	{return iScreen;}
sl@0: inline TBool CWsClient::NotClosing() const
sl@0: 	{return !(iInternalFlags&EClientIsClosing);}
sl@0: inline CWsClient* CWsClient::CurrentClient()
sl@0: 	{return iCurrentClient;}
sl@0: inline TBool CWsClient::CheckBuffer(TInt aLength, TInt aMaxLength)
sl@0: 	{return TBool((aLength>=0) && (aLength<=aMaxLength));}
sl@0: inline TBool CWsClient::IsInitialised()
sl@0: 	{return iIsInitialised;}
sl@0: #endif