input.h 31.4 KB
Newer Older
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
/************************************************************

Copyright 1987, 1998  The Open Group

Permission to use, copy, modify, distribute, and sell this software and its
documentation for any purpose is hereby granted without fee, provided that
the above copyright notice appear in all copies and that both that
copyright notice and this permission notice appear in supporting
documentation.

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 PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
OPEN GROUP 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 Open Group 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 Open Group.

Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.

                        All Rights Reserved

29 30
Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted,
31
provided that the above copyright notice appear in all copies and that
32
both that copyright notice and this permission notice appear in
33 34
supporting documentation, and that the name of Digital not be
used in advertising or publicity pertaining to distribution of the
35
software without specific, written prior permission.
36 37 38 39 40 41 42 43 44 45

DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
SOFTWARE.

********************************************************/
Kaleb Keithley's avatar
Kaleb Keithley committed
46

47 48 49
#ifndef INPUT_H
#define INPUT_H

50
#include "misc.h"
51
#include "screenint.h"
52 53
#include <X11/Xmd.h>
#include <X11/Xproto.h>
54
#include <stdint.h>
55
#include "window.h"             /* for WindowPtr */
56
#include "xkbrules.h"
57
#include "events.h"
58
#include "list.h"
59
#include <X11/extensions/XI2.h>
60 61 62 63 64

#define DEVICE_INIT	0
#define DEVICE_ON	1
#define DEVICE_OFF	2
#define DEVICE_CLOSE	3
65
#define DEVICE_ABORT	4
66

67 68 69
#define POINTER_RELATIVE	(1 << 1)
#define POINTER_ABSOLUTE	(1 << 2)
#define POINTER_ACCELERATE	(1 << 3)
70 71 72
#define POINTER_SCREEN		(1 << 4)        /* Data in screen coordinates */
#define POINTER_NORAW		(1 << 5)        /* Don't generate RawEvents */
#define POINTER_EMULATED	(1 << 6)        /* Event was emulated from another event */
73
#define POINTER_DESKTOP		(1 << 7)        /* Data in desktop coordinates */
74

75 76 77 78 79 80 81 82 83
/* GetTouchEvent flags */
#define TOUCH_ACCEPT            (1 << 0)
#define TOUCH_REJECT            (1 << 1)
#define TOUCH_PENDING_END       (1 << 2)
#define TOUCH_CLIENT_ID         (1 << 3)        /* touch ID is the client-visible id */
#define TOUCH_REPLAYING         (1 << 4)        /* event is being replayed */
#define TOUCH_POINTER_EMULATED  (1 << 5)        /* touch event may be pointer emulated */
#define TOUCH_END               (1 << 6)        /* really end this touch now */

84 85 86
/*int constants for pointer acceleration schemes*/
#define PtrAccelNoOp            0
#define PtrAccelPredictable     1
87
#define PtrAccelLightweight     2
88 89
#define PtrAccelDefault         PtrAccelPredictable

90 91 92 93
#define MAX_VALUATORS 36
/* Maximum number of valuators, divided by six, rounded up, to get number
 * of events. */
#define MAX_VALUATOR_EVENTS 6
94
#define MAX_BUTTONS 256         /* completely arbitrarily chosen */
95

96 97
#define NO_AXIS_LIMITS -1

98 99
#define MAP_LENGTH	MAX_BUTTONS
#define DOWN_LENGTH	(MAX_BUTTONS/8)      /* 256/8 => number of bytes to hold 256 bits */
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
#define NullGrab ((GrabPtr)NULL)
#define PointerRootWin ((WindowPtr)PointerRoot)
#define NoneWin ((WindowPtr)None)
#define NullDevice ((DevicePtr)NULL)

#ifndef FollowKeyboard
#define FollowKeyboard 		3
#endif
#ifndef FollowKeyboardWin
#define FollowKeyboardWin  ((WindowPtr) FollowKeyboard)
#endif
#ifndef RevertToFollowKeyboard
#define RevertToFollowKeyboard	3
#endif

115
enum InputLevel {
116 117 118
    CORE = 1,
    XI = 2,
    XI2 = 3,
119 120
};

