// 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:

// Interface code for animated DLL's

// 

//

#include <e32std.h>

#include "server.h"

#include "gc.h"

#include "rootwin.h"

#include "windowgroup.h"

#include "ANIM.H"

#include "wstop.h"

#include "EVENT.H"

#include "ScrDev.H"

#include "panics.h"

#include "wsfont.h"

#include "pointer.h"

GLREF_D CDebugLogBase *wsDebugLog;

static const TInt64 KFlashOnTime(700000);

static const TInt64 KFlashOffTime(300000);

static const TInt64 KOneSecond(1000000);

static const TInt64 KOneMinute(60 * KOneSecond);

static const TInt64 KOneDay(24 * 60 * 60 * KOneSecond);

static const TInt64 KOneHalfSecond(500000);

enum {EWindowUpdate=0x0001};

// Anim DLL code //

CWsAnim::CWsAnim(CWsAnimDll *aDll) : iClient(aDll->WsOwner()), iAnimAddedInHandler(EFalse), iLastFrame(-1)

	{

	__DECLARE_NAME(_S("CWsAnim"));

	iBitFlags.Set(EFlashOn);

	}

void CWsAnim::WindowClosing(CWsAnim *aWsAnim)

	{

	CWsAnim *anim=aWsAnim;

	CWsAnim *next;

	while(anim)

		{

		next=anim->iNextWin;

		CloseAnim(anim);

		anim=next;

		}

	}

void CWsAnim::CloseAnim(CWsAnim *aWsAnim)

	{

	if(aWsAnim)

		{

		TInt handle=aWsAnim->iAnimDll->AnimObjectHandle(aWsAnim);

		if (handle<0)

			delete aWsAnim;

		else

			aWsAnim->iAnimDll->Remove(handle);

		}

	}

CWsAnim::~CWsAnim()

	{

	if (iWindow)	// In case it never got linked

		{

		iWindow->SetupVisibleRegionTracking(EFalse);

		MWsWindowTreeObserver* windowTreeObserver = iClient->Screen()->WindowTreeObserver();

		if (windowTreeObserver && (iBitFlags.IsSet(EWinAnimConstructed)))

			{

			windowTreeObserver->NodeReleased(*this);

			iBitFlags.Clear(EWinAnimConstructed);

			}

		CWsAnim **pAnim;

		for(pAnim= &iWindow->iAnimList;(*pAnim)!=NULL && (*pAnim)!=this;pAnim= &(*pAnim)->iNextWin)

			{}

		*pAnim=iNextWin;

		}

	else if (iSprite)

		{

		// coverity[extend_simple_error]

		iSprite->iAnim=NULL;

		iSprite->SetHasAnimation(EFalse);

		if(iSprite->Win())

			iSprite->Win()->SetupVisibleRegionTracking(EFalse);

		}

	// force the anim for the event handler list.

	TWindowServerEvent::RemoveEventHandler(Anim());

	TWindowServerEvent::RemoveNotificationHandler(Anim());

	delete iAnim.iWindowAnim;

	delete iAnimGc;

	// coverity[extend_simple_error]

	TWindowServerEvent::PotentialEventHandlerL(-1);		//PotentialEventHandler cannot leave when passed a negative parameter.

	}

void CWsAnim::Connect(CWsClientWindow *aWindow)

	{

	//coverity[var_compare_op]

	WS_ASSERT_DEBUG(aWindow,EWsPanicWindowNull);

	if ((iSprite))

		Panic();

	iWindow=aWindow;

	iNextWin=aWindow->iAnimList;

	aWindow->iAnimList=this;

	iBitFlags.Assign(EAdvancedPointersEnabled, aWindow->AdvancedPointersEnabled());

	iWindow->SetupVisibleRegionTracking(ETrue);

	}

void CWsAnim::Connect(CWsSprite *aSprite)

	{

	WS_ASSERT_DEBUG(aSprite,EWsPanicNoSprite);

	if (iWindow)

		Panic();

	iSprite=aSprite;

	iSprite->iAnim=this;

	iSprite->SetHasAnimation(ETrue);

	iBitFlags.Assign(EAdvancedPointersEnabled, aSprite->AdvancedPointersEnabled());

	if(iSprite->Win())

		{

		iSprite->Win()->SetupVisibleRegionTracking(ETrue);

		}

	}

LOCAL_C void HandleLeaveInCWsAnimConstructL(TAny* aAnim)

	{

	STATIC_CAST(CWsAnim*,aAnim)->SetMessage(NULL);

	STATIC_CAST(CWsAnim*,aAnim)->UserDeactivateAnimGc();

	}

