1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/graphics/windowing/windowserver/nonnga/SERVER/CLIENT.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,295 @@
1.4 +// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// Definition of classes for the class that deals with client communication
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __CLIENT_H__
1.22 +#define __CLIENT_H__
1.23 +
1.24 +#include <graphics/wsgraphicdrawerinterface.h>
1.25 +#include "WSGRAPHICDRAWERARRAY.H"
1.26 +
1.27 +#include <e32std.h>
1.28 +#include <e32base.h>
1.29 +#include <w32std.h>
1.30 +#include "w32cmd.h"
1.31 +#include "WSOBJIX.H"
1.32 +#include "EVQUEUE.H"
1.33 +#include "PRIKEY.H"
1.34 +#include "wstypes.h"
1.35 +
1.36 +class CWsWindowBase;
1.37 +class CWsClientWindow;
1.38 +class CWsPointerCursor;
1.39 +class CWsCustomTextCursor;
1.40 +class CWsSpriteBase;
1.41 +class DWsScreenDevice;
1.42 +class CScreen;
1.43 +class RHandleBase;
1.44 +class CWindowServer;
1.45 +class CWsGraphicDrawerObject;
1.46 +class CWsGraphicDrawer;
1.47 +
1.48 +class TWsCursorArrayItem
1.49 + {
1.50 +public:
1.51 + CWsSpriteBase *iCursor;
1.52 + TInt iIndex;
1.53 + };
1.54 +
1.55 +/** Server-side object for a client session.
1.56 +
1.57 +@internalComponent
1.58 +@released
1.59 +*/
1.60 +class CWsClient : public CSession2, public MWsClient
1.61 + {
1.62 +private:
1.63 + enum{EObjectGranularity=5};
1.64 + enum{ENoDefaultSystemPointerCursor=-1};
1.65 +public:
1.66 + enum{EPanicLeave=1};
1.67 +public:
1.68 + CWsClient(RThread aClient);
1.69 + ~CWsClient();
1.70 + inline const RThread& Client() const;
1.71 + inline CWindowServer& WindowServer();
1.72 + void CommandL(TInt aOpcode, const TAny *aCmdData);
1.73 + void StartInitializationL(TUint aConnectionHandle);
1.74 + static const TUint8 *EndOfCommandBuffer();
1.75 + static const TPtrC BufferTPtr(TText *aStart,TInt aLen);
1.76 + static TBool BufferTPtrGc(TText* aStart,TInt aLen,TPtrC& aPtr);
1.77 + static const TPtrC8 BufferTPtr8(TUint8* aStart,TInt aLen);
1.78 + void CommandBufL();
1.79 + static void ReplyBuf(const TAny *aSource, TInt aLength);
1.80 + static void ReplyBuf(const TDesC8 &aDes);
1.81 + static void ReplyBuf(const TDesC16 &aDes);
1.82 + static void ReplySize(const TSize &aSize);
1.83 + static void ReplyPoint(const TPoint &aPoint);
1.84 + static void ReplyRect(const TRect &aRect);
1.85 + static void SetReply(TInt reply);
1.86 + static void PanicCurrentClient(TClientPanic aPanic);
1.87 + void PPanic(TClientPanic aPanic) const;
1.88 + void HandleToWindow(TInt handle,CWsWindowBase **pWin);
1.89 + void HandleToClientWindow(TInt handle,CWsClientWindow **pWin);
1.90 + inline CEventQueue *EventQueue() const;
1.91 + inline CRedrawQueue *RedrawQueue() const;
1.92 + inline CWsObjectIx *ObjectIndex();
1.93 + CWsObject *HandleToObjUntyped(TInt aHandle);
1.94 + CWsObject *HandleToObj(TInt aHandle, WH_HANDLES aType);
1.95 + void RequestComplete(TRequestStatus * &aStatus, TInt aErr);
1.96 +//
1.97 + inline void EventReady(const RMessagePtr2& aEventMsg);
1.98 + inline void GetEventData();
1.99 + inline void CancelEvent();
1.100 + inline void PurgePointerEvents();
1.101 +
1.102 + inline void RedrawEventReady(const RMessagePtr2& aEventMsg);
1.103 + inline void CancelRedrawEvent();
1.104 + inline void GetRedrawData();
1.105 +
1.106 + inline void PriorityKeyEventReady(const RMessagePtr2& aEventMsg);
1.107 + inline void CancelPriorityKeyEvent();
1.108 + inline void GetPriorityKeyData();
1.109 + inline void PriorityKeyPressed(TInt aHandle, const TKeyData &aKey, TInt aScanCode);
1.110 +
1.111 + void TriggerRedraw();
1.112 + void SessionPanic(TClientPanic aReason) const;
1.113 + void SessionTerminate();
1.114 + void UpdateWindowOrdinalPrioritys();
1.115 + void CreateNewWindowGroupL(const TWsClCmdCreateWindowGroup &aCmd);
1.116 + void CreateNewWindowL(const TWsClCmdCreateWindow &aCmd);
1.117 + void CreateNewAnimDllL(const TWsClCmdUnion &aParams);
1.118 +//
1.119 + void CreateNewSpriteL(const TWsClCmdCreateSprite &aCmd);
1.120 + void CreateNewPointerCursorL(const TWsClCmdCreatePointerCursor &aCmd);
1.121 + void StartSetCustomTextCursorL(const TWsClCmdCustomTextCursorData& aCmd);
1.122 + void CompleteSetCustomTextCursorL(TInt aErr);
1.123 + static CWsCustomTextCursor* FindCustomTextCursor(TInt aIdentifier);
1.124 +
1.125 + void CreateNewScreenDeviceL( TInt aDefaultScreenNumber, TUint aClientScreenDevicePointer);
1.126 + void CreateNewBitmapL(const TWsClCmdCreateBitmap &aCmd);
1.127 + void CreateNewClickL(const TUid& aUid);
1.128 +//
1.129 + void ReplyGroupName(HBufC *aName, TInt aMaxLength) const;
1.130 + inline TInt ObjectHandle(const CWsObject *aThis);
1.131 + void SetSystemPointerCursorL(TInt aIndex, CWsPointerCursor *aCursor);
1.132 + void ClearSystemPointerCursor(TInt aIndex);
1.133 + void ClaimSystemPointerCursorListL();
1.134 + void FreeSystemPointerCursorList();
1.135 + static CWsPointerCursor *SystemPointerCursor(TInt aIndex);
1.136 + static inline CWsPointerCursor *DefaultSystemPointerCursor();
1.137 + void SetDefaultSystemPointerCursor(TInt aIndex);
1.138 + void SetComputeMode(RWsSession::TComputeMode aComputeMode);
1.139 + void SetClientPriority();
1.140 + inline TInt ConnectionHandle() const;
1.141 + inline DWsScreenDevice *PrimaryScreenDevice() const;
1.142 + inline void NotifyScreenDeviceDeleted(DWsScreenDevice* aDeletedScreenDevice);
1.143 + inline CScreen* Screen() const;
1.144 + inline TBool NotClosing() const;
1.145 + inline const RMessage2& ClientMessage() const;
1.146 + void RemoteRead(TDes16& aDes, TInt aOffset);
1.147 + void RemoteRead(TDes8& aDes, TInt aOffset);
1.148 + void RemoteReadL(TDes16& aDes, TInt aOffset);
1.149 + void RemoteReadL(TDes8& aDes, TInt aOffset);
1.150 + static void DeleteStatics();
1.151 + void SetResponseHandle(RHandleBase* aHandle);
1.152 +
1.153 + // from MWsClient
1.154 + TBool HasCapability(TCapability aCapability) const;
1.155 + TSecureId SecureId() const;
1.156 + TVendorId VendorId() const;
1.157 + TInt SendMessage(const CWsGraphicDrawer* aOnBehalfOf,const TDesC8& aData);
1.158 + TInt SendMessage(const CWsGraphicDrawer* aOnBehalfOf,CWsMessageData& aData);
1.159 +
1.160 + CWsGraphicDrawerObject* DrawerObject(const CWsGraphicDrawer* aDrawer);
1.161 + const CWsGraphicDrawerObject* DrawerObject(const CWsGraphicDrawer* aDrawer) const;
1.162 + static inline CWsClient* CurrentClient();
1.163 + static inline TBool CheckBuffer(TInt aLength, TInt aMaxLength);
1.164 + static TBool DebugEnforceRedrawCallingConvention();
1.165 +private: // from CSession2
1.166 + void ServiceL(const RMessage2 &aMessage);
1.167 + void ServiceError(const RMessage2& aMessage,TInt aError);
1.168 +private:
1.169 + void CompleteInitializationL();
1.170 + static void DeleteSystemPointerListEntry(TInt aIndex);
1.171 + static TBool FindCursorArrayItem (CArrayFixFlat<TWsCursorArrayItem>* aCursorArray,
1.172 + TInt aIndex, TInt& aPosition);
1.173 + static inline CWsPointerCursor*& PointerCursor (TInt aPosition);
1.174 + static inline CWsCustomTextCursor*& TextCursor (TInt aPosition);
1.175 + void CommandL(TInt aOpcode, const RMessage2& aMessage);
1.176 + void DoServiceL(const RMessage2& aMessage, TBool& aCompleteRequest);
1.177 + void CompleteMessage(const RMessage2& aMessage,TInt aReason);
1.178 + void InitialiseScreenDevices();
1.179 + inline TBool IsInitialised();
1.180 + void DebugInfoL(TInt aFunction, TInt aParam, TBool aHasReplyBuf) const;
1.181 +public:
1.182 + static TWsCmdHeaderBase iCurrentCommand;
1.183 +private:
1.184 + enum TInternalFlags
1.185 + {
1.186 + EPanicClientAsSoonAsPossible =0x01, //The client should be panicked, but we have no way to panic him now
1.187 + EClientIsClosing =0x02, //The client is closing down, so the screen device may no longer be valid
1.188 + };
1.189 +private: // Private data
1.190 + RThread iClient;
1.191 + TUint iConnectionHandle; // Connection ID, only needed for logging, could bin this
1.192 + CEventQueue *iEventQueue;
1.193 + CRedrawQueue *iRedrawQueue;
1.194 + CPriorityKey *iPriorityKeyEvent;
1.195 + CWsGraphicMessageQueue iGraphicMessageQueue;
1.196 + RWsSession::TComputeMode iComputeMode;
1.197 + CWsObjectIx *iObjectIndex;
1.198 + DWsScreenDevice *iPrimaryScreenDevice;
1.199 + TWsCursorArrayItem iTempCustomTextCursor;
1.200 + CScreen* iScreen; //## This needs updating
1.201 + mutable TInt iPanicReason;
1.202 + mutable TInt iInternalFlags;
1.203 + RMessage2 iClientMessage;
1.204 + RHandleBase* iResponseHandle;
1.205 + TInt iMessageIdSeq;
1.206 + TBool iIsInitialised;
1.207 +#if defined(_DEBUG)
1.208 + TBool iLastCommand;
1.209 +#endif
1.210 + static CWsClient *iCurrentClient; // Client who's buffer is currently being processed
1.211 + static TInt iReply; // Value to reply
1.212 + static TInt iReplyOffset; // Offset into reply to write next block of data
1.213 + static TInt iDefaultSystemPointerCursorIndex; //Negative when there isn't one
1.214 + static CWsPointerCursor *iDefaultSystemPointerCursor;
1.215 + static CArrayFixFlat<TWsCursorArrayItem> *iSystemPointerCursors;
1.216 + static CWsClient *iSystemPointerCursorListOwner;
1.217 + static CArrayFixFlat<TWsCursorArrayItem> *iTextCursorArray;
1.218 + static TBuf8<EClientBufferMaxSize> iCmdBuf;
1.219 + static TUint iConnectionId;
1.220 + static TBool iDebug_EnforceRedrawCallingConvention;
1.221 +#if defined(__WINS__)
1.222 + TBool iRemoveKeyCode;
1.223 +public:
1.224 + inline TBool RemoveKeyCode();
1.225 +#endif
1.226 + };
1.227 +
1.228 +
1.229 +//
1.230 +// inlines //
1.231 +//
1.232 +
1.233 +//
1.234 +inline const RThread& CWsClient::Client() const
1.235 + {return iClient;}
1.236 +inline CWindowServer& CWsClient::WindowServer()
1.237 + {return *reinterpret_cast<CWindowServer*>(const_cast<CServer2*>(Server()));}
1.238 +inline void CWsClient::EventReady(const RMessagePtr2& aEventMsg)
1.239 + {iEventQueue->EventReady(aEventMsg);}
1.240 +inline void CWsClient::GetEventData()
1.241 + {iEventQueue->GetData();}
1.242 +inline void CWsClient::PurgePointerEvents()
1.243 + {iEventQueue->PurgePointerEvents();}
1.244 +inline void CWsClient::CancelEvent()
1.245 + {iEventQueue->CancelRead();}
1.246 +inline void CWsClient::RedrawEventReady(const RMessagePtr2& aEventMsg)
1.247 + {iRedrawQueue->EventReady(aEventMsg);}
1.248 +inline void CWsClient::GetRedrawData()
1.249 + {iRedrawQueue->GetData();}
1.250 +inline void CWsClient::CancelRedrawEvent()
1.251 + {iRedrawQueue->CancelRead();}
1.252 +inline void CWsClient::PriorityKeyEventReady(const RMessagePtr2& aEventMsg)
1.253 + {iPriorityKeyEvent->EventReady(aEventMsg);}
1.254 +inline void CWsClient::CancelPriorityKeyEvent()
1.255 + {iPriorityKeyEvent->CancelRead();}
1.256 +inline void CWsClient::GetPriorityKeyData()
1.257 + {iPriorityKeyEvent->GetData();}
1.258 +inline void CWsClient::PriorityKeyPressed(TInt aHandle, const TKeyData &aKey, TInt aScanCode)
1.259 + {iPriorityKeyEvent->PriorityKey(aHandle,aKey,aScanCode);}
1.260 +inline TInt CWsClient::ObjectHandle(const CWsObject *aThis)
1.261 + {return(iObjectIndex->At(aThis));}
1.262 +#if defined(__WINS__)
1.263 +inline TBool CWsClient::RemoveKeyCode()
1.264 + {return iRemoveKeyCode;}
1.265 +#endif
1.266 +//
1.267 +inline CEventQueue *CWsClient::EventQueue() const
1.268 + {return(iEventQueue);}
1.269 +inline CRedrawQueue *CWsClient::RedrawQueue() const
1.270 + {return(iRedrawQueue);}
1.271 +inline CWsObjectIx *CWsClient::ObjectIndex()
1.272 + {return(iObjectIndex);}
1.273 +inline TInt CWsClient::ConnectionHandle() const
1.274 + {return(iConnectionHandle);}
1.275 +inline DWsScreenDevice *CWsClient::PrimaryScreenDevice() const
1.276 + {return(iPrimaryScreenDevice);}
1.277 +inline void CWsClient::NotifyScreenDeviceDeleted(DWsScreenDevice* aDeletedScreenDevice)
1.278 + {
1.279 + if (iPrimaryScreenDevice == aDeletedScreenDevice)
1.280 + iPrimaryScreenDevice = NULL;
1.281 + }
1.282 +inline CWsPointerCursor*& CWsClient::PointerCursor(TInt aIndex)
1.283 + {return (CWsPointerCursor*&)(*iSystemPointerCursors)[aIndex].iCursor;}
1.284 +inline CWsCustomTextCursor*& CWsClient::TextCursor(TInt aIndex)
1.285 + {return (CWsCustomTextCursor*&)(*iTextCursorArray)[aIndex].iCursor;}
1.286 +inline const RMessage2& CWsClient::ClientMessage() const
1.287 + {return iClientMessage;}
1.288 +inline CScreen* CWsClient::Screen() const
1.289 + {return iScreen;}
1.290 +inline TBool CWsClient::NotClosing() const
1.291 + {return !(iInternalFlags&EClientIsClosing);}
1.292 +inline CWsClient* CWsClient::CurrentClient()
1.293 + {return iCurrentClient;}
1.294 +inline TBool CWsClient::CheckBuffer(TInt aLength, TInt aMaxLength)
1.295 + {return TBool((aLength>=0) && (aLength<=aMaxLength));}
1.296 +inline TBool CWsClient::IsInitialised()
1.297 + {return iIsInitialised;}
1.298 +#endif