resource.h revision 4642e01f 
1/***********************************************************
2
3Copyright 1987, 1989, 1998  The Open Group
4
5Permission to use, copy, modify, distribute, and sell this software and its
6documentation for any purpose is hereby granted without fee, provided that
7the above copyright notice appear in all copies and that both that
8copyright notice and this permission notice appear in supporting
9documentation.
10
11The above copyright notice and this permission notice shall be included in
12all copies or substantial portions of the Software.
13
14THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
17OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
18AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
19CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20
21Except as contained in this notice, the name of The Open Group shall not be
22used in advertising or otherwise to promote the sale, use or other dealings
23in this Software without prior written authorization from The Open Group.
24
25
26Copyright 1987, 1989 by Digital Equipment Corporation, Maynard, Massachusetts.
27
28                        All Rights Reserved
29
30Permission to use, copy, modify, and distribute this software and its
31documentation for any purpose and without fee is hereby granted,
32provided that the above copyright notice appear in all copies and that
33both that copyright notice and this permission notice appear in
34supporting documentation, and that the name of Digital not be
35used in advertising or publicity pertaining to distribution of the
36software without specific, written prior permission.
37
38DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
39ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
40DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
41ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
42WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
43ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
44SOFTWARE.
45
46******************************************************************/
47
48#ifndef RESOURCE_H
49#define RESOURCE_H 1
50#include "misc.h"
51#include "dixaccess.h"
52
53/*****************************************************************
54 * STUFF FOR RESOURCES
55 *****************************************************************/
56
57/* classes for Resource routines */
58
59typedef unsigned long RESTYPE;
60
61#define RC_VANILLA	((RESTYPE)0)
62#define RC_CACHED	((RESTYPE)1<<31)
63#define RC_DRAWABLE	((RESTYPE)1<<30)
64/*  Use class RC_NEVERRETAIN for resources that should not be retained
65 *  regardless of the close down mode when the client dies.  (A client's
66 *  event selections on objects that it doesn't own are good candidates.)
67 *  Extensions can use this too!
68 */
69#define RC_NEVERRETAIN	((RESTYPE)1<<29)
70#define RC_LASTPREDEF	RC_NEVERRETAIN
71#define RC_ANY		(~(RESTYPE)0)
72
73/* types for Resource routines */
74
75#define RT_WINDOW	((RESTYPE)1|RC_DRAWABLE)
76#define RT_PIXMAP	((RESTYPE)2|RC_DRAWABLE)
77#define RT_GC		((RESTYPE)3)
78#undef RT_FONT
79#undef RT_CURSOR
80#define RT_FONT		((RESTYPE)4)
81#define RT_CURSOR	((RESTYPE)5)
82#define RT_COLORMAP	((RESTYPE)6)
83#define RT_CMAPENTRY	((RESTYPE)7)
84#define RT_OTHERCLIENT	((RESTYPE)8|RC_NEVERRETAIN)
85#define RT_PASSIVEGRAB	((RESTYPE)9|RC_NEVERRETAIN)
86#define RT_LASTPREDEF	((RESTYPE)9)
87#define RT_NONE		((RESTYPE)0)
88
89/* bits and fields within a resource id */
90#define RESOURCE_AND_CLIENT_COUNT   29			/* 29 bits for XIDs */
91#if MAXCLIENTS == 64
92#define RESOURCE_CLIENT_BITS	6
93#endif
94#if MAXCLIENTS == 128
95#define RESOURCE_CLIENT_BITS	7
96#endif
97#if MAXCLIENTS == 256
98#define RESOURCE_CLIENT_BITS	8
99#endif
100#if MAXCLIENTS == 512
101#define RESOURCE_CLIENT_BITS	9
102#endif
103/* client field offset */
104#define CLIENTOFFSET	    (RESOURCE_AND_CLIENT_COUNT - RESOURCE_CLIENT_BITS)
105/* resource field */
106#define RESOURCE_ID_MASK	((1 << CLIENTOFFSET) - 1)
107/* client field */
108#define RESOURCE_CLIENT_MASK	(((1 << RESOURCE_CLIENT_BITS) - 1) << CLIENTOFFSET)
109/* extract the client mask from an XID */
110#define CLIENT_BITS(id) ((id) & RESOURCE_CLIENT_MASK)
111/* extract the client id from an XID */
112#define CLIENT_ID(id) ((int)(CLIENT_BITS(id) >> CLIENTOFFSET))
113#define SERVER_BIT		(Mask)0x40000000	/* use illegal bit */
114
115#ifdef INVALID
116#undef INVALID	/* needed on HP/UX */
117#endif
118
119/* Invalid resource id */
120#define INVALID	(0)
121
122#define BAD_RESOURCE 0xe0000000
123
124/* Resource state callback */
125extern CallbackListPtr ResourceStateCallback;
126
127typedef enum {ResourceStateAdding,
128	      ResourceStateFreeing} ResourceState;
129
130typedef struct {
131    ResourceState state;
132    XID id;
133    RESTYPE type;
134    pointer value;
135} ResourceStateInfoRec;
136
137typedef int (*DeleteType)(
138    pointer /*value*/,
139    XID /*id*/);
140
141typedef void (*FindResType)(
142    pointer /*value*/,
143    XID /*id*/,
144    pointer /*cdata*/);
145
146typedef void (*FindAllRes)(
147    pointer /*value*/,
148    XID /*id*/,
149    RESTYPE /*type*/,
150    pointer /*cdata*/);
151
152typedef Bool (*FindComplexResType)(
153    pointer /*value*/,
154    XID /*id*/,
155    pointer /*cdata*/);
156
157extern RESTYPE CreateNewResourceType(
158    DeleteType /*deleteFunc*/);
159
160extern RESTYPE CreateNewResourceClass(void);
161
162extern Bool InitClientResources(
163    ClientPtr /*client*/);
164
165extern XID FakeClientID(
166    int /*client*/);
167
168/* Quartz support on Mac OS X uses the CarbonCore
169   framework whose AddResource function conflicts here. */
170#ifdef __APPLE__
171#define AddResource Darwin_X_AddResource
172#endif
173extern Bool AddResource(
174    XID /*id*/,
175    RESTYPE /*type*/,
176    pointer /*value*/);
177
178extern void FreeResource(
179    XID /*id*/,
180    RESTYPE /*skipDeleteFuncType*/);
181
182extern void FreeResourceByType(
183    XID /*id*/,
184    RESTYPE /*type*/,
185    Bool /*skipFree*/);
186
187extern Bool ChangeResourceValue(
188    XID /*id*/,
189    RESTYPE /*rtype*/,
190    pointer /*value*/);
191
192extern void FindClientResourcesByType(
193    ClientPtr /*client*/,
194    RESTYPE /*type*/,
195    FindResType /*func*/,
196    pointer /*cdata*/);
197
198extern void FindAllClientResources(
199    ClientPtr /*client*/,
200    FindAllRes /*func*/,
201    pointer /*cdata*/);
202
203extern void FreeClientNeverRetainResources(
204    ClientPtr /*client*/);
205
206extern void FreeClientResources(
207    ClientPtr /*client*/);
208
209extern void FreeAllResources(void);
210
211extern Bool LegalNewID(
212    XID /*id*/,
213    ClientPtr /*client*/);
214
215extern pointer LookupClientResourceComplex(
216    ClientPtr client,
217    RESTYPE type,
218    FindComplexResType func,
219    pointer cdata);
220
221extern int dixLookupResource(
222    pointer *result,
223    XID id,
224    RESTYPE rtype,
225    ClientPtr client,
226    Mask access_mode);
227
228extern void GetXIDRange(
229    int /*client*/,
230    Bool /*server*/,
231    XID * /*minp*/,
232    XID * /*maxp*/);
233
234extern unsigned int GetXIDList(
235    ClientPtr /*client*/,
236    unsigned int /*count*/,
237    XID * /*pids*/);
238
239extern RESTYPE lastResourceType;
240extern RESTYPE TypeMask;
241
242/*
243 * These are deprecated compatibility functions and will be removed soon!
244 * Please use the noted replacements instead.
245 */
246
247/* replaced by dixLookupResource */
248extern pointer SecurityLookupIDByType(
249    ClientPtr client,
250    XID id,
251    RESTYPE rtype,
252    Mask access_mode);
253
254/* replaced by dixLookupResource */
255extern pointer SecurityLookupIDByClass(
256    ClientPtr client,
257    XID id,
258    RESTYPE classes,
259    Mask access_mode);
260
261/* replaced by dixLookupResource */
262extern pointer LookupIDByType(
263    XID id,
264    RESTYPE rtype);
265
266/* replaced by dixLookupResource */
267extern pointer LookupIDByClass(
268    XID id,
269    RESTYPE classes);
270
271#endif /* RESOURCE_H */
272
273