privates.h revision 65fea56f17cd614bc8908264df980a62e1931468
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/***********************************************************
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncAUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncAN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncCONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync******************************************************************/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#ifndef PRIVATES_H
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define PRIVATES_H 1
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#include <X11/Xdefs.h>
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#include <X11/Xosdefs.h>
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#include <X11/Xfuncproto.h>
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#include "misc.h"
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*****************************************************************
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * STUFF FOR PRIVATES
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *****************************************************************/
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynctypedef struct _Private PrivateRec, *PrivatePtr;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynctypedef enum {
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* XSELinux uses the same private keys for numerous objects */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_XSELINUX,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* Otherwise, you get a private in just the requested structure
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* These can have objects created before all of the keys are registered */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_SCREEN,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_EXTENSION,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_COLORMAP,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_DEVICE,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* These cannot have any objects before all relevant keys are registered */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_CLIENT,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_PROPERTY,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_SELECTION,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_WINDOW,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_PIXMAP,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_GC,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_CURSOR,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_CURSOR_BITS,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* extension privates */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_DAMAGE,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_GLYPH,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_GLYPHSET,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_PICTURE,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_SYNC_FENCE,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync /* last private type */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync PRIVATE_LAST,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync} DevPrivateType;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynctypedef struct _DevPrivateKeyRec {
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int offset;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int size;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync Bool initialized;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync Bool allocated;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DevPrivateType type;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync struct _DevPrivateKeyRec *next;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync} DevPrivateKeyRec, *DevPrivateKey;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynctypedef struct _DevPrivateSetRec {
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DevPrivateKey key;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned offset;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int created;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync int allocated;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync} DevPrivateSetRec, *DevPrivateSetPtr;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsynctypedef struct _DevScreenPrivateKeyRec {
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DevPrivateKeyRec screenKey;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync} DevScreenPrivateKeyRec, *DevScreenPrivateKey;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Let drivers know how to initialize private keys
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define HAS_DEVPRIVATEKEYREC 1
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define HAS_DIXREGISTERPRIVATEKEY 1
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Register a new private index for the private type.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * This initializes the specified key and optionally requests pre-allocated
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * private space for your driver/module. If you request no extra space, you
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * may set and get a single pointer value using this private key. Otherwise,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * you can get the address of the extra space and store whatever data you like
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * there.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * You may call dixRegisterPrivateKey more than once on the same key, but the
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * size and type must match or the server will abort.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * dixRegisterPrivateKey returns FALSE if it fails to allocate memory
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * during its operation.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT Bool
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync dixRegisterPrivateKey(DevPrivateKey key, DevPrivateType type, unsigned size);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Check whether a private key has been registered
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncstatic inline Bool
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixPrivateKeyRegistered(DevPrivateKey key)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync return key->initialized;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync}
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Get the address of the private storage.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * For keys with pre-defined storage, this gets the base of that storage
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Otherwise, it returns the place where the private pointer is stored.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncstatic inline void *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixGetPrivateAddr(PrivatePtr *privates, const DevPrivateKey key)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync assert(key->initialized);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync return (char *) (*privates) + key->offset;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync}
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Fetch a private pointer stored in the object
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Returns the pointer stored with dixSetPrivate.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * This must only be used with keys that have
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * no pre-defined storage
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncstatic inline void *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixGetPrivate(PrivatePtr *privates, const DevPrivateKey key)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync assert(key->size == 0);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync return *(void **) dixGetPrivateAddr(privates, key);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync}
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Associate 'val' with 'key' in 'privates' so that later calls to
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * dixLookupPrivate(privates, key) will return 'val'.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncstatic inline void
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixSetPrivate(PrivatePtr *privates, const DevPrivateKey key, pointer val)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync assert(key->size == 0);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *(pointer *) dixGetPrivateAddr(privates, key) = val;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync}
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#include "dix.h"
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#include "resource.h"
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Lookup a pointer to the private record.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * For privates with defined storage, return the address of the
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * storage. For privates without defined storage, return the pointer
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * contents
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncstatic inline pointer
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixLookupPrivate(PrivatePtr *privates, const DevPrivateKey key)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync if (key->size)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync return dixGetPrivateAddr(privates, key);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync else
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync return dixGetPrivate(privates, key);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync}
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Look up the address of the pointer to the storage
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * This returns the place where the private pointer is stored,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * which is only valid for privates without predefined storage.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncstatic inline pointer *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixLookupPrivateAddr(PrivatePtr *privates, const DevPrivateKey key)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync assert(key->size == 0);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync return (pointer *) dixGetPrivateAddr(privates, key);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync}
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT Bool
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixRegisterScreenPrivateKey(DevScreenPrivateKey key, ScreenPtr pScreen,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DevPrivateType type, unsigned size);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT DevPrivateKey
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync _dixGetScreenPrivateKey(const DevScreenPrivateKey key, ScreenPtr pScreen);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncstatic inline void *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixGetScreenPrivateAddr(PrivatePtr *privates, const DevScreenPrivateKey key,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ScreenPtr pScreen)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync return dixGetPrivateAddr(privates, _dixGetScreenPrivateKey(key, pScreen));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync}
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncstatic inline void *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixGetScreenPrivate(PrivatePtr *privates, const DevScreenPrivateKey key,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ScreenPtr pScreen)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync return dixGetPrivate(privates, _dixGetScreenPrivateKey(key, pScreen));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync}
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncstatic inline void
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixSetScreenPrivate(PrivatePtr *privates, const DevScreenPrivateKey key,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ScreenPtr pScreen, pointer val)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync dixSetPrivate(privates, _dixGetScreenPrivateKey(key, pScreen), val);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync}
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncstatic inline pointer
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixLookupScreenPrivate(PrivatePtr *privates, const DevScreenPrivateKey key,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ScreenPtr pScreen)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync return dixLookupPrivate(privates, _dixGetScreenPrivateKey(key, pScreen));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync}
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncstatic inline pointer *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixLookupScreenPrivateAddr(PrivatePtr *privates, const DevScreenPrivateKey key,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync ScreenPtr pScreen)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync{
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync return dixLookupPrivateAddr(privates,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync _dixGetScreenPrivateKey(key, pScreen));
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync}
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * These functions relate to allocations related to a specific screen;
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * space will only be available for objects allocated for use on that
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * screen. As such, only objects which are related directly to a specific
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * screen are candidates for allocation this way, this includes
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * windows, pixmaps, gcs, pictures and colormaps. This key is
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * used just like any other key using dixGetPrivate and friends.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * This is distinctly different from the ScreenPrivateKeys above which
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * allocate space in global objects like cursor bits for a specific
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * screen, allowing multiple screen-related chunks of storage in a
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * single global object.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define HAVE_SCREEN_SPECIFIC_PRIVATE_KEYS 1
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT Bool
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixRegisterScreenSpecificPrivateKey(ScreenPtr pScreen, DevPrivateKey key,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DevPrivateType type, unsigned size);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* Clean up screen-specific privates before CloseScreen */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern void
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixFreeScreenSpecificPrivates(ScreenPtr pScreen);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/* Initialize screen-specific privates in AddScreen */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern void
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixInitScreenSpecificPrivates(ScreenPtr pScreen);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT void *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync_dixAllocateScreenObjectWithPrivates(ScreenPtr pScreen,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned size,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned clear,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned offset,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DevPrivateType type);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define dixAllocateScreenObjectWithPrivates(s, t, type) _dixAllocateScreenObjectWithPrivates(s, sizeof(t), sizeof(t), offsetof(t, devPrivates), type)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT int
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncdixScreenSpecificPrivatesSize(ScreenPtr pScreen, DevPrivateType type);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT void
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync_dixInitScreenPrivates(ScreenPtr pScreen, PrivatePtr *privates, void *addr, DevPrivateType type);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define dixInitScreenPrivates(s, o, v, type) _dixInitScreenPrivates(s, &(o)->devPrivates, (v), type);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Allocates private data separately from main object.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * For objects created during server initialization, this allows those
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * privates to be re-allocated as new private keys are registered.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * This includes screens, the serverClient, default colormaps and
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * extensions entries.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT Bool
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync dixAllocatePrivates(PrivatePtr *privates, DevPrivateType type);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Frees separately allocated private data
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT void
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync dixFreePrivates(PrivatePtr privates, DevPrivateType type);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Initialize privates by zeroing them
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT void
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync_dixInitPrivates(PrivatePtr *privates, void *addr, DevPrivateType type);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define dixInitPrivates(o, v, type) _dixInitPrivates(&(o)->devPrivates, (v), type);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Clean up privates
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT void
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync _dixFiniPrivates(PrivatePtr privates, DevPrivateType type);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define dixFiniPrivates(o,t) _dixFiniPrivates((o)->devPrivates,t)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Allocates private data at object creation time. Required
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * for almost all objects, except for the list described
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * above for dixAllocatePrivates.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT void *_dixAllocateObjectWithPrivates(unsigned size,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned clear,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync unsigned offset,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DevPrivateType type);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define dixAllocateObjectWithPrivates(t, type) (t *) _dixAllocateObjectWithPrivates(sizeof(t), sizeof(t), offsetof(t, devPrivates), type)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT void
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync_dixFreeObjectWithPrivates(void *object, PrivatePtr privates,
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync DevPrivateType type);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define dixFreeObjectWithPrivates(o,t) _dixFreeObjectWithPrivates(o, (o)->devPrivates, t)
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Return size of privates for the specified type
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT int
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync dixPrivatesSize(DevPrivateType type);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Dump out private stats to ErrorF
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern void
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync dixPrivateUsage(void);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Resets the privates subsystem. dixResetPrivates is called from the main loop
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * before each server generation. This function must only be called by main().
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT void
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync dixResetPrivates(void);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Looks up the offset where the devPrivates field is located.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync *
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Returns -1 if the specified resource has no dev privates.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * The position of the devPrivates field varies by structure
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * and calling code might only know the resource type, not the
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * structure definition.
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsyncextern _X_EXPORT int
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync dixLookupPrivateOffset(RESTYPE type);
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync/*
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * Convenience macro for adding an offset to an object pointer
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync * when making a call to one of the devPrivates functions
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#define DEVPRIV_AT(ptr, offset) ((PrivatePtr *)((char *)(ptr) + offset))
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync#endif /* PRIVATES_H */
deb4998ba50060c48cce222fd18a8eed053918d7vboxsync