1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/graphics/windowing/windowserver/nonnga/graphicdrawer/graphicdrawer.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,352 @@
1.4 +// Copyright (c) 2005-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 +// WSGRAPHIC.CPP
1.18 +// The client-side representation of a WsGraphic artwork
1.19 +//
1.20 +//
1.21 +
1.22 +#include "../SERVER/w32cmd.h"
1.23 +#include "Graphics/WSGRAPHICDRAWER.H"
1.24 +#include <Graphics/WSGRAPHICDRAWERINTERFACE.H>
1.25 +#include <s32mem.h>
1.26 +#include "panics.h"
1.27 +
1.28 +GLDEF_C void Panic(TWsGraphicDrawerPanic aPanic)
1.29 + {
1.30 + _LIT(KCategory,"WsGraphicDrawer");
1.31 + User::Panic(KCategory,aPanic);
1.32 + }
1.33 +
1.34 +//
1.35 +// TWservCrEvent implementation
1.36 +//
1.37 +EXPORT_C TWservCrEvent::TWservCrEvent(TUint32 aType): iType(aType), iInfo(0), iData(NULL), iWindow(NULL)
1.38 + {
1.39 + }
1.40 +
1.41 +EXPORT_C TWservCrEvent::TWservCrEvent(TUint32 aType, TUint32 aInfo): iType(aType), iInfo(aInfo), iData(NULL), iWindow(NULL)
1.42 + {
1.43 + }
1.44 +
1.45 +EXPORT_C TWservCrEvent::TWservCrEvent(TUint32 aType, TUint32 aInfo, TAny* aData): iType(aType), iInfo(aInfo), iData(aData), iWindow(NULL)
1.46 + {
1.47 + }
1.48 +
1.49 +EXPORT_C TWservCrEvent::TWservCrEvent(TUint32 aType, TUint32 aInfo, TAny* aData, MWsWindow* aWindow): iType(aType), iInfo(aInfo), iData(aData), iWindow(aWindow)
1.50 + {
1.51 + }
1.52 +
1.53 +EXPORT_C TUint32 TWservCrEvent::Type() const
1.54 + {
1.55 + return iType;
1.56 + }
1.57 +
1.58 +EXPORT_C TInt TWservCrEvent::SizeMode() const
1.59 + {
1.60 + return iInfo;
1.61 + }
1.62 +
1.63 +EXPORT_C const RRegion* TWservCrEvent::VisibleRegion() const
1.64 + {
1.65 + return reinterpret_cast<RRegion*>(iData);
1.66 + }
1.67 +
1.68 +EXPORT_C TInt TWservCrEvent::ScreenNumber() const
1.69 + {
1.70 + return iInfo;
1.71 + }
1.72 +
1.73 +EXPORT_C CFbsBitGc::TGraphicsOrientation TWservCrEvent::Orientation() const
1.74 + {
1.75 + return *reinterpret_cast<CFbsBitGc::TGraphicsOrientation*>(iData);
1.76 + }
1.77 +
1.78 +EXPORT_C const TRegion* TWservCrEvent::DrawingRegion() const
1.79 + {
1.80 + return reinterpret_cast<TRegion*>(iData);
1.81 + }
1.82 +
1.83 +EXPORT_C TInt TWservCrEvent::WindowGroupIdentifier() const
1.84 + {
1.85 + return reinterpret_cast<TInt>(iData);
1.86 + }
1.87 +
1.88 +//This is NGA-specific, but does not rely on any NGA-compiled code
1.89 +EXPORT_C const TSurfaceId* TWservCrEvent::SurfaceId() const
1.90 + {
1.91 + return reinterpret_cast<const TSurfaceId*>(iData);
1.92 + }
1.93 +
1.94 +EXPORT_C TBool TWservCrEvent::WasVisible() const
1.95 + {
1.96 + return iInfo;
1.97 + }
1.98 +
1.99 +EXPORT_C MWsWindow * TWservCrEvent::Window() const
1.100 + {
1.101 + return iWindow;
1.102 + }
1.103 +
1.104 +// CWsGraphicDrawer::CPimpl \\\\\\\\\\\\\\\\\\\\\\\\
1.105 +
1.106 +NONSHARABLE_STRUCT(CWsGraphicDrawer::CPimpl): public CBase
1.107 +/** @internalComponent
1.108 + @released
1.109 +*/ {
1.110 + enum
1.111 + {
1.112 + EActive = 0x01,
1.113 + EIsPublic = 0x02,
1.114 + EInContains = 0x04,
1.115 + EInDraw = 0x08,
1.116 + EDrawn = 0x10,
1.117 + };
1.118 + CPimpl(CWsGraphicDrawer& aGraphic,MWsGraphicDrawerEnvironment& aEnv,MWsClient& aOwner);
1.119 + ~CPimpl();
1.120 + CWsGraphicDrawer& iGraphic;
1.121 + MWsGraphicDrawerEnvironment& iEnv;
1.122 + MWsClient& iOwner;
1.123 + TGraphicDrawerId iId;
1.124 + RArray<TUint> iSharedWith;
1.125 + TUint iFlags;
1.126 + MWsEventHandler* iEventHandler;
1.127 + };
1.128 +
1.129 +CWsGraphicDrawer::CPimpl::CPimpl(CWsGraphicDrawer& aGraphic,MWsGraphicDrawerEnvironment& aEnv,MWsClient& aOwner):
1.130 + iGraphic(aGraphic), iEnv(aEnv), iOwner(aOwner)
1.131 + {
1.132 + }
1.133 +
1.134 +CWsGraphicDrawer::CPimpl::~CPimpl()
1.135 + {
1.136 + iSharedWith.Close();
1.137 + }
1.138 +
1.139 +// CWsGraphicDrawer \\\\\\\\\\\\\\\\\\\\\\\\
1.140 +
1.141 +EXPORT_C CWsGraphicDrawer::CWsGraphicDrawer()
1.142 +/** Constructor
1.143 +*/ {
1.144 + }
1.145 +
1.146 +EXPORT_C CWsGraphicDrawer::~CWsGraphicDrawer()
1.147 +/** Destructor
1.148 +*/ {
1.149 + delete iPimpl;
1.150 +
1.151 + if(KNullUid != iDtor_ID_Key)
1.152 + {
1.153 + REComSession::DestroyedImplementation(iDtor_ID_Key);
1.154 + }
1.155 + }
1.156 +
1.157 +EXPORT_C void CWsGraphicDrawer::BaseConstructL(MWsGraphicDrawerEnvironment& aEnv,const TGraphicDrawerId& aId,MWsClient& aOwner)
1.158 +/** Completes construction of the baseclass. Derived drawers should call this from their ConstructL() implementations
1.159 + @param aEnv the environment this drawer exists in
1.160 + @param aId the ID of this drawer
1.161 + @param aOwner the client session that owns this drawer
1.162 + @param aData arbitrary data for constructing this instance, sent from the client.
1.163 +*/ {
1.164 + iPimpl = new(ELeave) CPimpl(*this,aEnv,aOwner);
1.165 + iPimpl->iId = aId;
1.166 + }
1.167 +
1.168 +EXPORT_C MWsGraphicDrawerEnvironment& CWsGraphicDrawer::Env()
1.169 +/** The environment this drawer exists in
1.170 + @return the environment
1.171 +*/ {
1.172 + return iPimpl->iEnv;
1.173 + }
1.174 +
1.175 +EXPORT_C const MWsGraphicDrawerEnvironment& CWsGraphicDrawer::Env() const
1.176 +/** The environment this drawer exists in
1.177 + @return the environment
1.178 +*/ {
1.179 + return iPimpl->iEnv;
1.180 + }
1.181 +
1.182 +EXPORT_C const TGraphicDrawerId& CWsGraphicDrawer::Id() const
1.183 +/** The ID of this graphic
1.184 + @return the ID
1.185 +*/ {
1.186 + return iPimpl->iId;
1.187 + }
1.188 +
1.189 +EXPORT_C const MWsClient& CWsGraphicDrawer::Owner() const
1.190 +/** Only the owner can delete, replace or send messages to this graphic.
1.191 + The owner and any session sharing the owner's Secure ID can always
1.192 + draw the graphic.
1.193 + @return the Client session which created and owns this graphic.
1.194 +*/ {
1.195 + return iPimpl->iOwner;
1.196 + }
1.197 +
1.198 +EXPORT_C TBool CWsGraphicDrawer::IsSharedWith(TSecureId aClientId) const
1.199 +/** tests whether the client is allowed to draw this graphic
1.200 + Conditions include whether the client is the owner of this graphic,
1.201 + whether the graphic is shared globally, or whether this graphic
1.202 + has been explicitly shared with the client
1.203 + @param aClientId the Secure ID of the client session's process
1.204 + @return ETrue if the client can draw this graphic
1.205 +*/ {
1.206 + return ((iPimpl->iFlags & CPimpl::EIsPublic) ||
1.207 + (0 <= iPimpl->iSharedWith.FindInOrder(aClientId.iId)) ||
1.208 + (aClientId == iPimpl->iOwner.SecureId()));
1.209 + }
1.210 +
1.211 +EXPORT_C TInt CWsGraphicDrawer::Share(TSecureId aClientId)
1.212 +/** Explicitly shares this graphic with client sessions with the specified Secure ID
1.213 + @param aClientId the Secure ID of the client sessions to share with
1.214 + @return KErrNone if the graphic was shared, else one of the system-wide error codes
1.215 +*/ {
1.216 + return iPimpl->iSharedWith.InsertInOrder(aClientId.iId);
1.217 + }
1.218 +
1.219 +EXPORT_C TInt CWsGraphicDrawer::ShareGlobally()
1.220 +/** Share this drawer with all client sessions
1.221 + Sharing globally trumps explicit shares
1.222 + @return KErrNone if the graphic is globally shared, else one of the system-wide error codes
1.223 +*/ {
1.224 + iPimpl->iFlags |= CPimpl::EIsPublic;
1.225 + return KErrNone;
1.226 + }
1.227 +
1.228 +EXPORT_C TInt CWsGraphicDrawer::UnShareGlobally()
1.229 +/** Stop this drawer from being shared with all client sessions
1.230 + A drawer that isn't shared explicitly is only available to clients it
1.231 + has been explicitly shared with using Share()
1.232 + @return KErrNone if the graphic is not globally shared, else one of the system-wide error codes
1.233 +*/ {
1.234 + iPimpl->iFlags &= ~CPimpl::EIsPublic;
1.235 + return KErrNone;
1.236 + }
1.237 +
1.238 +EXPORT_C TInt CWsGraphicDrawer::UnShare(TSecureId aClientId)
1.239 +/** Stop this drawer from being shared with all client sessions with the specific Secure ID
1.240 + ShareGlobally() trumps explicit sharing
1.241 + @param aClientId the Secure ID of the client sessions to not share with
1.242 + @return KErrNone if the graphic is no longer shared, KErrNotFound if the graphic was not shared anyway, else one of the system-wide error codes
1.243 +*/ {
1.244 + const TInt idx = iPimpl->iSharedWith.FindInOrder(aClientId.iId);
1.245 + if(0 <= idx)
1.246 + {
1.247 + iPimpl->iSharedWith.Remove(idx);
1.248 + return KErrNone;
1.249 + }
1.250 + else
1.251 + {
1.252 + return idx;
1.253 + }
1.254 + }
1.255 +
1.256 +EXPORT_C void CWsGraphicDrawer::Draw(MWsGc& aGc,const TRect& aRect,const TDesC8& aData) const
1.257 + {
1.258 + // avoid infinite recursion
1.259 + if(iPimpl->iFlags & CPimpl::EInDraw)
1.260 + {
1.261 + return;
1.262 + }
1.263 + // draw
1.264 + iPimpl->iFlags |= (CPimpl::EInDraw | CPimpl::EDrawn);
1.265 + DoDraw(aGc,aRect,aData); // implemented by derived classes
1.266 + iPimpl->iFlags &= ~CPimpl::EInDraw;
1.267 + }
1.268 +
1.269 +
1.270 +EXPORT_C TInt CWsGraphicDrawer::SendMessage(const TDesC8& aData)
1.271 +/** Sends this message to the client-side peer
1.272 + @param aData the data to send
1.273 + @return KErrNone if successful, else one of the System-wide error codes
1.274 +*/ {
1.275 + return iPimpl->iOwner.SendMessage(this,aData);
1.276 + }
1.277 +
1.278 +EXPORT_C TInt CWsGraphicDrawer::SendMessage(CWsMessageData& aData)
1.279 +/** Sends this message to the client-side peer
1.280 + @param aData the data to send
1.281 + @return KErrNone if successful, else one of the System-wide error codes
1.282 +*/ {
1.283 + return iPimpl->iOwner.SendMessage(this,aData);
1.284 + }
1.285 +
1.286 +EXPORT_C void CWsGraphicDrawer::Invalidate()
1.287 + /** Schedules all potentially affected parts of the screen to repaint
1.288 + Called by derived classes when their presentation changes (e.g. they
1.289 + receive new artwork via a SendMessage())
1.290 + Note: this is not a suitable method for animating a graphic. For animation,
1.291 + use MWsGc::Invalidate when the graphic is being drawn to schedule the next
1.292 + animation frame instead.
1.293 +*/ {
1.294 + if(iPimpl && (iPimpl->iFlags & CPimpl::EDrawn))
1.295 + {
1.296 + iPimpl->iEnv.Invalidate(iPimpl->iId);
1.297 + iPimpl->iFlags &= ~CPimpl::EDrawn;
1.298 + }
1.299 + }
1.300 +
1.301 +EXPORT_C TBool CWsGraphicDrawer::Contains(const TArray<TGraphicDrawerId>& aIds) const
1.302 +/** Tests whether this drawer is, or itself draws, any of the graphic drawers identified by the IDs.
1.303 + Calls HasAsChild() on itself to determine if this graphic does itself contain
1.304 + any of the IDs. Derived classes which themselves draw other graphic drawers should
1.305 + override HasAsChild().
1.306 + @param aIds the (sorted in TGraphicDrawerId::Compare order) list of IDs
1.307 + @return ETrue if this graphic is, or contains, any of the graphic drawers listed
1.308 +*/ {
1.309 + // avoid infinite recursion
1.310 + if(iPimpl->iFlags & CPimpl::EInContains)
1.311 + {
1.312 + return EFalse;
1.313 + }
1.314 + // is it us?
1.315 + const TInt count = aIds.Count();
1.316 + for(TInt i=0; i<count; i++)
1.317 + {
1.318 + if(0 == aIds[i].Compare(iPimpl->iId))
1.319 + {
1.320 + return ETrue;
1.321 + }
1.322 + }
1.323 + // is it a child of us?
1.324 + iPimpl->iFlags |= CPimpl::EInContains;
1.325 + const TBool ret = HasAsChild(aIds);
1.326 + iPimpl->iFlags &= ~CPimpl::EInContains;
1.327 + return ret;
1.328 + }
1.329 +
1.330 +EXPORT_C TBool CWsGraphicDrawer::HasAsChild(const TArray<TGraphicDrawerId>& /*aIds*/) const
1.331 +/** Called by Contains() to determine if the graphic identified by Id is contained within the
1.332 + other graphic drawers that this graphic drawer itself draws.
1.333 + Derived classes which draw other drawers should override this method and call
1.334 + Contains() on all graphics which they draw.
1.335 + @param aIds a (sorted in TGraphicDrawerId::Compare order) list of the drawer IDs to see if this drawer draws
1.336 + @return ETrue if this drawer draws any of those graphics
1.337 +*/ {
1.338 + return EFalse;
1.339 + }
1.340 +
1.341 +EXPORT_C void CWsGraphicDrawer::HandleEvent(const TWservCrEvent& aEvent)
1.342 + {
1.343 + if (iPimpl->iEventHandler)
1.344 + iPimpl->iEventHandler->DoHandleEvent(aEvent);
1.345 + }
1.346 +
1.347 +EXPORT_C void CWsGraphicDrawer::SetEventHandler(MWsEventHandler* aHandler)
1.348 + {
1.349 + iPimpl->iEventHandler = aHandler;
1.350 + }
1.351 +
1.352 +EXPORT_C TBool CWsGraphicDrawer::HasEventHandler() const
1.353 + {
1.354 + return iPimpl->iEventHandler!=NULL;
1.355 + }