














		  XTEST Extension Library



			Version 2.2
		   X Consortium Standard






			Kieron Drake
			UniSoft Ltd.











































Copyright (C) 1992 by UniSoft Group Ltd.

Permission to use, copy, modify, and distribute this docu-
mentation 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 representa-
tions about the suitability for any purpose of the informa-
tion in this document.	This documentation is provided ``as
is'' without express or implied warranty.






Copyright (C) 1992, 1994 X Consortium

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documenta-
tion files (the ``Software''), to deal in the Software with-
out 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 fol-
lowing conditions:

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 PUR-
POSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE X CONSOR-
TIUM 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 X Con-
sortium 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.























1.  Overview

This extension is a minimal set of client and server exten-
sions required to completely test the X11 server with no
user intervention.

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, sim-
pler, case.  A more detailed discussion and justification of
the extension functionality is given in [Drake, 91].

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.

We have also tried to:

o    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.

o    Minimize the changes required in the rest of the
     server.

o    Minimize performance penalties on normal server opera-
     tion.


2.  Description

The functions provided by this extension fall into two
groups:

Client Operations
     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 section 7, rou-
     tines are provided to access the internals of two
     opaque data structures --GCs and Visuals-- and to dis-
     card any requests pending within the output buffer of a
     connection.  The exact details can be expected to dif-
     fer for other language bindings.





			      1





		   XTEST Extension Library


Server Requests
     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 follow-
     ing:

     o	  Access to an otherwise "write-only" server
	  resource: the cursor associated with a given win-
	  dow

     o	  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.

3.  C Language Binding

The C functions either provide direct access to the protocol
and add no additional semantics to those defined in section
5 or they correspond directly to the abstract descriptions
of client operations in section 4.

All XTEST extension functions and procedures, and all mani-
fest constants and macros, will start with the string
"XTest".  All operations are classified as server/client
(Server) or client-only (Client).  All routines that have
return type Status will return nonzero for "success" and
zero for "failure."  Even if the XTEST extension is sup-
ported, the server may withdraw such facilities arbitrarily;
in which case they will subsequently return zero.

The include file for this extension is <X11/exten-
sions/XTest.h>.

__
|
Bool
XTestQueryExtension(display, event_base, error_base, major_version, minor_version)
     Display *display;
     int *event_base; /* RETURN */
     int *error_base; /* RETURN */
     int *major_version; /* RETURN */
     int *minor_version; /* RETURN */

|__

XTestQueryExtension returns True if the specified display
supports the XTEST extension, else False.  If the extension
is supported, *event_base would be set to the event number
for the first event for this extension and *error_base would
be set to the error number for the first error for this
extension.  As no errors or events are defined for this



			      2





		   XTEST Extension Library


version of the extension, the values returned here are not
defined (nor useful).  If the extension is supported,
*major_version and *minor_version are set to the major and
minor version numbers of the extension supported by the dis-
play.  Otherwise, none of the arguments are set.


__
|
Bool
XTestCompareCursorWithWindow(display, window, cursor)
     Display *display;
     Window window;
     Cursor cursor;

|__

If the extension is supported, XTestCompareCursorWithWindow
performs a comparison of the cursor whose ID is specified by
cursor (which may be None) with the cursor of the window
specified by window returning True if they are the same and
False otherwise.  If the extension is not supported, then
the request is ignored and zero is returned.


__
|
Bool
XTestCompareCurrentCursorWithWindow(display, window)
     Display *display;
     Window window;

|__

If the extension is supported, XTestCompareCurrentCursor-
WithWindow performs a comparison of the current cursor with
the cursor of the specified window returning True if they
are the same and False otherwise.  If the extension is not
supported, then the request is ignored and zero is returned.


__
|
XTestFakeKeyEvent(display, keycode, is_press, delay)
     Display *display;
     unsigned int keycode;
     Bool is_press;
     unsigned long delay;

|__

If the extension is supported, XTestFakeKeyEvent requests
the server to simulate either a KeyPress (if is_press is
True) or a KeyRelease (if is_press is False) of the key with



			      3





		   XTEST Extension Library


the specified keycode; otherwise, the request is ignored.

If the extension is supported, the simulated event will not
be processed until delay milliseconds after the request is
received (if delay is CurrentTime, then this is interpreted
as no delay at all).  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 com-
pleted.


__
|
XTestFakeButtonEvent(display, button, is_press, delay)
     Display *display;
     unsigned int button;
     Bool is_press;
     unsigned long delay;

|__

If the extension is supported, XTestFakeButtonEvent requests
the server to simulate either a ButtonPress (if is_press is
True) or a ButtonRelease (if is_press is False) of the logi-
cal button numbered by the specified button; otherwise, the
request is ignored.

If the extension is supported, the simulated event will not
be processed until delay milliseconds after the request is
received (if delay is CurrentTime, then this is interpreted
as no delay at all).  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 com-
pleted.


__
|
XTestFakeMotionEvent(display, screen_number, x, y, delay)
     Display *display;
     int screen_number;
     int x y;
     unsigned long delay;

|__

If the extension is supported, XTestFakeMotionEvent requests
the server to simulate a movement of the pointer to the
specified position (x, y) on the root window of screen_num-
ber; otherwise, the request is ignored.  If screen_number is
-1, the current screen (that the pointer is on) is used.

If the extension is supported, the simulated event will not
be processed until delay milliseconds after the request is



			      4





		   XTEST Extension Library


received (if delay is CurrentTime, then this is interpreted
as no delay at all).  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 com-
pleted.


__
|
XTestFakeRelativeMotionEvent(display, screen_number, x, y, delay)
     Display *display;
     int screen_number;
     int x y;
     unsigned long delay;

|__

If the extension is supported, XTestFakeRelativeMotionEvent
requests the server to simulate a movement of the pointer by
the specified offsets (x, y) relative to the current pointer
position on screen_number; otherwise, the request is
ignored.  If screen_number is -1, the current screen (that
the pointer is on) is used.

If the extension is supported, the simulated event will not
be processed until delay milliseconds after the request is
received (if delay is CurrentTime, then this is interpreted
as no delay at all).  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 com-
pleted.


__
|
XTestGrabControl(display, impervious)
     Display *display;
     Bool impervious;

|__

If impervious is True, then the executing client becomes
impervious to server grabs.  If impervious is False, then
the executing client returns to the normal state of being
susceptible to server grabs.












			      5





		   XTEST Extension Library

__
|
Bool
XTestSetGContextOfGC(gc, gid)
     GC gc;
     GContext gid;

|__

XTestSetGContextOfGC sets the GContext within the opaque
datatype referenced by gc to be that specified by gid.


__
|
XTestSetVisualIDOfVisual(visual, visualid)
     Visual *visual;
     VisualID visualid;

|__

XTestSetVisualIDOfVisual sets the VisualID within the opaque
datatype referenced by visual to be that specified by visu-
alid.


__
|
Bool
XTestDiscard(display)
     Display *display;

|__

XTestDiscard discards any requests within the output buffer
for the specified display.  It returns True if any requests
were discarded; otherwise, it returns False.

4.  References

Annicchiarico, D., et al., XTrap: The XTrap Architecture.
     Digital Equipment Corporation, July 1991.

Drake, K. J., Some Proposals for a Minimum X11 Testing
     Extension.  UniSoft Ltd., June 1991.













			      6


