libwacom
Wacom model identification library
libwacom.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2011 Red Hat, Inc.
3  *
4  * Permission to use, copy, modify, distribute, and sell this software
5  * and its documentation for any purpose is hereby granted without
6  * fee, provided that the above copyright notice appear in all copies
7  * and that both that copyright notice and this permission notice
8  * appear in supporting documentation, and that the name of Red Hat
9  * not be used in advertising or publicity pertaining to distribution
10  * of the software without specific, written prior permission. Red
11  * Hat makes no representations about the suitability of this software
12  * for any purpose. It is provided "as is" without express or implied
13  * warranty.
14  *
15  * THE AUTHORS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
16  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
17  * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
18  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
19  * OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
20  * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
21  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22  *
23  * Authors:
24  * Peter Hutterer (peter.hutterer@redhat.com)
25  */
26 
27 
29 #ifndef _LIBWACOM_H_
30 #define _LIBWACOM_H_
31 
33 #include <stdint.h>
34 #include <stdio.h>
35 
36 #if defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 301)
37 #define LIBWACOM_DEPRECATED __attribute__((deprecated))
38 #else
39 #define LIBWACOM_DEPRECATED
40 #endif /* __GNUC__ */
41 
85 typedef struct _WacomDevice WacomDevice;
86 
87 typedef struct _WacomMatch WacomMatch;
88 
89 typedef struct _WacomStylus WacomStylus;
90 
91 typedef struct _WacomError WacomError;
92 
93 typedef struct _WacomDeviceDatabase WacomDeviceDatabase;
94 
95 #define WACOM_STYLUS_FALLBACK_ID 0xfffff
96 #define WACOM_ERASER_FALLBACK_ID 0xffffe
97 
108 };
109 
113 typedef enum {
119 } WacomBusType;
120 
124 typedef enum {
129 
133 typedef enum {
146 } WacomClass;
147 
151 typedef enum {
161 
165 typedef enum {
175  WACOM_BUTTON_OLED = (1 << 9),
181 
185 typedef enum {
198 
199 typedef enum {
203 
204 typedef enum {
206  WCOMPARE_MATCHES = (1 << 1),
208 
209 typedef enum {
216 
224 
232 void libwacom_error_free(WacomError **error);
233 
238 
242 const char* libwacom_error_get_message(WacomError *error);
243 
251 
261 
268 
281 WacomDevice* libwacom_new_from_path(const WacomDeviceDatabase *db, const char *path, WacomFallbackFlags fallback, WacomError *error);
282 
295 WacomDevice* libwacom_new_from_usbid(const WacomDeviceDatabase *db, int vendor_id, int product_id, WacomError *error);
296 
308 WacomDevice* libwacom_new_from_name(const WacomDeviceDatabase *db, const char *name, WacomError *error);
309 
322 
329 void libwacom_print_device_description (int fd, const WacomDevice *device);
330 
331 
337 void libwacom_destroy(WacomDevice *device);
338 
348 int libwacom_compare(const WacomDevice *a, const WacomDevice *b, WacomCompareFlags flags);
349 
355 
360 const char* libwacom_get_name(const WacomDevice *device);
361 
367 const char* libwacom_get_layout_filename(const WacomDevice *device);
368 
373 int libwacom_get_vendor_id(const WacomDevice *device);
374 
380 const char* libwacom_get_match(const WacomDevice *device);
381 
387 const WacomMatch** libwacom_get_matches(const WacomDevice *device);
388 
393 int libwacom_get_product_id(const WacomDevice *device);
394 
403 int libwacom_get_width(const WacomDevice *device);
404 
413 int libwacom_get_height(const WacomDevice *device);
414 
419 int libwacom_has_stylus(const WacomDevice *device);
420 
425 int libwacom_has_touch(const WacomDevice *device);
426 
433 int libwacom_get_num_buttons(const WacomDevice *device);
434 
440 const int *libwacom_get_supported_styli(const WacomDevice *device, int *num_styli);
441 
446 int libwacom_has_ring(const WacomDevice *device);
447 
452 int libwacom_has_ring2(const WacomDevice *device);
453 
458 int libwacom_has_touchswitch(const WacomDevice *device);
459 
464 int libwacom_get_ring_num_modes(const WacomDevice *device);
465 
470 int libwacom_get_ring2_num_modes(const WacomDevice *device);
471 
477 int libwacom_get_num_strips(const WacomDevice *device);
478 
483 int libwacom_get_strips_num_modes(const WacomDevice *device);
484 
490 const WacomStatusLEDs *libwacom_get_status_leds(const WacomDevice *device, int *num_leds);
491 
498 int libwacom_get_button_led_group (const WacomDevice *device,
499  char button);
500 
508 
514 int libwacom_is_reversible(const WacomDevice *device);
515 
521 
527 
534  char button);
535 
544 
549 int libwacom_stylus_get_id (const WacomStylus *stylus);
550 
555 const char *libwacom_stylus_get_name (const WacomStylus *stylus);
556 
561 int libwacom_stylus_get_num_buttons (const WacomStylus *stylus);
562 
567 int libwacom_stylus_has_eraser (const WacomStylus *stylus);
568 
573 int libwacom_stylus_is_eraser (const WacomStylus *stylus);
574 
579 int libwacom_stylus_has_lens (const WacomStylus *stylus);
580 
585 int libwacom_stylus_has_wheel (const WacomStylus *stylus);
586 
592 
598 
605 void libwacom_print_stylus_description (int fd, const WacomStylus *stylus);
606 
607 const char *libwacom_match_get_name(const WacomMatch *match);
609 uint32_t libwacom_match_get_product_id(const WacomMatch *match);
610 uint32_t libwacom_match_get_vendor_id(const WacomMatch *match);
611 const char* libwacom_match_get_match_string(const WacomMatch *match);
612 
614 #endif /* _LIBWACOM_H_ */
615 
617 /* vim: set noexpandtab tabstop=8 shiftwidth=8: */
const WacomStatusLEDs * libwacom_get_status_leds(const WacomDevice *device, int *num_leds)
Definition: libwacom.h:176
Definition: libwacom.h:125
struct _WacomMatch WacomMatch
Definition: libwacom.h:87
Definition: libwacom.h:175
Tip pressure.
Definition: libwacom.h:194
WacomButtonFlags
Capabilities of the various tablet buttons.
Definition: libwacom.h:165
Definition: libwacom.h:211
const WacomStylus * libwacom_stylus_get_for_id(const WacomDeviceDatabase *db, int id)
Get the WacomStylus for the given tool ID.
Unknown/unsupported device class.
Definition: libwacom.h:134
Any Graphire device.
Definition: libwacom.h:140
Unsupported/unknown device.
Definition: libwacom.h:107
const char * libwacom_get_match(const WacomDevice *device)
compare all possible matches too
Definition: libwacom.h:206
Definition: libwacom.h:179
enum WacomErrorCode libwacom_error_get_code(WacomError *error)
WacomClass
Classes of devices.
Definition: libwacom.h:133
Any Intuos2 series.
Definition: libwacom.h:143
Definition: libwacom.h:200
int libwacom_has_touch(const WacomDevice *device)
struct _WacomError WacomError
Definition: libwacom.h:91
Serial tablet.
Definition: libwacom.h:116
No error has occured.
Definition: libwacom.h:102
Definition: libwacom.h:156
Definition: libwacom.h:170
Definition: libwacom.h:155
int libwacom_has_ring(const WacomDevice *device)
Definition: libwacom.h:213
void libwacom_error_free(WacomError **error)
Free the error and associated memory.
WacomAxisTypeFlags
Axis type for a stylus.
Definition: libwacom.h:185
WacomErrorCode
Possible error codes.
Definition: libwacom.h:101
Any Intuos4 series.
Definition: libwacom.h:136
Definition: libwacom.h:210
int libwacom_stylus_get_num_buttons(const WacomStylus *stylus)
int libwacom_stylus_is_eraser(const WacomStylus *stylus)
Any Wacom Remote.
Definition: libwacom.h:145
Definition: libwacom.h:178
const WacomMatch ** libwacom_get_matches(const WacomDevice *device)
int libwacom_get_ring2_num_modes(const WacomDevice *device)
WacomButtonFlags libwacom_get_button_flag(const WacomDevice *device, char button)
int libwacom_get_num_strips(const WacomDevice *device)
void libwacom_destroy(WacomDevice *device)
Remove the device and free all memory and references to it.
Definition: libwacom.h:173
int libwacom_has_stylus(const WacomDevice *device)
int libwacom_get_button_led_group(const WacomDevice *device, char button)
struct _WacomDevice WacomDevice
Definition: libwacom.h:85
WacomStylusType libwacom_stylus_get_type(const WacomStylus *stylus)
const char * libwacom_match_get_match_string(const WacomMatch *match)
WacomCompareFlags
Definition: libwacom.h:204
Definition: libwacom.h:186
Definition: libwacom.h:154
uint32_t libwacom_match_get_vendor_id(const WacomMatch *match)
WacomDeviceDatabase * libwacom_database_new(void)
Loads the Tablet and Stylus databases, to be used in libwacom_new_*() functions.
Definition: libwacom.h:168
Any Bamboo device.
Definition: libwacom.h:139
Definition: libwacom.h:171
Definition: libwacom.h:167
Definition: libwacom.h:126
Distance to surface.
Definition: libwacom.h:192
Unknown/unsupported bus type.
Definition: libwacom.h:114
const int * libwacom_get_supported_styli(const WacomDevice *device, int *num_styli)
struct _WacomStylus WacomStylus
Definition: libwacom.h:89
Tilt in x and y direction.
Definition: libwacom.h:188
Definition: libwacom.h:127
uint32_t libwacom_match_get_product_id(const WacomMatch *match)
Allocation error.
Definition: libwacom.h:103
const char * libwacom_stylus_get_name(const WacomStylus *stylus)
const char * libwacom_match_get_name(const WacomMatch *match)
Any "interactive pen display".
Definition: libwacom.h:144
const char * libwacom_error_get_message(WacomError *error)
int libwacom_stylus_has_wheel(const WacomStylus *stylus)
Definition: libwacom.h:166
Definition: libwacom.h:201
int libwacom_has_touchswitch(const WacomDevice *device)
WacomClass libwacom_get_class(const WacomDevice *device)
int libwacom_get_ring_num_modes(const WacomDevice *device)
int libwacom_get_num_buttons(const WacomDevice *device)
Tablet buttons are numbered 'A' through to 'A' + number of buttons.
#define LIBWACOM_DEPRECATED
Definition: libwacom.h:39
WacomDevice ** libwacom_list_devices_from_database(const WacomDeviceDatabase *db, WacomError *error)
Returns the list of devices in the given database.
Any Intuos5 series.
Definition: libwacom.h:137
WacomAxisTypeFlags libwacom_stylus_get_axes(const WacomStylus *stylus)
Definition: libwacom.h:214
Definition: libwacom.h:159
WacomStatusLEDs
Definition: libwacom.h:209
A absolute-position slider like the wheel on the airbrush.
Definition: libwacom.h:196
void libwacom_print_stylus_description(int fd, const WacomStylus *stylus)
Print the description of this stylus to the given file.
WacomBusType libwacom_get_bustype(const WacomDevice *device)
void libwacom_database_destroy(WacomDeviceDatabase *db)
Free all memory used by the database.
WacomBusType
Bus types for tablets.
Definition: libwacom.h:113
Definition: libwacom.h:169
WacomError * libwacom_error_new(void)
Allocate a new structure for error reporting.
int libwacom_get_vendor_id(const WacomDevice *device)
Definition: libwacom.h:177
Any Intuos series.
Definition: libwacom.h:142
A path specified is invalid.
Definition: libwacom.h:104
Definition: libwacom.h:157
WacomIntegrationFlags
Tablet integration.
Definition: libwacom.h:124
Definition: libwacom.h:212
int libwacom_stylus_has_lens(const WacomStylus *stylus)
WacomStylusType
Class of stylus.
Definition: libwacom.h:151
int libwacom_get_strips_num_modes(const WacomDevice *device)
WacomDeviceDatabase * libwacom_database_new_for_path(const char *datadir)
Loads the Tablet and Stylus databases, to be used in libwacom_new_*() functions, from the prefix path...
Bluetooth tablet.
Definition: libwacom.h:117
Any Intuos3 series.
Definition: libwacom.h:135
int libwacom_is_reversible(const WacomDevice *device)
int libwacom_stylus_has_eraser(const WacomStylus *stylus)
int libwacom_is_builtin(const WacomDevice *device) LIBWACOM_DEPRECATED
Definition: libwacom.h:158
WacomDevice * libwacom_new_from_name(const WacomDeviceDatabase *db, const char *name, WacomError *error)
Create a new device reference from the given name.
const char * libwacom_get_layout_filename(const WacomDevice *device)
const char * libwacom_get_name(const WacomDevice *device)
WacomDevice * libwacom_new_from_usbid(const WacomDeviceDatabase *db, int vendor_id, int product_id, WacomError *error)
Create a new device reference from the given vendor/product IDs.
Definition: libwacom.h:174
int libwacom_get_width(const WacomDevice *device)
Retrieve the width of the device.
Any serial ISDV4 device.
Definition: libwacom.h:141
struct _WacomDeviceDatabase WacomDeviceDatabase
Definition: libwacom.h:93
Rotation in the z-axis.
Definition: libwacom.h:190
compare the device only
Definition: libwacom.h:205
The passed DB is invalid.
Definition: libwacom.h:105
WacomBusType libwacom_match_get_bustype(const WacomMatch *match)
void libwacom_print_device_description(int fd, const WacomDevice *device)
Print the description of this device to the given file.
Definition: libwacom.h:172
Invalid permissions to access the path.
Definition: libwacom.h:106
int libwacom_compare(const WacomDevice *a, const WacomDevice *b, WacomCompareFlags flags)
Compare the two devices for equal-ness.
int libwacom_get_product_id(const WacomDevice *device)
Definition: libwacom.h:152
WacomDevice * libwacom_new_from_path(const WacomDeviceDatabase *db, const char *path, WacomFallbackFlags fallback, WacomError *error)
Create a new device reference from the given device path.
USB tablet.
Definition: libwacom.h:115
WacomIntegrationFlags libwacom_get_integration_flags(const WacomDevice *device)
WacomFallbackFlags
Definition: libwacom.h:199
int libwacom_get_height(const WacomDevice *device)
Retrieve the height of the device.
int libwacom_stylus_get_id(const WacomStylus *stylus)
int libwacom_has_ring2(const WacomDevice *device)
I2C tablet.
Definition: libwacom.h:118
Definition: libwacom.h:153
Any Cintiq device.
Definition: libwacom.h:138