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

// Window redraw code, three sorts of redrawing are supported

// CRedrawMsgWindow handles it via sending a redraw message to the client

// 

//

#include "redrawmsgwindow.h"

#include "gc.h"

#include "playbackgc.h"

#include "inifile.h"

#include "rootwin.h"

#include "wstop.h"

#include "ANIM.H"

#include "EVQUEUE.H"

#include <s32mem.h>

#include <gdi.h>

#include "panics.h"

#include "rootwin.h"

#include "EVENT.H"

#include "wsfont.h"

#include <graphics/wsgraphicdrawerinterface.h>

#include "../debuglog/DEBUGLOG.H"

const TUint KDrawBufferGranularity = 240;

const TInt KRedrawRegionGranularity = 8;

const TInt KReadBufferMaxLen=0x100;

const TInt KRegionCompressThreshold = 6; // number of rectangles in region at which we try to compress it

/** Max number of non-redraw segments allowed before starting to throw away the oldest */

const TInt KNonRedrawSegMaxLimit = 16;

/** The number of non-redraw segments to spare from deletion once their number 

    have grown beyond KNonRedrawSegMaxLimit */

const TInt KNonRedrawSegThreshold = 8;

TInt CWsRedrawMsgWindow::iNonRedrawAgeLimit = 0;

CWsRedrawMsgWindow::TAtomicityType CWsRedrawMsgWindow::iAtomicity = ENoAtomicity;

#if defined(__WINS__) && defined(_DEBUG)

#   include "offscreenbitmap.h"

#	define DEBUGOSB { CWsOffScreenBitmap * ofb = Screen()->OffScreenBitmap(); if (ofb) ofb->Update(); }

#else

#	define DEBUGOSB

#endif

#ifndef _DEBUG

#define LOG_WINDOW_REDRAW_START(wswin,region)

#define LOG_WINDOW_REDRAW_END(wswin)

#define LOG_REDRAW_SEGMENT(segmentIndex,segmentType) 

#define LOG_REDRAW_SEGMENT_REGION(region)

#define LOG_PLAYBACK_GC_COMMAND(opcode,data)

#else

#define LOG_WINDOW_REDRAW_START(wswin,region) LogDrawCommandsStart(wswin,region)

#define LOG_WINDOW_REDRAW_END(wswin) LogDrawCommandsEnd(wswin)

#define LOG_REDRAW_SEGMENT(segmentIndex,segmentType) LogRedrawSegment(segmentIndex, segmentType)

#define LOG_REDRAW_SEGMENT_REGION(region) {if(wsDebugLog){ LogRegion(region);}}

#define LOG_PLAYBACK_GC_COMMAND(opcode,data)    {if (wsDebugLog) {wsDebugLog->Command(WS_HANDLE_GC, opcode, data, NULL);}}

extern CDebugLogBase *wsDebugLog;

class TTruncateOverflow : public TDesOverflow

	{

	public:

	virtual void Overflow(TDes&) {};

	};

LOCAL_C void LogRedrawSegment(TUint aSegmentIndex, CWsRedrawMsgWindow::TRedrawSegmentType aSegmentType)

	{

	if (wsDebugLog)

		{

		TBuf<LogTBufSize> log;

		TTruncateOverflow overflow;

		_LIT(KLogRedrawSegment, ">> CRedrawSegment[%d] ");

		log.AppendFormat(KLogRedrawSegment, &overflow, aSegmentIndex);

		_LIT(KLogRedrawSegmentPending, "Pending");

		_LIT(KLogRedrawSegmentRedraw, "Redraw");

		_LIT(KLogRedrawSegmentNonRedraw, "NonRedraw");

		switch(aSegmentType)

			{

			case CWsRedrawMsgWindow::ESegmentTypePendingRedraw :

				log.AppendFormat(KLogRedrawSegmentPending, &overflow);

				break;

			case CWsRedrawMsgWindow::ESegmentTypeRedraw :

				log.AppendFormat(KLogRedrawSegmentRedraw, &overflow);

				break;

			case CWsRedrawMsgWindow::ESegmentTypeNonRedraw :

				log.AppendFormat(KLogRedrawSegmentNonRedraw, &overflow);

			break;

			default :

				{

				}

			}

		wsDebugLog->MiscMessage(CDebugLogBase::ELogEverything, log);

		}

	}

