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 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"

#ifdef KEYSYM_RESOURCE

#include <cstring>

#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].
 */

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
    rt->tt_write (str, strlen (str));
}

// 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 = 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 discussed
//  return b->state - a->state;
  else
    return 0;
}

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

keyboard_manager::~keyboard_manager ()
{
  clear ();
}

void
keyboard_manager::clear ()
{
  hash [0] = 2;

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

  keymap.clear ();
}

// 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)
{
  keysym_t *key = new keysym_t;
  wchar_t *wc = rxvt_mbstowcs (trans);
  char *translation = rxvt_wcstoutf8 (wc);
  free (wc);

  if (key && translation)
    {
      key->keysym = keysym;
      key->state  = state;
      key->str    = translation;
      key->type   = keysym_t::STRING;

      if (strncmp (translation, "builtin:", 8) == 0)
        key->type = keysym_t::BUILTIN;

      register_keymap (key);
    }
  else
    {
      delete key;
      free ((void *)translation);
      rxvt_fatal ("out of memory, aborting.\n");
    }
}

void
keyboard_manager::register_keymap (keysym_t *key)
{
  if (keymap.size () == keymap.capacity ())
    keymap.reserve (keymap.size () * 2);

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

void
keyboard_manager::register_done ()
{
  setup_hash ();
}

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

  if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
    state |= AppKeypadMask;

  int index = find_keysym (keysym, state);

  if (index >= 0)
    {
      const keysym_t &key = *keymap [index];

      if (key.type != keysym_t::BUILTIN)
        {
          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)
            {
              case keysym_t::STRING:
                output_string (term, str);
                break;
            }

          free (str);

          return true;
        }
    }

  return false;
}

void
keyboard_manager::setup_hash ()
{
  unsigned int i, index, hashkey;
  vector <keysym_t *> sorted_keymap;
  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
  hash [0] = 0;
  for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i)
    {
      index += hash_bucket_size [i - 1];
      hash [i] = index;
    }

  // and allocate just enough space
  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 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.41
