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

// Shells for window server screen device

// 

//

#include <e32std.h>

#include <e32hal.h>

#include "../SERVER/w32cmd.h"

#include "CLIENT.H"

#include "w32comm.h"

#include "scrdevextension.h"

const TInt KDefaultScreenNumber = 0 ;

EXPORT_C CWsScreenDevice::CWsScreenDevice()

/** Default constructor. Developers should use the other constructor overload. */

	{

	}

EXPORT_C CWsScreenDevice::CWsScreenDevice(RWsSession &aWs) : MWsClientClass(aWs.iBuffer)

/** Constructs a new screen device attached to a particular window server session.

@param aWs The window server session this screen should be attached to. */

	{

	}

EXPORT_C TInt CWsScreenDevice::CreateContext(CGraphicsContext *&aGc)

/** Creates a graphics context for this device.

This function always causes a flush of the window server buffer.

@param aGc On successful return, contains a new graphics context referring 

to this screen device. 

@return KErrNone if successful, otherwise one of the system-wide error codes. 

@see CGraphicsDevice::CreateContext() */

	{

	if ((aGc=new CWindowGc(this))==NULL)

		return(KErrNoMemory);

	TInt err=((CWindowGc *)aGc)->Construct();

	if (err!=KErrNone)

		{

		delete aGc;

		aGc=NULL;

		}

	return(err);

	}

EXPORT_C CWsScreenDevice::~CWsScreenDevice()

/** Destructor. */

	{

	if (iBuffer)

		{

		if (iWsHandle)

			Write(EWsSdOpFree);

		}

	if (iExtension)

		{

		delete TypeFaceStore();

		delete iExtension;

		}

	}

#pragma warning(disable : 4710)

/** 

Completes construction of the object.

This method invokes Construct(TInt aDefaultScreenNumber) with default Screen number.

@return KErrNone if successful, otherwise another of the system-wide error codes. 

*/

EXPORT_C TInt CWsScreenDevice::Construct()

	{

	return Construct( KDefaultScreenNumber ) ;

	}

EXPORT_C TInt CWsScreenDevice::Construct(TInt aDefaultScreenNumber)

/** Completes construction of the object.

This function always causes a flush of the window server buffer.

@param aDefaultScreenNumber - This is the screen on which an application will start

@return KErrNone if successful, otherwise another of the system-wide error 

codes. 

@panic TW32Panic 17 in debug builds if called on an already constructed object.*/

	{

	__ASSERT_DEBUG(iWsHandle == KNullHandle, Panic(EW32PanicGraphicDoubleConstruction));

	TInt ret;

	TWsClCmdCreateScreenDevice createScreenDevice;

	createScreenDevice.screenNumber = aDefaultScreenNumber;

	createScreenDevice.clientScreenDevicePointer = (TUint)this;

	if ( ( ret=iBuffer->WriteReplyWs(&createScreenDevice,sizeof(createScreenDevice),EWsClOpCreateScreenDevice ) ) < 0 )

		{

		iBuffer=NULL;

		}

	else

		{

		iWsHandle=ret;

		//If the extension fails to allocate then clients will be refused access to the extension interface.

		TRAP(ret,iExtension=new(ELeave) CScrDevExtension(iBuffer,iWsHandle));

		if (ret>=KErrNone)

			{

			TRAP(ret,iExtension->SetTypefaceStore(CFbsTypefaceStore::NewL(this)));

			}

		iDisplaySizeInPixels=SizeInPixels();

		iPhysicalScreenSizeInTwips=SizeInTwips();

		if (iDisplaySizeInPixels.iWidth==0)

			{

			TMachineInfoV1Buf macInfo;

			UserHal::MachineInfo(macInfo);

			iPhysicalScreenSizeInTwips=macInfo().iPhysicalScreenSize;

			iDisplaySizeInPixels=macInfo().iDisplaySizeInPixels;

			}

		}

	return(ret);

	}

#pragma warning(default : 4710)

EXPORT_C TDisplayMode CWsScreenDevice::DisplayMode() const

/** Gets the device's display mode.

This function always causes a flush of the window server buffer.

@return The device's display mode. 

@see CGraphicsDevice::DisplayMode() */

	{

	return((TDisplayMode)WriteReply(EWsSdOpDisplayMode));

	}