LOCAL_C void LogRegion(const TRegion* aRegion)

	{

	TBuf<LogTBufSize> log;

	TTruncateOverflow overflow;

	TInt rectCount = (aRegion == NULL ? 0 : aRegion->Count());

	log.AppendFormat(_L("region [%d,"), &overflow, rectCount);

	if (rectCount > 0)

		{

		const TRect* rectangles = aRegion->RectangleList();

		TBuf<1> comma;

		for (TInt ii = 0; ii < rectCount; ii++)

			{

			TRect current = rectangles[ii];

			log.AppendFormat(_L("%S{{%d,%d},{%d,%d}}"), &overflow, &comma,

	                         current.iTl.iX,current.iTl.iY,current.iBr.iX,current.iBr.iY);

			comma = _L(",");

			}

		}

	else

		{

		log.AppendFormat(_L("NULL"), &overflow);

		}

	log.AppendFormat(_L("]"), &overflow);

	wsDebugLog->MiscMessage(CDebugLogBase::ELogEverything, log);

	}

LOCAL_C void LogDrawCommandsStart(const CWsWindow* aWsWin, const TRegion* aRegion)

	{

	if (wsDebugLog)

		{

		_LIT(KLogDrawCommandsStart, ">> CWsRedrawMsgWindow::DrawCommandsL() [%S][app %d] RWindow[%d]");

		const TDesC& clientName = aWsWin->WsOwner()->Client().FullName();

		TBuf<LogTBufSize> log;

		TTruncateOverflow overflow;

		log.AppendFormat(KLogDrawCommandsStart, &overflow, &clientName, aWsWin->WsOwner()->ConnectionHandle(), aWsWin->LogHandle());

		wsDebugLog->MiscMessage(CDebugLogBase::ELogEverything, log);

		LogRegion(aRegion);

		}

	}

LOCAL_C void LogDrawCommandsEnd(const CWsWindow* aWsWin)

	{

	if (wsDebugLog)

		{

		_LIT(KLogDrawCommandsEnd, "<< CWsRedrawMsgWindow::DrawCommandsL() [%S][app %d] RWindow[%d]");

		const TDesC& clientName = aWsWin->WsOwner()->Client().FullName();

		TBuf<LogTBufSize> log;

		TTruncateOverflow overflow;

		log.AppendFormat(KLogDrawCommandsEnd, &overflow, &clientName, aWsWin->WsOwner()->ConnectionHandle(), aWsWin->LogHandle());		

		wsDebugLog->MiscMessage(CDebugLogBase::ELogEverything, log);

		}

	}

#endif

//

// Redraw windows //

//

CWsRedrawMsgWindow::CRedrawSegment::CRedrawSegment()

	{

	}

CWsRedrawMsgWindow::CRedrawSegment* CWsRedrawMsgWindow::CRedrawSegment::NewLC(const TRect& aRect, TRedrawSegmentType aNewRegionType)

	{

	CRedrawSegment* self = new (ELeave) CRedrawSegment();

	CleanupStack::PushL(self);

	self->ConstructL(aRect, aNewRegionType);

	return self;

	}

void CWsRedrawMsgWindow::StaticInitL()

	{

	_LIT(KNonRedrawAgeLimit, "NONREDRAWAGELIMIT");

	const TInt KDefaultNonRedrawAgeLimit = 1000000;

	if (!WsIniFile->FindVar(KNonRedrawAgeLimit, iNonRedrawAgeLimit))

		iNonRedrawAgeLimit = KDefaultNonRedrawAgeLimit;

	_LIT(KAtomicRedraws,"ATOMICREDRAWS");

	_LIT(KAtomicSegment,"SEGMENT");

	_LIT(KAtomicWindow,"WINDOW");

	TPtrC atomicityTypeString;

	if (WsIniFile->FindVar(KAtomicRedraws,atomicityTypeString))

		{

		if(atomicityTypeString.CompareF(KAtomicSegment)==0 || atomicityTypeString.Length()==0)

			iAtomicity = ESegment;

		else if(atomicityTypeString.CompareF(KAtomicWindow)==0)

			iAtomicity = EWindow;

		}

	}

