// 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 virtual base class, windows and window groups are derived from this

// 

//

#include <e32std.h>

#include "server.h"

#include "winbase.h"

#include "rootwin.h"

#include "windowgroup.h"

#include "walkwindowtree.h"

#include "wstop.h"

#include "EVQUEUE.H"

#include "EVENT.H"

#include "panics.h"

#include "pointer.h"

#include "windowelementset.h"

CWsWindowBase::CWsWindowBase(CWsClient* aOwner,WH_HANDLES aType, CScreen* aScreen) : CWsScreenObject(aOwner,aType,aScreen)		

	{

	}

void CWsWindowBase::ConstructL(CWsWindowBase *aParent)

	{

	iParent=aParent;

	iSibling=aParent->iChild;

	aParent->iChild=this;

	CScreen* screen = aParent->Screen();

	WS_ASSERT_DEBUG(screen,EWsPanicNoScreen);

	MWsWindowTreeObserver* const windowTreeObserver = screen->WindowTreeObserver();

	if (windowTreeObserver)

		{

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

		iBaseWinFlags |= EBaseWinNodeCreated;

		}

	SetOrdinalPosition(0);

	iFadeCount = iParent->iFadeCount;

	}

CWsWindowBase *CWsWindowBase::GetPrevSibling() const

	{

	if(iParent == NULL) //RootWindow

		return(NULL);

	CWsWindowBase* prev=iParent->iChild;

	CWsWindowBase *ret=NULL;

	while (prev!=this)

		{

		ret=prev;

		prev=prev->iSibling;

		}

	return(ret);

	}

CWsWindowBase *CWsWindowBase::LastSibling() const

	{

	const CWsWindowBase *win;

	for(win=this;win->iSibling;win=win->iSibling)

		{}

	return (CWsWindowBase*)win;

	}

CWsWindowBase *CWsWindowBase::PrevSiblingMultiParent() const

	{

	CWsWindowBase *win=GetPrevSibling();

	if (win)

		return(win);

	for(CWsWindowBase *parent=iParent->GetPrevSibling();parent;parent=parent->GetPrevSibling())

		if ((win=parent->iChild)!=NULL)

			return(win->LastSibling());

	return(NULL);

	}

CWsWindowBase *CWsWindowBase::NextSiblingMultiParent() const

	{

	if (iSibling)

		return(iSibling);

	for(CWsWindowBase *parent=iParent->iSibling;parent;parent=parent->iSibling)

		{

		if (parent->iChild!=NULL)

			return(parent->iChild);

		}

	return(NULL);

	}

TInt CWsWindowBase::OrdinalPosition(TBool aFull) const

	{

	if (!iParent)

		{

		OwnerPanic(EWservPanicParentDeleted);

		}

	CWsWindowBase *win=iParent->iChild;

	if (!aFull)

		while(iOrdinalPriority<win->iOrdinalPriority)

			win=win->iSibling;

	TInt count;

	for(count=0;win!=this;count++)

		win=win->iSibling;

	return(count);

	}

/** Removes a window from the list of siblings maintained by its parent window.

The iSibling stored inside the window we remove is kept unchanged as it may be needed later.

@internalComponent

@released

*/

void CWsWindowBase::RemoveFromSiblingList()

	{

	if (iParent!=NULL)

		{

		CWsWindowBase **prev= &iParent->iChild;

		while ((*prev)!=this)

			prev= &(*prev)->iSibling;

		*prev=iSibling;

		}

	}

CWsWindowGroup *CWsWindowBase::WinGroup() const

	{

	if (iWinType==EWinTypeClient)

		return(((CWsClientWindow *)this)->TopClientWindow()->Parent());

	if (iWinType==EWinTypeGroup)

		return((CWsWindowGroup *)this);

	return(NULL);

	}

TBool CWsWindowBase::CheckOrdinalPositionChange(TInt aPos)

//

// This routine checks to see whether the specified new ordinal position

// will causes a change, if so returns ETrue else EFalse.

//

	{

	CWsWindowBase *win= iParent->iChild;

	CWsWindowBase *prev= NULL;

	while(win==this || (win!=NULL && iOrdinalPriority<win->iOrdinalPriority))

		{

		prev=win;

		win=win->iSibling;

		}

	if (prev==this)

		win=this;

	else if (win==NULL || (win->iSibling==this && iOrdinalPriority>win->iOrdinalPriority))

		return ETrue;

	while(aPos--!=0 && win->iSibling!=NULL && iOrdinalPriority==win->iSibling->iOrdinalPriority)

		win=win->iSibling;

	return(win!=this);

	}

