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

Diff Legend

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