// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// The client-side representation of a WsGraphic artwork

// 

//

#include <w32std.h>

#include "../SERVER/w32cmd.h"

#include "w32comm.h"

#include "CLIENT.H"

#include <s32mem.h>

#include <graphics/wsgraphicdrawerinterface.h>

/** Panics the client. This will result in the client thread being destroyed. */

GLREF_C void Panic(TW32Panic aPanic);

NONSHARABLE_STRUCT(CWsGraphic::CPimpl): public CBase, public MWsClientClass

/** @internalComponent @released */

	{

	friend class CWsGraphic;

	enum

		{

		/** is registered in the graphic manager's array */

		ERegistered = 0x01,

		/** has a peer CWsGraphicDrawer on the server */

		EHasPeer	= 0x02

		};

	CPimpl(CWsGraphic& aGraphic);

	~CPimpl();

	void ConstructL();		//LeaveScan: Member of macroised structure declaration.

	CManager* iManager;

	TInt WriteCreateGraphic(TWsClCmdCreateGraphic& aCreateGraphic,const TDesC8& aData,TInt aWsHandle) const;

	CWsGraphic& iGraphic;

	TWsGraphicId iId;

	TUint iFlags;

	MWsObjectProvider* iExt;

	};

LOCAL_C void MWsGraphicMessageAllocRelease(TAny* aAny)

	{

	MWsGraphicMessageAlloc::MBuffer* buf = static_cast<MWsGraphicMessageAlloc::MBuffer*>(aAny);

	if(buf)

		{

		buf->Release();

		}

	}

NONSHARABLE_CLASS(CWsGraphic::CManager): private CActive, public RWsSession

/** Client-side manager singleton for marshalling messages for all CWsGraphics owned by a client

@publishedAll

@released

*/	{

public:

	static CManager* StaticL();			  //LeaveScan:  Member of macroised structure declaration.

	// used by CWsGraphic

	void AddL(CWsGraphic* aGraphic);	  //LeaveScan:  Member of macroised structure declaration.

	void Replace(CWsGraphic* aGraphic);

	void Remove(CWsGraphic* aGraphic);

	CWsGraphic* Find(const TWsGraphicId& aId);

	void Inc();

	void Dec();

	RWsBuffer* Buffer();

	void ScheduleFlush();

private:

	CManager();

	~CManager();

	void ConstructL();					 //LeaveScan:  Member of macroised structure declaration.

	void Queue();

	void RunL();						 //LeaveScan:  Member of macroised structure declaration.

	void DoCancel();

	static TInt GraphicCompare(const CWsGraphic& aFirst,const CWsGraphic& aSecond);

	static TInt FlushOnIdle(TAny* aArg);

private:

	TInt iRefCount;

	RPointerArray<CWsGraphic> iArray;

	CIdle* iFlusher;

	TBool iFlushScheduled;

	};

// TWsGraphicId \\\\\\\\\\\\\\\\\\\\\\\\

EXPORT_C TWsGraphicId::TWsGraphicId(TUid aUid):

/** Construct a UID

    @param aUid UID of the graphic artwork.

    @publishedAll @released

*/	iFlags(EWsGraphicIdUid), iId(aUid.iUid)

	{

	}

EXPORT_C TWsGraphicId::TWsGraphicId(TInt aId):

/** Construct a transient Id

	@publishedAll @released

*/	iFlags(EWsGraphicIdTransient), iId(aId)

	{

	}

/** 

Copy constructor.

@param aCopy Graphic artwork Id.

*/

EXPORT_C TWsGraphicId::TWsGraphicId(const TWsGraphicId& aCopy):

	iFlags(aCopy.iFlags), iId(aCopy.iId)

	{

	}

EXPORT_C TUid TWsGraphicId::Uid() const

/** Returns UID.

    @return UID of graphic artwork. KNullUid if graphic artwork is transient.

    @publishedAll @released

*/	{

	if(IsUid())

		{

		return TUid::Uid(iId);

		}

	return KNullUid;

	}

EXPORT_C TBool TWsGraphicId::IsUid() const

/** Identifies whether graphic artwork is non-transient.

    @return ETrue if graphic artwork is non-transient.

    @publishedAll @released

*/	{

	return (iFlags & EWsGraphicIdUid);

	}

EXPORT_C void TWsGraphicId::Set(TUid aUid)

/** Set to be a UID

	@publishedAll @released

*/	{

	iId = aUid.iUid;

	iFlags = EWsGraphicIdUid;

	}

EXPORT_C TInt TWsGraphicId::Id() const