void CWsRedrawMsgWindow::CRedrawSegment::ReleaseFontsAndBitmaps()

	{

	// release Bitmap and Font handles

	TInt count = iWsBitmapArray.Count();

	TInt ii;

	for (ii = count - 1; ii >= 0; ii--)

		{

		iWsBitmapArray[ii]->DecRefCount();

		iWsBitmapArray.Remove(ii);

		}

	count = iWsFontArray.Count();

	for (ii = count - 1; ii >= 0; --ii)

		{

		CWsFontCache::Instance()->ReleaseFont(iWsFontArray[ii]);

		iWsFontArray.Remove(ii);

		}

	count = iFbsBitmapArray.Count();

	for(ii = count - 1 ; ii >= 0; ii--)

		{

		delete iFbsBitmapArray[ii];

		iFbsBitmapArray.Remove(ii);

		}

	}

/* Set new rectangle and region type for initial or reset redraw region

 @leave KErrNoMemory no memory to update region details

 */

void CWsRedrawMsgWindow::CRedrawSegment::ConstructL(const TRect& aRect, TRedrawSegmentType aNewRegionType)

	{

	iDrawCommands = CBufSeg::NewL(KDrawBufferGranularity);

	iCreationTime.UniversalTime();

	iRegion.AddRect(aRect);

	if (iRegion.CheckError())

		{

		User::Leave(KErrNoMemory);

		}

	iRedrawSegmentType = aNewRegionType;

	}

CWsRedrawMsgWindow::CRedrawSegment::~CRedrawSegment()

	{

	delete iDrawCommands;

	iRegion.Close();

	// Release Font and Bitmap handles, close arrays

	ReleaseFontsAndBitmaps();

	iFbsBitmapArray.Close();

	iWsBitmapArray.Close();

	iWsFontArray.Close();

	iDrawerArray.Close();

	}

void CWsRedrawMsgWindow::WindowClosing()

	{

	iWsWin->WsOwner()->RedrawQueue()->RemoveInvalid(this);

	}

TInt CWsRedrawMsgWindow::CRedrawSegment::SizeInBytes() const

	{

	TInt size = sizeof(CWsRedrawMsgWindow::CRedrawSegment);

	size += iDrawCommands->Size();

	size += iFbsBitmapArray.Count() * sizeof(CFbsBitmap);

	size += iWsBitmapArray.Count() * sizeof(DWsBitmap);

	size += iWsFontArray.Count() * sizeof(CWsFbsFont);

	size += iDrawerArray.Count() * sizeof(TGraphicDrawerId);

	return size;

	}

CWsRedrawMsgWindow::CWsRedrawMsgWindow(CWsWindow *aWin)

	:CWsWindowRedraw(aWin), iBackColor(aWin->RootWindow()->DefaultBackgroundColor()), iFlags(EBackgroundClear|EStoringEntireWindow),

	iRedrawSegments(KRedrawRegionGranularity),

	iCurrentSegment(0),

	iOSBStatus(ETrue)

	{

	}

void CWsRedrawMsgWindow::ConstructL()

	{

	CWsWindowRedraw::ConstructL();

	Invalidate(&WsWin()->Rel());

	iWsWin->WsOwner()->RedrawQueue()->ReCalcOrder();

	}

CWsRedrawMsgWindow::~CWsRedrawMsgWindow()

	{

	WS_ASSERT_DEBUG(iMemoryLock == 0, EWsPanicMemoryLock);

	RemoveFromRedrawQueueIfEmpty();

	iInvalid.Close();

	iLocalRedrawRegion.Close();

	iRedrawSegments.ResetAndDestroy();

	iCurrentSegment=NULL;

	}

/**

These three functions actually check for a value they have already asserted on.  This is intentional.

*/

void CWsRedrawMsgWindow::ExpandCommandBufferL(TInt aLength)

	{

	WS_ASSERT_DEBUG(iCurrentSegment != NULL, EWsPanicRedrawSegmentsInvalidState);

	if (iCurrentSegment)

		{

		// need more space?

		if (iCurrentSegment->iCurrentCommandBufferWritePos + aLength > iCurrentSegment->iDrawCommands->Size())

			{

			iCurrentSegment->iDrawCommands->ResizeL(iCurrentSegment->iCurrentCommandBufferWritePos + aLength);

			}

		}

	}

