libevdev.h

Go to the documentation of this file.

/*
 * Copyright © 2013 Red Hat, Inc.
 *
 * 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, and
 * that the name of the copyright holders not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  The copyright holders make no representations
 * about the suitability of this software for any purpose.  It is provided "as
 * is" without express or implied warranty.
 *
 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL THE COPYRIGHT HOLDERS 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.
 */

#ifndef LIBEVDEV_H
#define LIBEVDEV_H

#ifdef __cplusplus
extern "C" {
#endif

#include <linux/input.h>
#include <stdarg.h>

struct libevdev;

enum libevdev_read_flag {
        LIBEVDEV_READ_FLAG_SYNC         = 1, 
        LIBEVDEV_READ_FLAG_NORMAL       = 2, 
        LIBEVDEV_READ_FLAG_FORCE_SYNC   = 4, 
        LIBEVDEV_READ_FLAG_BLOCKING     = 8, 
};

struct libevdev* libevdev_new(void);

int libevdev_new_from_fd(int fd, struct libevdev **dev);

void libevdev_free(struct libevdev *dev);

enum libevdev_log_priority {
        LIBEVDEV_LOG_ERROR = 10,        
        LIBEVDEV_LOG_INFO  = 20,        
        LIBEVDEV_LOG_DEBUG = 30,        
};

typedef void (*libevdev_log_func_t)(enum libevdev_log_priority priority,
                                    void *data,
                                    const char *file, int line,
                                    const char *func,
                                    const char *format, va_list args);

void libevdev_set_log_function(libevdev_log_func_t logfunc, void *data);

void libevdev_set_log_priority(enum libevdev_log_priority priority);

enum libevdev_log_priority libevdev_get_log_priority(void);

enum libevdev_grab_mode {
        LIBEVDEV_GRAB = 3,      
        LIBEVDEV_UNGRAB = 4,    
};

int libevdev_grab(struct libevdev *dev, enum libevdev_grab_mode grab);

int libevdev_set_fd(struct libevdev* dev, int fd);

int libevdev_change_fd(struct libevdev* dev, int fd);

int libevdev_get_fd(const struct libevdev* dev);


enum libevdev_read_status {
        LIBEVDEV_READ_STATUS_SUCCESS = 0,
        LIBEVDEV_READ_STATUS_SYNC = 1,
};
int libevdev_next_event(struct libevdev *dev, unsigned int flags, struct input_event *ev);

int libevdev_has_event_pending(struct libevdev *dev);

const char* libevdev_get_name(const struct libevdev *dev);

void libevdev_set_name(struct libevdev *dev, const char *name);

const char * libevdev_get_phys(const struct libevdev *dev);

void libevdev_set_phys(struct libevdev *dev, const char *phys);

const char * libevdev_get_uniq(const struct libevdev *dev);

void libevdev_set_uniq(struct libevdev *dev, const char *uniq);

int libevdev_get_id_product(const struct libevdev *dev);

void libevdev_set_id_product(struct libevdev *dev, int product_id);

int libevdev_get_id_vendor(const struct libevdev *dev);

void libevdev_set_id_vendor(struct libevdev *dev, int vendor_id);

int libevdev_get_id_bustype(const struct libevdev *dev);

void libevdev_set_id_bustype(struct libevdev *dev, int bustype);

int libevdev_get_id_version(const struct libevdev *dev);

void libevdev_set_id_version(struct libevdev *dev, int version);

int libevdev_get_driver_version(const struct libevdev *dev);

int libevdev_has_property(const struct libevdev *dev, unsigned int prop);

int libevdev_enable_property(struct libevdev *dev, unsigned int prop);

int libevdev_has_event_type(const struct libevdev *dev, unsigned int type);

int libevdev_has_event_code(const struct libevdev *dev, unsigned int type, unsigned int code);

int libevdev_get_abs_minimum(const struct libevdev *dev, unsigned int code);
int libevdev_get_abs_maximum(const struct libevdev *dev, unsigned int code);
int libevdev_get_abs_fuzz(const struct libevdev *dev, unsigned int code);
int libevdev_get_abs_flat(const struct libevdev *dev, unsigned int code);
int libevdev_get_abs_resolution(const struct libevdev *dev, unsigned int code);

const struct input_absinfo* libevdev_get_abs_info(const struct libevdev *dev, unsigned int code);

int libevdev_get_event_value(const struct libevdev *dev, unsigned int type, unsigned int code);

int libevdev_set_event_value(struct libevdev *dev, unsigned int type, unsigned int code, int value);

int libevdev_fetch_event_value(const struct libevdev *dev, unsigned int type, unsigned int code, int *value);

int libevdev_get_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code);

