[PATCH 11/12] Add a new XI2Mask struct and a few helper functions.

Peter Hutterer peter.hutterer at who-t.net
Tue Nov 8 20:04:17 PST 2011


On Tue, Nov 08, 2011 at 11:00:21AM +0100, walter harms wrote:
> 
> 
> Am 07.11.2011 22:39, schrieb Peter Hutterer:
> > The current XI2 mask handling is handy for copying (fixed size arrays) but a
> > pain to deal with otherwise. Add a struct for XI2 masks and the required
> > accessors.
> > 
> > Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
> > ---
> >  dix/inpututils.c     |  161 ++++++++++++++++++++++++++++++++++++++++++++++++++
> >  include/input.h      |    1 +
> >  include/inputstr.h   |    6 ++
> >  include/inpututils.h |   12 ++++
> >  test/xi2/Makefile.am |    5 +-
> >  test/xi2/xi2.c       |  129 ++++++++++++++++++++++++++++++++++++++++
> >  6 files changed, 313 insertions(+), 1 deletions(-)
> >  create mode 100644 test/xi2/xi2.c
> > 
> > diff --git a/dix/inpututils.c b/dix/inpututils.c
> > index c152b2d..d0a205d 100644
> > --- a/dix/inpututils.c
> > +++ b/dix/inpututils.c
> > @@ -892,3 +892,164 @@ double_to_fp3232(double in)
> >      ret.frac = frac_d;
> >      return ret;
> >  }
> > +
> > +/**
> > + * DO NOT USE THIS FUNCTION. It only exists for the test cases. Use
> > + * xi2mask_new() instead to get the standard sized masks.
> > + *
> > + * @param nmasks The number of masks (== number of devices)
> > + * @param size The size of the masks in bytes
> > + * @return The new mask or NULL on allocation error.
> > + */
> > +XI2Mask*
> > +xi2mask_new_with_size(size_t nmasks, size_t size)
> > +{
> > +    XI2Mask *mask = calloc(1, sizeof(*mask));
> 
> normally you would expect an
> 	if (!mask)
> 		return NULL;

amended, thanks.

> > +    if (mask) {
> > +        int i;
> > +
> > +        mask->nmasks = nmasks;
> > +        mask->mask_size = size;
> > +
> > +        mask->masks = calloc(mask->nmasks, sizeof(*mask->masks));
> > +        if (!mask->masks)
> > +            goto unwind;
> > +
> > +        for (i = 0; i < mask->nmasks; i++) {
> > +            mask->masks[i] = calloc(1, mask->mask_size);
> > +            if (!mask->masks[i])
> > +                goto unwind;
> > +        }
> 
> 	this will leak already allocated mask->masks[i], i do not know the structure
> 	but i guess the want and array of mask[mask->nmasks]. maybe you can change
> 	the code to:
> 	mask->masks = calloc(mask->nmasks, mask->mask_size);
> 
> 	(of cause this will only work for mask->nmasks==const but since it is used for
>         testcases ...

I'm not quite sure yet if the mask should be const or not (all current use-cases)
are but this may change. So I'd rather leave it that way for now. Leaking
shouldn't happen since xi2mask_free will run through the mask and free all
masks.

Cheers,
  Peter

> 	
> 	re
> 		wh
> 
> 
> > +    }
> > +    return mask;
> > +
> > +unwind:
> > +    xi2mask_free(&mask);
> > +    return NULL;
> > +}
> > +
> > +
> > +/**
> > + * Create a new XI2 mask of the standard size, i.e. for all devices + fake
> > + * devices and for the highest supported XI2 event type.
> > + *
> > + * @return The new mask or NULL on allocation error.
> > + */
> > +XI2Mask*
> > +xi2mask_new(void)
> > +{
> > +    return xi2mask_new_with_size(EMASKSIZE, XI2MASKSIZE);
> > +}
> > +
> > +/**
> > + * Frees memory associated with mask and resets mask to NULL.
> > + */
> > +void
> > +xi2mask_free(XI2Mask** mask)
> > +{
> > +    int i;
> > +
> > +    if (!(*mask))
> > +        return;
> > +
> > +    for (i = 0; (*mask)->masks && i < (*mask)->nmasks; i++)
> > +        free((*mask)->masks[i]);
> > +    free((*mask)->masks);
> > +    free((*mask));
> > +    *mask = NULL;
> > +}
> > +
> > +/**
> > + * Test if the bit for event type is set for this device, or the
> > + * XIAllDevices/XIAllMasterDevices (if applicable) is set.
> > + *
> > + * @return TRUE if the bit is set, FALSE otherwise
> > + */
> > +Bool
> > +xi2mask_isset(XI2Mask* mask, const DeviceIntPtr dev, int event_type)
> > +{
> > +    int set = 0;
> > +
> > +    set = !!BitIsOn(mask->masks[XIAllDevices], event_type);
> > +    if (!set)
> > +        set = !!BitIsOn(mask->masks[dev->id], event_type);
> > +    if (!set && IsMaster(dev))
> > +        set = !!BitIsOn(mask->masks[XIAllMasterDevices], event_type);
> > +
> > +    return set;
> > +}
> > +
> > +/**
> > + * Set the mask bit for this event type for this device.
> > + */
> > +void
> > +xi2mask_set(XI2Mask *mask, int deviceid, int event_type)
> > +{
> > +    SetBit(mask->masks[deviceid], event_type);
> > +}
> > +
> > +/**
> > + * Zero out the xi2mask, for the deviceid given. If the deviceid is < 0, all
> > + * masks are zeroed.
> > + */
> > +void
> > +xi2mask_zero(XI2Mask *mask, int deviceid)
> > +{
> > +    int i;
> > +
> > +    if (deviceid >= 0)
> > +        memset(mask->masks[deviceid], 0, mask->mask_size);
> > +    else
> > +        for (i = 0; i < mask->nmasks; i++)
> > +            memset(mask->masks[i], 0, mask->mask_size);
> > +}
> > +
> > +/**
> > + * Merge source into dest, i.e. dest |= source.
> > + * If the masks are of different size, only the overlapping section is merged.
> > + */
> > +void
> > +xi2mask_merge(XI2Mask *dest, const XI2Mask *source)
> > +{
> > +    int i, j;
> > +
> > +    for (i = 0; i < min(dest->nmasks, source->nmasks); i++)
> > +        for (j = 0; j < min(dest->mask_size, source->mask_size); j++)
> > +            dest->masks[i][j] |= source->masks[i][j];
> > +}
> > +
> > +/**
> > + * @return The number of masks in mask
> > + */
> > +size_t
> > +xi2mask_num_masks(const XI2Mask *mask)
> > +{
> > +    return mask->nmasks;
> > +}
> > +
> > +/**
> > + * @return The size of each mask in bytes
> > + */
> > +size_t
> > +xi2mask_mask_size(const XI2Mask *mask)
> > +{
> > +    return mask->mask_size;
> > +}
> > +
> > +/**
> > + * Set the mask for the given deviceid to the source mask.
> > + */
> > +void
> > +xi2mask_set_one_mask(XI2Mask *xi2mask, int deviceid, const unsigned char *mask, size_t mask_size)
> > +{
> > +    memcpy(xi2mask->masks[deviceid], mask, min(xi2mask->mask_size, mask_size));
> > +}
> > +
> > +/**
> > + * Get a reference to the XI2mask for this particular device.
> > + */
> > +const unsigned char*
> > +xi2mask_get_one_mask(const XI2Mask *mask, int deviceid)
> > +{
> > +    return mask->masks[deviceid];
> > +}
> > diff --git a/include/input.h b/include/input.h
> > index 3c6f6af..ef82d5e 100644
> > --- a/include/input.h
> > +++ b/include/input.h
> > @@ -205,6 +205,7 @@ extern _X_EXPORT KeybdCtrl	defaultKeyboardControl;
> >  extern _X_EXPORT PtrCtrl	defaultPointerControl;
> >  
> >  typedef struct _InputOption InputOption;
> > +typedef struct _XI2Mask XI2Mask;
> >  
> >  typedef struct _InputAttributes {
> >      char                *product;
> > diff --git a/include/inputstr.h b/include/inputstr.h
> > index 0c1e523..a8d03dc 100644
> > --- a/include/inputstr.h
> > +++ b/include/inputstr.h
> > @@ -622,4 +622,10 @@ static inline WindowPtr DeepestSpriteWin(SpritePtr sprite)
> >      return sprite->spriteTrace[sprite->spriteTraceGood - 1];
> >  }
> >  
> > +struct _XI2Mask {
> > +    unsigned char **masks;      /* event mask in masks[deviceid][event type byte] */
> > +    size_t nmasks;              /* number of masks */
> > +    size_t mask_size;           /* size of each mask in bytes */
> > +};
> > +
> >  #endif /* INPUTSTRUCT_H */
> > diff --git a/include/inpututils.h b/include/inpututils.h
> > index 2832ed5..5f9dfec 100644
> > --- a/include/inpututils.h
> > +++ b/include/inpututils.h
> > @@ -46,4 +46,16 @@ FP1616 double_to_fp1616(double in);
> >  double fp1616_to_double(FP1616 in);
> >  double fp3232_to_double(FP3232 in);
> >  
> > +
> > +XI2Mask* xi2mask_new(void);
> > +XI2Mask* xi2mask_new_with_size(size_t, size_t); /* don't use it */
> > +void xi2mask_free(XI2Mask** mask);
> > +Bool xi2mask_isset(XI2Mask* mask, const DeviceIntPtr dev, int event_type);
> > +void xi2mask_set(XI2Mask *mask, int deviceid, int event_type);
> > +void xi2mask_zero(XI2Mask *mask, int deviceid);
> > +void xi2mask_merge(XI2Mask *dest, const XI2Mask *source);
> > +size_t xi2mask_num_masks(const XI2Mask *mask);
> > +size_t xi2mask_mask_size(const XI2Mask *mask);
> > +void xi2mask_set_one_mask(XI2Mask *xi2mask, int deviceid, const unsigned char *mask, size_t mask_size);
> > +const unsigned char* xi2mask_get_one_mask(const XI2Mask *xi2mask, int deviceid);
> >  #endif
> > diff --git a/test/xi2/Makefile.am b/test/xi2/Makefile.am
> > index b15d8ba..8fe95c9 100644
> > --- a/test/xi2/Makefile.am
> > +++ b/test/xi2/Makefile.am
> > @@ -10,7 +10,8 @@ noinst_PROGRAMS =  \
> >          protocol-xipassivegrabdevice \
> >          protocol-xiquerypointer \
> >          protocol-xiwarppointer \
> > -        protocol-eventconvert
> > +        protocol-eventconvert \
> > +        xi2
> >  
> >  TESTS=$(noinst_PROGRAMS)
> >  
> > @@ -33,6 +34,7 @@ protocol_xiquerypointer_LDADD=$(TEST_LDADD)
> >  protocol_xipassivegrabdevice_LDADD=$(TEST_LDADD)
> >  protocol_xiwarppointer_LDADD=$(TEST_LDADD)
> >  protocol_eventconvert_LDADD=$(TEST_LDADD)
> > +xi2_LDADD=$(TEST_LDADD)
> >  
> >  protocol_xiqueryversion_LDFLAGS=$(AM_LDFLAGS) -Wl,-wrap,WriteToClient
> >  protocol_xiquerydevice_LDFLAGS=$(AM_LDFLAGS) -Wl,-wrap,WriteToClient
> > @@ -43,6 +45,7 @@ protocol_xigetclientpointer_LDFLAGS=$(AM_LDFLAGS) -Wl,-wrap,WriteToClient -Wl,-w
> >  protocol_xipassivegrabdevice_LDFLAGS=$(AM_LDFLAGS) -Wl,-wrap,GrabButton -Wl,-wrap,dixLookupWindow -Wl,-wrap,WriteToClient
> >  protocol_xiquerypointer_LDFLAGS=$(AM_LDFLAGS) -Wl,-wrap,WriteToClient -Wl,-wrap,dixLookupWindow
> >  protocol_xiwarppointer_LDFLAGS=$(AM_LDFLAGS) -Wl,-wrap,WriteToClient -Wl,-wrap,dixLookupWindow
> > +xi2_LDFLAGS=$(AM_LDFLAGS)
> >  
> >  protocol_xiqueryversion_SOURCES=$(COMMON_SOURCES) protocol-xiqueryversion.c
> >  protocol_xiquerydevice_SOURCES=$(COMMON_SOURCES) protocol-xiquerydevice.c
> > diff --git a/test/xi2/xi2.c b/test/xi2/xi2.c
> > new file mode 100644
> > index 0000000..5143caf
> > --- /dev/null
> > +++ b/test/xi2/xi2.c
> > @@ -0,0 +1,129 @@
> > +/**
> > + * Copyright © 2011 Red Hat, Inc.
> > + *
> > + *  Permission is hereby granted, free of charge, to any person obtaining a
> > + *  copy of this software and associated documentation files (the "Software"),
> > + *  to deal in the Software without restriction, including without limitation
> > + *  the rights to use, copy, modify, merge, publish, distribute, sublicense,
> > + *  and/or sell copies of the Software, and to permit persons to whom the
> > + *  Software is furnished to do so, subject to the following conditions:
> > + *
> > + *  The above copyright notice and this permission notice (including the next
> > + *  paragraph) 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 AUTHORS OR COPYRIGHT HOLDERS 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.
> > + */
> > +
> > +#ifdef HAVE_DIX_CONFIG_H
> > +#include <dix-config.h>
> > +#endif
> > +
> > +#include <stdint.h>
> > +#include "inpututils.h"
> > +#include "inputstr.h"
> > +#include "assert.h"
> > +
> > +static void xi2mask_test(void)
> > +{
> > +    XI2Mask *xi2mask = NULL,
> > +            *mergemask = NULL;
> > +    unsigned char *mask;
> > +    DeviceIntRec dev;
> > +    int i;
> > +
> > +    /* size >= nmasks * 2 for the test cases below */
> > +    xi2mask = xi2mask_new_with_size(MAXDEVICES + 2, (MAXDEVICES + 2) * 2);
> > +    assert(xi2mask);
> > +    assert(xi2mask->nmasks > 0);
> > +    assert(xi2mask->mask_size > 0);
> > +
> > +    assert(xi2mask_mask_size(xi2mask) == xi2mask->mask_size);
> > +    assert(xi2mask_num_masks(xi2mask) == xi2mask->nmasks);
> > +
> > +    mask = calloc(1, xi2mask_mask_size(xi2mask));
> > +    /* ensure zeros */
> > +    for (i = 0; i < xi2mask_num_masks(xi2mask); i++) {
> > +        const unsigned char *m = xi2mask_get_one_mask(xi2mask, i);
> > +        assert(memcmp(mask, m, xi2mask_mask_size(xi2mask)) == 0);
> > +    }
> > +
> > +    /* set various bits */
> > +    for (i = 0; i < xi2mask_num_masks(xi2mask); i++) {
> > +        const unsigned char *m;
> > +        xi2mask_set(xi2mask, i, i);
> > +
> > +        dev.id = i;
> > +        assert(xi2mask_isset(xi2mask, &dev, i));
> > +
> > +        m = xi2mask_get_one_mask(xi2mask, i);
> > +        SetBit(mask, i);
> > +        assert(memcmp(mask, m, xi2mask_mask_size(xi2mask)) == 0);
> > +        ClearBit(mask, i);
> > +    }
> > +
> > +    /* ensure zeros one-by-one */
> > +    for (i = 0; i < xi2mask_num_masks(xi2mask); i++) {
> > +        const unsigned char *m = xi2mask_get_one_mask(xi2mask, i);
> > +        assert(memcmp(mask, m, xi2mask_mask_size(xi2mask)) != 0);
> > +        xi2mask_zero(xi2mask, i);
> > +        assert(memcmp(mask, m, xi2mask_mask_size(xi2mask)) == 0);
> > +    }
> > +
> > +    /* re-set, zero all */
> > +    for (i = 0; i < xi2mask_num_masks(xi2mask); i++)
> > +        xi2mask_set(xi2mask, i, i);
> > +    xi2mask_zero(xi2mask, -1);
> > +
> > +    for (i = 0; i < xi2mask_num_masks(xi2mask); i++) {
> > +        const unsigned char *m = xi2mask_get_one_mask(xi2mask, i);
> > +        assert(memcmp(mask, m, xi2mask_mask_size(xi2mask)) == 0);
> > +    }
> > +
> > +    for (i = 0; i < xi2mask_num_masks(xi2mask); i++) {
> > +        const unsigned char *m;
> > +        SetBit(mask, i);
> > +        xi2mask_set_one_mask(xi2mask, i, mask, xi2mask_mask_size(xi2mask));
> > +        m = xi2mask_get_one_mask(xi2mask, i);
> > +        assert(memcmp(mask, m, xi2mask_mask_size(xi2mask)) == 0);
> > +        ClearBit(mask, i);
> > +    }
> > +
> > +    mergemask = xi2mask_new_with_size(MAXDEVICES + 2, (MAXDEVICES + 2) * 2);
> > +    for (i = 0; i < xi2mask_num_masks(mergemask); i++) {
> > +        dev.id = i;
> > +        xi2mask_set(mergemask, i, i * 2);
> > +    }
> > +
> > +    /* xi2mask still has all i bits set, should now also have all i * 2 bits */
> > +    xi2mask_merge(xi2mask, mergemask);
> > +    for (i = 0; i < xi2mask_num_masks(mergemask); i++) {
> > +        const unsigned char *m = xi2mask_get_one_mask(xi2mask, i);
> > +        SetBit(mask, i);
> > +        SetBit(mask, i * 2);
> > +        assert(memcmp(mask, m, xi2mask_mask_size(xi2mask)) == 0);
> > +        ClearBit(mask, i);
> > +        ClearBit(mask, i * 2);
> > +    }
> > +
> > +    xi2mask_free(&xi2mask);
> > +    assert(xi2mask == NULL);
> > +
> > +    xi2mask_free(&mergemask);
> > +    assert(mergemask == NULL);
> > +    free(mask);
> > +}
> > +
> > +
> > +int main(int argc, char** argv)
> > +{
> > +    xi2mask_test();
> > +
> > +    return 0;
> > +}


More information about the xorg-devel mailing list