geext.c 11.4 KB
Newer Older
1
/*
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38

Copyright 2007 Peter Hutterer <peter@cs.unisa.edu.au>

Permission to use, copy, modify, distribute, and sell this software and its
documentation for any purpose is hereby granted without fee, provided that
the above copyright notice appear in all copies and that both that
copyright notice and this permission notice appear in supporting
documentation.

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of the author shall
not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization
from the author.

*/


#ifdef HAVE_DIX_CONFIG_H
#include <dix-config.h>
#endif
#include "windowstr.h"
#include <X11/extensions/ge.h>

#include "geint.h"
#include "geext.h"

39 40 41 42 43
/* Currently supported XGE version */
#define SERVER_GE_MAJOR 1
#define SERVER_GE_MINOR 0


44 45
int GEEventBase;
int GEErrorBase;
46
DevPrivateKey GEClientPrivateKey = &GEClientPrivateKey;
47 48 49
int GEEventType; /* The opcode for all GenericEvents will have. */


50
GEExtension GEExtensions[MAXEXTENSIONS];
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80

/* Major available requests */
static const int version_requests[] = {
    X_GEQueryVersion,	/* before client sends QueryVersion */
    X_GEQueryVersion,	/* must be set to last request in version 1 */
};

/* Forward declarations */
static void SGEGenericEvent(xEvent* from, xEvent* to);

#define NUM_VERSION_REQUESTS	(sizeof (version_requests) / sizeof (version_requests[0]))

/************************************************************/
/*                request handlers                          */
/************************************************************/

static int ProcGEQueryVersion(ClientPtr client)
{
    int n;
    GEClientInfoPtr pGEClient = GEGetClient(client);
    xGEQueryVersionReply rep;
    REQUEST(xGEQueryVersionReq);

    REQUEST_SIZE_MATCH(xGEQueryVersionReq);

    rep.repType = X_Reply;
    rep.RepType = X_GEQueryVersion;
    rep.length = 0;
    rep.sequenceNumber = client->sequence;

81 82 83
    /* return the supported version by the server */
    rep.majorVersion = SERVER_GE_MAJOR;
    rep.minorVersion = SERVER_GE_MINOR;
84

85 86 87
    /* Remember version the client requested */
    pGEClient->major_version = stuff->majorVersion;
    pGEClient->minor_version = stuff->minorVersion;
88 89 90

    if (client->swapped)
    {
91 92
	swaps(&rep.sequenceNumber, n);
        swapl(&rep.length, n);
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
        swaps(&rep.majorVersion, n);
        swaps(&rep.minorVersion, n);
    }

    WriteToClient(client, sizeof(xGEQueryVersionReply), (char*)&rep);
    return(client->noClientException);
}

int (*ProcGEVector[GENumberRequests])(ClientPtr) = {
    /* Version 1.0 */
    ProcGEQueryVersion
};

/************************************************************/
/*                swapped request handlers                  */
/************************************************************/
static int
SProcGEQueryVersion(ClientPtr client)
{
    int n;
    REQUEST(xGEQueryVersionReq);

    swaps(&stuff->length, n);
    REQUEST_SIZE_MATCH(xGEQueryVersionReq);
    swaps(&stuff->majorVersion, n);
    swaps(&stuff->minorVersion, n);
    return(*ProcGEVector[stuff->ReqType])(client);
}

int (*SProcGEVector[GENumberRequests])(ClientPtr) = {
    /* Version 1.0 */
    SProcGEQueryVersion
};


/************************************************************/
/*                callbacks                                 */
/************************************************************/

/* dispatch requests */
133
static int
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
ProcGEDispatch(ClientPtr client)
{
    GEClientInfoPtr pGEClient = GEGetClient(client);
    REQUEST(xGEReq);

    if (pGEClient->major_version >= NUM_VERSION_REQUESTS)
        return BadRequest;
    if (stuff->ReqType > version_requests[pGEClient->major_version])
        return BadRequest;

    return (ProcGEVector[stuff->ReqType])(client);
}