121 122 123 124
typedef unsigned long Leds;
typedef struct _OtherClients *OtherClientsPtr;
typedef struct _InputClients *InputClientsPtr;
typedef struct _DeviceIntRec *DeviceIntPtr;
125
typedef struct _ValuatorClassRec *ValuatorClassPtr;
126
typedef struct _ClassesRec *ClassesPtr;
127
typedef struct _SpriteRec *SpritePtr;
128 129 130
typedef struct _TouchClassRec *TouchClassPtr;
typedef struct _TouchPointInfo *TouchPointInfoPtr;
typedef struct _DDXTouchPointInfo *DDXTouchPointInfoPtr;
131
typedef union _GrabMask GrabMask;
132

133 134
typedef struct _ValuatorMask ValuatorMask;

135
/* The DIX stores incoming input events in this list */
136
extern InternalEvent *InputEventList;
137

138 139
typedef int (*DeviceProc) (DeviceIntPtr /*device */ ,
                           int /*what */ );
140

141 142
typedef void (*ProcessInputProc) (InternalEvent * /*event */ ,
                                  DeviceIntPtr /*device */ );
143

144 145
typedef Bool (*DeviceHandleProc) (DeviceIntPtr /*device */ ,
                                  void *        /*data */
146 147
    );

148 149 150
typedef void (*DeviceUnwrapProc) (DeviceIntPtr /*device */ ,
                                  DeviceHandleProc /*proc */ ,
                                  void *        /*data */
151 152
    );

153
/* pointer acceleration handling */
154 155 156
typedef void (*PointerAccelSchemeProc) (DeviceIntPtr /*device */ ,
                                        ValuatorMask * /*valuators */ ,
                                        CARD32 /*evtime */ );
157

158
typedef void (*DeviceCallbackProc) (DeviceIntPtr /*pDev */ );
159

Simon Thum's avatar
Simon Thum committed
160
struct _ValuatorAccelerationRec;
161 162 163
typedef Bool (*PointerAccelSchemeInitProc) (DeviceIntPtr /*dev */ ,
                                            struct _ValuatorAccelerationRec *
                                            /*protoScheme */ );
Simon Thum's avatar
Simon Thum committed
164

165
typedef struct _DeviceRec {
166
    void *devicePrivate;
167 168 169 170
    ProcessInputProc processInputProc;  /* current */
    ProcessInputProc realInputProc;     /* deliver */
    ProcessInputProc enqueueInputProc;  /* enqueue */
    Bool on;                    /* used by DDX to keep state */
171 172 173
} DeviceRec, *DevicePtr;

typedef struct {
174 175 176 177 178
    int click, bell, bell_pitch, bell_duration;
    Bool autoRepeat;
    unsigned char autoRepeats[32];
    Leds leds;
    unsigned char id;
179 180 181
} KeybdCtrl;

typedef struct {
182 183 184
    KeySym *map;
    KeyCode minKeyCode, maxKeyCode;
    int mapWidth;
185 186 187
} KeySymsRec, *KeySymsPtr;

typedef struct {
188
    int num, den, threshold;
189 190 191 192
    unsigned char id;
} PtrCtrl;

typedef struct {
193 194
    int resolution, min_value, max_value;
    int integer_displayed;
195 196 197 198
    unsigned char id;
} IntegerCtrl;

typedef struct {
199 200 201 202
    int max_symbols, num_symbols_supported;
    int num_symbols_displayed;
    KeySym *symbols_supported;
    KeySym *symbols_displayed;
203 204 205 206
    unsigned char id;
} StringCtrl;

typedef struct {
207
    int percent, pitch, duration;
208 209 210 211
    unsigned char id;
} BellCtrl;

typedef struct {
212 213
    Leds led_values;
    Mask led_mask;
214 215 216
    unsigned char id;
} LedCtrl;

217 218
extern _X_EXPORT KeybdCtrl defaultKeyboardControl;
extern _X_EXPORT PtrCtrl defaultPointerControl;
219

220
typedef struct _InputOption InputOption;
221
typedef struct _XI2Mask XI2Mask;
222

223
typedef struct _InputAttributes {
224 225 226 227 228 229
    char *product;
    char *vendor;
    char *device;
    char *pnp_id;
    char *usb_id;
    char **tags;                /* null-terminated */
230
    uint32_t flags;
231 232 233 234 235 236 237 238 239
} InputAttributes;

