1 |
/*----------------------------------------------------------------------* |
2 |
* File: keyboard.C |
3 |
*----------------------------------------------------------------------* |
4 |
* |
5 |
* All portions of code are copyright by their respective author/s. |
6 |
* Copyright (c) 2005 WU Fengguang |
7 |
* Copyright (c) 2005-2006 Marc Lehmann <schmorp@schmorp.de> |
8 |
* Copyright (c) 2015 Emanuele Giaquinta <e.giaquinta@glauco.it> |
9 |
* |
10 |
* This program is free software; you can redistribute it and/or modify |
11 |
* it under the terms of the GNU General Public License as published by |
12 |
* the Free Software Foundation; either version 3 of the License, or |
13 |
* (at your option) any later version. |
14 |
* |
15 |
* This program is distributed in the hope that it will be useful, |
16 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
17 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
18 |
* GNU General Public License for more details. |
19 |
* |
20 |
* You should have received a copy of the GNU General Public License |
21 |
* along with this program; if not, write to the Free Software |
22 |
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
23 |
*----------------------------------------------------------------------*/ |
24 |
|
25 |
#include "../config.h" |
26 |
#include "rxvt.h" |
27 |
|
28 |
#ifdef KEYSYM_RESOURCE |
29 |
|
30 |
#include <string.h> |
31 |
|
32 |
#include "rxvtperl.h" |
33 |
#include "keyboard.h" |
34 |
|
35 |
/* an intro to the data structure: |
36 |
* |
37 |
* vector keymap[] is grouped. |
38 |
* |
39 |
* inside each group, elements are sorted by the criteria given by compare_priority(). |
40 |
* the lookup of keysym is done in two steps: |
41 |
* 1) locate the group corresponds to the keysym; |
42 |
* 2) do a linear search inside the group. |
43 |
* |
44 |
* array hash[] effectively defines a map from a keysym to a group in keymap[]. |
45 |
* |
46 |
* each group has its address(the index of first group element in keymap[]), |
47 |
* which is computed and stored in hash[]. |
48 |
* hash[] stores the addresses in the form of: |
49 |
* index: 0 I1 I2 I3 In |
50 |
* value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An |
51 |
* where |
52 |
* A1 = 0; |
53 |
* Ai+1 = N1 + N2 + ... + Ni. |
54 |
* it is computed from hash_bucket_size[]: |
55 |
* index: 0 I1 I2 I3 In |
56 |
* value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0 |
57 |
* 0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the computation of hash[]) |
58 |
* or we can say |
59 |
* hash_bucket_size[Ii] = Ni; hash_bucket_size[elsewhere] = 0, |
60 |
* where |
61 |
* set {I1, I2, ..., In} = { hashkey of keymap[0]->keysym, ..., keymap[keymap.size-1]->keysym } |
62 |
* where hashkey of keymap[i]->keysym = keymap[i]->keysym & KEYSYM_HASH_MASK |
63 |
* n(the number of groups) = the number of non-zero member of hash_bucket_size[]; |
64 |
* Ni(the size of group i) = hash_bucket_size[Ii]. |
65 |
*/ |
66 |
|
67 |
// return: priority_of_a - priority_of_b |
68 |
static int |
69 |
compare_priority (keysym_t *a, keysym_t *b) |
70 |
{ |
71 |
// (the more '1's in state; the less range): the greater priority |
72 |
int ca = ecb_popcount32 (a->state /* & OtherModMask */); |
73 |
int cb = ecb_popcount32 (b->state /* & OtherModMask */); |
74 |
|
75 |
return ca - cb; |
76 |
} |
77 |
|
78 |
//////////////////////////////////////////////////////////////////////////////// |
79 |
keyboard_manager::keyboard_manager () |
80 |
{ |
81 |
keymap.reserve (256); |
82 |
hash [0] = 1; // hash[0] != 0 indicates uninitialized data |
83 |
} |
84 |
|
85 |
keyboard_manager::~keyboard_manager () |
86 |
{ |
87 |
for (unsigned int i = 0; i < keymap.size (); ++i) |
88 |
{ |
89 |
free (keymap [i]->str); |
90 |
delete keymap [i]; |
91 |
} |
92 |
} |
93 |
|
94 |
void |
95 |
keyboard_manager::unregister_action (KeySym keysym, unsigned int state) |
96 |
{ |
97 |
for (unsigned int i = 0; i < keymap.size (); ++i) |
98 |
if (keymap [i]->keysym == keysym |
99 |
&& keymap [i]->state == state) |
100 |
{ |
101 |
free (keymap [i]->str); |
102 |
delete keymap [i]; |
103 |
|
104 |
if (i < keymap.size () - 1) |
105 |
keymap [i] = keymap [keymap.size () - 1]; |
106 |
keymap.pop_back (); |
107 |
|
108 |
break; |
109 |
} |
110 |
} |
111 |
|
112 |
void |
113 |
keyboard_manager::register_action (KeySym keysym, unsigned int state, const wchar_t *ws) |
114 |
{ |
115 |
char *action = rxvt_wcstoutf8 (ws); |
116 |
|
117 |
keysym_t *key = new keysym_t; |
118 |
|
119 |
key->keysym = keysym; |
120 |
key->state = state; |
121 |
key->str = action; |
122 |
key->type = keysym_t::STRING; |
123 |
|
124 |
if (strncmp (action, "builtin:", 8) == 0) |
125 |
key->type = keysym_t::BUILTIN; |
126 |
else if (strncmp (action, "builtin-string:", 15) == 0) |
127 |
key->type = keysym_t::BUILTIN_STRING; |
128 |
|
129 |
unregister_action (keysym, state); |
130 |
|
131 |
if (keymap.size () == keymap.capacity ()) |
132 |
keymap.reserve (keymap.size () * 2); |
133 |
|
134 |
keymap.push_back (key); |
135 |
hash[0] = 3; |
136 |
} |
137 |
|
138 |
keysym_t * |
139 |
keyboard_manager::lookup_keysym (rxvt_term *term, KeySym keysym, unsigned int state) |
140 |
{ |
141 |
assert (("register_done() need to be called", hash[0] == 0)); |
142 |
|
143 |
state &= OtherModMask; // mask out uninteresting modifiers |
144 |
|
145 |
if (state & term->ModMetaMask) state |= MetaMask; |
146 |
if (state & term->ModNumLockMask) state |= NumLockMask; |
147 |
if (state & term->ModLevel3Mask) state |= Level3Mask; |
148 |
|
149 |
if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask)) |
150 |
state |= AppKeypadMask; |
151 |
|
152 |
int index = find_keysym (keysym, state); |
153 |
|
154 |
return index >= 0 ? keymap [index] : 0; |
155 |
} |
156 |
|
157 |
bool |
158 |
keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state, const char *kbuf, int len) |
159 |
{ |
160 |
keysym_t *key = lookup_keysym (term, keysym, state); |
161 |
|
162 |
if (key) |
163 |
{ |
164 |
if (key->type == keysym_t::BUILTIN_STRING) |
165 |
{ |
166 |
term->tt_write_user_input (kbuf, len); |
167 |
return true; |
168 |
} |
169 |
else if (key->type != keysym_t::BUILTIN) |
170 |
{ |
171 |
wchar_t *ws = rxvt_utf8towcs (key->str); |
172 |
char *str = rxvt_wcstombs (ws); |
173 |
// TODO: do (some) translations, unescaping etc, here (allow \u escape etc.) |
174 |
free (ws); |
175 |
|
176 |
if (char *colon = strchr (str, ':')) |
177 |
{ |
178 |
if (strncmp (str, "command:", 8) == 0) |
179 |
term->cmdbuf_append (str + 8, strlen (str) - 8); |
180 |
else if (strncmp (str, "string:", 7) == 0) |
181 |
term->tt_write_user_input (colon + 1, strlen (colon + 1)); |
182 |
else if (strncmp (str, "perl:", 5) == 0) |
183 |
HOOK_INVOKE ((term, HOOK_USER_COMMAND, DT_STR, colon + 1, DT_END)); |
184 |
else |
185 |
HOOK_INVOKE ((term, HOOK_ACTION, DT_STR_LEN, str, colon - str, DT_STR, colon + 1, DT_INT, 0, DT_STR_LEN, kbuf, len, DT_END)); |
186 |
} |
187 |
else |
188 |
term->tt_write_user_input (str, strlen (str)); |
189 |
|
190 |
free (str); |
191 |
|
192 |
return true; |
193 |
} |
194 |
} |
195 |
|
196 |
return false; |
197 |
} |
198 |
|
199 |
void |
200 |
keyboard_manager::register_done () |
201 |
{ |
202 |
unsigned int i, index, hashkey; |
203 |
uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket |
204 |
|
205 |
memset (hash_bucket_size, 0, sizeof (hash_bucket_size)); |
206 |
|
207 |
// determine hash bucket size |
208 |
for (i = 0; i < keymap.size (); ++i) |
209 |
{ |
210 |
hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK; |
211 |
++hash_bucket_size [hashkey]; |
212 |
} |
213 |
|
214 |
// now we know the size of each bucket |
215 |
// compute the index of each bucket |
216 |
for (index = 0, i = 0; i < KEYSYM_HASH_BUCKETS; ++i) |
217 |
{ |
218 |
hash [i] = index; |
219 |
index += hash_bucket_size [i]; |
220 |
} |
221 |
|
222 |
// and allocate just enough space |
223 |
simplevec <keysym_t *> sorted_keymap (index, 0); |
224 |
|
225 |
memset (hash_bucket_size, 0, sizeof (hash_bucket_size)); |
226 |
|
227 |
// fill in sorted_keymap |
228 |
// it is sorted in each bucket |
229 |
for (i = 0; i < keymap.size (); ++i) |
230 |
{ |
231 |
hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK; |
232 |
|
233 |
index = hash [hashkey] + hash_bucket_size [hashkey]; |
234 |
|
235 |
while (index > hash [hashkey] |
236 |
&& compare_priority (keymap [i], sorted_keymap [index - 1]) > 0) |
237 |
{ |
238 |
sorted_keymap [index] = sorted_keymap [index - 1]; |
239 |
--index; |
240 |
} |
241 |
|
242 |
sorted_keymap [index] = keymap [i]; |
243 |
++hash_bucket_size [hashkey]; |
244 |
} |
245 |
|
246 |
keymap.swap (sorted_keymap); |
247 |
|
248 |
#ifndef NDEBUG |
249 |
// check for invariants |
250 |
for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i) |
251 |
{ |
252 |
index = hash[i]; |
253 |
for (int j = 0; j < hash_bucket_size [i]; ++j) |
254 |
{ |
255 |
assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK)); |
256 |
|
257 |
if (j) |
258 |
assert (compare_priority (keymap [index + j - 1], |
259 |
keymap [index + j]) >= 0); |
260 |
} |
261 |
} |
262 |
|
263 |
// this should be able to detect most possible bugs |
264 |
for (i = 0; i < sorted_keymap.size (); ++i) |
265 |
{ |
266 |
keysym_t *a = sorted_keymap[i]; |
267 |
int index = find_keysym (a->keysym, a->state); |
268 |
|
269 |
assert (index >= 0); |
270 |
keysym_t *b = keymap [index]; |
271 |
assert (i == index // the normally expected result |
272 |
|| a->keysym == b->keysym |
273 |
&& compare_priority (a, b) <= 0); // is effectively the same or a closer match |
274 |
} |
275 |
#endif |
276 |
} |
277 |
|
278 |
int |
279 |
keyboard_manager::find_keysym (KeySym keysym, unsigned int state) |
280 |
{ |
281 |
int hashkey = keysym & KEYSYM_HASH_MASK; |
282 |
unsigned int index = hash [hashkey]; |
283 |
unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1 |
284 |
? hash [hashkey + 1] |
285 |
: keymap.size (); |
286 |
|
287 |
for (; index < end; ++index) |
288 |
{ |
289 |
keysym_t *key = keymap [index]; |
290 |
|
291 |
if (key->keysym == keysym |
292 |
// match only the specified bits in state and ignore others |
293 |
&& (key->state & state) == key->state) |
294 |
return index; |
295 |
} |
296 |
|
297 |
return -1; |
298 |
} |
299 |
|
300 |
#endif /* KEYSYM_RESOURCE */ |
301 |
// vim:et:ts=2:sw=2 |