void CWsRedrawMsgWindow::CommandBufferWrite(const TDesC8& aDes, TInt aLength)

	{

	WS_ASSERT_DEBUG(iCurrentSegment != NULL, EWsPanicRedrawSegmentsInvalidState);

	WS_ASSERT_DEBUG(iCurrentSegment->iCurrentCommandBufferWritePos + aLength <= iCurrentSegment->iDrawCommands->Size(), EWsPanicDrawCommandsInvalidState);

	if (iCurrentSegment)

		{

		iCurrentSegment->iDrawCommands->Write(iCurrentSegment->iCurrentCommandBufferWritePos, aDes, aLength);

		iCurrentSegment->iCurrentCommandBufferWritePos += aLength;

		}

	}

void CWsRedrawMsgWindow::CommandBufferWrite(const TAny* aPtr,TInt aLength)

	{

	WS_ASSERT_DEBUG(iCurrentSegment != NULL, EWsPanicRedrawSegmentsInvalidState);

	WS_ASSERT_DEBUG(iCurrentSegment->iCurrentCommandBufferWritePos + aLength <= iCurrentSegment->iDrawCommands->Size(), EWsPanicDrawCommandsInvalidState);

	if (iCurrentSegment)

		{

		iCurrentSegment->iDrawCommands->Write(iCurrentSegment->iCurrentCommandBufferWritePos, aPtr, aLength);

		iCurrentSegment->iCurrentCommandBufferWritePos += aLength;

		}

	}

/*------------------------------------------------------------------------------

  Description: Processes draw commands. These are received as opcodes.

 -----------------------------------------------------------------------------*/

TBool CWsRedrawMsgWindow::CommandL(TInt aOpcode, TWsWinCmdUnion &aCmd)

	{

	switch(aOpcode)

		{

		case EWsWinOpEnableOSB:

			iOSBStatus = ETrue;

			break;

		case EWsWinOpDisableOSB:

			iOSBStatus = EFalse;

			break;

		case EWsWinOpSetBackgroundColor:

			iBackColor = *aCmd.rgb;

			iFlags |= EBackgroundClear;

			break;

		case EWsWinOpSetNoBackgroundColor:

			iFlags &= ~EBackgroundClear;

			break;

		case EWsWinOpInvalidate:

			Invalidate(aCmd.rect);

			break;

		case EWsWinOpInvalidateFull:

			Invalidate();

			break;

		case EWsWinOpBeginRedraw:

			BeginRedraw(aCmd.rect);

			ValidateRect(aCmd.rect);

			break;

		case EWsWinOpBeginRedrawFull:

			BeginRedraw(NULL);

			ValidateRect(NULL);

			break;

		case EWsWinOpEndRedraw:

			EndRedraw();

			break;

		case EWsWinOpGetInvalidRegionCount:

			{				

			SetReply(iInvalid.Count());

			}

			break;

		case EWsWinOpGetInvalidRegion:

			{

			if ((*aCmd.Int) <= 0)

				OwnerPanic(EWservPanicInvalidRegionCount);

			if ((!iInvalid.CheckError()) && iInvalid.Count() == (*aCmd.Int))

				{

				CWsClient::ReplyBuf(iInvalid.RectangleList(),(*aCmd.Int) * sizeof(TRect));

				SetReply(EFalse);				

				}

			else

				SetReply(ETrue);

			}

			break;

		case EWsWinOpStoreDrawCommands:

			/* If the client asks us not to store commands, we still store the commands

			for the region of the window which can be seen through the parent, but

			won't attempt to obtain the entire window.

			*/

			if (*aCmd.Bool)

				{

				SetScope(EStoreEntireWindow);

				}

			else

				{

				// Clients that turn their redraw store off will still get one,

				// but it will only attempt to store the current viewport.

				SetScope(EStoreViewport);

				}

			break;

		case EWsWinOpHandleTransparencyUpdate:  // deprecated

		case EWsWinOpSetTransparencyBitmap:	    // deprecated

		case EWsWinOpSetTransparencyFactor:		// deprecated

		case EWsWinOpSetTransparencyBitmapCWs:  // deprecated

			break;    // do nothing.

		case EWsWinOpIsRedrawStoreEnabled:

			SetReply(ETrue);

			break;

		case EWsWinOpClearRedrawStore:

			DiscardStoredCommands();

			break;

		default:

			return(EFalse);

		}

	return(ETrue);

	}