/** Returns the transient Id.

    @return Id of transient graphic artwork. Zero if graphic artwork is non-transient.

	@publishedAll @released

*/	{

	if(IsId())

		{

		return iId;

		}

	return 0;

	}

EXPORT_C TBool TWsGraphicId::IsId() const

/** Identifies whether graphic artwork is transient.

    @return ETrue if graphic artwork is transient.

    @publishedAll @released

*/	{

	return (iFlags & EWsGraphicIdTransient);

	}

EXPORT_C void TWsGraphicId::Set(TInt aId)

/** Set to be a transient Id

	@publishedAll @released

*/	{

	iId = aId;

	iFlags = EWsGraphicIdTransient;

	}

EXPORT_C TInt TWsGraphicId::Compare(const TWsGraphicId& aOther) const

/** Compares another Id with this one.

	@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

	@publishedAll @released

*/	{

	if(iId < aOther.iId)

		{

		return -1;

		}

	else if(iId > aOther.iId)

		{

		return 1;

		}

	// else we have to compare the iIsUid flag too; again, expect it to be a match 99.99% of these times

	else if(IsUid() == aOther.IsUid())

		{

		return 0;

		}

	// collisions of id but not iIsUid are going to be really really rare

	else if(IsUid())

		{

		return 1;

		}

	else

		{

		return -1;

		}

	}

// CWsGraphicManager \\\\\\\\\\\\\\\\\\\\\\\\

CWsGraphic::CManager* CWsGraphic::CManager::StaticL()

	{

	CManager* singleton = RWsBuffer::WsGraphicManager();

	if(!singleton)

		{

		singleton = new(ELeave) CManager;

		CleanupStack::PushL(singleton);

		singleton->ConstructL();

		CleanupStack::Pop(singleton);

		__ASSERT_DEBUG(singleton == RWsBuffer::WsGraphicManager(),Panic(EW32PanicGraphicInternal));

		}

	return singleton;

	}

CWsGraphic::CManager::~CManager()

	{

	__ASSERT_DEBUG(!ResourceCount(),Panic(EW32PanicGraphicInternal));

	__ASSERT_DEBUG(!iArray.Count(),Panic(EW32PanicGraphicOrphaned));

	Close();

	__ASSERT_DEBUG(!RWsBuffer::WsGraphicManager(),Panic(EW32PanicGraphicInternal));

	iArray.Close();

	delete iFlusher;

	}

CWsGraphic::CManager::CManager(): CActive(CActive::EPriorityStandard)

	{

	}

void CWsGraphic::CManager::ConstructL()

	{

	User::LeaveIfError(Connect());

	iBuffer->SetWsGraphicManager(this);

	CActiveScheduler::Add(this);

	iFlusher = CIdle::NewL(CActive::EPriorityIdle);

	}

void CWsGraphic::CManager::Inc()

	{

	iRefCount++;

	}

void CWsGraphic::CManager::Dec()

	{

	if(!--iRefCount)

		{

		delete this;

		}

	}

RWsBuffer* CWsGraphic::CManager::Buffer()

	{

	return iBuffer;

	}

// used by CWsGraphic

void CWsGraphic::CManager::AddL(CWsGraphic* aGraphic)

/** Leaves if the graphic couldn't be added to the list

	@internalComponent @released */

	{

	__ASSERT_ALWAYS(aGraphic && aGraphic->iPimpl,Panic(EW32PanicGraphicInternal));

	__ASSERT_ALWAYS(aGraphic->Id().IsId() || aGraphic->Id().IsUid(),Panic(EW32PanicGraphicInternal));

	__ASSERT_ALWAYS(!(aGraphic->iPimpl->iFlags & CWsGraphic::CPimpl::ERegistered),Panic(EW32PanicGraphicInternal));

	iArray.InsertInOrderL(aGraphic,GraphicCompare);

	__ASSERT_ALWAYS(0 <= iArray.FindInOrder(aGraphic,GraphicCompare),Panic(EW32PanicGraphicInternal));

	aGraphic->iPimpl->iFlags |= CWsGraphic::CPimpl::ERegistered;

	Queue();

	}

void CWsGraphic::CManager::Replace(CWsGraphic* aGraphic)

