/usr/share/doc/x11proto-xext-dev/xtest.html is in x11proto-xext-dev 7.2.0-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>XTEST Extension Protocol</title><link rel="stylesheet" href="/usr/share/sgml/X11/xorg.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.75.2" /></head><body><div class="book" title="XTEST Extension Protocol"><div class="titlepage"><div><div><h1 class="title"><a id="xtest"></a>XTEST Extension Protocol</h1></div><div><h2 class="subtitle">X Consortium Standard</h2></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Kieron</span> <span class="surname">Drake</span></h3><div class="affiliation"><span class="orgname">UniSoft Ltd.<br /></span></div></div></div></div><div><p class="releaseinfo">Version 2.2</p></div><div><p class="copyright">Copyright © 1992 UniSoft Group Ltd.</p></div><div><p class="copyright">Copyright © 1992,1994 X Consortium</p></div><div><div class="legalnotice" title="Legal Notice"><a id="idp14178984"></a><p>
Permission to use, copy, modify, and distribute this documentation for any
purpose and without fee is hereby granted, provided that the above copyright
notice and this permission notice appear in all copies. UniSoft makes no
representations about the suitability for any purpose of the information in
this document. This documentation is provided "as is" without express or
implied warranty.
</p><p>
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:
</p><p>
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
</p><p>
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
X CONSORTIUM 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.
</p><p>
Except as contained in this notice, the name of the X Consortium 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 X Consortium.
</p></div></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#Overview">1. Overview</a></span></dt><dt><span class="chapter"><a href="#Description">2. Description</a></span></dt><dt><span class="chapter"><a href="#Types">3. Types</a></span></dt><dt><span class="chapter"><a href="#Client_Operations">4. Client Operations</a></span></dt><dt><span class="chapter"><a href="#Server_Requests">5. Server Requests</a></span></dt><dt><span class="chapter"><a href="#Encoding">6. Encoding</a></span></dt><dd><dl><dt><span class="sect1"><a href="#New_Types">New Types</a></span></dt><dt><span class="sect1"><a href="#Requests">Requests</a></span></dt></dl></dd><dt><span class="chapter"><a href="#References">7. References</a></span></dt></dl></div><div class="chapter" title="Chapter 1. Overview"><div class="titlepage"><div><div><h2 class="title"><a id="Overview"></a>Chapter 1. Overview</h2></div></div></div><p>
This extension is a minimal set of client and server extensions
required to completely test the X11 server with no user intervention.
</p><p>
This extension is not intended to support general journaling and
playback of user actions. This is a difficult area [XTrap, 89] as it attempts
to synchronize synthetic user interactions with their effects; it is at the
higher level of dialogue recording/playback rather than at the strictly lexical
level. We are interested only in the latter, simpler, case. A more detailed
discussion and justification of the extension functionality is given in
[Drake, 91].
</p><p>
We are aiming only to provide a minimum set of facilities that
solve immediate testing and validation problems. The testing extension
itself needs testing, where possible, and so should be as simple as possible.
</p><p>
We have also tried to:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
Confine the extension to an appropriate high level within the server
to minimize portability problems. In practice this means that the extension
should be at the DIX level or use the DIX/DDX interface, or both. This
has effects, in particular, on the level at which "input synthesis"
can occur.
</p></li><li class="listitem"><p>
Minimize the changes required in the rest of the server.
</p></li><li class="listitem"><p>
Minimize performance penalties on normal server operation.
</p></li></ul></div></div><div class="chapter" title="Chapter 2. Description"><div class="titlepage"><div><div><h2 class="title"><a id="Description"></a>Chapter 2. Description</h2></div></div></div><p>
The functions provided by this extension fall into two groups:
</p><div class="variablelist"><table border="0"><col align="left" valign="top" /><tbody><tr><td><p><span class="term">Client Operations</span></p></td><td><p>
These routines manipulate otherwise hidden client-side behavior. The
actual implementation will depend on the details of the actual language
binding and what degree of request buffering, GContext caching, and so on, is
provided.
In the C binding, defined in "XTEST Extension Library", routines are
provided to access the internals of two opaque data structures
-- <code class="function">GC</code>s
and
<code class="function">Visual</code>s --
and to discard any requests pending within the
output buffer of a connection. The exact details can be expected to differ for
other language bindings.
</p></td></tr><tr><td><p><span class="term">Server Requests</span></p></td><td><p>
The first of these requests is similar to that provided in most
extensions: it allows a client to specify a major and minor version
number to the server and for the server to respond with major and minor
versions of its own. The remaining two requests allow the following:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
Access to an otherwise "write-only" server resource: the cursor
associated with a given window
</p></li><li class="listitem"><p>
Perhaps most importantly, limited synthesis of input device events,
almost as if a cooperative user had moved the pointing device
or pressed a key or button.
</p></li></ul></div></td></tr></tbody></table></div></div><div class="chapter" title="Chapter 3. Types"><div class="titlepage"><div><div><h2 class="title"><a id="Types"></a>Chapter 3. Types</h2></div></div></div><p>
The following types are used in the request and event definitions in
subsequent sections:
</p><div class="informaltable"><table border="0"><colgroup><col align="left" /><col align="left" /></colgroup><tbody><tr><td colspan="2" align="left">
FAKE_EVENT_TYPE
{ <code class="function">KeyPress</code>,
<code class="function">KeyRelease</code>,
<code class="function">MotionNotify</code>,
<code class="function">ButtonPress</code>,
<code class="function">ButtonRelease</code> }
</td></tr><tr><td align="left"> </td><td class="auto-generated"> </td></tr><tr><td align="left">FAKE_EVENT</td><td align="left">[type: FAKE_EVENT_TYPE,</td></tr><tr><td align="left"> </td><td align="left">detail: BYTE,</td></tr><tr><td align="left"> </td><td align="left">time: TIME,</td></tr><tr><td align="left"> </td><td align="left">root: WINDOW,</td></tr><tr><td align="left"> </td><td align="left">rootX, rootY: INT16]</td></tr></tbody></table></div><p>
CURSOR { <code class="function">CurrentCursor</code>, <code class="function"> None</code> }
or a cursor as defined by the X11 Protocol.
</p></div><div class="chapter" title="Chapter 4. Client Operations"><div class="titlepage"><div><div><h2 class="title"><a id="Client_Operations"></a>Chapter 4. Client Operations</h2></div></div></div><p>
These are abstract definitions of functionality. They refer to client-side
objects such as "GC" and "VISUAL" that are quoted to
denote their abstract nature. Concrete versions of these functions are
defined only for particular language bindings. In some circumstances
a particular language binding may not implement the relevant abstract
type or may provide it as a transparent, rather than opaque, type, with
the result that the corresponding function does not make sense or is
not required, respectively.
</p><p>
<code class="function">XTestSetGContextOfGC</code>
</p><div class="informaltable"><table border="0"><colgroup><col align="left" /></colgroup><tbody><tr><td align="left">
<span class="emphasis"><em>gc</em></span>: "GC"
</td></tr><tr><td align="left">
<span class="emphasis"><em>gid</em></span>: GCONTEXT
</td></tr></tbody></table></div><p>
Sets the GCONTEXT within the "GC" gc to have
the value specified by gid.
</p><p>
<code class="function">XTestSetVisualIDOfVisual</code>
</p><div class="informaltable"><table border="0"><colgroup><col align="left" /></colgroup><tbody><tr><td align="left">
<span class="emphasis"><em>visual</em></span>: "VISUAL"
</td></tr><tr><td align="left">
<span class="emphasis"><em>visualid</em></span>: VISUALID
</td></tr></tbody></table></div><p>
Sets the VISUALID within the "VISUAL" visual to have
the value specified by visualid.
</p><p>
<code class="function">XTestDiscard</code>
</p><div class="informaltable"><table border="0"><colgroup><col align="left" /></colgroup><tbody><tr><td align="left">
<span class="emphasis"><em>dpy</em></span>: "CONNECTION"
</td></tr><tr><td align="left">
=>
</td></tr><tr><td align="left">
status: BOOL
</td></tr></tbody></table></div><p>
Discards any requests that are present in the request buffer associated with
the "CONNECTION" dpy.
The status returned is
<code class="function">True</code>
if there were one or more requests
in the buffer and
<code class="function">False</code>
otherwise.
</p></div><div class="chapter" title="Chapter 5. Server Requests"><div class="titlepage"><div><div><h2 class="title"><a id="Server_Requests"></a>Chapter 5. Server Requests</h2></div></div></div><p>
<code class="function">XTestGetVersion</code>
</p><div class="informaltable"><table border="0"><colgroup><col align="left" /></colgroup><tbody><tr><td align="left">
<span class="emphasis"><em>clientMajorVersion</em></span>: CARD16
</td></tr><tr><td align="left">
<span class="emphasis"><em>clientMinorVersion</em></span>: CARD16
</td></tr><tr><td align="left">
=>
</td></tr><tr><td align="left">
serverMajorVersion: CARD16
</td></tr><tr><td align="left">
serverMinorVersion: CARD16
</td></tr><tr><td align="left">
Errors: <code class="function">Length</code>
</td></tr></tbody></table></div><p>
This request can be used to ensure that the server version of the XTEST
extension is usable by the client. This document defines major version two
(2), minor version one (1).
</p><p>
<code class="function">XTestCompareCursor</code>
</p><div class="informaltable"><table border="0"><colgroup><col align="left" /></colgroup><tbody><tr><td align="left">
<span class="emphasis"><em>window</em></span>: WINDOW
</td></tr><tr><td align="left">
<span class="emphasis"><em>cursor-id</em></span>: CURSOR or
<code class="function">CurrentCursor</code>
or
<code class="function">None</code>
</td></tr><tr><td align="left">
=>
</td></tr><tr><td align="left">
same: BOOL
</td></tr><tr><td align="left">
Errors:
<code class="function">Window</code>,
<code class="function">Length</code>,
<code class="function">Cursor</code>
</td></tr></tbody></table></div><p>
This request looks up the cursor associated with the window and
compares it with either the null cursor if cursor-id is
<code class="function">None ,</code>
or the current cursor (that is, the one being displayed),
or the cursor whose ID is cursor-id, and returns
the result of the comparison in same.
</p><p>
<code class="function">XTestFakeInput</code>
</p><div class="informaltable"><table border="0"><colgroup><col align="left" /></colgroup><tbody><tr><td align="left">
<span class="emphasis"><em>events</em></span>: LISTofFAKE_EVENT
</td></tr><tr><td align="left">
Errors:
<code class="function">Window</code>,
<code class="function">Length</code>,
<code class="function">Alloc</code>,
<code class="function">Value</code>
</td></tr></tbody></table></div><p>
This request simulates the limited set of core protocol
events within the set FAKE_EVENT_TYPE. Only the following event fields,
defined in FAKE_EVENT, are interpreted:
</p><div class="variablelist"><table border="0"><col align="left" valign="top" /><tbody><tr><td><p><span class="term">
<span class="emphasis"><em>type</em></span>
</span></p></td><td><p>
This must be one of
<code class="function">KeyPress</code>,
<code class="function">KeyRelease</code>,
<code class="function">MotionNotify</code>,
<code class="function">ButtonPress</code>,
or
<code class="function">ButtonRelease</code>,
or else a
<code class="function">Value</code>
error occurs.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>detail</em></span>
</span></p></td><td><p>
For key events, this field is interpreted as the physical keycode.
If the keycode is less than min-keycode or greater than max-keycode,
as returned in the connection setup, then a
<code class="function">Value</code>
error occurs.
For button events, this field is interpreted as the physical (or core) button,
meaning it will be mapped to the corresponding logical button according to
the most recent
<code class="function">SetPointerMapping</code>
request.
If the button number is less than one or greater than the number of physical
buttons, then a
<code class="function">Value</code>
error occurs.
For motion events, if this field is
<code class="function">True ,</code>
then rootX and rootY
are relative distances from the current pointer location; if this field is
<code class="function">False,</code>
then they are absolute positions.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>time</em></span>
</span></p></td><td><p>
This is either
<code class="function">CurrentTime</code>
(meaning no delay)
or the delay in milliseconds that the server should wait before
simulating this event. No other requests from this client will be
processed until this delay, if any, has expired and subsequent processing
of the simulated event has been completed.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>root</em></span>
</span></p></td><td><p>
In the case of motion events this field is the ID of the root window on
which the new motion is to take place. If
<code class="function">None</code>
is specified, the root window of the screen the pointer is currently on
is used instead.
If this field is not a valid window, then a
<code class="function">Window</code>
error occurs.
</p></td></tr><tr><td><p><span class="term">
<span class="emphasis"><em>rootX</em></span> &
<span class="emphasis"><em>rootY</em></span>
</span></p></td><td><p>
In the case of motion events these fields indicate relative distance or
absolute pointer coordinates, according to the setting of detail.
If the specified coordinates are off-screen, the closest on-screen
coordinates will be substituted.
</p></td></tr></tbody></table></div><p>
When the simulated event(s) are processed, they cause event propagation,
passive grab activation, and so on, just as if the corresponding input device
action had occurred. However, motion events might not be recorded in the
motion history buffer.
</p><p>
For the currently supported event types, the event list must have length one,
otherwise a
<code class="function">BadLength</code>
error occurs.
</p><p>
<code class="function">XTestGrabControl</code>
</p><div class="informaltable"><table border="0"><colgroup><col align="left" /></colgroup><tbody><tr><td align="left">
<span class="emphasis"><em>impervious</em></span>: BOOL
</td></tr></tbody></table></div><p>
If impervious is
<code class="function">True</code>,
then the executing client becomes impervious to server grabs;
that is, it can continue executing requests even if another client
grabs the server.
If impervious is
<code class="function">False</code>,
then the executing client returns to the normal state of being
susceptible to server grabs.
</p></div><div class="chapter" title="Chapter 6. Encoding"><div class="titlepage"><div><div><h2 class="title"><a id="Encoding"></a>Chapter 6. Encoding</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#New_Types">New Types</a></span></dt><dt><span class="sect1"><a href="#Requests">Requests</a></span></dt></dl></div><p>
Please refer to the X11 Protocol Encoding document as this document uses
conventions established there.
</p><p>
The name of this extension is "XTEST".
</p><div class="sect1" title="New Types"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="New_Types"></a>New Types</h2></div></div></div><pre class="literallayout">
FAKE_EVENT_TYPE
2 KeyPress
3 KeyRelease
4 ButtonPress
5 ButtonRelease
6 MotionNotify
</pre><p>
NOTE that the above values are defined to be the same as those for
the corresponding core protocol event types.
</p></div><div class="sect1" title="Requests"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Requests"></a>Requests</h2></div></div></div><pre class="literallayout">
<code class="function">XTestGetVersion</code>
1 CARD8 opcode
1 0 xtest opcode
2 2 request length
1 CARD8 client major version
1 unused
2 CARD16 client minor version
=>
1 1 Reply
1 CARD8 server major version
2 CARD16 sequence number
4 0 reply length
2 CARD16 server minor version
22 unused
</pre><pre class="literallayout">
<code class="function">XTestCompareCursor</code>
1 CARD8 opcode
1 1 xtest opcode
2 3 request length
4 WINDOW window
4 CURSOR cursor-id
0 None
1 CurrentCursor
=>
1 1 Reply
1 BOOL cursors are the same
2 CARD16 sequence number
4 0 reply length
24 unused
</pre><pre class="literallayout">
<code class="function">XTestFakeInput</code>
1 CARD8 opcode
1 2 xtest opcode
2 1+(1*8) request length
1 FAKE_EVENT_TYPE fake device event type
1 BYTE detail: button or keycode
2 unused
4 TIME delay (milliseconds)
0 CurrentTime
4 WINDOW root window for MotionNotify
0 None
8 unused
2 INT16 x position for MotionNotify
2 INT16 y position for MotionNotify
8 unused
</pre><pre class="literallayout">
<code class="function">XTestGrabControl</code>
1 CARD8 opcode
1 3 xtest opcode
2 2 request length
1 BOOL impervious
3 unused
</pre></div></div><div class="chapter" title="Chapter 7. References"><div class="titlepage"><div><div><h2 class="title"><a id="References"></a>Chapter 7. References</h2></div></div></div><p>
Annicchiarico, D., et al.,
<span class="emphasis"><em>XTrap: The XTrap Architecture</em></span>.
Digital Equipment Corporation, July 1991.
</p><p>
Drake, K. J.,
<span class="emphasis"><em>Some Proposals for a
Minimum X11 Testing Extension</em></span>.
UniSoft Ltd., June 1991.
</p></div></div></body></html>
|