summaryrefslogtreecommitdiff
path: root/xc/programs/Xserver/dbe/dbestruct.h
blob: 8fffd962533b33ae9bda8dc9433fee7e84e2c24c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
/* $XConsortium: Xdbeproto.h,v 1.1 95/05/25 17:29:33 dpw Exp dpw $ */
/******************************************************************************
 * 
 * Copyright (c) 1994, 1995  Hewlett-Packard Company
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL HEWLETT-PACKARD COMPANY BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
 * THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 * 
 * Except as contained in this notice, the name of the Hewlett-Packard
 * Company shall not be used in advertising or otherwise to promote the
 * sale, use or other dealings in this Software without prior written
 * authorization from the Hewlett-Packard Company.
 * 
 * $Header: dbestruct.h,v 55.11 95/05/18 14:12:47 yip Exp $
 *
 *     Header file for DIX-related DBE
 *
 *****************************************************************************/


#ifndef DBE_STRUCT_H
#define DBE_STRUCT_H


/* INCLUDES */

#define NEED_DBE_PROTOCOL
#include "Xdbeproto.h"
#include "windowstr.h"


/* DEFINES */

#define DBE_SCREEN_PRIV(pScreen) \
    ((dbeScreenPrivIndex < 0) ? \
     NULL : \
     ((DbeScreenPrivPtr)((pScreen)->devPrivates[dbeScreenPrivIndex].ptr)))

#define DBE_SCREEN_PRIV_FROM_DRAWABLE(pDrawable) \
    DBE_SCREEN_PRIV((pDrawable)->pScreen)

#define DBE_SCREEN_PRIV_FROM_WINDOW_PRIV(pDbeWindowPriv) \
    DBE_SCREEN_PRIV((pDbeWindowPriv)->pWindow->drawable.pScreen)

#define DBE_SCREEN_PRIV_FROM_WINDOW(pWindow) \
    DBE_SCREEN_PRIV((pWindow)->drawable.pScreen)

#define DBE_SCREEN_PRIV_FROM_PIXMAP(pPixmap) \
    DBE_SCREEN_PRIV((pPixmap)->drawable.pScreen)

#define DBE_SCREEN_PRIV_FROM_GC(pGC)\
    DBE_SCREEN_PRIV((pGC)->pScreen)

#define DBE_WINDOW_PRIV(pWindow)\
    ((dbeWindowPrivIndex < 0) ? \
     NULL : \
     ((DbeWindowPrivPtr)(pWindow->devPrivates[dbeWindowPrivIndex].ptr)))


/* TYPEDEFS */

/*
 ******************************************************************************
 **
 ** Per-window data
 **
 ******************************************************************************
 */

typedef struct _DbeBufferIdRec
{
    XID				id;
    struct _DbeBufferIdRec	*prev; 
    struct _DbeBufferIdRec	*next; 

} DbeBufferIdRec, *DbeBufferIdPtr;

typedef struct _DbeWindowPrivRec
{
    /* A pointer to the window with which the DBE window private (buffer) is
     * associated.
     */
    WindowPtr		pWindow;

    /* Last known swap action for this buffer.  Legal values for this field
     * are XdbeUndefined, XdbeBackground, XdbeUntouched, and XdbeCopied.
     */
    unsigned char	swapAction;

    /* Last known buffer size.
     */
    unsigned short	width, height;

    /* Coordinates used for static gravity when the window is positioned.
     */
    short		x, y;

    /* List of XIDs associated with this buffer.  We are defining the XID list
     * as a record and not a pointer here to optimize for data locality.  In
     * most cases, only one buffer will be associated with a window.  Having a
     * record declared here can prevent us accessing the data in another memory
     * page, possibly resulting in a page swap and loss of performance.  For
     * situations where there is more than one buffer, we will possibly have to
     * access those XIDs on a different data page.  This situation could be
     * optimized by performing chunk allocations of memory specifically to be
     * used for XID list nodes.
     */
    DbeBufferIdRec	idList;

    /* Number of XIDs associated with this buffer.
     */
    int			nBufferIDs;

    /* Pointer to a pixmap that contains the contents of the back buffer.
     * This pointer is used for software buffering only.
     */
    PixmapPtr		pPixmapBack;

    /* Pointer to a pixmap that contains the contents of the front buffer.
     * This pointer is used for software buffering only.  Specifically, the
     * front pixmap is used for the XdbeUntouched swap action.  For that swap
     * action, we need to copy the front buffer (window) contents into this
     * pixmap, copy the contents of current back buffer pixmap (the back
     * buffer) into the window, swap the front and back pixmap pointers, and
     * then swap the pixmap/resource associations in the resource database.
     */
    PixmapPtr		pPixmapFront;

    /* Device-specific private information.
     */
    DevUnion		*devPrivates;

} DbeWindowPrivRec, *DbeWindowPrivPtr;


/*
 ******************************************************************************
 **
 ** Per-screen data
 **
 ******************************************************************************
 */

typedef struct _DbeScreenPrivRec
{
    /* Info for creating window privs */
    int          winPrivPrivLen;    /* Length of privs in DbeWindowPrivRec   */
    unsigned int *winPrivPrivSizes; /* Array of private record sizes         */
    unsigned int totalWinPrivSize;  /* PrivRec + size of all priv priv ptrs  */

    /* Info for creating screen privs */
    int          scrnPrivPrivLen;    /* Length of privs in DbeScreenPrivRec  */
    unsigned int *scrnPrivPrivSizes; /* Array of private record sizes        */
    unsigned int totalScrnPrivSize;  /* PrivRec + size of all priv priv ptrs */

    /* Resources created by DIX to be used by DDX */
    RESTYPE	dbeDrawableResType;
    RESTYPE	dbeWindowPrivResType;

    /* Private indices created by DIX to be used by DDX */
    int		dbeScreenPrivIndex;
    int		dbeWindowPrivIndex;

    /* Wrapped functions
     * It is the responsibilty of the DDX layer to wrap PositionWindow().
     * DbeExtensionInit wraps DestroyWindow().
     */
    Bool	(*PositionWindow)();	/* pWin, x, y */
    Bool	(*DestroyWindow)();	/* pWin */

    /* Per-screen DIX routines */
    Bool	     (*SetupBackgroundPainter)();  /* pWin, pGC              */
    DbeWindowPrivPtr (*AllocWinPriv)();            /* pScreen                */
    int              (*AllocWinPrivPrivIndex)();   /*                        */
    Bool             (*AllocWinPrivPriv)();        /* pScreen, index, amount */
    struct _DbeScreenPrivRec *(*AllocScrnPriv)();  /* pDbeScreenPriv         */
    int              (*AllocScrnPrivPrivIndex)();  /*                        */
    Bool             (*AllocScrnPrivPriv)();       /* pScreen, index, amount */

    /* Per-screen DDX routines */
    Bool	(*GetVisualInfo)();		  /* pScreen, pVisInfo       */
    int		(*AllocBackBufferName)();	  /* pWin, bufId, swapAction */
    int		(*SwapBuffers)();		  /* client, nWindows, pWins,*/
                                                  /* actions                 */
    void	(*BeginIdiom)();		  /* client                  */
    void	(*EndIdiom)();		          /* client                  */
    void	(*WinPrivDelete)();		  /* pDbeWindowPriv, bufID   */
    void	(*ResetProc)();		          /* pScreen                 */

    /* Device-specific private information.
     */
    DevUnion	*devPrivates;

} DbeScreenPrivRec, *DbeScreenPrivPtr;


/* EXTERNS */


#endif /* DBE_STRUCT_H */