--- rxvt-unicode/src/keyboard.C 2005/02/06 15:18:01 1.11 +++ rxvt-unicode/src/keyboard.C 2010/08/23 16:06:44 1.36 @@ -1,3 +1,26 @@ +/*----------------------------------------------------------------------* + * File: keyboard.C + *----------------------------------------------------------------------* + * + * All portions of code are copyright by their respective author/s. + * Copyright (c) 2005 WU Fengguang + * Copyright (c) 2005-2006 Marc Lehmann + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + *----------------------------------------------------------------------*/ + #include "../config.h" #include "rxvt.h" @@ -5,43 +28,80 @@ #include +#include "rxvtperl.h" #include "keyboard.h" #include "command.h" +/* an intro to the data structure: + * + * vector keymap[] is grouped. + * + * inside each group, elements are sorted by the criteria given by compare_priority(). + * the lookup of keysym is done in two steps: + * 1) locate the group corresponds to the keysym; + * 2) do a linear search inside the group. + * + * array hash[] effectively defines a map from a keysym to a group in keymap[]. + * + * each group has its address(the index of first group element in keymap[]), + * which is computed and stored in hash[]. + * hash[] stores the addresses in the form of: + * index: 0 I1 I2 I3 In + * value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An + * where + * A1 = 0; + * Ai+1 = N1 + N2 + ... + Ni. + * it is computed from hash_bucket_size[]: + * index: 0 I1 I2 I3 In + * value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0 + * 0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the computation of hash[]) + * or we can say + * hash_bucket_size[Ii] = Ni; hash_bucket_size[elsewhere] = 0, + * where + * set {I1, I2, ..., In} = { hashkey of keymap[0]->keysym, ..., keymap[keymap.size-1]->keysym } + * where hashkey of keymap[i]->keysym = keymap[i]->keysym & KEYSYM_HASH_MASK + * n(the number of groups) = the number of non-zero member of hash_bucket_size[]; + * Ni(the size of group i) = hash_bucket_size[Ii]. + */ + +#if STOCK_KEYMAP //////////////////////////////////////////////////////////////////////////////// // default keycode translation map and keyevent handlers keysym_t keyboard_manager::stock_keymap[] = { /* examples */ - /* keysym, state, range, handler, str */ -//{XK_ISO_Left_Tab, 0, 1, keysym_t::NORMAL, "\033[Z"}, + /* keysym, state, range, type, str */ +//{XK_ISO_Left_Tab, 0, 1, keysym_t::STRING, "\033[Z"}, //{ 'a', 0, 26, keysym_t::RANGE_META8, "a" "%c"}, //{ 'a', ControlMask, 26, keysym_t::RANGE_META8, "" "%c"}, //{ XK_Left, 0, 4, keysym_t::LIST, ".\033[.DACB."}, //{ XK_Left, ShiftMask, 4, keysym_t::LIST, ".\033[.dacb."}, //{ XK_Left, ControlMask, 4, keysym_t::LIST, ".\033O.dacb."}, -//{ XK_Tab, ControlMask, 1, keysym_t::NORMAL, "\033"}, -//{ XK_apostrophe, ControlMask, 1, keysym_t::NORMAL, "\033"}, -//{ XK_slash, ControlMask, 1, keysym_t::NORMAL, "\033"}, -//{ XK_semicolon, ControlMask, 1, keysym_t::NORMAL, "\033"}, -//{ XK_grave, ControlMask, 1, keysym_t::NORMAL, "\033"}, -//{ XK_comma, ControlMask, 1, keysym_t::NORMAL, "\033"}, -//{ XK_Return, ControlMask, 1, keysym_t::NORMAL, "\033"}, -//{ XK_Return, ShiftMask, 1, keysym_t::NORMAL, "\033"}, -//{ ' ', ShiftMask, 1, keysym_t::NORMAL, "\033"}, -//{ '.', ControlMask, 1, keysym_t::NORMAL, "\033"}, +//{ XK_Tab, ControlMask, 1, keysym_t::STRING, "\033"}, +//{ XK_apostrophe, ControlMask, 1, keysym_t::STRING, "\033"}, +//{ XK_slash, ControlMask, 1, keysym_t::STRING, "\033"}, +//{ XK_semicolon, ControlMask, 1, keysym_t::STRING, "\033"}, +//{ XK_grave, ControlMask, 1, keysym_t::STRING, "\033"}, +//{ XK_comma, ControlMask, 1, keysym_t::STRING, "\033"}, +//{ XK_Return, ControlMask, 1, keysym_t::STRING, "\033"}, +//{ XK_Return, ShiftMask, 1, keysym_t::STRING, "\033"}, +//{ ' ', ShiftMask, 1, keysym_t::STRING, "\033"}, +//{ '.', ControlMask, 1, keysym_t::STRING, "\033"}, //{ '0', ControlMask, 10, keysym_t::RANGE, "0" "\033"}, //{ '0', MetaMask|ControlMask, 10, keysym_t::RANGE, "0" "\033"}, //{ 'a', MetaMask|ControlMask, 26, keysym_t::RANGE, "a" "\033"}, }; +#endif static void output_string (rxvt_term *rt, const char *str) { if (strncmp (str, "command:", 8) == 0) - rt->cmd_write ((unsigned char *)str + 8, strlen (str) - 8); + rt->cmd_write (str + 8, strlen (str) - 8); + else if (strncmp (str, "perl:", 5) == 0) + HOOK_INVOKE((rt, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END)); else - rt->tt_write ((unsigned char *)str, strlen (str)); + rt->tt_write (str, strlen (str)); } static void @@ -58,12 +118,12 @@ else if (rt->meta_char == C0_ESC) /* escape prefix */ #endif { - const unsigned char ch = C0_ESC; + const char ch = C0_ESC; rt->tt_write (&ch, 1); } } - rt->tt_write ((unsigned char *) buf, buflen); + rt->tt_write (buf, buflen); } static int @@ -80,34 +140,17 @@ return len; } -//////////////////////////////////////////////////////////////////////////////// -// return: #bits of '1' -#if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ > 3) -# define bitcount(n) (__extension__ ({ uint32_t n__ = (n); __builtin_popcount (n); })) -#else -static int -bitcount (uint16_t n) -{ - int i; - - for (i = 0; n; ++i, n &= n - 1) - ; - - return i; -} -#endif - // return: priority_of_a - priority_of_b static int compare_priority (keysym_t *a, keysym_t *b) { // (the more '1's in state; the less range): the greater priority - int ca = bitcount (a->state /* & OtherModMask */); - int cb = bitcount (b->state /* & OtherModMask */); + int ca = rxvt_popcount (a->state /* & OtherModMask */); + int cb = rxvt_popcount (b->state /* & OtherModMask */); if (ca != cb) return ca - cb; -//else if (a->state != b->state) // this behavior is to be disscussed +//else if (a->state != b->state) // this behavior is to be discussed // return b->state - a->state; else return b->range - a->range; @@ -157,7 +200,7 @@ { keysym_t *key = new keysym_t; wchar_t *wc = rxvt_mbstowcs (trans); - const char *translation = rxvt_wcstoutf8 (wc); + char *translation = rxvt_wcstoutf8 (wc); free (wc); if (key && translation) @@ -166,23 +209,25 @@ key->state = state; key->range = 1; key->str = translation; - key->type = keysym_t::NORMAL; + key->type = keysym_t::STRING; if (strncmp (translation, "list", 4) == 0 && translation [4]) { char *middle = strchr (translation + 5, translation [4]); char *suffix = strrchr (translation + 5, translation [4]); - + if (suffix && middle && suffix > middle + 1) { key->type = keysym_t::LIST; key->range = suffix - middle - 1; - strcpy (translation, translation + 4); + memmove (translation, translation + 4, strlen (translation + 4) + 1); } else rxvt_warn ("cannot parse list-type keysym '%s', treating as normal keysym.\n", translation); } + else if (strncmp (translation, "builtin:", 8) == 0) + key->type = keysym_t::BUILTIN; user_keymap.push_back (key); user_translations.push_back (translation); @@ -209,11 +254,14 @@ void keyboard_manager::register_done () { - unsigned int i, n = sizeof (stock_keymap) / sizeof (keysym_t); +#if STOCK_KEYMAP + int n = sizeof (stock_keymap) / sizeof (keysym_t); - if (keymap.back () != &stock_keymap[n - 1]) - for (i = 0; i < n; ++i) + //TODO: shield against repeated calls and empty keymap + //if (keymap.back () != &stock_keymap[n - 1]) + for (int i = 0; i < n; ++i) register_keymap (&stock_keymap[i]); +#endif purge_duplicate_keymap (); @@ -225,6 +273,8 @@ { assert (hash[0] == 0 && "register_done() need to be called"); + state &= OtherModMask; // mask out uninteresting modifiers + if (state & term->ModMetaMask) state |= MetaMask; if (state & term->ModNumLockMask) state |= NumLockMask; if (state & term->ModLevel3Mask) state |= Level3Mask; @@ -238,64 +288,67 @@ { const keysym_t &key = *keymap [index]; - int keysym_offset = keysym - key.keysym; - - wchar_t *wc = rxvt_utf8towcs (key.str); - char *str = rxvt_wcstombs (wc); - // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.) - free (wc); - - switch (key.type) + if (key.type != keysym_t::BUILTIN) { - case keysym_t::NORMAL: - output_string (term, str); - break; + int keysym_offset = keysym - key.keysym; - case keysym_t::RANGE: + wchar_t *wc = rxvt_utf8towcs (key.str); + char *str = rxvt_wcstombs (wc); + // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.) + free (wc); + + switch (key.type) { - char buf[STRING_MAX]; + case keysym_t::STRING: + output_string (term, str); + break; - if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0) - output_string (term, buf); - } - break; + case keysym_t::RANGE: + { + char buf[STRING_MAX]; - case keysym_t::RANGE_META8: - { - int len; - char buf[STRING_MAX]; + if (format_keyrange_string (str, keysym_offset, buf, sizeof (buf)) > 0) + output_string (term, buf); + } + break; - len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf)); - if (len > 0) - output_string_meta8 (term, state, buf, len); - } - break; + case keysym_t::RANGE_META8: + { + int len; + char buf[STRING_MAX]; - case keysym_t::LIST: - { - char buf[STRING_MAX]; + len = format_keyrange_string (str, keysym_offset, buf, sizeof (buf)); + if (len > 0) + output_string_meta8 (term, state, buf, len); + } + break; + + case keysym_t::LIST: + { + char buf[STRING_MAX]; - char *prefix, *middle, *suffix; + char *prefix, *middle, *suffix; - prefix = str; - middle = strchr (prefix + 1, *prefix); - suffix = strrchr (middle + 1, *prefix); + prefix = str; + middle = strchr (prefix + 1, *prefix); + suffix = strrchr (middle + 1, *prefix); - memcpy (buf, prefix + 1, middle - prefix - 1); - buf [middle - prefix - 1] = middle [keysym_offset + 1]; - strcpy (buf + (middle - prefix), suffix + 1); + memcpy (buf, prefix + 1, middle - prefix - 1); + buf [middle - prefix - 1] = middle [keysym_offset + 1]; + strcpy (buf + (middle - prefix), suffix + 1); - output_string (term, buf); + output_string (term, buf); + } + break; } - break; - } - free (str); + free (str); - return true; + return true; + } } - else - return false; + + return false; } // purge duplicate keymap entries @@ -327,40 +380,40 @@ { unsigned int i, index, hashkey; vector sorted_keymap; - uint16_t hash_budget_size[KEYSYM_HASH_BUDGETS]; // size of each budget - uint16_t hash_budget_counter[KEYSYM_HASH_BUDGETS]; // #elements in each budget + uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket + uint16_t hash_bucket_counter[KEYSYM_HASH_BUCKETS]; // #elements in each bucket - memset (hash_budget_size, 0, sizeof (hash_budget_size)); - memset (hash_budget_counter, 0, sizeof (hash_budget_counter)); + memset (hash_bucket_size, 0, sizeof (hash_bucket_size)); + memset (hash_bucket_counter, 0, sizeof (hash_bucket_counter)); // determine hash bucket size for (i = 0; i < keymap.size (); ++i) - for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j) + for (int j = min (keymap [i]->range, KEYSYM_HASH_BUCKETS) - 1; j >= 0; --j) { hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; - ++hash_budget_size [hashkey]; + ++hash_bucket_size [hashkey]; } - // now we know the size of each budget - // compute the index of each budget + // now we know the size of each bucket + // compute the index of each bucket hash [0] = 0; - for (index = 0, i = 1; i < KEYSYM_HASH_BUDGETS; ++i) + for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i) { - index += hash_budget_size [i - 1]; + index += hash_bucket_size [i - 1]; hash [i] = index; } // and allocate just enough space - sorted_keymap.insert (sorted_keymap.begin (), index + hash_budget_size [i - 1], 0); + sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0); // fill in sorted_keymap - // it is sorted in each budget + // it is sorted in each bucket for (i = 0; i < keymap.size (); ++i) - for (int j = min (keymap [i]->range, KEYSYM_HASH_BUDGETS) - 1; j >= 0; --j) + for (int j = min (keymap [i]->range, KEYSYM_HASH_BUCKETS) - 1; j >= 0; --j) { hashkey = (keymap [i]->keysym + j) & KEYSYM_HASH_MASK; - index = hash [hashkey] + hash_budget_counter [hashkey]; + index = hash [hashkey] + hash_bucket_counter [hashkey]; while (index > hash [hashkey] && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0) @@ -370,17 +423,17 @@ } sorted_keymap [index] = keymap [i]; - ++hash_budget_counter [hashkey]; + ++hash_bucket_counter [hashkey]; } keymap.swap (sorted_keymap); -#if defined (DEBUG_STRICT) || defined (DEBUG_KEYBOARD) +#ifndef NDEBUG // check for invariants - for (i = 0; i < KEYSYM_HASH_BUDGETS; ++i) + for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i) { index = hash[i]; - for (int j = 0; j < hash_budget_size [i]; ++j) + for (int j = 0; j < hash_bucket_size [i]; ++j) { if (keymap [index + j]->range == 1) assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK)); @@ -401,8 +454,9 @@ assert (index >= 0); keysym_t *b = keymap [index]; - assert (i == (signed) index || // the normally expected result - (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 + assert (i == index // the normally expected result + || IN_RANGE_INC (a->keysym + j, b->keysym, b->keysym + b->range) + && compare_priority (a, b) <= 0); // is effectively the same or a closer match } } #endif @@ -413,8 +467,8 @@ { int hashkey = keysym & KEYSYM_HASH_MASK; unsigned int index = hash [hashkey]; - unsigned int end = hashkey < KEYSYM_HASH_BUDGETS - 1 - ? hash [hashkey + 1] + unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1 + ? hash [hashkey + 1] : keymap.size (); for (; index < end; ++index)