sl@0: // Copyright (c) 2004-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: // Defines the screen class (was in scrdev.h)
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef __SCREEN_H__
sl@0: #define __SCREEN_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <e32base.h>
sl@0: #include <w32std.h>	
sl@0: #include "w32cmd.h"
sl@0: #include "wstypes.h"
sl@0: 
sl@0: #include <Graphics/WSGRAPHICDRAWERINTERFACE.H>
sl@0: 
sl@0: class CWsDirectScreenAccess;
sl@0: 
sl@0: class CWsOffScreenBitmap;
sl@0: class CWsWindowGroup;
sl@0: class CWsWindow;
sl@0: class CWsRootWindow;
sl@0: class CWsClientWindow;
sl@0: class CDebugBar;
sl@0: class CScreenRedraw;
sl@0: class CWsSpriteManager;
sl@0: 
sl@0: class CScreen : public CBase, public MWsScreen, public MWsScreenConfig, public MWsFrontBuffer
sl@0: 	{
sl@0: 	enum {EDefaultShadowX=2};
sl@0: 	enum {EDefaultShadowY=2};
sl@0: public:
sl@0: 	enum {EGetScanLineBufLen=0x100};	// Buffer of for returning result of GetScanLine
sl@0: 	enum {EMaxNumModes=EColorLast-2};		// Number of available devices in the GDI enum TDisplayMode
sl@0: 	enum TDisplayScreen
sl@0: 		{
sl@0: 		EBlankScreenOnRotation = 0x1,
sl@0: 		EAutoClear = 0x2,
sl@0: 		EBltOffScreenBitmap = 0x04,			// Refrain from clearing window to default background color
sl@0: 		};
sl@0: 	/**
sl@0: 	The fallback map is an array of 32 bit integers sufficiently large to store a single bit for any
sl@0: 	possible orientation and size of the screen, with the pixel rows padded to the end of the int.
sl@0: 	Andy - This is only used by the screen redraw, so it should be in the screen redraw, not the screen.
sl@0: 	Also, it doesnt need its own region, since the root window has the correct region already.
sl@0: 	*/
sl@0: 	class CFallbackMap : public CBase
sl@0: 		{
sl@0: 	public:
sl@0: 		static CFallbackMap * NewL(CScreen* aScreen);
sl@0: 		~CFallbackMap();
sl@0: 		
sl@0: 		void Prepare();
sl@0: 		TBool FillRegion(const TRegion& aRegion);
sl@0: 		TBool FillRect(const TRect& aRect);
sl@0: 		TInt Count() const;
sl@0: 		const TRect * Rect() const;
sl@0: 		const RRegion * Region() const;
sl@0: 
sl@0: 	private:	
sl@0: 		CFallbackMap(CScreen* aScreen);
sl@0: 		void ConstructL();
sl@0: 		
sl@0: 	public:
sl@0: 		CScreen* iScreen;
sl@0: 		RRegionBuf<1> iRegion;
sl@0: 		TInt iCount;
sl@0: 		TInt iMapSize; // size in padded TInts
sl@0: 		TInt * iMap;
sl@0: 		};
sl@0: public:
sl@0: 	CScreen();
sl@0: 	~CScreen();
sl@0: 	void ConstructL( const TRect& aDigitiserArea, TInt aScreenNumber );
sl@0: 	void AbortAllDirectDrawing(RDirectScreenAccess::TTerminationReasons aReason);
sl@0: 	void AddDirect(CWsDirectScreenAccess& aDirect);
sl@0: 	void RemoveDirect(CWsDirectScreenAccess& aDirect);
sl@0: 	void AbortDSAs(RDirectScreenAccess::TTerminationReasons aReason,TSglQue<CWsDirectScreenAccess>& aDirects);
sl@0: #if defined(_DEBUG)
sl@0: 	TBool IsDirectOnQueue(const CWsDirectScreenAccess* aDirect);
sl@0: #if defined(__WINS__)
sl@0: 	void UpdateOffScreenBitmap();
sl@0: #endif
sl@0: #endif
sl@0: 
sl@0: 	inline CWsWindowGroup* FocusWindowGroup();
sl@0: 	void KillForegroundSession();
sl@0: 	void ResetFocus(CWsWindowGroup *aClosingWindow);
sl@0: 	void SetShadowVector(const TPoint &aShadowShift);
sl@0: 	inline TPoint ShadowVector();
sl@0: 	inline TBool BlankScreenOnRotation();
sl@0: 	inline TBool AutoClear();
sl@0: 	void RemoveFromDefaultOwningList(CWsWindowGroup *aDestroyedGroup);
sl@0: 	void SetDefaultOwningWindow(CWsWindowGroup *aGroup);
sl@0: 	inline CWsWindowGroup *DefaultOwningWindowGroup();
sl@0: 
sl@0: 	void CheckDisplayMode(TBool aUpdateNow);
sl@0: 	CFbsScreenDevice *ScreenDevice();
sl@0: 	inline CWsRootWindow* RootWindow() const;
sl@0: 	inline TInt ScreenNumber() const;
sl@0: 	void Update();
sl@0: 	void Update(const TRegion &aRegion);
sl@0: 	inline TDisplayMode CurrentDisplayMode();
sl@0: 	inline TDisplayMode DefaultDisplayMode();
sl@0: 	inline TDisplayMode DefaultDisplayMode(const TInt aMode) const;
sl@0: 	TDisplayMode FirstDefaultDisplayMode() const;
sl@0: 	//
sl@0: 	inline CFbsBitGc *ScreenGdi();
sl@0: 	void MaxNumColors(TInt& aColors,TInt& aGrays);
sl@0: 	TInt ColorModesFlag();
sl@0: 	inline void GetFadingParams(TUint8& aBlackMap,TUint8& aWhiteMap) const;
sl@0: 	inline void SetFadingParams(TUint8 aBlackMap,TUint8 aWhiteMap);
sl@0: 	void GetScanLine(const TWsSdCmdGetScanLine *aGetScanLine);
sl@0: 
sl@0: 	TBool SetScreenModeEnforcement(TInt aMode);
sl@0: 	inline TInt ScreenSizeMode() const;
sl@0: 	void SetPointerCursorArea(TInt aMode,const TRect& aRect);
sl@0: 	inline TRect GetPointerCursorArea(TInt aMode) const;
sl@0: 	CFbsBitGc::TGraphicsOrientation Orientation();
sl@0: 	void CycleDisplaySize();
sl@0: 	void UpdateOrientation();
sl@0: 	void doSetScreenMode(TInt aMode);
sl@0: 	inline TSize CurrentScreenSize() const;
sl@0: 	TRect DrawableArea() const;
sl@0: 	void CycleOrientation();
sl@0: 	TClientPanic SetModeRotation(TInt aMode,CFbsBitGc::TGraphicsOrientation aRotation);
sl@0: 	void LoadScreenSizesL(TSize aScreenSize);
sl@0: 	void LoadScreenSizeProperties();
sl@0: 	void LoadScreenScale();
sl@0: 	void SetDigitiserAreas(const TSize& aScreenSize,const TRect& aDigitiserArea);
sl@0: 	inline TInt NumScreenSizeModes() const;
sl@0: 	inline const TSizeMode& ScreenSizeModeData() const;
sl@0: 	inline const TSizeMode& ScreenSizeModeData(TInt aMode) const;
sl@0: 	inline TPoint ScreenModeOrigin(TInt aMode);
sl@0: 	inline TPoint CurrentScreenModeOrigin();
sl@0: 	inline TSize CurrentScreenModeScale();
sl@0: 	inline TPoint CurrentScreenModeScaledOrigin();
sl@0: 	inline TPoint ScreenModeScaledOrigin(TInt aMode);
sl@0: 	inline TScreenModeEnforcement SizeEnforcementMode() const;
sl@0: 	void GetScreenSizeAndRotation(TPixelsTwipsAndRotation &aSar, TInt aScreenMode);
sl@0: 	void GetScreenSizeAndRotation(TPixelsAndRotation &aSar, TInt aScreenMode);
sl@0: 	inline TSize GetScreenScale(TInt aMode) const;
sl@0: 	inline void SetCurrentScreenModeAttributes(const TSizeMode &aModeData);
sl@0: 	inline TSize GetPhysicalScreenSize();
sl@0: 	inline void SetPhysicalScreenSize();
sl@0: 	inline TBool ShouldSwapWidthAndHeightOffScBitmap(TInt aOldRotation);
sl@0: 	inline TInt Modes();
sl@0: 	CFbsDevice * DrawDevice();
sl@0: 	CWsOffScreenBitmap* OffScreenBitmap();
sl@0: 	void FreeOffScreenBitmap();
sl@0: 	void UpdateGcs();
sl@0: 	inline void SetScalingFactor();
sl@0: 	void UpdateOffScreenBitmapGc(const TBool aSwapWidthAndHeight);
sl@0: 	TPoint PhysicalToLogical(TPoint aPhysicalPt);
sl@0: 	void IncContrast();
sl@0: 	void DecContrast();
sl@0: 	void IncBrightness();
sl@0: 	void DecBrightness();
sl@0: 	inline TBool IsValidScreenSizeMode(TInt aMode);
sl@0: 	TInt GetScreenSizeModeListL();
sl@0: 	void SetDisplayModeFromName(const TDesC& aModeName, TDisplayMode& aMode);
sl@0: 	CFbsDevice* GetFbsDevice();
sl@0: 	// called by CWsGc when it is implementing MWsGc
sl@0: 	const TTime& Now() const;
sl@0: 	void ScheduleAnimation(const TRect& aRect,const TTimeIntervalMicroSeconds& aFromNow,const TTimeIntervalMicroSeconds& aFreq,const TTimeIntervalMicroSeconds& aStop);
sl@0: 	// redraw scheduling code
sl@0: 	void AddRedrawRegion(const TRegion& aRegion, TBool aSchedule = ETrue, TRedrawDepth aDepth = ERedrawAll);
sl@0: 	void DoRedrawNow();
sl@0: 	void ScheduleRegionUpdate(const TRegion* aDefinitelyDirty);
sl@0: 	void EndClientBuffer();
sl@0: 	// implementing MWsScreen
sl@0: 	void OnAnimation();
sl@0: 	void Redraw();
sl@0: 	TBool RedrawInvalid(const TArray<TGraphicDrawerId>& aInvalid);
sl@0: 	inline TBool BackLightFlag();
sl@0: 	// implementing interface extension
sl@0: 	TAny* ResolveObjectInterface(TUint aTypeId);
sl@0: 	// implementing MWsScreenConfig interface	
sl@0: 	TDisplayMode DisplayMode() const;
sl@0: 	TSize SizeInPixels() const;
sl@0: 	TSize ScreenModeSizeInPixels() const;
sl@0: 	TInt Stride() const;
sl@0: 	CFbsBitGc::TGraphicsOrientation Orientation() const;
sl@0: 	TInt SizeMode() const;
sl@0: 	TSize ScalingFactor() const;
sl@0: 	TPoint Origin() const;
sl@0: 	TPoint ScaledOrigin() const;
sl@0: 	// implementing MWsFrontBuffer
sl@0: 	const TAny* GetBits();
sl@0: 	CFbsBitGc* GetBitGc();
sl@0: 	CFbsBitGc* GetBitGcCurrent();
sl@0: 	TInt SetBitGc(CFbsBitGc* aBitGc);
sl@0: 	TInt SetBitGc(CFbsBitGc* aBitGc, TBool aInvalidateScreen);
sl@0: 	inline TBool IsOffScreenBitmap();
sl@0: 	inline TBool MaskingEnabled();
sl@0: 	inline TBool BltOffScreen();
sl@0: 	void RecalcHeights();
sl@0: 	void DiscardAllSchedules();
sl@0: 	inline CDebugBar * DebugBar();
sl@0: 	inline CFallbackMap * FallbackMap();
sl@0: 	inline CWsSpriteManager* SpriteManager();
sl@0: 	inline MWsFader* Fader();
sl@0: 	TBool IsUpdatePending();
sl@0: 	void DSARegionSyncStart( CWsDirectScreenAccess& aDSA );
sl@0: 	void DSARegionSyncOver( CWsDirectScreenAccess& aDSA );
sl@0: 	TBool HasVisibleDirectOnQueue();
sl@0: 	TBool IsDSAClientWindow( const CWsClientWindow* aWin ) const;
sl@0: 	void AcceptFadeRequest( CWsWindow* aWin, TBool	aIsFaded, TBool aIsBehind, TBool aIncludeChildren = EFalse );
sl@0: 
sl@0: private:
sl@0: 	enum TSyncConsts
sl@0: 		{
sl@0: 		KDSAAbortingImmediateRespAwaitFrameMicrosec = 80000		// 0.08 sec
sl@0: 		};
sl@0: private:
sl@0: 	void ChangeDisplayModeForAllOffScreenBitmap(TBool aSwapWidthAndHeight=EFalse);
sl@0: 	void SetInitialScreenSizeMode();
sl@0: 	CWsWindowGroup* FindNewFocus(CWsRootWindow* aRootWindow);
sl@0: 	void CreateFallbackMapL();
sl@0: 	void CreateScreenDeviceL();
sl@0: 	TBool DoCreateScreenDevice(TDisplayMode aScreenMode);
sl@0: private:
sl@0: 	enum
sl@0: 		{
sl@0: 		eTimerCreated=0x1,
sl@0: 		};
sl@0: 	enum TDsaDrawState
sl@0: 		{
sl@0: 		EDsaDrawStateIdle,
sl@0: 		EDsaDrawStateDrawing
sl@0: 		};
sl@0: private:
sl@0: 	TSglQue<CWsDirectScreenAccess> iDirects;
sl@0: 	RTimer iTimer;
sl@0: 	TRequestStatus iTimerStatus;
sl@0: 	TUint iFlags;
sl@0: 
sl@0: 	CScreenRedraw* iRedraw;
sl@0: 
sl@0: 	CWsRootWindow* iRootWindow;
sl@0: 	CWsWindowGroup *iCurrentFocus;
sl@0: 	CWsWindowGroup *iDefaultOwningWindow;
sl@0: 	CWsOffScreenBitmap* iOffScreenBitmap;
sl@0: 	TPoint iShadowShift;
sl@0: 
sl@0: 	CFbsScreenDevice *iScreenDevice;
sl@0: 	CFbsBitGc *iScreenGdi;
sl@0: 
sl@0: // Size and roation members
sl@0: 	RPointerArray<TSizeMode> *iModes;
sl@0: 	TInt iScreenSizeMode;
sl@0: 	TScreenModeEnforcement iSizeEnforcementMode;
sl@0: 	TSize iPhysicalScreenSize;
sl@0: 	TInt iScreenNumber;
sl@0: 	TInt iMaxContrast;
sl@0: 	TInt iMaxBrightness;
sl@0: 	TInt iNumScreenSizeModes;
sl@0: 	TInt iNumSupportedScreenSizeModes;
sl@0: 	TBool iBackLightFlag;
sl@0: 	
sl@0: 	// used by MWsFrontBuffer to redirect screen output
sl@0: 	CFbsBitGc* iRedirectGc;
sl@0: 
sl@0: 	TDsaDrawState iDsaDrawState;
sl@0: 	CDebugBar* iDebugBar;
sl@0: 	CFallbackMap* iFallbackMap;
sl@0: 	TUint8 iBlackMap;
sl@0: 	TUint8 iWhiteMap;
sl@0: 	CWsSpriteManager* iSpriteManager;
sl@0: 	MWsFader* iFader;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: //
sl@0: // inlines			//
sl@0: //
sl@0: 
sl@0: //
sl@0: // CScreen
sl@0: //
sl@0: inline void CScreen::Update(const TRegion &aRegion)
sl@0: 	{iScreenDevice->Update(aRegion);}
sl@0: inline TPoint CScreen::ShadowVector()
sl@0: 	{return(iShadowShift);}
sl@0: inline CWsWindowGroup* CScreen::FocusWindowGroup()
sl@0: 	{return(iCurrentFocus);}
sl@0: inline TBool CScreen::BlankScreenOnRotation()
sl@0: 	{return(iFlags&EBlankScreenOnRotation);}
sl@0: inline TBool CScreen::AutoClear()
sl@0: 	{return(iFlags&EAutoClear);}
sl@0: inline CWsWindowGroup* CScreen::DefaultOwningWindowGroup()
sl@0: 	{return(iDefaultOwningWindow);}
sl@0: 
sl@0: inline CWsRootWindow* CScreen::RootWindow() const
sl@0: 	{return iRootWindow;}
sl@0: inline TInt CScreen::ScreenNumber() const
sl@0: 	{return iScreenNumber;}
sl@0: 
sl@0: inline CFbsBitGc *CScreen::ScreenGdi()
sl@0: 	{return(iScreenGdi);}
sl@0: inline TDisplayMode CScreen::CurrentDisplayMode()
sl@0: 	{return iScreenDevice->DisplayMode();}
sl@0: inline TDisplayMode CScreen::DefaultDisplayMode()
sl@0: 	{return iScreenDevice->DisplayMode();}
sl@0: //
sl@0: inline TInt CScreen::ScreenSizeMode() const
sl@0: 	{return(iScreenSizeMode);}
sl@0: inline TRect CScreen::GetPointerCursorArea(TInt aMode) const
sl@0: 	{return (*iModes)[aMode]->iPointerCursorArea;}
sl@0: inline TSize CScreen::CurrentScreenSize() const
sl@0: 	{return (*iModes)[iScreenSizeMode]->iScreenSize;}
sl@0: inline TInt CScreen::NumScreenSizeModes() const
sl@0: 	{return iNumScreenSizeModes;}
sl@0: inline const TSizeMode& CScreen::ScreenSizeModeData() const
sl@0: 	{return *(*iModes)[iScreenSizeMode];}
sl@0: inline const TSizeMode& CScreen::ScreenSizeModeData(TInt aMode) const
sl@0: 	{return *(*iModes)[aMode];}
sl@0: inline TPoint CScreen::ScreenModeOrigin(TInt aMode)
sl@0: 	{return (*iModes)[aMode]->iOrigin;}
sl@0: inline TPoint CScreen::CurrentScreenModeOrigin()
sl@0: 	{return (*iModes)[iScreenSizeMode]->iOrigin;}
sl@0: inline TSize CScreen::CurrentScreenModeScale()
sl@0: 	{return (*iModes)[iScreenSizeMode]->iScreenScale;}
sl@0: inline TPoint CScreen::CurrentScreenModeScaledOrigin()
sl@0: 	{return (*iModes)[iScreenSizeMode]->ScaledOrigin();}
sl@0: inline TPoint CScreen::ScreenModeScaledOrigin(TInt aMode)
sl@0: 	{return (*iModes)[aMode]->ScaledOrigin();}
sl@0: inline TSize CScreen::GetScreenScale(TInt aMode) const
sl@0: 	{return (*iModes)[aMode]->iScreenScale;}
sl@0: inline TDisplayMode CScreen::DefaultDisplayMode(const TInt aMode) const
sl@0: 	{return (*iModes)[aMode]->iDefaultDisplayMode;}
sl@0: inline TSize CScreen::GetPhysicalScreenSize()
sl@0: 	{return iPhysicalScreenSize;}
sl@0: inline void CScreen::SetScalingFactor()
sl@0: 	{iScreenDevice->SetScalingFactor((*iModes)[iScreenSizeMode]->iOrigin,(*iModes)[iScreenSizeMode]->iScreenScale.iWidth,(*iModes)[iScreenSizeMode]->iScreenScale.iHeight,1,1);}
sl@0: inline void CScreen::SetCurrentScreenModeAttributes(const TSizeMode &aModeData)
sl@0: 	{*(*iModes)[iScreenSizeMode]=aModeData;}
sl@0: inline void CScreen::SetPhysicalScreenSize()
sl@0: 	{TInt temp=iPhysicalScreenSize.iWidth;iPhysicalScreenSize.iWidth=iPhysicalScreenSize.iHeight;iPhysicalScreenSize.iHeight=temp;}
sl@0: inline TScreenModeEnforcement CScreen::SizeEnforcementMode() const
sl@0: 	{return iSizeEnforcementMode;}
sl@0: inline TBool CScreen::IsValidScreenSizeMode(TInt aMode)
sl@0: 	{return (aMode>=0 && aMode<iModes->Count() && (*iModes)[aMode]!=NULL);}
sl@0: inline TBool CScreen::BackLightFlag()
sl@0: 	{return iBackLightFlag;}
sl@0: inline TBool CScreen::IsOffScreenBitmap()
sl@0: 	{return iOffScreenBitmap!=NULL;}
sl@0: 
sl@0: inline CDebugBar * CScreen::DebugBar()
sl@0: 	{return iDebugBar;}
sl@0: inline CScreen::CFallbackMap * CScreen::FallbackMap()
sl@0: 	{return iFallbackMap;}
sl@0: 	
sl@0: inline void CScreen::GetFadingParams(TUint8& aBlackMap,TUint8& aWhiteMap) const
sl@0:     {aBlackMap=iBlackMap;aWhiteMap=iWhiteMap;}
sl@0: inline void CScreen::SetFadingParams(TUint8 aBlackMap,TUint8 aWhiteMap)
sl@0: 	{iBlackMap=aBlackMap;iWhiteMap=aWhiteMap;}
sl@0: inline CWsSpriteManager* CScreen::SpriteManager()
sl@0: 	{return iSpriteManager;}
sl@0: inline MWsFader* CScreen::Fader()
sl@0: 	{return iFader;}
sl@0: inline TBool CScreen::BltOffScreen()
sl@0: 	{return iFlags&EBltOffScreenBitmap;}
sl@0: #endif