| 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 |
//////////////////////////////////////////////////////////////////////////////// |
| 12 |
// default keycode translation map and keyevent handlers |
| 13 |
|
| 14 |
keysym_t keyboard_manager::stock_keymap[] = { |
| 15 |
/* examples */ |
| 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, "" "%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>"}, |
| 36 |
}; |
| 37 |
|
| 38 |
static void |
| 39 |
output_string (rxvt_term *rt, const char *str) |
| 40 |
{ |
| 41 |
if (strncmp (str, "command:", 8) == 0) |
| 42 |
rt->cmd_write ((unsigned char *)str + 8, strlen (str) - 8); |
| 43 |
else |
| 44 |
rt->tt_write ((unsigned char *)str, strlen (str)); |
| 45 |
} |
| 46 |
|
| 47 |
static void |
| 48 |
output_string_meta8 (rxvt_term *rt, unsigned int state, char *buf, int buflen) |
| 49 |
{ |
| 50 |
if (state & rt->ModMetaMask) |
| 51 |
{ |
| 52 |
#ifdef META8_OPTION |
| 53 |
if (rt->meta_char == 0x80) /* set 8-bit on */ |
| 54 |
{ |
| 55 |
for (char *ch = buf; ch < buf + buflen; ch++) |
| 56 |
*ch |= 0x80; |
| 57 |
} |
| 58 |
else if (rt->meta_char == C0_ESC) /* escape prefix */ |
| 59 |
#endif |
| 60 |
{ |
| 61 |
const unsigned char ch = C0_ESC; |
| 62 |
rt->tt_write (&ch, 1); |
| 63 |
} |
| 64 |
} |
| 65 |
|
| 66 |
rt->tt_write ((unsigned char *) buf, buflen); |
| 67 |
} |
| 68 |
|
| 69 |
static int |
| 70 |
format_keyrange_string (const char *str, int keysym_offset, char *buf, int bufsize) |
| 71 |
{ |
| 72 |
size_t len = snprintf (buf, bufsize, str + 1, keysym_offset + str [0]); |
| 73 |
|
| 74 |
if (len >= (size_t)bufsize) |
| 75 |
{ |
| 76 |
rxvt_warn ("format_keyrange_string: formatting failed, ignoring key.\n"); |
| 77 |
*buf = 0; |
| 78 |
} |
| 79 |
|
| 80 |
return len; |
| 81 |
} |
| 82 |
|
| 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); })) |
| 87 |
#else |
| 88 |
static int |
| 89 |
bitcount (uint16_t n) |
| 90 |
{ |
| 91 |
int i; |
| 92 |
|
| 93 |
for (i = 0; n; ++i, n &= n - 1) |
| 94 |
; |
| 95 |
|
| 96 |
return i; |
| 97 |
} |
| 98 |
#endif |
| 99 |
|
| 100 |
// return: priority_of_a - priority_of_b |
| 101 |
static int |
| 102 |
compare_priority (keysym_t *a, keysym_t *b) |
| 103 |
{ |
| 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 */); |
| 107 |
|
| 108 |
if (ca != cb) |
| 109 |
return ca - cb; |
| 110 |
//else if (a->state != b->state) // this behavior is to be disscussed |
| 111 |
// return b->state - a->state; |
| 112 |
else |
| 113 |
return b->range - a->range; |
| 114 |
} |
| 115 |
|
| 116 |
//////////////////////////////////////////////////////////////////////////////// |
| 117 |
keyboard_manager::keyboard_manager () |
| 118 |
{ |
| 119 |
keymap.reserve (256); |
| 120 |
hash [0] = 1; // hash[0] != 0 indicates uninitialized data |
| 121 |
} |
| 122 |
|
| 123 |
keyboard_manager::~keyboard_manager () |
| 124 |
{ |
| 125 |
clear (); |
| 126 |
} |
| 127 |
|
| 128 |
void |
| 129 |
keyboard_manager::clear () |
| 130 |
{ |
| 131 |
keymap.clear (); |
| 132 |
hash [0] = 2; |
| 133 |
|
| 134 |
for (unsigned int i = 0; i < user_translations.size (); ++i) |
| 135 |
{ |
| 136 |
free ((void *)user_translations [i]); |
| 137 |
user_translations [i] = 0; |
| 138 |
} |
| 139 |
|
| 140 |
for (unsigned int i = 0; i < user_keymap.size (); ++i) |
| 141 |
{ |
| 142 |
delete user_keymap [i]; |
| 143 |
user_keymap [i] = 0; |
| 144 |
} |
| 145 |
|
| 146 |
user_keymap.clear (); |
| 147 |
user_translations.clear (); |
| 148 |
} |
| 149 |
|
| 150 |
// a wrapper for register_keymap, |
| 151 |
// so that outside codes don't have to know so much details. |
| 152 |
// |
| 153 |
// the string 'trans' is copied to an internal managed buffer, |
| 154 |
// so the caller can free memory of 'trans' at any time. |
| 155 |
void |
| 156 |
keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans) |
| 157 |
{ |
| 158 |
keysym_t *key = new keysym_t; |
| 159 |
wchar_t *wc = rxvt_mbstowcs (trans); |
| 160 |
const char *translation = rxvt_wcstoutf8 (wc); |
| 161 |
free (wc); |
| 162 |
|
| 163 |
if (key && translation) |
| 164 |
{ |
| 165 |
key->keysym = keysym; |
| 166 |
key->state = state; |
| 167 |
key->range = 1; |
| 168 |
key->str = translation; |
| 169 |
key->type = keysym_t::NORMAL; |
| 170 |
|
| 171 |
if (strncmp (translation, "list", 4) == 0 && translation [4]) |
| 172 |
{ |
| 173 |
char *middle = strchr (translation + 5, translation [4]); |
| 174 |
char *suffix = strrchr (translation + 5, translation [4]); |
| 175 |
|
| 176 |
if (suffix && middle && suffix > middle + 1) |
| 177 |
{ |
| 178 |
key->type = keysym_t::LIST; |
| 179 |
key->range = suffix - middle - 1; |
| 180 |
|
| 181 |
strcpy (translation, translation + 4); |
| 182 |
} |
| 183 |
else |
| 184 |
rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation); |
| 185 |
} |
| 186 |
|
| 187 |
user_keymap.push_back (key); |
| 188 |
user_translations.push_back (translation); |
| 189 |
register_keymap (key); |
| 190 |
} |
| 191 |
else |
| 192 |
{ |
| 193 |
delete key; |
| 194 |
free ((void *)translation); |
| 195 |
rxvt_fatal ("out of memory, aborting.\n"); |
| 196 |
} |
| 197 |
} |
| 198 |
|
| 199 |
void |
| 200 |
keyboard_manager::register_keymap (keysym_t *key) |
| 201 |
{ |
| 202 |
if (keymap.size () == keymap.capacity ()) |
| 203 |
keymap.reserve (keymap.size () * 2); |
| 204 |
|
| 205 |
keymap.push_back (key); |
| 206 |
hash[0] = 3; |
| 207 |
} |
| 208 |
|
| 209 |
void |
| 210 |
keyboard_manager::register_done () |
| 211 |
{ |
| 212 |
unsigned int i, n = sizeof (stock_keymap) / sizeof (keysym_t); |
| 213 |
|
| 214 |
if (keymap.back () != &stock_keymap[n - 1]) |
| 215 |
for (i = 0; i < n; ++i) |
| 216 |
register_keymap (&stock_keymap[i]); |
| 217 |
|
| 218 |
purge_duplicate_keymap (); |
| 219 |
|
| 220 |
setup_hash (); |
| 221 |
} |
| 222 |
|
| 223 |
bool |
| 224 |
keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state) |
| 225 |
{ |
| 226 |
assert (hash[0] == 0 && "register_done() need to be called"); |
| 227 |
|
| 228 |
if (state & term->ModMetaMask) state |= MetaMask; |
| 229 |
if (state & term->ModNumLockMask) state |= NumLockMask; |
| 230 |
if (state & term->ModLevel3Mask) state |= Level3Mask; |
| 231 |
|
| 232 |
if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask)) |
| 233 |
state |= AppKeypadMask; |
| 234 |
|
| 235 |
int index = find_keysym (keysym, state); |
| 236 |
|
| 237 |
if (index >= 0) |
| 238 |
{ |
| 239 |
const keysym_t &key = *keymap [index]; |
| 240 |
|
| 241 |
int keysym_offset = keysym - key.keysym; |
| 242 |
|
| 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.) |
| 246 |
free (wc); |
| 247 |
|
| 248 |
switch (key.type) |
| 249 |
{ |
| 250 |
case keysym_t::NORMAL: |
| 251 |
output_string (term, str); |
| 252 |
break; |
| 253 |
|
| 254 |
case keysym_t::RANGE: |
| 255 |
{ |
| 256 |
char buf[STRING_MAX]; |
| 257 |
|
| 258 |
if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0) |
| 259 |
output_string (term, buf); |
| 260 |
} |
| 261 |
break; |
| 262 |
|
| 263 |
case keysym_t::RANGE_META8: |
| 264 |
{ |
| 265 |
int len; |
| 266 |
char buf[STRING_MAX]; |
| 267 |
|
| 268 |
len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf)); |
| 269 |
if (len > 0) |
| 270 |
output_string_meta8 (term, state, buf, len); |
| 271 |
} |
| 272 |
break; |
| 273 |
|
| 274 |
case keysym_t::LIST: |
| 275 |
{ |
| 276 |
char buf[STRING_MAX]; |
| 277 |
|
| 278 |
char *prefix, *middle, *suffix; |
| 279 |
|
| 280 |
prefix = str; |
| 281 |
middle = strchr (prefix + 1, *prefix); |
| 282 |
suffix = strrchr (middle + 1, *prefix); |
| 283 |
|
| 284 |
memcpy (buf, prefix + 1, middle - prefix - 1); |
| 285 |
buf [middle - prefix - 1] = middle [keysym_offset + 1]; |
| 286 |
strcpy (buf + (middle - prefix), suffix + 1); |
| 287 |
|
| 288 |
output_string (term, buf); |
| 289 |
} |
| 290 |
break; |
| 291 |
} |
| 292 |
|
| 293 |
free (str); |
| 294 |
|
| 295 |
return true; |
| 296 |
} |
| 297 |
else |
| 298 |
return false; |
| 299 |
} |
| 300 |
|
| 301 |
// purge duplicate keymap entries |
| 302 |
void keyboard_manager::purge_duplicate_keymap () |
| 303 |
{ |
| 304 |
for (unsigned int i = 0; i < keymap.size (); ++i) |
| 305 |
{ |
| 306 |
for (unsigned int j = 0; j < i; ++j) |
| 307 |
{ |
| 308 |
if (keymap [i] == keymap [j]) |
| 309 |
{ |
| 310 |
while (keymap [i] == keymap.back ()) |
| 311 |
keymap.pop_back (); |
| 312 |
|
| 313 |
if (i < keymap.size ()) |
| 314 |
{ |
| 315 |
keymap[i] = keymap.back (); |
| 316 |
keymap.pop_back (); |
| 317 |
} |
| 318 |
|
| 319 |
break; |
| 320 |
} |
| 321 |
} |
| 322 |
} |
| 323 |
} |
| 324 |
|
| 325 |
void |
| 326 |
keyboard_manager::setup_hash () |
| 327 |
{ |
| 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 |
| 332 |
|
| 333 |
memset (hash_budget_size, 0, sizeof (hash_budget_size)); |
| 334 |
memset (hash_budget_counter, 0, sizeof (hash_budget_counter)); |
| 335 |
|
| 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) |
| 339 |
{ |
| 340 |
hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; |
| 341 |
++hash_budget_size [hashkey]; |
| 342 |
} |
| 343 |
|
| 344 |
// now we know the size of each budget |
| 345 |
// compute the index of each budget |
| 346 |
hash [0] = 0; |
| 347 |
for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i) |
| 348 |
{ |
| 349 |
index += hash_budget_size [i - 1]; |
| 350 |
hash [i] = index; |
| 351 |
} |
| 352 |
|
| 353 |
// and allocate just enough space |
| 354 |
sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0); |
| 355 |
|
| 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) |
| 360 |
{ |
| 361 |
hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; |
| 362 |
|
| 363 |
index = hash [hashkey] + hash_budget_counter [hashkey]; |
| 364 |
|
| 365 |
while (index > hash [hashkey] |
| 366 |
&& compare_priority (keymap [i], sorted_keymap [index - 1]) > 0) |
| 367 |
{ |
| 368 |
sorted_keymap [index] = sorted_keymap [index - 1]; |
| 369 |
--index; |
| 370 |
} |
| 371 |
|
| 372 |
sorted_keymap [index] = keymap [i]; |
| 373 |
++hash_budget_counter [hashkey]; |
| 374 |
} |
| 375 |
|
| 376 |
keymap.swap (sorted_keymap); |
| 377 |
|
| 378 |
#if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD) |
| 379 |
// check for invariants |
| 380 |
for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i) |
| 381 |
{ |
| 382 |
index = hash[i]; |
| 383 |
for (int j = 0; j < hash_budget_size [i]; ++j) |
| 384 |
{ |
| 385 |
if (keymap [index + j]->range == 1) |
| 386 |
assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK)); |
| 387 |
|
| 388 |
if (j) |
| 389 |
assert (compare_priority (keymap [index + j - 1], |
| 390 |
keymap [index + j]) >= 0); |
| 391 |
} |
| 392 |
} |
| 393 |
|
| 394 |
// this should be able to detect most possible bugs |
| 395 |
for (i = 0; i < sorted_keymap.size (); ++i) |
| 396 |
{ |
| 397 |
keysym_t *a = sorted_keymap[i]; |
| 398 |
for (int j = 0; j < a->range; ++j) |
| 399 |
{ |
| 400 |
int index = find_keysym (a->keysym + j, a->state); |
| 401 |
|
| 402 |
assert (index >= 0); |
| 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 |
| 406 |
} |
| 407 |
} |
| 408 |
#endif |
| 409 |
} |
| 410 |
|
| 411 |
int |
| 412 |
keyboard_manager::find_keysym (KeySym keysym, unsigned int state) |
| 413 |
{ |
| 414 |
int hashkey = keysym & KEYSYM_HASH_MASK; |
| 415 |
unsigned int index = hash [hashkey]; |
| 416 |
unsigned int end = hashkey < KEYSYM_HASH_BUDGETS - 1 |
| 417 |
? hash [hashkey + 1] |
| 418 |
: keymap.size (); |
| 419 |
|
| 420 |
for (; index < end; ++index) |
| 421 |
{ |
| 422 |
keysym_t *key = keymap [index]; |
| 423 |
|
| 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) |
| 427 |
return index; |
| 428 |
} |
| 429 |
|
| 430 |
return -1; |
| 431 |
} |
| 432 |
|
| 433 |
#endif /* KEYSYM_RESOURCE */ |
| 434 |
// vim:et:ts=2:sw=2 |