EXPORT_C TRect CWsScreenDevice::PointerRect() const

/** Gets the active area for the pointing device. 

This is a device-dependent parameter, and will typically depend on the screen 

size and other factors.

This function always causes a flush of the window server buffer.

@return The active area, measured in pixels. */

	{

	TPckgBuf<TRect> rectPkg;

  	WriteReplyP(&rectPkg,EWsSdOpPointerRect);

	return(rectPkg());

	}

EXPORT_C TSize CWsScreenDevice::SizeInPixels() const

/** Gets the size of the screen device area in pixels.

This function always causes a flush of the window server buffer.

@return The x and y dimensions of the screen device area, in pixels. 

@see CGraphicsDevice::SizeInPixels() */

	{

	TPckgBuf<TSize> sizePkg;

  	WriteReplyP(&sizePkg,EWsSdOpPixelSize);

	return(sizePkg());

	}

EXPORT_C TSize CWsScreenDevice::SizeInTwips() const

/** Gets the size of the screen device area in twips.

This function always causes a flush of the window server buffer.

@return The x and y dimensions of the screen device area, in twips. 

@see CGraphicsDevice::SizeInTwips() */

	{

	TPckgBuf<TSize> sizePkg;

  	WriteReplyP(&sizePkg,EWsSdOpTwipsSize);

	return(sizePkg());

	}

EXPORT_C TInt CWsScreenDevice::HorizontalTwipsToPixels(TInt aTwips) const

/** Translates a twips to a pixel value.

@param aTwips The value in twips. 

@return The equivalent number of pixels. 

@see MGraphicsDeviceMap::HorizontalTwipsToPixels() */

	{

	TInt64 twips=aTwips;

	twips=(twips*iDisplaySizeInPixels.iWidth+(iPhysicalScreenSizeInTwips.iWidth/2))/iPhysicalScreenSizeInTwips.iWidth;

	return I64INT(twips);

	}

EXPORT_C TInt CWsScreenDevice::VerticalTwipsToPixels(TInt aTwips) const

/** Translates a vertical dimension of a screen device in twips into pixels.

@param aTwips A vertical dimension of a device in twips. 

@return The vertical dimension in pixels. */

	{

	TInt64 twips=aTwips;

	twips=(twips*iDisplaySizeInPixels.iHeight+(iPhysicalScreenSizeInTwips.iHeight/2))/iPhysicalScreenSizeInTwips.iHeight;

	return I64INT(twips);

	}

EXPORT_C TInt CWsScreenDevice::HorizontalPixelsToTwips(TInt aPixels) const

/** Translates a specified pixel value to a twips value. 

@param aPixels The value in pixels to be translated. 

@return The equivalent number of twips. */

	{

	TInt64 pixels=aPixels;

	pixels=(pixels*iPhysicalScreenSizeInTwips.iWidth+(iDisplaySizeInPixels.iWidth/2))/iDisplaySizeInPixels.iWidth;

	return I64INT(pixels);

	}

EXPORT_C TInt CWsScreenDevice::VerticalPixelsToTwips(TInt aPixels) const

/** Translates a vertical dimension of a screen device in pixels into twips.

@param aPixels A vertical dimension of a device in pixels. 

@return The vertical dimension in twips. 

@see MGraphicsDeviceMap::VerticalPixelsToTwips() */

	{

	TInt64 pixels=aPixels;

	pixels=(pixels*iPhysicalScreenSizeInTwips.iHeight+(iDisplaySizeInPixels.iHeight/2))/iDisplaySizeInPixels.iHeight;

	return I64INT(pixels);

	}

EXPORT_C void CWsScreenDevice::GetPixel(TRgb &aColor,const TPoint &aPixel) const

/** Gets the RGB colour of an individual pixel on a screen device.

This function always causes a flush of the window server buffer.

@param aColor On return, contains the RGB colour of the pixel. 

@param aPixel The x,y co-ordinates of the pixel. The top left pixel is (0,0).

@see CBitmapDevice::GetPixel() */

	{

	aColor.SetInternal(((TUint32)WriteReply(&aPixel,sizeof(aPixel),EWsSdOpPixel)));

	}

EXPORT_C void CWsScreenDevice::GetScanLine(TDes8 &aScanLine,const TPoint &aStartPixel,TInt aPixelLength, TDisplayMode aDispMode) const

