// Copyright (c) 2006-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:

//

#include "Graphics/WSGRAPHICMSGBUF.H"

#include "DrawSection.h"

#include "CommandBuffer.h"

#include "BitmapCache.h"

#include "FontsCache.h"

const TInt KBufferSize = 1024;

EXPORT_C CCommandBuffer* CCommandBuffer::NewL()

	{

	CCommandBuffer* buffer = new (ELeave) CCommandBuffer;

	CleanupStack::PushL(buffer);

	buffer->ConstructL();

	CleanupStack::Pop(buffer);

	return buffer;

	}

CCommandBuffer::CCommandBuffer()

	{

	}

EXPORT_C CCommandBuffer::~CCommandBuffer()

	{	

	iDrawSections.ResetAndDestroy();

	iDrawSections.Close();

	iBufReadStream.Close();

	iClippingRegion.Close();

	iBufRead = NULL;

	delete iRecordSegBuf;

	delete iBitmapCache;

	delete iFontCache;

	}

void CCommandBuffer::ConstructL()

	{

	iBitmapCache = new (ELeave)	CBitmapCache;

	iRecordSegBuf = CBufSeg::NewL(KBufferSize);

	iFontCache =  new (ELeave) CFontsCache;

	}

/**

Resets the entire commandbuffer.

*/

void CCommandBuffer::Reset()

	{

	if(iRecordSegBuf)

		iRecordSegBuf->Reset();

	iError =  KErrNone;	

	iOrigin = TPoint(0,0);

	iClippingRegion.Clear();

	iDrawSections.ResetAndDestroy();	

	}

/**

Externalizes commandbuffer sections into a format which makes it possible to send over IPC.

If ETrue is sent as a parameter to this method, the entire commandbuffer will be externalized,

otherwise only sections which has not been externalized before will be externalized. Note that if only

not externalized sections is asked for, the flag will be reset on that section so next call

to ExternalizeLC will not externalize that section.

@param aMsgBuf A buffer used to externalize the commandbuffer to.

@param aEntireBuffer If ETrue, the entire commandbuffer will be externalized, otherwise only sections which has not been externalized before.

*/

void CCommandBuffer::ExternalizeL(RWsGraphicMsgBuf& aMsgBuf, TBool aEntireBuffer)

	{

	// Add drawsections to aMsgBuf

	const TInt sectionCount = iDrawSections.Count();

	for(TInt j = 0; j < sectionCount; j++)	

		{

		CDrawSection* section = iDrawSections[j];

		if(aEntireBuffer || !section->HasBeenExternalized())

			{

			section->ExternalizeL(aMsgBuf);

			section->SetHasBeenExternalized(ETrue);

			}

		}

	}

/**

Internalizes the entire commandbuffer from buffer containing information about all drawsections and drawcommands.

@param aBuf A buffer containing information about all drawsections and drawcommands.

*/

EXPORT_C void CCommandBuffer::InternalizeL(const TDesC8& aBuf)

	{

	// Reset the commandbuffer

	iRecordSegBuf->Reset();

	InternalizeAppendL(aBuf);

	}

/**

Internalizes and appends from a buffer containing information about some drawsections and drawcommands.

@param aBuf A buffer containing information about some drawsections and drawcommands.

*/

EXPORT_C void CCommandBuffer::InternalizeAppendL(const TDesC8& aBuf)

	{

	// Reset the commandbuffer

	TWsGraphicMsgBufParser parser(aBuf);

	// Load drawsections

	const TInt count = parser.Count();

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

		{

		CDrawSection* drawSection = CDrawSection::NewL();;

		CleanupStack::PushL(drawSection);

		User::LeaveIfError(drawSection->LoadL(parser, i));

		iDrawSections.AppendL(drawSection);

		CleanupStack::Pop(drawSection);

		}

	// Tidy the iDrawSection array so completely blocked sections will be removed

	Tidy();

	}

/**

@return the current active clipping region of the commandbuffer.

*/	

EXPORT_C const TRegion& CCommandBuffer::ClippingRegion() const

	{

	return *iActiveMasterClippingRegion;

	}

/**

Prepares to record new drawcommands for a drawsection.

This method is called from CRemoteGc::Activate().

*/