/* dispatch swapped requests */
static int
SProcGEDispatch(ClientPtr client)
{
    REQUEST(xGEReq);
    if (stuff->ReqType >= GENumberRequests)
        return BadRequest;
    return (*SProcGEVector[stuff->ReqType])(client);
}

157 158 159 160 161 162
/**
 * Called when a new client inits a connection to the X server.
 *
 * We alloc a simple struct to store the client's major/minor version. Can be
 * used in the furture for versioning support.
 */
163 164 165 166 167 168 169 170
static void GEClientCallback(CallbackListPtr *list,
        pointer closure,
        pointer data)
{
    NewClientInfoRec	*clientinfo = (NewClientInfoRec *) data;
    ClientPtr		pClient = clientinfo->client;
    GEClientInfoPtr     pGEClient = GEGetClient(pClient);

171 172 173 174 175 176
    if (pGEClient == NULL)
    {
        pGEClient = xcalloc(1, sizeof(GEClientInfoRec));
        dixSetPrivate(&pClient->devPrivates, GEClientPrivateKey, pGEClient);
    }

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
    pGEClient->major_version = 0;
    pGEClient->minor_version = 0;
}

/* reset extension */
static void
GEResetProc(ExtensionEntry *extEntry)
{
    DeleteCallback(&ClientStateCallback, GEClientCallback, 0);
    EventSwapVector[GenericEvent] = NotImplemented;

    GEEventBase = 0;
    GEErrorBase = 0;
    GEEventType = 0;
}

/*  Calls the registered event swap function for the extension. */
194
static void
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
SGEGenericEvent(xEvent* from, xEvent* to)
{
    xGenericEvent* gefrom = (xGenericEvent*)from;
    xGenericEvent* geto = (xGenericEvent*)to;

    if (gefrom->extension > MAXEXTENSIONS)
    {
        ErrorF("GE: Invalid extension offset for event.\n");
        return;
    }

    if (GEExtensions[gefrom->extension & 0x7F].evswap)
        GEExtensions[gefrom->extension & 0x7F].evswap(gefrom, geto);
}

/* init extension, register at server */
211
void
212 213 214 215 216 217 218 219 220
GEExtensionInit(void)
{
    ExtensionEntry *extEntry;

    if(!AddCallback(&ClientStateCallback, GEClientCallback, 0))
    {
        FatalError("GEExtensionInit: register client callback failed.\n");
    }

221 222 223
    if((extEntry = AddExtension(GE_NAME,
                        GENumberEvents, GENumberErrors,
                        ProcGEDispatch, SProcGEDispatch,
224 225 226 227 228 229 230 231
                        GEResetProc, StandardMinorOpcode)) != 0)
    {
        GEEventBase = extEntry->eventBase;
        GEErrorBase = extEntry->errorBase;
        GEEventType = GEEventBase;

        memset(GEExtensions, 0, sizeof(GEExtensions));

232
        EventSwapVector[GenericEvent] = (EventSwapPtr) SGEGenericEvent;
233 234 235 236 237 238 239 240 241 242
    } else {
        FatalError("GEInit: AddExtensions failed.\n");
    }

}

/************************************************************/
/*                interface for extensions                  */
/************************************************************/

243 244
/* Register an extension with GE. The given swap function will be called each
 * time an event is sent to a client with different byte order.
245 246
 * @param extension The extensions major opcode
 * @param ev_swap The event swap function.
247 248
 * @param ev_fill Called for an event before delivery. The extension now has
 * the chance to fill in necessary fields for the event.
249 250
 */
void GERegisterExtension(
251
        int extension,
252
        void (*ev_swap)(xGenericEvent* from, xGenericEvent* to),
253
        void (*ev_fill)(xGenericEvent* ev, DeviceIntPtr pDev,
254
                        WindowPtr pWin, GrabPtr pGrab)
255 256 257 258 259 260 261
        )
{
    if ((extension & 0x7F) >=  MAXEXTENSIONS)
        FatalError("GE: extension > MAXEXTENSIONS. This should not happen.\n");

    /* extension opcodes are > 128, might as well save some space here */
    GEExtensions[extension & 0x7f].evswap = ev_swap;
262
    GEExtensions[extension & 0x7f].evfill = ev_fill;
263 264 265 266
}


