Free the event queue on cleanup.
[platform/upstream/libevdev.git] / libevdev / libevdev-int.h
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_INT_H
24 #define libevdev_INT_H
25
26 #include <config.h>
27 #include "libevdev.h"
28
29 #define LONG_BITS (sizeof(long) * 8)
30 #define NLONGS(x) (((x) + LONG_BITS - 1) / LONG_BITS)
31 #define ARRAY_LENGTH(a) (sizeof(a) / (sizeof((a)[0])))
32 #define MAX_NAME 256
33 #define MAX_SLOTS 32
34 #define ABS_MT_MIN ABS_MT_SLOT
35 #define ABS_MT_MAX ABS_MT_TOOL_Y
36 #define ABS_MT_CNT (ABS_MT_MAX - ABS_MT_MIN + 1)
37
38 #undef min
39 #undef max
40 #define min(a,b) \
41                 ({ __typeof__ (a) _a = (a); \
42                   __typeof__ (b) _b = (b); \
43                 _a > _b ? _b : _a; \
44                 })
45 #define max(a,b) \
46                 ({ __typeof__ (a) _a = (a); \
47                   __typeof__ (b) _b = (b); \
48                 _a > _b ? _a : _b; \
49                 })
50
51 struct libevdev {
52         int fd;
53         libevdev_log_func_t log;
54
55         char name[MAX_NAME];
56         struct input_id ids;
57         unsigned long bits[NLONGS(EV_CNT)];
58         unsigned long props[NLONGS(INPUT_PROP_CNT)];
59         unsigned long key_bits[NLONGS(KEY_CNT)];
60         unsigned long rel_bits[NLONGS(REL_CNT)];
61         unsigned long abs_bits[NLONGS(ABS_CNT)];
62         unsigned long led_bits[NLONGS(LED_CNT)];
63         unsigned long key_values[NLONGS(KEY_CNT)];
64         struct input_absinfo abs_info[ABS_CNT];
65         unsigned int mt_slot_vals[MAX_SLOTS][ABS_MT_CNT];
66         int num_slots; /**< valid slots in mt_slot_vals */
67         int current_slot;
68
69         int need_sync;
70         int grabbed;
71
72         struct input_event *queue;
73         size_t queue_size; /**< size of queue in elements */
74         size_t queue_next; /**< next event index */
75         size_t queue_nsync; /**< number of sync events */
76 };
77
78 /**
79  * @return a pointer to the next element in the queue, or NULL if the queue
80  * is full.
81  */
82 static inline struct input_event*
83 queue_push(struct libevdev *dev)
84 {
85         if (dev->queue_next >= dev->queue_size)
86                 return NULL;
87
88         return &dev->queue[dev->queue_next++];
89 }
90
91 /**
92  * Set ev to the last element in the queue, removing it from the queue.
93  *
94  * @return 0 on success, 1 if the queue is empty.
95  */
96 static inline int
97 queue_pop(struct libevdev *dev, struct input_event *ev)
98 {
99         if (dev->queue_next == 0)
100                 return 1;
101
102         *ev = dev->queue[--dev->queue_next];
103
104         return 0;
105 }
106
107 static inline int
108 queue_peek(struct libevdev *dev, size_t idx, struct input_event *ev)
109 {
110         if (idx > dev->queue_next)
111                 return 1;
112         *ev = dev->queue[idx];
113         return 0;
114 }
115
116
117 /**
118  * Shift the first n elements into ev and return the number of elements
119  * shifted.
120  * ev must be large enough to store n elements.
121  *
122  * @param ev The buffer to copy into, or NULL
123  * @return The number of elements in ev.
124  */
125 static inline int
126 queue_shift_multiple(struct libevdev *dev, int n, struct input_event *ev)
127 {
128         int i;
129
130         if (dev->queue_next == 0)
131                 return 0;
132
133         n = min(n, dev->queue_next);
134
135         if (ev) {
136                 for (i = 0; i < n; i++)
137                         ev[i] = dev->queue[i];
138         }
139
140         for (i = 0; i < dev->queue_next - n; i++)
141                 dev->queue[i] = dev->queue[n + i];
142
143         dev->queue_next -= n;
144         return n;
145 }
146
147 /**
148  * Set ev to the first element in the queue, shifting everything else
149  * forward by one.
150  *
151  * @return 0 on success, 1 if the queue is empty.
152  */
153 static inline int
154 queue_shift(struct libevdev *dev, struct input_event *ev)
155 {
156         return queue_shift_multiple(dev, 1, ev) == 1 ? 0 : 1;
157 }
158
159 static inline int
160 queue_alloc(struct libevdev *dev, int size)
161 {
162         dev->queue = calloc(size, sizeof(struct input_event));
163         if (!dev->queue)
164                 return -ENOSPC;
165
166         dev->queue_size = size;
167         dev->queue_next = 0;
168         return 0;
169 }
170
171 static inline void
172 queue_free(struct libevdev *dev)
173 {
174         free(dev->queue);
175         dev->queue_size = 0;
176         dev->queue_next = 0;
177 }
178
179 static inline int
180 queue_num_elements(struct libevdev *dev)
181 {
182         return dev->queue_next;
183 }
184
185 static inline int
186 queue_size(struct libevdev *dev)
187 {
188         return dev->queue_size;
189 }
190
191 static inline int
192 queue_num_free_elements(struct libevdev *dev)
193 {
194         return dev->queue_size - dev->queue_next - 1;
195 }
196
197 static inline struct input_event *
198 queue_next_element(struct libevdev *dev)
199 {
200         return &dev->queue[dev->queue_next];
201 }
202
203 static inline int
204 queue_set_num_elements(struct libevdev *dev, int nelem)
205 {
206         if (nelem > dev->queue_size)
207                 return 1;
208
209         dev->queue_next = nelem;
210
211         return 0;
212 }
213 #endif
214