void CWsWindowBase::ChangeWindowPosition(TInt aPos,CWsWindowBase* aNewParent)

	{

	TBool changedWindowGroup = EFalse;

	WS_ASSERT_DEBUG(aNewParent,EWsPanicWindowNull);

	if (aNewParent != iParent)

		{

		iScreen->ScheduleRegionUpdate(NULL);		

		TWalkWindowTreeScheduleRedraws wwt;

		WalkWindowTree(wwt, EWalkChildren);

		changedWindowGroup = ETrue;

		}

	else if (WinType() == EWinTypeClient)

		{

		CWsClientWindow * cliwin = static_cast<CWsClientWindow*>(this);

		if (cliwin->IsVisible())

			{

			iScreen->ScheduleRegionUpdate(NULL);

			if (cliwin->IsTranslucent())

				{

				// There is still room for optimization here.  These redraws are only required if the window

				// moved through another window and BOTH of them were transparent, otherwise the visible

				// region change will sort out the redraws required.

				TWalkWindowTreeScheduleRedraws wwt;

				WalkWindowTree(wwt, EWalkChildren);

				}

			}

		}

	else if (WinType() == EWinTypeGroup)

		{

		iScreen->ScheduleRegionUpdate(NULL);

		if (static_cast<CWsWindowGroup*>(this)->HasVisibleTranslucentChild())

			{

			TWalkWindowTreeScheduleRedraws wwt;

			WalkWindowTree(wwt, EWalkChildren);				

			}

		}

	RemoveFromSiblingList();

	CWsWindowBase **prevWinPtr= &aNewParent->iChild;

	while((*prevWinPtr)!=NULL && iOrdinalPriority<(*prevWinPtr)->iOrdinalPriority)

		{

		prevWinPtr= &(*prevWinPtr)->iSibling;

		}

	while(aPos--!=0 && *prevWinPtr!=NULL && iOrdinalPriority==(*prevWinPtr)->iOrdinalPriority)

		{

		prevWinPtr= &(*prevWinPtr)->iSibling;

		}

	iSibling=*prevWinPtr;

	iParent=aNewParent;

	*prevWinPtr=this;

	Screen()->WindowElements().SortByZOrder();

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

	if (windowTreeObserver)

		{

		if(changedWindowGroup && (WinType() == EWinTypeClient))

			{

			windowTreeObserver->MovedToWindowGroup(*this, *(this->WinGroup()));

			}

		else if(!changedWindowGroup)

			{

			windowTreeObserver->SiblingOrderChanged(*this, OrdinalPosition(ETrue));

			}

		else if(changedWindowGroup)

			{

			OwnerPanic(EWservPanicInvalidParameter); //Should be impossible to end up here as only WinType() EWinTypeClient 

			}										 //and EWinTypeGroup can be moved to another windowgroup.

		}											 //@see RWindowBase::MoveToGroup

	}

void CWsWindowBase::SetOrdinalPosition(TInt aPos)

	{

	if (CheckOrdinalPositionChange(aPos))

		ChangeWindowPosition(aPos,iParent);

	}

TEventQueueWalkRet EventPurgeFunc(TAny *aPtr, TWsEvent *aEvent)

//

// Callback function for event queue walk

//

	{

	return(((CWsWindowBase *)aPtr)->EventPurgeCheck(aEvent));

	}

TEventQueueWalkRet CWsWindowBase::EventPurgeCheck(TWsEvent *aEvent)

	{

	if (aEvent->Handle()==ClientHandle())

		return(EEventQueueWalkDeleteEvent);

	return(EEventQueueWalkOk);

	}

void CWsWindowBase::PurgeEvents()

	{

	iWsOwner->EventQueue()->WalkEventQueue(&EventPurgeFunc,this);

	}

void CWsWindowBase::Shutdown()

//

// Destroy a window, disconnects from the window tree and destroys all it's child windows