#define ATTR_KEYBOARD (1<<0)
#define ATTR_POINTER (1<<1)
#define ATTR_JOYSTICK (1<<2)
#define ATTR_TABLET (1<<3)
#define ATTR_TOUCHPAD (1<<4)
#define ATTR_TOUCHSCREEN (1<<5)

240
/* Key/Button has been run through all input processing and events sent to clients. */
241
#define KEY_PROCESSED 1
242 243
#define BUTTON_PROCESSED 1
/* Key/Button has not been fully processed, no events have been sent. */
244
#define KEY_POSTED 2
245
#define BUTTON_POSTED 2
246

247 248 249 250 251 252
extern _X_EXPORT void set_key_down(DeviceIntPtr pDev, int key_code, int type);
extern _X_EXPORT void set_key_up(DeviceIntPtr pDev, int key_code, int type);
extern _X_EXPORT int key_is_down(DeviceIntPtr pDev, int key_code, int type);
extern _X_EXPORT void set_button_down(DeviceIntPtr pDev, int button, int type);
extern _X_EXPORT void set_button_up(DeviceIntPtr pDev, int button, int type);
extern _X_EXPORT int button_is_down(DeviceIntPtr pDev, int button, int type);
253

254
extern void InitCoreDevices(void);
255
extern void InitXTestDevices(void);
256

257 258 259
extern _X_EXPORT DeviceIntPtr AddInputDevice(ClientPtr /*client */ ,
                                             DeviceProc /*deviceProc */ ,
                                             Bool /*autoStart */ );
Kaleb Keithley's avatar
Kaleb Keithley committed
260

261 262
extern _X_EXPORT Bool EnableDevice(DeviceIntPtr /*device */ ,
                                   BOOL /* sendevent */ );
263

264 265
extern _X_EXPORT Bool ActivateDevice(DeviceIntPtr /*device */ ,
                                     BOOL /* sendevent */ );
266

267 268
extern _X_EXPORT Bool DisableDevice(DeviceIntPtr /*device */ ,
                                    BOOL /* sendevent */ );
269
extern void DisableAllDevices(void);
270
extern int InitAndStartDevices(void);
271

272
extern void CloseDownDevices(void);
273
extern void AbortDevices(void);
274

275
extern void UndisplayDevices(void);
276

277 278
extern _X_EXPORT int RemoveDevice(DeviceIntPtr /*dev */ ,
                                  BOOL /* sendevent */ );
Kaleb Keithley's avatar
Kaleb Keithley committed
279

280
extern _X_EXPORT int NumMotionEvents(void);
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
extern _X_EXPORT int dixLookupDevice(DeviceIntPtr * /* dev */ ,
                                     int /* id */ ,
                                     ClientPtr /* client */ ,
                                     Mask /* access_mode */ );

extern _X_EXPORT void QueryMinMaxKeyCodes(KeyCode * /*minCode */ ,
                                          KeyCode * /*maxCode */ );

extern _X_EXPORT Bool InitButtonClassDeviceStruct(DeviceIntPtr /*device */ ,
                                                  int /*numButtons */ ,
                                                  Atom * /* labels */ ,
                                                  CARD8 * /*map */ );

extern _X_INTERNAL ValuatorClassPtr AllocValuatorClass(ValuatorClassPtr src,
                                                       int numAxes);

extern _X_EXPORT Bool InitValuatorClassDeviceStruct(DeviceIntPtr /*device */ ,
                                                    int /*numAxes */ ,
                                                    Atom * /* labels */ ,
                                                    int /*numMotionEvents */ ,
                                                    int /*mode */ );

extern _X_EXPORT Bool InitPointerAccelerationScheme(DeviceIntPtr /*dev */ ,
                                                    int /*scheme */ );

extern _X_EXPORT Bool InitFocusClassDeviceStruct(DeviceIntPtr /*device */ );

extern _X_EXPORT Bool InitTouchClassDeviceStruct(DeviceIntPtr /*device */ ,
                                                 unsigned int /*max_touches */ ,
                                                 unsigned int /*mode */ ,
                                                 unsigned int /*numAxes */ );

314 315 316 317
typedef void (*BellProcPtr) (int percent,
                             DeviceIntPtr device,
                             void *ctrl,
                             int feedbackClass);
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

