/*

* Copyright (c) 2006 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:   Display sub session

*

*/

#include "alfsrvdisplaysubsession.h"

#include "alf/alfconstants.h"

#include "alf/alfappsrvsessionbase.h"

#include "alfappsrvsession.h"

#include "alfsrvscreenbuffermanager.h"

#include "alfsrvtranseffect.h"

#include <alf/alfdisplaybackgrounditem.h>

#include <uiacceltk/HuiEnv.h>

#include <uiacceltk/HuiDisplay.h>

#include <uiacceltk/HuiDisplayCoeControl.h>

#include <uiacceltk/HuiControlGroup.h>

#include <uiacceltk/HuiControl.h>

#include <uiacceltk/huidisplaybackgrounditem.h>

#include <uiacceltk/HuiEvent.h>

#include <mtransitionserver.h>

// ETrue if client defined display quality is supported, EFalse if not.

// As there is other content than this ALF application content in the scene, 

// it's better ignore client quality hints.

// Note: If this is supported and client gains focus, client quality setting is

//       taken into use and applied to the whole scene. However, when client loses

//       focus, quality setting is not restored.

const TBool KAlfSrvClientQualitySupport = EFalse;

// ======== MEMBER FUNCTIONS ========

// ---------------------------------------------------------------------------

// Constructor

// ---------------------------------------------------------------------------

//

CAlfSrvDisplaySubSession::CAlfSrvDisplaySubSession( 

    CAlfAppSrvSessionBase& aSession,

    const TRect& aRect,

    TInt aWindowGroupId,

    TInt aDisplayType,

    const TUid& aBufferUid) 

    : CAlfSrvSubSessionBase( aSession ),

      iDisplayType(aDisplayType), 

      iScreenBufferUid(aBufferUid),

      iRect(aRect), 

      iDisplayClearBackground(CHuiDisplay::EClearWithSkinBackground),

      iDisplayRenderingQuality(EHuiQualityAccurate),

      iDisplayUseDepthTest(EFalse),

      iDisplayUsage(0)

    {

    if (!IsTvOut())

        {

        // Note: Might not work if there are multiple displays: the client drawing area is set

        // according to the last display. Also the new area is left there even if  ConstructL() 

        // fails(!).

        static_cast<CAlfAppSrvSession&>(Session()).SetClientDrawingArea( aRect );

        aSession.SetClientWindowGroupId( aWindowGroupId );           

        Session().AlfAppUi()->SetAlfAppWindowGroup(aWindowGroupId);

        }    

    }

// ---------------------------------------------------------------------------

// 2nd phasse constructor

// ---------------------------------------------------------------------------

//