//

	{

	if (iWsOwner!=NULL)

		PurgeEvents();

	if (iParent!=NULL)	// Check it's connected to something

		{

		CWsWindowBase *win;

		for(win=this;win && win->iParent!=(CWsWindowBase *)RootWindow();win=win->iParent)

			{}

		RemoveFromSiblingList();

		TWalkWindowTreeDisconnect wwt2(win ? ((CWsWindowGroup *)win)->TextCursor() : NULL);

		WalkWindowTree(wwt2,EWalkChildren); // Disconnect all child windows

		iChild=NULL;

		}

	TWindowServerEvent::RemoveFromSwitchOnEventList(*this);

	TWindowServerEvent::RemoveFromErrorMessageList(*this);

	TWindowServerEvent::RemoveFromGroupChangeEventEventList(*this);

	TWindowServerEvent::RemoveFromFocusChangeEventEventList(*this);

	TWindowServerEvent::RemoveFromGroupListChangeEventEventList(*this);

	TWindowServerEvent::RemoveFromModifierChangedEventList(*this);

	TWindowServerEvent::RemoveFromScreenDeviceChangeEventList(*this);

	CWsTop::StopWindowGettingOffEvents(this);

	}

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

//

// If the command is supported by the window base class process it and return ETrue

// if it is not supported return EFalse

