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