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

Diff Legend

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