/** Gets a scanline into a buffer. 

The pixels are converted from the current screen display mode format 

to the format of the specified device display mode.

By specifying the start pixel and number of pixels either the whole or a portion 

of a row of screen pixels may be copied.

This function always causes a flush of the window server buffer.

@param aScanLine A buffer into which pixels are copied, it must be sufficiently 

large to store all the scanline pixels. 

@param aStartPixel The (x,y) co-ordinates of the first pixel of the bitmap scanline 

to be put into the buffer. 

@param aPixelLength The number of pixels to put into the buffer.

@param aDispMode The display mode into which to convert the pixels. 

@see CBitmapDevice::GetScanLine() */

	{

	TWsSdCmdGetScanLine getScanLine(aStartPixel,aPixelLength,aDispMode);

	WriteReplyP(&getScanLine,sizeof(getScanLine),&aScanLine,EWsSdOpGetScanLine);

	}

EXPORT_C TBool CWsScreenDevice::RectCompare(const TRect &aRect1,const TRect &aRect2) const

/** Compares two areas of the screen to see if they have the same content. 

If there are any sprites on the screen they are not included in the comparison.

This function always causes a flush of the window server buffer.

@param aRect1 A rectangle. 

@param aRect2 Another rectangle. 

@return ETrue if the two screen areas are identical. */

 	{

	return RectCompare(aRect1,aRect2,ERemoveSprite);

	}

EXPORT_C TBool CWsScreenDevice::RectCompare(const TRect &aRect1,const TRect &aRect2,TUint aFlags) const

/** Compares two areas of the screen to see if they have the same content.

This function always causes a flush of the window server buffer.

@param aRect1 A rectangle. 

@param aRect2 Another rectangle.

@param aFlags EIncludeSprite to include the sprite in the compare or ERemoveSprite to remove the sprite.

@return ETrue if the two screen areas are identical. */

	{

	TWsSdCmdRectCompare rectCompare(aRect1,aRect2,aFlags);

 	return(WriteReply(&rectCompare,sizeof(rectCompare),EWsSdOpRectCompare));

 	}

EXPORT_C TInt CWsScreenDevice::CopyScreenToBitmap(const CFbsBitmap *aBitmap) const

/** Saves the entire screen to a bitmap.

This function always causes a flush of the window server buffer.

@param aBitmap Bitmap to be filled with the screen image. 

@return KErrNone if successful, otherwise one of the system-wide error codes. */

	{

	AddToBitmapArray(aBitmap->Handle());

	TWsSdCmdCopyScreenToBitmap rectCompare(aBitmap->Handle());

	return(WriteReply(&rectCompare,sizeof(rectCompare),EWsSdOpCopyScreenToBitmap));

	}

EXPORT_C TInt CWsScreenDevice::CopyScreenToBitmap(const CFbsBitmap *aBitmap, const TRect &aRect) const

/** Saves a region of the screen to a bitmap.

This function always causes a flush of the window server buffer.

@param aBitmap Bitmap to be filled with the screen region image. 

@param aRect Screen region to be saved. 

@return KErrNone if successful, otherwise one of the system-wide error codes. */

	{

	AddToBitmapArray(aBitmap->Handle());

	TWsSdCmdCopyScreenToBitmap2 rectCompare(aRect, aBitmap->Handle());

	return(WriteReply(&rectCompare,sizeof(rectCompare),EWsSdOpCopyScreenToBitmap2));

	}

EXPORT_C TInt CWsScreenDevice::GetNearestFontInTwips(CFont*& aFont,const TFontSpec& aFontSpec)

/** Gets the nearest font, in twips, to that in the specified font specification. 

This function is replaced by GetNearestFontToDesignHeightInTwips()

The font and bitmap server returns a pointer to the nearest matching font 

from those available, in aFont.

@param aFont On return, this is set to point to the device font closest to the font 

specification passed in the second argument.

@param aFontSpec An absolute font specification. 

@return KErrNone if successful, otherwise another of the system-wide error 

codes. 

@see MGraphicsDeviceMap::GetNearestFontInTwips()

@deprecated */

	{

	return GetNearestFontToDesignHeightInTwips(aFont, aFontSpec);

	}

CFbsTypefaceStore* CWsScreenDevice::TypeFaceStore()const

