libei.h

Go to the documentation of this file.

/*
 * Copyright © 2020 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.
 */
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
 
struct ei;
 
struct ei_device;
 
struct ei_seat;
 
struct ei_event;
 
struct ei_keymap;
 
enum ei_device_capability {
        EI_DEVICE_CAP_POINTER = 1,
        EI_DEVICE_CAP_POINTER_ABSOLUTE,
        EI_DEVICE_CAP_KEYBOARD,
        EI_DEVICE_CAP_TOUCH,
};
 
enum ei_keymap_type {
        EI_KEYMAP_TYPE_XKB = 1,
};
 
enum ei_keymap_source {
        EI_KEYMAP_SOURCE_CLIENT = 1,
        EI_KEYMAP_SOURCE_SERVER,
};
 
enum ei_event_type {
        EI_EVENT_CONNECT = 1,
        EI_EVENT_DISCONNECT,
 
        EI_EVENT_SEAT_ADDED,
 
        EI_EVENT_SEAT_REMOVED,
 
        EI_EVENT_DEVICE_ADDED,
 
        EI_EVENT_DEVICE_REMOVED,
 
        EI_EVENT_DEVICE_SUSPENDED,
        EI_EVENT_DEVICE_RESUMED,
};
 
struct ei *
ei_new(void *user_data);
 
enum ei_log_priority {
        EI_LOG_PRIORITY_DEBUG = 10,
        EI_LOG_PRIORITY_INFO = 20,
        EI_LOG_PRIORITY_WARNING = 30,
        EI_LOG_PRIORITY_ERROR = 40,
};
 
typedef void (*ei_log_handler)(struct ei *ei,
                               enum ei_log_priority priority,
                               const char *message,
                               bool is_continuation);
void
ei_log_set_handler(struct ei *ei, ei_log_handler log_handler);
 
void
ei_log_set_priority(struct ei *ei, enum ei_log_priority priority);
 
enum ei_log_priority
ei_log_get_priority(const struct ei *ei);
 
void
ei_configure_name(struct ei * ei, const char *name);
 
int
ei_setup_backend_socket(struct ei *ei, const char *socketpath);
 
int
ei_setup_backend_fd(struct ei *ei, int fd);
 
int
ei_setup_backend_portal(struct ei *ei);
 
int
ei_setup_backend_portal_busname(struct ei *ei, const char *busname);
 
struct ei *
ei_ref(struct ei *ei);
 
struct ei *
ei_unref(struct ei *ei);
 
void
ei_set_user_data(struct ei *ei, void *user_data);
 
void *
ei_get_user_data(struct ei *ei);
 
int
ei_get_fd(struct ei *ei);
 
void
ei_dispatch(struct ei *ei);
 
struct ei_event *
ei_get_event(struct ei *ei);
 
struct ei_event *
ei_peek_event(struct ei *ei);
 
struct ei_event *
ei_event_unref(struct ei_event *event);
 
const char *
ei_seat_get_name(struct ei_seat *seat);
 
bool
ei_seat_has_capability(struct ei_seat *seat,
                       enum ei_device_capability cap);
 
struct ei_seat *
ei_seat_ref(struct ei_seat *seat);
 
struct ei_seat *
ei_seat_unref(struct ei_seat *seat);
 
struct ei *
ei_seat_get_context(struct ei_seat *seat);
 
enum ei_event_type
ei_event_get_type(struct ei_event *event);
 
struct ei_device *
ei_event_get_device(struct ei_event *event);
 
uint64_t
ei_event_get_time(struct ei_event *event);
 
struct ei_device *
ei_device_ref(struct ei_device *device);
 
struct ei_device *
ei_device_unref(struct ei_device *device);
 
struct ei_device *
ei_device_new(struct ei_seat *ei_seat);
 
struct ei_seat *
ei_device_get_seat(struct ei_device *device);
 
void
ei_seat_set_user_data(struct ei_seat *seat, void *user_data);
 
void *
ei_seat_get_user_data(struct ei_seat *seat);
 
void
ei_device_set_user_data(struct ei_device *device, void *user_data);
 
void *
ei_device_get_user_data(struct ei_device *device);
 
void
ei_device_configure_name(struct ei_device *device, const char *name);
 
bool
ei_device_configure_capability(struct ei_device *device,
                               enum ei_device_capability cap);
 
void
ei_device_pointer_configure_range(struct ei_device *device,
                                  uint32_t width,
                                  uint32_t height);
 
void
ei_device_touch_configure_range(struct ei_device *device,
                                uint32_t width,
                                uint32_t height);
 
 
struct ei_keymap *
ei_keymap_new(enum ei_keymap_type type, int fd, size_t size);
 
size_t
ei_keymap_get_size(struct ei_keymap *keymap);
 
enum ei_keymap_type
ei_keymap_get_type(struct ei_keymap *keymap);
 
int
ei_keymap_get_fd(struct ei_keymap *keymap);
 
enum ei_keymap_source
ei_keymap_get_source(struct ei_keymap *keymap);
 
struct ei_device *
ei_keymap_get_device(struct ei_keymap *keymap);
 
struct ei_keymap *
ei_keymap_ref(struct ei_keymap *keymap);
 
struct ei_keymap *
ei_keymap_unref(struct ei_keymap *keymap);
 
void
ei_device_keyboard_configure_keymap(struct ei_device *device,
                                    struct ei_keymap *keymap);
 
void
ei_device_add(struct ei_device *device);
 
void
ei_device_remove(struct ei_device *device);
 
const char *
ei_device_get_name(struct ei_device *device);
 
bool
ei_device_has_capability(struct ei_device *device,
                         enum ei_device_capability cap);
 
uint32_t
ei_device_pointer_get_width(struct ei_device *device);
 
uint32_t
ei_device_pointer_get_height(struct ei_device *device);
 
uint32_t
ei_device_touch_get_width(struct ei_device *device);
 
uint32_t
ei_device_touch_get_height(struct ei_device *device);
 
struct ei_keymap *
ei_device_keyboard_get_keymap(struct ei_device *device);
 
struct ei_device *
ei_keymap_get_context(struct ei_keymap *keymap);
 
struct ei *
ei_device_get_context(struct ei_device *device);
 
void
ei_device_pointer_motion(struct ei_device *device, double x, double y);
 
void
ei_device_pointer_motion_absolute(struct ei_device *device,
                                  double x, double y);
 
void
ei_device_pointer_button(struct ei_device *device,
                         uint32_t button, bool is_press);
 
void
ei_device_pointer_scroll(struct ei_device *device, double x, double y);
 
void
ei_device_pointer_scroll_discrete(struct ei_device *device, int32_t x, int32_t y);
 
void
ei_device_keyboard_key(struct ei_device *device, uint32_t keycode, bool is_press);
 
struct ei_touch *
ei_device_touch_new(struct ei_device *device);
 
void
ei_touch_down(struct ei_touch *touch, double x, double y);
 
void
ei_touch_motion(struct ei_touch *touch, double x, double y);
 
void
ei_touch_up(struct ei_touch *touch);
 
struct ei_touch *
ei_touch_ref(struct ei_touch *touch);
 
struct ei_touch *
ei_touch_unref(struct ei_touch *touch);
 
void
ei_touch_set_user_data(struct ei_touch *touch, void *user_data);
 
void *
ei_touch_get_user_data(struct ei_touch *touch);
 
struct ei_device *
ei_touch_get_device(struct ei_touch *touch);
 
struct ei_seat *
ei_event_get_seat(struct ei_event *event);
 
#ifdef __cplusplus
}
#endif