//

	{

	switch(aOpcode)

		{

		case EWsWinOpFree:

			{

			delete this;

			break;

			}

		case EWsWinOpSetOrdinalPosition:

			SetOrdinalPosition(*aCmd.Int);

			break;

		case EWsWinOpOrdinalPriority:

			SetReply(iOrdinalPriority);

			break;

		case EWsWinOpOrdinalPosition:

			SetReply(OrdinalPosition(EFalse));

			break;

		case EWsWinOpFullOrdinalPosition:

			SetReply(OrdinalPosition(ETrue));

			break;

		case EWsWinOpClientHandle:

			SetReply(iClientHandle);

			break;

		case EWsWinOpParent:

			if (!iParent)

				{

				OwnerPanic(EWservPanicParentDeleted);

				}

			SetReply(iParent->iClientHandle);

			break;

		case EWsWinOpPrevSibling:

			{

			if (!iParent)

				{

				OwnerPanic(EWservPanicParentDeleted);

				}

			TUint32 reply=NULL;

			for(CWsWindowBase *win=this->GetPrevSibling();win;win=win->GetPrevSibling())

				{

				if (win->iWsOwner==iWsOwner)

					{

					reply=win->iClientHandle;

					break;

					}

				}

			SetReply(reply);

			}

			break;

		case EWsWinOpNextSibling:

			{

			TUint32 reply=NULL;

			for(CWsWindowBase *win=this->iSibling;win;win=win->iSibling)

				{

				if (win->iWsOwner==iWsOwner)

					{

					reply=win->iClientHandle;

					break;

					}

				}

			SetReply(reply);

			}

			break;

		case EWsWinOpChild:

			SetReply(iChild==NULL ? NULL : iChild->iClientHandle);

			break;

		case EWsWinOpScreenNumber:

			SetReply(Screen()->ScreenNumber());

			break;

		case EWsWinOpWindowGroupId:

			{

			TUint32 reply=NULL;

			CWsWindowGroup *wg=WinGroup();

			if (wg)

				{

				reply=wg->Identifier();

				}

			SetReply(reply);

			}

			break;

		case EWsWinOpEnableOnEvents:

			{

			const TEventControl circumstances = *aCmd.EventControl;

			TWindowServerEvent::AddToSwitchOnEventListL(*this, circumstances);

			if (iScreen->ChangeTracking())

				{

				if(circumstances & EEventControlOnlyWhenVisible)

					{

					TWalkWindowTreeSetupVisibleRegionTracking wwt(ETrue);

					WalkWindowTree(wwt, EWalkChildren);

					}

				}

			break;

			}

		case EWsWinOpDisableOnEvents:

			{

			TWindowServerEvent::RemoveFromSwitchOnEventList(*this);

			if (iScreen->ChangeTracking())

				{

				TWalkWindowTreeSetupVisibleRegionTracking wwt(EFalse);

				WalkWindowTree(wwt, EWalkChildren);

				}

			break;

			}

		case EWsWinOpEnableErrorMessages:

			{

			const TEventControl circumstances = *aCmd.EventControl;

			TWindowServerEvent::AddToErrorMessageListL(*this, circumstances);

			if (iScreen->ChangeTracking())

				{

				if(circumstances & EEventControlOnlyWhenVisible)

					{

					TWalkWindowTreeSetupVisibleRegionTracking wwt(ETrue);

					WalkWindowTree(wwt, EWalkChildren);

					}

				}

			break;

			}

		case EWsWinOpDisableErrorMessages:

			{

			TWindowServerEvent::RemoveFromErrorMessageList(*this);

			if (iScreen->ChangeTracking())

				{

				TWalkWindowTreeSetupVisibleRegionTracking wwt(EFalse);

				WalkWindowTree(wwt, EWalkChildren);

				}

			break;

			}

		case EWsWinOpEnableModifierChangedEvents:

			{

			const TInt modifierMask = aCmd.EnableModifierChangedEvents->modifierMask;

			const TEventControl circumstances = aCmd.EnableModifierChangedEvents->circumstances;

			TWindowServerEvent::AddToModifierChangedEventListL(*this, modifierMask, circumstances);

			if (iScreen->ChangeTracking())

				{

				if(circumstances & EEventControlOnlyWhenVisible)

					{

					TWalkWindowTreeSetupVisibleRegionTracking wwt(ETrue);

					WalkWindowTree(wwt, EWalkChildren);

					}

				}

			break;

			}

		case EWsWinOpDisableModifierChangedEvents:

			{

			TWindowServerEvent::RemoveFromModifierChangedEventList(*this);

			if (iScreen->ChangeTracking())

				{

				TWalkWindowTreeSetupVisibleRegionTracking wwt(EFalse);

				WalkWindowTree(wwt, EWalkChildren);

				}

			break;

			}

		case EWsWinOpEnableGroupChangeEvents:

			TWindowServerEvent::AddToGroupChangeEventListL(*this);

			break;

		case EWsWinOpDisableGroupChangeEvents:

			TWindowServerEvent::RemoveFromGroupChangeEventEventList(*this);

			break;

		case EWsWinOpEnableFocusChangeEvents:

			TWindowServerEvent::AddToFocusChangeEventListL(*this);

			break;

		case EWsWinOpDisableFocusChangeEvents:

			TWindowServerEvent::RemoveFromFocusChangeEventEventList(*this);

			break;

		case EWsWinOpEnableGroupListChangeEvents:

			TWindowServerEvent::AddToGroupListChangeEventListL(*this);

			break;

		case EWsWinOpDisableGroupListChangeEvents:

			TWindowServerEvent::RemoveFromGroupListChangeEventEventList(*this);

			break;

		case EWsWinOpSetCustomPointerCursor:

			CWsObject *pointercursor;

			if ((pointercursor=iWsOwner->HandleToObj(*aCmd.Int, WS_HANDLE_POINTER_CURSOR))==NULL)

				OwnerPanic(EWservPanicSprite);

			SetPointerCursor((CWsPointerCursor *)pointercursor);

			break;

		case EWsWinOpSetPointerCursor:

			SetPointerCursorByIndex(*aCmd.UInt);

			break;

		case EWsWinOpClearPointerCursor:

			SetPointerCursor(NULL);

			break;

		case EWsWinOpSetNonFading:

			{

			WS_ASSERT_DEBUG(iScreen, EWsPanicNoScreen);

			// No fading will occur from a graphical perspective, but the fade counts

			// are maintained for BC reasons.

			TWalkWindowTreeSetNonFading wwt(*aCmd.Bool);

			WalkWindowTree(wwt,EWalkChildren);

			}

			break;

		case EWsWinOpSetFade:

			{

			WS_ASSERT_DEBUG(iScreen, EWsPanicNoScreen);

			TUint8 blackMap;

			TUint8 whiteMap;

			if (aCmd.SetFaded->UseDefaultMap())

				{

				iScreen->GetFadingParams(blackMap,whiteMap);

				}

			else

				{

				aCmd.SetFaded->GetFadingParams(blackMap,whiteMap);

				}

			if (aCmd.SetFaded->IncludeChildren())

				{

				TWalkWindowTreeSetFaded wwt(aCmd.SetFaded->Faded(),this,blackMap,whiteMap);

				WalkWindowTree(wwt,EWalkChildren);

				}

			else

				{

				if (iWinType==EWinTypeGroup)

					OwnerPanic(EWservPanicOpcode);

				const TBool KNotifyObserver = ETrue; //yes please

				const TBool KFaded = aCmd.SetFaded->Faded();

				static_cast<CWsClientWindow*>(this)->SetFaded(KFaded, blackMap, whiteMap, KNotifyObserver); 

				}

			}

			break;

		case EWsWinOpEnableAdvancedPointers:

      if(!IsActivated())

          {

          // Must call this BEFORE activating the window.

          iBaseWinFlags |= EBaseWinAdvancedPointersEnabled;

          }

      else

          {                    

          // Called after activation, so panic the client.                

          OwnerPanic(EWservPanicUnableToEnableAdvPointer);

          }

			break;