summaryrefslogtreecommitdiff
path: root/tests/server/barriers-notify.cpp
blob: 56b20928790c1c5d1de7f8f90e9e24dafce45472 (plain)
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
39
40
41
42
43
44
45
46
47
48
49
50
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
81
82
83
84
85
86
87
88
89
90
91
92
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
#if HAVE_CONFIG_H
#include <config.h>
#endif

#include <xorg/gtest/xorg-gtest.h>

#include <X11/Xlib.h>
#include <X11/Xatom.h>
#include <X11/extensions/Xfixes.h>
#include <X11/extensions/XInput2.h>

#include "barriers-common.h"
#include "xit-event.h"
#include "helpers.h"

using namespace xorg::testing::evemu;

class BarrierNotify : public BarrierTest {};

#define ASSERT_PTR_POS(x, y)                            \
    QueryPointerPosition(dpy, &root_x, &root_y);        \
    ASSERT_EQ(x, root_x);                               \
    ASSERT_EQ(y, root_y);

TEST_F(BarrierNotify, ReceivesNotifyEvents)
{
    XORG_TESTCASE("Ensure that we receive BarrierNotify events\n"
                  "when barriers are hit.\n");

    ::Display *dpy = Display();
    Window root = DefaultRootWindow(dpy);
    PointerBarrier barrier;

    XIWarpPointer(dpy, VIRTUAL_CORE_POINTER_ID, None, root, 0, 0, 0, 0, 30, 30);

    barrier = XFixesCreatePointerBarrier(dpy, root, 20, 20, 20, 40, 0, 0, NULL);
    XSync(dpy, False);

    XIEventMask mask;
    mask.deviceid = XIAllMasterDevices;
    mask.mask_len = XIMaskLen(XI_LASTEVENT);
    mask.mask = reinterpret_cast<unsigned char*>(calloc(mask.mask_len, 1));
    XISetMask(mask.mask, XI_BarrierHit);
    XISelectEvents(dpy, root, &mask, 1);
    free(mask.mask);
    XSync(dpy, False);

    dev->PlayOne(EV_REL, REL_X, -40, True);

    /* Ensure we have a BarrierHit on our hands. */
    XITEvent<XIBarrierEvent> event(dpy, GenericEvent, xi2_opcode, XI_BarrierHit);
    ASSERT_EQ(barrier, event.ev->barrier);
    ASSERT_EQ(20, event.ev->root_x);
    ASSERT_EQ(-40, event.ev->dx);

    XFixesDestroyPointerBarrier(dpy, barrier);
}