/** @internalComponent @released */

	{

	__ASSERT_ALWAYS(aGraphic && aGraphic->iPimpl,Panic(EW32PanicGraphicInternal));

	__ASSERT_ALWAYS(!(aGraphic->iPimpl->iFlags & CWsGraphic::CPimpl::ERegistered),Panic(EW32PanicGraphicInternal));

	__ASSERT_ALWAYS(aGraphic->Id().IsId() || aGraphic->Id().IsUid(),Panic(EW32PanicGraphicInternal));

	const TInt idx = iArray.FindInOrder(aGraphic,GraphicCompare);

	__ASSERT_ALWAYS(0 <= idx,Panic(EW32PanicGraphicInternal));

	__ASSERT_ALWAYS(iArray[idx]->iPimpl->iFlags & CWsGraphic::CPimpl::ERegistered,Panic(EW32PanicGraphicInternal));

	iArray[idx]->iPimpl->iFlags &= ~CWsGraphic::CPimpl::ERegistered;

	iArray[idx] = aGraphic;

	iArray[idx]->iPimpl->iFlags |= CWsGraphic::CPimpl::ERegistered;

	Queue();

	}

void CWsGraphic::CManager::Remove(CWsGraphic* aGraphic)

/** @internalComponent @released */

	{

	__ASSERT_ALWAYS(aGraphic && aGraphic->iPimpl,Panic(EW32PanicGraphicInternal));

	__ASSERT_ALWAYS(aGraphic->Id().IsId() || aGraphic->Id().IsUid(),Panic(EW32PanicGraphicInternal));

	__ASSERT_ALWAYS(aGraphic->iPimpl->iFlags & CWsGraphic::CPimpl::ERegistered,Panic(EW32PanicGraphicInternal));

	const TInt idx = iArray.FindInOrder(aGraphic,GraphicCompare);

	__ASSERT_ALWAYS(0 <= idx,Panic(EW32PanicGraphicInternal));

	iArray[idx]->iPimpl->iFlags &= ~CWsGraphic::CPimpl::ERegistered;

	iArray.Remove(idx);

	if(!iArray.Count())

		{

		Cancel();

		}

	}

CWsGraphic* CWsGraphic::CManager::Find(const TWsGraphicId& aId)

/** Find the active artwork identified by the Id

	@return NULL if no active artwork has the Id

	@publishedAll @released */

	{

	/*	RPointerArray can only FindInOrder other T*, which is a needless shame.  Therefore this search is

		dumb sequential */

	const TInt count = iArray.Count();

	for(TInt i=0; i<count; i++)

		{

		CWsGraphic* graphic = iArray[i];

		__ASSERT_ALWAYS(graphic && graphic->iPimpl && (graphic->iPimpl->iFlags & CWsGraphic::CPimpl::ERegistered),Panic(EW32PanicGraphicInternal));

		const TWsGraphicId& candidate = graphic->Id();

		if(0 == candidate.Compare(aId))

			{

			// found

			__ASSERT_DEBUG(i == iArray.FindInOrder(graphic,GraphicCompare),Panic(EW32PanicGraphicInternal));

			return graphic;

			}

		}

	// not found

	return NULL;

	}

void CWsGraphic::CManager::Queue()

	{

	if(!IsActive())

		{

		GraphicMessageReady(&iStatus);

		SetActive();

		}

	}

void CWsGraphic::CManager::RunL()

   	{

   	if(0 < iStatus.Int())

   		{

   		// a message to fetch!

   		const TInt msgLen = iStatus.Int();

 		TPtr8 buf(NULL,0);

 		MWsGraphicMessageAlloc* allocator = NULL;

 		MWsGraphicMessageAlloc::MBuffer* theirBuf = NULL;

 		HBufC8* ourBuf = HBufC8::New(msgLen);

 		if(ourBuf)

 			{

 			CleanupStack::PushL(ourBuf);

 			buf.Set(ourBuf->Des());

 			}

 		else // try to see if the destination CWsGraphic can allocate for us

 			{

			const TInt handle = GraphicFetchHeaderMessage();

			CWsGraphic* dest = reinterpret_cast<CWsGraphic*>(handle & ~0x03);

 			// check if it's valid

 			if(KErrNotFound != iArray.Find(dest) && dest->iPimpl && dest->iPimpl->iExt)

 				{

 				// check if the client is able to alloc memory for us

 				allocator = dest->iPimpl->iExt->ObjectInterface<MWsGraphicMessageAlloc>();

 				if(allocator)

 					{

 					// allocate memory

 					theirBuf = allocator->Alloc(msgLen);

 					if(theirBuf)

 						{

 						CleanupStack::PushL(TCleanupItem(MWsGraphicMessageAllocRelease,theirBuf));

 						buf.Set(theirBuf->Buffer());

 						}

 					}

 				}

 			}

 		if(!ourBuf && !theirBuf)

 			{

 			GraphicMessageCancel();

 			GraphicAbortMessage(KErrNoMemory);

 			}

 		else

 			{

 			GetGraphicMessage(buf);

 			// decode header and body

 			RDesReadStream in(buf);

 			in.PushL();

 			const TInt header = in.ReadInt32L();

 			__ASSERT_COMPILE(sizeof(header) == sizeof(TInt32));

 			const TInt clientHandle = (header & ~0x03);

 			const TInt msgType = (header & 0x03);

 			const TPtr8 body = buf.MidTPtr(sizeof(header));

 			// dispatch

 			CWsGraphic* dest = (CWsGraphic*)clientHandle;

 			if(KErrNotFound != iArray.Find(dest))

 				{

 				switch(msgType)

 					{

 					case EWsGraphMessageTypeUser:

 						dest->HandleMessage(body);

 						break;

 					default:

 						Panic(EW32PanicGraphicInternal);

 					}

 				}

 			// done

 			in.Pop();

 			}

 		if(ourBuf)

 			{

 			CleanupStack::PopAndDestroy(ourBuf);

 			}

 		else if(theirBuf)

 			{

 			CleanupStack::PopAndDestroy(theirBuf);

 			}

 		// done, wait for next message

 		Queue();

 		}

 	}

