libevdev  1.4.5
A wrapper library for evdev devices
libevdev.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Red Hat, Inc.
3  *
4  * Permission to use, copy, modify, distribute, and sell this software and its
5  * documentation for any purpose is hereby granted without fee, provided that
6  * the above copyright notice appear in all copies and that both that copyright
7  * notice and this permission notice appear in supporting documentation, and
8  * that the name of the copyright holders not be used in advertising or
9  * publicity pertaining to distribution of the software without specific,
10  * written prior permission. The copyright holders make no representations
11  * about the suitability of this software for any purpose. It is provided "as
12  * is" without express or implied warranty.
13  *
14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
20  * OF THIS SOFTWARE.
21  */
22 
23 #ifndef LIBEVDEV_H
24 #define LIBEVDEV_H
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30 #include <linux/input.h>
31 #include <stdarg.h>
32 
33 #define LIBEVDEV_ATTRIBUTE_PRINTF(_format, _args) __attribute__ ((format (printf, _format, _args)))
34 
738 struct libevdev;
739 
749 };
750 
765 struct libevdev* libevdev_new(void);
766 
789 int libevdev_new_from_fd(int fd, struct libevdev **dev);
790 
804 void libevdev_free(struct libevdev *dev);
805 
813 };
814 
831 typedef void (*libevdev_log_func_t)(enum libevdev_log_priority priority,
832  void *data,
833  const char *file, int line,
834  const char *func,
835  const char *format, va_list args)
837 
856 void libevdev_set_log_function(libevdev_log_func_t logfunc, void *data);
857 
871 
884 
904 typedef void (*libevdev_device_log_func_t)(const struct libevdev *dev,
905  enum libevdev_log_priority priority,
906  void *data,
907  const char *file, int line,
908  const char *func,
909  const char *format, va_list args)
911 
933 void libevdev_set_device_log_function(struct libevdev *dev,
935  enum libevdev_log_priority priority,
936  void *data);
937 
944 };
945 
964 int libevdev_grab(struct libevdev *dev, enum libevdev_grab_mode grab);
965 
989 int libevdev_set_fd(struct libevdev* dev, int fd);
990 
1026 int libevdev_change_fd(struct libevdev* dev, int fd);
1027 
1036 int libevdev_get_fd(const struct libevdev* dev);
1037 
1058 };
1059 
1110 int libevdev_next_event(struct libevdev *dev, unsigned int flags, struct input_event *ev);
1111 
1134 int libevdev_has_event_pending(struct libevdev *dev);
1135 
1150 const char* libevdev_get_name(const struct libevdev *dev);
1151 
1165 void libevdev_set_name(struct libevdev *dev, const char *name);
1166 
1182 const char * libevdev_get_phys(const struct libevdev *dev);
1183 
1197 void libevdev_set_phys(struct libevdev *dev, const char *phys);
1198 
1212 const char * libevdev_get_uniq(const struct libevdev *dev);
1213 
1227 void libevdev_set_uniq(struct libevdev *dev, const char *uniq);
1228 
1238 int libevdev_get_id_product(const struct libevdev *dev);
1239 
1249 void libevdev_set_id_product(struct libevdev *dev, int product_id);
1250 
1260 int libevdev_get_id_vendor(const struct libevdev *dev);
1261 
1271 void libevdev_set_id_vendor(struct libevdev *dev, int vendor_id);
1272 
1282 int libevdev_get_id_bustype(const struct libevdev *dev);
1283 
1293 void libevdev_set_id_bustype(struct libevdev *dev, int bustype);
1294 
1304 int libevdev_get_id_version(const struct libevdev *dev);
1305 
1315 void libevdev_set_id_version(struct libevdev *dev, int version);
1316 
1326 int libevdev_get_driver_version(const struct libevdev *dev);
1327 
1338 int libevdev_has_property(const struct libevdev *dev, unsigned int prop);
1339 
1351 int libevdev_enable_property(struct libevdev *dev, unsigned int prop);
1352 
1363 int libevdev_has_event_type(const struct libevdev *dev, unsigned int type);
1364 
1376 int libevdev_has_event_code(const struct libevdev *dev, unsigned int type, unsigned int code);
1377 
1390 int libevdev_get_abs_minimum(const struct libevdev *dev, unsigned int code);
1391 
1404 int libevdev_get_abs_maximum(const struct libevdev *dev, unsigned int code);
1405 
1418 int libevdev_get_abs_fuzz(const struct libevdev *dev, unsigned int code);
1419 
1432 int libevdev_get_abs_flat(const struct libevdev *dev, unsigned int code);
1433 
1446 int libevdev_get_abs_resolution(const struct libevdev *dev, unsigned int code);
1447 
1461 const struct input_absinfo* libevdev_get_abs_info(const struct libevdev *dev, unsigned int code);
1462 
1485 int libevdev_get_event_value(const struct libevdev *dev, unsigned int type, unsigned int code);
1486 
1518 int libevdev_set_event_value(struct libevdev *dev, unsigned int type, unsigned int code, int value);
1519 
1545 int libevdev_fetch_event_value(const struct libevdev *dev, unsigned int type, unsigned int code, int *value);
1546 
1567 int libevdev_get_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code);
1568 
1595 int libevdev_set_slot_value(struct libevdev *dev, unsigned int slot, unsigned int code, int value);
1596 
1622 int libevdev_fetch_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code, int *value);
1623 
1637 int libevdev_get_num_slots(const struct libevdev *dev);
1638 
1654 int libevdev_get_current_slot(const struct libevdev *dev);
1655 
1667 void libevdev_set_abs_minimum(struct libevdev *dev, unsigned int code, int min);
1668 
1680 void libevdev_set_abs_maximum(struct libevdev *dev, unsigned int code, int max);
1681 
1693 void libevdev_set_abs_fuzz(struct libevdev *dev, unsigned int code, int fuzz);
1694 
1706 void libevdev_set_abs_flat(struct libevdev *dev, unsigned int code, int flat);
1707 
1719 void libevdev_set_abs_resolution(struct libevdev *dev, unsigned int code, int resolution);
1720 
1732 void libevdev_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs);
1733 
1751 int libevdev_enable_event_type(struct libevdev *dev, unsigned int type);
1752 
1779 int libevdev_disable_event_type(struct libevdev *dev, unsigned int type);
1780 
1814 int libevdev_enable_event_code(struct libevdev *dev, unsigned int type, unsigned int code, const void *data);
1815 
1843 int libevdev_disable_event_code(struct libevdev *dev, unsigned int type, unsigned int code);
1844 
1859 int libevdev_kernel_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs);
1860 
1867 };
1868 
1882 int libevdev_kernel_set_led_value(struct libevdev *dev, unsigned int code, enum libevdev_led_value value);
1883 
1907 int libevdev_kernel_set_led_values(struct libevdev *dev, ...);
1908 
1923 int libevdev_set_clock_id(struct libevdev *dev, int clockid);
1924 
1946 int libevdev_event_is_type(const struct input_event *ev, unsigned int type);
1947 
1971 int libevdev_event_is_code(const struct input_event *ev, unsigned int type, unsigned int code);
1972 
1984 const char * libevdev_event_type_get_name(unsigned int type);
1997 const char * libevdev_event_code_get_name(unsigned int type, unsigned int code);
1998 
2012 const char* libevdev_property_get_name(unsigned int prop);
2013 
2026 int libevdev_event_type_get_max(unsigned int type);
2027 
2042 int libevdev_event_type_from_name(const char *name);
2043 
2060 int libevdev_event_type_from_name_n(const char *name, size_t len);
2061 
2081 int libevdev_event_code_from_name(unsigned int type, const char *name);
2082 
2104 int libevdev_event_code_from_name_n(unsigned int type, const char *name,
2105  size_t len);
2106 
2119 int libevdev_property_from_name(const char *name);
2120 
2135 int libevdev_property_from_name_n(const char *name, size_t len);
2136 
2154 int libevdev_get_repeat(const struct libevdev *dev, int *delay, int *period);
2155 
2156 /********* DEPRECATED SECTION *********/
2157 #if defined(__GNUC__) && __GNUC__ >= 4
2158 #define LIBEVDEV_DEPRECATED __attribute__ ((deprecated))
2159 #else
2160 #define LIBEVDEV_DEPRECATED
2161 #endif
2162 
2163 #ifdef __cplusplus
2164 }
2165 #endif
2166 
2167 #endif /* LIBEVDEV_H */
libevdev_read_status
Definition: libevdev.h:1041
int libevdev_get_abs_resolution(const struct libevdev *dev, unsigned int code)
Get the axis resolution for the given axis, as advertised by the kernel.
int libevdev_has_event_pending(struct libevdev *dev)
Check if there are events waiting for us.
void(* libevdev_device_log_func_t)(const struct libevdev *dev, enum libevdev_log_priority priority, void *data, const char *file, int line, const char *func, const char *format, va_list args)
Logging function called by library-internal logging for a specific libevdev context.
Definition: libevdev.h:904
int libevdev_event_type_from_name_n(const char *name, size_t len)
Look up an event-type by its name.
int libevdev_has_property(const struct libevdev *dev, unsigned int prop)
int libevdev_change_fd(struct libevdev *dev, int fd)
Change the fd for this device, without re-reading the actual device.
informational messages
Definition: libevdev.h:811
int libevdev_enable_property(struct libevdev *dev, unsigned int prop)
const char * libevdev_event_type_get_name(unsigned int type)
int libevdev_has_event_code(const struct libevdev *dev, unsigned int type, unsigned int code)
const struct input_absinfo * libevdev_get_abs_info(const struct libevdev *dev, unsigned int code)
Get the axis info for the given axis, as advertised by the kernel.
critical errors and application bugs
Definition: libevdev.h:810
void libevdev_set_abs_fuzz(struct libevdev *dev, unsigned int code, int fuzz)
Change the fuzz for the given EV_ABS event code, if the code exists.
Process data in sync mode.
Definition: libevdev.h:744
int libevdev_get_fd(const struct libevdev *dev)
libevdev_led_value
Definition: libevdev.h:1864
void libevdev_set_uniq(struct libevdev *dev, const char *uniq)
Change the device's unique identifier as returned by libevdev_get_uniq().
debug information
Definition: libevdev.h:812
const char * libevdev_event_code_get_name(unsigned int type, unsigned int code)
int libevdev_get_repeat(const struct libevdev *dev, int *delay, int *period)
Get the repeat delay and repeat period values for this device.
The fd is not in O_NONBLOCK and a read may block.
Definition: libevdev.h:748
enum libevdev_log_priority libevdev_get_log_priority(void)
Return the current log priority level.
void libevdev_set_log_function(libevdev_log_func_t logfunc, void *data)
Set a printf-style logging handler for library-internal logging.
int libevdev_has_event_type(const struct libevdev *dev, unsigned int type)
int libevdev_event_code_from_name(unsigned int type, const char *name)
Look up an event code by its type and name.
Turn the LED off.
Definition: libevdev.h:1866
void libevdev_set_abs_maximum(struct libevdev *dev, unsigned int code, int max)
Change the maximum for the given EV_ABS event code, if the code exists.
Pretend the next event is a SYN_DROPPED and require the caller to sync.
Definition: libevdev.h:746
int libevdev_get_abs_fuzz(const struct libevdev *dev, unsigned int code)
Get the axis fuzz for the given axis, as advertised by the kernel.
int libevdev_set_slot_value(struct libevdev *dev, unsigned int slot, unsigned int code, int value)
Set the value for a given code for the given slot.
int libevdev_event_code_from_name_n(unsigned int type, const char *name, size_t len)
Look up an event code by its type and name.
void libevdev_set_id_vendor(struct libevdev *dev, int vendor_id)
void libevdev_set_abs_resolution(struct libevdev *dev, unsigned int code, int resolution)
Change the resolution for the given EV_ABS event code, if the code exists.
int libevdev_get_abs_minimum(const struct libevdev *dev, unsigned int code)
Get the minimum axis value for the given axis, as advertised by the kernel.
int libevdev_grab(struct libevdev *dev, enum libevdev_grab_mode grab)
Grab or ungrab the device through a kernel EVIOCGRAB.
Turn the LED on.
Definition: libevdev.h:1865
int libevdev_get_id_bustype(const struct libevdev *dev)
int libevdev_event_type_get_max(unsigned int type)
int libevdev_event_type_from_name(const char *name)
Look up an event-type by its name.
int libevdev_disable_event_code(struct libevdev *dev, unsigned int type, unsigned int code)
Forcibly disable an event code on this device, even if the underlying device provides it...
int libevdev_get_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code)
Return the current value of the code for the given slot.
int libevdev_get_event_value(const struct libevdev *dev, unsigned int type, unsigned int code)
Behaviour of this function is undefined if the device does not provide the event. ...
const char * libevdev_get_name(const struct libevdev *dev)
Retrieve the device's name, either as set by the caller or as read from the kernel.
int libevdev_get_driver_version(const struct libevdev *dev)
int libevdev_get_id_version(const struct libevdev *dev)
int libevdev_get_abs_flat(const struct libevdev *dev, unsigned int code)
Get the axis flat for the given axis, as advertised by the kernel.
int libevdev_next_event(struct libevdev *dev, unsigned int flags, struct input_event *ev)
Get the next event from the device.
const char * libevdev_get_uniq(const struct libevdev *dev)
Retrieve the device's unique identifier, either as set by the caller or as read from the kernel...
Depending on the libevdev_next_event() read flag:
Definition: libevdev.h:1057
int libevdev_property_from_name_n(const char *name, size_t len)
Look up an input property by its name.
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)
Logging function called by library-internal logging.
Definition: libevdev.h:831
int libevdev_new_from_fd(int fd, struct libevdev **dev)
Initialize a new libevdev device from the given fd.
int libevdev_fetch_event_value(const struct libevdev *dev, unsigned int type, unsigned int code, int *value)
Fetch the current value of the event type.
int libevdev_set_event_value(struct libevdev *dev, unsigned int type, unsigned int code, int value)
Set the value for a given event type and code.
int libevdev_kernel_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs)
Set the device's EV_ABS axis to the value defined in the abs parameter.
int libevdev_fetch_slot_value(const struct libevdev *dev, unsigned int slot, unsigned int code, int *value)
Fetch the current value of the code for the given slot.
int libevdev_get_abs_maximum(const struct libevdev *dev, unsigned int code)
Get the maximum axis value for the given axis, as advertised by the kernel.
void libevdev_set_id_bustype(struct libevdev *dev, int bustype)
int libevdev_get_current_slot(const struct libevdev *dev)
Get the currently active slot.
int libevdev_event_is_code(const struct input_event *ev, unsigned int type, unsigned int code)
Helper function to check if an event is of a specific type and code.
int libevdev_event_is_type(const struct input_event *ev, unsigned int type)
Helper function to check if an event is of a specific type.
void libevdev_set_id_version(struct libevdev *dev, int version)
const char * libevdev_property_get_name(unsigned int prop)
#define LIBEVDEV_ATTRIBUTE_PRINTF(_format, _args)
Definition: libevdev.h:33
int libevdev_get_id_product(const struct libevdev *dev)
const char * libevdev_get_phys(const struct libevdev *dev)
Retrieve the device's physical location, either as set by the caller or as read from the kernel...
void libevdev_set_device_log_function(struct libevdev *dev, libevdev_device_log_func_t logfunc, enum libevdev_log_priority priority, void *data)
Set a printf-style logging handler for library-internal logging for this device context.
int libevdev_enable_event_type(struct libevdev *dev, unsigned int type)
Forcibly enable an event type on this device, even if the underlying device does not support it...
int libevdev_kernel_set_led_value(struct libevdev *dev, unsigned int code, enum libevdev_led_value value)
Turn an LED on or off.
int libevdev_set_clock_id(struct libevdev *dev, int clockid)
Set the clock ID to be used for timestamps.
int libevdev_get_num_slots(const struct libevdev *dev)
Get the number of slots supported by this device.
int libevdev_property_from_name(const char *name)
Look up an input property by its name.
void libevdev_set_log_priority(enum libevdev_log_priority priority)
Define the minimum level to be printed to the log handler.
libevdev_next_event() has finished without an error and an event is available for processing...
Definition: libevdev.h:1048
int libevdev_enable_event_code(struct libevdev *dev, unsigned int type, unsigned int code, const void *data)
Forcibly enable an event code on this device, even if the underlying device does not support it...
libevdev_read_flag
Definition: libevdev.h:743
int libevdev_set_fd(struct libevdev *dev, int fd)
Set the fd for this struct and initialize internal data.
int libevdev_kernel_set_led_values(struct libevdev *dev,...)
Turn multiple LEDs on or off simultaneously.
void libevdev_set_abs_flat(struct libevdev *dev, unsigned int code, int flat)
Change the flat for the given EV_ABS event code, if the code exists.
void libevdev_set_phys(struct libevdev *dev, const char *phys)
Change the device's physical location as returned by libevdev_get_phys().
int libevdev_disable_event_type(struct libevdev *dev, unsigned int type)
Forcibly disable an event type on this device, even if the underlying device provides it...
void libevdev_set_abs_info(struct libevdev *dev, unsigned int code, const struct input_absinfo *abs)
Change the abs info for the given EV_ABS event code, if the code exists.
Grab the device if not currently grabbed.
Definition: libevdev.h:942
void libevdev_set_name(struct libevdev *dev, const char *name)
Change the device's name as returned by libevdev_get_name().
void libevdev_free(struct libevdev *dev)
Clean up and free the libevdev struct.
void libevdev_set_abs_minimum(struct libevdev *dev, unsigned int code, int min)
Change the minimum for the given EV_ABS event code, if the code exists.
int libevdev_get_id_vendor(const struct libevdev *dev)
Process data in normal mode.
Definition: libevdev.h:745
libevdev_grab_mode
Definition: libevdev.h:941
libevdev_log_priority
Definition: libevdev.h:809
void libevdev_set_id_product(struct libevdev *dev, int product_id)
struct libevdev * libevdev_new(void)
Initialize a new libevdev device.
Ungrab the device if currently grabbed.
Definition: libevdev.h:943