typedef void (*KbdCtrlProcPtr) (DeviceIntPtr /*device */ ,
                                KeybdCtrl * /*ctrl */ );

typedef void (*PtrCtrlProcPtr) (DeviceIntPtr /*device */ ,
                                PtrCtrl * /*ctrl */ );

extern _X_EXPORT Bool InitPtrFeedbackClassDeviceStruct(DeviceIntPtr /*device */
                                                       ,
                                                       PtrCtrlProcPtr
                                                       /*controlProc */ );

typedef void (*StringCtrlProcPtr) (DeviceIntPtr /*device */ ,
                                   StringCtrl * /*ctrl */ );

extern _X_EXPORT Bool InitStringFeedbackClassDeviceStruct(DeviceIntPtr
                                                          /*device */ ,
                                                          StringCtrlProcPtr
                                                          /*controlProc */ ,
                                                          int /*max_symbols */ ,
                                                          int
                                                          /*num_symbols_supported */
                                                          ,
                                                          KeySym * /*symbols */
                                                          );

typedef void (*BellCtrlProcPtr) (DeviceIntPtr /*device */ ,
                                 BellCtrl * /*ctrl */ );

extern _X_EXPORT Bool InitBellFeedbackClassDeviceStruct(DeviceIntPtr /*device */
                                                        ,
                                                        BellProcPtr
                                                        /*bellProc */ ,
                                                        BellCtrlProcPtr
                                                        /*controlProc */ );

typedef void (*LedCtrlProcPtr) (DeviceIntPtr /*device */ ,
                                LedCtrl * /*ctrl */ );

extern _X_EXPORT Bool InitLedFeedbackClassDeviceStruct(DeviceIntPtr /*device */
                                                       ,
                                                       LedCtrlProcPtr
                                                       /*controlProc */ );

typedef void (*IntegerCtrlProcPtr) (DeviceIntPtr /*device */ ,
                                    IntegerCtrl * /*ctrl */ );

extern _X_EXPORT Bool InitIntegerFeedbackClassDeviceStruct(DeviceIntPtr
                                                           /*device */ ,
                                                           IntegerCtrlProcPtr
                                                           /*controlProc */ );

extern _X_EXPORT Bool InitPointerDeviceStruct(DevicePtr /*device */ ,
                                              CARD8 * /*map */ ,
                                              int /*numButtons */ ,
                                              Atom * /* btn_labels */ ,
                                              PtrCtrlProcPtr /*controlProc */ ,
                                              int /*numMotionEvents */ ,
                                              int /*numAxes */ ,
                                              Atom * /* axes_labels */ );

extern _X_EXPORT Bool InitKeyboardDeviceStruct(DeviceIntPtr /*device */ ,
                                               XkbRMLVOSet * /*rmlvo */ ,
                                               BellProcPtr /*bellProc */ ,
                                               KbdCtrlProcPtr /*controlProc */
                                               );

385 386 387 388 389 390
extern _X_EXPORT Bool InitKeyboardDeviceStructFromString(DeviceIntPtr dev,
							 const char *keymap,
							 int keymap_length,
							 BellProcPtr bell_func,
							 KbdCtrlProcPtr ctrl_func);

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
extern int ApplyPointerMapping(DeviceIntPtr /* pDev */ ,
                               CARD8 * /* map */ ,
                               int /* len */ ,
                               ClientPtr /* client */ );

extern Bool BadDeviceMap(BYTE * /*buff */ ,
                         int /*length */ ,
                         unsigned /*low */ ,
                         unsigned /*high */ ,
                         XID * /*errval */ );

extern void NoteLedState(DeviceIntPtr /*keybd */ ,
                         int /*led */ ,
                         Bool /*on */ );

extern void MaybeStopHint(DeviceIntPtr /*device */ ,
                          ClientPtr /*client */ );

extern void ProcessPointerEvent(InternalEvent * /* ev */ ,
                                DeviceIntPtr /*mouse */ );

extern void ProcessKeyboardEvent(InternalEvent * /*ev */ ,
                                 DeviceIntPtr /*keybd */ );

extern Bool LegalModifier(unsigned int /*key */ ,
                          DeviceIntPtr /*pDev */ );
417

