300 lines
11 KiB
C
300 lines
11 KiB
C
/*
|
|
* Copyright © 2009 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 EVENTSTR_H
|
|
#define EVENTSTR_H
|
|
|
|
#include "inputstr.h"
|
|
#include <events.h>
|
|
/**
|
|
* @file events.h
|
|
* This file describes the event structures used internally by the X
|
|
* server during event generation and event processing.
|
|
*
|
|
* When are internal events used?
|
|
* Events from input devices are stored as internal events in the EQ and
|
|
* processed as internal events until late in the processing cycle. Only then
|
|
* do they switch to their respective wire events.
|
|
*/
|
|
|
|
/**
|
|
* Event types. Used exclusively internal to the server, not visible on the
|
|
* protocol.
|
|
*
|
|
* Note: Keep KeyPress to Motion aligned with the core events.
|
|
* Keep ET_Raw* in the same order as KeyPress - Motion
|
|
*/
|
|
enum EventType {
|
|
ET_KeyPress = 2,
|
|
ET_KeyRelease,
|
|
ET_ButtonPress,
|
|
ET_ButtonRelease,
|
|
ET_Motion,
|
|
ET_TouchBegin,
|
|
ET_TouchUpdate,
|
|
ET_TouchEnd,
|
|
ET_TouchOwnership,
|
|
ET_Enter,
|
|
ET_Leave,
|
|
ET_FocusIn,
|
|
ET_FocusOut,
|
|
ET_ProximityIn,
|
|
ET_ProximityOut,
|
|
ET_DeviceChanged,
|
|
ET_Hierarchy,
|
|
ET_DGAEvent,
|
|
ET_RawKeyPress,
|
|
ET_RawKeyRelease,
|
|
ET_RawButtonPress,
|
|
ET_RawButtonRelease,
|
|
ET_RawMotion,
|
|
ET_RawTouchBegin,
|
|
ET_RawTouchUpdate,
|
|
ET_RawTouchEnd,
|
|
ET_XQuartz,
|
|
ET_BarrierHit,
|
|
ET_BarrierLeave,
|
|
ET_Internal = 0xFF /* First byte */
|
|
};
|
|
|
|
/**
|
|
* How a DeviceEvent was provoked
|
|
*/
|
|
enum DeviceEventSource {
|
|
EVENT_SOURCE_NORMAL = 0, /**< Default: from a user action (e.g. key press) */
|
|
EVENT_SOURCE_FOCUS, /**< Keys or buttons previously down on focus-in */
|
|
};
|
|
|
|
/**
|
|
* Used for ALL input device events internal in the server until
|
|
* copied into the matching protocol event.
|
|
*
|
|
* Note: We only use the device id because the DeviceIntPtr may become invalid while
|
|
* the event is in the EQ.
|
|
*/
|
|
struct _DeviceEvent {
|
|
unsigned char header; /**< Always ET_Internal */
|
|
enum EventType type; /**< One of EventType */
|
|
int length; /**< Length in bytes */
|
|
Time time; /**< Time in ms */
|
|
int deviceid; /**< Device to post this event for */
|
|
int sourceid; /**< The physical source device */
|
|
union {
|
|
uint32_t button; /**< Button number (also used in pointer emulating
|
|
touch events) */
|
|
uint32_t key; /**< Key code */
|
|
} detail;
|
|
uint32_t touchid; /**< Touch ID (client_id) */
|
|
int16_t root_x; /**< Pos relative to root window in integral data */
|
|
float root_x_frac; /**< Pos relative to root window in frac part */
|
|
int16_t root_y; /**< Pos relative to root window in integral part */
|
|
float root_y_frac; /**< Pos relative to root window in frac part */
|
|
uint8_t buttons[(MAX_BUTTONS + 7) / 8]; /**< Button mask */
|
|
struct {
|
|
uint8_t mask[(MAX_VALUATORS + 7) / 8];/**< Valuator mask */
|
|
uint8_t mode[(MAX_VALUATORS + 7) / 8];/**< Valuator mode (Abs or Rel)*/
|
|
double data[MAX_VALUATORS]; /**< Valuator data */
|
|
} valuators;
|
|
struct {
|
|
uint32_t base; /**< XKB base modifiers */
|
|
uint32_t latched; /**< XKB latched modifiers */
|
|
uint32_t locked; /**< XKB locked modifiers */
|
|
uint32_t effective;/**< XKB effective modifiers */
|
|
} mods;
|
|
struct {
|
|
uint8_t base; /**< XKB base group */
|
|
uint8_t latched; /**< XKB latched group */
|
|
uint8_t locked; /**< XKB locked group */
|
|
uint8_t effective;/**< XKB effective group */
|
|
} group;
|
|
Window root; /**< Root window of the event */
|
|
int corestate; /**< Core key/button state BEFORE the event */
|
|
int key_repeat; /**< Internally-generated key repeat event */
|
|
uint32_t flags; /**< Flags to be copied into the generated event */
|
|
uint32_t resource; /**< Touch event resource, only for TOUCH_REPLAYING */
|
|
enum DeviceEventSource source_type; /**< How this event was provoked */
|
|
};
|
|
|
|
/**
|
|
* Generated internally whenever a touch ownership chain changes - an owner
|
|
* has accepted or rejected a touch, or a grab/event selection in the delivery
|
|
* chain has been removed.
|
|
*/
|
|
struct _TouchOwnershipEvent {
|
|
unsigned char header; /**< Always ET_Internal */
|
|
enum EventType type; /**< ET_TouchOwnership */
|
|
int length; /**< Length in bytes */
|
|
Time time; /**< Time in ms */
|
|
int deviceid; /**< Device to post this event for */
|
|
int sourceid; /**< The physical source device */
|
|
uint32_t touchid; /**< Touch ID (client_id) */
|
|
uint8_t reason; /**< ::XIAcceptTouch, ::XIRejectTouch */
|
|
uint32_t resource; /**< Provoking grab or event selection */
|
|
uint32_t flags; /**< Flags to be copied into the generated event */
|
|
};
|
|
|
|
/* Flags used in DeviceChangedEvent to signal if the slave has changed */
|
|
#define DEVCHANGE_SLAVE_SWITCH 0x2
|
|
/* Flags used in DeviceChangedEvent to signal whether the event was a
|
|
* pointer event or a keyboard event */
|
|
#define DEVCHANGE_POINTER_EVENT 0x4
|
|
#define DEVCHANGE_KEYBOARD_EVENT 0x8
|
|
/* device capabilities changed */
|
|
#define DEVCHANGE_DEVICE_CHANGE 0x10
|
|
|
|
/**
|
|
* Sent whenever a device's capabilities have changed.
|
|
*/
|
|
struct _DeviceChangedEvent {
|
|
unsigned char header; /**< Always ET_Internal */
|
|
enum EventType type; /**< ET_DeviceChanged */
|
|
int length; /**< Length in bytes */
|
|
Time time; /**< Time in ms */
|
|
int deviceid; /**< Device whose capabilities have changed */
|
|
int flags; /**< Mask of ::HAS_NEW_SLAVE,
|
|
::POINTER_EVENT, ::KEYBOARD_EVENT */
|
|
int masterid; /**< MD when event was generated */
|
|
int sourceid; /**< The device that caused the change */
|
|
|
|
struct {
|
|
int num_buttons; /**< Number of buttons */
|
|
Atom names[MAX_BUTTONS];/**< Button names */
|
|
} buttons;
|
|
|
|
int num_valuators; /**< Number of axes */
|
|
struct {
|
|
uint32_t min; /**< Minimum value */
|
|
uint32_t max; /**< Maximum value */
|
|
double value; /**< Current value */
|
|
/* FIXME: frac parts of min/max */
|
|
uint32_t resolution; /**< Resolution counts/m */
|
|
uint8_t mode; /**< Relative or Absolute */
|
|
Atom name; /**< Axis name */
|
|
ScrollInfo scroll; /**< Smooth scrolling info */
|
|
} valuators[MAX_VALUATORS];
|
|
|
|
struct {
|
|
int min_keycode;
|
|
int max_keycode;
|
|
} keys;
|
|
};
|
|
|
|
#if XFreeXDGA
|
|
/**
|
|
* DGAEvent, used by DGA to intercept and emulate input events.
|
|
*/
|
|
struct _DGAEvent {
|
|
unsigned char header; /**< Always ET_Internal */
|
|
enum EventType type; /**< ET_DGAEvent */
|
|
int length; /**< Length in bytes */
|
|
Time time; /**< Time in ms */
|
|
int subtype; /**< KeyPress, KeyRelease, ButtonPress,
|
|
ButtonRelease, MotionNotify */
|
|
int detail; /**< Button number or key code */
|
|
int dx; /**< Relative x coordinate */
|
|
int dy; /**< Relative y coordinate */
|
|
int screen; /**< Screen number this event applies to */
|
|
uint16_t state; /**< Core modifier/button state */
|
|
};
|
|
#endif
|
|
|
|
/**
|
|
* Raw event, contains the data as posted by the device.
|
|
*/
|
|
struct _RawDeviceEvent {
|
|
unsigned char header; /**< Always ET_Internal */
|
|
enum EventType type; /**< ET_Raw */
|
|
int length; /**< Length in bytes */
|
|
Time time; /**< Time in ms */
|
|
int deviceid; /**< Device to post this event for */
|
|
int sourceid; /**< The physical source device */
|
|
union {
|
|
uint32_t button; /**< Button number */
|
|
uint32_t key; /**< Key code */
|
|
} detail;
|
|
struct {
|
|
uint8_t mask[(MAX_VALUATORS + 7) / 8];/**< Valuator mask */
|
|
double data[MAX_VALUATORS]; /**< Valuator data */
|
|
double data_raw[MAX_VALUATORS]; /**< Valuator data as posted */
|
|
} valuators;
|
|
uint32_t flags; /**< Flags to be copied into the generated event */
|
|
};
|
|
|
|
struct _BarrierEvent {
|
|
unsigned char header; /**< Always ET_Internal */
|
|
enum EventType type; /**< ET_BarrierHit, ET_BarrierLeave */
|
|
int length; /**< Length in bytes */
|
|
Time time; /**< Time in ms */
|
|
int deviceid; /**< Device to post this event for */
|
|
int sourceid; /**< The physical source device */
|
|
int barrierid;
|
|
Window window;
|
|
Window root;
|
|
double dx;
|
|
double dy;
|
|
double root_x;
|
|
double root_y;
|
|
int16_t dt;
|
|
int32_t event_id;
|
|
uint32_t flags;
|
|
};
|
|
|
|
#ifdef XQUARTZ
|
|
#define XQUARTZ_EVENT_MAXARGS 5
|
|
struct _XQuartzEvent {
|
|
unsigned char header; /**< Always ET_Internal */
|
|
enum EventType type; /**< Always ET_XQuartz */
|
|
int length; /**< Length in bytes */
|
|
Time time; /**< Time in ms. */
|
|
int subtype; /**< Subtype defined by XQuartz DDX */
|
|
uint32_t data[XQUARTZ_EVENT_MAXARGS]; /**< Up to 5 32bit values passed to handler */
|
|
};
|
|
#endif
|
|
|
|
/**
|
|
* Event type used inside the X server for input event
|
|
* processing.
|
|
*/
|
|
union _InternalEvent {
|
|
struct {
|
|
unsigned char header; /**< Always ET_Internal */
|
|
enum EventType type; /**< One of ET_* */
|
|
int length; /**< Length in bytes */
|
|
Time time; /**< Time in ms. */
|
|
} any;
|
|
DeviceEvent device_event;
|
|
DeviceChangedEvent changed_event;
|
|
TouchOwnershipEvent touch_ownership_event;
|
|
BarrierEvent barrier_event;
|
|
#if XFreeXDGA
|
|
DGAEvent dga_event;
|
|
#endif
|
|
RawDeviceEvent raw_event;
|
|
#ifdef XQUARTZ
|
|
XQuartzEvent xquartz_event;
|
|
#endif
|
|
};
|
|
|
|
#endif
|