TEST_F(BarrierNotify, CorrectEventIDs)
{
    XORG_TESTCASE("Ensure that barrier event IDs have correct and "
                  "sequential values, and that multiple chained hits "
                  "have the same event ID\n");

    ::Display *dpy = Display();
    Window root = DefaultRootWindow(dpy);
    PointerBarrier barrier;

    XIWarpPointer(dpy, VIRTUAL_CORE_POINTER_ID, None, root, 0, 0, 0, 0, 30, 30);

    barrier = XFixesCreatePointerBarrier(dpy, root, 20, 20, 20, 40, 0, 0, NULL);
    XSync(dpy, False);

    XIEventMask mask;
    mask.deviceid = XIAllMasterDevices;
    mask.mask_len = XIMaskLen(XI_LASTEVENT);
    mask.mask = reinterpret_cast<unsigned char*>(calloc(mask.mask_len, 1));
    XISetMask(mask.mask, XI_BarrierHit);
    XISetMask(mask.mask, XI_BarrierLeave);
    XISelectEvents(dpy, root, &mask, 1);
    free(mask.mask);
    XSync(dpy, False);

    /* Ensure we have a bunch of BarrierHits on our hands. */
    for (int i = 0; i < 10; i++) {
        dev->PlayOne(EV_REL, REL_X, -40, True);

        /* Ensure we have a BarrierHit on our hands. */
        XITEvent<XIBarrierEvent> event(dpy, GenericEvent, xi2_opcode, XI_BarrierHit);
        ASSERT_EQ(barrier, event.ev->barrier);
        ASSERT_EQ(20, event.ev->root_x);
        ASSERT_EQ(30, event.ev->root_y);
        ASSERT_EQ(-40, event.ev->dx);
        ASSERT_EQ(0, event.ev->dy);
        ASSERT_EQ(1, event.ev->event_id);
    }

    /* Move outside the hitbox, and ensure that we
     * get a BarrierNewEvent */
    dev->PlayOne(EV_REL, REL_X, 20, True);
    XITEvent<XIBarrierEvent> event(dpy, GenericEvent, xi2_opcode, XI_BarrierLeave);
    ASSERT_EQ(barrier, event.ev->barrier);
    ASSERT_EQ(2, event.ev->event_id);

    for (int i = 0; i < 10; i++) {
        dev->PlayOne(EV_REL, REL_X, -40, True);

        XITEvent<XIBarrierEvent> event(dpy, GenericEvent, xi2_opcode, XI_BarrierHit);
        ASSERT_EQ(barrier, event.ev->barrier);
        ASSERT_EQ(2, event.ev->event_id);
    }

    /* Ensure that we're still inside the hit box. Event ID
     * should stay the same on such a minor change. */
    dev->PlayOne(EV_REL, REL_X, 1, True);

    for (int i = 0; i < 10; i++) {
        dev->PlayOne(EV_REL, REL_X, -40, True);

        XITEvent<XIBarrierEvent> event(dpy, GenericEvent, xi2_opcode, XI_BarrierHit);
        ASSERT_EQ(barrier, event.ev->barrier);
        ASSERT_EQ(2, event.ev->event_id);
    }

    XFixesDestroyPointerBarrier(dpy, barrier);
}

TEST_F(BarrierNotify, BarrierReleases)
{
    XORG_TESTCASE("Ensure that releasing barriers works without "
                  "erroring out and allows pointer movement over "
                  "the barrier, and that we properly get a "
                  "XI_BarrierHit with the correct flags.\n");

    ::Display *dpy = Display();
    Window root = DefaultRootWindow(dpy);
    PointerBarrier barrier;

    XIEventMask mask;
    mask.deviceid = XIAllMasterDevices;
    mask.mask_len = XIMaskLen(XI_LASTEVENT);
    mask.mask = reinterpret_cast<unsigned char*>(calloc(mask.mask_len, 1));
    XISetMask(mask.mask, XI_BarrierHit);
    XISetMask(mask.mask, XI_BarrierLeave);
    XISelectEvents(dpy, root, &mask, 1);
    free(mask.mask);
    XSync(dpy, False);

    XIWarpPointer(dpy, VIRTUAL_CORE_POINTER_ID, None, root, 0, 0, 0, 0, 30, 30);

    barrier = XFixesCreatePointerBarrier(dpy, root, 20, 20, 20, 40, 0, 0, NULL);
    XSync(dpy, False);

    dev->PlayOne(EV_REL, REL_X, -40, True);
    {
        XITEvent<XIBarrierEvent> event(dpy, GenericEvent, xi2_opcode, XI_BarrierHit);
        ASSERT_EQ(barrier, event.ev->barrier);
        ASSERT_EQ(1, event.ev->event_id);
        ASSERT_FALSE((event.ev->flags & XIBarrierPointerReleased));
    }

    XIBarrierReleasePointer(dpy, VIRTUAL_CORE_POINTER_ID, barrier, 1);
    XSync(dpy, False);

    dev->PlayOne(EV_REL, REL_X, -40, True);
    {
        XITEvent<XIBarrierEvent> event(dpy, GenericEvent, xi2_opcode, XI_BarrierLeave);
        ASSERT_EQ(barrier, event.ev->barrier);
        ASSERT_EQ(1, event.ev->event_id);
        ASSERT_TRUE((event.ev->flags & XIBarrierPointerReleased));
    }

    /* Immediately afterwards, we should have a new event
     * because we exited the hit box */
    {
        XITEvent<XIBarrierEvent> event(dpy, GenericEvent, xi2_opcode, XI_BarrierLeave);
        ASSERT_EQ(barrier, event.ev->barrier);
        ASSERT_EQ(2, event.ev->event_id);
    }

    XFixesDestroyPointerBarrier(dpy, barrier);
}