418
extern _X_EXPORT void ProcessInputEvents(void);
419

420 421
extern _X_EXPORT void InitInput(int /*argc */ ,
                                char ** /*argv */ );
422
extern _X_EXPORT void CloseInput(void);
423

424
extern _X_EXPORT int GetMaximumEventsNum(void);
425

426 427
extern _X_EXPORT InternalEvent *InitEventList(int num_events);
extern _X_EXPORT void FreeEventList(InternalEvent *list, int num_events);
428

429
extern void CreateClassesChangedEvent(InternalEvent *event,
430
                                      DeviceIntPtr master,
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
                                      DeviceIntPtr slave, int flags);

extern InternalEvent *UpdateFromMaster(InternalEvent *events,
                                       DeviceIntPtr pDev,
                                       int type, int *num_events);

extern _X_EXPORT int GetPointerEvents(InternalEvent *events,
                                      DeviceIntPtr pDev,
                                      int type,
                                      int buttons,
                                      int flags, const ValuatorMask *mask);

extern _X_EXPORT void QueuePointerEvents(DeviceIntPtr pDev,
                                         int type,
                                         int buttons,
                                         int flags, const ValuatorMask *mask);

extern _X_EXPORT int GetKeyboardEvents(InternalEvent *events,
                                       DeviceIntPtr pDev,
                                       int type,
451
                                       int key_code);
452 453 454

extern _X_EXPORT void QueueKeyboardEvents(DeviceIntPtr pDev,
                                          int type,
455
                                          int key_code);
456 457 458 459 460 461

extern int GetTouchEvents(InternalEvent *events,
                          DeviceIntPtr pDev,
                          uint32_t ddx_touchid,
                          uint16_t type,
                          uint32_t flags, const ValuatorMask *mask);
462 463 464 465

void QueueTouchEvents(DeviceIntPtr device,
                      int type,
                      uint32_t ddx_touchid,
466 467 468 469 470 471
                      int flags, const ValuatorMask *mask);

extern int GetTouchOwnershipEvents(InternalEvent *events,
                                   DeviceIntPtr pDev,
                                   TouchPointInfoPtr ti,
                                   uint8_t mode, XID resource, uint32_t flags);
472 473 474 475 476

extern void GetDixTouchEnd(InternalEvent *ievent,
                           DeviceIntPtr dev,
                           TouchPointInfoPtr ti,
                           uint32_t flags);
477 478 479 480 481 482 483 484

extern _X_EXPORT int GetProximityEvents(InternalEvent *events,
                                        DeviceIntPtr pDev,
                                        int type, const ValuatorMask *mask);

extern _X_EXPORT void QueueProximityEvents(DeviceIntPtr pDev,
                                           int type, const ValuatorMask *mask);

485 486 487
#ifdef PANORAMIX
_X_EXPORT
#endif
488 489 490 491 492 493 494 495 496 497 498 499
extern void PostSyntheticMotion(DeviceIntPtr pDev,
                                int x, int y, int screen, unsigned long time);

extern _X_EXPORT int GetMotionHistorySize(void);

extern _X_EXPORT void AllocateMotionHistory(DeviceIntPtr pDev);

extern _X_EXPORT int GetMotionHistory(DeviceIntPtr pDev,
                                      xTimecoord ** buff,
                                      unsigned long start,
                                      unsigned long stop,
                                      ScreenPtr pScreen, BOOL core);
500

501 502
extern void ReleaseButtonsAndKeys(DeviceIntPtr dev);

503
extern int AttachDevice(ClientPtr client,
504
                        DeviceIntPtr slave, DeviceIntPtr master);
505

506
extern _X_EXPORT DeviceIntPtr GetPairedDevice(DeviceIntPtr kbd);
507
extern _X_EXPORT DeviceIntPtr GetMaster(DeviceIntPtr dev, int type);
508

509
extern _X_EXPORT int AllocDevicePair(ClientPtr client,
510 511 512 513 514
                                     const char *name,
                                     DeviceIntPtr *ptr,
                                     DeviceIntPtr *keybd,
                                     DeviceProc ptr_proc,
                                     DeviceProc keybd_proc, Bool master);
515
extern void DeepCopyDeviceClasses(DeviceIntPtr from,
516
                                  DeviceIntPtr to, DeviceChangedEvent *dce);