void CCommandBuffer::Prepare(const TRect& aDrawRect)

	{

	iDrawSectionRect = aDrawRect;

	iError = KErrNone;

  	if(iRecordSegBuf)

  		iRecordSegBuf->Delete(0, iRecordSegBuf->Size()); // Reset record buffer

  	else

  		TRAP(iError, iRecordSegBuf = CBufSeg::NewL(KBufferSize));

	}

/**

Finishes the recording of drawcommands for a drawsection. 

This method is called from CRemoteGc::Deactivate().

@param aDrawRect The drawrect of the recorded drawcommands.

@param aBoundingRect The boundingrect of the recorded drawcommands.

*/

TInt CCommandBuffer::Finish(const TRect& aDrawRect, const TRect& aBoundingRect, TBool aHasBitmapCommand)

	{

	// If some error occured during the recording of this section, dont add the section

	if(!iError)

		{

		CDrawSection* drawSection = NULL;

		TRAP(iError, drawSection = CDrawSection::NewL(aDrawRect, aBoundingRect, aHasBitmapCommand))

		if(iError)

			return iError;

		// If boundingRect is empty clear the drawcommands added

		if(aBoundingRect.IsEmpty())

			iRecordSegBuf->Delete(0, iRecordSegBuf->Size());

		iRecordSegBuf->Compress();

		drawSection->SetBuffer(iRecordSegBuf); //Takes ownership of the memory allocated by iRecordSegBuf			

		iRecordSegBuf = NULL;		

		if(CheckForDuplicate(*drawSection))

			{

			delete drawSection;

			return KErrAlreadyExists;

			}

		iError = iDrawSections.Append(drawSection);

		if(iError)

			delete drawSection;

		else

			{

			Tidy();

			if(iDrawSections.Count() == 0 || AllSectionsExternalized())

				return KErrGeneral;

			}

		}

	return iError;

	}

/**

Remove drawsections that is completely blocked by another drawsection. 

*/

void CCommandBuffer::Tidy()

	{

	RRegion region;

	TInt count = 0;

	for(TInt i = 0; i < (count = iDrawSections.Count()); i++)

		{		

		TRect rect1 = iDrawSections[i]->DrawRect();

		region.Clear();

		region.AddRect(rect1);

		for(TInt j = i + 1; j < count; j++)

			{

			TRect rect2 = iDrawSections[j]->DrawRect();

			region.SubRect(rect2);

			}

		if(region.IsEmpty())

			{

			delete iDrawSections[i];

			iDrawSections.Remove(i--);

			}

		}

	region.Close();

	}

/** 

@return ETrue if all sections in the commandbuffer have been externalized, otherwise EFalse. 

*/ 

TBool CCommandBuffer::AllSectionsExternalized() const 

	{ 

	const TInt count = iDrawSections.Count(); 

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

		{ 

		if(!iDrawSections[i]->HasBeenExternalized()) 

			return EFalse; 

		} 

	return ETrue; 

	} 

/**

Checks if there exists any duplicate of aDrawSection already in the iDrawSection array.

@param aDrawSection The drawsection to look for a duplicate of.

@return ETrue if a duplicate was found, otherwise EFalse.

*/

TBool CCommandBuffer::CheckForDuplicate(const CDrawSection& aDrawSection) const

	{

	const TInt count = iDrawSections.Count();

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

		{

		if(!iDrawSections[i]->IsIdentical(aDrawSection))

			continue;

		// Check if there is some drawsection that overlaps the section we found identical, 

		// if that is the case it is not a duplicate

		for(TInt j = i + 1; j < count; j++)

			{

			TRect compareRect = iDrawSections[j]->DrawRect();

			if(aDrawSection.DrawRect().Intersects(compareRect)) 

				return EFalse; //Found a drawrect that overlapped, no duplicate exists then

			}

		// Found duplicate

		return ETrue;

		}

	return EFalse;

	}

/**

Updates the clippingregion for a specific drawsection.

@param aDrawSectionIndex The index in iDrawSections of the drawsection to update the clippingregion for.

@param aBitmapContext The bitmapcontext to set the new clippingregion on.

*/

