1 |
#include "../config.h" |
2 |
#include "rxvt.h" |
3 |
|
4 |
#ifdef KEYSYM_RESOURCE |
5 |
|
6 |
#include <cstring> |
7 |
|
8 |
#include "keyboard.h" |
9 |
#include "command.h" |
10 |
|
11 |
/* an intro to the data structure: |
12 |
* |
13 |
* vector keymap[] is grouped. |
14 |
* |
15 |
* inside each group, elements are sorted by the criteria given by compare_priority(). |
16 |
* the lookup of keysym is done in two steps: |
17 |
* 1) locate the group corresponds to the keysym; |
18 |
* 2) do a linear search inside the group. |
19 |
* |
20 |
* array hash[] effectively defines a map from a keysym to a group in keymap[]. |
21 |
* |
22 |
* each group has its address(the index of first group element in keymap[]), |
23 |
* which is computed and stored in hash[]. |
24 |
* hash[] stores the addresses in the form of: |
25 |
* index: 0 I1 I2 I3 In |
26 |
* value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An |
27 |
* where |
28 |
* A1 = 0; |
29 |
* Ai+1 = N1 + N2 + ... + Ni. |
30 |
* it is computed from hash_budget_size[]: |
31 |
* index: 0 I1 I2 I3 In |
32 |
* value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0 |
33 |
* 0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the compution of hash[]) |
34 |
* or we can say |
35 |
* hash_budget_size[Ii] = Ni; hash_budget_size[elsewhere] = 0, |
36 |
* where |
37 |
* set {I1, I2, ..., In} = { hashkey of keymap[0]->keysym, ..., keymap[keymap.size-1]->keysym } |
38 |
* where hashkey of keymap[i]->keysym = keymap[i]->keysym & KEYSYM_HASH_MASK |
39 |
* n(the number of groups) = the number of non-zero member of hash_budget_size[]; |
40 |
* Ni(the size of group i) = hash_budget_size[Ii]. |
41 |
*/ |
42 |
|
43 |
#if STOCK_KEYMAP |
44 |
//////////////////////////////////////////////////////////////////////////////// |
45 |
// default keycode translation map and keyevent handlers |
46 |
|
47 |
keysym_t keyboard_manager::stock_keymap[] = { |
48 |
/* examples */ |
49 |
/* keysym, state, range, handler, str */ |
50 |
//{XK_ISO_Left_Tab, 0, 1, keysym_t::NORMAL, "\033[Z"}, |
51 |
//{ 'a', 0, 26, keysym_t::RANGE_META8, "a" "%c"}, |
52 |
//{ 'a', ControlMask, 26, keysym_t::RANGE_META8, "" "%c"}, |
53 |
//{ XK_Left, 0, 4, keysym_t::LIST, ".\033[.DACB."}, |
54 |
//{ XK_Left, ShiftMask, 4, keysym_t::LIST, ".\033[.dacb."}, |
55 |
//{ XK_Left, ControlMask, 4, keysym_t::LIST, ".\033O.dacb."}, |
56 |
//{ XK_Tab, ControlMask, 1, keysym_t::NORMAL, "\033<C-Tab>"}, |
57 |
//{ XK_apostrophe, ControlMask, 1, keysym_t::NORMAL, "\033<C-'>"}, |
58 |
//{ XK_slash, ControlMask, 1, keysym_t::NORMAL, "\033<C-/>"}, |
59 |
//{ XK_semicolon, ControlMask, 1, keysym_t::NORMAL, "\033<C-;>"}, |
60 |
//{ XK_grave, ControlMask, 1, keysym_t::NORMAL, "\033<C-`>"}, |
61 |
//{ XK_comma, ControlMask, 1, keysym_t::NORMAL, "\033<C-\054>"}, |
62 |
//{ XK_Return, ControlMask, 1, keysym_t::NORMAL, "\033<C-Return>"}, |
63 |
//{ XK_Return, ShiftMask, 1, keysym_t::NORMAL, "\033<S-Return>"}, |
64 |
//{ ' ', ShiftMask, 1, keysym_t::NORMAL, "\033<S-Space>"}, |
65 |
//{ '.', ControlMask, 1, keysym_t::NORMAL, "\033<C-.>"}, |
66 |
//{ '0', ControlMask, 10, keysym_t::RANGE, "0" "\033<C-%c>"}, |
67 |
//{ '0', MetaMask|ControlMask, 10, keysym_t::RANGE, "0" "\033<M-C-%c>"}, |
68 |
//{ 'a', MetaMask|ControlMask, 26, keysym_t::RANGE, "a" "\033<M-C-%c>"}, |
69 |
}; |
70 |
#endif |
71 |
|
72 |
static void |
73 |
output_string (rxvt_term *rt, const char *str) |
74 |
{ |
75 |
if (strncmp (str, "command:", 8) == 0) |
76 |
rt->cmd_write ((unsigned char *)str + 8, strlen (str) - 8); |
77 |
else |
78 |
rt->tt_write ((unsigned char *)str, strlen (str)); |
79 |
} |
80 |
|
81 |
static void |
82 |
output_string_meta8 (rxvt_term *rt, unsigned int state, char *buf, int buflen) |
83 |
{ |
84 |
if (state & rt->ModMetaMask) |
85 |
{ |
86 |
#ifdef META8_OPTION |
87 |
if (rt->meta_char == 0x80) /* set 8-bit on */ |
88 |
{ |
89 |
for (char *ch = buf; ch < buf + buflen; ch++) |
90 |
*ch |= 0x80; |
91 |
} |
92 |
else if (rt->meta_char == C0_ESC) /* escape prefix */ |
93 |
#endif |
94 |
{ |
95 |
const unsigned char ch = C0_ESC; |
96 |
rt->tt_write (&ch, 1); |
97 |
} |
98 |
} |
99 |
|
100 |
rt->tt_write ((unsigned char *) buf, buflen); |
101 |
} |
102 |
|
103 |
static int |
104 |
format_keyrange_string (const char *str, int keysym_offset, char *buf, int bufsize) |
105 |
{ |
106 |
size_t len = snprintf (buf, bufsize, str + 1, keysym_offset + str [0]); |
107 |
|
108 |
if (len >= (size_t)bufsize) |
109 |
{ |
110 |
rxvt_warn ("format_keyrange_string: formatting failed, ignoring key.\n"); |
111 |
*buf = 0; |
112 |
} |
113 |
|
114 |
return len; |
115 |
} |
116 |
|
117 |
//////////////////////////////////////////////////////////////////////////////// |
118 |
// return: #bits of '1' |
119 |
#if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 3) |
120 |
# define bitcount(n) (__extension__ ({ uint32_t n__ = (n); __builtin_popcount (n); })) |
121 |
#else |
122 |
static int |
123 |
bitcount (uint16_t n) |
124 |
{ |
125 |
int i; |
126 |
|
127 |
for (i = 0; n; ++i, n &= n - 1) |
128 |
; |
129 |
|
130 |
return i; |
131 |
} |
132 |
#endif |
133 |
|
134 |
// return: priority_of_a - priority_of_b |
135 |
static int |
136 |
compare_priority (keysym_t *a, keysym_t *b) |
137 |
{ |
138 |
// (the more '1's in state; the less range): the greater priority |
139 |
int ca = bitcount (a->state /* & OtherModMask */); |
140 |
int cb = bitcount (b->state /* & OtherModMask */); |
141 |
|
142 |
if (ca != cb) |
143 |
return ca - cb; |
144 |
//else if (a->state != b->state) // this behavior is to be disscussed |
145 |
// return b->state - a->state; |
146 |
else |
147 |
return b->range - a->range; |
148 |
} |
149 |
|
150 |
//////////////////////////////////////////////////////////////////////////////// |
151 |
keyboard_manager::keyboard_manager () |
152 |
{ |
153 |
keymap.reserve (256); |
154 |
hash [0] = 1; // hash[0] != 0 indicates uninitialized data |
155 |
} |
156 |
|
157 |
keyboard_manager::~keyboard_manager () |
158 |
{ |
159 |
clear (); |
160 |
} |
161 |
|
162 |
void |
163 |
keyboard_manager::clear () |
164 |
{ |
165 |
keymap.clear (); |
166 |
hash [0] = 2; |
167 |
|
168 |
for (unsigned int i = 0; i < user_translations.size (); ++i) |
169 |
{ |
170 |
free ((void *)user_translations [i]); |
171 |
user_translations [i] = 0; |
172 |
} |
173 |
|
174 |
for (unsigned int i = 0; i < user_keymap.size (); ++i) |
175 |
{ |
176 |
delete user_keymap [i]; |
177 |
user_keymap [i] = 0; |
178 |
} |
179 |
|
180 |
user_keymap.clear (); |
181 |
user_translations.clear (); |
182 |
} |
183 |
|
184 |
// a wrapper for register_keymap, |
185 |
// so that outside codes don't have to know so much details. |
186 |
// |
187 |
// the string 'trans' is copied to an internal managed buffer, |
188 |
// so the caller can free memory of 'trans' at any time. |
189 |
void |
190 |
keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans) |
191 |
{ |
192 |
keysym_t *key = new keysym_t; |
193 |
wchar_t *wc = rxvt_mbstowcs (trans); |
194 |
const char *translation = rxvt_wcstoutf8 (wc); |
195 |
free (wc); |
196 |
|
197 |
if (key && translation) |
198 |
{ |
199 |
key->keysym = keysym; |
200 |
key->state = state; |
201 |
key->range = 1; |
202 |
key->str = translation; |
203 |
key->type = keysym_t::NORMAL; |
204 |
|
205 |
if (strncmp (translation, "list", 4) == 0 && translation [4]) |
206 |
{ |
207 |
char *middle = strchr (translation + 5, translation [4]); |
208 |
char *suffix = strrchr (translation + 5, translation [4]); |
209 |
|
210 |
if (suffix && middle && suffix > middle + 1) |
211 |
{ |
212 |
key->type = keysym_t::LIST; |
213 |
key->range = suffix - middle - 1; |
214 |
|
215 |
strcpy (translation, translation + 4); |
216 |
} |
217 |
else |
218 |
rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation); |
219 |
} |
220 |
else if (strncmp (translation, "builtin:", 8) == 0) |
221 |
key->type = keysym_t::BUILTIN; |
222 |
|
223 |
user_keymap.push_back (key); |
224 |
user_translations.push_back (translation); |
225 |
register_keymap (key); |
226 |
} |
227 |
else |
228 |
{ |
229 |
delete key; |
230 |
free ((void *)translation); |
231 |
rxvt_fatal ("out of memory, aborting.\n"); |
232 |
} |
233 |
} |
234 |
|
235 |
void |
236 |
keyboard_manager::register_keymap (keysym_t *key) |
237 |
{ |
238 |
if (keymap.size () == keymap.capacity ()) |
239 |
keymap.reserve (keymap.size () * 2); |
240 |
|
241 |
keymap.push_back (key); |
242 |
hash[0] = 3; |
243 |
} |
244 |
|
245 |
void |
246 |
keyboard_manager::register_done () |
247 |
{ |
248 |
#if STOCK_KEYMAP |
249 |
int n = sizeof (stock_keymap) / sizeof (keysym_t); |
250 |
|
251 |
//TODO: shield against repeated calls and empty keymap |
252 |
//if (keymap.back () != &stock_keymap[n - 1]) |
253 |
for (int i = 0; i < n; ++i) |
254 |
register_keymap (&stock_keymap[i]); |
255 |
#endif |
256 |
|
257 |
purge_duplicate_keymap (); |
258 |
|
259 |
setup_hash (); |
260 |
} |
261 |
|
262 |
bool |
263 |
keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state) |
264 |
{ |
265 |
assert (hash[0] == 0 && "register_done() need to be called"); |
266 |
|
267 |
state &= OtherModMask; // mask out uninteresting modifiers |
268 |
|
269 |
if (state & term->ModMetaMask) state |= MetaMask; |
270 |
if (state & term->ModNumLockMask) state |= NumLockMask; |
271 |
if (state & term->ModLevel3Mask) state |= Level3Mask; |
272 |
|
273 |
if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask)) |
274 |
state |= AppKeypadMask; |
275 |
|
276 |
int index = find_keysym (keysym, state); |
277 |
|
278 |
if (index >= 0) |
279 |
{ |
280 |
const keysym_t &key = *keymap [index]; |
281 |
|
282 |
if (key.type != keysym_t::BUILTIN) |
283 |
{ |
284 |
int keysym_offset = keysym - key.keysym; |
285 |
|
286 |
wchar_t *wc = rxvt_utf8towcs (key.str); |
287 |
char *str = rxvt_wcstombs (wc); |
288 |
// TODO: do (some) translations, unescaping etc, here (allow \u escape etc.) |
289 |
free (wc); |
290 |
|
291 |
switch (key.type) |
292 |
{ |
293 |
case keysym_t::NORMAL: |
294 |
output_string (term, str); |
295 |
break; |
296 |
|
297 |
case keysym_t::RANGE: |
298 |
{ |
299 |
char buf[STRING_MAX]; |
300 |
|
301 |
if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0) |
302 |
output_string (term, buf); |
303 |
} |
304 |
break; |
305 |
|
306 |
case keysym_t::RANGE_META8: |
307 |
{ |
308 |
int len; |
309 |
char buf[STRING_MAX]; |
310 |
|
311 |
len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf)); |
312 |
if (len > 0) |
313 |
output_string_meta8 (term, state, buf, len); |
314 |
} |
315 |
break; |
316 |
|
317 |
case keysym_t::LIST: |
318 |
{ |
319 |
char buf[STRING_MAX]; |
320 |
|
321 |
char *prefix, *middle, *suffix; |
322 |
|
323 |
prefix = str; |
324 |
middle = strchr (prefix + 1, *prefix); |
325 |
suffix = strrchr (middle + 1, *prefix); |
326 |
|
327 |
memcpy (buf, prefix + 1, middle - prefix - 1); |
328 |
buf [middle - prefix - 1] = middle [keysym_offset + 1]; |
329 |
strcpy (buf + (middle - prefix), suffix + 1); |
330 |
|
331 |
output_string (term, buf); |
332 |
} |
333 |
break; |
334 |
} |
335 |
|
336 |
free (str); |
337 |
|
338 |
return true; |
339 |
} |
340 |
} |
341 |
|
342 |
return false; |
343 |
} |
344 |
|
345 |
// purge duplicate keymap entries |
346 |
void keyboard_manager::purge_duplicate_keymap () |
347 |
{ |
348 |
for (unsigned int i = 0; i < keymap.size (); ++i) |
349 |
{ |
350 |
for (unsigned int j = 0; j < i; ++j) |
351 |
{ |
352 |
if (keymap [i] == keymap [j]) |
353 |
{ |
354 |
while (keymap [i] == keymap.back ()) |
355 |
keymap.pop_back (); |
356 |
|
357 |
if (i < keymap.size ()) |
358 |
{ |
359 |
keymap[i] = keymap.back (); |
360 |
keymap.pop_back (); |
361 |
} |
362 |
|
363 |
break; |
364 |
} |
365 |
} |
366 |
} |
367 |
} |
368 |
|
369 |
void |
370 |
keyboard_manager::setup_hash () |
371 |
{ |
372 |
unsigned int i, index, hashkey; |
373 |
vector <keysym_t *> sorted_keymap; |
374 |
uint16_t hash_budget_size[KEYSYM_HASH_BUDGETS]; // size of each budget |
375 |
uint16_t hash_budget_counter[KEYSYM_HASH_BUDGETS]; // #elements in each budget |
376 |
|
377 |
memset (hash_budget_size, 0, sizeof (hash_budget_size)); |
378 |
memset (hash_budget_counter, 0, sizeof (hash_budget_counter)); |
379 |
|
380 |
// determine hash bucket size |
381 |
for (i = 0; i < keymap.size (); ++i) |
382 |
for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j) |
383 |
{ |
384 |
hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; |
385 |
++hash_budget_size [hashkey]; |
386 |
} |
387 |
|
388 |
// now we know the size of each budget |
389 |
// compute the index of each budget |
390 |
hash [0] = 0; |
391 |
for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i) |
392 |
{ |
393 |
index += hash_budget_size [i - 1]; |
394 |
hash [i] = index; |
395 |
} |
396 |
|
397 |
// and allocate just enough space |
398 |
sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0); |
399 |
|
400 |
// fill in sorted_keymap |
401 |
// it is sorted in each budget |
402 |
for (i = 0; i < keymap.size (); ++i) |
403 |
for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j) |
404 |
{ |
405 |
hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; |
406 |
|
407 |
index = hash [hashkey] + hash_budget_counter [hashkey]; |
408 |
|
409 |
while (index > hash [hashkey] |
410 |
&& compare_priority (keymap [i], sorted_keymap [index - 1]) > 0) |
411 |
{ |
412 |
sorted_keymap [index] = sorted_keymap [index - 1]; |
413 |
--index; |
414 |
} |
415 |
|
416 |
sorted_keymap [index] = keymap [i]; |
417 |
++hash_budget_counter [hashkey]; |
418 |
} |
419 |
|
420 |
keymap.swap (sorted_keymap); |
421 |
|
422 |
#if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD) |
423 |
// check for invariants |
424 |
for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i) |
425 |
{ |
426 |
index = hash[i]; |
427 |
for (int j = 0; j < hash_budget_size [i]; ++j) |
428 |
{ |
429 |
if (keymap [index + j]->range == 1) |
430 |
assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK)); |
431 |
|
432 |
if (j) |
433 |
assert (compare_priority (keymap [index + j - 1], |
434 |
keymap [index + j]) >= 0); |
435 |
} |
436 |
} |
437 |
|
438 |
// this should be able to detect most possible bugs |
439 |
for (i = 0; i < sorted_keymap.size (); ++i) |
440 |
{ |
441 |
keysym_t *a = sorted_keymap[i]; |
442 |
for (int j = 0; j < a->range; ++j) |
443 |
{ |
444 |
int index = find_keysym (a->keysym + j, a->state); |
445 |
|
446 |
assert (index >= 0); |
447 |
keysym_t *b = keymap [index]; |
448 |
assert (i == (signed) index || // the normally expected result |
449 |
(a->keysym + j) >= b->keysym && (a->keysym + j) <= (b->keysym + b->range) && compare_priority (a, b) <= 0); // is effectively the same or a closer match |
450 |
} |
451 |
} |
452 |
#endif |
453 |
} |
454 |
|
455 |
int |
456 |
keyboard_manager::find_keysym (KeySym keysym, unsigned int state) |
457 |
{ |
458 |
int hashkey = keysym & KEYSYM_HASH_MASK; |
459 |
unsigned int index = hash [hashkey]; |
460 |
unsigned int end = hashkey < KEYSYM_HASH_BUDGETS - 1 |
461 |
? hash [hashkey + 1] |
462 |
: keymap.size (); |
463 |
|
464 |
for (; index < end; ++index) |
465 |
{ |
466 |
keysym_t *key = keymap [index]; |
467 |
|
468 |
if (key->keysym <= keysym && keysym < key->keysym + key->range |
469 |
// match only the specified bits in state and ignore others |
470 |
&& (key->state & state) == key->state) |
471 |
return index; |
472 |
} |
473 |
|
474 |
return -1; |
475 |
} |
476 |
|
477 |
#endif /* KEYSYM_RESOURCE */ |
478 |
// vim:et:ts=2:sw=2 |