sl@0: // Copyright (c) 2005-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: // WSGRAPHIC.CPP
sl@0: // The client-side representation of a WsGraphic artwork
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include "../SERVER/w32cmd.h"
sl@0: #include "Graphics/WSGRAPHICDRAWER.H"
sl@0: #include <Graphics/WSGRAPHICDRAWERINTERFACE.H>
sl@0: #include <s32mem.h>
sl@0: #include "panics.h"
sl@0: 
sl@0: GLDEF_C void Panic(TWsGraphicDrawerPanic aPanic)
sl@0: 	{
sl@0: 	_LIT(KCategory,"WsGraphicDrawer");
sl@0: 	User::Panic(KCategory,aPanic);
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // TWservCrEvent implementation
sl@0: //
sl@0: EXPORT_C TWservCrEvent::TWservCrEvent(TUint32 aType): iType(aType), iInfo(0), iData(NULL), iWindow(NULL)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TWservCrEvent::TWservCrEvent(TUint32 aType, TUint32 aInfo): iType(aType), iInfo(aInfo), iData(NULL), iWindow(NULL)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TWservCrEvent::TWservCrEvent(TUint32 aType, TUint32 aInfo, TAny* aData): iType(aType), iInfo(aInfo), iData(aData), iWindow(NULL)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TWservCrEvent::TWservCrEvent(TUint32 aType, TUint32 aInfo, TAny* aData, MWsWindow* aWindow): iType(aType), iInfo(aInfo), iData(aData), iWindow(aWindow)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TUint32 TWservCrEvent::Type() const
sl@0: 	{
sl@0: 	return iType;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt TWservCrEvent::SizeMode() const
sl@0: 	{
sl@0: 	return iInfo;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C const RRegion* TWservCrEvent::VisibleRegion() const
sl@0: 	{
sl@0: 	return reinterpret_cast<RRegion*>(iData);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt TWservCrEvent::ScreenNumber() const
sl@0: 	{
sl@0: 	return iInfo;	
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CFbsBitGc::TGraphicsOrientation TWservCrEvent::Orientation() const
sl@0: 	{
sl@0: 	return *reinterpret_cast<CFbsBitGc::TGraphicsOrientation*>(iData);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C const TRegion* TWservCrEvent::DrawingRegion() const
sl@0: 	{
sl@0: 	return reinterpret_cast<TRegion*>(iData);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt TWservCrEvent::WindowGroupIdentifier() const
sl@0: 	{
sl@0: 	return reinterpret_cast<TInt>(iData);
sl@0: 	}
sl@0: 
sl@0: //This is NGA-specific, but does not rely on any NGA-compiled code
sl@0: EXPORT_C const TSurfaceId* TWservCrEvent::SurfaceId() const
sl@0: 	{
sl@0: 	return reinterpret_cast<const TSurfaceId*>(iData);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool TWservCrEvent::WasVisible() const
sl@0: 	{
sl@0: 	return iInfo;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C MWsWindow * TWservCrEvent::Window() const
sl@0: 	{
sl@0: 	return iWindow;
sl@0: 	}
sl@0: 
sl@0: // CWsGraphicDrawer::CPimpl \\\\\\\\\\\\\\\\\\\\\\\\
sl@0: 
sl@0: NONSHARABLE_STRUCT(CWsGraphicDrawer::CPimpl): public CBase
sl@0: /** @internalComponent
sl@0: 	@released
sl@0: */	{
sl@0: 	enum
sl@0: 		{
sl@0: 		EActive			= 0x01,
sl@0: 		EIsPublic		= 0x02,
sl@0: 		EInContains		= 0x04,
sl@0: 		EInDraw			= 0x08,
sl@0: 		EDrawn			= 0x10,
sl@0: 		};
sl@0: 	CPimpl(CWsGraphicDrawer& aGraphic,MWsGraphicDrawerEnvironment& aEnv,MWsClient& aOwner);
sl@0: 	~CPimpl();
sl@0: 	CWsGraphicDrawer& iGraphic;
sl@0: 	MWsGraphicDrawerEnvironment& iEnv;
sl@0: 	MWsClient& iOwner;
sl@0: 	TGraphicDrawerId iId;
sl@0: 	RArray<TUint> iSharedWith;
sl@0: 	TUint iFlags;
sl@0: 	MWsEventHandler* iEventHandler;
sl@0: 	};
sl@0: 
sl@0: CWsGraphicDrawer::CPimpl::CPimpl(CWsGraphicDrawer& aGraphic,MWsGraphicDrawerEnvironment& aEnv,MWsClient& aOwner):
sl@0: 	iGraphic(aGraphic), iEnv(aEnv), iOwner(aOwner)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: CWsGraphicDrawer::CPimpl::~CPimpl()
sl@0: 	{
sl@0: 	iSharedWith.Close();
sl@0: 	}
sl@0: 
sl@0: // CWsGraphicDrawer \\\\\\\\\\\\\\\\\\\\\\\\
sl@0: 
sl@0: EXPORT_C CWsGraphicDrawer::CWsGraphicDrawer()
sl@0: /** Constructor
sl@0: */	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CWsGraphicDrawer::~CWsGraphicDrawer()
sl@0: /** Destructor
sl@0: */	{
sl@0: 	delete iPimpl;
sl@0: 
sl@0: 	if(KNullUid != iDtor_ID_Key)
sl@0: 		{
sl@0: 		REComSession::DestroyedImplementation(iDtor_ID_Key);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CWsGraphicDrawer::BaseConstructL(MWsGraphicDrawerEnvironment& aEnv,const TGraphicDrawerId& aId,MWsClient& aOwner)
sl@0: /** Completes construction of the baseclass. Derived drawers should call this from their ConstructL() implementations
sl@0: 	@param aEnv the environment this drawer exists in
sl@0: 	@param aId the ID of this drawer
sl@0: 	@param aOwner the client session that owns this drawer
sl@0: 	@param aData arbitrary data for constructing this instance, sent from the client.
sl@0: */	{
sl@0: 	iPimpl = new(ELeave) CPimpl(*this,aEnv,aOwner);
sl@0: 	iPimpl->iId = aId;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C MWsGraphicDrawerEnvironment& CWsGraphicDrawer::Env()
sl@0: /** The environment this drawer exists in
sl@0: 	@return the environment
sl@0: */	{
sl@0: 	return iPimpl->iEnv;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C const MWsGraphicDrawerEnvironment& CWsGraphicDrawer::Env() const
sl@0: /** The environment this drawer exists in
sl@0: 	@return the environment
sl@0: */	{
sl@0: 	return iPimpl->iEnv;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C const TGraphicDrawerId& CWsGraphicDrawer::Id() const
sl@0: /** The ID of this graphic
sl@0: 	@return the ID
sl@0: */	{
sl@0: 	return iPimpl->iId;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C const MWsClient& CWsGraphicDrawer::Owner() const
sl@0: /** Only the owner can delete, replace or send messages to this graphic.
sl@0: 	The owner and any session sharing the owner's Secure ID can always
sl@0: 	draw the graphic.
sl@0: 	@return the Client session which created and owns this graphic.
sl@0: */	{
sl@0: 	return iPimpl->iOwner;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool CWsGraphicDrawer::IsSharedWith(TSecureId aClientId) const
sl@0: /** tests whether the client is allowed to draw this graphic
sl@0: 	Conditions include whether the client is the owner of this graphic,
sl@0: 	whether the graphic is shared globally, or whether this graphic
sl@0: 	has been explicitly shared with the client
sl@0: 	@param aClientId the Secure ID of the client session's process
sl@0: 	@return ETrue if the client can draw this graphic
sl@0: */	{
sl@0: 	return ((iPimpl->iFlags & CPimpl::EIsPublic) ||
sl@0: 		(0 <= iPimpl->iSharedWith.FindInOrder(aClientId.iId)) ||
sl@0: 		(aClientId == iPimpl->iOwner.SecureId()));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CWsGraphicDrawer::Share(TSecureId aClientId)
sl@0: /** Explicitly shares this graphic with client sessions with the specified Secure ID
sl@0: 	@param aClientId the Secure ID of the client sessions to share with
sl@0: 	@return KErrNone if the graphic was shared, else one of the system-wide error codes
sl@0: */	{
sl@0: 	return iPimpl->iSharedWith.InsertInOrder(aClientId.iId);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CWsGraphicDrawer::ShareGlobally()
sl@0: /** Share this drawer with all client sessions
sl@0: 	Sharing globally trumps explicit shares
sl@0: 	@return KErrNone if the graphic is globally shared, else one of the system-wide error codes
sl@0: */	{
sl@0: 	iPimpl->iFlags |= CPimpl::EIsPublic;
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CWsGraphicDrawer::UnShareGlobally()
sl@0: /** Stop this drawer from being shared with all client sessions
sl@0: 	A drawer that isn't shared explicitly is only available to clients it
sl@0: 	has been explicitly shared with using Share()
sl@0: 	@return KErrNone if the graphic is not globally shared, else one of the system-wide error codes
sl@0: */	{
sl@0: 	iPimpl->iFlags &= ~CPimpl::EIsPublic;
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CWsGraphicDrawer::UnShare(TSecureId aClientId)
sl@0: /** Stop this drawer from being shared with all client sessions with the specific Secure ID
sl@0: 	ShareGlobally() trumps explicit sharing
sl@0: 	@param aClientId the Secure ID of the client sessions to not share with
sl@0: 	@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
sl@0: */	{
sl@0: 	const TInt idx = iPimpl->iSharedWith.FindInOrder(aClientId.iId);
sl@0: 	if(0 <= idx)
sl@0: 		{
sl@0: 		iPimpl->iSharedWith.Remove(idx);
sl@0: 		return KErrNone;
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		return idx;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CWsGraphicDrawer::Draw(MWsGc& aGc,const TRect& aRect,const TDesC8& aData) const
sl@0: 	{
sl@0: 	// avoid infinite recursion
sl@0: 	if(iPimpl->iFlags & CPimpl::EInDraw)
sl@0: 		{
sl@0: 		return;
sl@0: 		}
sl@0: 	// draw
sl@0: 	iPimpl->iFlags |= (CPimpl::EInDraw | CPimpl::EDrawn);
sl@0: 	DoDraw(aGc,aRect,aData); // implemented by derived classes
sl@0: 	iPimpl->iFlags &= ~CPimpl::EInDraw;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C TInt CWsGraphicDrawer::SendMessage(const TDesC8& aData)
sl@0: /** Sends this message to the client-side peer
sl@0: 	@param aData the data to send
sl@0: 	@return KErrNone if successful, else one of the System-wide error codes
sl@0: */	{
sl@0: 	return iPimpl->iOwner.SendMessage(this,aData);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CWsGraphicDrawer::SendMessage(CWsMessageData& aData)
sl@0: /** Sends this message to the client-side peer
sl@0: 	@param aData the data to send
sl@0: 	@return KErrNone if successful, else one of the System-wide error codes
sl@0: */	{
sl@0: 	return iPimpl->iOwner.SendMessage(this,aData);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CWsGraphicDrawer::Invalidate()
sl@0: 	/** Schedules all potentially affected parts of the screen to repaint
sl@0: 	Called by derived classes when their presentation changes (e.g. they
sl@0: 	receive new artwork via a SendMessage())
sl@0: 	Note: this is not a suitable method for animating a graphic.  For animation,
sl@0: 	use MWsGc::Invalidate when the graphic is being drawn to schedule the next
sl@0: 	animation frame instead.
sl@0: */	{
sl@0: 	if(iPimpl && (iPimpl->iFlags & CPimpl::EDrawn))
sl@0: 		{
sl@0: 		iPimpl->iEnv.Invalidate(iPimpl->iId);
sl@0: 		iPimpl->iFlags &= ~CPimpl::EDrawn;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool CWsGraphicDrawer::Contains(const TArray<TGraphicDrawerId>& aIds) const
sl@0: /** Tests whether this drawer is, or itself draws, any of the graphic drawers identified by the IDs.
sl@0: 	Calls HasAsChild() on itself to determine if this graphic does itself contain
sl@0: 	any of the IDs.  Derived classes which themselves draw other graphic drawers should
sl@0: 	override HasAsChild().
sl@0: 	@param aIds the (sorted in TGraphicDrawerId::Compare order) list of IDs
sl@0: 	@return ETrue if this graphic is, or contains, any of the graphic drawers listed
sl@0: */	{
sl@0: 	// avoid infinite recursion
sl@0: 	if(iPimpl->iFlags & CPimpl::EInContains)
sl@0: 		{
sl@0: 		return EFalse;
sl@0: 		}
sl@0: 	// is it us?
sl@0: 	const TInt count = aIds.Count();
sl@0: 	for(TInt i=0; i<count; i++)
sl@0: 		{
sl@0: 		if(0 == aIds[i].Compare(iPimpl->iId))
sl@0: 			{
sl@0: 			return ETrue;
sl@0: 			}
sl@0: 		}
sl@0: 	// is it a child of us?
sl@0: 	iPimpl->iFlags |= CPimpl::EInContains;
sl@0: 	const TBool ret = HasAsChild(aIds);
sl@0: 	iPimpl->iFlags &= ~CPimpl::EInContains;
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool CWsGraphicDrawer::HasAsChild(const TArray<TGraphicDrawerId>& /*aIds*/) const
sl@0: /** Called by Contains() to determine if the graphic identified by Id is contained within the
sl@0: 	other graphic drawers that this graphic drawer itself draws.
sl@0: 	Derived classes which draw other drawers should override this method and call
sl@0: 	Contains() on all graphics which they draw.
sl@0: 	@param aIds a (sorted in TGraphicDrawerId::Compare order) list of the drawer IDs to see if this drawer draws
sl@0: 	@return ETrue if this drawer draws any of those graphics
sl@0: */	{
sl@0: 	return EFalse;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CWsGraphicDrawer::HandleEvent(const TWservCrEvent& aEvent)
sl@0: 	{
sl@0: 	if (iPimpl->iEventHandler)
sl@0: 		iPimpl->iEventHandler->DoHandleEvent(aEvent);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CWsGraphicDrawer::SetEventHandler(MWsEventHandler* aHandler)
sl@0: 	{
sl@0: 	iPimpl->iEventHandler = aHandler;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool CWsGraphicDrawer::HasEventHandler() const
sl@0: 	{
sl@0: 	return iPimpl->iEventHandler!=NULL;
sl@0: 	}