TEST_F(BarrierNotify, DestroyWindow)
{
    XORG_TESTCASE("Create a window.\n"
                  "Set up a barrier using this window as drawable.\n"
                  "Select for barrier events.\n"
                  "Ensure events are received\n"
                  "Destroy the window.\n"
                  "Ensure events are not received anymore.\n");

    ::Display *dpy = Display();
    Window root = DefaultRootWindow(dpy);
    Window win = CreateWindow(dpy, root);

    XIWarpPointer(dpy, VIRTUAL_CORE_POINTER_ID, None, root, 0, 0, 0, 0, 30, 30);

    PointerBarrier barrier = XFixesCreatePointerBarrier(dpy, win, 20, 20, 20, 40, 0, 0, NULL);
    XSync(dpy, False);

    XIEventMask mask;
    mask.deviceid = XIAllMasterDevices;
    mask.mask_len = XIMaskLen(XI_LASTEVENT);
    mask.mask = reinterpret_cast<unsigned char*>(calloc(mask.mask_len, 1));
    XISetMask(mask.mask, XI_BarrierHit);
    XISelectEvents(dpy, win, &mask, 1);
    free(mask.mask);
    XSync(dpy, False);

    dev->PlayOne(EV_REL, REL_X, -40, True);

    /* Ensure we have a BarrierHit on our hands. */
    XITEvent<XIBarrierEvent> event(dpy, GenericEvent, xi2_opcode, XI_BarrierHit);
    ASSERT_EQ(barrier, event.ev->barrier);
    ASSERT_EQ(20, event.ev->root_x);
    ASSERT_EQ(-40, event.ev->dx);

    XIWarpPointer(dpy, VIRTUAL_CORE_POINTER_ID, None, root, 0, 0, 0, 0, 30, 30);
    XDestroyWindow(dpy, win);
    XSync(dpy, True);

    dev->PlayOne(EV_REL, REL_X, -40, True);

    double x, y;
    QueryPointerPosition(dpy, &x, &y);
    EXPECT_EQ(x, 20);
    EXPECT_EQ(y, 30);

    ASSERT_FALSE(xorg::testing::XServer::WaitForEventOfType(Display(),
                                                            GenericEvent,
                                                            xi2_opcode,
                                                            XI_BarrierHit,
                                                            500));

    XFixesDestroyPointerBarrier(dpy, barrier);
}

TEST_F(BarrierNotify, UnmapWindow)
{
    XORG_TESTCASE("Create a window.\n"
                  "Set up a barrier using this window as drawable.\n"
                  "Select for barrier events.\n"
                  "Ensure events are received\n"
                  "Unmap the window.\n"
                  "Ensure events are still received.\n");

    ::Display *dpy = Display();
    Window root = DefaultRootWindow(dpy);
    Window win = CreateWindow(dpy, root);

    XIWarpPointer(dpy, VIRTUAL_CORE_POINTER_ID, None, root, 0, 0, 0, 0, 30, 30);

    PointerBarrier barrier = XFixesCreatePointerBarrier(dpy, win, 20, 20, 20, 40, 0, 0, NULL);
    XSync(dpy, False);

    XIEventMask mask;
    mask.deviceid = XIAllMasterDevices;
    mask.mask_len = XIMaskLen(XI_LASTEVENT);
    mask.mask = reinterpret_cast<unsigned char*>(calloc(mask.mask_len, 1));
    XISetMask(mask.mask, XI_BarrierHit);
    XISelectEvents(dpy, win, &mask, 1);
    free(mask.mask);
    XSync(dpy, False);

    dev->PlayOne(EV_REL, REL_X, -40, True);

    /* Ensure we have a BarrierHit on our hands. */
    XITEvent<XIBarrierEvent> event(dpy, GenericEvent, xi2_opcode, XI_BarrierHit);
    ASSERT_EQ(barrier, event.ev->barrier);
    ASSERT_EQ(20, event.ev->root_x);
    ASSERT_EQ(-40, event.ev->dx);

    XIWarpPointer(dpy, VIRTUAL_CORE_POINTER_ID, None, root, 0, 0, 0, 0, 30, 30);
    XUnmapWindow(dpy, win);
    XSync(dpy, True);

    dev->PlayOne(EV_REL, REL_X, -40, True);

    double x, y;
    QueryPointerPosition(dpy, &x, &y);
    EXPECT_EQ(x, 20);
    EXPECT_EQ(y, 30);

    ASSERT_TRUE(xorg::testing::XServer::WaitForEventOfType(Display(),
                                                           GenericEvent,
                                                           xi2_opcode,
                                                           XI_BarrierHit,
                                                           500));
    XFixesDestroyPointerBarrier(dpy, barrier);
}

