ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/keyboard.C
(Generate patch)

Comparing rxvt-unicode/src/keyboard.C (file contents):
Revision 1.8 by root, Mon Jan 17 00:07:26 2005 UTC vs.
Revision 1.54 by sf-exg, Sat Dec 3 11:31:56 2011 UTC

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
1#include "../config.h" 24#include "../config.h"
2#include "rxvt.h" 25#include "rxvt.h"
3 26
4#ifdef KEYSYM_RESOURCE 27#ifdef KEYSYM_RESOURCE
5 28
6#include <cstring> 29#include <cstring>
7 30
31#include "rxvtperl.h"
8#include "keyboard.h" 32#include "keyboard.h"
9#include "command.h" 33#include "command.h"
10 34
11//////////////////////////////////////////////////////////////////////////////// 35/* an intro to the data structure:
12// default keycode translation map and keyevent handlers 36 *
13 37 * vector keymap[] is grouped.
14keysym_t keyboard_manager::stock_keymap[] = { 38 *
15 /* examples */ 39 * inside each group, elements are sorted by the criteria given by compare_priority().
16 /* keysym, state, range, handler, str */ 40 * the lookup of keysym is done in two steps:
17//{XK_ISO_Left_Tab, 0, 1, NORMAL, "\033[Z"}, 41 * 1) locate the group corresponds to the keysym;
18//{ 'a', 0, 26, RANGE_META8, "a" "%c"}, 42 * 2) do a linear search inside the group.
19//{ 'a', ControlMask, 26, RANGE_META8, "" "%c"}, 43 *
20//{ XK_Left, 0, 4, LIST, "DACBZ" "\033[Z"}, 44 * array hash[] effectively defines a map from a keysym to a group in keymap[].
21//{ XK_Left, ShiftMask, 4, LIST, "dacbZ" "\033[Z"}, 45 *
22//{ XK_Left, ControlMask, 4, LIST, "dacbZ" "\033OZ"}, 46 * each group has its address(the index of first group element in keymap[]),
23//{ XK_Tab, ControlMask, 1, NORMAL, "\033<C-Tab>"}, 47 * which is computed and stored in hash[].
24//{ XK_apostrophe, ControlMask, 1, NORMAL, "\033<C-'>"}, 48 * hash[] stores the addresses in the form of:
25//{ XK_slash, ControlMask, 1, NORMAL, "\033<C-/>"}, 49 * index: 0 I1 I2 I3 In
26//{ XK_semicolon, ControlMask, 1, NORMAL, "\033<C-;>"}, 50 * value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An
27//{ XK_grave, ControlMask, 1, NORMAL, "\033<C-`>"}, 51 * where
28//{ XK_comma, ControlMask, 1, NORMAL, "\033<C-\054>"}, 52 * A1 = 0;
29//{ XK_Return, ControlMask, 1, NORMAL, "\033<C-Return>"}, 53 * Ai+1 = N1 + N2 + ... + Ni.
30//{ XK_Return, ShiftMask, 1, NORMAL, "\033<S-Return>"}, 54 * it is computed from hash_bucket_size[]:
31//{ ' ', ShiftMask, 1, NORMAL, "\033<S-Space>"}, 55 * index: 0 I1 I2 I3 In
32//{ '.', ControlMask, 1, NORMAL, "\033<C-.>"}, 56 * value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0
33//{ '0', ControlMask, 10, RANGE, "0" "\033<C-%c>"}, 57 * 0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the computation of hash[])
34//{ '0', MetaMask|ControlMask, 10, RANGE, "0" "\033<M-C-%c>"}, 58 * or we can say
35//{ 'a', MetaMask|ControlMask, 26, RANGE, "a" "\033<M-C-%c>"}, 59 * hash_bucket_size[Ii] = Ni; hash_bucket_size[elsewhere] = 0,
36}; 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 */
37 66
38static void 67static void
39output_string (rxvt_term *rt, const char *str) 68output_string (rxvt_term *term, const char *str)
40{ 69{
70 if (strncmp (str, "command:", 8) == 0)
71 term->cmdbuf_append (str + 8, strlen (str) - 8);
41 if (strncmp (str, "proto:", 6) == 0) 72 else if (strncmp (str, "perl:", 5) == 0)
42 rt->cmd_write ((unsigned char *)str + 6, strlen (str) - 6); 73 HOOK_INVOKE((term, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END));
43 else 74 else
44 rt->tt_write ((unsigned char *)str, strlen (str)); 75 term->tt_write (str, strlen (str));
45} 76}
46
47static void
48output_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
69static int
70format_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
88static int
89bitcount (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 77
100// return: priority_of_a - priority_of_b 78// return: priority_of_a - priority_of_b
101static int 79static int
102compare_priority (keysym_t *a, keysym_t *b) 80compare_priority (keysym_t *a, keysym_t *b)
103{ 81{
104 // (the more '1's in state; the less range): the greater priority 82 // (the more '1's in state; the less range): the greater priority
105 int ca = bitcount (a->state /* & OtherModMask */); 83 int ca = ecb_popcount32 (a->state /* & OtherModMask */);
106 int cb = bitcount (b->state /* & OtherModMask */); 84 int cb = ecb_popcount32 (b->state /* & OtherModMask */);
107 85
108 if (ca != cb) 86 if (ca != cb)
109 return ca - cb; 87 return ca - cb;
110//else if (a->state != b->state) // this behavior is to be disscussed 88//else if (a->state != b->state) // this behavior is to be discussed
111// return b->state - a->state; 89// return b->state - a->state;
112 else 90 else
113 return b->range - a->range; 91 return 0;
114} 92}
115 93
116//////////////////////////////////////////////////////////////////////////////// 94////////////////////////////////////////////////////////////////////////////////
117keyboard_manager::keyboard_manager () 95keyboard_manager::keyboard_manager ()
118{ 96{
… …
120 hash [0] = 1; // hash[0] != 0 indicates uninitialized data 98 hash [0] = 1; // hash[0] != 0 indicates uninitialized data
121} 99}
122 100
123keyboard_manager::~keyboard_manager () 101keyboard_manager::~keyboard_manager ()
124{ 102{
125 clear (); 103 for (unsigned int i = 0; i < keymap.size (); ++i)
104 {
105 free (keymap [i]->str);
106 delete keymap [i];
107 }
126} 108}
127 109
128void 110void
129keyboard_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.
155void
156keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans) 111keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const wchar_t *ws)
157{ 112{
113 char *translation = rxvt_wcstoutf8 (ws);
114
158 keysym_t *key = new keysym_t; 115 keysym_t *key = new keysym_t;
159 wchar_t *wc = rxvt_mbstowcs (trans);
160 const char *translation = rxvt_wcstoutf8 (wc);
161 free (wc);
162 116
163 if (key && translation) 117 if (key && translation)
164 { 118 {
165 key->keysym = keysym; 119 key->keysym = keysym;
166 key->state = state; 120 key->state = state;
167 key->range = 1;
168 key->str = translation; 121 key->str = translation;
169 key->type = keysym_t::NORMAL; 122 key->type = keysym_t::STRING;
170 123
171 if (strncmp (translation, "list", 4) == 0 && translation [4]) 124 if (strncmp (translation, "builtin:", 8) == 0)
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; 125 key->type = keysym_t::BUILTIN;
179 key->range = suffix - middle - 1;
180 126
181 strcpy (translation, translation + 4); 127 if (keymap.size () == keymap.capacity ())
182 } 128 keymap.reserve (keymap.size () * 2);
183 else
184 rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation);
185 }
186 129
187 user_keymap.push_back (key); 130 keymap.push_back (key);
188 user_translations.push_back (translation); 131 hash[0] = 3;
189 register_keymap (key);
190 } 132 }
191 else 133 else
192 { 134 {
193 delete key; 135 delete key;
194 free ((void *)translation); 136 free (translation);
195 rxvt_fatal ("out of memory, aborting.\n"); 137 rxvt_fatal ("memory allocation failure. aborting.\n");
196 } 138 }
197}
198
199void
200keyboard_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
209void
210keyboard_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} 139}
222 140
223bool 141bool
224keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state) 142keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
225{ 143{
226 assert (hash[0] == 0 && "register_done() need to be called"); 144 assert (("register_done() need to be called", hash[0] == 0));
145
146 state &= OtherModMask; // mask out uninteresting modifiers
227 147
228 if (state & term->ModMetaMask) state |= MetaMask; 148 if (state & term->ModMetaMask) state |= MetaMask;
229 if (state & term->ModNumLockMask) state |= NumLockMask; 149 if (state & term->ModNumLockMask) state |= NumLockMask;
230 if (state & term->ModLevel3Mask) state |= Level3Mask; 150 if (state & term->ModLevel3Mask) state |= Level3Mask;
231 151
… …
234 154
235 int index = find_keysym (keysym, state); 155 int index = find_keysym (keysym, state);
236 156
237 if (index >= 0) 157 if (index >= 0)
238 { 158 {
239 const keysym_t &key = *keymap [index]; 159 keysym_t *key = keymap [index];
240 160
241 int keysym_offset = keysym - key.keysym; 161 if (key->type != keysym_t::BUILTIN)
242
243 wchar_t *wc = rxvt_utf8towcs (key.str);
244
245 char *str = rxvt_wcstombs (wc);
246 // TODO: do translations, unescaping etc, here (allow \u escape etc.)
247 free (wc);
248
249 switch (key.type)
250 { 162 {
251 case keysym_t::NORMAL: 163 wchar_t *ws = rxvt_utf8towcs (key->str);
164 char *str = rxvt_wcstombs (ws);
165 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
166 free (ws);
167
252 output_string (term, str); 168 output_string (term, str);
253 break;
254 169
255 case keysym_t::RANGE: 170 free (str);
256 {
257 char buf[STRING_MAX];
258 171
259 if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0) 172 return true;
260 output_string (term, buf);
261 }
262 break;
263
264 case keysym_t::RANGE_META8:
265 {
266 int len;
267 char buf[STRING_MAX];
268
269 len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf));
270 if (len > 0)
271 output_string_meta8 (term, state, buf, len);
272 }
273 break;
274
275 case keysym_t::LIST:
276 {
277 char buf[STRING_MAX];
278
279 char *prefix, *middle, *suffix;
280
281 prefix = str;
282 middle = strchr (prefix + 1, *prefix);
283 suffix = strrchr (middle + 1, *prefix);
284
285 memcpy (buf, prefix + 1, middle - prefix - 1);
286 buf [middle - prefix - 1] = middle [keysym_offset + 1];
287 strcpy (buf + (middle - prefix), suffix + 1);
288
289 output_string (term, buf);
290 }
291 break;
292 } 173 }
293
294 free (str);
295
296 return true;
297 }
298 else
299 { 174 }
300 // fprintf(stderr,"[%x:%x]",state,keysym); 175
301 return false; 176 return false;
302 }
303}
304
305// purge duplicate keymap entries
306void keyboard_manager::purge_duplicate_keymap ()
307{
308 for (unsigned int i = 0; i < keymap.size (); ++i)
309 {
310 for (unsigned int j = 0; j < i; ++j)
311 {
312 if (keymap [i] == keymap [j])
313 {
314 while (keymap [i] == keymap.back ())
315 keymap.pop_back ();
316
317 if (i < keymap.size ())
318 {
319 keymap[i] = keymap.back ();
320 keymap.pop_back ();
321 }
322 break;
323 }
324 }
325 }
326} 177}
327 178
328void 179void
329keyboard_manager::setup_hash () 180keyboard_manager::register_done ()
330{ 181{
331 unsigned int i, index, hashkey; 182 unsigned int i, index, hashkey;
332 vector <keysym_t *> sorted_keymap; 183 vector <keysym_t *> sorted_keymap;
333 uint16_t hash_budget_size[KEYSYM_HASH_BUDGETS]; // size of each budget 184 uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket
334 uint16_t hash_budget_counter[KEYSYM_HASH_BUDGETS]; // #elements in each budget
335 185
336 memset (hash_budget_size, 0, sizeof (hash_budget_size)); 186 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
337 memset (hash_budget_counter, 0, sizeof (hash_budget_counter));
338 187
339 // count keysyms for corresponding hash budgets 188 // determine hash bucket size
340 for (i = 0; i < keymap.size (); ++i) 189 for (i = 0; i < keymap.size (); ++i)
341 { 190 {
342 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK; 191 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
343 ++hash_budget_size [hashkey]; 192 ++hash_bucket_size [hashkey];
193 }
194
195 // now we know the size of each bucket
196 // compute the index of each bucket
197 hash [0] = 0;
198 for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i)
344 } 199 {
200 index += hash_bucket_size [i - 1];
201 hash [i] = index;
202 }
345 203
346 // a keysym_t with range>1 is counted one more time for every keysym that 204 // and allocate just enough space
347 // lies in its range 205 sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0);
206
207 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
208
209 // fill in sorted_keymap
210 // it is sorted in each bucket
348 for (i = 0; i < keymap.size (); ++i) 211 for (i = 0; i < keymap.size (); ++i)
349 { 212 {
350 if (keymap[i]->range > 1) 213 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
214
215 index = hash [hashkey] + hash_bucket_size [hashkey];
216
217 while (index > hash [hashkey]
218 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
351 { 219 {
352 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j > 0; --j) 220 sorted_keymap [index] = sorted_keymap [index - 1];
353 { 221 --index;
354 hashkey = ((keymap [i]->keysym + j) & KEYSYM_HASH_MASK);
355 if (hash_budget_size [hashkey])
356 ++hash_budget_size [hashkey];
357 }
358 } 222 }
359 }
360 223
361 // now we know the size of each budget 224 sorted_keymap [index] = keymap [i];
362 // compute the index of each budget 225 ++hash_bucket_size [hashkey];
363 hash [0] = 0; 226 }
227
228 keymap.swap (sorted_keymap);
229
230#ifndef NDEBUG
231 // check for invariants
364 for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i) 232 for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
365 {
366 index += hash_budget_size [i - 1];
367 hash[i] = (hash_budget_size [i] ? index : hash [i - 1]);
368 } 233 {
369 234 index = hash[i];
370 // and allocate just enough space 235 for (int j = 0; j < hash_bucket_size [i]; ++j)
371 //sorted_keymap.reserve (hash[i - 1] + hash_budget_size[i - 1]);
372 sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0);
373
374 // fill in sorted_keymap
375 // it is sorted in each budget
376 for (i = 0; i < keymap.size (); ++i)
377 {
378 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
379 { 236 {
380 hashkey = ((keymap [i]->keysym + j) & KEYSYM_HASH_MASK);
381
382 if (hash_budget_size [hashkey])
383 {
384 index = hash [hashkey] + hash_budget_counter [hashkey];
385
386 while (index > hash [hashkey]
387 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
388 {
389 sorted_keymap [index] = sorted_keymap [index - 1];
390 --index;
391 }
392
393 sorted_keymap [index] = keymap [i];
394 ++hash_budget_counter [hashkey];
395 }
396 }
397 }
398
399 keymap.swap (sorted_keymap);
400
401#if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD)
402 // check for invariants
403 for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i)
404 {
405 index = hash[i];
406 for (int j = 0; j < hash_budget_size [i]; ++j)
407 {
408 if (keymap [index + j]->range == 1)
409 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK)); 237 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
410 238
411 if (j) 239 if (j)
412 assert (compare_priority (keymap [index + j - 1], 240 assert (compare_priority (keymap [index + j - 1],
413 keymap [index + j]) >= 0); 241 keymap [index + j]) >= 0);
414 } 242 }
… …
416 244
417 // this should be able to detect most possible bugs 245 // this should be able to detect most possible bugs
418 for (i = 0; i < sorted_keymap.size (); ++i) 246 for (i = 0; i < sorted_keymap.size (); ++i)
419 { 247 {
420 keysym_t *a = sorted_keymap[i]; 248 keysym_t *a = sorted_keymap[i];
421 for (int j = 0; j < a->range; ++j)
422 {
423 int index = find_keysym (a->keysym + j, a->state); 249 int index = find_keysym (a->keysym, a->state);
424 250
425 assert (index >= 0); 251 assert (index >= 0);
426 keysym_t *b = keymap [index]; 252 keysym_t *b = keymap [index];
427 assert (i == (signed) index || // the normally expected result 253 assert (i == index // the normally expected result
428 (a->keysym + j) >= b->keysym && (a->keysym + j) <= (b->keysym + b->range) && compare_priority (a, b) <= 0); // is effectively the same 254 || a->keysym == b->keysym
429 } 255 && compare_priority (a, b) <= 0); // is effectively the same or a closer match
430 } 256 }
431#endif 257#endif
432} 258}
433 259
434int 260int
435keyboard_manager::find_keysym (KeySym keysym, unsigned int state) 261keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
436{ 262{
437 int hashkey = keysym & KEYSYM_HASH_MASK; 263 int hashkey = keysym & KEYSYM_HASH_MASK;
438 unsigned int index = hash [hashkey]; 264 unsigned int index = hash [hashkey];
265 unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1
266 ? hash [hashkey + 1]
267 : keymap.size ();
439 268
440 for (; index < keymap.size (); ++index) 269 for (; index < end; ++index)
441 { 270 {
442 keysym_t *key = keymap [index]; 271 keysym_t *key = keymap [index];
443 272
444 if (key->keysym <= keysym && key->keysym + key->range > keysym 273 if (key->keysym == keysym
445 // match only the specified bits in state and ignore others 274 // match only the specified bits in state and ignore others
446 && (key->state & state) == key->state) 275 && (key->state & state) == key->state)
447 return index; 276 return index;
448 else if (key->keysym > keysym && key->range == 1)
449 return -1;
450 } 277 }
451 278
452 return -1; 279 return -1;
453} 280}
454 281

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines