rxvt-unicode/src/keyboard.C

/*----------------------------------------------------------------------*
 * 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 <schmorp@schmorp.de>
 *
 * 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 3 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"

#ifdef KEYSYM_RESOURCE

#include <string.h>

#include "rxvtperl.h"
#include "keyboard.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].
 */

// 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 = ecb_popcount32 (a->state /* & OtherModMask */);
  int cb = ecb_popcount32 (b->state /* & OtherModMask */);

  return ca - cb;
}

////////////////////////////////////////////////////////////////////////////////
keyboard_manager::keyboard_manager ()
{
  keymap.reserve (256);
  hash [0] = 1;                 // hash[0] != 0 indicates uninitialized data
}

keyboard_manager::~keyboard_manager ()
{
  for (unsigned int i = 0; i < keymap.size (); ++i)
    {
      free (keymap [i]->str);
      delete keymap [i];
    }
}

void
keyboard_manager::unregister_action (KeySym keysym, unsigned int state)
{
  for (unsigned int i = 0; i < keymap.size (); ++i)
    if (keymap [i]->keysym == keysym
        && keymap [i]->state == state)
      {
        free (keymap [i]->str);
        delete keymap [i];

        if (i < keymap.size () - 1)
          keymap [i] = keymap [keymap.size () - 1];
        keymap.pop_back ();

        break;
      }
}

void
keyboard_manager::register_action (KeySym keysym, unsigned int state, const wchar_t *ws)
{
  char *action = rxvt_wcstoutf8 (ws);

  keysym_t *key = new keysym_t;

  key->keysym = keysym;
  key->state  = state;
  key->str    = action;
  key->type   = keysym_t::STRING;

  if (strncmp (action, "builtin:", 8) == 0)
    key->type = keysym_t::BUILTIN;
  else if (strncmp (action, "builtin-string:", 15) == 0)
    key->type = keysym_t::BUILTIN_STRING;

  unregister_action (keysym, state);

  if (keymap.size () == keymap.capacity ())
    keymap.reserve (keymap.size () * 2);

  keymap.push_back (key);
  hash[0] = 3;
}

keysym_t *
keyboard_manager::lookup_keysym (rxvt_term *term, KeySym keysym, unsigned int state)
{
  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);

  return index >= 0 ? keymap [index] : 0;
}

bool
keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state, const char *kbuf, int len)
{
  keysym_t *key = lookup_keysym (term, keysym, state);

  if (key)
    {
      if (key->type == keysym_t::BUILTIN_STRING)
        {
          term->tt_write_user_input (kbuf, len);
          return true;
        }
      else if (key->type != keysym_t::BUILTIN)
        {
          wchar_t *ws = rxvt_utf8towcs (key->str);
          char *str = rxvt_wcstombs (ws);
          // TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
          free (ws);

          if (char *colon = strchr (str, ':'))
            {
              if (strncmp (str, "command:", 8) == 0)
                term->cmdbuf_append (str + 8, strlen (str) - 8);
              else if (strncmp (str, "string:", 7) == 0)
                term->tt_write_user_input (colon + 1, strlen (colon + 1));
              else if (strncmp (str, "perl:", 5) == 0)
                HOOK_INVOKE ((term, HOOK_USER_COMMAND, DT_STR, colon + 1, DT_END));
              else
                HOOK_INVOKE ((term, HOOK_ACTION, DT_STR_LEN, str, colon - str, DT_STR, colon + 1, DT_INT, 0, DT_STR_LEN, kbuf, len, DT_END));
            }
          else
            term->tt_write_user_input (str, strlen (str));

          free (str);

          return true;
        }
    }

  return false;
}

void
keyboard_manager::register_done ()
{
  unsigned int i, index, hashkey;
  uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS];       // size of each bucket

  memset (hash_bucket_size, 0, sizeof (hash_bucket_size));

  // determine hash bucket size
  for (i = 0; i < keymap.size (); ++i)
    {
      hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
      ++hash_bucket_size [hashkey];
    }

  // now we know the size of each bucket
  // compute the index of each bucket
  for (index = 0, i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
    {
      hash [i] = index;
      index += hash_bucket_size [i];
    }

  // and allocate just enough space
  simplevec <keysym_t *> sorted_keymap (index, 0);

  memset (hash_bucket_size, 0, sizeof (hash_bucket_size));

  // fill in sorted_keymap
  // it is sorted in each bucket
  for (i = 0; i < keymap.size (); ++i)
    {
      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)
        {
          sorted_keymap [index] = sorted_keymap [index - 1];
          --index;
        }

      sorted_keymap [index] = keymap [i];
      ++hash_bucket_size [hashkey];
    }

  keymap.swap (sorted_keymap);

#ifndef NDEBUG
  // check for invariants
  for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
    {
      index = hash[i];
      for (int j = 0; j < hash_bucket_size [i]; ++j)
        {
          assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));

          if (j)
            assert (compare_priority (keymap [index + j - 1],
                    keymap [index + j]) >= 0);
        }
    }

  // this should be able to detect most possible bugs
  for (i = 0; i < sorted_keymap.size (); ++i)
    {
      keysym_t *a = sorted_keymap[i];
      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
}

int
keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
{
  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 < end; ++index)
    {
      keysym_t *key = keymap [index];

      if (key->keysym == keysym
          // match only the specified bits in state and ignore others
          && (key->state & state) == key->state)
        return index;
    }

  return -1;
}

#endif /* KEYSYM_RESOURCE */
// vim:et:ts=2:sw=2
Revision:	1.72
Committed:	Tue Mar 17 09:23:08 2015 UTC (11 years, 7 months ago) by sf-exg
Content type:	text/plain
Branch:	MAIN
Changes since 1.71:	+11 -5 lines
Log Message:	Add perl method to lookup the action bound to a key combination.
#	User	Rev	Content
1	root	1.25	/----------------------------------------------------------------------
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	root	1.39	* Copyright (c) 2005-2006 Marc Lehmann <schmorp@schmorp.de>
8	root	1.25	*
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	root	1.69	* the Free Software Foundation; either version 3 of the License, or
12	root	1.25	* (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
24	root	1.1	#include "../config.h"
25			#include "rxvt.h"
26	root	1.7
27			#ifdef KEYSYM_RESOURCE
28
29	sf-exg	1.58	#include <string.h>
30	root	1.7
31	root	1.18	#include "rxvtperl.h"
32	root	1.1	#include "keyboard.h"
33
34	root	1.13	/* an intro to the data structure:
35			*
36			* vector keymap[] is grouped.
37			*
38			* inside each group, elements are sorted by the criteria given by compare_priority().
39			* the lookup of keysym is done in two steps:
40			* 1) locate the group corresponds to the keysym;
41			* 2) do a linear search inside the group.
42			*
43			* array hash[] effectively defines a map from a keysym to a group in keymap[].
44			*
45			* each group has its address(the index of first group element in keymap[]),
46			* which is computed and stored in hash[].
47			* hash[] stores the addresses in the form of:
48			* index: 0 I1 I2 I3 In
49			* value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An
50			* where
51			* A1 = 0;
52			* Ai+1 = N1 + N2 + ... + Ni.
53	sf-exg	1.34	* it is computed from hash_bucket_size[]:
54	root	1.13	* index: 0 I1 I2 I3 In
55			* value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0
56	sf-exg	1.33	* 0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the computation of hash[])
57	root	1.13	* or we can say
58	sf-exg	1.34	* hash_bucket_size[Ii] = Ni; hash_bucket_size[elsewhere] = 0,
59	root	1.13	* where
60			* set {I1, I2, ..., In} = { hashkey of keymap[0]->keysym, ..., keymap[keymap.size-1]->keysym }
61			* where hashkey of keymap[i]->keysym = keymap[i]->keysym & KEYSYM_HASH_MASK
62	sf-exg	1.34	* n(the number of groups) = the number of non-zero member of hash_bucket_size[];
63			* Ni(the size of group i) = hash_bucket_size[Ii].
64	root	1.13	*/
65
66	root	1.1	// return: priority_of_a - priority_of_b
67	root	1.2	static int
68	root	1.1	compare_priority (keysym_t a, keysym_t b)
69			{
70			// (the more '1's in state; the less range): the greater priority
71	sf-exg	1.43	int ca = ecb_popcount32 (a->state /* & OtherModMask */);
72			int cb = ecb_popcount32 (b->state /* & OtherModMask */);
73	root	1.2
74	sf-exg	1.60	return ca - cb;
75	root	1.1	}
76
77			////////////////////////////////////////////////////////////////////////////////
78	root	1.2	keyboard_manager::keyboard_manager ()
79	root	1.1	{
80	root	1.2	keymap.reserve (256);
81	root	1.4	hash [0] = 1; // hash[0] != 0 indicates uninitialized data
82	root	1.1	}
83
84			keyboard_manager::~keyboard_manager ()
85			{
86	sf-exg	1.37	for (unsigned int i = 0; i < keymap.size (); ++i)
87	sf-exg	1.36	{
88	sf-exg	1.45	free (keymap [i]->str);
89	sf-exg	1.37	delete keymap [i];
90	sf-exg	1.36	}
91	root	1.1	}
92
93			void
94	sf-exg	1.71	keyboard_manager::unregister_action (KeySym keysym, unsigned int state)
95			{
96			for (unsigned int i = 0; i < keymap.size (); ++i)
97			if (keymap [i]->keysym == keysym
98			&& keymap [i]->state == state)
99			{
100			free (keymap [i]->str);
101			delete keymap [i];
102
103			if (i < keymap.size () - 1)
104			keymap [i] = keymap [keymap.size () - 1];
105			keymap.pop_back ();
106
107			break;
108			}
109			}
110
111			void
112	sf-exg	1.67	keyboard_manager::register_action (KeySym keysym, unsigned int state, const wchar_t *ws)
113	root	1.1	{
114	sf-exg	1.70	char *action = rxvt_wcstoutf8 (ws);
115	root	1.1
116	sf-exg	1.42	keysym_t *key = new keysym_t;
117
118	sf-exg	1.55	key->keysym = keysym;
119			key->state = state;
120	sf-exg	1.70	key->str = action;
121	sf-exg	1.55	key->type = keysym_t::STRING;
122	root	1.2
123	sf-exg	1.70	if (strncmp (action, "builtin:", 8) == 0)
124	sf-exg	1.55	key->type = keysym_t::BUILTIN;
125	sf-exg	1.70	else if (strncmp (action, "builtin-string:", 15) == 0)
126	sf-exg	1.65	key->type = keysym_t::BUILTIN_STRING;
127	root	1.1
128	sf-exg	1.71	unregister_action (keysym, state);
129
130	sf-exg	1.55	if (keymap.size () == keymap.capacity ())
131			keymap.reserve (keymap.size () * 2);
132	sf-exg	1.47
133	sf-exg	1.55	keymap.push_back (key);
134			hash[0] = 3;
135	root	1.1	}
136
137	sf-exg	1.72	keysym_t *
138			keyboard_manager::lookup_keysym (rxvt_term *term, KeySym keysym, unsigned int state)
139	root	1.1	{
140	sf-exg	1.46	assert (("register_done() need to be called", hash[0] == 0));
141	root	1.1
142	root	1.14	state &= OtherModMask; // mask out uninteresting modifiers
143
144	root	1.6	if (state & term->ModMetaMask) state \|= MetaMask;
145			if (state & term->ModNumLockMask) state \|= NumLockMask;
146			if (state & term->ModLevel3Mask) state \|= Level3Mask;
147	root	1.3
148			if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
149			state \|= AppKeypadMask;
150
151	root	1.1	int index = find_keysym (keysym, state);
152
153	sf-exg	1.72	return index >= 0 ? keymap [index] : 0;
154			}
155
156			bool
157			keyboard_manager::dispatch (rxvt_term term, KeySym keysym, unsigned int state, const char kbuf, int len)
158			{
159			keysym_t *key = lookup_keysym (term, keysym, state);
160
161			if (key)
162	root	1.1	{
163	sf-exg	1.65	if (key->type == keysym_t::BUILTIN_STRING)
164			{
165			term->tt_write_user_input (kbuf, len);
166			return true;
167			}
168			else if (key->type != keysym_t::BUILTIN)
169	root	1.16	{
170	sf-exg	1.51	wchar_t *ws = rxvt_utf8towcs (key->str);
171			char *str = rxvt_wcstombs (ws);
172	root	1.16	// TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
173	sf-exg	1.51	free (ws);
174	root	1.2
175	root	1.62	if (char *colon = strchr (str, ':'))
176			{
177			if (strncmp (str, "command:", 8) == 0)
178			term->cmdbuf_append (str + 8, strlen (str) - 8);
179	root	1.63	else if (strncmp (str, "string:", 7) == 0)
180	sf-exg	1.64	term->tt_write_user_input (colon + 1, strlen (colon + 1));
181	root	1.66	else if (strncmp (str, "perl:", 5) == 0)
182	root	1.62	HOOK_INVOKE ((term, HOOK_USER_COMMAND, DT_STR, colon + 1, DT_END));
183			else
184	root	1.68	HOOK_INVOKE ((term, HOOK_ACTION, DT_STR_LEN, str, colon - str, DT_STR, colon + 1, DT_INT, 0, DT_STR_LEN, kbuf, len, DT_END));
185	root	1.62	}
186	root	1.63	else
187	sf-exg	1.64	term->tt_write_user_input (str, strlen (str));
188	root	1.2
189	root	1.16	free (str);
190	root	1.2
191	root	1.16	return true;
192			}
193	root	1.1	}
194	root	1.16
195			return false;
196	root	1.1	}
197
198			void
199	sf-exg	1.47	keyboard_manager::register_done ()
200	root	1.1	{
201			unsigned int i, index, hashkey;
202	sf-exg	1.34	uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket
203	root	1.1
204	sf-exg	1.34	memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
205	root	1.1
206	root	1.11	// determine hash bucket size
207	root	1.2	for (i = 0; i < keymap.size (); ++i)
208	sf-exg	1.41	{
209			hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
210			++hash_bucket_size [hashkey];
211			}
212	root	1.1
213	sf-exg	1.34	// now we know the size of each bucket
214			// compute the index of each bucket
215	sf-exg	1.60	for (index = 0, i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
216	root	1.1	{
217	root	1.11	hash [i] = index;
218	sf-exg	1.60	index += hash_bucket_size [i];
219	root	1.1	}
220	root	1.2
221	root	1.1	// and allocate just enough space
222	sf-exg	1.60	simplevec <keysym_t *> sorted_keymap (index, 0);
223	root	1.1
224	sf-exg	1.38	memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
225
226	root	1.1	// fill in sorted_keymap
227	sf-exg	1.34	// it is sorted in each bucket
228	root	1.2	for (i = 0; i < keymap.size (); ++i)
229	sf-exg	1.41	{
230			hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
231
232			index = hash [hashkey] + hash_bucket_size [hashkey];
233
234			while (index > hash [hashkey]
235			&& compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
236			{
237			sorted_keymap [index] = sorted_keymap [index - 1];
238			--index;
239			}
240
241			sorted_keymap [index] = keymap [i];
242			++hash_bucket_size [hashkey];
243			}
244	root	1.1
245	root	1.2	keymap.swap (sorted_keymap);
246	root	1.1
247	root	1.32	#ifndef NDEBUG
248	root	1.1	// check for invariants
249	sf-exg	1.34	for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
250	root	1.1	{
251	root	1.2	index = hash[i];
252	sf-exg	1.34	for (int j = 0; j < hash_bucket_size [i]; ++j)
253	root	1.1	{
254	sf-exg	1.41	assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
255	root	1.2
256	root	1.1	if (j)
257	root	1.4	assert (compare_priority (keymap [index + j - 1],
258			keymap [index + j]) >= 0);
259	root	1.1	}
260			}
261
262			// this should be able to detect most possible bugs
263			for (i = 0; i < sorted_keymap.size (); ++i)
264			{
265			keysym_t *a = sorted_keymap[i];
266	sf-exg	1.41	int index = find_keysym (a->keysym, a->state);
267	root	1.6
268	sf-exg	1.41	assert (index >= 0);
269			keysym_t *b = keymap [index];
270			assert (i == index // the normally expected result
271			\|\| a->keysym == b->keysym
272			&& compare_priority (a, b) <= 0); // is effectively the same or a closer match
273	root	1.1	}
274			#endif
275			}
276
277			int
278			keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
279			{
280	root	1.2	int hashkey = keysym & KEYSYM_HASH_MASK;
281			unsigned int index = hash [hashkey];
282	sf-exg	1.34	unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1
283	ayin	1.28	? hash [hashkey + 1]
284	root	1.11	: keymap.size ();
285	root	1.1
286	root	1.11	for (; index < end; ++index)
287	root	1.1	{
288	root	1.4	keysym_t *key = keymap [index];
289	root	1.2
290	sf-exg	1.41	if (key->keysym == keysym
291	root	1.1	// match only the specified bits in state and ignore others
292	root	1.16	&& (key->state & state) == key->state)
293	root	1.2	return index;
294	root	1.1	}
295
296			return -1;
297			}
298
299			#endif /* KEYSYM_RESOURCE */
300			// vim:et:ts=2:sw=2