rxvt-unicode/src/keyboard.h

/*----------------------------------------------------------------------*
 * File:        keyboard.h
 *----------------------------------------------------------------------*
 *
 * 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.
 *----------------------------------------------------------------------*/

#ifndef KEYBOARD_H_
#define KEYBOARD_H_

#ifdef KEYSYM_RESOURCE

#include <inttypes.h>

#include "rxvtutil.h"

#define KEYSYM_HASH_BITS        4       /* lowest #bits of keysym is used as hash key */
#define KEYSYM_HASH_BUCKETS     (1 << KEYSYM_HASH_BITS)
#define KEYSYM_HASH_MASK        (KEYSYM_HASH_BUCKETS - 1)

#define MetaMask                0x0100
#define NumLockMask             0x0200
#define AppKeypadMask           0x0400
#define Level3Mask              0x0800 // currently not supported
#define OtherModMask            (ShiftMask | LockMask | ControlMask \
                                | Mod1Mask | Mod2Mask | Mod3Mask | Mod4Mask | Mod5Mask)

#if OtherModMask > 0xff
# error FATAL: X modifiers might clash with rxvt-unicode ones
#endif

struct rxvt_term;

struct keysym_t
{
  enum keysym_type {
    STRING, BUILTIN, BUILTIN_STRING,
  };

  KeySym      keysym;
  /* only the lower 8 bits of state are used for matching according to X.h */
  /* the higher bits are preserved for Meta/NumLock keys */
  /* which are mapped to corresponding lower bits at register time */
  uint16_t    state;    /* indicates each modifiers' DOWN/UP status         */
  keysym_type type;
  char        *str;      /* the key's definition encoded in UTF-8 */
};

class keyboard_manager
{
public:
  keyboard_manager ();
  ~keyboard_manager ();

  void unregister_action (KeySym keysym, unsigned int state);
  void register_action (KeySym keysym, unsigned int state, const wchar_t *ws);
  void register_done ();        // call this to make newly registered key bindings take effect
  bool dispatch (rxvt_term *term, KeySym keysym, unsigned int state, const char *kbuf, int len);

private:
  int find_keysym (KeySym keysym, unsigned int state);

private:
  uint16_t hash[KEYSYM_HASH_BUCKETS];
  vector<keysym_t *> keymap;
};

#endif /* KEYSYM_RESOURCE */

#endif /* KEYBOARD_H_ */
Revision:	1.29
Committed:	Thu Jan 15 14:30:05 2015 UTC (9 years, 4 months ago) by sf-exg
Content type:	text/plain
Branch:	MAIN
Changes since 1.28:	+1 -0 lines
Log Message:	Before registering a binding for a key, unregister the current binding for it, if any.
#	User	Rev	Content
1	root	1.7	/----------------------------------------------------------------------
2			* File: keyboard.h
3			----------------------------------------------------------------------
4			*
5			* All portions of code are copyright by their respective author/s.
6			* Copyright (c) 2005 WU Fengguang
7	root	1.13	* Copyright (c) 2005-2006 Marc Lehmann <schmorp@schmorp.de>
8	root	1.7	*
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.28	* the Free Software Foundation; either version 3 of the License, or
12	root	1.7	* (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	#ifndef KEYBOARD_H_
25			#define KEYBOARD_H_
26
27	root	1.5	#ifdef KEYSYM_RESOURCE
28
29	root	1.2	#include <inttypes.h>
30
31	root	1.1	#include "rxvtutil.h"
32
33	root	1.2	#define KEYSYM_HASH_BITS 4 /* lowest #bits of keysym is used as hash key */
34	sf-exg	1.24	#define KEYSYM_HASH_BUCKETS (1 << KEYSYM_HASH_BITS)
35			#define KEYSYM_HASH_MASK (KEYSYM_HASH_BUCKETS - 1)
36	root	1.1
37			#define MetaMask 0x0100
38			#define NumLockMask 0x0200
39	root	1.2	#define AppKeypadMask 0x0400
40	root	1.3	#define Level3Mask 0x0800 // currently not supported
41	root	1.2	#define OtherModMask (ShiftMask \| LockMask \| ControlMask \
42	root	1.1	\| Mod1Mask \| Mod2Mask \| Mod3Mask \| Mod4Mask \| Mod5Mask)
43
44	root	1.3	#if OtherModMask > 0xff
45			# error FATAL: X modifiers might clash with rxvt-unicode ones
46	root	1.1	#endif
47
48			struct rxvt_term;
49
50			struct keysym_t
51			{
52	root	1.2	enum keysym_type {
53	sf-exg	1.26	STRING, BUILTIN, BUILTIN_STRING,
54	root	1.2	};
55
56			KeySym keysym;
57	root	1.1	/* only the lower 8 bits of state are used for matching according to X.h */
58			/* the higher bits are preserved for Meta/NumLock keys */
59			/* which are mapped to corresponding lower bits at register time */
60	root	1.2	uint16_t state; /* indicates each modifiers' DOWN/UP status */
61			keysym_type type;
62	sf-exg	1.21	char str; / the key's definition encoded in UTF-8 */
63	root	1.1	};
64
65			class keyboard_manager
66			{
67			public:
68	root	1.2	keyboard_manager ();
69	root	1.1	~keyboard_manager ();
70
71	sf-exg	1.29	void unregister_action (KeySym keysym, unsigned int state);
72	sf-exg	1.27	void register_action (KeySym keysym, unsigned int state, const wchar_t *ws);
73	sf-exg	1.20	void register_done (); // call this to make newly registered key bindings take effect
74	sf-exg	1.25	bool dispatch (rxvt_term term, KeySym keysym, unsigned int state, const char kbuf, int len);
75	root	1.1
76			private:
77			int find_keysym (KeySym keysym, unsigned int state);
78
79			private:
80	sf-exg	1.9	uint16_t hash[KEYSYM_HASH_BUCKETS];
81	root	1.2	vector<keysym_t *> keymap;
82	root	1.1	};
83
84			#endif /* KEYSYM_RESOURCE */
85	root	1.5
86	root	1.1	#endif /* KEYBOARD_H_ */