517

518
/* Helper functions. */
519
extern _X_EXPORT int generate_modkeymap(ClientPtr client, DeviceIntPtr dev,
520 521
                                        KeyCode **modkeymap,
                                        int *max_keys_per_mod);
522 523
extern int change_modmap(ClientPtr client, DeviceIntPtr dev, KeyCode *map,
                         int max_keys_per_mod);
524 525 526
extern int AllocXTestDevice(ClientPtr client, const char *name,
                            DeviceIntPtr *ptr, DeviceIntPtr *keybd,
                            DeviceIntPtr master_ptr, DeviceIntPtr master_keybd);
527 528
extern BOOL IsXTestDevice(DeviceIntPtr dev, DeviceIntPtr master);
extern DeviceIntPtr GetXTestDevice(DeviceIntPtr master);
529
extern void SendDevicePresenceEvent(int deviceid, int type);
530 531 532
extern _X_EXPORT InputAttributes *DuplicateInputAttributes(InputAttributes *
                                                           attrs);
extern _X_EXPORT void FreeInputAttributes(InputAttributes * attrs);
533

534
enum TouchListenerState {
535 536
    LISTENER_AWAITING_BEGIN = 0,   /**< Waiting for a TouchBegin event */
    LISTENER_AWAITING_OWNER,       /**< Waiting for a TouchOwnership event */
537 538
    LISTENER_EARLY_ACCEPT,         /**< Waiting for ownership, has already
                                        accepted */
539 540
    LISTENER_IS_OWNER,             /**< Is the current owner, hasn't accepted */
    LISTENER_HAS_ACCEPTED,         /**< Is the current owner, has accepted */
541 542 543 544 545 546 547 548 549 550
    LISTENER_HAS_END,              /**< Has already received the end event */
};

enum TouchListenerType {
    LISTENER_GRAB,
    LISTENER_POINTER_GRAB,
    LISTENER_REGULAR,
    LISTENER_POINTER_REGULAR,
};

551 552 553 554
extern void TouchInitDDXTouchPoint(DeviceIntPtr dev,
                                   DDXTouchPointInfoPtr ddxtouch);
extern DDXTouchPointInfoPtr TouchBeginDDXTouch(DeviceIntPtr dev,
                                               uint32_t ddx_id);
555 556
extern void TouchEndDDXTouch(DeviceIntPtr dev, DDXTouchPointInfoPtr ti);
extern DDXTouchPointInfoPtr TouchFindByDDXID(DeviceIntPtr dev,
557 558 559
                                             uint32_t ddx_id, Bool create);
extern Bool TouchInitTouchPoint(TouchClassPtr touch, ValuatorClassPtr v,
                                int index);
560
extern void TouchFreeTouchPoint(DeviceIntPtr dev, int index);
561
extern TouchPointInfoPtr TouchBeginTouch(DeviceIntPtr dev, int sourceid,
562 563
                                         uint32_t touchid,
                                         Bool emulate_pointer);
564 565 566
extern TouchPointInfoPtr TouchFindByClientID(DeviceIntPtr dev,
                                             uint32_t client_id);
extern void TouchEndTouch(DeviceIntPtr dev, TouchPointInfoPtr ti);
567 568 569
extern Bool TouchEventHistoryAllocate(TouchPointInfoPtr ti);
extern void TouchEventHistoryFree(TouchPointInfoPtr ti);
extern void TouchEventHistoryPush(TouchPointInfoPtr ti, const DeviceEvent *ev);
570 571
extern void TouchEventHistoryReplay(TouchPointInfoPtr ti, DeviceIntPtr dev,
                                    XID resource);
572
extern Bool TouchResourceIsOwner(TouchPointInfoPtr ti, XID resource);
573
extern void TouchAddListener(TouchPointInfoPtr ti, XID resource, int resource_type,
574
                             enum InputLevel level, enum TouchListenerType type,
575
                             enum TouchListenerState state, WindowPtr window, GrabPtr grab);
576
extern Bool TouchRemoveListener(TouchPointInfoPtr ti, XID resource);
577 578
extern void TouchSetupListeners(DeviceIntPtr dev, TouchPointInfoPtr ti,
                                InternalEvent *ev);