Committed:	Sat Apr 30 18:45:38 2011 UTC (13 years, 1 month ago) by sf-exg
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-9_11
Changes since 1.40:	+29 -71 lines
Log Message:	Remove 'list' syntax for keysym resources, it serves no useful purpose.
#	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			* the Free Software Foundation; either version 2 of the License, or
12			* (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			#include <cstring>
30
31	root	1.18	#include "rxvtperl.h"
32	root	1.1	#include "keyboard.h"
33			#include "command.h"
34
35	root	1.13	/* an intro to the data structure:
36			*
37			* vector keymap[] is grouped.
38			*
39			* inside each group, elements are sorted by the criteria given by compare_priority().
40			* the lookup of keysym is done in two steps:
41			* 1) locate the group corresponds to the keysym;
42			* 2) do a linear search inside the group.
43			*
44			* array hash[] effectively defines a map from a keysym to a group in keymap[].
45			*
46			* each group has its address(the index of first group element in keymap[]),
47			* which is computed and stored in hash[].
48			* hash[] stores the addresses in the form of:
49			* index: 0 I1 I2 I3 In
50			* value: 0...0, A1...A1, A2...A2, A3...A3, ..., An...An
51			* where
52			* A1 = 0;
53			* Ai+1 = N1 + N2 + ... + Ni.
54	sf-exg	1.34	* it is computed from hash_bucket_size[]:
55	root	1.13	* index: 0 I1 I2 I3 In
56			* value: 0...0, N1, 0...0, N2, 0...0, N3, ..., Nn, 0...0
57	sf-exg	1.33	* 0...0, 0.......0, N1.....N1, N1+N2...N1+N2, ... (the computation of hash[])
58	root	1.13	* or we can say
59	sf-exg	1.34	* hash_bucket_size[Ii] = Ni; hash_bucket_size[elsewhere] = 0,
60	root	1.13	* where
61			* set {I1, I2, ..., In} = { hashkey of keymap[0]->keysym, ..., keymap[keymap.size-1]->keysym }
62			* where hashkey of keymap[i]->keysym = keymap[i]->keysym & KEYSYM_HASH_MASK
63	sf-exg	1.34	* 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].
65	root	1.13	*/
66
67	root	1.2	static void
68			output_string (rxvt_term rt, const char str)
69	root	1.1	{
70	root	1.10	if (strncmp (str, "command:", 8) == 0)
71	root	1.40	rt->cmdbuf_append (str + 8, strlen (str) - 8);
72	root	1.18	else if (strncmp (str, "perl:", 5) == 0)
73	root	1.24	HOOK_INVOKE((rt, HOOK_USER_COMMAND, DT_STR, str + 5, DT_END));
74	root	1.1	else
75	root	1.19	rt->tt_write (str, strlen (str));
76	root	1.1	}
77
78			// return: priority_of_a - priority_of_b
79	root	1.2	static int
80	root	1.1	compare_priority (keysym_t a, keysym_t b)
81			{
82			// (the more '1's in state; the less range): the greater priority
83	root	1.31	int ca = rxvt_popcount (a->state /* & OtherModMask */);
84			int cb = rxvt_popcount (b->state /* & OtherModMask */);
85	root	1.2
86	root	1.1	if (ca != cb)
87			return ca - cb;
88	sf-exg	1.33	//else if (a->state != b->state) // this behavior is to be discussed
89	root	1.1	// return b->state - a->state;
90			else
91	sf-exg	1.41	return 0;
92	root	1.1	}
93
94			////////////////////////////////////////////////////////////////////////////////
95	root	1.2	keyboard_manager::keyboard_manager ()
96	root	1.1	{
97	root	1.2	keymap.reserve (256);
98	root	1.4	hash [0] = 1; // hash[0] != 0 indicates uninitialized data
99	root	1.1	}
100
101			keyboard_manager::~keyboard_manager ()
102			{
103			clear ();
104			}
105
106			void
107			keyboard_manager::clear ()
108			{
109	root	1.2	hash [0] = 2;
110	sf-exg	1.36
111	sf-exg	1.37	for (unsigned int i = 0; i < keymap.size (); ++i)
112	sf-exg	1.36	{
113	sf-exg	1.37	free ((void *)keymap [i]->str);
114			delete keymap [i];
115			keymap [i] = 0;
116	sf-exg	1.36	}
117
118	sf-exg	1.37	keymap.clear ();
119	root	1.1	}
120
121			// a wrapper for register_keymap,
122			// so that outside codes don't have to know so much details.
123			//
124			// the string 'trans' is copied to an internal managed buffer,
125			// so the caller can free memory of 'trans' at any time.
126			void
127	root	1.2	keyboard_manager::register_user_translation (KeySym keysym, unsigned int state, const char *trans)
128	root	1.1	{
129			keysym_t *key = new keysym_t;
130	root	1.2	wchar_t *wc = rxvt_mbstowcs (trans);
131	root	1.19	char *translation = rxvt_wcstoutf8 (wc);
132	root	1.2	free (wc);
133	root	1.1
134	root	1.2	if (key && translation)
135	root	1.1	{
136			key->keysym = keysym;
137	root	1.2	key->state = state;
138			key->str = translation;
139	root	1.22	key->type = keysym_t::STRING;
140	root	1.2
141	sf-exg	1.41	if (strncmp (translation, "builtin:", 8) == 0)
142	root	1.16	key->type = keysym_t::BUILTIN;
143	root	1.1
144			register_keymap (key);
145			}
146			else
147			{
148			delete key;
149	root	1.2	free ((void *)translation);
150	root	1.1	rxvt_fatal ("out of memory, aborting.\n");
151			}
152			}
153
154			void
155			keyboard_manager::register_keymap (keysym_t *key)
156			{
157	root	1.2	if (keymap.size () == keymap.capacity ())
158			keymap.reserve (keymap.size () * 2);
159	root	1.1
160	root	1.2	keymap.push_back (key);
161			hash[0] = 3;
162	root	1.1	}
163
164			void
165			keyboard_manager::register_done ()
166			{
167			setup_hash ();
168			}
169
170	root	1.2	bool
171			keyboard_manager::dispatch (rxvt_term *term, KeySym keysym, unsigned int state)
172	root	1.1	{
173	root	1.2	assert (hash[0] == 0 && "register_done() need to be called");
174	root	1.1
175	root	1.14	state &= OtherModMask; // mask out uninteresting modifiers
176
177	root	1.6	if (state & term->ModMetaMask) state \|= MetaMask;
178			if (state & term->ModNumLockMask) state \|= NumLockMask;
179			if (state & term->ModLevel3Mask) state \|= Level3Mask;
180	root	1.3
181			if (!!(term->priv_modes & PrivMode_aplKP) != !!(state & ShiftMask))
182			state \|= AppKeypadMask;
183
184	root	1.1	int index = find_keysym (keysym, state);
185
186			if (index >= 0)
187			{
188	root	1.2	const keysym_t &key = *keymap [index];
189
190	root	1.16	if (key.type != keysym_t::BUILTIN)
191			{
192			wchar_t *wc = rxvt_utf8towcs (key.str);
193			char *str = rxvt_wcstombs (wc);
194			// TODO: do (some) translations, unescaping etc, here (allow \u escape etc.)
195			free (wc);
196	root	1.2
197	root	1.16	switch (key.type)
198			{
199	root	1.22	case keysym_t::STRING:
200	root	1.16	output_string (term, str);
201			break;
202	root	1.2	}
203
204	root	1.16	free (str);
205	root	1.2
206	root	1.16	return true;
207			}
208	root	1.1	}
209	root	1.16
210			return false;
211	root	1.1	}
212
213			void
214			keyboard_manager::setup_hash ()
215			{
216			unsigned int i, index, hashkey;
217	root	1.2	vector <keysym_t *> sorted_keymap;
218	sf-exg	1.34	uint16_t hash_bucket_size[KEYSYM_HASH_BUCKETS]; // size of each bucket
219	root	1.1
220	sf-exg	1.34	memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
221	root	1.1
222	root	1.11	// determine hash bucket size
223	root	1.2	for (i = 0; i < keymap.size (); ++i)
224	sf-exg	1.41	{
225			hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
226			++hash_bucket_size [hashkey];
227			}
228	root	1.1
229	sf-exg	1.34	// now we know the size of each bucket
230			// compute the index of each bucket
231	root	1.4	hash [0] = 0;
232	sf-exg	1.34	for (index = 0, i = 1; i < KEYSYM_HASH_BUCKETS; ++i)
233	root	1.1	{
234	sf-exg	1.34	index += hash_bucket_size [i - 1];
235	root	1.11	hash [i] = index;
236	root	1.1	}
237	root	1.2
238	root	1.1	// and allocate just enough space
239	sf-exg	1.34	sorted_keymap.insert (sorted_keymap.begin (), index + hash_bucket_size [i - 1], 0);
240	root	1.1
241	sf-exg	1.38	memset (hash_bucket_size, 0, sizeof (hash_bucket_size));
242
243	root	1.1	// fill in sorted_keymap
244	sf-exg	1.34	// it is sorted in each bucket
245	root	1.2	for (i = 0; i < keymap.size (); ++i)
246	sf-exg	1.41	{
247			hashkey = keymap [i]->keysym & KEYSYM_HASH_MASK;
248
249			index = hash [hashkey] + hash_bucket_size [hashkey];
250
251			while (index > hash [hashkey]
252			&& compare_priority (keymap [i], sorted_keymap [index - 1]) > 0)
253			{
254			sorted_keymap [index] = sorted_keymap [index - 1];
255			--index;
256			}
257
258			sorted_keymap [index] = keymap [i];
259			++hash_bucket_size [hashkey];
260			}
261	root	1.1
262	root	1.2	keymap.swap (sorted_keymap);
263	root	1.1
264	root	1.32	#ifndef NDEBUG
265	root	1.1	// check for invariants
266	sf-exg	1.34	for (i = 0; i < KEYSYM_HASH_BUCKETS; ++i)
267	root	1.1	{
268	root	1.2	index = hash[i];
269	sf-exg	1.34	for (int j = 0; j < hash_bucket_size [i]; ++j)
270	root	1.1	{
271	sf-exg	1.41	assert (i == (keymap [index + j]->keysym & KEYSYM_HASH_MASK));
272	root	1.2
273	root	1.1	if (j)
274	root	1.4	assert (compare_priority (keymap [index + j - 1],
275			keymap [index + j]) >= 0);
276	root	1.1	}
277			}
278
279			// this should be able to detect most possible bugs
280			for (i = 0; i < sorted_keymap.size (); ++i)
281			{
282			keysym_t *a = sorted_keymap[i];
283	sf-exg	1.41	int index = find_keysym (a->keysym, a->state);
284	root	1.6
285	sf-exg	1.41	assert (index >= 0);
286			keysym_t *b = keymap [index];
287			assert (i == index // the normally expected result
288			\|\| a->keysym == b->keysym
289			&& compare_priority (a, b) <= 0); // is effectively the same or a closer match
290	root	1.1	}
291			#endif
292			}
293
294			int
295			keyboard_manager::find_keysym (KeySym keysym, unsigned int state)
296			{
297	root	1.2	int hashkey = keysym & KEYSYM_HASH_MASK;
298			unsigned int index = hash [hashkey];
299	sf-exg	1.34	unsigned int end = hashkey < KEYSYM_HASH_BUCKETS - 1
300	ayin	1.28	? hash [hashkey + 1]
301	root	1.11	: keymap.size ();
302	root	1.1
303	root	1.11	for (; index < end; ++index)
304	root	1.1	{
305	root	1.4	keysym_t *key = keymap [index];
306	root	1.2
307	sf-exg	1.41	if (key->keysym == keysym
308	root	1.1	// match only the specified bits in state and ignore others
309	root	1.16	&& (key->state & state) == key->state)
310	root	1.2	return index;
311	root	1.1	}
312
313			return -1;
314			}
315
316			#endif /* KEYSYM_RESOURCE */
317			// vim:et:ts=2:sw=2