/**

*/

void CWsRedrawMsgWindow::BeginRedraw(const TRect* aRect)

	{

	if(InRedraw())

		OwnerPanic(EWservPanicDrawCommandsInvalidState);

	iFlags|=EBeginEndRedraw;

	TRAPD(err,DoBeginRedrawL(aRect));

	DiscardStoredCommandsIfError(err);

	}

void CWsRedrawMsgWindow::DoBeginRedrawL(const TRect* aRect)

	{

	const TRect redrawRect = (aRect ? *aRect : TRect(WsWin()->Size()));

	if (redrawRect.IsEmpty())

		{

		//Skip empty rects since they are not added to the region

		iCurrentSegment = NULL;

		}

	else

		{

		CreateNewSegmentL(redrawRect, CWsRedrawMsgWindow::ESegmentTypePendingRedraw);

		if (iAtomicity==ENoAtomicity)

			PromoteLastPendingSegment();

		}

	}

void CWsRedrawMsgWindow::Invalidate(const TRect * aRect)

	{

    //The memory allocation in this function can trigger a call to ReleaseMemory(), which would

    //recursively call this function again. This would cause a memory leak. To avoid this

    //we call Lock() to block ReleaseMemory() from this object while executing this function.

    Lock();

	if (!aRect)

		{

		iInvalid.Clear();

		iInvalid.Copy(iWsWin->WindowArea());

		iInvalid.Offset(-iWsWin->Origin());

		}

	else if((!aRect->IsEmpty()) && aRect->IsNormalized())

		{

		iInvalid.AddRect(*aRect);

		iInvalid.Tidy();		

		}

	if (iWsWin->IsVisible())

		{

		QueueRedraw();

		iWsWin->WsOwner()->TriggerRedraw(); //wtf isn't the redrawq already scheduling itself?

		}

	Unlock();

	}

/**

If a draw command is received outside a begin/end redraw pair, then it is stored in a non-redraw

segment.  This function creates such a segment if it isn't already available.

*/

void CWsRedrawMsgWindow::HandleNonRedrawCommand(TWsGcOpcodes aOpcode)

	{

	// calling code should check the Window State

	WS_ASSERT_DEBUG(!InRedraw(), EWsPanicDrawCommandsInvalidState);

	// Attempting to draw part of a polygon in a new segment - only a very bad client can do this:

	TBool canCreate = !(aOpcode == EWsGcOpSegmentedDrawPolygonData || aOpcode == EWsGcOpDrawSegmentedPolygon);

	if ((!iCurrentSegment) && (!canCreate))

		{

		OwnerPanic(EWservPanicBadPolyData);

		}

	if (canCreate)

		AgeNonRedrawSegments();

	// If current redraw region is not for Non-Redraw drawing, add a region corresponding to the

	// full window to the redraw store.  Need to make sure that this is done 

	// before the AppendCommand, or bitmap/font handles are recorded, in StoreDrawCommandL

	TInt err = KErrNone;

	if ((!iCurrentSegment) || iCurrentSegment->iRedrawSegmentType != ESegmentTypeNonRedraw)

		{

		TRAP(err,CreateNewSegmentL(TRect(WsWin()->Size()), ESegmentTypeNonRedraw));

		}

	if (err != KErrNone)

		{

		Invalidate();

		}

	if(iWsWin->VisibleRegion().CheckError())

		iWsWin->Screen()->AddRedrawRegion(iWsWin->WindowArea());

	else if(iWsWin->VisibleRegion().Count())

		iWsWin->Screen()->AddRedrawRegion(iWsWin->VisibleRegion());

	else if(!iWsWin->HasBeenDrawnToScreen())

		CliWin()->ScheduleRegionUpdate(&iWsWin->VisibleRegion());

	}

/**

This function attempts to prevent non-redraw segments from growing indefinitely by requesting redraws 

and throwing away old ones.

*/

void CWsRedrawMsgWindow::AgeNonRedrawSegments()

  	{

	if (!iRedrawSegments.Count())

		return;