579 580
extern Bool TouchBuildSprite(DeviceIntPtr sourcedev, TouchPointInfoPtr ti,
                             InternalEvent *ev);
581
extern Bool TouchBuildDependentSpriteTrace(DeviceIntPtr dev, SpritePtr sprite);
582
extern int TouchConvertToPointerEvent(const InternalEvent *ev,
583 584
                                      InternalEvent *motion,
                                      InternalEvent *button);
585
extern int TouchGetPointerEventType(const InternalEvent *ev);
586
extern void TouchRemovePointerGrab(DeviceIntPtr dev);
587
extern void TouchListenerGone(XID resource);
588 589
extern int TouchListenerAcceptReject(DeviceIntPtr dev, TouchPointInfoPtr ti,
                                     int listener, int mode);
590
extern int TouchAcceptReject(ClientPtr client, DeviceIntPtr dev, int mode,
591
                             uint32_t touchid, Window grab_window, XID *error);
592
extern void TouchEndPhysicallyActiveTouches(DeviceIntPtr dev);
593 594
extern void TouchDeliverDeviceClassesChangedEvent(TouchPointInfoPtr ti,
                                                  Time time, XID resource);
595
extern void TouchEmitTouchEnd(DeviceIntPtr dev, TouchPointInfoPtr ti, int flags, XID resource);
596
extern void TouchAcceptAndEnd(DeviceIntPtr dev, int touchid);
597

598
/* misc event helpers */
599
extern Mask GetEventMask(DeviceIntPtr dev, xEvent *ev, InputClientsPtr clients);
600
extern Mask GetEventFilter(DeviceIntPtr dev, xEvent *event);
601
extern Bool WindowXI2MaskIsset(DeviceIntPtr dev, WindowPtr win, xEvent *ev);
602
extern int GetXI2MaskByte(XI2Mask *mask, DeviceIntPtr dev, int event_type);
603
void FixUpEventFromWindow(SpritePtr pSprite,
604
                          xEvent *xE,
605
                          WindowPtr pWin, Window child, Bool calcChild);
606
extern Bool PointInBorderSize(WindowPtr pWin, int x, int y);
607
extern WindowPtr XYToWindow(SpritePtr pSprite, int x, int y);
608
extern int EventIsDeliverable(DeviceIntPtr dev, int evtype, WindowPtr win);
609
extern Bool ActivatePassiveGrab(DeviceIntPtr dev, GrabPtr grab,
610
                                InternalEvent *ev, InternalEvent *real_event);
611
/**
612 613
 * Masks specifying the type of event to deliver for an InternalEvent; used
 * by EventIsDeliverable.
614 615 616
 * @defgroup EventIsDeliverable return flags
 * @{
 */
617 618 619 620
#define EVENT_XI1_MASK                (1 << 0) /**< XI1.x event */
#define EVENT_CORE_MASK               (1 << 1) /**< Core event */
#define EVENT_DONT_PROPAGATE_MASK     (1 << 2) /**< DontPropagate mask set */
#define EVENT_XI2_MASK                (1 << 3) /**< XI2 mask set on window */
621
/* @} */
622

623 624 625 626 627 628 629
enum EventDeliveryState {
    EVENT_DELIVERED,     /**< Event has been delivered to a client  */
    EVENT_NOT_DELIVERED, /**< Event was not delivered to any client */
    EVENT_SKIP,          /**< Event can be discarded by the caller  */
    EVENT_REJECTED,      /**< Event was rejected for delivery to the client */
};

630
/* Implemented by the DDX. */
631 632 633 634 635 636
extern _X_EXPORT int NewInputDeviceRequest(InputOption *options,
                                           InputAttributes * attrs,
                                           DeviceIntPtr *dev);
extern _X_EXPORT void DeleteInputDeviceRequest(DeviceIntPtr dev);

extern _X_EXPORT void DDXRingBell(int volume, int pitch, int duration);
637

638 639 640 641
#define VALUATOR_MODE_ALL_AXES -1
extern _X_HIDDEN int valuator_get_mode(DeviceIntPtr dev, int axis);
extern _X_HIDDEN void valuator_set_mode(DeviceIntPtr dev, int axis, int mode);

642 643 644 645
/* Set to TRUE by default - os/utils.c sets it to FALSE on user request,
   xfixes/cursor.c uses it to determine if the cursor is enabled */