void CWsAnim::ConstructL(CAnim *aAnim, TAny *aArgs, CWsAnimDll *aAnimDll, TBool aIsWindow)

	{

	TBool isFocused=(iSprite!=NULL);

	if (!isFocused)

		isFocused=CWsTop::FocusWindowGroup()==iWindow->WinGroup();

	iAnimDll=aAnimDll;

	iAnimSync=ESyncNone;

	if(!aAnim)

	    {

	    RDebug::Printf("CreateInstanceL did not create an anim instance.");

	    Panic();

	    }

	aAnim->iFunctions=this;

	SetMessage(&iClient->ClientMessage());

	CleanupStack::PushL(TCleanupItem(HandleLeaveInCWsAnimConstructL,this));

	if (aIsWindow)

		{

		iAnim.iWindowAnim = static_cast<CWindowAnim*>(aAnim);

		iAnimGc = new (ELeave) CWsAnimGc(*this);

		iAnim.iWindowAnim->iWindowFunctions=this;

		iAnim.iWindowAnim->iGc=iAnimGc;

		iAnim.iWindowAnim->ConstructL(aArgs, isFocused);

		iBitFlags.Set(EWinAnimConstructed);

		WS_ASSERT_DEBUG(iClient->Screen(), EWsPanicNoScreen);

		if (iClient->Screen())

			{

			MWsWindowTreeObserver* windowTreeObserver = iClient->Screen()->WindowTreeObserver();

			if (windowTreeObserver)

				{

				windowTreeObserver->NodeCreated(*this, ParentNode());

				const TRect rect = BestRect();

				windowTreeObserver->NodeExtentChanged(*this, rect);

				windowTreeObserver->NodeActivated(*this); //window-anim inherits activate status from iWindow

				}

			}

		}

	else

		{

		iAnim.iSpriteAnim = static_cast<CSpriteAnim*>(aAnim);

		iAnim.iSpriteAnim->iSpriteFunctions=this;

		iAnim.iSpriteAnim->ConstructL(aArgs);

		}

	CleanupStack::PopAndDestroy(this); // doesn't really destroy "this" - it actually calls HandleLeaveInCWsAnimConstructL

	}

/**

This function should only be called in the context of a redraw (i.e. CScreenRedraw::OnAnimation) 

@panic EWsPanicAnim will be raised in debug build if this function is called in the wrong context.

*/

void CWsAnim::RedrawWindowAnimL(const TTime& aTimeNow, MWsGraphicsContext* aGc, const TRegion* aRegion)

	{

	WS_ASSERT_DEBUG(iWindow, EWsPanicAnimHasNoWindow);

	WS_ASSERT_DEBUG(iWindow->Screen(), EWsPanicNoScreen);

	WS_ASSERT_DEBUG(iWindow->Screen()->IsAnimating(), EWsPanicAnim);

	iBitFlags.Set(EInRedraw);

	TInt frame;

	TInt64 adjustedStart;

	 // Don't call AnimateL() on CFreeTimerWindowAnim animations

	if(iAnimSync!=ESyncNone || iInterval!=0)

	    {

	    AnimateL(aTimeNow, frame, adjustedStart);

	    }

	RedrawWindowAnimL(aGc, aRegion);

	ReSchedule(aTimeNow, frame, adjustedStart);

	iBitFlags.Clear(EInRedraw);

	}

/**

This function should only be called in the context of a redraw (i.e. CScreenRedraw::OnAnimation)

@panic EWsPanicAnim will be raised in debug build if this function is called in the wrong context. 

*/

void CWsAnim::AnimateSpriteAnimL(const TTime& aTimeNow)

	{

	WS_ASSERT_DEBUG(iSprite, EWsPanicNoSprite);

	WS_ASSERT_DEBUG(iSprite->Screen(), EWsPanicNoScreen);

    WS_ASSERT_DEBUG(iSprite->Screen()->IsAnimating(), EWsPanicAnim);

    iBitFlags.Set(EInRedraw);

	TInt frame;

	TInt64 adjustedStart;

	AnimateL(aTimeNow, frame, adjustedStart);

	ReSchedule(aTimeNow, frame, adjustedStart);

	iBitFlags.Clear(EInRedraw);

	}

