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
|
/*
* Copyright © 2012-2013 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.
*
*/
#ifndef _HELPERS_H_
#define _HELPERS_H_
#include <string>
#include <xorg/gtest/xorg-gtest.h>
#include "xorg-conf.h"
#include "xit-server.h"
#define VIRTUAL_CORE_POINTER_ID 2
#define VIRTUAL_CORE_KEYBOARD_ID 3
/**
* Find the device in the input device list and return the number of
* instances found.
*
* @param [out] deviceid If not NULL, deviceid is set to the id of the
* device. If multiple devices with the same name
* exist, the behaviour is undefined.
*/
int FindInputDeviceByName(Display *dpy, const std::string& device_name, int *deviceid = NULL);
/**
* Initialized XRandR support by selecting appropriate events to be
* notified of RandR related changes.
*
* Returns TRUE if the display support XRandR >= 1.2
*
* @param [out] event_base If not NULL, the value is set to the first event
* code.
* @param [out] error_base If not NULL, the value is set to the first error
* code.
*/
Bool InitRandRSupport (Display *dpy, int *event_base, int *error_base);
/**
* Returns the number of connected monitors
*/
int GetNMonitors (Display *dpy);
/**
* Returns the geometry of the given monitor specified by its number.
*
* @param [out] x If not NULL, the value is set to the X position of the
* monitor.
* @param [out] y If not NULL, the value is set to the Y position of the
* monitor.
* @param [out] width If not NULL, the value is set to the width of the
* monitor.
* @param [out] height If not NULL, the value is set to the height of the
* monitor.
*/
void GetMonitorGeometry (Display *dpy, int monitor, int *x, int *y, int *width, int *height);
/**
* Enable or disable the input device
*
* @param [in] dpy The display connection
* @param [in] deviceid The numerical device ID for this device
* @param [in] enabled true to enable the device, false to disable
*/
void DeviceSetEnabled(Display *dpy, int deviceid, bool enabled);
/**
* Set an error trap. This is designed to be wound tightly
* around an Xlib call that you're expecting an error for:
*
* // Ensure that bad devices raise an error.
* SetErrorTrap(dpy);
* XIQueryDevice(dpy, 0xBAD, &ndevice);
* XErrorEvent *err = ReleaseErrorTrap(dpy);
* ASSERT_EQ(BadDevice, err->code);
*
* Note that if multiple errors come in, the second will
* overwrite the first. These functions are also meant to
* tightly wrap Xlib calls, and don't really do any state, so
* calling SetErrorTrap() twice, and then ReleaseErrorTrap() once
* will remove the error trap entirely.
*
* @param [in] dpy The display to trap errors for.
*/
void SetErrorTrap(Display *dpy);
/**
* Release an error trap. See the documentation of SetErrorTrap()
* for more details.
*
* @param [in] dpy The display to release error trapping for.
*
* @return An XErrorEvent that was trapped.
*/
const XErrorEvent* ReleaseErrorTrap(Display *dpy);
#define ASSERT_ERROR(err, code) \
{ \
const XErrorEvent* e = (err); \
ASSERT_TRUE(e != NULL) << ("Expected " #code); \
ASSERT_EQ(code, (int)e->error_code) << ("Expected " #code); \
}
#define ASSERT_NO_ERROR(err) \
ASSERT_TRUE(err == NULL) << "Expected no error"
/**
* Does not much for normal device IDs, but returns
* XIAllDevices/XIAllMasterDevices where applicable.
*
* @return string representing this deviceID.
*/
std::string DeviceIDToString(int deviceid);
/**
* Returns current root coordinates for the VCP.
*
* @return true if the pointer is on the same screen as the default root
* window, false otherwise
*/
Bool QueryPointerPosition(Display *dpy, double *root_x, double *root_y, int deviceid = VIRTUAL_CORE_POINTER_ID);
/**
* Warps the VCP to the position of the default root window.
*/
void WarpPointer(Display *dpy, int x, int y);
/**
* Create and map a window below the given parent. Default is a full-screen window.
*/
Window CreateWindow(Display *dpy, Window parent = None,
int x = 0, int y = 0,
int width = -1, int height = -1);
/**
* Check if there are any events on the wire and if so, print information
* about the first one.
*
* Typical usage: ASSERT_TRUE(NoEventPending(dpy))
*
* @return true if the event queue is empty, false otherwise
*/
bool NoEventPending(Display *dpy);
/**
* Open the file at path and search it for the substring given. Search is
* per-line and for location of the substring within that line.
*
* @return true if the file at path contains the substring in any line, or
* false otherwise.
*/
bool SearchFileForString(const std::string &path, const std::string &substring);
/**
* Compare two doubles for equality within the given precision.
*
* @return 1, 0, -1 if a is larger, equal, or less than b, respectively
*/
int double_cmp(double a, double b, int precision = 2);
/**
* Select for the list of events given in the varargs. Last element must be
* -1.
*/
void SelectXI2Events(Display *dpy, int deviceid, Window win, ...);
#endif
|