void CWsGraphic::CManager::DoCancel()

	{

	GraphicMessageCancel();

	}

TInt CWsGraphic::CManager::GraphicCompare(const CWsGraphic& aFirst,const CWsGraphic& aSecond)

/** Compares two graphics for id equality

@internalComponent

@released

*/	{

	return aFirst.Id().Compare(aSecond.Id());

	}

void CWsGraphic::CManager::ScheduleFlush()

/** Request to schedule flush when idle

@internalComponent

@released

*/

	{

	if (iFlushScheduled)

		return;

	iFlushScheduled = ETrue;

	iFlusher->Start(TCallBack(CWsGraphic::CManager::FlushOnIdle,this));

	}

TInt CWsGraphic::CManager::FlushOnIdle(TAny* aArg)

/** Flush buffer when idle and there is outstanding data in it

@internalComponent

@released

*/

	{

	CWsGraphic::CManager* mgr = reinterpret_cast<CWsGraphic::CManager*>(aArg);

	if (mgr)

		{

		mgr->iFlushScheduled = EFalse;

		if (mgr->iBuffer && !mgr->iBuffer->IsEmpty())

			mgr->iBuffer->Flush();

		}

	return 0; // complete

	}

// CWsGraphic::CPimpl \\\\\\\\\\\\\\\\\\\\\\\\

CWsGraphic::CPimpl::CPimpl(CWsGraphic& aGraphic):

	iGraphic(aGraphic), iId(TWsGraphicId::EUninitialized)

	{

	}

CWsGraphic::CPimpl::~CPimpl()

	{

	if(iManager)

		{

		iManager->Dec();

		}

	}

void CWsGraphic::CPimpl::ConstructL()

	{

	iManager = CManager::StaticL();

	iManager->Inc();

	iBuffer = iManager->Buffer();

	}

TInt CWsGraphic::CPimpl::WriteCreateGraphic(TWsClCmdCreateGraphic& aCreateGraphic,const TDesC8& aData,TInt aWsHandle) const

/** Writes the CreateGraphic message to the server.  If the data will not fit in the buffer, uses remote-read

	@internalComponent @released */

	{

	aCreateGraphic.iDataLen = aData.Size();

	aCreateGraphic.iRemoteReadData = ((aData.Size()+sizeof(aCreateGraphic))>(TInt)(iBuffer->BufferSize()-sizeof(TWsCmdHeader)));

	if(aCreateGraphic.iRemoteReadData)

		{

		return iBuffer->WriteReplyByProvidingRemoteReadAccess(aWsHandle,EWsClOpCreateGraphic,&aCreateGraphic,sizeof(aCreateGraphic),&aData);

		}

	else if(aCreateGraphic.iDataLen)

		{

		return iBuffer->WriteReplyWs(&aCreateGraphic,sizeof(aCreateGraphic),aData.Ptr(),aData.Size(),EWsClOpCreateGraphic);

		}

	else

		{

		return iBuffer->WriteReplyWs(&aCreateGraphic,sizeof(aCreateGraphic),EWsClOpCreateGraphic);

		}

	}

// CWsGraphic \\\\\\\\\\\\\\\\\\\\\\\\

/** 

Default Constructor.

*/

EXPORT_C CWsGraphic::CWsGraphic()

	{

	}

/**

Destructor.

*/

EXPORT_C CWsGraphic::~CWsGraphic()

	{

	Destroy();

	delete iPimpl;

	}

/**

Completes construction of the baseclass. All the overloaded BaseConstructL() methods

should invoke this method to complete the construction of the baseclass.

*/

void CWsGraphic::BaseConstructL()

	{

	iPimpl = new(ELeave) CPimpl(*this);

	iPimpl->ConstructL();