--- rxvt-unicode/src/keyboard.C 2005/01/16 15:59:45 1.1 +++ rxvt-unicode/src/keyboard.C 2011/11/27 10:14:51 1.46 @@ -1,202 +1,101 @@ +/*----------------------------------------------------------------------* + * 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" -#include "keyboard.h" -#include "command.h" -#include -#include #ifdef KEYSYM_RESOURCE -//////////////////////////////////////////////////////////////////////////////// -// default keycode translation map and keyevent handlers -keyevent_handler keysym_translator; -keyevent_handler keyrange_translator; -keyevent_handler keyrange_translator_meta8; -keyevent_handler keylist_translator; - -keysym_t keyboard_manager::stock_keymap_[] = -{ - /* examples */ - /* keysym, state, range, handler, str*/ -//{XK_ISO_Left_Tab, 0, 1, keysym_translator, "\033[Z"}, -//{ 'a', 0, 26, keyrange_translator_meta8, "a" "%c"}, -//{ 'a', ControlMask, 26, keyrange_translator_meta8, "" "%c"}, -//{ XK_Left, 0, 4, keylist_translator, "DACBZ" "\033[Z"}, -//{ XK_Left, ShiftMask, 4, keylist_translator, "dacbZ" "\033[Z"}, -//{ XK_Left, ControlMask, 4, keylist_translator, "dacbZ" "\033OZ"}, -//{ XK_Tab, ControlMask, 1, keysym_translator, "\033"}, -//{ XK_apostrophe, ControlMask, 1, keysym_translator, "\033"}, -//{ XK_slash, ControlMask, 1, keysym_translator, "\033"}, -//{ XK_semicolon, ControlMask, 1, keysym_translator, "\033"}, -//{ XK_grave, ControlMask, 1, keysym_translator, "\033"}, -//{ XK_comma, ControlMask, 1, keysym_translator, "\033"}, -//{ XK_Return, ControlMask, 1, keysym_translator, "\033"}, -//{ XK_Return, ShiftMask, 1, keysym_translator, "\033"}, -//{ ' ', ShiftMask, 1, keysym_translator, "\033"}, -//{ '.', ControlMask, 1, keysym_translator, "\033"}, -//{ '0', ControlMask, 10, keyrange_translator, "0" "\033"}, -//{ '0', MetaMask|ControlMask, 10, keyrange_translator, "0" "\033"}, -//{ 'a', MetaMask|ControlMask, 26, keyrange_translator, "a" "\033"}, -}; - -void output_string (rxvt_term *rt, - const char *str) -{ - assert (rt && str); - if (strncmp (str, "proto:", 6) == 0) - rt->cmd_write ((unsigned char*)str + 6, strlen (str) - 6); - else - rt->tt_write ((unsigned char*)str, strlen (str)); -} - -void output_string_meta8 (rxvt_term *rt, - unsigned int state, - char buf[], - int buflen) -{ - if (state & rt->ModMetaMask) - { -#ifdef META8_OPTION - if(rt->meta_char == 0x80) /* set 8-bit on */ - { - for (char *ch = buf; ch < buf + buflen; ch++) - *ch |= 0x80; - } - else if(rt->meta_char == C0_ESC) /* escape prefix */ -#endif - { - const unsigned char ch = C0_ESC; - rt->tt_write (&ch, 1); - } - } +#include - rt->tt_write ((unsigned char*)buf, buflen); -} - -int format_keyrange_string (keysym_t *key, - KeySym keysym, - char buf[], - int bufsize) -{ - int len; - - assert (key->str); - len = snprintf (buf, bufsize, key->str + 1, - keysym - key->keysym + (int)(key->str[0])); - if (len >= bufsize) - { - fprintf (stderr, "buffer overflowed!\n"); - buf[bufsize-1] = '\0'; - } - else if (len < 0) - { - perror("keyrange_translator()"); - } - - return len; -} - -bool format_keylist_string (keysym_t *key, - KeySym keysym, - char buf[], - int bufsize) -{ - char *p; - - assert (key->str); - strncpy (buf, key->str + key->range + 1, bufsize); - buf[bufsize-1] = '\0'; +#include "rxvtperl.h" +#include "keyboard.h" +#include "command.h" - p = strchr (buf, key->str[key->range]); - if (p) - { - *p = key->str[keysym - key->keysym]; - return true; - } +/* 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]. + */ + +static void +output_string (rxvt_term *rt, const char *str) +{ + if (strncmp (str, "command:", 8) == 0) + rt->cmdbuf_append (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 - { - fprintf (stderr, "invalid str for keylist_translator()!\n"); - return false; - } -} - -///////////////////////////////////////////////////////////////// -void keysym_translator (rxvt_term *rt, - keysym_t *key, - KeySym keysym, - unsigned int state) -{ - output_string (rt, key->str); -} - -void keyrange_translator (rxvt_term *rt, - keysym_t *key, - KeySym keysym, - unsigned int state) -{ - char buf[STRING_MAX]; - - if (format_keyrange_string (key, keysym, buf, sizeof(buf)) > 0) - output_string (rt, buf); -} - -void keyrange_translator_meta8 (rxvt_term *rt, - keysym_t *key, - KeySym keysym, - unsigned int state) -{ - int len; - char buf[STRING_MAX]; - - len = format_keyrange_string (key, keysym, buf, sizeof(buf)); - if (len > 0) - output_string_meta8 (rt, state, buf, len); -} - -void keylist_translator (rxvt_term *rt, - keysym_t *key, - KeySym keysym, - unsigned int state) -{ - char buf[STRING_MAX]; - - format_keylist_string (key, keysym, buf, sizeof(buf)); - output_string (rt, buf); -} - -//////////////////////////////////////////////////////////////////////////////// -// return: #bits of '1' -int -bitcount (unsigned int n) -{ - int i; - for (i = 0; n; ++i, n &= (n - 1)); - return i; + rt->tt_write (str, strlen (str)); } // return: priority_of_a - priority_of_b -int +static int compare_priority (keysym_t *a, keysym_t *b) { - assert (a && b); - // (the more '1's in state; the less range): the greater priority - int ca = bitcount (a->state/* & AllModMask*/); - int cb = bitcount (b->state/* & AllModMask*/); + int ca = ecb_popcount32 (a->state /* & OtherModMask */); + int cb = ecb_popcount32 (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; + return 0; } //////////////////////////////////////////////////////////////////////////////// -keyboard_manager::keyboard_manager (rxvt_term *rt) - :term_(rt) +keyboard_manager::keyboard_manager () { - keymap_.reserve (256); - hash_[0] = 1; // hash_[0] != 0 indicates uninitialized data + keymap.reserve (256); + hash [0] = 1; // hash[0] != 0 indicates uninitialized data } keyboard_manager::~keyboard_manager () @@ -207,250 +106,201 @@ void keyboard_manager::clear () { - keymap_.clear (); - hash_[0] = 2; + hash [0] = 2; - for(unsigned int i = 0;i < user_translations_.size();++i) + for (unsigned int i = 0; i < keymap.size (); ++i) { - delete[] user_translations_[i]; - user_translations_[i] = 0; + free (keymap [i]->str); + delete keymap [i]; + keymap [i] = 0; } - for(unsigned int i = 0;i < user_keymap_.size();++i) + keymap.clear (); +} + +// a wrapper for register_translation that converts the input string +// to utf-8 and expands 'list' syntax. +void +keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans) +{ + wchar_t *wc = rxvt_mbstowcs (trans); + char *translation = rxvt_wcstoutf8 (wc); + free (wc); + + if (strncmp (translation, "list", 4) == 0 && translation [4] + && strlen (translation) < STRING_MAX) { - delete user_keymap_[i]; - user_keymap_[i] = 0; + char *prefix = translation + 4; + char *middle = strchr (prefix + 1, translation [4]); + char *suffix = strrchr (prefix + 1, translation [4]); + + if (suffix && middle && suffix > middle + 1) + { + int range = suffix - middle - 1; + int prefix_len = middle - prefix - 1; + char buf[STRING_MAX]; + + memcpy (buf, prefix + 1, prefix_len); + strcpy (buf + prefix_len + 1, suffix + 1); + + for (int i = 0; i < range; i++) + { + buf [prefix_len] = middle [i + 1]; + register_translation (keysym + i, state, strdup (buf)); + } + + free (translation); + return; + } + else + rxvt_warn ("unable to parse list-type keysym '%s', processing as normal keysym.\n", translation); } - user_keymap_.clear(); - user_translations_.clear(); + register_translation (keysym, state, translation); } -// a wrapper for register_keymap, -// so that outside codes don't have to know so much details. -// -// the string 'trans' is copied to an internal managed buffer, -// so the caller can free memory of 'trans' at any time. void -keyboard_manager::register_user_translation (KeySym keysym, - unsigned int state, - const char *trans) +keyboard_manager::register_translation (KeySym keysym, unsigned int state, char *translation) { - assert(trans); - keysym_t *key = new keysym_t; - const char *translation = new char[1+strlen(trans)]; - if(key && translation) + if (key && translation) { key->keysym = keysym; - key->state = state; - key->range = 1; - key->str = translation; + key->state = state; + key->str = translation; + key->type = keysym_t::STRING; - if (strncmp (trans, "list", 4) == 0) - { - const char *p = &trans[4]; - if (*p && (p = strchr (p+1, *p))) - if ((p - trans - 5 > 1) && strchr (p+1, *p)) - { - strcpy (translation, trans+5); - key->range = p - trans - 5; - key->handler = keylist_translator; - } - } - if (key->range == 1) - { - strcpy (translation, trans); - key->handler = keysym_translator; - } + if (strncmp (translation, "builtin:", 8) == 0) + key->type = keysym_t::BUILTIN; - user_keymap_.push_back (key); - user_translations_.push_back (translation); register_keymap (key); } else { delete key; - delete[] translation; - rxvt_fatal ("out of memory, aborting.\n"); + free (translation); + rxvt_fatal ("memory allocation failure. aborting.\n"); } } void keyboard_manager::register_keymap (keysym_t *key) { - assert (key); - assert (key->handler); - assert (key->range >= 1); + if (keymap.size () == keymap.capacity ()) + keymap.reserve (keymap.size () * 2); - if (keymap_.size () == keymap_.capacity ()) - keymap_.reserve (keymap_.size () * 2); - - keymap_.push_back (key); - hash_[0] = 3; + keymap.push_back (key); + hash[0] = 3; } void keyboard_manager::register_done () { - unsigned int i, n = sizeof(stock_keymap_)/sizeof(keysym_t); - - if(keymap_.back() != &stock_keymap_[n-1]) - for(i = 0;i < n;++i) - register_keymap(&stock_keymap_[i]); - - purge_duplicate_keymap (); - - for (i = 0; i < keymap_.size(); ++i) - { - keysym_t *key = keymap_[i]; - - assert (bitcount (term_->ModMetaMask) == 1 - && "call me after ModMetaMask was set!"); - if (key->state & MetaMask) - { - //key->state &= ~MetaMask; - key->state |= term_->ModMetaMask; - } - - assert (bitcount (term_->ModNumLockMask) == 1 - && "call me after ModNumLockMask was set!"); - if (key->state & NumLockMask) - { - //key->state &= ~NumLockMask; - key->state |= term_->ModNumLockMask; - } - } - setup_hash (); } -bool keyboard_manager::dispatch (KeySym keysym, unsigned int state) +bool +keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state) { - assert(hash_[0] == 0 && "register_done() need to be called"); + assert (("register_done() need to be called", hash[0] == 0)); + + state &= OtherModMask; // mask out uninteresting modifiers + + if (state & term->ModMetaMask) state |= MetaMask; + if (state & term->ModNumLockMask) state |= NumLockMask; + if (state & term->ModLevel3Mask) state |= Level3Mask; + + if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask)) + state |= AppKeypadMask; int index = find_keysym (keysym, state); if (index >= 0) { - assert (term_ && keymap_[index] && keymap_[index]->handler); - keymap_[index]->handler (term_, keymap_[index], keysym, state); - return true; - } - else - { - // fprintf(stderr,"[%x:%x]",state,keysym); - return false; - } -} + const keysym_t &key = *keymap [index]; -// purge duplicate keymap_ entries -void -keyboard_manager::purge_duplicate_keymap () -{ - for (unsigned int i = 0; i < keymap_.size (); ++i) - { - for (unsigned int j = 0; j < i; ++j) + if (key.type != keysym_t::BUILTIN) { - if (keymap_[i] == keymap_[j]) - { - while (keymap_[i] == keymap_.back ()) - keymap_.pop_back (); - if (i < keymap_.size ()) - { - keymap_[i] = keymap_.back (); - keymap_.pop_back (); - } - break; - } + 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); + + output_string (term, str); + + free (str); + + return true; } } + + return false; } void keyboard_manager::setup_hash () { unsigned int i, index, hashkey; - vector sorted_keymap; - u16 hash_budget_size[KEYSYM_HASH_BUDGETS]; // size of each budget - u16 hash_budget_counter[KEYSYM_HASH_BUDGETS]; // #elements in each budget + vector sorted_keymap; + uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of 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)); - // count keysyms for corresponding hash budgets - for (i = 0; i < keymap_.size (); ++i) + // determine hash bucket size + for (i = 0; i < keymap.size (); ++i) { - assert (keymap_[i]); - hashkey = (keymap_[i]->keysym & KEYSYM_HASH_MASK); - ++hash_budget_size[hashkey]; + hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK; + ++hash_bucket_size [hashkey]; } - // keysym A with range>1 is counted one more time for - // every keysym B lies in its range - for (i = 0; i < keymap_.size (); ++i) + // 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_BUCKETS; ++i) { - if (keymap_[i]->range > 1) - { - for (int j = min (keymap_[i]->range, KEYSYM_HASH_BUDGETS) - 1;j > 0; --j) - { - hashkey = ((keymap_[i]->keysym + j) & KEYSYM_HASH_MASK); - if (hash_budget_size[hashkey]) - ++hash_budget_size[hashkey]; - } - } + index += hash_bucket_size [i - 1]; + hash [i] = index; } - // now we know the size of each budget - // compute the index of each budget - hash_[0] = 0; - for (index = 0,i = 1; i < KEYSYM_HASH_BUDGETS; ++i) - { - index += hash_budget_size[i-1]; - hash_[i] = (hash_budget_size[i] ? index : hash_[i-1]); - } // and allocate just enough space - //sorted_keymap.reserve (hash_[i - 1] + hash_budget_size[i - 1]); - 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); + + memset (hash_bucket_size, 0, sizeof (hash_bucket_size)); // fill in sorted_keymap - // it is sorted in each budget - for (i = 0; i < keymap_.size (); ++i) + // 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) + hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK; + + index = hash [hashkey] + hash_bucket_size [hashkey]; + + while (index > hash [hashkey] + && compare_priority (keymap [i], sorted_keymap [index - 1]) > 0) { - hashkey = ((keymap_[i]->keysym + j) & KEYSYM_HASH_MASK); - if (hash_budget_size[hashkey]) - { - index = hash_[hashkey] + hash_budget_counter[hashkey]; - while (index > hash_[hashkey] && - compare_priority (keymap_[i], - sorted_keymap[index - 1]) > 0) - { - sorted_keymap[index] = sorted_keymap[index - 1]; - --index; - } - sorted_keymap[index] = keymap_[i]; - ++hash_budget_counter[hashkey]; - } + sorted_keymap [index] = sorted_keymap [index - 1]; + --index; } + + sorted_keymap [index] = keymap [i]; + ++hash_bucket_size [hashkey]; } - keymap_.swap (sorted_keymap); + 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) + index = hash[i]; + 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)); + assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK)); + if (j) - assert (compare_priority (keymap_[index + j - 1], - keymap_[index + j]) >= 0); + assert (compare_priority (keymap [index + j - 1], + keymap [index + j]) >= 0); } } @@ -458,16 +308,13 @@ for (i = 0; i < sorted_keymap.size (); ++i) { keysym_t *a = sorted_keymap[i]; - for (int j = 0; j < a->range; ++j) - { - int index = find_keysym (a->keysym + j, a->state & AllModMask); - 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 - } + int index = find_keysym (a->keysym, a->state); + + assert (index >= 0); + keysym_t *b = keymap [index]; + assert (i == index // the normally expected result + || a->keysym == b->keysym + && compare_priority (a, b) <= 0); // is effectively the same or a closer match } #endif } @@ -475,23 +322,20 @@ int keyboard_manager::find_keysym (KeySym keysym, unsigned int state) { - int hashkey = (keysym & KEYSYM_HASH_MASK); - unsigned int index = hash_[hashkey]; + int hashkey = keysym & KEYSYM_HASH_MASK; + unsigned int index = hash [hashkey]; + unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1 + ? hash [hashkey + 1] + : keymap.size (); - for (;index < keymap_.size(); ++index) + for (; index < end; ++index) { - keysym_t *key = keymap_[index]; - assert (key); - if (key->keysym <= keysym && - key->keysym + key->range > keysym && + keysym_t *key = keymap [index]; + + if (key->keysym == keysym // match only the specified bits in state and ignore others - (key->state & (unsigned int)AllModMask) == (key->state & state)) - { - return index; - } - else if (key->keysym > keysym && - key->range == 1) - return -1; + && (key->state & state) == key->state) + return index; } return -1;