TEST_F(BarrierNotify, EventsDuringActiveGrab)
{
    XORG_TESTCASE("Set up a pointer barrier.\n"
                  "Actively grab the pointer.\n"
                  "Move pointer against barrier.\n"
                  "Expect events\n");
    /* variations
       - core, xi2  (xi1 not needed)
       - barrier event masks set in grab mask
       - owner_events true/false
       - grab window == barrier window or other window

       if OE is true and mask is set → event
       if OE is false and mask is set → event
       if OE is true and mask is not set, but set on window → event
       if OE is false and mask is not set, but set on window → no event
     */

    ::Display *dpy = Display();
    Window root = DefaultRootWindow(dpy);

    unsigned char event_mask_bits[XIMaskLen (XI_LASTEVENT)] = { 0 };
    XIEventMask event_mask = { XIAllMasterDevices, sizeof (event_mask_bits), event_mask_bits };
    XISetMask(event_mask_bits, XI_BarrierHit);

    unsigned char no_mask_bits[XIMaskLen (XI_LASTEVENT)] = { 0 };
    XIEventMask no_mask = { XIAllMasterDevices, sizeof (no_mask_bits), no_mask_bits };

    PointerBarrier barrier = XFixesCreatePointerBarrier(dpy, root, 20, 20, 20, 40, 0, 0, NULL);
    XSync(dpy, False);

    /* if OE is true and mask is not set, but set on window → event */
    XIWarpPointer(dpy, VIRTUAL_CORE_POINTER_ID, None, root, 0, 0, 0, 0, 30, 30);
    XISelectEvents(dpy, root, &event_mask, 1);
    XIGrabDevice(dpy, VIRTUAL_CORE_POINTER_ID, root, CurrentTime, None, GrabModeAsync, GrabModeAsync, True, &no_mask);
    dev->PlayOne(EV_REL, REL_X, -40, True);
    ASSERT_TRUE(xorg::testing::XServer::WaitForEventOfType(dpy, GenericEvent, xi2_opcode, XI_BarrierHit, 500));

    /* if OE is false and mask is not set, but set on window → no event */
    XIWarpPointer(dpy, VIRTUAL_CORE_POINTER_ID, None, root, 0, 0, 0, 0, 30, 30);
    XISelectEvents(dpy, root, &event_mask, 1);
    XIGrabDevice(dpy, VIRTUAL_CORE_POINTER_ID, root, CurrentTime, None, GrabModeAsync, GrabModeAsync, False, &no_mask);
    dev->PlayOne(EV_REL, REL_X, -40, True);
    ASSERT_FALSE(xorg::testing::XServer::WaitForEvent(dpy, 500));

    /* if OE is true and mask is set → event */
    XIWarpPointer(dpy, VIRTUAL_CORE_POINTER_ID, None, root, 0, 0, 0, 0, 30, 30);
    XISelectEvents(dpy, root, &no_mask, 1);
    XIGrabDevice(dpy, VIRTUAL_CORE_POINTER_ID, root, CurrentTime, None, GrabModeAsync, GrabModeAsync, True, &event_mask);
    dev->PlayOne(EV_REL, REL_X, -40, True);
    ASSERT_TRUE(xorg::testing::XServer::WaitForEventOfType(dpy, GenericEvent, xi2_opcode, XI_BarrierHit, 500));

    /* if OE is false and mask is set → event */
    XIWarpPointer(dpy, VIRTUAL_CORE_POINTER_ID, None, root, 0, 0, 0, 0, 30, 30);
    XISelectEvents(dpy, root, &no_mask, 1);
    XIGrabDevice(dpy, VIRTUAL_CORE_POINTER_ID, root, CurrentTime, None, GrabModeAsync, GrabModeAsync, False, &event_mask);
    dev->PlayOne(EV_REL, REL_X, -40, True);
    ASSERT_TRUE(xorg::testing::XServer::WaitForEventOfType(dpy, GenericEvent, xi2_opcode, XI_BarrierHit, 500));

    XFixesDestroyPointerBarrier(dpy, barrier);
}

