deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/******************************************************************************
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Copyright (c) 1994, 1995 Hewlett-Packard Company
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Permission is hereby granted, free of charge, to any person obtaining
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * a copy of this software and associated documentation files (the
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * "Software"), to deal in the Software without restriction, including
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * without limitation the rights to use, copy, modify, merge, publish,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * distribute, sublicense, and/or sell copies of the Software, and to
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * permit persons to whom the Software is furnished to do so, subject to
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * the following conditions:
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * The above copyright notice and this permission notice shall be included
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * in all copies or substantial portions of the Software.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * IN NO EVENT SHALL HEWLETT-PACKARD COMPANY BE LIABLE FOR ANY CLAIM,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Except as contained in this notice, the name of the Hewlett-Packard
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Company shall not be used in advertising or otherwise to promote the
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * sale, use or other dealings in this Software without prior written
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * authorization from the Hewlett-Packard Company.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Header file for DIX-related DBE
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *****************************************************************************/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* $XFree86$ */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#ifndef DBE_STRUCT_H
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define DBE_STRUCT_H
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* INCLUDES */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define NEED_DBE_PROTOCOL
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#include <X11/extensions/Xdbeproto.h>
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#include "windowstr.h"
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* DEFINES */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define DBE_SCREEN_PRIV(pScreen) \
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ((dbeScreenPrivIndex < 0) ? \
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync NULL : \
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ((DbeScreenPrivPtr)((pScreen)->devPrivates[dbeScreenPrivIndex].ptr)))
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define DBE_SCREEN_PRIV_FROM_DRAWABLE(pDrawable) \
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DBE_SCREEN_PRIV((pDrawable)->pScreen)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define DBE_SCREEN_PRIV_FROM_WINDOW_PRIV(pDbeWindowPriv) \
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DBE_SCREEN_PRIV((pDbeWindowPriv)->pWindow->drawable.pScreen)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define DBE_SCREEN_PRIV_FROM_WINDOW(pWindow) \
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DBE_SCREEN_PRIV((pWindow)->drawable.pScreen)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define DBE_SCREEN_PRIV_FROM_PIXMAP(pPixmap) \
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DBE_SCREEN_PRIV((pPixmap)->drawable.pScreen)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define DBE_SCREEN_PRIV_FROM_GC(pGC)\
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DBE_SCREEN_PRIV((pGC)->pScreen)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define DBE_WINDOW_PRIV(pWindow)\
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ((dbeWindowPrivIndex < 0) ? \
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync NULL : \
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ((DbeWindowPrivPtr)(pWindow->devPrivates[dbeWindowPrivIndex].ptr)))
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* Initial size of the buffer ID array in the window priv. */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define DBE_INIT_MAX_IDS 2
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* Reallocation increment for the buffer ID array. */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define DBE_INCR_MAX_IDS 4
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* Marker for free elements in the buffer ID array. */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define DBE_FREE_ID_ELEMENT 0
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* TYPEDEFS */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* Record used to pass swap information between DIX and DDX swapping
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * procedures.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynctypedef struct _DbeSwapInfoRec
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync WindowPtr pWindow;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned char swapAction;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync} DbeSwapInfoRec, *DbeSwapInfoPtr;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ******************************************************************************
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ** Per-window data
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ******************************************************************************
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynctypedef struct _DbeWindowPrivRec
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* A pointer to the window with which the DBE window private (buffer) is
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * associated.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync WindowPtr pWindow;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Last known swap action for this buffer. Legal values for this field
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * are XdbeUndefined, XdbeBackground, XdbeUntouched, and XdbeCopied.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned char swapAction;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Last known buffer size.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned short width, height;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Coordinates used for static gravity when the window is positioned.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync short x, y;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Number of XIDs associated with this buffer.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int nBufferIDs;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Capacity of the current buffer ID array, IDs. */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int maxAvailableIDs;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Pointer to the array of buffer IDs. This initially points to initIDs.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * When the static limit of the initIDs array is reached, the array is
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * reallocated and this pointer is set to the new array instead of initIDs.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync XID *IDs;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Initial array of buffer IDs. We are defining the XID array within the
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * window priv to optimize for data locality. In most cases, only one
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * buffer will be associated with a window. Having the array declared
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * here can prevent us from accessing the data in another memory page,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * possibly resulting in a page swap and loss of performance. Initially we
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * will use this array to store buffer IDs. For situations where we have
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * more IDs than can fit in this static array, we will allocate a larger
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * array to use, possibly suffering a performance loss.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync XID initIDs[DBE_INIT_MAX_IDS];
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Device-specific private information.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DevUnion *devPrivates;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync} DbeWindowPrivRec, *DbeWindowPrivPtr;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ******************************************************************************
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ** Per-screen data
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ******************************************************************************
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynctypedef struct _DbeScreenPrivRec
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Info for creating window privs */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int winPrivPrivLen; /* Length of privs in DbeWindowPrivRec */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned int *winPrivPrivSizes; /* Array of private record sizes */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned int totalWinPrivSize; /* PrivRec + size of all priv priv ptrs */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Resources created by DIX to be used by DDX */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync RESTYPE dbeDrawableResType;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync RESTYPE dbeWindowPrivResType;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Private indices created by DIX to be used by DDX */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int dbeScreenPrivIndex;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int dbeWindowPrivIndex;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Wrapped functions
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * It is the responsibilty of the DDX layer to wrap PositionWindow().
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * DbeExtensionInit wraps DestroyWindow().
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PositionWindowProcPtr PositionWindow;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DestroyWindowProcPtr DestroyWindow;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Per-screen DIX routines */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync Bool (*SetupBackgroundPainter)(
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync WindowPtr /*pWin*/,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync GCPtr /*pGC*/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DbeWindowPrivPtr (*AllocWinPriv)(
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ScreenPtr /*pScreen*/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int (*AllocWinPrivPrivIndex)(
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync void
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync Bool (*AllocWinPrivPriv)(
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ScreenPtr /*pScreen*/,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int /*index*/,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned /*amount*/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Per-screen DDX routines */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync Bool (*GetVisualInfo)(
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ScreenPtr /*pScreen*/,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync XdbeScreenVisualInfo * /*pVisInfo*/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int (*AllocBackBufferName)(
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync WindowPtr /*pWin*/,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync XID /*bufId*/,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int /*swapAction*/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int (*SwapBuffers)(
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ClientPtr /*client*/,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int * /*pNumWindows*/,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DbeSwapInfoPtr /*swapInfo*/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync void (*BeginIdiom)(
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ClientPtr /*client*/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync void (*EndIdiom)(
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ClientPtr /*client*/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync void (*WinPrivDelete)(
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DbeWindowPrivPtr /*pDbeWindowPriv*/,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync XID /*bufId*/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync void (*ResetProc)(
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ScreenPtr /*pScreen*/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync void (*ValidateBuffer)(
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync WindowPtr /*pWin*/,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync XID /*bufId*/,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync Bool /*dstbuffer*/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Device-specific private information.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DevUnion *devPrivates;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync} DbeScreenPrivRec, *DbeScreenPrivPtr;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#endif /* DBE_STRUCT_H */