ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/keyboard.C
Revision: 1.12
Committed: Sat Feb 12 18:55:04 2005 UTC (19 years, 3 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-5_1, rel-5_2
Changes since 1.11: +8 -3 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.1 #include "../config.h"
2     #include "rxvt.h"
3 root 1.7
4     #ifdef KEYSYM_RESOURCE
5    
6     #include <cstring>
7    
8 root 1.1 #include "keyboard.h"
9     #include "command.h"
10    
11 root 1.12 #if STOCK_KEYMAP
12 root 1.1 ////////////////////////////////////////////////////////////////////////////////
13     // default keycode translation map and keyevent handlers
14    
15 root 1.2 keysym_t keyboard_manager::stock_keymap[] = {
16 root 1.1 /* examples */
17 root 1.10 /* keysym, state, range, handler, str */
18     //{XK_ISO_Left_Tab, 0, 1, keysym_t::NORMAL, "\033[Z"},
19     //{ 'a', 0, 26, keysym_t::RANGE_META8, "a" "%c"},
20     //{ 'a', ControlMask, 26, keysym_t::RANGE_META8, "" "%c"},
21     //{ XK_Left, 0, 4, keysym_t::LIST, ".\033[.DACB."},
22     //{ XK_Left, ShiftMask, 4, keysym_t::LIST, ".\033[.dacb."},
23     //{ XK_Left, ControlMask, 4, keysym_t::LIST, ".\033O.dacb."},
24     //{ XK_Tab, ControlMask, 1, keysym_t::NORMAL, "\033<C-Tab>"},
25     //{ XK_apostrophe, ControlMask, 1, keysym_t::NORMAL, "\033<C-'>"},
26     //{ XK_slash, ControlMask, 1, keysym_t::NORMAL, "\033<C-/>"},
27     //{ XK_semicolon, ControlMask, 1, keysym_t::NORMAL, "\033<C-;>"},
28     //{ XK_grave, ControlMask, 1, keysym_t::NORMAL, "\033<C-`>"},
29     //{ XK_comma, ControlMask, 1, keysym_t::NORMAL, "\033<C-\054>"},
30     //{ XK_Return, ControlMask, 1, keysym_t::NORMAL, "\033<C-Return>"},
31     //{ XK_Return, ShiftMask, 1, keysym_t::NORMAL, "\033<S-Return>"},
32     //{ ' ', ShiftMask, 1, keysym_t::NORMAL, "\033<S-Space>"},
33     //{ '.', ControlMask, 1, keysym_t::NORMAL, "\033<C-.>"},
34     //{ '0', ControlMask, 10, keysym_t::RANGE, "0" "\033<C-%c>"},
35     //{ '0', MetaMask|ControlMask, 10, keysym_t::RANGE, "0" "\033<M-C-%c>"},
36     //{ 'a', MetaMask|ControlMask, 26, keysym_t::RANGE, "a" "\033<M-C-%c>"},
37 root 1.1 };
38 root 1.12 #endif
39 root 1.1
40 root 1.2 static void
41     output_string (rxvt_term *rt, const char *str)
42 root 1.1 {
43 root 1.10 if (strncmp (str, "command:", 8) == 0)
44     rt->cmd_write ((unsigned char *)str + 8, strlen (str) - 8);
45 root 1.1 else
46 root 1.2 rt->tt_write ((unsigned char *)str, strlen (str));
47 root 1.1 }
48    
49 root 1.2 static void
50     output_string_meta8 (rxvt_term *rt, unsigned int state, char *buf, int buflen)
51 root 1.1 {
52     if (state & rt->ModMetaMask)
53     {
54     #ifdef META8_OPTION
55 root 1.2 if (rt->meta_char == 0x80) /* set 8-bit on */
56 root 1.1 {
57     for (char *ch = buf; ch < buf + buflen; ch++)
58     *ch |= 0x80;
59     }
60 root 1.2 else if (rt->meta_char == C0_ESC) /* escape prefix */
61 root 1.1 #endif
62     {
63 root 1.5 const unsigned char ch = C0_ESC;
64 root 1.1 rt->tt_write (&ch, 1);
65     }
66     }
67    
68 root 1.2 rt->tt_write ((unsigned char *) buf, buflen);
69 root 1.1 }
70    
71 root 1.2 static int
72     format_keyrange_string (const char *str, int keysym_offset, char *buf, int bufsize)
73 root 1.1 {
74 root 1.7 size_t len = snprintf (buf, bufsize, str + 1, keysym_offset + str [0]);
75 root 1.1
76 root 1.7 if (len >= (size_t)bufsize)
77 root 1.1 {
78 root 1.7 rxvt_warn ("format_keyrange_string: formatting failed, ignoring key.\n");
79 root 1.5 *buf = 0;
80 root 1.1 }
81    
82     return len;
83     }
84    
85     ////////////////////////////////////////////////////////////////////////////////
86     // return: #bits of '1'
87 root 1.7 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 3)
88     # define bitcount(n) (__extension__ ({ uint32_t n__ = (n); __builtin_popcount (n); }))
89     #else
90 root 1.2 static int
91 root 1.7 bitcount (uint16_t n)
92 root 1.1 {
93     int i;
94 root 1.2
95 root 1.7 for (i = 0; n; ++i, n &= n - 1)
96 root 1.2 ;
97    
98 root 1.1 return i;
99     }
100 root 1.7 #endif
101 root 1.1
102     // return: priority_of_a - priority_of_b
103 root 1.2 static int
104 root 1.1 compare_priority (keysym_t *a, keysym_t *b)
105     {
106     // (the more '1's in state; the less range): the greater priority
107 root 1.2 int ca = bitcount (a->state /* & OtherModMask */);
108     int cb = bitcount (b->state /* & OtherModMask */);
109    
110 root 1.1 if (ca != cb)
111     return ca - cb;
112     //else if (a->state != b->state) // this behavior is to be disscussed
113     // return b->state - a->state;
114     else
115     return b->range - a->range;
116     }
117    
118     ////////////////////////////////////////////////////////////////////////////////
119 root 1.2 keyboard_manager::keyboard_manager ()
120 root 1.1 {
121 root 1.2 keymap.reserve (256);
122 root 1.4 hash [0] = 1; // hash[0] != 0 indicates uninitialized data
123 root 1.1 }
124    
125     keyboard_manager::~keyboard_manager ()
126     {
127     clear ();
128     }
129    
130     void
131     keyboard_manager::clear ()
132     {
133 root 1.2 keymap.clear ();
134     hash [0] = 2;
135 root 1.1
136 root 1.2 for (unsigned int i = 0; i < user_translations.size (); ++i)
137 root 1.1 {
138 root 1.2 free ((void *)user_translations [i]);
139     user_translations [i] = 0;
140 root 1.1 }
141    
142 root 1.2 for (unsigned int i = 0; i < user_keymap.size (); ++i)
143 root 1.1 {
144 root 1.2 delete user_keymap [i];
145     user_keymap [i] = 0;
146 root 1.1 }
147    
148 root 1.2 user_keymap.clear ();
149     user_translations.clear ();
150 root 1.1 }
151    
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.
157     void
158 root 1.2 keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans)
159 root 1.1 {
160     keysym_t *key = new keysym_t;
161 root 1.2 wchar_t *wc = rxvt_mbstowcs (trans);
162     const char *translation = rxvt_wcstoutf8 (wc);
163     free (wc);
164 root 1.1
165 root 1.2 if (key && translation)
166 root 1.1 {
167     key->keysym = keysym;
168 root 1.2 key->state = state;
169     key->range = 1;
170     key->str = translation;
171     key->type = keysym_t::NORMAL;
172    
173     if (strncmp (translation, "list", 4) == 0 && translation [4])
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;
181     key->range = suffix - middle - 1;
182 root 1.1
183 root 1.2 strcpy (translation, translation + 4);
184     }
185     else
186 root 1.7 rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation);
187 root 1.1 }
188    
189 root 1.2 user_keymap.push_back (key);
190     user_translations.push_back (translation);
191 root 1.1 register_keymap (key);
192     }
193     else
194     {
195     delete key;
196 root 1.2 free ((void *)translation);
197 root 1.1 rxvt_fatal ("out of memory, aborting.\n");
198     }
199     }
200    
201     void
202     keyboard_manager::register_keymap (keysym_t *key)
203     {
204 root 1.2 if (keymap.size () == keymap.capacity ())
205     keymap.reserve (keymap.size () * 2);
206 root 1.1
207 root 1.2 keymap.push_back (key);
208     hash[0] = 3;
209 root 1.1 }
210    
211     void
212     keyboard_manager::register_done ()
213     {
214 root 1.12 #if STOCK_KEYMAP
215     int n = sizeof (stock_keymap) / sizeof (keysym_t);
216 root 1.1
217 root 1.12 //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 root 1.2 register_keymap (&stock_keymap[i]);
221 root 1.12 #endif
222 root 1.1
223     purge_duplicate_keymap ();
224    
225     setup_hash ();
226     }
227    
228 root 1.2 bool
229     keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
230 root 1.1 {
231 root 1.2 assert (hash[0] == 0 && "register_done() need to be called");
232 root 1.1
233 root 1.6 if (state & term->ModMetaMask) state |= MetaMask;
234     if (state & term->ModNumLockMask) state |= NumLockMask;
235     if (state & term->ModLevel3Mask) state |= Level3Mask;
236 root 1.3
237     if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
238     state |= AppKeypadMask;
239    
240 root 1.1 int index = find_keysym (keysym, state);
241    
242     if (index >= 0)
243     {
244 root 1.2 const keysym_t &key = *keymap [index];
245    
246     int keysym_offset = keysym - key.keysym;
247    
248     wchar_t *wc = rxvt_utf8towcs (key.str);
249     char *str = rxvt_wcstombs (wc);
250 root 1.11 // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
251 root 1.2 free (wc);
252    
253     switch (key.type)
254     {
255     case keysym_t::NORMAL:
256     output_string (term, str);
257     break;
258    
259     case keysym_t::RANGE:
260     {
261     char buf[STRING_MAX];
262    
263     if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0)
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     }
297    
298     free (str);
299    
300 root 1.1 return true;
301     }
302     else
303 root 1.11 return false;
304 root 1.1 }
305    
306 root 1.2 // purge duplicate keymap entries
307     void keyboard_manager::purge_duplicate_keymap ()
308 root 1.1 {
309 root 1.2 for (unsigned int i = 0; i < keymap.size (); ++i)
310 root 1.1 {
311     for (unsigned int j = 0; j < i; ++j)
312     {
313 root 1.4 if (keymap [i] == keymap [j])
314 root 1.1 {
315 root 1.4 while (keymap [i] == keymap.back ())
316 root 1.2 keymap.pop_back ();
317    
318     if (i < keymap.size ())
319 root 1.1 {
320 root 1.2 keymap[i] = keymap.back ();
321     keymap.pop_back ();
322 root 1.1 }
323 root 1.11
324 root 1.1 break;
325     }
326     }
327     }
328     }
329    
330     void
331     keyboard_manager::setup_hash ()
332     {
333     unsigned int i, index, hashkey;
334 root 1.2 vector <keysym_t *> sorted_keymap;
335     uint16_t hash_budget_size[KEYSYM_HASH_BUDGETS]; // size of each budget
336     uint16_t hash_budget_counter[KEYSYM_HASH_BUDGETS]; // #elements in each budget
337 root 1.1
338     memset (hash_budget_size, 0, sizeof (hash_budget_size));
339     memset (hash_budget_counter, 0, sizeof (hash_budget_counter));
340    
341 root 1.11 // determine hash bucket size
342 root 1.2 for (i = 0; i < keymap.size (); ++i)
343 root 1.11 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
344     {
345     hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK;
346     ++hash_budget_size [hashkey];
347     }
348 root 1.1
349     // now we know the size of each budget
350     // compute the index of each budget
351 root 1.4 hash [0] = 0;
352 root 1.2 for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i)
353 root 1.1 {
354 root 1.4 index += hash_budget_size [i - 1];
355 root 1.11 hash [i] = index;
356 root 1.1 }
357 root 1.2
358 root 1.1 // and allocate just enough space
359 root 1.4 sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0);
360 root 1.1
361     // fill in sorted_keymap
362     // it is sorted in each budget
363 root 1.2 for (i = 0; i < keymap.size (); ++i)
364 root 1.11 for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j)
365     {
366     hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK;
367    
368     index = hash [hashkey] + hash_budget_counter [hashkey];
369    
370     while (index > hash [hashkey]
371     && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
372     {
373     sorted_keymap [index] = sorted_keymap [index - 1];
374     --index;
375     }
376    
377     sorted_keymap [index] = keymap [i];
378     ++hash_budget_counter [hashkey];
379     }
380 root 1.1
381 root 1.2 keymap.swap (sorted_keymap);
382 root 1.1
383     #if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD)
384     // check for invariants
385     for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i)
386     {
387 root 1.2 index = hash[i];
388 root 1.4 for (int j = 0; j < hash_budget_size [i]; ++j)
389 root 1.1 {
390 root 1.4 if (keymap [index + j]->range == 1)
391     assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
392 root 1.2
393 root 1.1 if (j)
394 root 1.4 assert (compare_priority (keymap [index + j - 1],
395     keymap [index + j]) >= 0);
396 root 1.1 }
397     }
398    
399     // this should be able to detect most possible bugs
400     for (i = 0; i < sorted_keymap.size (); ++i)
401     {
402     keysym_t *a = sorted_keymap[i];
403     for (int j = 0; j < a->range; ++j)
404     {
405 root 1.7 int index = find_keysym (a->keysym + j, a->state);
406 root 1.6
407 root 1.1 assert (index >= 0);
408 root 1.4 keysym_t *b = keymap [index];
409 root 1.2 assert (i == (signed) index || // the normally expected result
410 root 1.10 (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
411 root 1.1 }
412     }
413     #endif
414     }
415    
416     int
417     keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
418     {
419 root 1.2 int hashkey = keysym & KEYSYM_HASH_MASK;
420     unsigned int index = hash [hashkey];
421 root 1.11 unsigned int end = hashkey < KEYSYM_HASH_BUDGETS - 1
422     ? hash [hashkey + 1]
423     : keymap.size ();
424 root 1.1
425 root 1.11 for (; index < end; ++index)
426 root 1.1 {
427 root 1.4 keysym_t *key = keymap [index];
428 root 1.2
429 root 1.11 if (key->keysym <= keysym && keysym < key->keysym + key->range
430 root 1.1 // match only the specified bits in state and ignore others
431 root 1.7 && (key->state & state) == key->state)
432 root 1.2 return index;
433 root 1.1 }
434    
435     return -1;
436     }
437    
438     #endif /* KEYSYM_RESOURCE */
439     // vim:et:ts=2:sw=2