// Copyright (c) 1999-2010 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:

// Command numbers and structures for client to window server communications.

// 

//

#ifndef __W32CMD_H__

#define __W32CMD_H__

#include <e32std.h>

#include <w32std.h>

#include <gdi.h>

#if defined(SYMBIAN_GRAPHICS_GCE)

#include <graphics/surfaceconfiguration.h>

#include <graphics/sgresource.h>

#endif

#include <graphics/displayconfiguration.h>

#include <graphics/displaymapping.h>

const TUint KWservMajorVersionNumber=1;

const TUint KWservMinorVersionNumber=0;

const TUint KWservBuildVersionNumber=151;

const TUint KWservLoggingDllUidValue8=268435925;

const TUid KWservLoggingDllUid8={KWservLoggingDllUidValue8};

const TUint KWservLoggingDllUidValue16=268450595;

const TUid KWservLoggingDllUid16={KWservLoggingDllUidValue16};

//const TUint KUidWservLoggingCommon=268439591;

const TUint KWservLoggingDllUidValue=KWservLoggingDllUidValue16;

const TUid KWservLoggingDllUid={KWservLoggingDllUidValue};

const TInt KDummyScreenNumber = -1;

class CClickMaker;

class CAnimDll;

class CDebugLogBase;

class TSurfaceId;

/** Creates an interface object for Shell

@publishedPartner

@released

*/

typedef TInt (*ShellEntryPoint)(TAny *);

/** Creates the key or pointer click plug-in provider interface.

When a key is pressed, a key auto repeats or when the screen is tapped with a pointer, 

the window server informs the plug-in DLL, which can then make the sound.

@publishedAll

@released

*/

typedef CClickMaker *(*CreateCClickHandler)();

/** Creates the animation dll factory interface object.

Animation DLL objects are created by the CreateCAnimDllL() function,

which is called by the window server at the request of the client.

@publishedAll

@released

*/

typedef CAnimDll* (*CreateCAnimDll)();

class WservEncoding

	{

public:

	static inline TUint Encode8BitValues(TUint8 aFirst,TUint8 aSecond);

	static inline TUint Encode8BitValues(TUint8 aFirst,TUint8 aSecond,TUint8 aThird);

	static inline TUint8 ExtractFirst8BitValue(TUint aUint);

	static inline TUint8 ExtractSecond8BitValue(TUint aUint);

	static inline TUint8 ExtractThird8BitValue(TUint aUint);

	};

struct SKeyRepeatSettings

	{

	SKeyRepeatSettings();

	TTimeIntervalMicroSeconds32 iInitialTime;

	TTimeIntervalMicroSeconds32 iTime;

	};

struct SDoubleClickSettings

	{

	SDoubleClickSettings();

	TTimeIntervalMicroSeconds32 iInterval;

	TInt iDistance;

	};

//struct SMaxNumColors

struct SDefModeMaxNumColors

	{

	SDefModeMaxNumColors();

	TInt iColors;

	TInt iGrays;

	TDisplayMode iDisplayMode;

	};

struct SEventMessageReady

	{

	TInt iWindowGroupIdentifier;

	TUid iMessageUid;

	TInt iMessageParametersSize;

	};

class TCmdSpriteMember

	{

public:

	inline TCmdSpriteMember();

	TCmdSpriteMember(const TSpriteMember &aSpriteMember);

public:

	TInt iBitmap;

	TInt iMaskBitmap;

	TBool iInvertMask;

	CGraphicsContext::TDrawMode iDrawMode;

	TPoint iOffset;			// Offset from sprites central position

	TTimeIntervalMicroSeconds32 iInterval;

	};

enum {EClientBufferSize=640};		// default buffer size

enum {EClientBufferMaxSize=0x4000};	// 16K is max buffer size

enum {EWsOpcodeHandle=0x8000};	// Indicates a new handle is included in the message header

enum {EMaxPolygonPoints=50}; // Max size polygon that can be drawn without allocing

enum {EMaxPolylinePoints=50}; // Max size polygon that can be drawn without allocing

enum {EClickLoaded=0x01, EClickLoadable=0x02};

//

// Opcodes

//

// Client opcodes