int libevdev_set_slot_value(struct libevdev *dev, unsigned int slot, unsigned int code, int value);

int libevdev_fetch_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code, int *value);

int libevdev_get_num_slots(const struct libevdev *dev);

int libevdev_get_current_slot(const struct libevdev *dev);

void libevdev_set_abs_minimum(struct libevdev *dev, unsigned int code, int min);

void libevdev_set_abs_maximum(struct libevdev *dev, unsigned int code, int max);

void libevdev_set_abs_fuzz(struct libevdev *dev, unsigned int code, int fuzz);

void libevdev_set_abs_flat(struct libevdev *dev, unsigned int code, int flat);

void libevdev_set_abs_resolution(struct libevdev *dev, unsigned int code, int resolution);

void libevdev_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs);

int libevdev_enable_event_type(struct libevdev *dev, unsigned int type);

int libevdev_disable_event_type(struct libevdev *dev, unsigned int type);

int libevdev_enable_event_code(struct libevdev *dev, unsigned int type, unsigned int code, const void *data);

int libevdev_disable_event_code(struct libevdev *dev, unsigned int type, unsigned int code);

int libevdev_kernel_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs);


enum libevdev_led_value {
        LIBEVDEV_LED_ON = 3,
        LIBEVDEV_LED_OFF = 4,
};

int libevdev_kernel_set_led_value(struct libevdev *dev, unsigned int code, enum libevdev_led_value value);

int libevdev_kernel_set_led_values(struct libevdev *dev, ...);

int libevdev_set_clock_id(struct libevdev *dev, int clockid);

int libevdev_event_is_type(const struct input_event *ev, unsigned int type);

int libevdev_event_is_code(const struct input_event *ev, unsigned int type, unsigned int code);

const char * libevdev_event_type_get_name(unsigned int type);
const char * libevdev_event_code_get_name(unsigned int type, unsigned int code);

const char* libevdev_property_get_name(unsigned int prop);

int libevdev_event_type_get_max(unsigned int type);

int libevdev_event_type_from_name(const char *name);

int libevdev_event_type_from_name_n(const char *name, size_t len);

int libevdev_event_code_from_name(unsigned int type, const char *name);

int libevdev_event_code_from_name_n(unsigned int type, const char *name,
                                    size_t len);

int libevdev_get_repeat(struct libevdev *dev, int *delay, int *period);


/********* DEPRECATED SECTION *********/
#if defined(__GNUC__) && __GNUC__ >= 4
#define LIBEVDEV_DEPRECATED __attribute__ ((deprecated))
#else
#define LIBEVDEV_DEPRECATED
#endif

LIBEVDEV_DEPRECATED extern const enum libevdev_read_flag LIBEVDEV_READ_SYNC;
LIBEVDEV_DEPRECATED extern const enum libevdev_read_flag LIBEVDEV_READ_NORMAL;
LIBEVDEV_DEPRECATED extern const enum libevdev_read_flag LIBEVDEV_FORCE_SYNC;
LIBEVDEV_DEPRECATED extern const enum libevdev_read_flag LIBEVDEV_READ_BLOCKING;

/* replacement: libevdev_kernel_set_abs_info */
int libevdev_kernel_set_abs_value(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs) LIBEVDEV_DEPRECATED;


/* replacement: libevdev_set_log_function */
void libevdev_set_log_handler(struct libevdev *dev, libevdev_log_func_t logfunc) LIBEVDEV_DEPRECATED;

int libevdev_get_event_type_max(unsigned int type) LIBEVDEV_DEPRECATED;

const char* libevdev_get_property_name(unsigned int prop) LIBEVDEV_DEPRECATED;

const char * libevdev_get_event_type_name(unsigned int type) LIBEVDEV_DEPRECATED;
const char * libevdev_get_event_code_name(unsigned int type, unsigned int code) LIBEVDEV_DEPRECATED;

int libevdev_is_event_type(const struct input_event *ev, unsigned int type) LIBEVDEV_DEPRECATED;

int libevdev_is_event_code(const struct input_event *ev, unsigned int type, unsigned int code) LIBEVDEV_DEPRECATED;
/**************************************/

#ifdef __cplusplus
}
#endif

#endif /* LIBEVDEV_H */