void CCommandBuffer::UpdateClippingRegion(TInt aDrawSectionIndex)

	{

	__ASSERT_DEBUG(aDrawSectionIndex < iDrawSections.Count(), User::Invariant());

	iDrawSectionClippingRegion.Clear();

	if (iMasterClippingRegion)

		{

		iDrawSectionClippingRegion.Copy(*iMasterClippingRegion);

		}

	else

		{

		TRect rect = iMasterClippingRect;

		rect.Move(iMasterOrigin);

		iDrawSectionClippingRegion.AddRect(rect);

		}

	const TInt count = iDrawSections.Count();

	for(TInt i = aDrawSectionIndex + 1; i < count; ++i)

		{

		TRect rect = iDrawSections[i]->DrawRect();

		rect.Move(iMasterOrigin);

		iDrawSectionClippingRegion.SubRect(rect);

		}

	if (iDrawSectionClippingRegion.CheckError())

		iActiveMasterClippingRegion = iMasterClippingRegion;

	else

		iActiveMasterClippingRegion = &iDrawSectionClippingRegion;

	}

/**

Writes data of a specific length to the recordbuffer.

@param aPtr The data to write.

@param aLength The length of the data to write.

*/

void CCommandBuffer::Write(const TUint8* aPtr, TUint aLength)

	{

	if(iError)

		return;

	TRAP(iError, iRecordSegBuf->InsertL(iRecordSegBuf->Size(), aPtr, aLength))

	if(iError)

		return;

	}

/**

Writes text to the recordbuffer.

@param aText The text to write to the recordbuffer.

*/

void CCommandBuffer::WriteText(const TDesC8 &aText)

	{

	if(iError)

		return;

	// Append the total size of the text

	Write<TInt>(aText.Size());

	if(iError)

		return;			

	TRAP(iError, DoWriteTextL(aText));	

	}

/**

Writes text to the recordbuffer.

@param aText The text to write to the recordbuffer.

*/

void CCommandBuffer::WriteText(const TDesC16 &aText)

	{

	if(iError)

		return;

	// Append the total size of the text

	Write<TInt>(aText.Size());

	if(iError)

		return;			

	TPtrC8 textPtr(reinterpret_cast<const TUint8*>(aText.Ptr()),aText.Size());

	TRAP(iError, DoWriteTextL(textPtr));	

	}

/**

Writes text to the recordbuffer.

@param aText The text to write to the recordbuffer.

*/	

void CCommandBuffer::DoWriteTextL(const TDesC8 &aText)

	{

	iRecordSegBuf->InsertL(iRecordSegBuf->Size(), aText, aText.Size());		

	}

/**

Reads data with a specific length from iBufReadStream.

@param aPtr The read data is written to this paramenter.

@param aLength The length of the data to be read.

*/

void CCommandBuffer::ReadL(TUint8* aPtr, TUint aLength)

	{

	iBufReadStream.ReadL(aPtr, aLength);

	}

/**

Reads text from iBufReadStream.

@param aText The read text is put into this 8-bit buffer.

*/	

void CCommandBuffer::ReadTextLC(TPtrC8& aText)

	{

	DoReadTextLC(aText,EFalse);

	}

/**

Reads text from iBufReadStream.

@param aText The read text is put into this 16-bit buffer.

*/	

void CCommandBuffer::ReadTextLC(TPtrC16& aText)

	{

	TPtrC8 text8;

	DoReadTextLC(text8,ETrue);

	aText.Set(reinterpret_cast<const TUint16*>(text8.Ptr()),text8.Size()/2);

	}

/**

Reads text from iBufReadStream; used by ReadTextLC

@internalComponent

*/	

void CCommandBuffer::DoReadTextLC(TPtrC8& aText,TBool a16Bit)

	{

	ASSERT(iBufRead);

	TInt textSize;

	ReadL<TInt>(textSize); // Read the length of the text

	if(0 > textSize)

		{

		User::Leave(KErrArgument);

		}

	// attempt to do it inline

	const TInt pos = iBufReadStream.Source()->TellL(MStreamBuf::ERead).Offset();

	if(!a16Bit || !(pos & 1)) // check 16bit-aligned

		{

		const TPtrC8 remaining = iBufRead->Ptr(pos);

		if(remaining.Size() >= textSize) // can do inline!

			{

			CleanupStack::PushL((TAny*)NULL); // have to push something

			iBufReadStream.Source()->SeekL(MStreamBuf::ERead,textSize);

			aText.Set(remaining.Ptr(),textSize);

			return;

			}

		}

	// have to copy into a continuous segment

	HBufC8* buf = HBufC8::NewLC(textSize);

	TPtr8 textPtr8(buf->Des());

	iBufReadStream.ReadL(textPtr8,textSize);

	aText.Set(*buf);

	}

