sl@0: // Copyright (c) 1996-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: //
sl@0: 
sl@0: // Window server redraw queue handling
sl@0: //
sl@0: #include <e32std.h>
sl@0: #include "server.h"
sl@0: #include "rootwin.h"
sl@0: #include "windowgroup.h"
sl@0: #include "walkwindowtree.h"
sl@0: #include "EVQUEUE.H"
sl@0: #include "panics.h"
sl@0: #include "wstop.h"
sl@0: 
sl@0: const TInt KGranularity = 10;
sl@0: 
sl@0: void TWsRedrawEvent::SetHandle(TUint aHandle)
sl@0: 	{
sl@0: 	iHandle=aHandle;
sl@0: 	}
sl@0: 
sl@0: void TWsRedrawEvent::SetRect(TRect aRect)
sl@0: 	{
sl@0: 	iRect=aRect;
sl@0: 	}
sl@0: 
sl@0: TWsRedrawEvent CRedrawQueue::iNullRedrawEvent;
sl@0: 
sl@0: CRedrawQueue::CRedrawQueue(CWsClient *aOwner) : CEventBase(aOwner)
sl@0: 	{
sl@0: 	__DECLARE_NAME(_S("CRedrawQueue"));
sl@0: 	}
sl@0: 
sl@0: void CRedrawQueue::ConstructL()
sl@0: 	{
sl@0: 	iRedrawTrigger=EFalse;
sl@0: 	iRedraws=new(ELeave) CArrayFixSeg<TRedraw>(KGranularity);
sl@0: 	iKeyPriority=new(ELeave) TKeyArrayFix(_FOFF(TRedraw,iPriority),ECmpTUint32);
sl@0: 	iKeyWindow=new(ELeave) TKeyArrayFix(_FOFF(TRedraw,iRedraw),ECmpTUint32);
sl@0: 	Mem::FillZ(&iNullRedrawEvent,sizeof(iNullRedrawEvent));
sl@0: 	}
sl@0: 
sl@0: CRedrawQueue::~CRedrawQueue()
sl@0: 	{
sl@0: 	delete iRedraws;
sl@0: 	delete iKeyPriority;
sl@0: 	delete iKeyWindow;
sl@0: 	}
sl@0: 
sl@0: void CRedrawQueue::ReCalcOrder()
sl@0: 	{
sl@0: 	const TInt redrawsCount=iRedraws->Count();
sl@0: 	for(TInt index=0;index<redrawsCount;index++)
sl@0: 		{
sl@0: 		TRedraw *redraw=&iRedraws->At(index);
sl@0: 		redraw->iPriority=static_cast<CWsClientWindow*>(redraw->iRedraw->WsWin())->RedrawPriority();
sl@0: 		}
sl@0: 	iRedraws->Sort(*iKeyPriority);
sl@0: 	}
sl@0: 
sl@0: void CRedrawQueue::AddInvalid(CWsWindowRedraw *aRedrawWin) 
sl@0: //
sl@0: // Add a window to the update list.
sl@0: //
sl@0: 	{
sl@0: 	TInt index;
sl@0: 	TRedraw redraw;
sl@0: 
sl@0: 	redraw.iRedraw=aRedrawWin;
sl@0: 	if (iRedraws->Find(redraw,*iKeyWindow,index)!=0)
sl@0: 		{
sl@0: 		redraw.iPriority=static_cast<CWsClientWindow*>(aRedrawWin->WsWin())->RedrawPriority();
sl@0: 		TRAPD(err,iRedraws->InsertIsqAllowDuplicatesL(redraw,*iKeyPriority));
sl@0: 		if (err!=KErrNone)
sl@0: 			{
sl@0: 			WS_ASSERT_DEBUG(err==KErrNoMemory,EWsPanicRedrawQueueError);
sl@0: 			iAllocError=ETrue;
sl@0: 			}
sl@0: 		iRedrawTrigger=ETrue;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CRedrawQueue::DeleteFromQueue(TInt aIndex)
sl@0: 	{
sl@0: 	iRedraws->Delete(aIndex,1);
sl@0: 
sl@0: 	//We are certain we will need iRedraws again, so it would be silly to compress away the last KGranularity slots.
sl@0: 	const TInt count = iRedraws->Count();
sl@0: 	if((count >= KGranularity) && (count % KGranularity == 0))
sl@0: 		{
sl@0: 		iRedraws->Compress();
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void CRedrawQueue::RemoveInvalid(CWsWindowRedraw *aRedrawWin)
sl@0: //
sl@0: // remove the window from the invalid window list.
sl@0: // harmless to call if the window is not in the list.
sl@0: //
sl@0: 	{
sl@0: 	TInt index;
sl@0: 	TRedraw redraw;
sl@0: 
sl@0: 	redraw.iRedraw=aRedrawWin;
sl@0: 	redraw.iPriority=0;
sl@0: 	if ((iRedraws->Find(redraw,*iKeyWindow,index))==KErrNone)
sl@0: 		DeleteFromQueue(index);
sl@0: 	}
sl@0: 
sl@0: TBool CRedrawQueue::TriggerRedraw()
sl@0: //
sl@0: // Trigger any pending redraw messages in the queue
sl@0: // Returns ETrue if a redraw was sent, EFalse if not.
sl@0: //
sl@0: 	{
sl@0: 	TBool ret=EFalse;
sl@0: 	if (iRedrawTrigger)
sl@0: 		{
sl@0: 		iRedrawTrigger=EFalse;
sl@0: 		if (!iEventMsg.IsNull() && (iRedraws->Count()>0 || iAllocError))
sl@0: 			{
sl@0: 			SignalEvent();
sl@0: 			ret=ETrue;
sl@0: 			}
sl@0: 		}
sl@0: 	return(ret);
sl@0: 	}
sl@0: 
sl@0: void CRedrawQueue::EventReady(const RMessagePtr2& aEventMsg)
sl@0: //
sl@0: // Queue a read of an event from the queue
sl@0: //
sl@0: 	{
sl@0: 	CEventBase::EventReady(aEventMsg);
sl@0: 	iRedrawTrigger=ETrue;
sl@0: 	TriggerRedraw();
sl@0: 	}
sl@0: 
sl@0: TBool CRedrawQueue::FindOutstandingRedrawEvent(CWsWindowRedraw& aRedraw, TWsRedrawEvent& aEvent)
sl@0: 	{
sl@0: 	TRect rect;
sl@0: 	if (aRedraw.GetRedrawRect(rect))
sl@0: 		{
sl@0: 		aEvent.SetRect(rect);
sl@0: 		aEvent.SetHandle(aRedraw.WsWin()->ClientHandle());
sl@0: 		CEventBase::GetData(&aEvent,sizeof(aEvent));
sl@0: 		return ETrue;
sl@0: 		}
sl@0: 	return EFalse;
sl@0: 	}
sl@0: 
sl@0: TBool CRedrawQueue::FindWindowNeedingRedrawEvent(TWsRedrawEvent& aEvent)
sl@0: 	{
sl@0: #if defined(_DEBUG)
sl@0: 	CWsWindowRedraw* previousRedraw = NULL;
sl@0: #endif
sl@0: 	// search all screens
sl@0: 	TInt invalidWindows = 0;
sl@0: 	for (TInt screenNo = 0; screenNo < CWsTop::NumberOfScreens(); ++screenNo)
sl@0: 		{
sl@0: 		const CScreen* screen = CWsTop::Screen(screenNo);
sl@0: 		WS_ASSERT_ALWAYS(screen, EWsPanicNoScreen);
sl@0: 		CWsRootWindow* rootWindow = screen->RootWindow();
sl@0: 		for (CWsWindowGroup *groupWin = rootWindow->Child(); groupWin; groupWin = groupWin->NextSibling())
sl@0: 			{
sl@0: 			if (groupWin->WsOwner() == iWsOwner)
sl@0: 				{
sl@0: 				CWsWindowRedraw* redrawWin = NULL;
sl@0: 				// use a window tree walk that can be resumed to find windows with an invalid region
sl@0: 				TResumableWalkWindowTreeFindInvalid wwt(&redrawWin);
sl@0: 				groupWin->WalkWindowTree(wwt, EWalkChildren, EFalse);
sl@0: 				while (redrawWin != NULL)
sl@0: 					{
sl@0: 					WS_ASSERT_DEBUG(redrawWin != previousRedraw, EWsPanicRedrawQueueError);
sl@0: 					// (the window may not actually need the client to redraw it, e.g. a CWsBlankWindow can redraw itself)
sl@0: 					if (FindOutstandingRedrawEvent(*redrawWin, aEvent))
sl@0: 						{
sl@0: 						return ETrue;
sl@0: 						}
sl@0: 					else
sl@0: 						{ // continue the Tree Walk
sl@0: #if defined(_DEBUG)
sl@0: 						previousRedraw = redrawWin;
sl@0: #endif
sl@0: 						if (redrawWin->NeedsRedraw())
sl@0: 							{ // needs to be redrawn later?
sl@0: 							++invalidWindows;
sl@0: 							}
sl@0: 						redrawWin = NULL;
sl@0: 						groupWin->WalkWindowTree(wwt, EWalkChildren, ETrue);
sl@0: 						}
sl@0: 					}
sl@0: 				}
sl@0: 			}
sl@0: 		}
sl@0: 
sl@0: 	if (invalidWindows == 0)
sl@0: 		{ // error recovery is complete
sl@0: 		iAllocError = 0;
sl@0: 		}
sl@0: 	return EFalse;
sl@0: 	}
sl@0: 
sl@0: void CRedrawQueue::GetData()
sl@0: //
sl@0: // If there is an outstanding redraw event in the queue, reply with it's data
sl@0: //
sl@0: 	{
sl@0: 	CWsWindowRedraw *redraw;
sl@0: 	TWsRedrawEvent event;
sl@0: 
sl@0: 	while (iRedraws->Count()>0)
sl@0: 		{
sl@0: 		redraw=(*iRedraws)[0].iRedraw;
sl@0: 		if (FindOutstandingRedrawEvent(*redraw,event))
sl@0: 			{
sl@0: 			return;
sl@0: 			}
sl@0: 		TInt toDelete=0;
sl@0: 		if (redraw!=(*iRedraws)[0].iRedraw)
sl@0: 			{		//In low memory conditions calls to FindOutstandingRedrawEvent can cause extra entries to be added to the array
sl@0: 			TRedraw redrawFind;
sl@0: 			redrawFind.iRedraw=redraw;
sl@0: 			iRedraws->Find(redrawFind,*iKeyWindow,toDelete);
sl@0: 			}
sl@0: 		DeleteFromQueue(toDelete);
sl@0: 		}
sl@0: 
sl@0: 	if (iAllocError && FindWindowNeedingRedrawEvent(event))
sl@0: 		{
sl@0: 		return;
sl@0: 		}
sl@0: 
sl@0: 	CEventBase::GetData(&iNullRedrawEvent,sizeof(iNullRedrawEvent));
sl@0: 	}
sl@0: 
sl@0: TUint CRedrawQueue::RedrawPriority(CWsWindowRedraw *aRedrawWin)
sl@0: 	{
sl@0: 	TInt index;
sl@0: 	TRedraw redraw;
sl@0: 	TUint priority=0;
sl@0: 	redraw.iRedraw=aRedrawWin;
sl@0: 
sl@0: 	if ((iRedraws->Find(redraw,*iKeyWindow,index))==KErrNone)
sl@0: 		{
sl@0: 		priority=iRedraws->At(index).iPriority;
sl@0: 		}
sl@0: 	return priority;
sl@0: 	}