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

#ifndef KEYBOARD_H_
#define KEYBOARD_H_

#ifdef KEYSYM_RESOURCE

#include <inttypes.h>

#include "feature.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;

typedef void (keyevent_handler) (rxvt_term *rt,
                                 keysym_t *key,
                                 KeySym keysym,
                                 unsigned int state);

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

  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         */
  uint16_t    range;    /* =1: single keysym; >1: a of range keysyms        */
  keysym_type type;
  const char  *str;      /* would normally be a keycode translation in UTF-8 */
};

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

  void clear ();
  void register_user_translation (KeySym keysym, unsigned int state, const char *trans);
  void register_done ();        // call this to make newly registered keymaps take effect
  bool dispatch (rxvt_term *term, KeySym keysym, unsigned int state);

private:
  void register_keymap (keysym_t *key);
  void setup_hash ();
  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.13
Committed:	Mon Feb 21 07:41:01 2011 UTC (13 years, 3 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.12:	+1 -1 lines
Log Message:	the pcg is now the schmorp
#	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			* 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	#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 "feature.h"
32			#include "rxvtutil.h"
33
34	root	1.2	#define KEYSYM_HASH_BITS 4 /* lowest #bits of keysym is used as hash key */
35	sf-exg	1.9	#define KEYSYM_HASH_BUCKETS (1<<KEYSYM_HASH_BITS)
36			#define KEYSYM_HASH_MASK (KEYSYM_HASH_BUCKETS-1)
37	root	1.1
38			#define MetaMask 0x0100
39			#define NumLockMask 0x0200
40	root	1.2	#define AppKeypadMask 0x0400
41	root	1.3	#define Level3Mask 0x0800 // currently not supported
42	root	1.2	#define OtherModMask (ShiftMask \| LockMask \| ControlMask \
43	root	1.1	\| Mod1Mask \| Mod2Mask \| Mod3Mask \| Mod4Mask \| Mod5Mask)
44
45	root	1.3	#if OtherModMask > 0xff
46			# error FATAL: X modifiers might clash with rxvt-unicode ones
47	root	1.1	#endif
48
49			struct rxvt_term;
50			struct keysym_t;
51	root	1.2
52	root	1.1	typedef void (keyevent_handler) (rxvt_term *rt,
53			keysym_t *key,
54			KeySym keysym,
55			unsigned int state);
56
57			struct keysym_t
58			{
59	root	1.2	enum keysym_type {
60	sf-exg	1.12	STRING, LIST, BUILTIN,
61	root	1.2	};
62
63			KeySym keysym;
64	root	1.1	/* only the lower 8 bits of state are used for matching according to X.h */
65			/* the higher bits are preserved for Meta/NumLock keys */
66			/* which are mapped to corresponding lower bits at register time */
67	root	1.2	uint16_t state; /* indicates each modifiers' DOWN/UP status */
68			uint16_t range; /* =1: single keysym; >1: a of range keysyms */
69			keysym_type type;
70			const char str; / would normally be a keycode translation in UTF-8 */
71	root	1.1	};
72
73			class keyboard_manager
74			{
75			public:
76	root	1.2	keyboard_manager ();
77	root	1.1	~keyboard_manager ();
78
79			void clear ();
80			void register_user_translation (KeySym keysym, unsigned int state, const char *trans);
81			void register_done (); // call this to make newly registered keymaps take effect
82	root	1.2	bool dispatch (rxvt_term *term, KeySym keysym, unsigned int state);
83	root	1.1
84			private:
85			void register_keymap (keysym_t *key);
86			void setup_hash ();
87			int find_keysym (KeySym keysym, unsigned int state);
88
89			private:
90	sf-exg	1.9	uint16_t hash[KEYSYM_HASH_BUCKETS];
91	root	1.2	vector<keysym_t *> keymap;
92	root	1.1	};
93
94			#endif /* KEYSYM_RESOURCE */
95	root	1.5
96	root	1.1	#endif /* KEYBOARD_H_ */