1
/* $Xorg: windowstr.h,v 1.4 2001/02/09 02:05:16 xorgcvs Exp $ */
2
/***********************************************************
4
Copyright 1987, 1998 The Open Group
6
Permission to use, copy, modify, distribute, and sell this software and its
7
documentation for any purpose is hereby granted without fee, provided that
8
the above copyright notice appear in all copies and that both that
9
copyright notice and this permission notice appear in supporting
12
The above copyright notice and this permission notice shall be included in
13
all copies or substantial portions of the Software.
15
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
19
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22
Except as contained in this notice, the name of The Open Group shall not be
23
used in advertising or otherwise to promote the sale, use or other dealings
24
in this Software without prior written authorization from The Open Group.
27
Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.
31
Permission to use, copy, modify, and distribute this software and its
32
documentation for any purpose and without fee is hereby granted,
33
provided that the above copyright notice appear in all copies and that
34
both that copyright notice and this permission notice appear in
35
supporting documentation, and that the name of Digital not be
36
used in advertising or publicity pertaining to distribution of the
37
software without specific, written prior permission.
39
DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
40
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
41
DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
42
ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
43
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
44
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
47
******************************************************************/
48
/* $XFree86: xc/programs/Xserver/include/windowstr.h,v 1.6 2001/12/14 19:59:57 dawes Exp $ */
50
#ifndef WINDOWSTRUCT_H
51
#define WINDOWSTRUCT_H
54
#include "pixmapstr.h"
55
#include "regionstr.h"
58
#include "resource.h" /* for ROOT_WINDOW_ID_BASE */
60
#include "miscstruct.h"
61
#include <X11/Xprotostr.h>
64
#define GuaranteeNothing 0
65
#define GuaranteeVisBack 1
67
#define SameBackground(as, a, bs, b) \
68
((as) == (bs) && ((as) == None || \
69
(as) == ParentRelative || \
70
SamePixUnion(a,b,as == BackgroundPixel)))
72
#define SameBorder(as, a, bs, b) \
73
EqualPixUnion(as, a, bs, b)
75
typedef struct _WindowOpt {
76
VisualID visual; /* default: same as parent */
77
CursorPtr cursor; /* default: window.cursorNone */
78
Colormap colormap; /* default: same as parent */
79
Mask dontPropagateMask; /* default: window.dontPropagate */
80
Mask otherEventMasks; /* default: 0 */
81
struct _OtherClients *otherClients; /* default: NULL */
82
struct _GrabRec *passiveGrabs; /* default: NULL */
83
PropertyPtr userProps; /* default: NULL */
84
unsigned long backingBitPlanes; /* default: ~0L */
85
unsigned long backingPixel; /* default: 0 */
87
RegionPtr boundingShape; /* default: NULL */
88
RegionPtr clipShape; /* default: NULL */
89
RegionPtr inputShape; /* default: NULL */
92
struct _OtherInputMasks *inputMasks; /* default: NULL */
94
} WindowOptRec, *WindowOptPtr;
96
#define BackgroundPixel 2L
97
#define BackgroundPixmap 3L
99
typedef struct _Window {
100
DrawableRec drawable;
101
WindowPtr parent; /* ancestor chain */
102
WindowPtr nextSib; /* next lower sibling */
103
WindowPtr prevSib; /* next higher sibling */
104
WindowPtr firstChild; /* top-most child */
105
WindowPtr lastChild; /* bottom-most child */
106
RegionRec clipList; /* clipping rectangle for output */
107
RegionRec borderClip; /* NotClippedByChildren + border */
108
union _Validate *valdata;
110
RegionRec borderSize;
111
DDXPointRec origin; /* position relative to parent */
112
unsigned short borderWidth;
113
unsigned short deliverableEvents;
117
pointer backStorage; /* null when BS disabled */
118
WindowOptPtr optional;
119
unsigned backgroundState:2; /* None, Relative, Pixel, Pixmap */
120
unsigned borderIsPixel:1;
121
unsigned cursorIsNone:1; /* else real cursor (might inherit) */
122
unsigned backingStore:2;
123
unsigned saveUnder:1;
124
unsigned DIXsaveUnder:1;
125
unsigned bitGravity:4;
126
unsigned winGravity:4;
127
unsigned overrideRedirect:1;
128
unsigned visibility:2;
130
unsigned realized:1; /* ancestors are all mapped */
131
unsigned viewable:1; /* realized && InputOutput */
132
unsigned dontPropagate:3;/* index into DontPropagateMasks */
133
unsigned forcedBS:1; /* system-supplied backingStore */
134
#ifdef NEED_DBE_BUF_BITS
135
#define DBE_FRONT_BUFFER 1
136
#define DBE_BACK_BUFFER 0
137
unsigned dstBuffer:1; /* destination buffer for rendering */
138
unsigned srcBuffer:1; /* source buffer for rendering */
141
unsigned redirectDraw:1; /* rendering is redirected from here */
143
DevUnion *devPrivates;
147
* Ok, a bunch of macros for accessing the optional record
148
* fields (or filling the appropriate default value)
151
extern Mask DontPropagateMasks[];
153
#define wTrackParent(w,field) ((w)->optional ? \
154
(w)->optional->field \
155
: FindWindowWithOptional(w)->optional->field)
156
#define wUseDefault(w,field,def) ((w)->optional ? \
157
(w)->optional->field \
160
#define wVisual(w) wTrackParent(w, visual)
161
#define wCursor(w) ((w)->cursorIsNone ? None : wTrackParent(w, cursor))
162
#define wColormap(w) ((w)->drawable.class == InputOnly ? None : wTrackParent(w, colormap))
163
#define wDontPropagateMask(w) wUseDefault(w, dontPropagateMask, DontPropagateMasks[(w)->dontPropagate])
164
#define wOtherEventMasks(w) wUseDefault(w, otherEventMasks, 0)
165
#define wOtherClients(w) wUseDefault(w, otherClients, NULL)
167
#define wOtherInputMasks(w) wUseDefault(w, inputMasks, NULL)
169
#define wOtherInputMasks(w) NULL
171
#define wPassiveGrabs(w) wUseDefault(w, passiveGrabs, NULL)
172
#define wUserProps(w) wUseDefault(w, userProps, NULL)
173
#define wBackingBitPlanes(w) wUseDefault(w, backingBitPlanes, ~0L)
174
#define wBackingPixel(w) wUseDefault(w, backingPixel, 0)
176
#define wBoundingShape(w) wUseDefault(w, boundingShape, NULL)
177
#define wClipShape(w) wUseDefault(w, clipShape, NULL)
178
#define wInputShape(w) wUseDefault(w, inputShape, NULL)
180
#define wClient(w) (clients[CLIENT_ID((w)->drawable.id)])
181
#define wBorderWidth(w) ((int) (w)->borderWidth)
183
/* true when w needs a border drawn. */
186
#define HasBorder(w) ((w)->borderWidth || wClipShape(w))
188
#define HasBorder(w) ((w)->borderWidth)
191
typedef struct _ScreenSaverStuff {
195
Bool (*ExternalScreenSaver)(
196
ScreenPtr /*pScreen*/,
199
} ScreenSaverStuffRec, *ScreenSaverStuffPtr;
201
#define SCREEN_IS_BLANKED 0
202
#define SCREEN_ISNT_SAVED 1
203
#define SCREEN_IS_TILED 2
204
#define SCREEN_IS_BLACK 3
206
#define HasSaverWindow(i) (savedScreenInfo[i].pWindow != NullWindow)
208
extern int screenIsSaved;
209
extern ScreenSaverStuffRec savedScreenInfo[MAXSCREENS];
212
* this is the configuration parameter "NO_BACK_SAVE"
213
* it means that any existant backing store should not
214
* be used to implement save unders.
218
#define DO_SAVE_UNDERS(pWin) ((pWin)->drawable.pScreen->saveUnderSupport ==\
221
* saveUnderSupport is set to this magic value when using DIXsaveUnders
224
#define USE_DIX_SAVE_UNDERS 0x40
227
extern int numSaveUndersViewable;
228
extern int deltaSaveUndersViewable;
231
extern WindowPtr xeviewin;
234
#endif /* WINDOWSTRUCT_H */