uterm_input: change device 'feature' to device 'capability'
[platform/upstream/kmscon.git] / src / uterm_input.h
1 /*
2  * uterm - Linux User-Space Terminal
3  *
4  * Copyright (c) 2011-2012 David Herrmann <dh.herrmann@googlemail.com>
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining
7  * a copy of this software and associated documentation files
8  * (the "Software"), to deal in the Software without restriction, including
9  * without limitation the rights to use, copy, modify, merge, publish,
10  * distribute, sublicense, and/or sell copies of the Software, and to
11  * permit persons to whom the Software is furnished to do so, subject to
12  * the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included
15  * in all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
20  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
21  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
22  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
23  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24  */
25
26 /* Internal definitions */
27
28 #ifndef UTERM_INPUT_H
29 #define UTERM_INPUT_H
30
31 #include <inttypes.h>
32 #include <limits.h>
33 #include <stdbool.h>
34 #include <stdlib.h>
35 #include <xkbcommon/xkbcommon-keysyms.h>
36 #include "eloop.h"
37 #include "shl_dlist.h"
38 #include "uterm.h"
39
40 enum uterm_input_device_capability {
41         UTERM_DEVICE_HAS_KEYS = (1 << 0),
42         UTERM_DEVICE_HAS_LEDS = (1 << 1),
43 };
44
45 struct uterm_input_dev {
46         struct shl_dlist list;
47         struct uterm_input *input;
48
49         unsigned int capabilities;
50         int rfd;
51         char *node;
52         struct ev_fd *fd;
53         struct xkb_state *state;
54
55         unsigned int num_syms;
56         struct uterm_input_event event;
57         struct uterm_input_event repeat_event;
58
59         bool repeating;
60         struct ev_timer *repeat_timer;
61 };
62
63 struct uterm_input {
64         unsigned long ref;
65         struct ev_eloop *eloop;
66         int awake;
67         unsigned int repeat_rate;
68         unsigned int repeat_delay;
69
70         struct shl_hook *hook;
71         struct xkb_context *ctx;
72         struct xkb_keymap *keymap;
73
74         struct shl_dlist devices;
75 };
76
77 static inline bool input_bit_is_set(const unsigned long *array, int bit)
78 {
79         return !!(array[bit / LONG_BIT] & (1LL << (bit % LONG_BIT)));
80 }
81
82 int uxkb_desc_init(struct uterm_input *input,
83                    const char *layout,
84                    const char *variant,
85                    const char *options);
86 void uxkb_desc_destroy(struct uterm_input *input);
87
88 int uxkb_dev_init(struct uterm_input_dev *dev);
89 void uxkb_dev_destroy(struct uterm_input_dev *dev);
90 int uxkb_dev_process(struct uterm_input_dev *dev,
91                      uint16_t key_state,
92                      uint16_t code);
93 void uxkb_dev_reset(struct uterm_input_dev *dev);
94
95 #endif /* UTERM_INPUT_H */