/**

Compares the commands in one buffer to those in another

@param aBuffer The buffer to compare to

@return ETrue if they are an exact match, EFalse otherwise

*/

EXPORT_C TBool CCommandBuffer::IsIdentical(const CCommandBuffer & aBuffer) const

	{

	for(TInt i = 0; i < iDrawSections.Count(); ++i)

		{

		if (!iDrawSections[i]->IsIdentical(*aBuffer.iDrawSections[i]))

			return EFalse;

		}

	return ETrue;

	}

/**

Draws drawcommands that are within a specific rect to a specific position.

This function is deprecated use the other overload

@param aPosition Draws the drawcommands to this position.

@param aDrawRect Draws only drawcommands that are within this rect.

@param aBitmapContext The bitmapcontext to draw to.

@deprecated

@publishedPartner

*/

EXPORT_C TInt CCommandBuffer::Play(const TPoint& aPosition, const TRect& aDrawRect, const MWsGraphicResolver& aWsGraphicResolver, CBitmapContext& aContext)

	{

	iMasterOrigin = aPosition;

	iOrigin = TPoint(0,0); // Need to save this to be able to make Reset not affect Origin beacuse that is how CWsGc works.

	aContext.SetOrigin(iMasterOrigin);

	iMasterClippingRect = aDrawRect;

	iMasterClippingRegion=0;

	TRAPD(errMess, DoPlayL(aWsGraphicResolver, aContext));		

	return errMess;

	}

/**

Draws drawcommands that are within a specific rect to a specific position.

@param aMasterOrigin The origin relative to which all draw commands will be drawn

@param aMasterClippingRegion The region to which all draw commands are clipped

@param aMasterClippingRect The rectangle to which all draw commands are clipped

@param aWsGraphicResolver Any DrawWsGraphic commands will use this to draw themselves

@param aContext The bitmap context to draw to

@publishedPartner

*/

EXPORT_C TInt CCommandBuffer::Play(const TPoint& aMasterOrigin, const TRegion * aMasterClippingRegion, const TRect& aMasterClippingRect, const MWsGraphicResolver& aWsGraphicResolver, CBitmapContext& aContext)

	{

	iMasterOrigin = aMasterOrigin;

	iMasterClippingRegion = aMasterClippingRegion;

	iMasterClippingRect = aMasterClippingRect;

	Reset(aContext);

	TRAPD(errMess, DoPlayL(aWsGraphicResolver, aContext));		

	return errMess;

	}

/**

	@internalTechnology

*/

EXPORT_C TInt CCommandBuffer::Play(const TPoint& /*aOffset*/, const TRegion* /*aClippingRegion*/, const TRect& /*aSourceRect*/, const MWsGraphicResolver& /*aWsGraphicResolver*/, MWsGraphicsContext& /*aGraphicsContext*/) //Stub implementation to maintain compatibility with NGA Window Server

	{

	ASSERT(0);

	return KErrNotSupported;

	}

/**

	@internalTechnology

*/

EXPORT_C TInt CCommandBuffer::Play(const TPoint& /*aOffset*/, const TRegion* /*aClippingRegion*/, const TRect& /*aSourceRect*/, RWsSession& /*aWsSession*/, CWindowGc& /*aWindowGc*/) //Stub implementation to maintain compatibility with NGA Window Server

	{

	ASSERT(0);

	return KErrNotSupported;

	}

/**

Draws drawcommands that are within a specific rect.

@param aDrawRect Draws only drawcommands that are within this rect.

@param aBitmapContext The bitmapcontext to draw to.

*/

void CCommandBuffer::DoPlayL(const MWsGraphicResolver& aWsGraphicResolver, CBitmapContext& aBitmapContext)

	{

	const TInt sections = iDrawSections.Count();

	if(sections == 0)

		User::Leave(KErrEof);

	iBitmapCache->BeginUpdate();