extern Bool EnableCursor;

646 647 648 649 650
/* Set to FALSE by default - ChangeWindowAttributes sets it to TRUE on
 * CWCursor, xfixes/cursor.c uses it to determine if the cursor is enabled
 */
extern Bool CursorVisible;

651
extern _X_EXPORT ValuatorMask *valuator_mask_new(int num_valuators);
652
extern _X_EXPORT void valuator_mask_free(ValuatorMask **mask);
653
extern _X_EXPORT void valuator_mask_set_range(ValuatorMask *mask,
654 655 656 657
                                              int first_valuator,
                                              int num_valuators,
                                              const int *valuators);
extern _X_EXPORT void valuator_mask_set(ValuatorMask *mask, int valuator,
658
                                        int data);
659
extern _X_EXPORT void valuator_mask_set_double(ValuatorMask *mask, int valuator,
660
                                               double data);
661
extern _X_EXPORT void valuator_mask_zero(ValuatorMask *mask);
662 663 664 665 666 667 668
extern _X_EXPORT int valuator_mask_size(const ValuatorMask *mask);
extern _X_EXPORT int valuator_mask_isset(const ValuatorMask *mask, int bit);
extern _X_EXPORT void valuator_mask_unset(ValuatorMask *mask, int bit);
extern _X_EXPORT int valuator_mask_num_valuators(const ValuatorMask *mask);
extern _X_EXPORT void valuator_mask_copy(ValuatorMask *dest,
                                         const ValuatorMask *src);
extern _X_EXPORT int valuator_mask_get(const ValuatorMask *mask, int valnum);
669 670
extern _X_EXPORT double valuator_mask_get_double(const ValuatorMask *mask,
                                                 int valnum);
671 672 673 674
extern _X_EXPORT Bool valuator_mask_fetch(const ValuatorMask *mask,
                                          int valnum, int *val);
extern _X_EXPORT Bool valuator_mask_fetch_double(const ValuatorMask *mask,
                                                 int valnum, double *val);
675

676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
extern _X_EXPORT Bool valuator_mask_has_unaccelerated(const ValuatorMask *mask);
extern _X_EXPORT void valuator_mask_set_unaccelerated(ValuatorMask *mask,
                                                      int valuator,
                                                      double accel,
                                                      double unaccel);
extern _X_EXPORT double valuator_mask_get_accelerated(const ValuatorMask *mask,
                                                      int valuator);
extern _X_EXPORT double valuator_mask_get_unaccelerated(const ValuatorMask *mask,
                                                        int valuator);
extern _X_EXPORT Bool valuator_mask_fetch_unaccelerated(const ValuatorMask *mask,
                                                        int valuator,
                                                        double *accel,
                                                        double *unaccel);
extern _X_HIDDEN void valuator_mask_drop_unaccelerated(ValuatorMask *mask);

691
/* InputOption handling interface */
692 693 694
extern _X_EXPORT InputOption *input_option_new(InputOption *list,
                                               const char *key,
                                               const char *value);
695
extern _X_EXPORT void input_option_free_list(InputOption **opt);
696 697 698 699 700 701 702 703 704
extern _X_EXPORT InputOption *input_option_free_element(InputOption *opt,
                                                        const char *key);
extern _X_EXPORT InputOption *input_option_find(InputOption *list,
                                                const char *key);
extern _X_EXPORT const char *input_option_get_key(const InputOption *opt);
extern _X_EXPORT const char *input_option_get_value(const InputOption *opt);
extern _X_EXPORT void input_option_set_key(InputOption *opt, const char *key);
extern _X_EXPORT void input_option_set_value(InputOption *opt,
                                             const char *value);
705

706
extern _X_HIDDEN Bool point_on_screen(ScreenPtr pScreen, int x, int y);
707
extern _X_HIDDEN void update_desktop_dimensions(void);
708

709 710 711
extern _X_HIDDEN void input_constrain_cursor(DeviceIntPtr pDev, ScreenPtr screen,
                                             int current_x, int current_y,
                                             int dest_x, int dest_y,
712 713
                                             int *out_x, int *out_y,
                                             int *nevents, InternalEvent* events);
714

715
#endif                          /* INPUT_H */