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);
244 char *str = rxvt_wcstombs (wc);
245 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
250 case keysym_t::NORMAL:
251 output_string (term, str);
254 case keysym_t::RANGE:
256 char buf[STRING_MAX];
258 if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0)
259 output_string (term, buf);
263 case keysym_t::RANGE_META8:
266 char buf[STRING_MAX];
268 len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf));
270 output_string_meta8 (term, state, buf, len);
276 char buf[STRING_MAX];
278 char *prefix, *middle, *suffix;
281 middle = strchr (prefix + 1, *prefix);
282 suffix = strrchr (middle + 1, *prefix);
284 memcpy (buf, prefix + 1, middle - prefix - 1);
285 buf [middle - prefix - 1] = middle [keysym_offset + 1];
286 strcpy (buf + (middle - prefix), suffix + 1);
288 output_string (term, buf);
301 // purge duplicate keymap entries
302 void keyboard_manager::purge_duplicate_keymap ()
304 for (unsigned int i = 0; i < keymap.size (); ++i)
306 for (unsigned int j = 0; j < i; ++j)
308 if (keymap [i] == keymap [j])
310 while (keymap [i] == keymap.back ())
313 if (i < keymap.size ())
315 keymap[i] = keymap.back ();
326 keyboard_manager::setup_hash ()
328 unsigned int i, index, hashkey;
329 vector <keysym_t *> sorted_keymap;
330 uint16_t hash_budget_size[KEYSYM_HASH_BUDGETS]; // size of each budget
331 uint16_t hash_budget_counter[KEYSYM_HASH_BUDGETS]; // #elements in each budget
333 memset (hash_budget_size, 0, sizeof (hash_budget_size));
334 memset (hash_budget_counter, 0, sizeof (hash_budget_counter));
336 // determine hash bucket size
337 for (i = 0; i < keymap.size (); ++i)
338 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
340 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK;
341 ++hash_budget_size [hashkey];
344 // now we know the size of each budget
345 // compute the index of each budget
347 for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i)
349 index += hash_budget_size [i - 1];
353 // and allocate just enough space
354 sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0);
356 // fill in sorted_keymap
357 // it is sorted in each budget
358 for (i = 0; i < keymap.size (); ++i)
359 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
361 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK;
363 index = hash [hashkey] + hash_budget_counter [hashkey];
365 while (index > hash [hashkey]
366 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
368 sorted_keymap [index] = sorted_keymap [index - 1];
372 sorted_keymap [index] = keymap [i];
373 ++hash_budget_counter [hashkey];
376 keymap.swap (sorted_keymap);
378 #if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD)
379 // check for invariants
380 for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i)
383 for (int j = 0; j < hash_budget_size [i]; ++j)
385 if (keymap [index + j]->range == 1)
386 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
389 assert (compare_priority (keymap [index + j - 1],
390 keymap [index + j]) >= 0);
394 // this should be able to detect most possible bugs
395 for (i = 0; i < sorted_keymap.size (); ++i)
397 keysym_t *a = sorted_keymap[i];
398 for (int j = 0; j < a->range; ++j)
400 int index = find_keysym (a->keysym + j, a->state);
403 keysym_t *b = keymap [index];
404 assert (i == (signed) index || // the normally expected result
405 (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
412 keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
414 int hashkey = keysym & KEYSYM_HASH_MASK;
415 unsigned int index = hash [hashkey];
416 unsigned int end = hashkey < KEYSYM_HASH_BUDGETS - 1
420 for (; index < end; ++index)
422 keysym_t *key = keymap [index];
424 if (key->keysym <= keysym && keysym < key->keysym + key->range
425 // match only the specified bits in state and ignore others
426 && (key->state & state) == key->state)
433 #endif /* KEYSYM_RESOURCE */