void CWsAnim::AnimateL(const TTime& aTimeNow, TInt& aFrame, TInt64& aAdjustedStart)

	{

	// Work out which frame we are in:

	if (iLastFrame < 0)

		iStartTime = aTimeNow;

	TInt64 elapsed = aTimeNow.Int64() - iStartTime.Int64();

	aAdjustedStart = iStartTime.Int64();

	aFrame = 0;

	switch (iAnimSync)

		{

		case ESyncNone:

			if (iInterval > 0)

				{

				aFrame = elapsed / iInterval.Int64();

				}

				else

				{

				aFrame = -1; //This would be a CFreeTimerWindowAnim

				}

			break;

		case ESyncFlash:

			{

			TInt64 fraction = elapsed % (KFlashOnTime + KFlashOffTime);

			aFrame = (elapsed - fraction) / (KFlashOnTime + KFlashOffTime) * 2;

			if (fraction > KFlashOnTime)

				{

				aFrame += 1;

				iBitFlags.Clear(EFlashOn);

				}

			else

				{

				iBitFlags.Set(EFlashOn);

				}

			}

			break;

		case ESyncSecond:

			aAdjustedStart = iStartTime.Int64() - (iStartTime.Int64() % KOneSecond);

			elapsed = aTimeNow.Int64() - aAdjustedStart;

			aFrame = elapsed / KOneSecond;

			break;

		case ESyncMinute:

			aAdjustedStart = iStartTime.Int64() - (iStartTime.Int64() % KOneMinute);

			elapsed = aTimeNow.Int64() - aAdjustedStart;

			aFrame = elapsed / KOneMinute;

			break;

		case ESyncDay:

			aAdjustedStart = iStartTime.Int64() - (iStartTime.Int64() % KOneDay);

			elapsed = aTimeNow.Int64() - aAdjustedStart;

			aFrame = elapsed / KOneDay;

			break;

		}

	// If the frame has changed, animate:

	if (aFrame != iLastFrame && aFrame != -1)

		{

		if (aFrame == iLastFrame + 1 && iLastFrame != -1)

			{

			Animate(NULL); //This can leave

			}

		else

			{

			TDateTime dt = aTimeNow.DateTime();

			Animate(&dt);

			}

		iLastFrame = aFrame;

		}

	}

void CWsAnim::RedrawWindowAnimL(MWsGraphicsContext * aGc, const TRegion *aRegion)

	{

	WS_ASSERT_DEBUG(iWindow,EWsPanicAnimHasNoWindow);

	// We don't attempt to make use of iRect because it often isn't set up by the client code.

	TWindowInfo::TRegionPair regionPair;

	regionPair.iRegion1 = aRegion;

	regionPair.iRegion2 = NULL;

	iRedrawRegionPair = &regionPair;

	if(iWindow && iAnim.iWindowAnim)

		{

		// Regardless of whether we animated or not, redraw:

		iAnimGc->Activate(aRegion, aGc);

		iAnim.iWindowAnim->Redraw();	//This can leave

		iAnimGc->Deactivate();

		}

	iRedrawRegionPair = NULL;				

	}

void CWsAnim::ReSchedule(const TTime& aTimeNow, const TInt& aFrame, const TInt64& aAdjustedStart)

	{

	// Schedule ourselves again (we usually only have to do this when we animate,

	// but it is possible for our scheduled rectangle to get lost in a redraw):

	TInt64 timeToNextFrame = 0;

	switch (iAnimSync)

		{

		case ESyncNone:

			if (iInterval > 0)

				{

				timeToNextFrame = iStartTime.Int64() + iInterval.Int64() * (aFrame + 1) - aTimeNow.Int64();

				}

			break;

		case ESyncFlash:

			if (iBitFlags.IsSet(EFlashOn))

				{

				timeToNextFrame = iStartTime.Int64() + (KFlashOnTime + KFlashOffTime) * aFrame / 2 + KFlashOnTime - aTimeNow.Int64();

				}

			else

				{

				timeToNextFrame = iStartTime.Int64() + (KFlashOnTime + KFlashOffTime) * (aFrame + 1 ) / 2 - aTimeNow.Int64();

				}

			break;

		case ESyncSecond:

			timeToNextFrame = aAdjustedStart + KOneSecond * (aFrame + 1) - aTimeNow.Int64();

			break;

		case ESyncMinute:

			timeToNextFrame = aAdjustedStart + KOneMinute * (aFrame + 1) - aTimeNow.Int64();

			break;

		case ESyncDay:

			timeToNextFrame = aAdjustedStart + KOneDay * (aFrame + 1) - aTimeNow.Int64();

			break;

		}

	if (iAnimSync != ESyncNone || iInterval > 0)

		{

		ScheduleSelf(timeToNextFrame);

		}

	}

/**

Mark the animation area as invalid so it gets redrawn later. 

*/

void CWsAnim::ScheduleSelf(const TTimeIntervalMicroSeconds& aFrom)

	{

	ASSERT( (iWindow && iAnim.iWindowAnim) || (iSprite && iAnim.iSpriteAnim) );

	if(iWindow && iAnim.iWindowAnim)

		{

		WS_ASSERT_DEBUG(iWindow->Screen(), EWsPanicNoScreen);

		const TRect rect = BestRect();

		iWindow->Screen()->ScheduleAnimation(EWindowAnim, rect, aFrom, 0, 0, iWindow);

		}

	else if(iSprite && iAnim.iSpriteAnim)

		{

		WS_ASSERT_DEBUG(iSprite->Screen(), EWsPanicNoScreen);

		const TRect rect = iSprite->Rect();

		if(iSprite->Win())

			iSprite->Screen()->ScheduleAnimation(ESpriteAnim, rect, aFrom, 0, 0, iSprite->Win());

		else

			iSprite->Screen()->ScheduleAnimation(EFloatingSpriteAnim, rect, aFrom, 0, 0, NULL);

		}

	}