/** Helper member fn to access the movable typeface store.

 **/

	{

	return iExtension->TypefaceStore();

	}

EXPORT_C TInt CWsScreenDevice::GetNearestFontToDesignHeightInTwips(CFont*& aFont,const TFontSpec& aFontSpec)

/** Gets the nearest font in twips to that specified.

The font and bitmap server returns a pointer to the nearest matching font 

from those available. Matches to design height of font - this gives no

guarantees on the actual physical size of the font.

This function replaces GetNearestFontInTwips

@param aFont On return, the pointer is set to point to the device font which 

most closely approximates to the required font specification.

@param aFontSpec An absolute font specification. 

@return KErrNone, if successful; otherwise, another of the system-wide error 

codes.

@see MGraphicsDeviceMap::GetNearestFontToDesignHeightInTwips() */

	{

	return TypeFaceStore()->GetNearestFontToDesignHeightInTwips(aFont, aFontSpec);

	}

/** Gets the nearest font, in twips, to that specified. 

The font and bitmap server returns a pointer to the nearest matching font 

from those available. Matches to max height of font - this does its best 

to return a font that will fit within the maximum height specified (but 

note that variations due to hinting algorithms may rarely result in this 

height being exceeded by up to one pixel). Problems can also be 

encountered with bitmap fonts where the typeface exists but doesn't have 

a font small enough.

@param aFont On return, the pointer is set to point to the device font which 

most closely approximates to the required font specification.

@param aFontSpec An absolute font specification. 

@param aMaxHeight The maximum height within which the font must fit - this

overrides the height specified in the TFontSpec. 

@return KErrNone, if successful; otherwise, another of the system-wide error 

codes.

@see MGraphicsDeviceMap::GetNearestFontToMaxHeightInTwips() */

EXPORT_C TInt CWsScreenDevice::GetNearestFontToMaxHeightInTwips(CFont*& aFont,const TFontSpec& aFontSpec,TInt aMaxHeight)

	{

	return TypeFaceStore()->GetNearestFontToMaxHeightInTwips(aFont, aFontSpec, aMaxHeight);

	}

EXPORT_C TInt CWsScreenDevice::GetNearestFontInPixels(CFont*& aFont,const TFontSpec& aFontSpec)

/** Gets the nearest font to that specified for use by a bitmapped graphics device. 

This function is replaced by GetNearestFontToDesignHeightInPixels()

The font and bitmap server returns a pointer to the nearest matching font 

from those available, in aFont.

@param aFont On return, this is set to point to the device font that is  

closest to the font specification passed in the second argument 

@param aFontSpec An absolute font specification 

@return KErrNone if successful, otherwise another of the system-wide error 

codes. 

@see CBitmapDevice::GetNearestFontInPixels()

@deprecated */

	{

	return GetNearestFontToDesignHeightInPixels(aFont, aFontSpec);

	}

EXPORT_C TInt CWsScreenDevice::GetNearestFontToDesignHeightInPixels(CFont*& aFont,const TFontSpec& aFontSpec)

/** Gets the nearest font in pixels to that specified. 

The font and bitmap server returns a pointer to the nearest matching font 

from those available. Matches to design height of font - this gives no

guarantees on the actual physical size of the font.

This function replaces GetNearestFontInTwips

@param aFont On return, the pointer is set to point to the device font which 

most closely approximates to the required font specification.

@param aFontSpec An absolute font specification. 

@return KErrNone, if successful; otherwise, another of the system-wide error 

codes.

@see CBitmapDevice::GetNearestFontToDesignHeightInPixels() */

	{

	return TypeFaceStore()->GetNearestFontToDesignHeightInPixels(aFont, aFontSpec);

	}

/** Gets the nearest font in pixels to that specified. 

The font and bitmap server returns a pointer to the nearest matching font 

from those available. Matches to max height of font - this does its best 

to return a font that will fit within the maximum height specified (but 

note that variations due to hinting algorithms may rarely result in this 

height being exceeded by up to one pixel). Problems can also be 

encountered with bitmap fonts where the typeface exists but doesn't have 

a font small enough.

@param aFont On return, the pointer is set to point to the device font which 

most closely approximates to the required font specification.

@param aFontSpec An absolute font specification. 

@param aMaxHeight The maximum height within which the font must fit - this

overrides the height specified in the TFontSpec. 

@return KErrNone, if successful; otherwise, another of the system-wide error 

codes.

@see CBitmapDevice::GetNearestFontToMaxHeightInPixels() */