void CAlfSrvDisplaySubSession::ConstructL()

    {

    CAlfSrvSubSessionBase::ConstructL();

    // With one display, use the existing one or create one if there aren't any.

    const TRect& rect = CHuiStatic::ScreenDevice()->SizeInPixels();

    // when running oldstyle, we may have rect different from whole screen

    if (Session().AlfAppUi()->Container())

        {

        const TRect& rect = Session().AlfAppUi()->Container()->Rect();

        }

    // Shared normal screen 0

    if ((iDisplayType == CHuiDisplay::EDisplayLcd0) || 

       ((iDisplayType == CHuiDisplay::EDisplayNormal) && (iScreenBufferUid == KHuiUidBackBufferScreen0)))

        {            

        iDisplay = 

            Session().SharedHuiEnv()->DisplayCount() ? 

                &Session().SharedHuiEnv()->PrimaryDisplay() : 

                &Session().SharedHuiEnv()->NewDisplayL( rect, Session().AlfAppUi()->Container(), 0,

                	NULL,  CHuiDisplay::EDisplayNormal, iScreenBufferUid );

        Session().AlfAppUi()->AppendDisplayOnSharedWindowL(*iDisplay);

        #ifdef TFXSERVER_API_V2

		// Register to Tfx Server

        MTransitionServer2* tfxServer = Session().AlfServer()->TfxServer();

        if (tfxServer)

        	{

        	// Note: if this returns KErrNotFound, it is also send to Tfx server

        	TInt wgId = Session().ClientWindowGroup();

       		// Just ignore returned error code. Can this cause trouble? 

       		tfxServer->RegisterApp(MTransitionServer2::ETypeAlf, wgId, KNullUid, KNullUid);

        	}

   		#endif

        }

    // Off screen buffer    

    else if (iDisplayType == CHuiDisplay::EDisplayOffScreenBuffer)

        {            

        iDisplay = &Session().SharedHuiEnv()->NewDisplayL( rect, Session().AlfAppUi()->Container(), 0, NULL, iDisplayType, iScreenBufferUid );

        TRect clipped = rect;

        if (clipped.Intersects(iRect))

            {

            clipped.Intersection(iRect);        

            }

        iDisplay->SetVisibleArea(clipped);        

        }

    // Shared TV-out display    

    else if (IsTvOut())

        {

        if (Session().SharedHuiEnv()->DisplayCount() == 0)

            {

            // Primary lcd must exist before tv out is created            

            User::Leave(KErrNotFound);                    

            }                

        else

            {                

            iDisplay = &Session().SharedHuiEnv()->NewDisplayL( iRect,

                 Session().AlfAppUi()->Container(),

                 0, 

                 &Session().SharedHuiEnv()->PrimaryDisplay(), 

                 CHuiDisplay::EDisplayNormal, 

                 KHuiUidBackBufferTvOutNormal

                 );                  

            }

        }  

     else

     	{

     	User::Leave(KErrNotFound); 

     	} 

    // If we have screen buffer observers for the new display, add Alf server as an observer 	

    TAlfScreenBufferEvent event = {iScreenBufferUid, MHuiScreenBufferObserver::ECreated, TRect(), TRect()};

    if (Session().AlfServer()->ScreenBufferManager().TriggerScreenBufferEvent(event))

    	{

    	iDisplay->AddScreenBufferObserverL(&Session().AlfServer()->ScreenBufferManager());

    	}

    }

// ---------------------------------------------------------------------------

// NewL

// ---------------------------------------------------------------------------

//

CAlfSrvDisplaySubSession* CAlfSrvDisplaySubSession::NewL( 

    CAlfAppSrvSessionBase& aSession,

    const TRect& aRect,

    TInt aWindowGroupId,

    TInt aDisplayType,

    const TUid& aBufferUid )

    {

    CAlfSrvDisplaySubSession* self = 

        CAlfSrvDisplaySubSession::NewLC( aSession, aRect, aWindowGroupId, aDisplayType, aBufferUid );

    CleanupStack::Pop( self );

    return self;

    }

// ---------------------------------------------------------------------------

// NewLC

// ---------------------------------------------------------------------------

//

CAlfSrvDisplaySubSession* CAlfSrvDisplaySubSession::NewLC( 

    CAlfAppSrvSessionBase& aSession,

    const TRect& aRect,

    TInt aWindowGroupId,

    TInt aDisplayType,

    const TUid& aBufferUid )

    {

    CAlfSrvDisplaySubSession* self = 

        new( ELeave ) CAlfSrvDisplaySubSession( aSession, aRect, aWindowGroupId, aDisplayType, aBufferUid);

    CleanupClosePushL( *self );

    self->ConstructL();

    return self;

    }

// ---------------------------------------------------------------------------

// Destructor

// ---------------------------------------------------------------------------

//

CAlfSrvDisplaySubSession::~CAlfSrvDisplaySubSession()

    {

    if (iDisplay && (IsTvOut() || (iDisplayType == CHuiDisplay::EDisplayOffScreenBuffer)))

        {

        if (IsTvOut())

        	{

   	        Session().AlfAppUi()->RemoveTvDisplayOnSharedWindow(*iDisplay);

        	}

        delete iDisplay;    

        }

    iDisplay = NULL;

    iBackgroundItems.Close();    

    // If we are deleting shared screen subsession, deregister to Tfx Server

    if ((iDisplayType == CHuiDisplay::EDisplayLcd0) || 

    	((iDisplayType == CHuiDisplay::EDisplayNormal) && (iScreenBufferUid == KHuiUidBackBufferScreen0)))

    	{  

        #ifdef TFXSERVER_API_V2

    	MTransitionServer2* tfxServer = Session().AlfServer()->TfxServer();

    	if (tfxServer)

    		{

        	// Note: if this returns KErrNotFound, it is also send to Tfx server

        	TInt wgId = Session().ClientWindowGroup();

			tfxServer->UnregisterApp(MTransitionServer2::ETypeAlf, wgId);

        	}

    	#endif

        }

    }