TEST_F(BarrierNotify, EventsDuringPassiveGrab)
{
    XORG_TESTCASE("Set up a pointer barrier.\n"
                  "Trigger a passive pointer grab\n"
                  "Move pointer against barrier.\n"
                  "Expect events\n");
    /* FIXME:
       variations
       - core, xi2  (xi1 not needed) 
       - barrier event masks set in grab mask
       - owner_events true/false
       - grab window == barrier window or other window

       if OE is true and mask is set → event
       if OE is false and mask is set → event
       if OE is true and mask is not set, but set on window → event
       if OE is false and mask is not set, but set on window → no event
     */
}

TEST_F(BarrierNotify, BarrierRandREventsVertical)
{
    XORG_TESTCASE("Set up pointer barrier close to a screen.\n"
                  "Move the pointer against the barrier that the barrier blocks movement\n"
                  "Same movement must be restriced by the RandR dimensions"
                  "Ensure Barrier event root x/y are fully constrained");
#if 0
             +-------------+
             |             |
             |             |
             |             |
             |         a | |
             |          y| |
             +-----------+-+
                        x|
                         |b

     Move a→b will clamp the barrier at X, but we want Y (i.e. including
     RandR clamping)

#endif

    ::Display *dpy = Display();
    XSynchronize(dpy, True);
    Window root = DefaultRootWindow(dpy);
    PointerBarrier barrier;

    XIEventMask mask;
    mask.deviceid = XIAllMasterDevices;
    mask.mask_len = XIMaskLen(XI_LASTEVENT);
    mask.mask = new unsigned char[mask.mask_len]();
    XISetMask(mask.mask, XI_BarrierHit);
    XISetMask(mask.mask, XI_BarrierLeave);
    XISelectEvents(dpy, root, &mask, 1);
    delete[] mask.mask;

    int w = DisplayWidth(dpy, DefaultScreen(dpy));
    int h = DisplayHeight(dpy, DefaultScreen(dpy));

    XIWarpPointer(dpy, VIRTUAL_CORE_POINTER_ID, None, root, 0, 0, 0, 0, w - 40 , h - 30);

    barrier = XFixesCreatePointerBarrier(dpy, root, w - 20, 0, w - 20, 4000, 0, 0, NULL);

    dev->PlayOne(EV_REL, REL_X, 40, false);
    dev->PlayOne(EV_REL, REL_Y, 100, true);

    XITEvent<XIBarrierEvent> event(dpy, GenericEvent, xi2_opcode, XI_BarrierHit);
    ASSERT_EQ(barrier, event.ev->barrier);
    ASSERT_EQ(1, event.ev->event_id);
    ASSERT_EQ(event.ev->root_x, w - 20 - 1);
    ASSERT_LT(event.ev->root_y, h);
}