| 1 |
/*----------------------------------------------------------------------* |
| 2 |
* File: keyboard.C |
| 3 |
*----------------------------------------------------------------------* |
| 4 |
* |
| 5 |
* All portions of code are copyright by their respective author/s. |
| 6 |
* Copyright (c) 2005 WU Fengguang |
| 7 |
* Copyright (c) 2005-2006 Marc Lehmann <schmorp@schmorp.de> |
| 8 |
* |
| 9 |
* This program is free software; you can redistribute it and/or modify |
| 10 |
* it under the terms of the GNU General Public License as published by |
| 11 |
* the Free Software Foundation; either version 2 of the License, or |
| 12 |
* (at your option) any later version. |
| 13 |
* |
| 14 |
* This program is distributed in the hope that it will be useful, |
| 15 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 |
* GNU General Public License for more details. |
| 18 |
* |
| 19 |
* You should have received a copy of the GNU General Public License |
| 20 |
* along with this program; if not, write to the Free Software |
| 21 |
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
| 22 |
*----------------------------------------------------------------------*/ |
| 23 |
|
| 24 |
#include "../config.h" |
| 25 |
#include "rxvt.h" |
| 26 |
|
| 27 |
#ifdef KEYSYM_RESOURCE |
| 28 |
|
| 29 |
#include <cstring> |
| 30 |
|
| 31 |
#include "rxvtperl.h" |
| 32 |
#include "keyboard.h" |
| 33 |
#include "command.h" |
| 34 |
|
| 35 |
/* an intro to the data structure: |
| 36 |
* |
| 37 |
* vector keymap[] is grouped. |
| 38 |
* |
| 39 |
* inside each group, elements are sorted by the criteria given by compare_priority(). |
| 40 |
* the lookup of keysym is done in two steps: |
| 41 |
* 1) locate the group corresponds to the keysym; |
| 42 |
* 2) do a linear search inside the group. |
| 43 |
* |
| 44 |
* array hash[] effectively defines a map from a keysym to a group in keymap[]. |
| 45 |
* |
| 46 |
* each group has its address(the index of first group element in keymap[]), |
| 47 |
* which is computed and stored in hash[]. |
| 48 |
* hash[] stores the addresses in the form of: |
| 49 |
* index: 0 I1 I2 I3 In |
| 50 |
* value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An |
| 51 |
* where |
| 52 |
* A1 = 0; |
| 53 |
* Ai+1 = N1 + N2 + ... + Ni. |
| 54 |
* it is computed from hash_bucket_size[]: |
| 55 |
* index: 0 I1 I2 I3 In |
| 56 |
* value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0 |
| 57 |
* 0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the computation of hash[]) |
| 58 |
* or we can say |
| 59 |
* hash_bucket_size[Ii] = Ni; hash_bucket_size[elsewhere] = 0, |
| 60 |
* where |
| 61 |
* set {I1, I2, ..., In} = { hashkey of keymap[0]->keysym, ..., keymap[keymap.size-1]->keysym } |
| 62 |
* where hashkey of keymap[i]->keysym = keymap[i]->keysym & KEYSYM_HASH_MASK |
| 63 |
* n(the number of groups) = the number of non-zero member of hash_bucket_size[]; |
| 64 |
* Ni(the size of group i) = hash_bucket_size[Ii]. |
| 65 |
*/ |
| 66 |
|
| 67 |
static void |
| 68 |
output_string (rxvt_term *rt, const char *str) |
| 69 |
{ |
| 70 |
if (strncmp (str, "command:", 8) == 0) |
| 71 |
rt->cmdbuf_append (str + 8, strlen (str) - 8); |
| 72 |
else if (strncmp (str, "perl:", 5) == 0) |
| 73 |
HOOK_INVOKE((rt, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END)); |
| 74 |
else |
| 75 |
rt->tt_write (str, strlen (str)); |
| 76 |
} |
| 77 |
|
| 78 |
// return: priority_of_a - priority_of_b |
| 79 |
static int |
| 80 |
compare_priority (keysym_t *a, keysym_t *b) |
| 81 |
{ |
| 82 |
// (the more '1's in state; the less range): the greater priority |
| 83 |
int ca = rxvt_popcount (a->state /* & OtherModMask */); |
| 84 |
int cb = rxvt_popcount (b->state /* & OtherModMask */); |
| 85 |
|
| 86 |
if (ca != cb) |
| 87 |
return ca - cb; |
| 88 |
//else if (a->state != b->state) // this behavior is to be discussed |
| 89 |
// return b->state - a->state; |
| 90 |
else |
| 91 |
return 0; |
| 92 |
} |
| 93 |
|
| 94 |
//////////////////////////////////////////////////////////////////////////////// |
| 95 |
keyboard_manager::keyboard_manager () |
| 96 |
{ |
| 97 |
keymap.reserve (256); |
| 98 |
hash [0] = 1; // hash[0] != 0 indicates uninitialized data |
| 99 |
} |
| 100 |
|
| 101 |
keyboard_manager::~keyboard_manager () |
| 102 |
{ |
| 103 |
clear (); |
| 104 |
} |
| 105 |
|
| 106 |
void |
| 107 |
keyboard_manager::clear () |
| 108 |
{ |
| 109 |
hash [0] = 2; |
| 110 |
|
| 111 |
for (unsigned int i = 0; i < keymap.size (); ++i) |
| 112 |
{ |
| 113 |
free ((void *)keymap [i]->str); |
| 114 |
delete keymap [i]; |
| 115 |
keymap [i] = 0; |
| 116 |
} |
| 117 |
|
| 118 |
keymap.clear (); |
| 119 |
} |
| 120 |
|
| 121 |
// a wrapper for register_keymap, |
| 122 |
// so that outside codes don't have to know so much details. |
| 123 |
// |
| 124 |
// the string 'trans' is copied to an internal managed buffer, |
| 125 |
// so the caller can free memory of 'trans' at any time. |
| 126 |
void |
| 127 |
keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans) |
| 128 |
{ |
| 129 |
keysym_t *key = new keysym_t; |
| 130 |
wchar_t *wc = rxvt_mbstowcs (trans); |
| 131 |
char *translation = rxvt_wcstoutf8 (wc); |
| 132 |
free (wc); |
| 133 |
|
| 134 |
if (key && translation) |
| 135 |
{ |
| 136 |
key->keysym = keysym; |
| 137 |
key->state = state; |
| 138 |
key->str = translation; |
| 139 |
key->type = keysym_t::STRING; |
| 140 |
|
| 141 |
if (strncmp (translation, "builtin:", 8) == 0) |
| 142 |
key->type = keysym_t::BUILTIN; |
| 143 |
|
| 144 |
register_keymap (key); |
| 145 |
} |
| 146 |
else |
| 147 |
{ |
| 148 |
delete key; |
| 149 |
free ((void *)translation); |
| 150 |
rxvt_fatal ("out of memory, aborting.\n"); |
| 151 |
} |
| 152 |
} |
| 153 |
|
| 154 |
void |
| 155 |
keyboard_manager::register_keymap (keysym_t *key) |
| 156 |
{ |
| 157 |
if (keymap.size () == keymap.capacity ()) |
| 158 |
keymap.reserve (keymap.size () * 2); |
| 159 |
|
| 160 |
keymap.push_back (key); |
| 161 |
hash[0] = 3; |
| 162 |
} |
| 163 |
|
| 164 |
void |
| 165 |
keyboard_manager::register_done () |
| 166 |
{ |
| 167 |
setup_hash (); |
| 168 |
} |
| 169 |
|
| 170 |
bool |
| 171 |
keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state) |
| 172 |
{ |
| 173 |
assert (hash[0] == 0 && "register_done() need to be called"); |
| 174 |
|
| 175 |
state &= OtherModMask; // mask out uninteresting modifiers |
| 176 |
|
| 177 |
if (state & term->ModMetaMask) state |= MetaMask; |
| 178 |
if (state & term->ModNumLockMask) state |= NumLockMask; |
| 179 |
if (state & term->ModLevel3Mask) state |= Level3Mask; |
| 180 |
|
| 181 |
if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask)) |
| 182 |
state |= AppKeypadMask; |
| 183 |
|
| 184 |
int index = find_keysym (keysym, state); |
| 185 |
|
| 186 |
if (index >= 0) |
| 187 |
{ |
| 188 |
const keysym_t &key = *keymap [index]; |
| 189 |
|
| 190 |
if (key.type != keysym_t::BUILTIN) |
| 191 |
{ |
| 192 |
wchar_t *wc = rxvt_utf8towcs (key.str); |
| 193 |
char *str = rxvt_wcstombs (wc); |
| 194 |
// TODO: do (some) translations, unescaping etc, here (allow \u escape etc.) |
| 195 |
free (wc); |
| 196 |
|
| 197 |
switch (key.type) |
| 198 |
{ |
| 199 |
case keysym_t::STRING: |
| 200 |
output_string (term, str); |
| 201 |
break; |
| 202 |
} |
| 203 |
|
| 204 |
free (str); |
| 205 |
|
| 206 |
return true; |
| 207 |
} |
| 208 |
} |
| 209 |
|
| 210 |
return false; |
| 211 |
} |
| 212 |
|
| 213 |
void |
| 214 |
keyboard_manager::setup_hash () |
| 215 |
{ |
| 216 |
unsigned int i, index, hashkey; |
| 217 |
vector <keysym_t *> sorted_keymap; |
| 218 |
uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket |
| 219 |
|
| 220 |
memset (hash_bucket_size, 0, sizeof (hash_bucket_size)); |
| 221 |
|
| 222 |
// determine hash bucket size |
| 223 |
for (i = 0; i < keymap.size (); ++i) |
| 224 |
{ |
| 225 |
hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK; |
| 226 |
++hash_bucket_size [hashkey]; |
| 227 |
} |
| 228 |
|
| 229 |
// now we know the size of each bucket |
| 230 |
// compute the index of each bucket |
| 231 |
hash [0] = 0; |
| 232 |
for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i) |
| 233 |
{ |
| 234 |
index += hash_bucket_size [i - 1]; |
| 235 |
hash [i] = index; |
| 236 |
} |
| 237 |
|
| 238 |
// and allocate just enough space |
| 239 |
sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0); |
| 240 |
|
| 241 |
memset (hash_bucket_size, 0, sizeof (hash_bucket_size)); |
| 242 |
|
| 243 |
// fill in sorted_keymap |
| 244 |
// it is sorted in each bucket |
| 245 |
for (i = 0; i < keymap.size (); ++i) |
| 246 |
{ |
| 247 |
hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK; |
| 248 |
|
| 249 |
index = hash [hashkey] + hash_bucket_size [hashkey]; |
| 250 |
|
| 251 |
while (index > hash [hashkey] |
| 252 |
&& compare_priority (keymap [i], sorted_keymap [index - 1]) > 0) |
| 253 |
{ |
| 254 |
sorted_keymap [index] = sorted_keymap [index - 1]; |
| 255 |
--index; |
| 256 |
} |
| 257 |
|
| 258 |
sorted_keymap [index] = keymap [i]; |
| 259 |
++hash_bucket_size [hashkey]; |
| 260 |
} |
| 261 |
|
| 262 |
keymap.swap (sorted_keymap); |
| 263 |
|
| 264 |
#ifndef NDEBUG |
| 265 |
// check for invariants |
| 266 |
for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i) |
| 267 |
{ |
| 268 |
index = hash[i]; |
| 269 |
for (int j = 0; j < hash_bucket_size [i]; ++j) |
| 270 |
{ |
| 271 |
assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK)); |
| 272 |
|
| 273 |
if (j) |
| 274 |
assert (compare_priority (keymap [index + j - 1], |
| 275 |
keymap [index + j]) >= 0); |
| 276 |
} |
| 277 |
} |
| 278 |
|
| 279 |
// this should be able to detect most possible bugs |
| 280 |
for (i = 0; i < sorted_keymap.size (); ++i) |
| 281 |
{ |
| 282 |
keysym_t *a = sorted_keymap[i]; |
| 283 |
int index = find_keysym (a->keysym, a->state); |
| 284 |
|
| 285 |
assert (index >= 0); |
| 286 |
keysym_t *b = keymap [index]; |
| 287 |
assert (i == index // the normally expected result |
| 288 |
|| a->keysym == b->keysym |
| 289 |
&& compare_priority (a, b) <= 0); // is effectively the same or a closer match |
| 290 |
} |
| 291 |
#endif |
| 292 |
} |
| 293 |
|
| 294 |
int |
| 295 |
keyboard_manager::find_keysym (KeySym keysym, unsigned int state) |
| 296 |
{ |
| 297 |
int hashkey = keysym & KEYSYM_HASH_MASK; |
| 298 |
unsigned int index = hash [hashkey]; |
| 299 |
unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1 |
| 300 |
? hash [hashkey + 1] |
| 301 |
: keymap.size (); |
| 302 |
|
| 303 |
for (; index < end; ++index) |
| 304 |
{ |
| 305 |
keysym_t *key = keymap [index]; |
| 306 |
|
| 307 |
if (key->keysym == keysym |
| 308 |
// match only the specified bits in state and ignore others |
| 309 |
&& (key->state & state) == key->state) |
| 310 |
return index; |
| 311 |
} |
| 312 |
|
| 313 |
return -1; |
| 314 |
} |
| 315 |
|
| 316 |
#endif /* KEYSYM_RESOURCE */ |
| 317 |
// vim:et:ts=2:sw=2 |