enum TWsClientOpcodes

	{

	EWsClOpDisconnect, //Keep this as the first enum value - used by test code

	EWsClOpClearHotKeys,

	EWsClOpSetHotKey,

	EWsClOpRestoreDefaultHotKey,

	EWsClOpComputeMode,

	EWsClOpEventReady,

	EWsClOpEventReadyCancel,

	EWsClOpGetEvent,

	EWsClOpPurgePointerEvents,

	EWsClOpRedrawReady,

	EWsClOpRedrawReadyCancel,

	EWsClOpGetRedraw,

	EWsClOpPriorityKeyReady,

	EWsClOpPriorityKeyReadyCancel,

	EWsClOpGetPriorityKey,

	EWsClOpSetShadowVector,

	EWsClOpShadowVector,

	EWsClOpSetKeyboardRepeatRate,

	EWsClOpGetKeyboardRepeatRate,

	EWsClOpSetDoubleClick,

	EWsClOpGetDoubleClickSettings,

	EWsClOpCreateWindowGroup,

	EWsClOpCreateWindow,

	EWsClOpCreateGc,

	EWsClOpCreateAnimDll,

	EWsClOpCreateScreenDevice,

	EWsClOpCreateSprite,

	EWsClOpCreatePointerCursor,

	EWsClOpStartSetCustomTextCursor,

	EWsClOpCompleteSetCustomTextCursor,

	EWsClOpCreateBitmap,

	EWsClOpNumWindowGroups,

	EWsClOpNumWindowGroupsAllPriorities,

	EWsClOpWindowGroupList,

	EWsClOpWindowGroupListAllPriorities,

	EWsClOpSetWindowGroupOrdinalPosition,

	EWsClOpGetWindowGroupHandle,

	EWsClOpGetWindowGroupOrdinalPriority,

	EWsClOpGetWindowGroupClientThreadId,

	EWsClOpGetWindowGroupNameFromIdentifier,

	EWsClOpGetFocusWindowGroup,

	EWsClOpGetDefaultOwningWindow,

	EWsClOpSendEventToWindowGroup,

	EWsClOpFindWindowGroupIdentifier,

	EWsClOpFindWindowGroupIdentifierThread,

	EWsClOpSetBackgroundColor,

	EWsClOpGetBackgroundColor,

	EWsClOpSetSystemPointerCursor,

	EWsClOpClearSystemPointerCursor,

	EWsClOpClaimSystemPointerCursorList,

	EWsClOpFreeSystemPointerCursorList,

	EWsClOpGetModifierState,

	EWsClOpSetModifierState,

	EWsClOpHeapCount,

	EWsClOpResourceCount,

	EWsClOpTestInvariant,

	EWsClOpHeapSetFail,

	EWsClOpRawEvent,

	EWsClOpSystemInfo,

	EWsClOpLogMessage,

	EWsClOpPasswordEntered,

	EWsClOpSendMessageToWindowGroup,

	EWsClOpSendOffEventsToShell,

	EWsClOpGetDefModeMaxNumColors,

	EWsClOpGetColorModeList,

	EWsClOpKeyEvent,

	EWsClOpSendEventToAllWindowGroup,

	EWsClOpSendEventToAllWindowGroupPriority,

	EWsClOpSetPointerCursorArea,

	EWsClOpPointerCursorArea,

	EWsClOpSetPointerCursorMode,

	EWsClOpPointerCursorMode,

	EWsClOpSetDefaultSystemPointerCursor,

	EWsClOpClearDefaultSystemPointerCursor,

	EWsClOpSetPointerCursorPosition,

	EWsClOpPointerCursorPosition,

	EWsClOpSetDefaultFadingParams,

	EWsClOpSendMessageToAllWindowGroups,

	EWsClOpSendMessageToAllWindowGroupsPriority,

	EWsClOpFetchMessage,

	EWsClOpPrepareForSwitchOff,

	EWsClOpCreateDirectScreenAccess,

	EWsClOpSetFaded,

	EWsClOpLogCommand,

	EWsClOpCreateClick,

	EWsClOpSendEventToOneWindowGroupPerClient,

#if defined(__WINS__)

	EWsClOpRemoveKeyCode,

	EWsClOpSimulateXyInput,

#endif

	EWsClOpNoFlickerFree,

	EWsClOpSetFocusScreen,

	EWsClOpGetFocusScreen,

	EWsClOpWindowGroupListAndChain,

	EWsClOpWindowGroupListAndChainAllPriorities,

	EWsClOpSetClientCursorMode,

	EWsClOpClearAllRedrawStores,

	EWsClOpCreateGraphic,

	EWsClOpGraphicMessageReady,

	EWsClOpGetGraphicMessage,

	EWsClOpGraphicMessageCancel,

	EWsClOpNumWindowGroupsOnScreen,

	EWsClOpGetNumberOfScreens, 

	EWsClOpGraphicAbortMessage,

	EWsClOpGraphicFetchHeaderMessage,

	EWsClOpDebugInfo,

	EWsClOpDebugInfoReplyBuf,

	EWsClOpRegisterSurface,

	EWsClOpUnregisterSurface,

	EWsClOpSetCloseProximityThresholds,

	EWsClOpSetHighPressureThresholds,

	EWsClOpGetEnterCloseProximityThreshold,

	EWsClOpGetExitCloseProximityThreshold,

	EWsClOpGetEnterHighPressureThreshold,

	EWsClOpGetExitHighPressureThreshold,

	EWsClOpCreateDrawableSource,

	EWsClOpCreateDirectScreenAccessRegionTrackingOnly,

	EWsClOpLastEnumValue //Keep this at the end - used by test code

	};

