libinput.h

Go to the documentation of this file.

/*
 * Copyright © 2013 Jonas Ådahl
 * Copyright © 2013-2015 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 LIBINPUT_H
#define LIBINPUT_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdlib.h>
#include <stdint.h>
#include <libudev.h>

#define LIBINPUT_ATTRIBUTE_PRINTF(_format, _args) \
        __attribute__ ((format (printf, _format, _args)))
#define LIBINPUT_ATTRIBUTE_DEPRECATED __attribute__ ((deprecated))

enum libinput_log_priority {
        LIBINPUT_LOG_PRIORITY_DEBUG = 10,
        LIBINPUT_LOG_PRIORITY_INFO = 20,
        LIBINPUT_LOG_PRIORITY_ERROR = 30,
};

enum libinput_device_capability {
        LIBINPUT_DEVICE_CAP_KEYBOARD = 0,
        LIBINPUT_DEVICE_CAP_POINTER = 1,
        LIBINPUT_DEVICE_CAP_TOUCH = 2,
        LIBINPUT_DEVICE_CAP_GESTURE = 5,
};

enum libinput_key_state {
        LIBINPUT_KEY_STATE_RELEASED = 0,
        LIBINPUT_KEY_STATE_PRESSED = 1
};

enum libinput_led {
        LIBINPUT_LED_NUM_LOCK = (1 << 0),
        LIBINPUT_LED_CAPS_LOCK = (1 << 1),
        LIBINPUT_LED_SCROLL_LOCK = (1 << 2)
};

enum libinput_button_state {
        LIBINPUT_BUTTON_STATE_RELEASED = 0,
        LIBINPUT_BUTTON_STATE_PRESSED = 1
};

enum libinput_pointer_axis {
        LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL = 0,
        LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL = 1,
};

enum libinput_pointer_axis_source {
        LIBINPUT_POINTER_AXIS_SOURCE_WHEEL = 1,
        LIBINPUT_POINTER_AXIS_SOURCE_FINGER,
        LIBINPUT_POINTER_AXIS_SOURCE_CONTINUOUS,
};

enum libinput_event_type {
        LIBINPUT_EVENT_NONE = 0,

        LIBINPUT_EVENT_DEVICE_ADDED,

        LIBINPUT_EVENT_DEVICE_REMOVED,

        LIBINPUT_EVENT_KEYBOARD_KEY = 300,

        LIBINPUT_EVENT_POINTER_MOTION = 400,
        LIBINPUT_EVENT_POINTER_MOTION_ABSOLUTE,
        LIBINPUT_EVENT_POINTER_BUTTON,
        LIBINPUT_EVENT_POINTER_AXIS,

        LIBINPUT_EVENT_TOUCH_DOWN = 500,
        LIBINPUT_EVENT_TOUCH_UP,
        LIBINPUT_EVENT_TOUCH_MOTION,
        LIBINPUT_EVENT_TOUCH_CANCEL,
        LIBINPUT_EVENT_TOUCH_FRAME,

        LIBINPUT_EVENT_GESTURE_SWIPE_BEGIN = 800,
        LIBINPUT_EVENT_GESTURE_SWIPE_UPDATE,
        LIBINPUT_EVENT_GESTURE_SWIPE_END,
        LIBINPUT_EVENT_GESTURE_PINCH_BEGIN,
        LIBINPUT_EVENT_GESTURE_PINCH_UPDATE,
        LIBINPUT_EVENT_GESTURE_PINCH_END,
};

struct libinput;

struct libinput_device;

struct libinput_device_group;

struct libinput_seat;

struct libinput_event;

struct libinput_event_device_notify;

struct libinput_event_keyboard;

struct libinput_event_pointer;

struct libinput_event_touch;

void
libinput_event_destroy(struct libinput_event *event);

enum libinput_event_type
libinput_event_get_type(struct libinput_event *event);

struct libinput *
libinput_event_get_context(struct libinput_event *event);

struct libinput_device *
libinput_event_get_device(struct libinput_event *event);

struct libinput_event_pointer *
libinput_event_get_pointer_event(struct libinput_event *event);

struct libinput_event_keyboard *
libinput_event_get_keyboard_event(struct libinput_event *event);

struct libinput_event_touch *
libinput_event_get_touch_event(struct libinput_event *event);

struct libinput_event_gesture *
libinput_event_get_gesture_event(struct libinput_event *event);

struct libinput_event_device_notify *
libinput_event_get_device_notify_event(struct libinput_event *event);

struct libinput_event *
libinput_event_device_notify_get_base_event(struct libinput_event_device_notify *event);

uint32_t
libinput_event_keyboard_get_time(struct libinput_event_keyboard *event);

uint64_t
libinput_event_keyboard_get_time_usec(struct libinput_event_keyboard *event);

uint32_t
libinput_event_keyboard_get_key(struct libinput_event_keyboard *event);

enum libinput_key_state
libinput_event_keyboard_get_key_state(struct libinput_event_keyboard *event);

struct libinput_event *
libinput_event_keyboard_get_base_event(struct libinput_event_keyboard *event);

uint32_t
libinput_event_keyboard_get_seat_key_count(
        struct libinput_event_keyboard *event);

uint32_t
libinput_event_pointer_get_time(struct libinput_event_pointer *event);

uint64_t
libinput_event_pointer_get_time_usec(struct libinput_event_pointer *event);

double
libinput_event_pointer_get_dx(struct libinput_event_pointer *event);

double
libinput_event_pointer_get_dy(struct libinput_event_pointer *event);

double
libinput_event_pointer_get_dx_unaccelerated(
        struct libinput_event_pointer *event);

double
libinput_event_pointer_get_dy_unaccelerated(
        struct libinput_event_pointer *event);

double
libinput_event_pointer_get_absolute_x(struct libinput_event_pointer *event);

double
libinput_event_pointer_get_absolute_y(struct libinput_event_pointer *event);

double
libinput_event_pointer_get_absolute_x_transformed(
        struct libinput_event_pointer *event,
        uint32_t width);

double
libinput_event_pointer_get_absolute_y_transformed(
        struct libinput_event_pointer *event,
        uint32_t height);

uint32_t
libinput_event_pointer_get_button(struct libinput_event_pointer *event);

enum libinput_button_state
libinput_event_pointer_get_button_state(struct libinput_event_pointer *event);

uint32_t
libinput_event_pointer_get_seat_button_count(
        struct libinput_event_pointer *event);

int
libinput_event_pointer_has_axis(struct libinput_event_pointer *event,
                                enum libinput_pointer_axis axis);

double
libinput_event_pointer_get_axis_value(struct libinput_event_pointer *event,
                                      enum libinput_pointer_axis axis);

enum libinput_pointer_axis_source
libinput_event_pointer_get_axis_source(struct libinput_event_pointer *event);

double
libinput_event_pointer_get_axis_value_discrete(struct libinput_event_pointer *event,
                                               enum libinput_pointer_axis axis);

struct libinput_event *
libinput_event_pointer_get_base_event(struct libinput_event_pointer *event);

uint32_t
libinput_event_touch_get_time(struct libinput_event_touch *event);

uint64_t
libinput_event_touch_get_time_usec(struct libinput_event_touch *event);

int32_t
libinput_event_touch_get_slot(struct libinput_event_touch *event);

int32_t
libinput_event_touch_get_seat_slot(struct libinput_event_touch *event);

double
libinput_event_touch_get_x(struct libinput_event_touch *event);

double
libinput_event_touch_get_y(struct libinput_event_touch *event);

double
libinput_event_touch_get_x_transformed(struct libinput_event_touch *event,
                                       uint32_t width);

double
libinput_event_touch_get_y_transformed(struct libinput_event_touch *event,
                                       uint32_t height);

struct libinput_event *
libinput_event_touch_get_base_event(struct libinput_event_touch *event);

uint32_t
libinput_event_gesture_get_time(struct libinput_event_gesture *event);

uint64_t
libinput_event_gesture_get_time_usec(struct libinput_event_gesture *event);

struct libinput_event *
libinput_event_gesture_get_base_event(struct libinput_event_gesture *event);

int
libinput_event_gesture_get_finger_count(struct libinput_event_gesture *event);

int
libinput_event_gesture_get_cancelled(struct libinput_event_gesture *event);

double
libinput_event_gesture_get_dx(struct libinput_event_gesture *event);

double
libinput_event_gesture_get_dy(struct libinput_event_gesture *event);

double
libinput_event_gesture_get_dx_unaccelerated(
        struct libinput_event_gesture *event);

double
libinput_event_gesture_get_dy_unaccelerated(
        struct libinput_event_gesture *event);

double
libinput_event_gesture_get_scale(struct libinput_event_gesture *event);

double
libinput_event_gesture_get_angle_delta(struct libinput_event_gesture *event);

struct libinput_interface {
        int (*open_restricted)(const char *path, int flags, void *user_data);
        void (*close_restricted)(int fd, void *user_data);
};

struct libinput *
libinput_udev_create_context(const struct libinput_interface *interface,
                             void *user_data,
                             struct udev *udev);

int
libinput_udev_assign_seat(struct libinput *libinput,
                          const char *seat_id);

struct libinput *
libinput_path_create_context(const struct libinput_interface *interface,
                             void *user_data);

struct libinput_device *
libinput_path_add_device(struct libinput *libinput,
                         const char *path);

void
libinput_path_remove_device(struct libinput_device *device);

int
libinput_get_fd(struct libinput *libinput);

int
libinput_dispatch(struct libinput *libinput);

struct libinput_event *
libinput_get_event(struct libinput *libinput);

enum libinput_event_type
libinput_next_event_type(struct libinput *libinput);

void
libinput_set_user_data(struct libinput *libinput,
                       void *user_data);

void *
libinput_get_user_data(struct libinput *libinput);

int
libinput_resume(struct libinput *libinput);

void
libinput_suspend(struct libinput *libinput);

struct libinput *
libinput_ref(struct libinput *libinput);

struct libinput *
libinput_unref(struct libinput *libinput);

void
libinput_log_set_priority(struct libinput *libinput,
                          enum libinput_log_priority priority);

enum libinput_log_priority
libinput_log_get_priority(const struct libinput *libinput);

typedef void (*libinput_log_handler)(struct libinput *libinput,
                                     enum libinput_log_priority priority,
                                     const char *format, va_list args)
           LIBINPUT_ATTRIBUTE_PRINTF(3, 0);

void
libinput_log_set_handler(struct libinput *libinput,
                         libinput_log_handler log_handler);

struct libinput_seat *
libinput_seat_ref(struct libinput_seat *seat);

struct libinput_seat *
libinput_seat_unref(struct libinput_seat *seat);

void
libinput_seat_set_user_data(struct libinput_seat *seat, void *user_data);

void *
libinput_seat_get_user_data(struct libinput_seat *seat);

struct libinput *
libinput_seat_get_context(struct libinput_seat *seat);

const char *
libinput_seat_get_physical_name(struct libinput_seat *seat);

const char *
libinput_seat_get_logical_name(struct libinput_seat *seat);

struct libinput_device *
libinput_device_ref(struct libinput_device *device);

struct libinput_device *
libinput_device_unref(struct libinput_device *device);

void
libinput_device_set_user_data(struct libinput_device *device, void *user_data);

void *
libinput_device_get_user_data(struct libinput_device *device);

struct libinput *
libinput_device_get_context(struct libinput_device *device);

struct libinput_device_group *
libinput_device_get_device_group(struct libinput_device *device);

const char *
libinput_device_get_sysname(struct libinput_device *device);

const char *
libinput_device_get_name(struct libinput_device *device);

unsigned int
libinput_device_get_id_product(struct libinput_device *device);

unsigned int
libinput_device_get_id_vendor(struct libinput_device *device);

const char *
libinput_device_get_output_name(struct libinput_device *device);

struct libinput_seat *
libinput_device_get_seat(struct libinput_device *device);

int
libinput_device_set_seat_logical_name(struct libinput_device *device,
                                      const char *name);

struct udev_device *
libinput_device_get_udev_device(struct libinput_device *device);

void
libinput_device_led_update(struct libinput_device *device,
                           enum libinput_led leds);

int
libinput_device_has_capability(struct libinput_device *device,
                               enum libinput_device_capability capability);

int
libinput_device_get_size(struct libinput_device *device,
                         double *width,
                         double *height);

int
libinput_device_pointer_has_button(struct libinput_device *device, uint32_t code);

int
libinput_device_keyboard_has_key(struct libinput_device *device,
                                 uint32_t code);

struct libinput_device_group *
libinput_device_group_ref(struct libinput_device_group *group);

struct libinput_device_group *
libinput_device_group_unref(struct libinput_device_group *group);

void
libinput_device_group_set_user_data(struct libinput_device_group *group,
                                    void *user_data);

void *
libinput_device_group_get_user_data(struct libinput_device_group *group);

enum libinput_config_status {
        LIBINPUT_CONFIG_STATUS_SUCCESS = 0,     
        LIBINPUT_CONFIG_STATUS_UNSUPPORTED,     
        LIBINPUT_CONFIG_STATUS_INVALID,         
};

const char *
libinput_config_status_to_str(enum libinput_config_status status);

enum libinput_config_tap_state {
        LIBINPUT_CONFIG_TAP_DISABLED, 
        LIBINPUT_CONFIG_TAP_ENABLED, 
};

int
libinput_device_config_tap_get_finger_count(struct libinput_device *device);

enum libinput_config_status
libinput_device_config_tap_set_enabled(struct libinput_device *device,
                                       enum libinput_config_tap_state enable);

enum libinput_config_tap_state
libinput_device_config_tap_get_enabled(struct libinput_device *device);

enum libinput_config_tap_state
libinput_device_config_tap_get_default_enabled(struct libinput_device *device);

enum libinput_config_drag_lock_state {
        LIBINPUT_CONFIG_DRAG_LOCK_DISABLED,
        LIBINPUT_CONFIG_DRAG_LOCK_ENABLED,
};

enum libinput_config_status
libinput_device_config_tap_set_drag_lock_enabled(struct libinput_device *device,
                                                 enum libinput_config_drag_lock_state enable);

enum libinput_config_drag_lock_state
libinput_device_config_tap_get_drag_lock_enabled(struct libinput_device *device);

enum libinput_config_drag_lock_state
libinput_device_config_tap_get_default_drag_lock_enabled(struct libinput_device *device);

int
libinput_device_config_calibration_has_matrix(struct libinput_device *device);

enum libinput_config_status
libinput_device_config_calibration_set_matrix(struct libinput_device *device,
                                              const float matrix[6]);

int
libinput_device_config_calibration_get_matrix(struct libinput_device *device,
                                              float matrix[6]);

int
libinput_device_config_calibration_get_default_matrix(struct libinput_device *device,
                                                      float matrix[6]);

enum libinput_config_send_events_mode {
        LIBINPUT_CONFIG_SEND_EVENTS_ENABLED = 0,
        LIBINPUT_CONFIG_SEND_EVENTS_DISABLED = (1 << 0),
        LIBINPUT_CONFIG_SEND_EVENTS_DISABLED_ON_EXTERNAL_MOUSE = (1 << 1),
};

uint32_t
libinput_device_config_send_events_get_modes(struct libinput_device *device);

enum libinput_config_status
libinput_device_config_send_events_set_mode(struct libinput_device *device,
                                            uint32_t mode);

uint32_t
libinput_device_config_send_events_get_mode(struct libinput_device *device);

uint32_t
libinput_device_config_send_events_get_default_mode(struct libinput_device *device);

int
libinput_device_config_accel_is_available(struct libinput_device *device);

enum libinput_config_status
libinput_device_config_accel_set_speed(struct libinput_device *device,
                                       double speed);

double
libinput_device_config_accel_get_speed(struct libinput_device *device);

double
libinput_device_config_accel_get_default_speed(struct libinput_device *device);

int
libinput_device_config_scroll_has_natural_scroll(struct libinput_device *device);

enum libinput_config_status
libinput_device_config_scroll_set_natural_scroll_enabled(struct libinput_device *device,
                                                         int enable);
int
libinput_device_config_scroll_get_natural_scroll_enabled(struct libinput_device *device);

int
libinput_device_config_scroll_get_default_natural_scroll_enabled(struct libinput_device *device);

int
libinput_device_config_left_handed_is_available(struct libinput_device *device);

enum libinput_config_status
libinput_device_config_left_handed_set(struct libinput_device *device,
                                       int left_handed);

int
libinput_device_config_left_handed_get(struct libinput_device *device);

int
libinput_device_config_left_handed_get_default(struct libinput_device *device);

enum libinput_config_click_method {
        LIBINPUT_CONFIG_CLICK_METHOD_NONE = 0,
        LIBINPUT_CONFIG_CLICK_METHOD_BUTTON_AREAS = (1 << 0),
        LIBINPUT_CONFIG_CLICK_METHOD_CLICKFINGER = (1 << 1),
};

uint32_t
libinput_device_config_click_get_methods(struct libinput_device *device);

enum libinput_config_status
libinput_device_config_click_set_method(struct libinput_device *device,
                                        enum libinput_config_click_method method);
enum libinput_config_click_method
libinput_device_config_click_get_method(struct libinput_device *device);

enum libinput_config_click_method
libinput_device_config_click_get_default_method(struct libinput_device *device);

enum libinput_config_middle_emulation_state {
        LIBINPUT_CONFIG_MIDDLE_EMULATION_DISABLED,
        LIBINPUT_CONFIG_MIDDLE_EMULATION_ENABLED,
};

int
libinput_device_config_middle_emulation_is_available(
                struct libinput_device *device);

enum libinput_config_status
libinput_device_config_middle_emulation_set_enabled(
                struct libinput_device *device,
                enum libinput_config_middle_emulation_state enable);

enum libinput_config_middle_emulation_state
libinput_device_config_middle_emulation_get_enabled(
                struct libinput_device *device);

enum libinput_config_middle_emulation_state
libinput_device_config_middle_emulation_get_default_enabled(
                struct libinput_device *device);

enum libinput_config_scroll_method {
        LIBINPUT_CONFIG_SCROLL_NO_SCROLL = 0,
        LIBINPUT_CONFIG_SCROLL_2FG = (1 << 0),
        LIBINPUT_CONFIG_SCROLL_EDGE = (1 << 1),
        LIBINPUT_CONFIG_SCROLL_ON_BUTTON_DOWN = (1 << 2),
};

uint32_t
libinput_device_config_scroll_get_methods(struct libinput_device *device);

enum libinput_config_status
libinput_device_config_scroll_set_method(struct libinput_device *device,
                                         enum libinput_config_scroll_method method);

enum libinput_config_scroll_method
libinput_device_config_scroll_get_method(struct libinput_device *device);

enum libinput_config_scroll_method
libinput_device_config_scroll_get_default_method(struct libinput_device *device);

enum libinput_config_status
libinput_device_config_scroll_set_button(struct libinput_device *device,
                                         uint32_t button);

uint32_t
libinput_device_config_scroll_get_button(struct libinput_device *device);

uint32_t
libinput_device_config_scroll_get_default_button(struct libinput_device *device);

enum libinput_config_dwt_state {
        LIBINPUT_CONFIG_DWT_DISABLED,
        LIBINPUT_CONFIG_DWT_ENABLED,
};

int
libinput_device_config_dwt_is_available(struct libinput_device *device);

enum libinput_config_status
libinput_device_config_dwt_set_enabled(struct libinput_device *device,
                                       enum libinput_config_dwt_state enable);

enum libinput_config_dwt_state
libinput_device_config_dwt_get_enabled(struct libinput_device *device);

enum libinput_config_dwt_state
libinput_device_config_dwt_get_default_enabled(struct libinput_device *device);

#ifdef __cplusplus
}
#endif
#endif /* LIBINPUT_H */