EXPORT_C TInt CWsScreenDevice::GetNearestFontToMaxHeightInPixels(CFont*& aFont,const TFontSpec& aFontSpec,TInt aMaxHeight)

	{

	return TypeFaceStore()->GetNearestFontToMaxHeightInPixels(aFont, aFontSpec, aMaxHeight);

	}

EXPORT_C TInt CWsScreenDevice::NumTypefaces() const

/** Gets the number of typefaces supported by the screen device.

@return The number of typefaces supported. 

@see CGraphicsDevice::NumTypefaces() */

	{

	return(TypeFaceStore()->NumTypefaces());

	}

EXPORT_C void CWsScreenDevice::TypefaceSupport(TTypefaceSupport& aTypefaceSupport,TInt aTypefaceIndex) const

/** Gets typeface information for a particular typeface index number.

This information is returned in aTypefaceSupport, and includes: the typeface 

name and typeface attributes (in a TTypeface object), the number of font heights, 

the maximum and minimum font heights and whether it is a scalable typeface.

@param aTypefaceSupport On return, if the function executed successfully, 

this contains the typeface information.

@param aTypefaceIndex A typeface index number, in the range zero to (NumTypefaces() 

- 1). 

@see CGraphicsDevice::TypefaceSupport() */

	{

	TypeFaceStore()->TypefaceSupport(aTypefaceSupport,aTypefaceIndex);

	}

EXPORT_C TInt CWsScreenDevice::FontHeightInTwips(TInt aTypefaceIndex,TInt aHeightIndex) const

/** Gets the height in twips of the specified font. 

The value returned is rounded up or down to the nearest font height in twips.

The specified font is the one with height index number aHeightIndex of the 

typeface with index number aTypefaceIndex.

@param aTypefaceIndex A typeface index number, in the range: 0 to (NumTypefaces() - 1). 

@param aHeightIndex A font height index number, in the range: 0 to (iNumHeights - 1). 

@return The height of the font in twips. 

@see CGraphicsDevice::FontHeightInTwips() */

	{

	return(TypeFaceStore()->FontHeightInTwips(aTypefaceIndex,aHeightIndex));

	}

EXPORT_C TInt CWsScreenDevice::FontHeightInPixels(TInt aTypefaceIndex,TInt aHeightIndex) const

/** Gets the height of the specified font in pixels.

The value returned is rounded up or down to the nearest font height in pixels.

The specified font is the one with height index number aHeightIndex of the 

typeface with index number aTypefaceIndex.

@param aTypefaceIndex A typeface index number, in the range: 0 to (NumTypefaces() - 1). 

@param aHeightIndex A font height index number, in the range: 0 to (iNumHeights - 1).

@return The height of the font in pixels. 

@see CBitmapDevice::FontHeightInPixels() */

	{

	return(TypeFaceStore()->FontHeightInPixels(aTypefaceIndex,aHeightIndex));

	}

EXPORT_C TInt CWsScreenDevice::GetFontById(CFont *&aFont,TUid aUid,const TAlgStyle& aAlgStyle)

/** Gets a font by its bitmap UID. 

Within a font file each font has its own UID. An algorithmic style is not 

part of the actual font description, but is applied to it. For example algorithmic 

bolding applies an algorithm to increase the apparent weight of each character 

in the font. Note that the algorithm is applied blindly, and that a typeface 

may already have a style e.g. it may already be bold or italic. Thus a bold 

face will appear extra-bold if algorithmic bolding is applied to it. Algorithmic 

effects are not necessarily a substitute for typeface design and should be 

used with care.

@param aFont On a successful return, contains a pointer to the new CFont. 

@param aUid UID of the bitmap font. 

@param aAlgStyle The algorithmic style to apply. 

@return KErrNone if successful, otherwise one of the system-wide error codes. */

	{

	return(TypeFaceStore()->GetFontById(aFont,aUid,aAlgStyle));

	}

EXPORT_C TInt CWsScreenDevice::AddFile(const TDesC& aName,TInt& aId)

/** Adds a font file to the device's typeface store. The specified font

file must be accessible to any process, i.e. not located inside an

application's private directory.

@param aName Name of the font file. 

@param aId ID for the font file.