// Graphic Drawer opcodes

enum TWsGraphicDrawerOpcodes

	{

	EWsGdOpFree = 0x0000,

	EWsGdOpSendMsg,

	EWsGdOpGetGraphicId,

	EWsGdOpShareGlobally,

	EWsGdOpUnShareGlobally,

	EWsGdOpShare,

	EWsGdOpUnShare,

	EWsGdOpSendSynchronMsg,

	};

// types of Graphic Drawer messages to be passed from the Graphic Drawer to the client

enum TWsGraphicMessageType

	{

	EWsGraphMessageTypeUser = 0x00

	// max 0x03 as packed into lower two bits of client handle

	};

// Window opcodes

enum TWsWindowOpcodes

	{

	EWsWinOpFree=0x0000,

	EWsWinOpSetExtent,

	EWsWinOpSetExtentErr,

	EWsWinOpOrdinalPosition,

	EWsWinOpFullOrdinalPosition,

	EWsWinOpSetOrdinalPosition,

	EWsWinOpSetOrdinalPositionPri,

	EWsWinOpSetOrdinalPriorityAdjust,

	EWsWinOpSetPos,

	EWsWinOpSetSize,

	EWsWinOpSetSizeErr,

	EWsWinOpPosition,

	EWsWinOpAbsPosition,

	EWsWinOpSize,

	EWsWinOpActivate,

	EWsWinOpInvalidate,

	EWsWinOpInvalidateFull,

	EWsWinOpBeginRedraw,

	EWsWinOpBeginRedrawFull,

	EWsWinOpEndRedraw,

	EWsWinOpTestInvariant,

	EWsWinOpParent,

	EWsWinOpPrevSibling,

	EWsWinOpNextSibling,

	EWsWinOpChild,

	EWsWinOpInquireOffset,

	EWsWinOpPointerFilter,

	EWsWinOpSetPointerCapture,

	EWsWinOpSetPointerGrab,

	EWsWinOpClaimPointerGrab,

	EWsWinOpSetBackgroundColor,

	EWsWinOpSetOrdinalPositionErr,

	EWsWinOpSetVisible,

	EWsWinOpScroll,

	EWsWinOpScrollClip,

	EWsWinOpScrollRect,

	EWsWinOpScrollClipRect,

	EWsWinOpReceiveFocus,

	EWsWinOpAutoForeground,

	EWsWinOpSetNoBackgroundColor,

	EWsWinOpCaptureKey,

	EWsWinOpCancelCaptureKey,

	EWsWinOpCaptureKeyUpsAndDowns,

	EWsWinOpCancelCaptureKeyUpsAndDowns,

	EWsWinOpAddPriorityKey,

	EWsWinOpRemovePriorityKey,

	EWsWinOpSetTextCursor,

	EWsWinOpSetTextCursorClipped,

	EWsWinOpCancelTextCursor,

	EWsWinOpSetShadowHeight,

	EWsWinOpShadowDisabled,

	EWsWinOpGetInvalidRegion,

	EWsWinOpGetInvalidRegionCount,

	EWsWinOpSetColor,

	EWsWinOpSetCornerType,

	EWsWinOpSetShape,

	EWsWinOpBitmapHandle,

	EWsWinOpUpdateScreen,

	EWsWinOpUpdateScreenRegion,

	EWsWinOpUpdateBackupBitmap,

	EWsWinOpMaintainBackup,

	EWsWinOpName,

	EWsWinOpSetName,

	EWsWinOpSetOwningWindowGroup,

	EWsWinOpDefaultOwningWindow,

	EWsWinOpRequiredDisplayMode,

	EWsWinOpEnableOnEvents,

	EWsWinOpDisableOnEvents,

	EWsWinOpEnableGroupChangeEvents,

	EWsWinOpDisableGroupChangeEvents,

	EWsWinOpSetPointerCursor,

	EWsWinOpSetCustomPointerCursor,

	EWsWinOpRequestPointerRepeatEvent,

	EWsWinOpCancelPointerRepeatEventRequest,

	EWsWinOpAllocPointerMoveBuffer,

	EWsWinOpFreePointerMoveBuffer,

	EWsWinOpEnablePointerMoveBuffer,

	EWsWinOpDisablePointerMoveBuffer,

	EWsWinOpRetrievePointerMoveBuffer,

	EWsWinOpDiscardPointerMoveBuffer,		//Tested to here %%%

	EWsWinOpEnableModifierChangedEvents,

	EWsWinOpDisableModifierChangedEvents,

	EWsWinOpEnableErrorMessages,

	EWsWinOpDisableErrorMessages,

	EWsWinOpAddKeyRect,

	EWsWinOpRemoveAllKeyRects,

	EWsWinOpPasswordWindow,

	EWsWinOpEnableBackup,

	EWsWinOpIdentifier,

	EWsWinOpDisableKeyClick,

	EWsWinOpSetFade=EWsWinOpDisableKeyClick+3,	//Two messages removed

	EWsWinOpSetNonFading,

	EWsWinOpFadeBehind,

	EWsWinOpEnableScreenChangeEvents,

	EWsWinOpDisableScreenChangeEvents,

	EWsWinOpSendPointerEvent,

	EWsWinOpSendAdvancedPointerEvent,

	EWsWinOpGetDisplayMode,

	EWsWinOpGetIsFaded,

	EWsWinOpGetIsNonFading,

	EWsWinOpOrdinalPriority,

	EWsWinOpClearPointerCursor,

	EWsWinOpMoveToGroup,

	EWsWinOpEnableFocusChangeEvents,

	EWsWinOpDisableFocusChangeEvents,

	EWsWinOpEnableGroupListChangeEvents,

	EWsWinOpDisableGroupListChangeEvents,

	EWsWinOpCaptureLongKey,

	EWsWinOpCancelCaptureLongKey,

	EWsWinOpStoreDrawCommands,

	EWsWinOpHandleTransparencyUpdate,

	EWsWinOpSetTransparencyFactor,

	EWsWinOpSetTransparencyBitmap,

	EWsWinOpAllowChildWindowGroup,

	EWsWinOpSetTransparencyBitmapCWs, 

	EWsWinOpEnableVisibilityChangeEvents,

	EWsWinOpDisableVisibilityChangeEvents,

	EWsWinOpSetTransparencyAlphaChannel,

	EWsWinOpWindowGroupId,

	EWsWinOpSetPointerCapturePriority,

	EWsWinOpGetPointerCapturePriority,

	EWsWinOpSetTransparentRegion,

	EWsWinOpSetTransparencyPolicy,

	EWsWinOpIsRedrawStoreEnabled,

	EWsWinOpEnableOSB,

	EWsWinOpDisableOSB,

	EWsWinOpClearChildGroup,

	EWsWinOpSetChildGroup,

	EWsWinOpClientHandle,

	EWsWinOpSetBackgroundSurface,

	EWsWinOpKeyColor=EWsWinOpSetBackgroundSurface+2, 	//One message removed

	EWsWinOpSetBackgroundSurfaceConfig=EWsWinOpKeyColor+5,	//Four messages removed

	EWsWinOpRemoveBackgroundSurface=EWsWinOpSetBackgroundSurfaceConfig+2,	//One message removed

	EWsWinOpGetBackgroundSurfaceConfig=EWsWinOpRemoveBackgroundSurface+2,	//One message removed

	EWsWinOpClearRedrawStore=EWsWinOpGetBackgroundSurfaceConfig+2,	//One message removed

	EWsWinOpScreenNumber,

	EWsWinOpEnableAdvancedPointers,

#ifdef SYMBIAN_GRAPHICS_WSERV_QT_EFFECTS	

	EWsWinOpSetSurfaceTransparency=EWsWinOpEnableAdvancedPointers+1, // Explicit offset to prevent clash with EWsWinOpFixNativeOrientation

#endif

#ifdef SYMBIAN_GRAPHICS_FIXNATIVEORIENTATION

	EWsWinOpFixNativeOrientation=EWsWinOpEnableAdvancedPointers+2, // Offset to prevent clash with EWsWinOpSetSurfaceTransparency

#endif // SYMBIAN_GRAPHICS_FIXNATIVEORIENTATION

	EWsWinOpTestLowPriorityRedraw=0x2000,  //Specific opcode for testing redraw queue priorities

	};

