03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/***********************************************************
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
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
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncAUTHOR 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.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync******************************************************************/
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#ifndef PRIVATES_H
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define PRIVATES_H 1
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#include <X11/Xdefs.h>
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#include <X11/Xosdefs.h>
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#include <X11/Xfuncproto.h>
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#include "misc.h"
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*****************************************************************
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * STUFF FOR PRIVATES
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *****************************************************************/
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsynctypedef struct _Private PrivateRec, *PrivatePtr;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsynctypedef enum {
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync /* XSELinux uses the same private keys for numerous objects */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_XSELINUX,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync /* Otherwise, you get a private in just the requested structure
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync /* These can have objects created before all of the keys are registered */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_SCREEN,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_EXTENSION,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_COLORMAP,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_DEVICE,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync /* These cannot have any objects before all relevant keys are registered */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_CLIENT,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_PROPERTY,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_SELECTION,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_WINDOW,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_PIXMAP,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_GC,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_CURSOR,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_CURSOR_BITS,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync /* extension privates */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_DBE_WINDOW,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_DAMAGE,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_GLYPH,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_GLYPHSET,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_PICTURE,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_SYNC_FENCE,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync /* last private type */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync PRIVATE_LAST,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync} DevPrivateType;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsynctypedef struct _DevPrivateKeyRec {
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync int offset;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync int size;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync Bool initialized;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync Bool allocated;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync DevPrivateType type;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync struct _DevPrivateKeyRec *next;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync} DevPrivateKeyRec, *DevPrivateKey;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsynctypedef struct _DevPrivateSetRec {
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync DevPrivateKey key;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync unsigned offset;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync int created;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync int allocated;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync} DevPrivateSetRec, *DevPrivateSetPtr;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsynctypedef struct _DevScreenPrivateKeyRec {
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync DevPrivateKeyRec screenKey;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync} DevScreenPrivateKeyRec, *DevScreenPrivateKey;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Let drivers know how to initialize private keys
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define HAS_DEVPRIVATEKEYREC 1
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define HAS_DIXREGISTERPRIVATEKEY 1
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Register a new private index for the private type.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * This initializes the specified key and optionally requests pre-allocated
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * private space for your driver/module. If you request no extra space, you
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * may set and get a single pointer value using this private key. Otherwise,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * you can get the address of the extra space and store whatever data you like
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * there.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * You may call dixRegisterPrivateKey more than once on the same key, but the
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * size and type must match or the server will abort.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * dixRegisterPrivateKey returns FALSE if it fails to allocate memory
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * during its operation.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT Bool
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync dixRegisterPrivateKey(DevPrivateKey key, DevPrivateType type, unsigned size);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Check whether a private key has been registered
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncstatic inline Bool
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixPrivateKeyRegistered(DevPrivateKey key)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync{
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync return key->initialized;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync}
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Get the address of the private storage.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * For keys with pre-defined storage, this gets the base of that storage
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Otherwise, it returns the place where the private pointer is stored.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncstatic inline void *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixGetPrivateAddr(PrivatePtr *privates, const DevPrivateKey key)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync{
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync assert(key->initialized);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync return (char *) (*privates) + key->offset;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync}
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Fetch a private pointer stored in the object
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Returns the pointer stored with dixSetPrivate.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * This must only be used with keys that have
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * no pre-defined storage
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncstatic inline void *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixGetPrivate(PrivatePtr *privates, const DevPrivateKey key)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync{
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync assert(key->size == 0);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync return *(void **) dixGetPrivateAddr(privates, key);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync}
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Associate 'val' with 'key' in 'privates' so that later calls to
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * dixLookupPrivate(privates, key) will return 'val'.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncstatic inline void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixSetPrivate(PrivatePtr *privates, const DevPrivateKey key, pointer val)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync{
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync assert(key->size == 0);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *(pointer *) dixGetPrivateAddr(privates, key) = val;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync}
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#include "dix.h"
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#include "resource.h"
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Lookup a pointer to the private record.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * For privates with defined storage, return the address of the
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * storage. For privates without defined storage, return the pointer
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * contents
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncstatic inline pointer
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixLookupPrivate(PrivatePtr *privates, const DevPrivateKey key)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync{
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync if (key->size)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync return dixGetPrivateAddr(privates, key);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync else
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync return dixGetPrivate(privates, key);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync}
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Look up the address of the pointer to the storage
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * This returns the place where the private pointer is stored,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * which is only valid for privates without predefined storage.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncstatic inline pointer *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixLookupPrivateAddr(PrivatePtr *privates, const DevPrivateKey key)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync{
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync assert(key->size == 0);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync return (pointer *) dixGetPrivateAddr(privates, key);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync}
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT Bool
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixRegisterScreenPrivateKey(DevScreenPrivateKey key, ScreenPtr pScreen,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync DevPrivateType type, unsigned size);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT DevPrivateKey
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync _dixGetScreenPrivateKey(const DevScreenPrivateKey key, ScreenPtr pScreen);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncstatic inline void *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixGetScreenPrivateAddr(PrivatePtr *privates, const DevScreenPrivateKey key,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync ScreenPtr pScreen)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync{
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync return dixGetPrivateAddr(privates, _dixGetScreenPrivateKey(key, pScreen));
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync}
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncstatic inline void *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixGetScreenPrivate(PrivatePtr *privates, const DevScreenPrivateKey key,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync ScreenPtr pScreen)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync{
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync return dixGetPrivate(privates, _dixGetScreenPrivateKey(key, pScreen));
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync}
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncstatic inline void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixSetScreenPrivate(PrivatePtr *privates, const DevScreenPrivateKey key,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync ScreenPtr pScreen, pointer val)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync{
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync dixSetPrivate(privates, _dixGetScreenPrivateKey(key, pScreen), val);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync}
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncstatic inline pointer
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixLookupScreenPrivate(PrivatePtr *privates, const DevScreenPrivateKey key,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync ScreenPtr pScreen)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync{
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync return dixLookupPrivate(privates, _dixGetScreenPrivateKey(key, pScreen));
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync}
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncstatic inline pointer *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixLookupScreenPrivateAddr(PrivatePtr *privates, const DevScreenPrivateKey key,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync ScreenPtr pScreen)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync{
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync return dixLookupPrivateAddr(privates,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync _dixGetScreenPrivateKey(key, pScreen));
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync}
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * These functions relate to allocations related to a specific screen;
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * space will only be available for objects allocated for use on that
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * screen. As such, only objects which are related directly to a specific
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * screen are candidates for allocation this way, this includes
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * windows, pixmaps, gcs, pictures and colormaps. This key is
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * used just like any other key using dixGetPrivate and friends.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * This is distinctly different from the ScreenPrivateKeys above which
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * allocate space in global objects like cursor bits for a specific
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * screen, allowing multiple screen-related chunks of storage in a
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * single global object.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define HAVE_SCREEN_SPECIFIC_PRIVATE_KEYS 1
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT Bool
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixRegisterScreenSpecificPrivateKey(ScreenPtr pScreen, DevPrivateKey key,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync DevPrivateType type, unsigned size);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/* Clean up screen-specific privates before CloseScreen */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixFreeScreenSpecificPrivates(ScreenPtr pScreen);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/* Initialize screen-specific privates in AddScreen */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixInitScreenSpecificPrivates(ScreenPtr pScreen);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT void *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync_dixAllocateScreenObjectWithPrivates(ScreenPtr pScreen,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync unsigned size,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync unsigned clear,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync unsigned offset,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync DevPrivateType type);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define dixAllocateScreenObjectWithPrivates(s, t, type) _dixAllocateScreenObjectWithPrivates(s, sizeof(t), sizeof(t), offsetof(t, devPrivates), type)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT int
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncdixScreenSpecificPrivatesSize(ScreenPtr pScreen, DevPrivateType type);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync_dixInitScreenPrivates(ScreenPtr pScreen, PrivatePtr *privates, void *addr, DevPrivateType type);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define dixInitScreenPrivates(s, o, v, type) _dixInitScreenPrivates(s, &(o)->devPrivates, (v), type);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Allocates private data separately from main object.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * For objects created during server initialization, this allows those
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * privates to be re-allocated as new private keys are registered.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * This includes screens, the serverClient, default colormaps and
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * extensions entries.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT Bool
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync dixAllocatePrivates(PrivatePtr *privates, DevPrivateType type);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Frees separately allocated private data
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync dixFreePrivates(PrivatePtr privates, DevPrivateType type);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Initialize privates by zeroing them
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync_dixInitPrivates(PrivatePtr *privates, void *addr, DevPrivateType type);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define dixInitPrivates(o, v, type) _dixInitPrivates(&(o)->devPrivates, (v), type);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Clean up privates
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync _dixFiniPrivates(PrivatePtr privates, DevPrivateType type);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define dixFiniPrivates(o,t) _dixFiniPrivates((o)->devPrivates,t)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Allocates private data at object creation time. Required
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * for almost all objects, except for the list described
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * above for dixAllocatePrivates.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT void *_dixAllocateObjectWithPrivates(unsigned size,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync unsigned clear,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync unsigned offset,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync DevPrivateType type);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define dixAllocateObjectWithPrivates(t, type) (t *) _dixAllocateObjectWithPrivates(sizeof(t), sizeof(t), offsetof(t, devPrivates), type)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync_dixFreeObjectWithPrivates(void *object, PrivatePtr privates,
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync DevPrivateType type);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define dixFreeObjectWithPrivates(o,t) _dixFreeObjectWithPrivates(o, (o)->devPrivates, t)
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Return size of privates for the specified type
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT int
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync dixPrivatesSize(DevPrivateType type);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Dump out private stats to ErrorF
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync dixPrivateUsage(void);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Resets the privates subsystem. dixResetPrivates is called from the main loop
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * before each server generation. This function must only be called by main().
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT void
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync dixResetPrivates(void);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Looks up the offset where the devPrivates field is located.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync *
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Returns -1 if the specified resource has no dev privates.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * The position of the devPrivates field varies by structure
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * and calling code might only know the resource type, not the
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * structure definition.
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsyncextern _X_EXPORT int
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync dixLookupPrivateOffset(RESTYPE type);
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync/*
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * Convenience macro for adding an offset to an object pointer
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync * when making a call to one of the devPrivates functions
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync */
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#define DEVPRIV_AT(ptr, offset) ((PrivatePtr *)((char *)(ptr) + offset))
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync
03532efdc331b598d3dedc8cc7477641c3b0dd12vboxsync#endif /* PRIVATES_H */