1 |
root |
1.25 |
/*----------------------------------------------------------------------* |
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 |
root |
1.39 |
* Copyright (c) 2005-2006 Marc Lehmann <schmorp@schmorp.de> |
8 |
root |
1.25 |
* |
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 |
root |
1.1 |
#include "../config.h" |
25 |
|
|
#include "rxvt.h" |
26 |
root |
1.7 |
|
27 |
|
|
#ifdef KEYSYM_RESOURCE |
28 |
|
|
|
29 |
|
|
#include <cstring> |
30 |
|
|
|
31 |
root |
1.18 |
#include "rxvtperl.h" |
32 |
root |
1.1 |
#include "keyboard.h" |
33 |
|
|
#include "command.h" |
34 |
|
|
|
35 |
root |
1.13 |
/* 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 |
sf-exg |
1.34 |
* it is computed from hash_bucket_size[]: |
55 |
root |
1.13 |
* index: 0 I1 I2 I3 In |
56 |
|
|
* value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0 |
57 |
sf-exg |
1.33 |
* 0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the computation of hash[]) |
58 |
root |
1.13 |
* or we can say |
59 |
sf-exg |
1.34 |
* hash_bucket_size[Ii] = Ni; hash_bucket_size[elsewhere] = 0, |
60 |
root |
1.13 |
* 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 |
sf-exg |
1.34 |
* 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 |
root |
1.13 |
*/ |
66 |
|
|
|
67 |
root |
1.2 |
static void |
68 |
|
|
output_string (rxvt_term *rt, const char *str) |
69 |
root |
1.1 |
{ |
70 |
root |
1.10 |
if (strncmp (str, "command:", 8) == 0) |
71 |
root |
1.40 |
rt->cmdbuf_append (str + 8, strlen (str) - 8); |
72 |
root |
1.18 |
else if (strncmp (str, "perl:", 5) == 0) |
73 |
root |
1.24 |
HOOK_INVOKE((rt, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END)); |
74 |
root |
1.1 |
else |
75 |
root |
1.19 |
rt->tt_write (str, strlen (str)); |
76 |
root |
1.1 |
} |
77 |
|
|
|
78 |
|
|
// return: priority_of_a - priority_of_b |
79 |
root |
1.2 |
static int |
80 |
root |
1.1 |
compare_priority (keysym_t *a, keysym_t *b) |
81 |
|
|
{ |
82 |
|
|
// (the more '1's in state; the less range): the greater priority |
83 |
sf-exg |
1.43 |
int ca = ecb_popcount32 (a->state /* & OtherModMask */); |
84 |
|
|
int cb = ecb_popcount32 (b->state /* & OtherModMask */); |
85 |
root |
1.2 |
|
86 |
root |
1.1 |
if (ca != cb) |
87 |
|
|
return ca - cb; |
88 |
sf-exg |
1.33 |
//else if (a->state != b->state) // this behavior is to be discussed |
89 |
root |
1.1 |
// return b->state - a->state; |
90 |
|
|
else |
91 |
sf-exg |
1.41 |
return 0; |
92 |
root |
1.1 |
} |
93 |
|
|
|
94 |
|
|
//////////////////////////////////////////////////////////////////////////////// |
95 |
root |
1.2 |
keyboard_manager::keyboard_manager () |
96 |
root |
1.1 |
{ |
97 |
root |
1.2 |
keymap.reserve (256); |
98 |
root |
1.4 |
hash [0] = 1; // hash[0] != 0 indicates uninitialized data |
99 |
root |
1.1 |
} |
100 |
|
|
|
101 |
|
|
keyboard_manager::~keyboard_manager () |
102 |
|
|
{ |
103 |
|
|
clear (); |
104 |
|
|
} |
105 |
|
|
|
106 |
|
|
void |
107 |
|
|
keyboard_manager::clear () |
108 |
|
|
{ |
109 |
root |
1.2 |
hash [0] = 2; |
110 |
sf-exg |
1.36 |
|
111 |
sf-exg |
1.37 |
for (unsigned int i = 0; i < keymap.size (); ++i) |
112 |
sf-exg |
1.36 |
{ |
113 |
sf-exg |
1.45 |
free (keymap [i]->str); |
114 |
sf-exg |
1.37 |
delete keymap [i]; |
115 |
|
|
keymap [i] = 0; |
116 |
sf-exg |
1.36 |
} |
117 |
|
|
|
118 |
sf-exg |
1.37 |
keymap.clear (); |
119 |
root |
1.1 |
} |
120 |
|
|
|
121 |
sf-exg |
1.42 |
// a wrapper for register_translation that converts the input string |
122 |
|
|
// to utf-8 and expands 'list' syntax. |
123 |
root |
1.1 |
void |
124 |
root |
1.2 |
keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans) |
125 |
root |
1.1 |
{ |
126 |
root |
1.2 |
wchar_t *wc = rxvt_mbstowcs (trans); |
127 |
root |
1.19 |
char *translation = rxvt_wcstoutf8 (wc); |
128 |
root |
1.2 |
free (wc); |
129 |
root |
1.1 |
|
130 |
sf-exg |
1.42 |
if (strncmp (translation, "list", 4) == 0 && translation [4] |
131 |
|
|
&& strlen (translation) < STRING_MAX) |
132 |
|
|
{ |
133 |
|
|
char *prefix = translation + 4; |
134 |
|
|
char *middle = strchr (prefix + 1, translation [4]); |
135 |
|
|
char *suffix = strrchr (prefix + 1, translation [4]); |
136 |
|
|
|
137 |
|
|
if (suffix && middle && suffix > middle + 1) |
138 |
|
|
{ |
139 |
|
|
int range = suffix - middle - 1; |
140 |
|
|
int prefix_len = middle - prefix - 1; |
141 |
|
|
char buf[STRING_MAX]; |
142 |
|
|
|
143 |
|
|
memcpy (buf, prefix + 1, prefix_len); |
144 |
|
|
strcpy (buf + prefix_len + 1, suffix + 1); |
145 |
|
|
|
146 |
|
|
for (int i = 0; i < range; i++) |
147 |
|
|
{ |
148 |
|
|
buf [prefix_len] = middle [i + 1]; |
149 |
|
|
register_translation (keysym + i, state, strdup (buf)); |
150 |
|
|
} |
151 |
|
|
|
152 |
|
|
free (translation); |
153 |
|
|
return; |
154 |
|
|
} |
155 |
|
|
else |
156 |
sf-exg |
1.46 |
rxvt_warn ("unable to parse list-type keysym '%s', processing as normal keysym.\n", translation); |
157 |
sf-exg |
1.42 |
} |
158 |
|
|
|
159 |
|
|
register_translation (keysym, state, translation); |
160 |
|
|
} |
161 |
|
|
|
162 |
|
|
void |
163 |
|
|
keyboard_manager::register_translation (KeySym keysym, unsigned int state, char *translation) |
164 |
|
|
{ |
165 |
|
|
keysym_t *key = new keysym_t; |
166 |
|
|
|
167 |
root |
1.2 |
if (key && translation) |
168 |
root |
1.1 |
{ |
169 |
|
|
key->keysym = keysym; |
170 |
root |
1.2 |
key->state = state; |
171 |
|
|
key->str = translation; |
172 |
root |
1.22 |
key->type = keysym_t::STRING; |
173 |
root |
1.2 |
|
174 |
sf-exg |
1.41 |
if (strncmp (translation, "builtin:", 8) == 0) |
175 |
root |
1.16 |
key->type = keysym_t::BUILTIN; |
176 |
root |
1.1 |
|
177 |
|
|
register_keymap (key); |
178 |
|
|
} |
179 |
|
|
else |
180 |
|
|
{ |
181 |
|
|
delete key; |
182 |
sf-exg |
1.45 |
free (translation); |
183 |
sf-exg |
1.46 |
rxvt_fatal ("memory allocation failure. aborting.\n"); |
184 |
root |
1.1 |
} |
185 |
|
|
} |
186 |
|
|
|
187 |
|
|
void |
188 |
|
|
keyboard_manager::register_keymap (keysym_t *key) |
189 |
|
|
{ |
190 |
root |
1.2 |
if (keymap.size () == keymap.capacity ()) |
191 |
|
|
keymap.reserve (keymap.size () * 2); |
192 |
root |
1.1 |
|
193 |
root |
1.2 |
keymap.push_back (key); |
194 |
|
|
hash[0] = 3; |
195 |
root |
1.1 |
} |
196 |
|
|
|
197 |
|
|
void |
198 |
|
|
keyboard_manager::register_done () |
199 |
|
|
{ |
200 |
|
|
setup_hash (); |
201 |
|
|
} |
202 |
|
|
|
203 |
root |
1.2 |
bool |
204 |
|
|
keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state) |
205 |
root |
1.1 |
{ |
206 |
sf-exg |
1.46 |
assert (("register_done() need to be called", hash[0] == 0)); |
207 |
root |
1.1 |
|
208 |
root |
1.14 |
state &= OtherModMask; // mask out uninteresting modifiers |
209 |
|
|
|
210 |
root |
1.6 |
if (state & term->ModMetaMask) state |= MetaMask; |
211 |
|
|
if (state & term->ModNumLockMask) state |= NumLockMask; |
212 |
|
|
if (state & term->ModLevel3Mask) state |= Level3Mask; |
213 |
root |
1.3 |
|
214 |
|
|
if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask)) |
215 |
|
|
state |= AppKeypadMask; |
216 |
|
|
|
217 |
root |
1.1 |
int index = find_keysym (keysym, state); |
218 |
|
|
|
219 |
|
|
if (index >= 0) |
220 |
|
|
{ |
221 |
root |
1.2 |
const keysym_t &key = *keymap [index]; |
222 |
|
|
|
223 |
root |
1.16 |
if (key.type != keysym_t::BUILTIN) |
224 |
|
|
{ |
225 |
|
|
wchar_t *wc = rxvt_utf8towcs (key.str); |
226 |
|
|
char *str = rxvt_wcstombs (wc); |
227 |
|
|
// TODO: do (some) translations, unescaping etc, here (allow \u escape etc.) |
228 |
|
|
free (wc); |
229 |
root |
1.2 |
|
230 |
sf-exg |
1.44 |
output_string (term, str); |
231 |
root |
1.2 |
|
232 |
root |
1.16 |
free (str); |
233 |
root |
1.2 |
|
234 |
root |
1.16 |
return true; |
235 |
|
|
} |
236 |
root |
1.1 |
} |
237 |
root |
1.16 |
|
238 |
|
|
return false; |
239 |
root |
1.1 |
} |
240 |
|
|
|
241 |
|
|
void |
242 |
|
|
keyboard_manager::setup_hash () |
243 |
|
|
{ |
244 |
|
|
unsigned int i, index, hashkey; |
245 |
root |
1.2 |
vector <keysym_t *> sorted_keymap; |
246 |
sf-exg |
1.34 |
uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket |
247 |
root |
1.1 |
|
248 |
sf-exg |
1.34 |
memset (hash_bucket_size, 0, sizeof (hash_bucket_size)); |
249 |
root |
1.1 |
|
250 |
root |
1.11 |
// determine hash bucket size |
251 |
root |
1.2 |
for (i = 0; i < keymap.size (); ++i) |
252 |
sf-exg |
1.41 |
{ |
253 |
|
|
hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK; |
254 |
|
|
++hash_bucket_size [hashkey]; |
255 |
|
|
} |
256 |
root |
1.1 |
|
257 |
sf-exg |
1.34 |
// now we know the size of each bucket |
258 |
|
|
// compute the index of each bucket |
259 |
root |
1.4 |
hash [0] = 0; |
260 |
sf-exg |
1.34 |
for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i) |
261 |
root |
1.1 |
{ |
262 |
sf-exg |
1.34 |
index += hash_bucket_size [i - 1]; |
263 |
root |
1.11 |
hash [i] = index; |
264 |
root |
1.1 |
} |
265 |
root |
1.2 |
|
266 |
root |
1.1 |
// and allocate just enough space |
267 |
sf-exg |
1.34 |
sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0); |
268 |
root |
1.1 |
|
269 |
sf-exg |
1.38 |
memset (hash_bucket_size, 0, sizeof (hash_bucket_size)); |
270 |
|
|
|
271 |
root |
1.1 |
// fill in sorted_keymap |
272 |
sf-exg |
1.34 |
// it is sorted in each bucket |
273 |
root |
1.2 |
for (i = 0; i < keymap.size (); ++i) |
274 |
sf-exg |
1.41 |
{ |
275 |
|
|
hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK; |
276 |
|
|
|
277 |
|
|
index = hash [hashkey] + hash_bucket_size [hashkey]; |
278 |
|
|
|
279 |
|
|
while (index > hash [hashkey] |
280 |
|
|
&& compare_priority (keymap [i], sorted_keymap [index - 1]) > 0) |
281 |
|
|
{ |
282 |
|
|
sorted_keymap [index] = sorted_keymap [index - 1]; |
283 |
|
|
--index; |
284 |
|
|
} |
285 |
|
|
|
286 |
|
|
sorted_keymap [index] = keymap [i]; |
287 |
|
|
++hash_bucket_size [hashkey]; |
288 |
|
|
} |
289 |
root |
1.1 |
|
290 |
root |
1.2 |
keymap.swap (sorted_keymap); |
291 |
root |
1.1 |
|
292 |
root |
1.32 |
#ifndef NDEBUG |
293 |
root |
1.1 |
// check for invariants |
294 |
sf-exg |
1.34 |
for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i) |
295 |
root |
1.1 |
{ |
296 |
root |
1.2 |
index = hash[i]; |
297 |
sf-exg |
1.34 |
for (int j = 0; j < hash_bucket_size [i]; ++j) |
298 |
root |
1.1 |
{ |
299 |
sf-exg |
1.41 |
assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK)); |
300 |
root |
1.2 |
|
301 |
root |
1.1 |
if (j) |
302 |
root |
1.4 |
assert (compare_priority (keymap [index + j - 1], |
303 |
|
|
keymap [index + j]) >= 0); |
304 |
root |
1.1 |
} |
305 |
|
|
} |
306 |
|
|
|
307 |
|
|
// this should be able to detect most possible bugs |
308 |
|
|
for (i = 0; i < sorted_keymap.size (); ++i) |
309 |
|
|
{ |
310 |
|
|
keysym_t *a = sorted_keymap[i]; |
311 |
sf-exg |
1.41 |
int index = find_keysym (a->keysym, a->state); |
312 |
root |
1.6 |
|
313 |
sf-exg |
1.41 |
assert (index >= 0); |
314 |
|
|
keysym_t *b = keymap [index]; |
315 |
|
|
assert (i == index // the normally expected result |
316 |
|
|
|| a->keysym == b->keysym |
317 |
|
|
&& compare_priority (a, b) <= 0); // is effectively the same or a closer match |
318 |
root |
1.1 |
} |
319 |
|
|
#endif |
320 |
|
|
} |
321 |
|
|
|
322 |
|
|
int |
323 |
|
|
keyboard_manager::find_keysym (KeySym keysym, unsigned int state) |
324 |
|
|
{ |
325 |
root |
1.2 |
int hashkey = keysym & KEYSYM_HASH_MASK; |
326 |
|
|
unsigned int index = hash [hashkey]; |
327 |
sf-exg |
1.34 |
unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1 |
328 |
ayin |
1.28 |
? hash [hashkey + 1] |
329 |
root |
1.11 |
: keymap.size (); |
330 |
root |
1.1 |
|
331 |
root |
1.11 |
for (; index < end; ++index) |
332 |
root |
1.1 |
{ |
333 |
root |
1.4 |
keysym_t *key = keymap [index]; |
334 |
root |
1.2 |
|
335 |
sf-exg |
1.41 |
if (key->keysym == keysym |
336 |
root |
1.1 |
// match only the specified bits in state and ignore others |
337 |
root |
1.16 |
&& (key->state & state) == key->state) |
338 |
root |
1.2 |
return index; |
339 |
root |
1.1 |
} |
340 |
|
|
|
341 |
|
|
return -1; |
342 |
|
|
} |
343 |
|
|
|
344 |
|
|
#endif /* KEYSYM_RESOURCE */ |
345 |
|
|
// vim:et:ts=2:sw=2 |