/* Sets type and extension field for a generic event. This is just an
267 268
 * auxiliary function, extensions could do it manually too.
 */
269 270 271 272 273 274 275 276
void GEInitEvent(xGenericEvent* ev, int extension)
{
    ev->type = GenericEvent;
    ev->extension = extension;
    ev->length = 0;
}

/* Recalculates the summary mask for the window. */
277
static void
278 279 280
GERecalculateWinMask(WindowPtr pWin)
{
    int i;
281 282
    GenericMaskPtr it;
    GenericClientMasksPtr evmasks;
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305

    if (!pWin->optional)
        return;

    evmasks = pWin->optional->geMasks;

    for (i = 0; i < MAXEXTENSIONS; i++)
    {
        evmasks->eventMasks[i] = 0;
    }

    it = pWin->optional->geMasks->geClients;
    while(it)
    {
        for (i = 0; i < MAXEXTENSIONS; i++)
        {
            evmasks->eventMasks[i] |= it->eventMask[i];
        }
        it = it->next;
    }
}

/* Set generic event mask for given window. */
306
void GEWindowSetMask(ClientPtr pClient, DeviceIntPtr pDev,
307
                     WindowPtr pWin, int extension, Mask mask)
308
{
309
    GenericMaskPtr cli;
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326

    extension = (extension & 0x7F);

    if (extension > MAXEXTENSIONS)
    {
        ErrorF("Invalid extension number.\n");
        return;
    }

    if (!pWin->optional && !MakeWindowOptional(pWin))
    {
        ErrorF("GE: Could not make window optional.\n");
        return;
    }

    if (mask)
    {
327
        GenericClientMasksPtr evmasks = pWin->optional->geMasks;
328 329 330 331 332

        /* check for existing client */
        cli = evmasks->geClients;
        while(cli)
        {
333
            if (cli->client == pClient && cli->dev == pDev)
334 335 336 337 338
                break;
            cli = cli->next;
        }
        if (!cli)
        {
339
            /* new client and/or new device */
340
            cli  = (GenericMaskPtr)xcalloc(1, sizeof(GenericMaskRec));
341 342 343 344 345 346 347
            if (!cli)
            {
                ErrorF("GE: Insufficient memory to alloc client.\n");
                return;
            }
            cli->next = evmasks->geClients;
            cli->client = pClient;
348
            cli->dev = pDev;
349 350 351 352 353 354 355
            evmasks->geClients = cli;
        }
        cli->eventMask[extension] = mask;
    } else
    {
        /* remove client. */
        cli = pWin->optional->geMasks->geClients;
356
        if (cli->client == pClient && cli->dev == pDev)
357 358 359 360 361
        {
            pWin->optional->geMasks->geClients = cli->next;
            xfree(cli);
        } else 
        { 
362
            GenericMaskPtr prev = cli;
363 364 365 366
            cli = cli->next;

            while(cli)
            {
367
                if (cli->client == pClient && cli->dev == pDev)
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
                {
                    prev->next = cli->next;
                    xfree(cli);
                    break;
                }
                prev = cli;
                cli = cli->next;
            }
        }
        if (!cli)
            return;
    }

    GERecalculateWinMask(pWin);
}

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
/**
 * Return TRUE if the mask for the given device is set.
 * @param pWin Window the event may be delivered to.
 * @param pDev Device the device originating the event. May be NULL.
 * @param extension Extension ID
 * @param mask Event mask
 */
BOOL GEDeviceMaskIsSet(WindowPtr pWin, DeviceIntPtr pDev,
                       int extension, Mask mask)
{
    GenericMaskPtr gemask;

    if (!pWin->optional || !pWin->optional->geMasks)
        return FALSE;

    extension &= 0x7F;

    if (!pWin->optional->geMasks->eventMasks[extension] & mask)
        return FALSE;


    gemask = pWin->optional->geMasks->geClients;

    while(gemask)
    {
409
        if ((!gemask->dev || gemask->dev == pDev) &&
410 411 412 413 414 415 416 417
                (gemask->eventMask[extension] & mask))
            return TRUE;

        gemask = gemask->next;
    }

    return FALSE;
}
418