61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/***********************************************************
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncCopyright 1987, 1989, 1998 The Open Group
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncPermission to use, copy, modify, distribute, and sell this software and its
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncdocumentation for any purpose is hereby granted without fee, provided that
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncthe above copyright notice appear in all copies and that both that
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsynccopyright notice and this permission notice appear in supporting
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncdocumentation.
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncThe above copyright notice and this permission notice shall be included in
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncall copies or substantial portions of the Software.
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncOPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncAN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncExcept as contained in this notice, the name of The Open Group shall not be
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncused in advertising or otherwise to promote the sale, use or other dealings
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncin this Software without prior written authorization from The Open Group.
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncCopyright 1987, 1989 by Digital Equipment Corporation, Maynard, Massachusetts.
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync All Rights Reserved
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncPermission to use, copy, modify, and distribute this software and its
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncdocumentation for any purpose and without fee is hereby granted,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncprovided that the above copyright notice appear in all copies and that
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncboth that copyright notice and this permission notice appear in
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncsupporting documentation, and that the name of Digital not be
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncused in advertising or publicity pertaining to distribution of the
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncsoftware without specific, written prior permission.
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncDIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncDIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncWHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync******************************************************************/
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/*****************************************************************
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync * STUFF FOR RESOURCES
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync *****************************************************************/
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/* classes for Resource routines */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/* Use class RC_NEVERRETAIN for resources that should not be retained
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync * regardless of the close down mode when the client dies. (A client's
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync * event selections on objects that it doesn't own are good candidates.)
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync * Extensions can use this too!
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/* types for Resource routines */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/* bits and fields within a resource id */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync#define RESOURCE_AND_CLIENT_COUNT 29 /* 29 bits for XIDs */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/* client field offset */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync#define CLIENTOFFSET (RESOURCE_AND_CLIENT_COUNT - RESOURCE_CLIENT_BITS)
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/* resource field */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/* client field */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync#define RESOURCE_CLIENT_MASK (((1 << RESOURCE_CLIENT_BITS) - 1) << CLIENTOFFSET)
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/* extract the client mask from an XID */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync#define CLIENT_BITS(id) ((id) & RESOURCE_CLIENT_MASK)
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/* extract the client id from an XID */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync#define CLIENT_ID(id) ((int)(CLIENT_BITS(id) >> CLIENTOFFSET))
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync#define SERVER_BIT (Mask)0x40000000 /* use illegal bit */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/* Invalid resource id */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync#define rClient(obj) (clients[CLIENT_ID((obj)->resource)])
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/* Resource state callback */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT CallbackListPtr ResourceStateCallback;
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsynctypedef struct {
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync void */*cdata */ );
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync void */*cdata */ );
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsynctypedef Bool (*FindComplexResType) (void */*value */ ,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync void */*cdata */ );
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/* Structure for estimating resource memory usage. Memory usage
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync * consists of space allocated for the resource itself and of
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync * references to other resources. Currently the most important use for
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync * this structure is to estimate pixmap usage of different resources
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync * more accurately. */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsynctypedef struct {
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync /* Size of resource itself. Zero if not implemented. */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync /* Size attributed to pixmap references from the resource. */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync /* Number of references to this resource; typically 1 */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT RESTYPE CreateNewResourceType(DeleteType /*deleteFunc */ ,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync const char * /*name */ );
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsynctypedef void (*FindTypeSubResources)(void */* value */,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync void */* cdata */);
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT void SetResourceTypeFindSubResFunc(
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync RESTYPE /*type*/, FindTypeSubResources /*findFunc*/);
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT RESTYPE CreateNewResourceClass(void);
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT Bool InitClientResources(ClientPtr /*client */ );
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT XID FakeClientID(int /*client */ );
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/* Quartz support on Mac OS X uses the CarbonCore
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync framework whose AddResource function conflicts here. */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync void */*value */ );
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT void FreeResourceByType(XID /*id */ ,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT Bool ChangeResourceValue(XID /*id */ ,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync void */*value */ );
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT void FindClientResourcesByType(ClientPtr /*client */ ,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync void */*cdata */ );
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT void FindAllClientResources(ClientPtr /*client */ ,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync void */*cdata */ );
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/** @brief Iterate through all subresources of a resource.
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync @note The XID argument provided to the FindAllRes function
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync may be 0 for subresources that don't have an XID */
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT void FindSubResources(void */*resource*/,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync void */*cdata*/);
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT void FreeClientNeverRetainResources(ClientPtr /*client */ );
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT void FreeClientResources(ClientPtr /*client */ );
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT void *LookupClientResourceComplex(ClientPtr client,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT int dixLookupResourceByType(void **result,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT int dixLookupResourceByClass(void **result,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsyncextern _X_EXPORT unsigned int GetXIDList(ClientPtr /*client */ ,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync unsigned int /*count */ ,
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync/** @brief A hashing function to be used for hashing resource IDs
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync @param id The resource ID to hash
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync @param numBits The number of bits in the resulting hash. Must be >=0.
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync @note This function is really only for handling
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync INITHASHSIZE..MAXHASHSIZE bit hashes, but will handle any number
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync of bits by either masking numBits lower bits of the ID or by
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync providing at most MAXHASHSIZE hashes.
61cb83a8ccd1dd7f671f31fa93c9d8b7be09b4ccvboxsync#endif /* RESOURCE_H */