void CWsAnim::UserDeactivateAnimGc()

	{

	if (iAnimGc) // For sprite anims iAnimGc is NULL

	    {

        //If we have been receiving draw commands outside the context of 

	    //CScreenRedraw::OnAnimation, then we need to schedule a redraw.

	    if (iAnimGc->IsActive() && iBitFlags.IsClear(EInRedraw))

	         {

	         ScheduleSelf(0);

	         }

	    iAnimGc->UserDeactivate();

	    }

	}

void CWsAnim::FocusChanged(TBool aNewFocusState)

	{

	WS_ASSERT_DEBUG(iWindow && iAnimGc && iAnim.iWindowAnim,EWsPanicAnim);

	iAnim.iWindowAnim->FocusChanged(aNewFocusState);

	UserDeactivateAnimGc();

	}

void CWsAnim::Animate(TDateTime *aDateTime)

	{

	WS_ASSERT_DEBUG(Anim(),EWsPanicAnim);

	Anim()->Animate(aDateTime);

	UserDeactivateAnimGc();

	}

// Callback functions //

void CWsAnim::ActivateGc()

	{

	if (!iWindow)

		Panic();

	// Window animation drawing commands need to go through the render stage pipeline. This means

	// that drawing commands issued outside animation redraws (for instance, during Animate() or

	// when the animation receives a command) will mark the animation area as invalid, but the

	// commands themselves will be ignored as drawing will only happen during the next WSERV redraw

	// cycle (CWindowAnim::Redraw).

	// In this new situation MAnimWindowFunctions::ActivateGc doesn't need to activate the graphics

	// context (drawing commands issued outside CWindowAnim::Redraw are ignored), but to avoid some

	// behavior breaks (for instance, panic situations) we mark the GC as "activated by the user".

	iAnimGc->UserActivate();

	}

void CWsAnim::DeactivateGc()

	{

	if (!iWindow)

		Panic();

	// Window animation drawing commands need to go through the render stage pipeline. This means

	// that drawing commands issued outside animation redraws (for instance, during Animate() or

	// when the animation receives a command) will mark the animation area as invalid, but the

	// commands themselves will be ignored as drawing will only happen during the next WSERV redraw

	// cycle (CWindowAnim::Redraw).

	// In this new situation MAnimFreeTimerWindowFunctions::DeactivateGc just marks the animation

	// area as invalid so it gets redrawn later.

	UserDeactivateAnimGc();

	}

/*

Because lots of animations don't set a rectangle, or set an empty one, we need

to make a best guess at what to use rather than assuming anything.

*/

TRect CWsAnim::BestRect() const

	{

	WS_ASSERT_DEBUG(iWindow,EWsPanicAnimHasNoWindow);

	TRect rect;

	if (iRect.IsEmpty())

		{

		rect = iWindow->AbsRect();

		}

	else

		{

		rect = iRect;

		rect.Move(iWindow->Origin());

		rect.Intersection(iWindow->AbsRect());

		}

	return rect;

	}

void CWsAnim::Invalidate(const TRect &aRect)

	{

	if (!iWindow)

		{

		if (iSprite) 

			{

			iSprite->RootWindow()->InvalidateWholeScreen();

			}

		return;

		}

	iWindow->Redraw()->ClientExposing();

	TRect rect(aRect);

	rect.Move(iWindow->Origin());

	CWsTop::TriggerRedraws(iWindow->RootWindow());

	}

void CWsAnim::Update()

	{

	if (!iWindow)

		Panic();

	}

void CWsAnim::Parameters(TWindowInfo &aData)

	{

	if (!iWindow)

		Panic();

	aData.iScreenPos=iWindow->FullRect();

	aData.iMode=iWindow->DisplayMode();

	aData.iRegionPair=iRedrawRegionPair;

	}

void CWsAnim::VisibleRegion(TRegion& aRegion)

	{

	if(iWindow)

		{

		aRegion.Copy(iWindow->VisibleRegion());

		}

	}

void CWsAnim::SetSync(TAnimSync aSyncMode)

	{

	if (iAnimSync != aSyncMode)

		{

		iAnimSync=aSyncMode;

		iLastFrame = -1;

		if (iAnimSync != ESyncNone)

			ScheduleSelf(0);

		if (iAnimSync == ESyncFlash)

			iBitFlags.Set(EFlashOn);

		}

	}

void CWsAnim::SetInterval(TInt aInterval)

	{

	if (iAnimSync!=ESyncNone)

		Panic();