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: // The client-side representation of a WsGraphic artwork
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include <w32std.h>
sl@0: #include "../SERVER/w32cmd.h"
sl@0: #include "w32comm.h"
sl@0: #include "CLIENT.H"
sl@0: #include <s32mem.h>
sl@0: #include <graphics/wsgraphicdrawerinterface.h>
sl@0: /** Panics the client. This will result in the client thread being destroyed. */
sl@0: GLREF_C void Panic(TW32Panic aPanic);
sl@0: 
sl@0: NONSHARABLE_STRUCT(CWsGraphic::CPimpl): public CBase, public MWsClientClass
sl@0: /** @internalComponent @released */
sl@0: 	{
sl@0: 	friend class CWsGraphic;
sl@0: 	enum
sl@0: 		{
sl@0: 		/** is registered in the graphic manager's array */
sl@0: 		ERegistered = 0x01,
sl@0: 		/** has a peer CWsGraphicDrawer on the server */
sl@0: 		EHasPeer	= 0x02
sl@0: 		};
sl@0: 	CPimpl(CWsGraphic& aGraphic);
sl@0: 	~CPimpl();
sl@0: 	void ConstructL();		//LeaveScan: Member of macroised structure declaration.
sl@0: 	CManager* iManager;
sl@0: 	TInt WriteCreateGraphic(TWsClCmdCreateGraphic& aCreateGraphic,const TDesC8& aData,TInt aWsHandle) const;
sl@0: 	CWsGraphic& iGraphic;
sl@0: 	TWsGraphicId iId;
sl@0: 	TUint iFlags;
sl@0: 	MWsObjectProvider* iExt;
sl@0: 	};
sl@0: 
sl@0: LOCAL_C void MWsGraphicMessageAllocRelease(TAny* aAny)
sl@0: 	{
sl@0: 	MWsGraphicMessageAlloc::MBuffer* buf = static_cast<MWsGraphicMessageAlloc::MBuffer*>(aAny);
sl@0: 	if(buf)
sl@0: 		{
sl@0: 		buf->Release();
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: NONSHARABLE_CLASS(CWsGraphic::CManager): private CActive, public RWsSession
sl@0: /** Client-side manager singleton for marshalling messages for all CWsGraphics owned by a client
sl@0: 
sl@0: @publishedAll
sl@0: @released
sl@0: */	{
sl@0: public:
sl@0: 	static CManager* StaticL();			  //LeaveScan:  Member of macroised structure declaration.
sl@0: 	// used by CWsGraphic
sl@0: 	void AddL(CWsGraphic* aGraphic);	  //LeaveScan:  Member of macroised structure declaration.
sl@0: 	void Replace(CWsGraphic* aGraphic);
sl@0: 	void Remove(CWsGraphic* aGraphic);
sl@0: 	CWsGraphic* Find(const TWsGraphicId& aId);
sl@0: 	void Inc();
sl@0: 	void Dec();
sl@0: 	RWsBuffer* Buffer();
sl@0: 	void ScheduleFlush();
sl@0: private:
sl@0: 	CManager();
sl@0: 	~CManager();
sl@0: 	void ConstructL();					 //LeaveScan:  Member of macroised structure declaration.
sl@0: 	void Queue();
sl@0: 	void RunL();						 //LeaveScan:  Member of macroised structure declaration.
sl@0: 	void DoCancel();
sl@0: 	static TInt GraphicCompare(const CWsGraphic& aFirst,const CWsGraphic& aSecond);
sl@0: 	static TInt FlushOnIdle(TAny* aArg);
sl@0: private:
sl@0: 	TInt iRefCount;
sl@0: 	RPointerArray<CWsGraphic> iArray;
sl@0: 	CIdle* iFlusher;
sl@0: 	TBool iFlushScheduled;
sl@0: 	};
sl@0: 
sl@0: // TWsGraphicId \\\\\\\\\\\\\\\\\\\\\\\\
sl@0: 
sl@0: EXPORT_C TWsGraphicId::TWsGraphicId(TUid aUid):
sl@0: /** Construct a UID
sl@0:     @param aUid UID of the graphic artwork.
sl@0:     @publishedAll @released
sl@0: */	iFlags(EWsGraphicIdUid), iId(aUid.iUid)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TWsGraphicId::TWsGraphicId(TInt aId):
sl@0: /** Construct a transient Id
sl@0: 	@publishedAll @released
sl@0: */	iFlags(EWsGraphicIdTransient), iId(aId)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /** 
sl@0: Copy constructor.
sl@0: @param aCopy Graphic artwork Id.
sl@0: */
sl@0: EXPORT_C TWsGraphicId::TWsGraphicId(const TWsGraphicId& aCopy):
sl@0: 	iFlags(aCopy.iFlags), iId(aCopy.iId)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TUid TWsGraphicId::Uid() const
sl@0: /** Returns UID.
sl@0:     @return UID of graphic artwork. KNullUid if graphic artwork is transient.
sl@0:     @publishedAll @released
sl@0: */	{
sl@0: 	if(IsUid())
sl@0: 		{
sl@0: 		return TUid::Uid(iId);
sl@0: 		}
sl@0: 	return KNullUid;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool TWsGraphicId::IsUid() const
sl@0: /** Identifies whether graphic artwork is non-transient.
sl@0:     @return ETrue if graphic artwork is non-transient.
sl@0:     @publishedAll @released
sl@0: */	{
sl@0: 	return (iFlags & EWsGraphicIdUid);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void TWsGraphicId::Set(TUid aUid)
sl@0: /** Set to be a UID
sl@0: 	@publishedAll @released
sl@0: */	{
sl@0: 	iId = aUid.iUid;
sl@0: 	iFlags = EWsGraphicIdUid;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt TWsGraphicId::Id() const
sl@0: /** Returns the transient Id.
sl@0:     @return Id of transient graphic artwork. Zero if graphic artwork is non-transient.
sl@0: 	@publishedAll @released
sl@0: */	{
sl@0: 	if(IsId())
sl@0: 		{
sl@0: 		return iId;
sl@0: 		}
sl@0: 	return 0;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TBool TWsGraphicId::IsId() const
sl@0: /** Identifies whether graphic artwork is transient.
sl@0:     @return ETrue if graphic artwork is transient.
sl@0:     @publishedAll @released
sl@0: */	{
sl@0: 	return (iFlags & EWsGraphicIdTransient);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void TWsGraphicId::Set(TInt aId)
sl@0: /** Set to be a transient Id
sl@0: 	@publishedAll @released
sl@0: */	{
sl@0: 	iId = aId;
sl@0: 	iFlags = EWsGraphicIdTransient;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt TWsGraphicId::Compare(const TWsGraphicId& aOther) const
sl@0: /** Compares another Id with this one.
sl@0: 	@return 0 if the other Id is identical, else -1 if the other Id is to greater than or 1 if the other Id is less than
sl@0: 	@publishedAll @released
sl@0: */	{
sl@0: 	if(iId < aOther.iId)
sl@0: 		{
sl@0: 		return -1;
sl@0: 		}
sl@0: 	else if(iId > aOther.iId)
sl@0: 		{
sl@0: 		return 1;
sl@0: 		}
sl@0: 	// else we have to compare the iIsUid flag too; again, expect it to be a match 99.99% of these times
sl@0: 	else if(IsUid() == aOther.IsUid())
sl@0: 		{
sl@0: 		return 0;
sl@0: 		}
sl@0: 	// collisions of id but not iIsUid are going to be really really rare
sl@0: 	else if(IsUid())
sl@0: 		{
sl@0: 		return 1;
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		return -1;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: // CWsGraphicManager \\\\\\\\\\\\\\\\\\\\\\\\
sl@0: 
sl@0: CWsGraphic::CManager* CWsGraphic::CManager::StaticL()
sl@0: 	{
sl@0: 	CManager* singleton = RWsBuffer::WsGraphicManager();
sl@0: 	if(!singleton)
sl@0: 		{
sl@0: 		singleton = new(ELeave) CManager;
sl@0: 		CleanupStack::PushL(singleton);
sl@0: 		singleton->ConstructL();
sl@0: 		CleanupStack::Pop(singleton);
sl@0: 		__ASSERT_DEBUG(singleton == RWsBuffer::WsGraphicManager(),Panic(EW32PanicGraphicInternal));
sl@0: 		}
sl@0: 	return singleton;
sl@0: 	}
sl@0: 
sl@0: CWsGraphic::CManager::~CManager()
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(!ResourceCount(),Panic(EW32PanicGraphicInternal));
sl@0: 	__ASSERT_DEBUG(!iArray.Count(),Panic(EW32PanicGraphicOrphaned));
sl@0: 	Close();
sl@0: 	__ASSERT_DEBUG(!RWsBuffer::WsGraphicManager(),Panic(EW32PanicGraphicInternal));
sl@0: 	iArray.Close();
sl@0: 	delete iFlusher;
sl@0: 	}
sl@0: 
sl@0: CWsGraphic::CManager::CManager(): CActive(CActive::EPriorityStandard)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: void CWsGraphic::CManager::ConstructL()
sl@0: 	{
sl@0: 	User::LeaveIfError(Connect());
sl@0: 	iBuffer->SetWsGraphicManager(this);
sl@0: 	CActiveScheduler::Add(this);
sl@0: 	iFlusher = CIdle::NewL(CActive::EPriorityIdle);
sl@0: 	}
sl@0: 
sl@0: void CWsGraphic::CManager::Inc()
sl@0: 	{
sl@0: 	iRefCount++;
sl@0: 	}
sl@0: 
sl@0: void CWsGraphic::CManager::Dec()
sl@0: 	{
sl@0: 	if(!--iRefCount)
sl@0: 		{
sl@0: 		delete this;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: RWsBuffer* CWsGraphic::CManager::Buffer()
sl@0: 	{
sl@0: 	return iBuffer;
sl@0: 	}
sl@0: 
sl@0: // used by CWsGraphic
sl@0: 
sl@0: void CWsGraphic::CManager::AddL(CWsGraphic* aGraphic)
sl@0: /** Leaves if the graphic couldn't be added to the list
sl@0: 	@internalComponent @released */
sl@0: 	{
sl@0: 	__ASSERT_ALWAYS(aGraphic && aGraphic->iPimpl,Panic(EW32PanicGraphicInternal));
sl@0: 	__ASSERT_ALWAYS(aGraphic->Id().IsId() || aGraphic->Id().IsUid(),Panic(EW32PanicGraphicInternal));
sl@0: 	__ASSERT_ALWAYS(!(aGraphic->iPimpl->iFlags & CWsGraphic::CPimpl::ERegistered),Panic(EW32PanicGraphicInternal));
sl@0: 	iArray.InsertInOrderL(aGraphic,GraphicCompare);
sl@0: 	__ASSERT_ALWAYS(0 <= iArray.FindInOrder(aGraphic,GraphicCompare),Panic(EW32PanicGraphicInternal));
sl@0: 	aGraphic->iPimpl->iFlags |= CWsGraphic::CPimpl::ERegistered;
sl@0: 	Queue();
sl@0: 	}
sl@0: 
sl@0: void CWsGraphic::CManager::Replace(CWsGraphic* aGraphic)
sl@0: /** @internalComponent @released */
sl@0: 	{
sl@0: 	__ASSERT_ALWAYS(aGraphic && aGraphic->iPimpl,Panic(EW32PanicGraphicInternal));
sl@0: 	__ASSERT_ALWAYS(!(aGraphic->iPimpl->iFlags & CWsGraphic::CPimpl::ERegistered),Panic(EW32PanicGraphicInternal));
sl@0: 	__ASSERT_ALWAYS(aGraphic->Id().IsId() || aGraphic->Id().IsUid(),Panic(EW32PanicGraphicInternal));
sl@0: 	const TInt idx = iArray.FindInOrder(aGraphic,GraphicCompare);
sl@0: 	__ASSERT_ALWAYS(0 <= idx,Panic(EW32PanicGraphicInternal));
sl@0: 	__ASSERT_ALWAYS(iArray[idx]->iPimpl->iFlags & CWsGraphic::CPimpl::ERegistered,Panic(EW32PanicGraphicInternal));
sl@0: 	iArray[idx]->iPimpl->iFlags &= ~CWsGraphic::CPimpl::ERegistered;
sl@0: 	iArray[idx] = aGraphic;
sl@0: 	iArray[idx]->iPimpl->iFlags |= CWsGraphic::CPimpl::ERegistered;
sl@0: 	Queue();
sl@0: 	}
sl@0: 
sl@0: void CWsGraphic::CManager::Remove(CWsGraphic* aGraphic)
sl@0: /** @internalComponent @released */
sl@0: 	{
sl@0: 	__ASSERT_ALWAYS(aGraphic && aGraphic->iPimpl,Panic(EW32PanicGraphicInternal));
sl@0: 	__ASSERT_ALWAYS(aGraphic->Id().IsId() || aGraphic->Id().IsUid(),Panic(EW32PanicGraphicInternal));
sl@0: 	__ASSERT_ALWAYS(aGraphic->iPimpl->iFlags & CWsGraphic::CPimpl::ERegistered,Panic(EW32PanicGraphicInternal));
sl@0: 	const TInt idx = iArray.FindInOrder(aGraphic,GraphicCompare);
sl@0: 	__ASSERT_ALWAYS(0 <= idx,Panic(EW32PanicGraphicInternal));
sl@0: 	iArray[idx]->iPimpl->iFlags &= ~CWsGraphic::CPimpl::ERegistered;
sl@0: 	iArray.Remove(idx);
sl@0: 	if(!iArray.Count())
sl@0: 		{
sl@0: 		Cancel();
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: CWsGraphic* CWsGraphic::CManager::Find(const TWsGraphicId& aId)
sl@0: /** Find the active artwork identified by the Id
sl@0: 	@return NULL if no active artwork has the Id
sl@0: 	@publishedAll @released */
sl@0: 	{
sl@0: 	/*	RPointerArray can only FindInOrder other T*, which is a needless shame.  Therefore this search is
sl@0: 		dumb sequential */
sl@0: 	const TInt count = iArray.Count();
sl@0: 	for(TInt i=0; i<count; i++)
sl@0: 		{
sl@0: 		CWsGraphic* graphic = iArray[i];
sl@0: 		__ASSERT_ALWAYS(graphic && graphic->iPimpl && (graphic->iPimpl->iFlags & CWsGraphic::CPimpl::ERegistered),Panic(EW32PanicGraphicInternal));
sl@0: 		const TWsGraphicId& candidate = graphic->Id();
sl@0: 		if(0 == candidate.Compare(aId))
sl@0: 			{
sl@0: 			// found
sl@0: 			__ASSERT_DEBUG(i == iArray.FindInOrder(graphic,GraphicCompare),Panic(EW32PanicGraphicInternal));
sl@0: 			return graphic;
sl@0: 			}
sl@0: 		}
sl@0: 	// not found
sl@0: 	return NULL;
sl@0: 	}
sl@0: 
sl@0: void CWsGraphic::CManager::Queue()
sl@0: 	{
sl@0: 	if(!IsActive())
sl@0: 		{
sl@0: 		GraphicMessageReady(&iStatus);
sl@0: 		SetActive();
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CWsGraphic::CManager::RunL()
sl@0:    	{
sl@0:    	if(0 < iStatus.Int())
sl@0:    		{
sl@0:    		// a message to fetch!
sl@0:    		const TInt msgLen = iStatus.Int();
sl@0:  		TPtr8 buf(NULL,0);
sl@0:  		MWsGraphicMessageAlloc* allocator = NULL;
sl@0:  		MWsGraphicMessageAlloc::MBuffer* theirBuf = NULL;
sl@0:  		HBufC8* ourBuf = HBufC8::New(msgLen);
sl@0:  		if(ourBuf)
sl@0:  			{
sl@0:  			CleanupStack::PushL(ourBuf);
sl@0:  			buf.Set(ourBuf->Des());
sl@0:  			}
sl@0:  		else // try to see if the destination CWsGraphic can allocate for us
sl@0:  			{
sl@0: 			const TInt handle = GraphicFetchHeaderMessage();
sl@0: 			CWsGraphic* dest = reinterpret_cast<CWsGraphic*>(handle & ~0x03);
sl@0:  			// check if it's valid
sl@0:  			if(KErrNotFound != iArray.Find(dest) && dest->iPimpl && dest->iPimpl->iExt)
sl@0:  				{
sl@0:  				// check if the client is able to alloc memory for us
sl@0:  				allocator = dest->iPimpl->iExt->ObjectInterface<MWsGraphicMessageAlloc>();
sl@0:  				if(allocator)
sl@0:  					{
sl@0:  					// allocate memory
sl@0:  					theirBuf = allocator->Alloc(msgLen);
sl@0:  					if(theirBuf)
sl@0:  						{
sl@0:  						CleanupStack::PushL(TCleanupItem(MWsGraphicMessageAllocRelease,theirBuf));
sl@0:  						buf.Set(theirBuf->Buffer());
sl@0:  						}
sl@0:  					}
sl@0:  				}
sl@0:  			}
sl@0:  		if(!ourBuf && !theirBuf)
sl@0:  			{
sl@0:  			GraphicMessageCancel();
sl@0:  			GraphicAbortMessage(KErrNoMemory);
sl@0:  			}
sl@0:  		else
sl@0:  			{
sl@0:  			GetGraphicMessage(buf);
sl@0:  			// decode header and body
sl@0:  			RDesReadStream in(buf);
sl@0:  			in.PushL();
sl@0:  			const TInt header = in.ReadInt32L();
sl@0:  			__ASSERT_COMPILE(sizeof(header) == sizeof(TInt32));
sl@0:  			const TInt clientHandle = (header & ~0x03);
sl@0:  			const TInt msgType = (header & 0x03);
sl@0:  			const TPtr8 body = buf.MidTPtr(sizeof(header));
sl@0:  			// dispatch
sl@0:  			CWsGraphic* dest = (CWsGraphic*)clientHandle;
sl@0:  			if(KErrNotFound != iArray.Find(dest))
sl@0:  				{
sl@0:  				switch(msgType)
sl@0:  					{
sl@0:  					case EWsGraphMessageTypeUser:
sl@0:  						dest->HandleMessage(body);
sl@0:  						break;
sl@0:  					default:
sl@0:  						Panic(EW32PanicGraphicInternal);
sl@0:  					}
sl@0:  				}
sl@0:  			// done
sl@0:  			in.Pop();
sl@0:  			}
sl@0:  		if(ourBuf)
sl@0:  			{
sl@0:  			CleanupStack::PopAndDestroy(ourBuf);
sl@0:  			}
sl@0:  		else if(theirBuf)
sl@0:  			{
sl@0:  			CleanupStack::PopAndDestroy(theirBuf);
sl@0:  			}
sl@0:  		// done, wait for next message
sl@0:  		Queue();
sl@0:  		}
sl@0:  	}
sl@0: 
sl@0: void CWsGraphic::CManager::DoCancel()
sl@0: 	{
sl@0: 	GraphicMessageCancel();
sl@0: 	}
sl@0: 
sl@0: TInt CWsGraphic::CManager::GraphicCompare(const CWsGraphic& aFirst,const CWsGraphic& aSecond)
sl@0: /** Compares two graphics for id equality
sl@0: @internalComponent
sl@0: @released
sl@0: */	{
sl@0: 	return aFirst.Id().Compare(aSecond.Id());
sl@0: 	}
sl@0: 
sl@0: void CWsGraphic::CManager::ScheduleFlush()
sl@0: /** Request to schedule flush when idle
sl@0: @internalComponent
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: 	if (iFlushScheduled)
sl@0: 		return;
sl@0: 
sl@0: 	iFlushScheduled = ETrue;
sl@0: 	iFlusher->Start(TCallBack(CWsGraphic::CManager::FlushOnIdle,this));
sl@0: 	}
sl@0: 
sl@0: TInt CWsGraphic::CManager::FlushOnIdle(TAny* aArg)
sl@0: /** Flush buffer when idle and there is outstanding data in it
sl@0: @internalComponent
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: 	CWsGraphic::CManager* mgr = reinterpret_cast<CWsGraphic::CManager*>(aArg);
sl@0: 	if (mgr)
sl@0: 		{
sl@0: 		mgr->iFlushScheduled = EFalse;
sl@0: 		if (mgr->iBuffer && !mgr->iBuffer->IsEmpty())
sl@0: 			mgr->iBuffer->Flush();
sl@0: 		}
sl@0: 
sl@0: 	return 0; // complete
sl@0: 	}
sl@0: 
sl@0: // CWsGraphic::CPimpl \\\\\\\\\\\\\\\\\\\\\\\\
sl@0: 
sl@0: CWsGraphic::CPimpl::CPimpl(CWsGraphic& aGraphic):
sl@0: 	iGraphic(aGraphic), iId(TWsGraphicId::EUninitialized)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: CWsGraphic::CPimpl::~CPimpl()
sl@0: 	{
sl@0: 	if(iManager)
sl@0: 		{
sl@0: 		iManager->Dec();
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CWsGraphic::CPimpl::ConstructL()
sl@0: 	{
sl@0: 	iManager = CManager::StaticL();
sl@0: 	iManager->Inc();
sl@0: 	iBuffer = iManager->Buffer();
sl@0: 	}
sl@0: 
sl@0: TInt CWsGraphic::CPimpl::WriteCreateGraphic(TWsClCmdCreateGraphic& aCreateGraphic,const TDesC8& aData,TInt aWsHandle) const
sl@0: /** Writes the CreateGraphic message to the server.  If the data will not fit in the buffer, uses remote-read
sl@0: 	@internalComponent @released */
sl@0: 	{
sl@0: 	aCreateGraphic.iDataLen = aData.Size();
sl@0: 	aCreateGraphic.iRemoteReadData = ((aData.Size()+sizeof(aCreateGraphic))>(TInt)(iBuffer->BufferSize()-sizeof(TWsCmdHeader)));
sl@0: 	if(aCreateGraphic.iRemoteReadData)
sl@0: 		{
sl@0: 		return iBuffer->WriteReplyByProvidingRemoteReadAccess(aWsHandle,EWsClOpCreateGraphic,&aCreateGraphic,sizeof(aCreateGraphic),&aData);
sl@0: 		}
sl@0: 	else if(aCreateGraphic.iDataLen)
sl@0: 		{
sl@0: 		return iBuffer->WriteReplyWs(&aCreateGraphic,sizeof(aCreateGraphic),aData.Ptr(),aData.Size(),EWsClOpCreateGraphic);
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		return iBuffer->WriteReplyWs(&aCreateGraphic,sizeof(aCreateGraphic),EWsClOpCreateGraphic);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: // CWsGraphic \\\\\\\\\\\\\\\\\\\\\\\\
sl@0: 
sl@0: /** 
sl@0: Default Constructor.
sl@0: */
sl@0: EXPORT_C CWsGraphic::CWsGraphic()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Destructor.
sl@0: */
sl@0: EXPORT_C CWsGraphic::~CWsGraphic()
sl@0: 	{
sl@0: 	Destroy();
sl@0: 	delete iPimpl;
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Completes construction of the baseclass. All the overloaded BaseConstructL() methods
sl@0: should invoke this method to complete the construction of the baseclass.
sl@0: */
sl@0: void CWsGraphic::BaseConstructL()
sl@0: 	{
sl@0: 	iPimpl = new(ELeave) CPimpl(*this);
sl@0: 	iPimpl->ConstructL();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CWsGraphic::BaseConstructL(TUid aUid,TUid aType,const TDesC8& aData)
sl@0: /** 
sl@0: Constructs a piece of non-transient graphic artwork.
sl@0: @capability ProtServ
sl@0: @param aUid	Graphic artwork UID.
sl@0: @param aType Graphic artwork type.
sl@0: @param aData User specific data.
sl@0: */	{
sl@0: 	BaseConstructL();
sl@0: 
sl@0: 	TWsClCmdCreateGraphic createGraphic;
sl@0: 	createGraphic.iFlags = EWsGraphicIdUid;
sl@0: 	createGraphic.iId = aUid.iUid;
sl@0: 	createGraphic.iType = aType;
sl@0: 	createGraphic.iClientHandle = (TInt)this;
sl@0: 
sl@0: 	TInt ret = iPimpl->WriteCreateGraphic(createGraphic,aData,iPimpl->iManager->WsHandle());
sl@0: 	User::LeaveIfError(ret);
sl@0: 
sl@0: 	iPimpl->iWsHandle=ret;
sl@0: 	iPimpl->iId = aUid;
sl@0: 	iPimpl->iFlags = CPimpl::EHasPeer;
sl@0: 	iPimpl->iManager->AddL(this);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CWsGraphic::BaseConstructL(TUid aType,const TDesC8& aData)
sl@0: /** 
sl@0: Constructs a piece of transient graphic artwork.
sl@0: @param aType Graphic artwork type.
sl@0: @param aData User specific data.
sl@0: */
sl@0: 	{
sl@0: 	BaseConstructL();
sl@0: 
sl@0: 	TWsClCmdCreateGraphic createGraphic;
sl@0: 	createGraphic.iFlags = EWsGraphicIdTransient;
sl@0: 	createGraphic.iId = 0;
sl@0: 	createGraphic.iType = aType;
sl@0: 	createGraphic.iClientHandle = (TInt)this;
sl@0: 
sl@0: 	TInt ret = iPimpl->WriteCreateGraphic(createGraphic,aData,iPimpl->iManager->WsHandle());
sl@0: 	User::LeaveIfError(ret);
sl@0: 
sl@0: 	iPimpl->iWsHandle = ret;
sl@0: 
sl@0: 	// fetch id from server
sl@0: 	TPckgBuf<TWsClCmdGdGetId> cmd;
sl@0: 	User::LeaveIfError(iPimpl->WriteReplyP(TWriteDescriptorType(&cmd),EWsGdOpGetGraphicId));
sl@0: 	if(cmd().iIsUid)
sl@0: 		{
sl@0: 		__DEBUG_ONLY(Panic(EW32PanicGraphicInternal));
sl@0: 		User::Leave(KErrGeneral);
sl@0: 		}
sl@0: 	iPimpl->iId = cmd().iId;
sl@0: 
sl@0: 	iPimpl->iFlags = CPimpl::EHasPeer;
sl@0: 	iPimpl->iManager->AddL(this);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CWsGraphic::BaseConstructL(const TWsGraphicId& aReplace,TUid aType,const TDesC8& aData)
sl@0: /** 
sl@0: Atomically replace the artwork that already exists with this artwork.
sl@0: If failure to properly construct the replacement artwork occurs, the replacee artwork will remain
sl@0: @param aReplace Graphic artwork which will be replaced.
sl@0: @param aType New graphic artwork type.
sl@0: @param aData User specific data.
sl@0: */
sl@0: 	{
sl@0: 	BaseConstructL();
sl@0: 
sl@0: 	CWsGraphic* dup = iPimpl->iManager->Find(aReplace);
sl@0: 	if(!dup || !dup->iPimpl)
sl@0: 		{
sl@0: 		Panic(EW32PanicGraphicInternal);
sl@0: 		}
sl@0: 
sl@0: 	const TUint flags = aReplace.IsUid()?EWsGraphicIdUid:EWsGraphicIdTransient;
sl@0: 
sl@0: 	TWsClCmdCreateGraphic createGraphic;
sl@0: 	createGraphic.iFlags = EWsGraphicReplace|flags;
sl@0: 	createGraphic.iId = aReplace.IsUid()?aReplace.Uid().iUid:aReplace.Id();
sl@0: 	createGraphic.iType = aType;
sl@0: 	createGraphic.iClientHandle = (TInt)this;
sl@0: 
sl@0: 	TInt ret = iPimpl->WriteCreateGraphic(createGraphic,aData,iPimpl->iManager->WsHandle());
sl@0: 	if(0 > ret)
sl@0: 		{
sl@0: 		User::Leave(ret);
sl@0: 		}
sl@0: 
sl@0: 	iPimpl->iWsHandle = ret;
sl@0: 	iPimpl->iId = aReplace;
sl@0: 
sl@0: 	iPimpl->iFlags = CPimpl::EHasPeer;
sl@0: 	iPimpl->iManager->Replace(this);
sl@0: 
sl@0: 	// when WriteCreateGraphic succeeds, the replacee drawer has already been destroyed serverside
sl@0: 	// so this cleanup is not quite the same as Destroy(), as it doesn't free server side
sl@0: 	dup->iPimpl->iWsHandle = 0;
sl@0: 	dup->OnReplace();
sl@0: 	dup->iPimpl->iFlags &= ~CPimpl::EHasPeer;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Shares the graphic artwork with all the 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: EXPORT_C TInt CWsGraphic::ShareGlobally()
sl@0: 	{
sl@0: 	if(!IsActive())
sl@0: 		{
sl@0: 		return KErrNotReady;
sl@0: 		}
sl@0: 	return iPimpl->WriteReply(EWsGdOpShareGlobally);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Prevents this graphic artwork from being shared with all the client sessions.
sl@0: A graphic artwork 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: EXPORT_C TInt CWsGraphic::UnShareGlobally()
sl@0: 	{
sl@0: 	if(!IsActive())
sl@0: 		{
sl@0: 		return KErrNotReady;
sl@0: 		}
sl@0: 	return iPimpl->WriteReply(EWsGdOpUnShareGlobally);
sl@0: 	}
sl@0: 	
sl@0: /** 
sl@0: Explicitly shares this graphic artwork 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 artwork was shared, else one of the system-wide error codes.
sl@0: */
sl@0: EXPORT_C TInt CWsGraphic::Share(TSecureId aClientId)
sl@0: 	{
sl@0: 	if(!IsActive())
sl@0: 		{
sl@0: 		return KErrNotReady;
sl@0: 		}
sl@0: 	return iPimpl->WriteReply(&aClientId,sizeof(TSecureId),EWsGdOpShare);
sl@0: 	}
sl@0: 
sl@0: /** 
sl@0: Stops this graphic artwork 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 artwork is no longer shared, KErrNotFound if the graphic was not shared anyway, else one of the system-wide error codes
sl@0: */
sl@0: EXPORT_C TInt CWsGraphic::UnShare(TSecureId aClientId)
sl@0: 	{
sl@0: 	if(!IsActive())
sl@0: 		{
sl@0: 		return KErrNotReady;
sl@0: 		}
sl@0: 	return iPimpl->WriteReply(&aClientId,sizeof(TSecureId),EWsGdOpUnShare);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Returns graphic artwork Id.
sl@0: @return Graphic artwork Id. KNullWsGraphicId if graphic artwork is not active.
sl@0: */
sl@0: EXPORT_C const TWsGraphicId& CWsGraphic::Id() const
sl@0: 	{
sl@0: 	if(IsActive())
sl@0: 		{
sl@0: 		return iPimpl->iId;
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		// fallback
sl@0: 		static const TInt KNullWsGraphicId[4] = //binary compatible with TWsGraphicId
sl@0: 			{
sl@0: 			0, 0, 0, 0
sl@0: 			};
sl@0: 		__ASSERT_COMPILE(sizeof(KNullWsGraphicId) == sizeof(TWsGraphicId));
sl@0: 		return reinterpret_cast<const TWsGraphicId&>(KNullWsGraphicId);
sl@0: 		}
sl@0: 	}
sl@0: 	
sl@0: /** 
sl@0: Checks whether a peer of this graphic artwork has been fully constructed on the server.
sl@0: @return ETrue if this graphic artwork has a peer CWsGraphic on the server.
sl@0: */
sl@0: EXPORT_C TBool CWsGraphic::IsActive() const
sl@0: 	{
sl@0: 	return (iPimpl && iPimpl->iWsHandle && (iPimpl->iFlags & CPimpl::EHasPeer));
sl@0: 	}
sl@0: 	
sl@0: /**
sl@0: Derived class can override this method to provide custom operations when the client is closed.
sl@0: */
sl@0: EXPORT_C void CWsGraphic::OnClientClose()
sl@0: 	{
sl@0: 	}
sl@0: 	
sl@0: /** 
sl@0: Sends message to this graphic artwork peer on the server.
sl@0: @param aData User specific data.
sl@0: */
sl@0: EXPORT_C void CWsGraphic::SendMessage(const TDesC8& aData) const
sl@0: 	{
sl@0: 	TWsClCmdGdSendMessage cmd;
sl@0: 	cmd.iDataLen = aData.Size();
sl@0: 	__ASSERT_DEBUG(cmd.iDataLen, Panic(EW32PanicGraphicNullData));
sl@0: 	cmd.iRemoteReadData = ((aData.Size()+sizeof(cmd))>(TInt)(iPimpl->iBuffer->BufferSize()-sizeof(TWsCmdHeader)));
sl@0: 	if(cmd.iRemoteReadData)
sl@0: 		{
sl@0: 		iPimpl->WriteReplyByProvidingRemoteReadAccess(&cmd,sizeof(cmd),&aData,EWsGdOpSendMsg);
sl@0: 		//ignore return value!
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		iPimpl->Write(&cmd,sizeof(cmd),aData.Ptr(),aData.Size(),EWsGdOpSendMsg);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CWsGraphic::SendSynchronMessage(const TDesC8& aData) const
sl@0: 	 {
sl@0: 	 TWsClCmdGdSendMessage cmd;
sl@0: 	 cmd.iDataLen = aData.Size();
sl@0: 	 __ASSERT_DEBUG(cmd.iDataLen, Panic(EW32PanicGraphicNullData));
sl@0: 	 cmd.iRemoteReadData = ((aData.Size()+sizeof(cmd))>(TInt)(iPimpl->iBuffer->BufferSize()-sizeof(TWsCmdHeader)));
sl@0: 	 if(cmd.iRemoteReadData)
sl@0: 		{
sl@0: 		return iPimpl->WriteReplyByProvidingRemoteReadAccess(&cmd,sizeof(cmd),&aData,EWsGdOpSendSynchronMsg);
sl@0: 		}
sl@0: 	 else
sl@0: 		{
sl@0: 		return iPimpl->WriteReply(&cmd,sizeof(cmd),aData.Ptr(),aData.Size(),EWsGdOpSendSynchronMsg);
sl@0: 		}
sl@0: 	 }
sl@0: 
sl@0: /** 
sl@0: Flushes window server command buffer
sl@0: @return One of system-wide error codes.
sl@0: */
sl@0: EXPORT_C TInt CWsGraphic::Flush() const
sl@0: 	{
sl@0: 	return iPimpl->iBuffer->Flush();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CWsGraphic::Destroy()
sl@0: /** Destroys the corresponding CWsGraphicDrawer instance on the server
sl@0: @released
sl@0: @publishedAll
sl@0: */	{
sl@0: 	if(iPimpl && (iPimpl->iFlags & CPimpl::ERegistered))
sl@0: 		{
sl@0: 		iPimpl->iManager->Remove(this);
sl@0: 		}
sl@0: 	if(IsActive()) // if iPimpl==NULL, IsActive() returns false
sl@0: 		{
sl@0: 		iPimpl->Write(EWsGdOpFree);
sl@0: 		iPimpl->iWsHandle = 0;
sl@0: 		iPimpl->iFlags &= ~CPimpl::EHasPeer;
sl@0: 		iPimpl->iManager->ScheduleFlush();
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CWsGraphic::SetGraphicExtension(MWsObjectProvider* aExt)
sl@0: 	{
sl@0: 	iPimpl->iExt = aExt;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C RWsSession&  CWsGraphic::Session()
sl@0: 	{
sl@0: 	return *iPimpl->iManager;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CWsGraphic::CWsGraphic_Reserved1()
sl@0: 	{
sl@0: 	return KErrNotSupported;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CWsGraphic::CWsGraphic_Reserved2()
sl@0: 	{
sl@0: 	return KErrNotSupported;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CWsGraphic::CWsGraphic_Reserved3()
sl@0: 	{
sl@0: 	return KErrNotSupported;
sl@0: 	}
sl@0: 
sl@0: // TWsGraphicMsgFixedBase \\\\\\\\\\\\\\\\\\\\\\\\
sl@0: 
sl@0: EXPORT_C TWsGraphicMsgFixedBase::TWsGraphicMsgFixedBase(TUid aTypeId,TInt aSizeOfDerived):
sl@0: /** Protected constructor for subclasses to call
sl@0: @param aTypeId The UID representing this type of data
sl@0: @param aSizeOf The size of the derived class
sl@0: 
sl@0: Example:
sl@0: @code
sl@0: TMyDerivedFixedMsg::TMyDerivedFixedMsg(): TWsGraphicMsgFixedBase(KUidMyDerivedType,sizeof(TMyDerivedFixedMsg)), ...
sl@0: @endcode
sl@0: */	iTypeId(aTypeId), iSize(aSizeOfDerived-sizeof(TWsGraphicMsgFixedBase))
sl@0: 	{
sl@0: 	__ASSERT_COMPILE(sizeof(*this) == (sizeof(TInt32)*2));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TPtrC8 TWsGraphicMsgFixedBase::Pckg() const
sl@0: /** @return this fixed message as a descriptor so that it can be passed as draw data in the CWindowGc::DrawWsGraphic command directly if only one such message is to be sent
sl@0: */	{
sl@0: 	return TPtrC8(reinterpret_cast<const TUint8*>(this),sizeof(*this) + iSize);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TUid TWsGraphicMsgFixedBase::TypeId() const
sl@0: /** @return the UID identifying the type of the data that follows */
sl@0: 	{
sl@0: 	return iTypeId;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt TWsGraphicMsgFixedBase::Size() const
sl@0: /** @return the size of the derived class (not including this fixed base class size) */
sl@0: 	{
sl@0: 	return iSize;
sl@0: 	}
sl@0: 
sl@0: // RWsGraphicMsgBuf \\\\\\\\\\\\\\\\\\\\\\\\
sl@0: 
sl@0: EXPORT_C RWsGraphicMsgBuf::RWsGraphicMsgBuf()
sl@0: /** Default Constructor */
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: TInt RWsGraphicMsgBuf::IntAt(TInt aOfs) const
sl@0: /** @internalComponent @released */
sl@0: 	{
sl@0: 	if((aOfs < 0) || ((aOfs+sizeof(TInt)) > Length()))
sl@0: 		{
sl@0: 		Panic(EW32PanicGraphicBadBuffer);
sl@0: 		}
sl@0: 	TInt ret;
sl@0: 	memcpy(&ret,Ptr()+aOfs,sizeof(TInt));
sl@0: 	return ret;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt RWsGraphicMsgBuf::Append(TUid aTypeId,const TDesC8& aData)
sl@0: /** Append a descriptor as data
sl@0: 	@param aTypeId the type of the message to append
sl@0: 	@param aData arbitrary length data consisting of the whole message
sl@0: 	@return KErrNone if successful, else a system-wide error code
sl@0: */	{
sl@0: 	TInt err = ExpandForAppend(aData.Length());
sl@0: 	if (err)
sl@0: 		{
sl@0: 		return err;
sl@0: 		}
sl@0: 	WriteHeader(aTypeId,aData.Length());
sl@0: 	// append data
sl@0: 	Insert(Length(),aData);
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt RWsGraphicMsgBuf::Append(TUid aTypeId,const TDesC16& aData)
sl@0: /** Append a descriptor as data
sl@0: 	@param aTypeId the type of the message to append
sl@0: 	@param aData arbitrary length data consisting of the whole message
sl@0: 	@return KErrNone if successful, else a system-wide error code
sl@0: */	{
sl@0: 	TPtr8 data(NULL,0);
sl@0: 	TInt err = Append(aTypeId,aData.Size(),data);
sl@0: 	if (err)
sl@0: 		{
sl@0: 		return err;
sl@0: 		}
sl@0: 	// append data
sl@0: 	data.Copy(reinterpret_cast<const TUint8*>(aData.Ptr()),aData.Size());
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: TInt RWsGraphicMsgBuf::ExpandForAppend(TInt aDataLen)
sl@0: /** @internalComponent @released */
sl@0: 	{
sl@0: 	__ASSERT_COMPILE(sizeof(TInt) == sizeof(TInt32));
sl@0: 	const TInt required = (sizeof(TUid) + sizeof(TInt) + aDataLen);
sl@0: 	if(MaxLength() < (Length() + required))
sl@0: 		{
sl@0: 		TInt err = ReAlloc(Length()+required);
sl@0: 		if(KErrNone != err)
sl@0: 			{
sl@0: 			return err;
sl@0: 			}
sl@0: 		}
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: void RWsGraphicMsgBuf::WriteHeader(TUid aTypeId,TInt aLen)
sl@0: /** @internalComponent @released */
sl@0: 	{
sl@0: 	__ASSERT_COMPILE(sizeof(TInt) == sizeof(TInt32));
sl@0: 	// append header
sl@0: 	TPckgBuf<TInt32> i(aTypeId.iUid);
sl@0: 	Insert(Length(),i);
sl@0: 	i() = aLen;
sl@0: 	Insert(Length(),i);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt RWsGraphicMsgBuf::Append(TUid aTypeId,TInt aLen,TPtr8& aPtr)
sl@0: /** Append a message of the specified length and type, and return a pointer to
sl@0: 	allow client code to modify the message.
sl@0: 	aPtr is only set if the append succeeds.
sl@0: 	aPtr is only valid until the next message is appended to the buffer.
sl@0: 	@param aTypeId the type of the message to append
sl@0: 	@param aLen the length of the message to be reserved
sl@0: 	@param aPtr a modifiable descriptor to be used by the client code to write into the message body
sl@0: 	@return KErrNone if successful, else a system-wide error code
sl@0: */	{
sl@0: 	TInt err = ExpandForAppend(aLen);
sl@0: 	if (err)
sl@0: 		{
sl@0: 		return err;
sl@0: 		}
sl@0: 	WriteHeader(aTypeId,aLen);
sl@0: 	// set aPtr
sl@0: 	TInt usedLen = Length();
sl@0: 	SetLength(usedLen+aLen);
sl@0: 	aPtr.Set(MidTPtr(usedLen,aLen));
sl@0: 	aPtr.Fill('_'); // prettier when debugging, but want consistant behaviour in release builds
sl@0: 	aPtr.Zero();
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RWsGraphicMsgBuf::Remove(TInt aIndex)
sl@0: /** Remove a message from the buffer
sl@0: 	@panic if the index is out of bounds
sl@0: 	@param aIndex the ordinal position of message to be removed
sl@0: */	{
sl@0: 	if((aIndex < 0) || (aIndex >= Count()))
sl@0: 		{
sl@0: 		Panic(EW32PanicGraphicBadBuffer);
sl@0: 		}
sl@0: 	TPtrC8 ptr = Data(aIndex);
sl@0: 	const TInt ofs = (ptr.Ptr()-(sizeof(TInt)*2)-Ptr());
sl@0: 	Delete(ofs,ptr.Length() + (sizeof(TInt)*2));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt RWsGraphicMsgBuf::Count() const
sl@0: /** Returns the number of messages in the buffer
sl@0: 	@return the number of messages in the buffer
sl@0: */	{
sl@0: 	const TInt length = Length();
sl@0: 	TInt ofs = 0, count = 0;
sl@0: 	while(ofs < length)
sl@0: 		{
sl@0: 		count++;
sl@0: 		ofs += IntAt(ofs+sizeof(TInt)) + (sizeof(TInt)*2);
sl@0: 		}
sl@0: 	if(ofs != length)
sl@0: 		{
sl@0: 		Panic(EW32PanicGraphicBadBuffer);
sl@0: 		}
sl@0: 	return count;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TUid RWsGraphicMsgBuf::TypeId(TInt aIndex) const
sl@0: /** Returns the Type ID of a message in the buffer
sl@0: 	@param aIndex the ordinal position of the message
sl@0: 	@return the Type ID of the message
sl@0: 	@panic if the index is out of bounds
sl@0: */	{
sl@0: 	const TInt length = Length();
sl@0: 	TInt ofs = 0, count = 0;
sl@0: 	while(ofs < length)
sl@0: 		{
sl@0: 		if(count == aIndex)
sl@0: 			{
sl@0: 			return TUid::Uid(IntAt(ofs));
sl@0: 			}
sl@0: 		count++;
sl@0: 		ofs += IntAt(ofs+sizeof(TInt)) + (sizeof(TInt)*2);
sl@0: 		}
sl@0: 	Panic(EW32PanicGraphicBadBuffer);
sl@0: 	return KNullUid; //dumb compiler
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TPtrC8 RWsGraphicMsgBuf::Data(TInt aIndex) const
sl@0: /** Returns a non-modifiable descriptor of a message body in the buffer
sl@0: 	@param aIndex the ordinal position of the message
sl@0: 	@return the message body
sl@0: 	@panic if the index is out of bounds
sl@0: */	{
sl@0: 	const TInt length = Length();
sl@0: 	TInt ofs = 0, count = 0;
sl@0: 	while(ofs < length)
sl@0: 		{
sl@0: 		if(count == aIndex)
sl@0: 			{
sl@0: 			return Mid(ofs+(sizeof(TInt)*2),IntAt(ofs+sizeof(TInt)));
sl@0: 			}
sl@0: 		count++;
sl@0: 		ofs += IntAt(ofs+sizeof(TInt)) + (sizeof(TInt)*2);
sl@0: 		}
sl@0: 	Panic(EW32PanicGraphicBadBuffer);
sl@0: 	return TPtrC8(KNullDesC8()); //dumb compiler
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TPtr8 RWsGraphicMsgBuf::Data(TInt aIndex)
sl@0: /** Returns a modifiable descriptor of a message body in the buffer
sl@0: 	The returned TPtr8 is only valid until the next message is appended to the buffer.
sl@0: 	@param aIndex the ordinal position of the message
sl@0: 	@return the message body
sl@0: 	@panic if the index is out of bounds
sl@0: */	{
sl@0: 	const TInt length = Length();
sl@0: 	TInt ofs = 0, count = 0;
sl@0: 	while(ofs < length)
sl@0: 		{
sl@0: 		if(count == aIndex)
sl@0: 			{
sl@0: 			return MidTPtr(ofs+(sizeof(TInt)*2),IntAt(ofs+sizeof(TInt)));
sl@0: 			}
sl@0: 		count++;
sl@0: 		ofs += IntAt(ofs+sizeof(TInt)) + (sizeof(TInt)*2);
sl@0: 		}
sl@0: 	Panic(EW32PanicGraphicBadBuffer);
sl@0: 	return TPtr8(NULL,0); //dumb compiler
sl@0: 	}
sl@0: 
sl@0: EXPORT_C const TDesC8& RWsGraphicMsgBuf::Pckg() const
sl@0: /** Returns the message buffer as a descriptor.  Example:
sl@0: 	@code
sl@0: 	RWsGraphicMsgBuf msgBuf;
sl@0: 	msgBuf.Append(...);
sl@0: 	...
sl@0: 	TWsGraphicId id(...);
sl@0: 	SystemGc().DrawWsGraphic(id,Rect(),msgBuf.Pckg());
sl@0: 	msgBuf.Close();
sl@0: 	@endcode
sl@0: 	@see CWindowGc::DrawWsGraphic
sl@0: 	@see CCoeControl::Draw
sl@0: 	@return the message buffer to be attached a command to draw a CWsGraphic
sl@0: */	{
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt RWsGraphicMsgBuf::Append(const TWsGraphicMsgFixedBase& aMsg)
sl@0: /** Append a fixed-size message
sl@0: 	@param aMsg the fixed-size message to append
sl@0: 	@return KErrNone if successful, else a system-wide error code
sl@0: */	{
sl@0: 	__ASSERT_COMPILE(sizeof(TWsGraphicMsgFixedBase) == (sizeof(TInt)*2));
sl@0: 	TInt err = ExpandForAppend(aMsg.Size());
sl@0: 	if (err)
sl@0: 		{
sl@0: 		return err;
sl@0: 		}
sl@0: 	// append data
sl@0: 	RBuf8::Append(reinterpret_cast<const TUint8*>(&aMsg),sizeof(TWsGraphicMsgFixedBase) + aMsg.Size());
sl@0: 	Count();
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RWsGraphicMsgBuf::GetFixedMsg(TWsGraphicMsgFixedBase& aMsg,TInt aIndex) const
sl@0: /** Returns a copy of a fixed-size message in the buffer
sl@0: 	@param a copy of the message
sl@0: 	@param aIndex the ordinal position of the message
sl@0: 	@panic if the index is out of bounds
sl@0: 	@panic the message specified is not of the correct type
sl@0: */	{
sl@0: 	__ASSERT_COMPILE(sizeof(TWsGraphicMsgFixedBase) == (sizeof(TInt32)*2));
sl@0: 	const TInt KHeaderSize = sizeof(TWsGraphicMsgFixedBase);
sl@0: 	const TInt length = Length();
sl@0: 	TInt ofs = 0, count = 0;
sl@0: 	while(ofs < length)
sl@0: 		{
sl@0: 		if(count == aIndex)
sl@0: 			{
sl@0: 			if((TUid::Uid(IntAt(ofs)) != aMsg.TypeId()) ||
sl@0: 				(IntAt(ofs+sizeof(TInt)) != aMsg.Size()) ||
sl@0: 				((ofs + KHeaderSize + aMsg.Size()) > length))
sl@0: 				{
sl@0: 				Panic(EW32PanicGraphicBadBuffer);
sl@0: 				}
sl@0: 			memcpy(&aMsg,(Ptr()+ofs),KHeaderSize + aMsg.Size());
sl@0: 			return;
sl@0: 			}
sl@0: 		count++;
sl@0: 		ofs += IntAt(ofs+sizeof(TInt)) + (sizeof(TInt)*2);
sl@0: 		}
sl@0: 	Panic(EW32PanicGraphicBadBuffer);
sl@0: 	}
sl@0: