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.42 by sf-exg, Sat May 7 18:29:18 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 *rt, 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 rt->cmdbuf_append (str + 8, strlen (str) - 8);
72 else if (strncmp (str, "perl:", 5) == 0)
73 HOOK_INVOKE((rt, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END));
43 else 74 else
44 rt->tt_write ((unsigned char *)str, strlen (str)); 75 rt->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 = rxvt_popcount (a->state /* & OtherModMask */);
106 int cb = bitcount (b->state /* & OtherModMask */); 84 int cb = rxvt_popcount (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{
… …
126} 104}
127 105
128void 106void
129keyboard_manager::clear () 107keyboard_manager::clear ()
130{ 108{
109 hash [0] = 2;
110
111 for (unsigned int i = 0; i < keymap.size (); ++i)
112 {
113 free ((void *)keymap [i]->str);
114 delete keymap [i];
115 keymap [i] = 0;
116 }
117
131 keymap.clear (); 118 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} 119}
149 120
150// a wrapper for register_keymap, 121// a wrapper for register_translation that converts the input string
151// so that outside codes don't have to know so much details. 122// to utf-8 and expands 'list' syntax.
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 123void
156keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans) 124keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans)
157{ 125{
126 wchar_t *wc = rxvt_mbstowcs (trans);
127 char *translation = rxvt_wcstoutf8 (wc);
128 free (wc);
129
130 if (strncmp (translation, "list", 4) == 0 && translation [4]
131 && strlen (translation) < STRING_MAX)
132 {
133 char *prefix = translation + 4;
134 char *middle = strchr (prefix + 1, translation [4]);
135 char *suffix = strrchr (prefix + 1, translation [4]);
136
137 if (suffix && middle && suffix > middle + 1)
138 {
139 int range = suffix - middle - 1;
140 int prefix_len = middle - prefix - 1;
141 char buf[STRING_MAX];
142
143 memcpy (buf, prefix + 1, prefix_len);
144 strcpy (buf + prefix_len + 1, suffix + 1);
145
146 for (int i = 0; i < range; i++)
147 {
148 buf [prefix_len] = middle [i + 1];
149 register_translation (keysym + i, state, strdup (buf));
150 }
151
152 free (translation);
153 return;
154 }
155 else
156 rxvt_warn ("cannot parse list-type keysym '%s', processing as normal keysym.\n", translation);
157 }
158
159 register_translation (keysym, state, translation);
160}
161
162void
163keyboard_manager::register_translation (KeySym keysym, unsigned int state, char *translation)
164{
158 keysym_t *key = new keysym_t; 165 keysym_t *key = new keysym_t;
159 wchar_t *wc = rxvt_mbstowcs (trans);
160 const char *translation = rxvt_wcstoutf8 (wc);
161 free (wc);
162 166
163 if (key && translation) 167 if (key && translation)
164 { 168 {
165 key->keysym = keysym; 169 key->keysym = keysym;
166 key->state = state; 170 key->state = state;
167 key->range = 1;
168 key->str = translation; 171 key->str = translation;
169 key->type = keysym_t::NORMAL; 172 key->type = keysym_t::STRING;
170 173
171 if (strncmp (translation, "list", 4) == 0 && translation [4]) 174 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; 175 key->type = keysym_t::BUILTIN;
179 key->range = suffix - middle - 1;
180 176
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); 177 register_keymap (key);
190 } 178 }
191 else 179 else
192 { 180 {
193 delete key; 181 delete key;
… …
207} 195}
208 196
209void 197void
210keyboard_manager::register_done () 198keyboard_manager::register_done ()
211{ 199{
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 (); 200 setup_hash ();
221} 201}
222 202
223bool 203bool
224keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state) 204keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
225{ 205{
226 assert (hash[0] == 0 && "register_done() need to be called"); 206 assert (hash[0] == 0 && "register_done() need to be called");
207
208 state &= OtherModMask; // mask out uninteresting modifiers
227 209
228 if (state & term->ModMetaMask) state |= MetaMask; 210 if (state & term->ModMetaMask) state |= MetaMask;
229 if (state & term->ModNumLockMask) state |= NumLockMask; 211 if (state & term->ModNumLockMask) state |= NumLockMask;
230 if (state & term->ModLevel3Mask) state |= Level3Mask; 212 if (state & term->ModLevel3Mask) state |= Level3Mask;
231 213
… …
236 218
237 if (index >= 0) 219 if (index >= 0)
238 { 220 {
239 const keysym_t &key = *keymap [index]; 221 const keysym_t &key = *keymap [index];
240 222
241 int keysym_offset = keysym - key.keysym; 223 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 { 224 {
250 case keysym_t::NORMAL: 225 wchar_t *wc = rxvt_utf8towcs (key.str);
251 output_string (term, str); 226 char *str = rxvt_wcstombs (wc);
252 break; 227 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
228 free (wc);
253 229
254 case keysym_t::RANGE: 230 switch (key.type)
255 { 231 {
256 char buf[STRING_MAX]; 232 case keysym_t::STRING:
257
258 if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0)
259 output_string (term, buf); 233 output_string (term, str);
234 break;
260 } 235 }
261 break;
262 236
263 case keysym_t::RANGE_META8: 237 free (str);
264 {
265 int len;
266 char buf[STRING_MAX];
267 238
268 len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf)); 239 return true;
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 } 240 }
292
293 free (str);
294
295 return true;
296 } 241 }
297 else 242
298 return false; 243 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} 244}
324 245
325void 246void
326keyboard_manager::setup_hash () 247keyboard_manager::setup_hash ()
327{ 248{
328 unsigned int i, index, hashkey; 249 unsigned int i, index, hashkey;
329 vector <keysym_t *> sorted_keymap; 250 vector <keysym_t *> sorted_keymap;
330 uint16_t hash_budget_size[KEYSYM_HASH_BUDGETS]; // size of each budget 251 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 252
333 memset (hash_budget_size, 0, sizeof (hash_budget_size)); 253 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
334 memset (hash_budget_counter, 0, sizeof (hash_budget_counter));
335 254
336 // determine hash bucket size 255 // determine hash bucket size
337 for (i = 0; i < keymap.size (); ++i) 256 for (i = 0; i < keymap.size (); ++i)
338 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
339 { 257 {
340 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; 258 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
341 ++hash_budget_size [hashkey]; 259 ++hash_bucket_size [hashkey];
342 } 260 }
343 261
344 // now we know the size of each budget 262 // now we know the size of each bucket
345 // compute the index of each budget 263 // compute the index of each bucket
346 hash [0] = 0; 264 hash [0] = 0;
347 for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i) 265 for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i)
348 { 266 {
349 index += hash_budget_size [i - 1]; 267 index += hash_bucket_size [i - 1];
350 hash [i] = index; 268 hash [i] = index;
351 } 269 }
352 270
353 // and allocate just enough space 271 // and allocate just enough space
354 sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0); 272 sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0);
273
274 memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
355 275
356 // fill in sorted_keymap 276 // fill in sorted_keymap
357 // it is sorted in each budget 277 // it is sorted in each bucket
358 for (i = 0; i < keymap.size (); ++i) 278 for (i = 0; i < keymap.size (); ++i)
359 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
360 { 279 {
361 hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; 280 hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
362 281
363 index = hash [hashkey] + hash_budget_counter [hashkey]; 282 index = hash [hashkey] + hash_bucket_size [hashkey];
364 283
365 while (index > hash [hashkey] 284 while (index > hash [hashkey]
366 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0) 285 && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
367 { 286 {
368 sorted_keymap [index] = sorted_keymap [index - 1]; 287 sorted_keymap [index] = sorted_keymap [index - 1];
369 --index; 288 --index;
370 } 289 }
371 290
372 sorted_keymap [index] = keymap [i]; 291 sorted_keymap [index] = keymap [i];
373 ++hash_budget_counter [hashkey]; 292 ++hash_bucket_size [hashkey];
374 } 293 }
375 294
376 keymap.swap (sorted_keymap); 295 keymap.swap (sorted_keymap);
377 296
378#if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD) 297#ifndef NDEBUG
379 // check for invariants 298 // check for invariants
380 for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i) 299 for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
381 { 300 {
382 index = hash[i]; 301 index = hash[i];
383 for (int j = 0; j < hash_budget_size [i]; ++j) 302 for (int j = 0; j < hash_bucket_size [i]; ++j)
384 { 303 {
385 if (keymap [index + j]->range == 1)
386 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK)); 304 assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
387 305
388 if (j) 306 if (j)
389 assert (compare_priority (keymap [index + j - 1], 307 assert (compare_priority (keymap [index + j - 1],
390 keymap [index + j]) >= 0); 308 keymap [index + j]) >= 0);
391 } 309 }
… …
393 311
394 // this should be able to detect most possible bugs 312 // this should be able to detect most possible bugs
395 for (i = 0; i < sorted_keymap.size (); ++i) 313 for (i = 0; i < sorted_keymap.size (); ++i)
396 { 314 {
397 keysym_t *a = sorted_keymap[i]; 315 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); 316 int index = find_keysym (a->keysym, a->state);
401 317
402 assert (index >= 0); 318 assert (index >= 0);
403 keysym_t *b = keymap [index]; 319 keysym_t *b = keymap [index];
404 assert (i == (signed) index || // the normally expected result 320 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 321 || a->keysym == b->keysym
406 } 322 && compare_priority (a, b) <= 0); // is effectively the same or a closer match
407 } 323 }
408#endif 324#endif
409} 325}
410 326
411int 327int
412keyboard_manager::find_keysym (KeySym keysym, unsigned int state) 328keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
413{ 329{
414 int hashkey = keysym & KEYSYM_HASH_MASK; 330 int hashkey = keysym & KEYSYM_HASH_MASK;
415 unsigned int index = hash [hashkey]; 331 unsigned int index = hash [hashkey];
416 unsigned int end = hashkey < KEYSYM_HASH_BUDGETS - 1 332 unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1
417 ? hash [hashkey + 1] 333 ? hash [hashkey + 1]
418 : keymap.size (); 334 : keymap.size ();
419 335
420 for (; index < end; ++index) 336 for (; index < end; ++index)
421 { 337 {
422 keysym_t *key = keymap [index]; 338 keysym_t *key = keymap [index];
423 339
424 if (key->keysym <= keysym && keysym < key->keysym + key->range 340 if (key->keysym == keysym
425 // match only the specified bits in state and ignore others 341 // match only the specified bits in state and ignore others
426 && (key->state & state) == key->state) 342 && (key->state & state) == key->state)
427 return index; 343 return index;
428 } 344 }
429 345

Diff Legend

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