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.35 by sf-exg, Mon Aug 23 15:58:43 2010 UTC vs.
Revision 1.60 by sf-exg, Fri Dec 28 13:29:05 2012 UTC

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

Diff Legend

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