// ---------------------------------------------------------------------------

// Gets display

// ---------------------------------------------------------------------------

//

CHuiDisplay& CAlfSrvDisplaySubSession::Display()

    {

    return *iDisplay;

    }

// ---------------------------------------------------------------------------

// Sets background clear mode.

// ---------------------------------------------------------------------------

//    

void CAlfSrvDisplaySubSession::SetClearBackgroundL( const RMessage2& aMessage )

    {

    CAlfAppSrvSession& session = static_cast<CAlfAppSrvSession&>(Session());

    // Parse parameters

    // 1: clear background (in)

    const TInt clearBackground = aMessage.Int1();

    if ( session.IsFocused() )

        {

        // Clear the background items, those are not used in this case

        iBackgroundItems.Reset();

        // Set background

        TRAPD(err, Display().SetClearBackgroundL( CHuiDisplay::TClearMode( clearBackground )) );

        // Don't let client see timeout errors from our internal services implementation

        if( err != KErrNone && err != KErrTimedOut ) 

            {

            User::Leave(err);

            }

        }

    // Complete

    aMessage.Complete( KErrNone );

    // Store value for this client

    iDisplayClearBackground = clearBackground;

    }

// ---------------------------------------------------------------------------

// Sets visible area.

// ---------------------------------------------------------------------------

//

void CAlfSrvDisplaySubSession::SetVisibleAreaL( const RMessage2& aMessage, TBool aForce )

    {

    // Parse parameters

    // 1: area rect (in)

    TRect rect;

    TPckg<TRect> rectPckg(rect); 

    aMessage.Read(1,rectPckg);

		CAlfAppSrvSession& session = static_cast<CAlfAppSrvSession&>(Session());	        

    // Set clipping rect for display visible area to e.g. avoid unnecesssary 

    // drawing under Avkon status/control pane areas. TV out does not show

    // those so no clipping in that case.

    if (UseVisualAreaClipping())

       {

       iRect = rect;

			if ( session.IsFocused() )

        		{

    	      TRect clipped = Session().AlfAppUi()->Container()->Rect();

#ifndef SYMBIAN_BUILD_GCE

		       	if (clipped.Intersects(rect))

		           {

		           clipped.Intersection(rect);        

		           }

#endif           

		       	iDisplay->SetVisibleAreaClippingRect(clipped);        

		       	iDisplay->SetDirty();

	        	}

	       }           

    // Set visible area        

			if ( session.IsFocused() || aForce )

        		{

    		    static_cast<CAlfAppSrvSession&>(Session()).SetClientDrawingArea( rect );

        		}

    // Complete

    aMessage.Complete( KErrNone );

    }

// ---------------------------------------------------------------------------

// Returns the visible area.

// ---------------------------------------------------------------------------

//

void CAlfSrvDisplaySubSession::VisibleAreaL( const RMessage2& aMessage )

    {

    // Parse parameters

    // 2: area rect (out)

    TRect rect;

    TPckg<TRect> rectPckg(rect); 

    aMessage.Read(2,rectPckg);

    // Get visible area

    rect = static_cast<CAlfAppSrvSession&>(Session()).ClientDrawingArea();

    // Write parameters

    aMessage.Write(2,rectPckg);

    // Complete

    aMessage.Complete( KErrNone );

    }

// ---------------------------------------------------------------------------

// Sets display dirty

// ---------------------------------------------------------------------------

//    

void CAlfSrvDisplaySubSession::SetDirtyL( const RMessage2& aMessage )

    {

    CAlfAppSrvSession& session = static_cast<CAlfAppSrvSession&>(Session());

    if ( session.IsFocused() )

        {

        Display().SetDirty();    

        }

    // Complete

    aMessage.Complete( KErrNone );    

    }

// ---------------------------------------------------------------------------

// Sets display rendering quality

