ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/keyboard.C
(Generate patch)

Comparing rxvt-unicode/src/keyboard.C (file contents):
Revision 1.6 by root, Sun Jan 16 19:20:30 2005 UTC vs.
Revision 1.13 by root, Thu Feb 24 13:01:01 2005 UTC

1#include "../config.h" 1#include "../config.h"
2#include "rxvt.h" 2#include "rxvt.h"
3
4#ifdef KEYSYM_RESOURCE
5
6#include <cstring>
7
3#include "keyboard.h" 8#include "keyboard.h"
4#include "command.h" 9#include "command.h"
5#include <string.h>
6#include <X11/X.h>
7 10
8#ifdef KEYSYM_RESOURCE 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 */
9 42
43#if STOCK_KEYMAP
10//////////////////////////////////////////////////////////////////////////////// 44////////////////////////////////////////////////////////////////////////////////
11// default keycode translation map and keyevent handlers 45// default keycode translation map and keyevent handlers
12 46
13keysym_t keyboard_manager::stock_keymap[] = { 47keysym_t keyboard_manager::stock_keymap[] = {
14 /* examples */ 48 /* examples */
15 /* keysym, state, range, handler, str */ 49 /* keysym, state, range, handler, str */
16//{XK_ISO_Left_Tab, 0, 1, NORMAL, "\033[Z"}, 50//{XK_ISO_Left_Tab, 0, 1, keysym_t::NORMAL, "\033[Z"},
17//{ 'a', 0, 26, RANGE_META8, "a" "%c"}, 51//{ 'a', 0, 26, keysym_t::RANGE_META8, "a" "%c"},
18//{ 'a', ControlMask, 26, RANGE_META8, "" "%c"}, 52//{ 'a', ControlMask, 26, keysym_t::RANGE_META8, "" "%c"},
19//{ XK_Left, 0, 4, LIST, "DACBZ" "\033[Z"}, 53//{ XK_Left, 0, 4, keysym_t::LIST, ".\033[.DACB."},
20//{ XK_Left, ShiftMask, 4, LIST, "dacbZ" "\033[Z"}, 54//{ XK_Left, ShiftMask, 4, keysym_t::LIST, ".\033[.dacb."},
21//{ XK_Left, ControlMask, 4, LIST, "dacbZ" "\033OZ"}, 55//{ XK_Left, ControlMask, 4, keysym_t::LIST, ".\033O.dacb."},
22//{ XK_Tab, ControlMask, 1, NORMAL, "\033<C-Tab>"}, 56//{ XK_Tab, ControlMask, 1, keysym_t::NORMAL, "\033<C-Tab>"},
23//{ XK_apostrophe, ControlMask, 1, NORMAL, "\033<C-'>"}, 57//{ XK_apostrophe, ControlMask, 1, keysym_t::NORMAL, "\033<C-'>"},
24//{ XK_slash, ControlMask, 1, NORMAL, "\033<C-/>"}, 58//{ XK_slash, ControlMask, 1, keysym_t::NORMAL, "\033<C-/>"},
25//{ XK_semicolon, ControlMask, 1, NORMAL, "\033<C-;>"}, 59//{ XK_semicolon, ControlMask, 1, keysym_t::NORMAL, "\033<C-;>"},
26//{ XK_grave, ControlMask, 1, NORMAL, "\033<C-`>"}, 60//{ XK_grave, ControlMask, 1, keysym_t::NORMAL, "\033<C-`>"},
27//{ XK_comma, ControlMask, 1, NORMAL, "\033<C-\054>"}, 61//{ XK_comma, ControlMask, 1, keysym_t::NORMAL, "\033<C-\054>"},
28//{ XK_Return, ControlMask, 1, NORMAL, "\033<C-Return>"}, 62//{ XK_Return, ControlMask, 1, keysym_t::NORMAL, "\033<C-Return>"},
29//{ XK_Return, ShiftMask, 1, NORMAL, "\033<S-Return>"}, 63//{ XK_Return, ShiftMask, 1, keysym_t::NORMAL, "\033<S-Return>"},
30//{ ' ', ShiftMask, 1, NORMAL, "\033<S-Space>"}, 64//{ ' ', ShiftMask, 1, keysym_t::NORMAL, "\033<S-Space>"},
31//{ '.', ControlMask, 1, NORMAL, "\033<C-.>"}, 65//{ '.', ControlMask, 1, keysym_t::NORMAL, "\033<C-.>"},
32//{ '0', ControlMask, 10, RANGE, "0" "\033<C-%c>"}, 66//{ '0', ControlMask, 10, keysym_t::RANGE, "0" "\033<C-%c>"},
33//{ '0', MetaMask|ControlMask, 10, RANGE, "0" "\033<M-C-%c>"}, 67//{ '0', MetaMask|ControlMask, 10, keysym_t::RANGE, "0" "\033<M-C-%c>"},
34//{ 'a', MetaMask|ControlMask, 26, RANGE, "a" "\033<M-C-%c>"}, 68//{ 'a', MetaMask|ControlMask, 26, keysym_t::RANGE, "a" "\033<M-C-%c>"},
35}; 69};
70#endif
36 71
37static void 72static void
38output_string (rxvt_term *rt, const char *str) 73output_string (rxvt_term *rt, const char *str)
39{ 74{
40 assert (rt && str);
41
42 if (strncmp (str, "proto:", 6) == 0) 75 if (strncmp (str, "command:", 8) == 0)
43 rt->cmd_write ((unsigned char *)str + 6, strlen (str) - 6); 76 rt->cmd_write ((unsigned char *)str + 8, strlen (str) - 8);
44 else 77 else
45 rt->tt_write ((unsigned char *)str, strlen (str)); 78 rt->tt_write ((unsigned char *)str, strlen (str));
46} 79}
47 80
48static void 81static void
… …
68} 101}
69 102
70static int 103static int
71format_keyrange_string (const char *str, int keysym_offset, char *buf, int bufsize) 104format_keyrange_string (const char *str, int keysym_offset, char *buf, int bufsize)
72{ 105{
73 int len = snprintf (buf, bufsize, str + 1, keysym_offset + str [0]); 106 size_t len = snprintf (buf, bufsize, str + 1, keysym_offset + str [0]);
74 107
75 if (len >= bufsize) 108 if (len >= (size_t)bufsize)
76 {
77 rxvt_warn ("buffer overflowed!\n");
78 *buf = 0;
79 } 109 {
80 else if (len < 0) 110 rxvt_warn ("format_keyrange_string: formatting failed, ignoring key.\n");
81 {
82 rxvt_warn ("keyrange_translator(), snprintf error");
83 *buf = 0; 111 *buf = 0;
84 } 112 }
85 113
86 return len; 114 return len;
87} 115}
88 116
89//////////////////////////////////////////////////////////////////////////////// 117////////////////////////////////////////////////////////////////////////////////
90// return: #bits of '1' 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
91static int 122static int
92bitcount (unsigned int n) 123bitcount (uint16_t n)
93{ 124{
94 int i; 125 int i;
95 126
96 for (i = 0; n; ++i, n &= (n - 1)) 127 for (i = 0; n; ++i, n &= n - 1)
97 ; 128 ;
98 129
99 return i; 130 return i;
100} 131}
132#endif
101 133
102// return: priority_of_a - priority_of_b 134// return: priority_of_a - priority_of_b
103static int 135static int
104compare_priority (keysym_t *a, keysym_t *b) 136compare_priority (keysym_t *a, keysym_t *b)
105{ 137{
106 assert (a && b);
107
108 // (the more '1's in state; the less range): the greater priority 138 // (the more '1's in state; the less range): the greater priority
109 int ca = bitcount (a->state /* & OtherModMask */); 139 int ca = bitcount (a->state /* & OtherModMask */);
110 int cb = bitcount (b->state /* & OtherModMask */); 140 int cb = bitcount (b->state /* & OtherModMask */);
111 141
112 if (ca != cb) 142 if (ca != cb)
… …
157// the string 'trans' is copied to an internal managed buffer, 187// the string 'trans' is copied to an internal managed buffer,
158// so the caller can free memory of 'trans' at any time. 188// so the caller can free memory of 'trans' at any time.
159void 189void
160keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans) 190keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans)
161{ 191{
162 assert (trans);
163
164 keysym_t *key = new keysym_t; 192 keysym_t *key = new keysym_t;
165 wchar_t *wc = rxvt_mbstowcs (trans); 193 wchar_t *wc = rxvt_mbstowcs (trans);
166 const char *translation = rxvt_wcstoutf8 (wc); 194 const char *translation = rxvt_wcstoutf8 (wc);
167 free (wc); 195 free (wc);
168 196
… …
185 key->range = suffix - middle - 1; 213 key->range = suffix - middle - 1;
186 214
187 strcpy (translation, translation + 4); 215 strcpy (translation, translation + 4);
188 } 216 }
189 else 217 else
190 {
191 key->range = 1;
192 rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation); 218 rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation);
193 } 219 }
194 }
195 else
196 220
197 user_keymap.push_back (key); 221 user_keymap.push_back (key);
198 user_translations.push_back (translation); 222 user_translations.push_back (translation);
199 register_keymap (key); 223 register_keymap (key);
200 } 224 }
… …
207} 231}
208 232
209void 233void
210keyboard_manager::register_keymap (keysym_t *key) 234keyboard_manager::register_keymap (keysym_t *key)
211{ 235{
212 assert (key);
213 assert (key->range >= 1);
214
215 if (keymap.size () == keymap.capacity ()) 236 if (keymap.size () == keymap.capacity ())
216 keymap.reserve (keymap.size () * 2); 237 keymap.reserve (keymap.size () * 2);
217 238
218 keymap.push_back (key); 239 keymap.push_back (key);
219 hash[0] = 3; 240 hash[0] = 3;
220} 241}
221 242
222void 243void
223keyboard_manager::register_done () 244keyboard_manager::register_done ()
224{ 245{
246#if STOCK_KEYMAP
225 unsigned int i, n = sizeof (stock_keymap) / sizeof (keysym_t); 247 int n = sizeof (stock_keymap) / sizeof (keysym_t);
226 248
249 //TODO: shield against repeated calls and empty keymap
227 if (keymap.back () != &stock_keymap[n - 1]) 250 //if (keymap.back () != &stock_keymap[n - 1])
228 for (i = 0; i < n; ++i) 251 for (int i = 0; i < n; ++i)
229 register_keymap (&stock_keymap[i]); 252 register_keymap (&stock_keymap[i]);
253#endif
230 254
231 purge_duplicate_keymap (); 255 purge_duplicate_keymap ();
232 256
233 setup_hash (); 257 setup_hash ();
234} 258}
… …
247 271
248 int index = find_keysym (keysym, state); 272 int index = find_keysym (keysym, state);
249 273
250 if (index >= 0) 274 if (index >= 0)
251 { 275 {
252 assert (term && keymap [index]);
253 const keysym_t &key = *keymap [index]; 276 const keysym_t &key = *keymap [index];
254 277
255 int keysym_offset = keysym - key.keysym; 278 int keysym_offset = keysym - key.keysym;
256 279
257 wchar_t *wc = rxvt_utf8towcs (key.str); 280 wchar_t *wc = rxvt_utf8towcs (key.str);
258 char *str = rxvt_wcstombs (wc); 281 char *str = rxvt_wcstombs (wc);
259 // TODO: do translations, unescaping etc, here (allow \u escape etc.) 282 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
260 free (wc); 283 free (wc);
261 284
262 switch (key.type) 285 switch (key.type)
263 { 286 {
264 case keysym_t::NORMAL: 287 case keysym_t::NORMAL:
… …
307 free (str); 330 free (str);
308 331
309 return true; 332 return true;
310 } 333 }
311 else 334 else
312 {
313 // fprintf(stderr,"[%x:%x]",state,keysym);
314 return false; 335 return false;
315 }
316} 336}
317 337
318// purge duplicate keymap entries 338// purge duplicate keymap entries
319void keyboard_manager::purge_duplicate_keymap () 339void keyboard_manager::purge_duplicate_keymap ()
320{ 340{
… …
330 if (i < keymap.size ()) 350 if (i < keymap.size ())
331 { 351 {
332 keymap[i] = keymap.back (); 352 keymap[i] = keymap.back ();
333 keymap.pop_back (); 353 keymap.pop_back ();
334 } 354 }
355
335 break; 356 break;
336 } 357 }
337 } 358 }
338 } 359 }
339} 360}
… …
347 uint16_t hash_budget_counter[KEYSYM_HASH_BUDGETS]; // #elements in each budget 368 uint16_t hash_budget_counter[KEYSYM_HASH_BUDGETS]; // #elements in each budget
348 369
349 memset (hash_budget_size, 0, sizeof (hash_budget_size)); 370 memset (hash_budget_size, 0, sizeof (hash_budget_size));
350 memset (hash_budget_counter, 0, sizeof (hash_budget_counter)); 371 memset (hash_budget_counter, 0, sizeof (hash_budget_counter));
351 372
352 // count keysyms for corresponding hash budgets 373 // determine hash bucket size
353 for (i = 0; i < keymap.size (); ++i) 374 for (i = 0; i < keymap.size (); ++i)
375 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
354 { 376 {
355 assert (keymap [i]);
356 hashkey = (keymap [i]->keysym & KEYSYM_HASH_MASK); 377 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK;
357 ++hash_budget_size [hashkey]; 378 ++hash_budget_size [hashkey];
358 }
359
360 // keysym A with range>1 is counted one more time for
361 // every keysym B lies in its range
362 for (i = 0; i < keymap.size (); ++i)
363 {
364 if (keymap[i]->range > 1)
365 {
366 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j > 0; --j)
367 {
368 hashkey = ((keymap [i]->keysym + j) & KEYSYM_HASH_MASK);
369 if (hash_budget_size [hashkey])
370 ++hash_budget_size [hashkey];
371 }
372 } 379 }
373 }
374 380
375 // now we know the size of each budget 381 // now we know the size of each budget
376 // compute the index of each budget 382 // compute the index of each budget
377 hash [0] = 0; 383 hash [0] = 0;
378 for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i) 384 for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i)
379 { 385 {
380 index += hash_budget_size [i - 1]; 386 index += hash_budget_size [i - 1];
381 hash[i] = (hash_budget_size [i] ? index : hash [i - 1]); 387 hash [i] = index;
382 } 388 }
383 389
384 // and allocate just enough space 390 // and allocate just enough space
385 //sorted_keymap.reserve (hash[i - 1] + hash_budget_size[i - 1]);
386 sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0); 391 sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0);
387 392
388 // fill in sorted_keymap 393 // fill in sorted_keymap
389 // it is sorted in each budget 394 // it is sorted in each budget
390 for (i = 0; i < keymap.size (); ++i) 395 for (i = 0; i < keymap.size (); ++i)
391 {
392 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j) 396 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
393 { 397 {
394 hashkey = ((keymap [i]->keysym + j) & KEYSYM_HASH_MASK); 398 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK;
395 399
396 if (hash_budget_size [hashkey])
397 {
398 index = hash [hashkey] + hash_budget_counter [hashkey]; 400 index = hash [hashkey] + hash_budget_counter [hashkey];
399 401
400 while (index > hash [hashkey] 402 while (index > hash [hashkey]
401 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0) 403 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
402 { 404 {
403 sorted_keymap [index] = sorted_keymap [index - 1]; 405 sorted_keymap [index] = sorted_keymap [index - 1];
404 --index; 406 --index;
405 } 407 }
406 408
407 sorted_keymap [index] = keymap [i]; 409 sorted_keymap [index] = keymap [i];
408 ++hash_budget_counter [hashkey]; 410 ++hash_budget_counter [hashkey];
409 }
410 } 411 }
411 }
412 412
413 keymap.swap (sorted_keymap); 413 keymap.swap (sorted_keymap);
414 414
415#if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD) 415#if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD)
416 // check for invariants 416 // check for invariants
… …
432 for (i = 0; i < sorted_keymap.size (); ++i) 432 for (i = 0; i < sorted_keymap.size (); ++i)
433 { 433 {
434 keysym_t *a = sorted_keymap[i]; 434 keysym_t *a = sorted_keymap[i];
435 for (int j = 0; j < a->range; ++j) 435 for (int j = 0; j < a->range; ++j)
436 { 436 {
437 int index = find_keysym (a->keysym + j, a->state & OtherModMask); 437 int index = find_keysym (a->keysym + j, a->state);
438 438
439 assert (index >= 0); 439 assert (index >= 0);
440 keysym_t *b = keymap [index]; 440 keysym_t *b = keymap [index];
441 assert (i == (signed) index || // the normally expected result 441 assert (i == (signed) index || // the normally expected result
442 (a->keysym + j) >= b->keysym && (a->keysym + j) <= (b->keysym + b->range) && compare_priority (a, b) <= 0); // is effectively the same 442 (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
443 } 443 }
444 } 444 }
445#endif 445#endif
446} 446}
447 447
448int 448int
449keyboard_manager::find_keysym (KeySym keysym, unsigned int state) 449keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
450{ 450{
451 int hashkey = keysym & KEYSYM_HASH_MASK; 451 int hashkey = keysym & KEYSYM_HASH_MASK;
452 unsigned int index = hash [hashkey]; 452 unsigned int index = hash [hashkey];
453 unsigned int end = hashkey < KEYSYM_HASH_BUDGETS - 1
454 ? hash [hashkey + 1]
455 : keymap.size ();
453 456
454 for (; index < keymap.size (); ++index) 457 for (; index < end; ++index)
455 { 458 {
456 keysym_t *key = keymap [index]; 459 keysym_t *key = keymap [index];
457 assert (key);
458 460
459 if (key->keysym <= keysym && key->keysym + key->range > keysym 461 if (key->keysym <= keysym && keysym < key->keysym + key->range
460 // match only the specified bits in state and ignore others 462 // match only the specified bits in state and ignore others
461 && (key->state & OtherModMask) == (key->state & state)) 463 && (key->state & state) == key->state)
462 return index; 464 return index;
463 else if (key->keysym > keysym && key->range == 1)
464 return -1;
465 } 465 }
466 466
467 return -1; 467 return -1;
468} 468}
469 469

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines