11 ////////////////////////////////////////////////////////////////////////////////
12 // default keycode translation map and keyevent handlers
14 keysym_t keyboard_manager::stock_keymap[] = {
16 /* keysym, state, range, handler, str */
17 //{XK_ISO_Left_Tab, 0, 1, keysym_t::NORMAL, "\033[Z"},
18 //{ 'a', 0, 26, keysym_t::RANGE_META8, "a" "%c"},
19 //{ 'a', ControlMask, 26, keysym_t::RANGE_META8, "
\ 1" "%c"},
20 //{ XK_Left, 0, 4, keysym_t::LIST, ".\033[.DACB."},
21 //{ XK_Left, ShiftMask, 4, keysym_t::LIST, ".\033[.dacb."},
22 //{ XK_Left, ControlMask, 4, keysym_t::LIST, ".\033O.dacb."},
23 //{ XK_Tab, ControlMask, 1, keysym_t::NORMAL, "\033<C-Tab>"},
24 //{ XK_apostrophe, ControlMask, 1, keysym_t::NORMAL, "\033<C-'>"},
25 //{ XK_slash, ControlMask, 1, keysym_t::NORMAL, "\033<C-/>"},
26 //{ XK_semicolon, ControlMask, 1, keysym_t::NORMAL, "\033<C-;>"},
27 //{ XK_grave, ControlMask, 1, keysym_t::NORMAL, "\033<C-`>"},
28 //{ XK_comma, ControlMask, 1, keysym_t::NORMAL, "\033<C-\054>"},
29 //{ XK_Return, ControlMask, 1, keysym_t::NORMAL, "\033<C-Return>"},
30 //{ XK_Return, ShiftMask, 1, keysym_t::NORMAL, "\033<S-Return>"},
31 //{ ' ', ShiftMask, 1, keysym_t::NORMAL, "\033<S-Space>"},
32 //{ '.', ControlMask, 1, keysym_t::NORMAL, "\033<C-.>"},
33 //{ '0', ControlMask, 10, keysym_t::RANGE, "0" "\033<C-%c>"},
34 //{ '0', MetaMask|ControlMask, 10, keysym_t::RANGE, "0" "\033<M-C-%c>"},
35 //{ 'a', MetaMask|ControlMask, 26, keysym_t::RANGE, "a" "\033<M-C-%c>"},
39 output_string (rxvt_term *rt, const char *str)
41 if (strncmp (str, "command:", 8) == 0)
42 rt->cmd_write ((unsigned char *)str + 8, strlen (str) - 8);
44 rt->tt_write ((unsigned char *)str, strlen (str));
48 output_string_meta8 (rxvt_term *rt, unsigned int state, char *buf, int buflen)
50 if (state & rt->ModMetaMask)
53 if (rt->meta_char == 0x80) /* set 8-bit on */
55 for (char *ch = buf; ch < buf + buflen; ch++)
58 else if (rt->meta_char == C0_ESC) /* escape prefix */
61 const unsigned char ch = C0_ESC;
62 rt->tt_write (&ch, 1);
66 rt->tt_write ((unsigned char *) buf, buflen);
70 format_keyrange_string (const char *str, int keysym_offset, char *buf, int bufsize)
72 size_t len = snprintf (buf, bufsize, str + 1, keysym_offset + str [0]);
74 if (len >= (size_t)bufsize)
76 rxvt_warn ("format_keyrange_string: formatting failed, ignoring key.\n");
83 ////////////////////////////////////////////////////////////////////////////////
84 // return: #bits of '1'
85 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 3)
86 # define bitcount(n) (__extension__ ({ uint32_t n__ = (n); __builtin_popcount (n); }))
93 for (i = 0; n; ++i, n &= n - 1)
100 // return: priority_of_a - priority_of_b
102 compare_priority (keysym_t *a, keysym_t *b)
104 // (the more '1's in state; the less range): the greater priority
105 int ca = bitcount (a->state /* & OtherModMask */);
106 int cb = bitcount (b->state /* & OtherModMask */);
110 //else if (a->state != b->state) // this behavior is to be disscussed
111 // return b->state - a->state;
113 return b->range - a->range;
116 ////////////////////////////////////////////////////////////////////////////////
117 keyboard_manager::keyboard_manager ()
119 keymap.reserve (256);
120 hash [0] = 1; // hash[0] != 0 indicates uninitialized data
123 keyboard_manager::~keyboard_manager ()
129 keyboard_manager::clear ()
134 for (unsigned int i = 0; i < user_translations.size (); ++i)
136 free ((void *)user_translations [i]);
137 user_translations [i] = 0;
140 for (unsigned int i = 0; i < user_keymap.size (); ++i)
142 delete user_keymap [i];
146 user_keymap.clear ();
147 user_translations.clear ();
150 // a wrapper for register_keymap,
151 // so that outside codes don't have to know so much details.
153 // the string 'trans' is copied to an internal managed buffer,
154 // so the caller can free memory of 'trans' at any time.
156 keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans)
158 keysym_t *key = new keysym_t;
159 wchar_t *wc = rxvt_mbstowcs (trans);
160 const char *translation = rxvt_wcstoutf8 (wc);
163 if (key && translation)
165 key->keysym = keysym;
168 key->str = translation;
169 key->type = keysym_t::NORMAL;
171 if (strncmp (translation, "list", 4) == 0 && translation [4])
173 char *middle = strchr (translation + 5, translation [4]);
174 char *suffix = strrchr (translation + 5, translation [4]);
176 if (suffix && middle && suffix > middle + 1)
178 key->type = keysym_t::LIST;
179 key->range = suffix - middle - 1;
181 strcpy (translation, translation + 4);
184 rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation);
187 user_keymap.push_back (key);
188 user_translations.push_back (translation);
189 register_keymap (key);
194 free ((void *)translation);
195 rxvt_fatal ("out of memory, aborting.\n");
200 keyboard_manager::register_keymap (keysym_t *key)
202 if (keymap.size () == keymap.capacity ())
203 keymap.reserve (keymap.size () * 2);
205 keymap.push_back (key);
210 keyboard_manager::register_done ()
212 unsigned int i, n = sizeof (stock_keymap) / sizeof (keysym_t);
214 if (keymap.back () != &stock_keymap[n - 1])
215 for (i = 0; i < n; ++i)
216 register_keymap (&stock_keymap[i]);
218 purge_duplicate_keymap ();
224 keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
226 assert (hash[0] == 0 && "register_done() need to be called");
228 if (state & term->ModMetaMask) state |= MetaMask;
229 if (state & term->ModNumLockMask) state |= NumLockMask;
230 if (state & term->ModLevel3Mask) state |= Level3Mask;
232 if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
233 state |= AppKeypadMask;
235 int index = find_keysym (keysym, state);
239 const keysym_t &key = *keymap [index];
241 int keysym_offset = keysym - key.keysym;
243 wchar_t *wc = rxvt_utf8towcs (key.str);
245 char *str = rxvt_wcstombs (wc);
246 // TODO: do translations, unescaping etc, here (allow \u escape etc.)
251 case keysym_t::NORMAL:
252 output_string (term, str);
255 case keysym_t::RANGE:
257 char buf[STRING_MAX];
259 if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0)
260 output_string (term, buf);
264 case keysym_t::RANGE_META8:
267 char buf[STRING_MAX];
269 len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf));
271 output_string_meta8 (term, state, buf, len);
277 char buf[STRING_MAX];
279 char *prefix, *middle, *suffix;
282 middle = strchr (prefix + 1, *prefix);
283 suffix = strrchr (middle + 1, *prefix);
285 memcpy (buf, prefix + 1, middle - prefix - 1);
286 buf [middle - prefix - 1] = middle [keysym_offset + 1];
287 strcpy (buf + (middle - prefix), suffix + 1);
289 output_string (term, buf);
300 // fprintf(stderr,"[%x:%x]",state,keysym);
305 // purge duplicate keymap entries
306 void keyboard_manager::purge_duplicate_keymap ()
308 for (unsigned int i = 0; i < keymap.size (); ++i)
310 for (unsigned int j = 0; j < i; ++j)
312 if (keymap [i] == keymap [j])
314 while (keymap [i] == keymap.back ())
317 if (i < keymap.size ())
319 keymap[i] = keymap.back ();
329 keyboard_manager::setup_hash ()
331 unsigned int i, index, hashkey;
332 vector <keysym_t *> sorted_keymap;
333 uint16_t hash_budget_size[KEYSYM_HASH_BUDGETS]; // size of each budget
334 uint16_t hash_budget_counter[KEYSYM_HASH_BUDGETS]; // #elements in each budget
336 memset (hash_budget_size, 0, sizeof (hash_budget_size));
337 memset (hash_budget_counter, 0, sizeof (hash_budget_counter));
339 // count keysyms for corresponding hash budgets
340 for (i = 0; i < keymap.size (); ++i)
342 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
343 ++hash_budget_size [hashkey];
346 // a keysym_t with range>1 is counted one more time for every keysym that
348 for (i = 0; i < keymap.size (); ++i)
350 if (keymap[i]->range > 1)
352 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j > 0; --j)
354 hashkey = ((keymap [i]->keysym + j) & KEYSYM_HASH_MASK);
355 if (hash_budget_size [hashkey])
356 ++hash_budget_size [hashkey];
361 // now we know the size of each budget
362 // compute the index of each budget
364 for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i)
366 index += hash_budget_size [i - 1];
367 hash[i] = (hash_budget_size [i] ? index : hash [i - 1]);
370 // and allocate just enough space
371 sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0);
373 // fill in sorted_keymap
374 // it is sorted in each budget
375 for (i = 0; i < keymap.size (); ++i)
377 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
379 hashkey = ((keymap [i]->keysym + j) & KEYSYM_HASH_MASK);
381 if (hash_budget_size [hashkey])
383 index = hash [hashkey] + hash_budget_counter [hashkey];
385 while (index > hash [hashkey]
386 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
388 sorted_keymap [index] = sorted_keymap [index - 1];
392 sorted_keymap [index] = keymap [i];
393 ++hash_budget_counter [hashkey];
398 keymap.swap (sorted_keymap);
400 #if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD)
401 // check for invariants
402 for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i)
405 for (int j = 0; j < hash_budget_size [i]; ++j)
407 if (keymap [index + j]->range == 1)
408 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
411 assert (compare_priority (keymap [index + j - 1],
412 keymap [index + j]) >= 0);
416 // this should be able to detect most possible bugs
417 for (i = 0; i < sorted_keymap.size (); ++i)
419 keysym_t *a = sorted_keymap[i];
420 for (int j = 0; j < a->range; ++j)
422 int index = find_keysym (a->keysym + j, a->state);
425 keysym_t *b = keymap [index];
426 assert (i == (signed) index || // the normally expected result
427 (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
434 keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
436 int hashkey = keysym & KEYSYM_HASH_MASK;
437 unsigned int index = hash [hashkey];
439 for (; index < keymap.size (); ++index)
441 keysym_t *key = keymap [index];
443 if (key->keysym <= keysym && key->keysym + key->range > keysym
444 // match only the specified bits in state and ignore others
445 && (key->state & state) == key->state)
447 else if ((key->keysym & KEYSYM_HASH_MASK) > hashkey && key->range == 1)
454 #endif /* KEYSYM_RESOURCE */