// GC opcodes

enum TWsGcOpcodes

	{

	EWsGcOpFree=0x0000,

	EWsGcOpActivate,

	EWsGcOpDeactivate,

	EWsGcOpSetClippingRegion,

	EWsGcOpSetClippingRect,

	EWsGcOpCancelClippingRegion,

	EWsGcOpCancelClippingRect,

	EWsGcOpSetWordJustification,

	EWsGcOpSetCharJustification,

	EWsGcOpSetPenColor,

	EWsGcOpSetPenStyle,

	EWsGcOpSetPenSize,

	EWsGcOpSetBrushColor,

	EWsGcOpSetBrushStyle,

	EWsGcOpSetBrushOrigin,

	EWsGcOpUseBrushPattern,

	EWsGcOpDiscardBrushPattern,

	EWsGcOpDrawArc,

	EWsGcOpDrawLine,

	EWsGcOpPlot,

	EWsGcOpDrawTo,

	EWsGcOpDrawBy,

	EWsGcOpDrawPolyLine,

	EWsGcOpDrawPolyLineContinued,   //Quater Way

	EWsGcOpDrawPie,

	EWsGcOpDrawRoundRect,

	EWsGcOpDrawPolygon,

	EWsGcOpStartSegmentedDrawPolygon,

	EWsGcOpSegmentedDrawPolygonData,

	EWsGcOpDrawSegmentedPolygon,

	EWsGcOpDrawBitmap,

	EWsGcOpDrawBitmap2,

	EWsGcOpDrawBitmap3,

	EWsGcOpDrawBitmapMasked,

	EWsGcOpWsDrawBitmapMasked,

	EWsGcOpDrawText,

	EWsGcOpDrawTextPtr,

	EWsGcOpDrawTextInContextPtr,

	EWsGcOpDrawTextInContext,

	EWsGcOpDrawTextVertical,

	EWsGcOpDrawTextInContextVertical,

	EWsGcOpDrawTextInContextVerticalPtr,

	EWsGcOpDrawTextVerticalPtr,

	EWsGcOpDrawBoxTextOptimised1,

	EWsGcOpDrawBoxTextOptimised2,

	EWsGcOpDrawBoxTextInContextOptimised1,

	EWsGcOpDrawBoxTextInContextOptimised2,

	EWsGcOpDrawBoxText,

	EWsGcOpDrawBoxTextInContext,

	EWsGcOpDrawBoxTextPtr,

	EWsGcOpDrawBoxTextInContextPtr,

	EWsGcOpDrawBoxTextVertical,

	EWsGcOpDrawBoxTextInContextVertical,

	EWsGcOpDrawBoxTextVerticalPtr,

	EWsGcOpDrawBoxTextInContextVerticalPtr,

	EWsGcOpMoveBy,

	EWsGcOpMoveTo,

	EWsGcOpSetOrigin,

	EWsGcOpCopyRect,

	EWsGcOpDrawRect,

	EWsGcOpDrawEllipse,		//Half Way

	EWsGcOpGdiBlt2,

	EWsGcOpGdiBlt3,

	EWsGcOpGdiBltMasked,

	EWsGcOpGdiWsBlt2,

	EWsGcOpGdiWsBlt3,

	EWsGcOpGdiWsBltMasked,

	EWsGcOpSize,

	EWsGcOpUseFont,

	//Two unused codes deleted

	EWsGcOpDiscardFont=EWsGcOpUseFont+3,

	EWsGcOpSetUnderlineStyle,

	EWsGcOpSetStrikethroughStyle,

	EWsGcOpSetDrawMode,

	EWsGcOpTestInvariant,

	EWsGcOpClearRect,

	EWsGcOpClear,

	EWsGcOpReset,

	EWsGcOpSetDitherOrigin,

	EWsGcOpMapColors,

	EWsGcOpDrawWsGraphic, //PREQ1246 Bravo

	EWsGcOpDrawWsGraphicPtr,

//

// Local opcodes used internally access GC drawing code

//