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.11 by root, Sun Feb 6 15:18:01 2005 UTC vs.
Revision 1.56 by sf-exg, Mon Dec 5 12:22:50 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, keysym_t::NORMAL, "\033[Z"}, 41 * 1) locate the group corresponds to the keysym;
18//{ 'a', 0, 26, keysym_t::RANGE_META8, "a" "%c"}, 42 * 2) do a linear search inside the group.
19//{ 'a', ControlMask, 26, keysym_t::RANGE_META8, "" "%c"}, 43 *
20//{ XK_Left, 0, 4, keysym_t::LIST, ".\033[.DACB."}, 44 * array hash[] effectively defines a map from a keysym to a group in keymap[].
21//{ XK_Left, ShiftMask, 4, keysym_t::LIST, ".\033[.dacb."}, 45 *
22//{ XK_Left, ControlMask, 4, keysym_t::LIST, ".\033O.dacb."}, 46 * each group has its address(the index of first group element in keymap[]),
23//{ XK_Tab, ControlMask, 1, keysym_t::NORMAL, "\033<C-Tab>"}, 47 * which is computed and stored in hash[].
24//{ XK_apostrophe, ControlMask, 1, keysym_t::NORMAL, "\033<C-'>"}, 48 * hash[] stores the addresses in the form of:
25//{ XK_slash, ControlMask, 1, keysym_t::NORMAL, "\033<C-/>"}, 49 * index: 0 I1 I2 I3 In
26//{ XK_semicolon, ControlMask, 1, keysym_t::NORMAL, "\033<C-;>"}, 50 * value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An
27//{ XK_grave, ControlMask, 1, keysym_t::NORMAL, "\033<C-`>"}, 51 * where
28//{ XK_comma, ControlMask, 1, keysym_t::NORMAL, "\033<C-\054>"}, 52 * A1 = 0;
29//{ XK_Return, ControlMask, 1, keysym_t::NORMAL, "\033<C-Return>"}, 53 * Ai+1 = N1 + N2 + ... + Ni.
30//{ XK_Return, ShiftMask, 1, keysym_t::NORMAL, "\033<S-Return>"}, 54 * it is computed from hash_bucket_size[]:
31//{ ' ', ShiftMask, 1, keysym_t::NORMAL, "\033<S-Space>"}, 55 * index: 0 I1 I2 I3 In
32//{ '.', ControlMask, 1, keysym_t::NORMAL, "\033<C-.>"}, 56 * value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0
33//{ '0', ControlMask, 10, keysym_t::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, keysym_t::RANGE, "0" "\033<M-C-%c>"}, 58 * or we can say
35//{ 'a', MetaMask|ControlMask, 26, keysym_t::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{
41 if (strncmp (str, "command:", 8) == 0) 70 if (strncmp (str, "command:", 8) == 0)
42 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));
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)
164 {
165 key->keysym = keysym; 117 key->keysym = keysym;
166 key->state = state; 118 key->state = state;
167 key->range = 1;
168 key->str = translation; 119 key->str = translation;
169 key->type = keysym_t::NORMAL; 120 key->type = keysym_t::STRING;
170 121
171 if (strncmp (translation, "list", 4) == 0 && translation [4]) 122 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; 123 key->type = keysym_t::BUILTIN;
179 key->range = suffix - middle - 1;
180 124
181 strcpy (translation, translation + 4);
182 }
183 else
184 rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation);
185 }
186
187 user_keymap.push_back (key);
188 user_translations.push_back (translation);
189 register_keymap (key);
190 }
191 else
192 {
193 delete key;
194 free ((void *)translation);
195 rxvt_fatal ("out of memory, aborting.\n");
196 }
197}
198
199void
200keyboard_manager::register_keymap (keysym_t *key)
201{
202 if (keymap.size () == keymap.capacity ()) 125 if (keymap.size () == keymap.capacity ())
203 keymap.reserve (keymap.size () * 2); 126 keymap.reserve (keymap.size () * 2);
204 127
205 keymap.push_back (key); 128 keymap.push_back (key);
206 hash[0] = 3; 129 hash[0] = 3;
207} 130}
208 131
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}
222
223bool 132bool
224keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state) 133keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
225{ 134{
226 assert (hash[0] == 0 && "register_done() need to be called"); 135 assert (("register_done() need to be called", hash[0] == 0));
136
137 state &= OtherModMask; // mask out uninteresting modifiers
227 138
228 if (state & term->ModMetaMask) state |= MetaMask; 139 if (state & term->ModMetaMask) state |= MetaMask;
229 if (state & term->ModNumLockMask) state |= NumLockMask; 140 if (state & term->ModNumLockMask) state |= NumLockMask;
230 if (state & term->ModLevel3Mask) state |= Level3Mask; 141 if (state & term->ModLevel3Mask) state |= Level3Mask;
231 142
… …
234 145
235 int index = find_keysym (keysym, state); 146 int index = find_keysym (keysym, state);
236 147
237 if (index >= 0) 148 if (index >= 0)
238 { 149 {
239 const keysym_t &key = *keymap [index]; 150 keysym_t *key = keymap [index];
240 151
241 int keysym_offset = keysym - key.keysym; 152 if (key->type != keysym_t::BUILTIN)
242
243 wchar_t *wc = rxvt_utf8towcs (key.str);
244 char *str = rxvt_wcstombs (wc);
245 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
246 free (wc);
247
248 switch (key.type)
249 { 153 {
250 case keysym_t::NORMAL: 154 wchar_t *ws = rxvt_utf8towcs (key->str);
155 char *str = rxvt_wcstombs (ws);
156 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
157 free (ws);
158
251 output_string (term, str); 159 output_string (term, str);
252 break;
253 160
254 case keysym_t::RANGE: 161 free (str);
255 {
256 char buf[STRING_MAX];
257 162
258 if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0) 163 return true;
259 output_string (term, buf);
260 }
261 break;
262
263 case keysym_t::RANGE_META8:
264 {
265 int len;
266 char buf[STRING_MAX];
267
268 len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf));
269 if (len > 0)
270 output_string_meta8 (term, state, buf, len);
271 }
272 break;
273
274 case keysym_t::LIST:
275 {
276 char buf[STRING_MAX];
277
278 char *prefix, *middle, *suffix;
279
280 prefix = str;
281 middle = strchr (prefix + 1, *prefix);
282 suffix = strrchr (middle + 1, *prefix);
283
284 memcpy (buf, prefix + 1, middle - prefix - 1);
285 buf [middle - prefix - 1] = middle [keysym_offset + 1];
286 strcpy (buf + (middle - prefix), suffix + 1);
287
288 output_string (term, buf);
289 }
290 break;
291 } 164 }
292
293 free (str);
294
295 return true;
296 } 165 }
297 else 166
298 return false; 167 return false;
299}
300
301// purge duplicate keymap entries
302void keyboard_manager::purge_duplicate_keymap ()
303{
304 for (unsigned int i = 0; i < keymap.size (); ++i)
305 {
306 for (unsigned int j = 0; j < i; ++j)
307 {
308 if (keymap [i] == keymap [j])
309 {
310 while (keymap [i] == keymap.back ())
311 keymap.pop_back ();
312
313 if (i < keymap.size ())
314 {
315 keymap[i] = keymap.back ();
316 keymap.pop_back ();
317 }
318
319 break;
320 }
321 }
322 }
323} 168}
324 169
325void 170void
326keyboard_manager::setup_hash () 171keyboard_manager::register_done ()
327{ 172{
328 unsigned int i, index, hashkey; 173 unsigned int i, index, hashkey;
329 vector <keysym_t *> sorted_keymap; 174 vector <keysym_t *> sorted_keymap;
330 uint16_t hash_budget_size[KEYSYM_HASH_BUDGETS]; // size of each budget 175 uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket
331 uint16_t hash_budget_counter[KEYSYM_HASH_BUDGETS]; // #elements in each budget
332 176
333 memset (hash_budget_size, 0, sizeof (hash_budget_size)); 177 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
334 memset (hash_budget_counter, 0, sizeof (hash_budget_counter));
335 178
336 // determine hash bucket size 179 // determine hash bucket size
337 for (i = 0; i < keymap.size (); ++i) 180 for (i = 0; i < keymap.size (); ++i)
338 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
339 { 181 {
340 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; 182 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
341 ++hash_budget_size [hashkey]; 183 ++hash_bucket_size [hashkey];
342 } 184 }
343 185
344 // now we know the size of each budget 186 // now we know the size of each bucket
345 // compute the index of each budget 187 // compute the index of each bucket
346 hash [0] = 0; 188 hash [0] = 0;
347 for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i) 189 for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i)
348 { 190 {
349 index += hash_budget_size [i - 1]; 191 index += hash_bucket_size [i - 1];
350 hash [i] = index; 192 hash [i] = index;
351 } 193 }
352 194
353 // and allocate just enough space 195 // and allocate just enough space
354 sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0); 196 sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0);
197
198 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
355 199
356 // fill in sorted_keymap 200 // fill in sorted_keymap
357 // it is sorted in each budget 201 // it is sorted in each bucket
358 for (i = 0; i < keymap.size (); ++i) 202 for (i = 0; i < keymap.size (); ++i)
359 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
360 { 203 {
361 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; 204 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
362 205
363 index = hash [hashkey] + hash_budget_counter [hashkey]; 206 index = hash [hashkey] + hash_bucket_size [hashkey];
364 207
365 while (index > hash [hashkey] 208 while (index > hash [hashkey]
366 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0) 209 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
367 { 210 {
368 sorted_keymap [index] = sorted_keymap [index - 1]; 211 sorted_keymap [index] = sorted_keymap [index - 1];
369 --index; 212 --index;
370 } 213 }
371 214
372 sorted_keymap [index] = keymap [i]; 215 sorted_keymap [index] = keymap [i];
373 ++hash_budget_counter [hashkey]; 216 ++hash_bucket_size [hashkey];
374 } 217 }
375 218
376 keymap.swap (sorted_keymap); 219 keymap.swap (sorted_keymap);
377 220
378#if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD) 221#ifndef NDEBUG
379 // check for invariants 222 // check for invariants
380 for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i) 223 for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
381 { 224 {
382 index = hash[i]; 225 index = hash[i];
383 for (int j = 0; j < hash_budget_size [i]; ++j) 226 for (int j = 0; j < hash_bucket_size [i]; ++j)
384 { 227 {
385 if (keymap [index + j]->range == 1)
386 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK)); 228 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
387 229
388 if (j) 230 if (j)
389 assert (compare_priority (keymap [index + j - 1], 231 assert (compare_priority (keymap [index + j - 1],
390 keymap [index + j]) >= 0); 232 keymap [index + j]) >= 0);
391 } 233 }
… …
393 235
394 // this should be able to detect most possible bugs 236 // this should be able to detect most possible bugs
395 for (i = 0; i < sorted_keymap.size (); ++i) 237 for (i = 0; i < sorted_keymap.size (); ++i)
396 { 238 {
397 keysym_t *a = sorted_keymap[i]; 239 keysym_t *a = sorted_keymap[i];
398 for (int j = 0; j < a->range; ++j)
399 {
400 int index = find_keysym (a->keysym + j, a->state); 240 int index = find_keysym (a->keysym, a->state);
401 241
402 assert (index >= 0); 242 assert (index >= 0);
403 keysym_t *b = keymap [index]; 243 keysym_t *b = keymap [index];
404 assert (i == (signed) index || // the normally expected result 244 assert (i == index // the normally expected result
405 (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 245 || a->keysym == b->keysym
406 } 246 && compare_priority (a, b) <= 0); // is effectively the same or a closer match
407 } 247 }
408#endif 248#endif
409} 249}
410 250
411int 251int
412keyboard_manager::find_keysym (KeySym keysym, unsigned int state) 252keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
413{ 253{
414 int hashkey = keysym & KEYSYM_HASH_MASK; 254 int hashkey = keysym & KEYSYM_HASH_MASK;
415 unsigned int index = hash [hashkey]; 255 unsigned int index = hash [hashkey];
416 unsigned int end = hashkey < KEYSYM_HASH_BUDGETS - 1 256 unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1
417 ? hash [hashkey + 1] 257 ? hash [hashkey + 1]
418 : keymap.size (); 258 : keymap.size ();
419 259
420 for (; index < end; ++index) 260 for (; index < end; ++index)
421 { 261 {
422 keysym_t *key = keymap [index]; 262 keysym_t *key = keymap [index];
423 263
424 if (key->keysym <= keysym && keysym < key->keysym + key->range 264 if (key->keysym == keysym
425 // match only the specified bits in state and ignore others 265 // match only the specified bits in state and ignore others
426 && (key->state & state) == key->state) 266 && (key->state & state) == key->state)
427 return index; 267 return index;
428 } 268 }
429 269

Diff Legend

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