// ---------------------------------------------------------------------------

//    

void CAlfSrvDisplaySubSession::SetQualityL( const RMessage2& aMessage )

    {

    CAlfAppSrvSession& session = static_cast<CAlfAppSrvSession&>(Session());

    // Parse parameters

    // 1: quality (in)

    THuiQuality value = EHuiQualityAccurate;

    TPckg<THuiQuality> valuePckg(value); 

    aMessage.Read(1,valuePckg);

    if ( KAlfSrvClientQualitySupport && session.IsFocused() )

        {

        // Set quality

        Display().SetQuality(value);    

        }

    // Complete

    aMessage.Complete( KErrNone );    

    // Store value for this client

    iDisplayRenderingQuality = value;

    }

// ---------------------------------------------------------------------------

// Gets display rendering quality

// ---------------------------------------------------------------------------

//    

void CAlfSrvDisplaySubSession::QualityL( const RMessage2& aMessage )

    {

    CAlfAppSrvSession& session = static_cast<CAlfAppSrvSession&>(Session());

    // Parse parameters

    // 2: quality (out)

    THuiQuality value = EHuiQualityAccurate;

    TPckg<THuiQuality> valuePckg(value); 

    if ( KAlfSrvClientQualitySupport && session.IsFocused() )

        {

        // Get quality

        value = Display().Quality();    

        }

    else

        {

        value = THuiQuality(iDisplayRenderingQuality);

        }

    // Write parameters

    aMessage.Write(2,valuePckg);

    // Complete

    aMessage.Complete( KErrNone );    

    }

// ---------------------------------------------------------------------------

// Sets display depth test usage

// ---------------------------------------------------------------------------

//    

void CAlfSrvDisplaySubSession::SetUseDepthL( const RMessage2& aMessage )

    {

    CAlfAppSrvSession& session = static_cast<CAlfAppSrvSession&>(Session());

    // Parse parameters

    // 1: bool (in)

    TBool value = EFalse;

    TPckg<TBool> valuePckg(value); 

    aMessage.Read(1,valuePckg);

    // Update value if the client is on focus

    if ( session.IsFocused() )

        {

        // Set use depth

        Display().SetUseDepth(value);    

        }

    // Complete

    aMessage.Complete( KErrNone );    

    // Store value for this client

    iDisplayUseDepthTest = value;

    }

// ---------------------------------------------------------------------------

// Sets display usage

// ---------------------------------------------------------------------------

//    

void CAlfSrvDisplaySubSession::SetUsageL( const RMessage2& aMessage )

    {

    CAlfAppSrvSession& session = static_cast<CAlfAppSrvSession&>(Session());

    // Parse parameters

    // 1: TUint (in)

    TUint value = 0;

    TPckg<TUint> valuePckg(value); 

    aMessage.Read(1,valuePckg);

    // Update value if the client is on focus

    if ( session.IsFocused() )

        {

        // Set use depth

        Display().SetUsageL(value);    

        }

    // Complete

    aMessage.Complete( KErrNone );    

    // Store value for this client

    iDisplayUsage = value;

    }

// ---------------------------------------------------------------------------

// Sets visual content for the window

// ---------------------------------------------------------------------------

//    

void CAlfSrvDisplaySubSession::SetClientWindowForDrawingL( const RMessage2& aMessage )

    {

    CAlfAppSrvSession& session = static_cast<CAlfAppSrvSession&>(Session());

    // Parse parameters

    // 1: TUint (in)

    TInt3 data(0,0,0);

    TPckg<TInt3> dataPckg(data); 

    aMessage.Read(1,dataPckg);    

    // Update value even if the client is not in focus

    CHuiVisual* visual = NULL;

    TInt visualHandle = data.iInt3;

    if (visualHandle)

    	{

    	visual = (CHuiVisual*) Session().GetInterfaceL(EHuiObjectTypeVisual, visualHandle);

    	}

		Session().AlfAppUi()->SetClientWindowForDrawingL(data.iInt1, data.iInt2, visual);

    // Complete

    aMessage.Complete( KErrNone );    

    }

// ---------------------------------------------------------------------------

// Sets display bqckground items

// ---------------------------------------------------------------------------

//