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->cmd_write (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 b->range - a->range; |
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->range = 1; |
139 |
key->str = translation; |
140 |
key->type = keysym_t::STRING; |
141 |
|
142 |
if (strncmp (translation, "list", 4) == 0 && translation [4]) |
143 |
{ |
144 |
char *middle = strchr (translation + 5, translation [4]); |
145 |
char *suffix = strrchr (translation + 5, translation [4]); |
146 |
|
147 |
if (suffix && middle && suffix > middle + 1) |
148 |
{ |
149 |
key->type = keysym_t::LIST; |
150 |
key->range = suffix - middle - 1; |
151 |
|
152 |
memmove (translation, translation + 4, strlen (translation + 4) + 1); |
153 |
} |
154 |
else |
155 |
rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation); |
156 |
} |
157 |
else if (strncmp (translation, "builtin:", 8) == 0) |
158 |
key->type = keysym_t::BUILTIN; |
159 |
|
160 |
register_keymap (key); |
161 |
} |
162 |
else |
163 |
{ |
164 |
delete key; |
165 |
free ((void *)translation); |
166 |
rxvt_fatal ("out of memory, aborting.\n"); |
167 |
} |
168 |
} |
169 |
|
170 |
void |
171 |
keyboard_manager::register_keymap (keysym_t *key) |
172 |
{ |
173 |
if (keymap.size () == keymap.capacity ()) |
174 |
keymap.reserve (keymap.size () * 2); |
175 |
|
176 |
keymap.push_back (key); |
177 |
hash[0] = 3; |
178 |
} |
179 |
|
180 |
void |
181 |
keyboard_manager::register_done () |
182 |
{ |
183 |
setup_hash (); |
184 |
} |
185 |
|
186 |
bool |
187 |
keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state) |
188 |
{ |
189 |
assert (hash[0] == 0 && "register_done() need to be called"); |
190 |
|
191 |
state &= OtherModMask; // mask out uninteresting modifiers |
192 |
|
193 |
if (state & term->ModMetaMask) state |= MetaMask; |
194 |
if (state & term->ModNumLockMask) state |= NumLockMask; |
195 |
if (state & term->ModLevel3Mask) state |= Level3Mask; |
196 |
|
197 |
if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask)) |
198 |
state |= AppKeypadMask; |
199 |
|
200 |
int index = find_keysym (keysym, state); |
201 |
|
202 |
if (index >= 0) |
203 |
{ |
204 |
const keysym_t &key = *keymap [index]; |
205 |
|
206 |
if (key.type != keysym_t::BUILTIN) |
207 |
{ |
208 |
int keysym_offset = keysym - key.keysym; |
209 |
|
210 |
wchar_t *wc = rxvt_utf8towcs (key.str); |
211 |
char *str = rxvt_wcstombs (wc); |
212 |
// TODO: do (some) translations, unescaping etc, here (allow \u escape etc.) |
213 |
free (wc); |
214 |
|
215 |
switch (key.type) |
216 |
{ |
217 |
case keysym_t::STRING: |
218 |
output_string (term, str); |
219 |
break; |
220 |
|
221 |
case keysym_t::LIST: |
222 |
{ |
223 |
char buf[STRING_MAX]; |
224 |
|
225 |
char *prefix, *middle, *suffix; |
226 |
|
227 |
prefix = str; |
228 |
middle = strchr (prefix + 1, *prefix); |
229 |
suffix = strrchr (middle + 1, *prefix); |
230 |
|
231 |
memcpy (buf, prefix + 1, middle - prefix - 1); |
232 |
buf [middle - prefix - 1] = middle [keysym_offset + 1]; |
233 |
strcpy (buf + (middle - prefix), suffix + 1); |
234 |
|
235 |
output_string (term, buf); |
236 |
} |
237 |
break; |
238 |
} |
239 |
|
240 |
free (str); |
241 |
|
242 |
return true; |
243 |
} |
244 |
} |
245 |
|
246 |
return false; |
247 |
} |
248 |
|
249 |
void |
250 |
keyboard_manager::setup_hash () |
251 |
{ |
252 |
unsigned int i, index, hashkey; |
253 |
vector <keysym_t *> sorted_keymap; |
254 |
uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket |
255 |
|
256 |
memset (hash_bucket_size, 0, sizeof (hash_bucket_size)); |
257 |
|
258 |
// determine hash bucket size |
259 |
for (i = 0; i < keymap.size (); ++i) |
260 |
for (int j = min (keymap [i]->range, KEYSYM_HASH_BUCKETS) - 1; j >= 0; --j) |
261 |
{ |
262 |
hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; |
263 |
++hash_bucket_size [hashkey]; |
264 |
} |
265 |
|
266 |
// now we know the size of each bucket |
267 |
// compute the index of each bucket |
268 |
hash [0] = 0; |
269 |
for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i) |
270 |
{ |
271 |
index += hash_bucket_size [i - 1]; |
272 |
hash [i] = index; |
273 |
} |
274 |
|
275 |
// and allocate just enough space |
276 |
sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0); |
277 |
|
278 |
memset (hash_bucket_size, 0, sizeof (hash_bucket_size)); |
279 |
|
280 |
// fill in sorted_keymap |
281 |
// it is sorted in each bucket |
282 |
for (i = 0; i < keymap.size (); ++i) |
283 |
for (int j = min (keymap [i]->range, KEYSYM_HASH_BUCKETS) - 1; j >= 0; --j) |
284 |
{ |
285 |
hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; |
286 |
|
287 |
index = hash [hashkey] + hash_bucket_size [hashkey]; |
288 |
|
289 |
while (index > hash [hashkey] |
290 |
&& compare_priority (keymap [i], sorted_keymap [index - 1]) > 0) |
291 |
{ |
292 |
sorted_keymap [index] = sorted_keymap [index - 1]; |
293 |
--index; |
294 |
} |
295 |
|
296 |
sorted_keymap [index] = keymap [i]; |
297 |
++hash_bucket_size [hashkey]; |
298 |
} |
299 |
|
300 |
keymap.swap (sorted_keymap); |
301 |
|
302 |
#ifndef NDEBUG |
303 |
// check for invariants |
304 |
for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i) |
305 |
{ |
306 |
index = hash[i]; |
307 |
for (int j = 0; j < hash_bucket_size [i]; ++j) |
308 |
{ |
309 |
if (keymap [index + j]->range == 1) |
310 |
assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK)); |
311 |
|
312 |
if (j) |
313 |
assert (compare_priority (keymap [index + j - 1], |
314 |
keymap [index + j]) >= 0); |
315 |
} |
316 |
} |
317 |
|
318 |
// this should be able to detect most possible bugs |
319 |
for (i = 0; i < sorted_keymap.size (); ++i) |
320 |
{ |
321 |
keysym_t *a = sorted_keymap[i]; |
322 |
for (int j = 0; j < a->range; ++j) |
323 |
{ |
324 |
int index = find_keysym (a->keysym + j, a->state); |
325 |
|
326 |
assert (index >= 0); |
327 |
keysym_t *b = keymap [index]; |
328 |
assert (i == index // the normally expected result |
329 |
|| IN_RANGE_INC (a->keysym + j, b->keysym, b->keysym + b->range) |
330 |
&& compare_priority (a, b) <= 0); // is effectively the same or a closer match |
331 |
} |
332 |
} |
333 |
#endif |
334 |
} |
335 |
|
336 |
int |
337 |
keyboard_manager::find_keysym (KeySym keysym, unsigned int state) |
338 |
{ |
339 |
int hashkey = keysym & KEYSYM_HASH_MASK; |
340 |
unsigned int index = hash [hashkey]; |
341 |
unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1 |
342 |
? hash [hashkey + 1] |
343 |
: keymap.size (); |
344 |
|
345 |
for (; index < end; ++index) |
346 |
{ |
347 |
keysym_t *key = keymap [index]; |
348 |
|
349 |
if (key->keysym <= keysym && keysym < key->keysym + key->range |
350 |
// match only the specified bits in state and ignore others |
351 |
&& (key->state & state) == key->state) |
352 |
return index; |
353 |
} |
354 |
|
355 |
return -1; |
356 |
} |
357 |
|
358 |
#endif /* KEYSYM_RESOURCE */ |
359 |
// vim:et:ts=2:sw=2 |