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

Diff Legend

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