1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
3 obt/keyboard.c for the Openbox window manager
4 Copyright (c) 2007 Dana Jansens
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 See the COPYING file for a copy of the GNU General Public License.
19 #include "obt/display.h"
20 #include "obt/keyboard.h"
23 #include <X11/keysym.h>
25 /* These masks are constants and the modifier keys are bound to them as
27 ShiftMask (1<<0), LockMask (1<<1), ControlMask (1<<2), Mod1Mask (1<<3),
28 Mod2Mask (1<<4), Mod3Mask (1<<5), Mod4Mask (1<<6), Mod5Mask (1<<7)
31 #define ALL_MASKS 0xff /* an or'ing of all 8 keyboard masks */
33 /* Get the bitflag for the n'th modifier mask */
34 #define nth_mask(n) (1 << n)
36 static void set_modkey_mask(guchar mask, KeySym sym);
37 void obt_keyboard_shutdown();
39 static XModifierKeymap *modmap;
40 static KeySym *keymap;
41 static gint min_keycode, max_keycode, keysyms_per_keycode;
42 /* This is a bitmask of the different masks for each modifier key */
43 static guchar modkeys_keys[OBT_KEYBOARD_NUM_MODKEYS];
45 static gboolean alt_l = FALSE;
46 static gboolean meta_l = FALSE;
47 static gboolean super_l = FALSE;
48 static gboolean hyper_l = FALSE;
50 static gboolean started = FALSE;
52 void obt_keyboard_reload(void)
56 if (started) obt_keyboard_shutdown(); /* free stuff */
59 /* reset the keys to not be bound to any masks */
60 for (i = 0; i < OBT_KEYBOARD_NUM_MODKEYS; ++i)
63 modmap = XGetModifierMapping(obt_display);
64 /* note: modmap->max_keypermod can be 0 when there is no valid key layout
67 XDisplayKeycodes(obt_display, &min_keycode, &max_keycode);
68 keymap = XGetKeyboardMapping(obt_display, min_keycode,
69 max_keycode - min_keycode + 1,
70 &keysyms_per_keycode);
72 alt_l = meta_l = super_l = hyper_l = FALSE;
74 /* go through each of the modifier masks (eg ShiftMask, CapsMask...) */
75 for (i = 0; i < NUM_MASKS; ++i) {
76 /* go through each keycode that is bound to the mask */
77 for (j = 0; j < modmap->max_keypermod; ++j) {
79 /* get a keycode that is bound to the mask (i) */
80 KeyCode keycode = modmap->modifiermap[i*modmap->max_keypermod + j];
82 /* go through each keysym bound to the given keycode */
83 for (k = 0; k < keysyms_per_keycode; ++k) {
84 sym = keymap[(keycode-min_keycode) * keysyms_per_keycode +
86 if (sym != NoSymbol) {
87 /* bind the key to the mask (e.g. Alt_L => Mod1Mask) */
88 set_modkey_mask(nth_mask(i), sym);
95 /* CapsLock, Shift, and Control are special and hard-coded */
96 modkeys_keys[OBT_KEYBOARD_MODKEY_CAPSLOCK] = LockMask;
97 modkeys_keys[OBT_KEYBOARD_MODKEY_SHIFT] = ShiftMask;
98 modkeys_keys[OBT_KEYBOARD_MODKEY_CONTROL] = ControlMask;
101 void obt_keyboard_shutdown(void)
103 XFreeModifiermap(modmap);
110 guint obt_keyboard_keycode_to_modmask(guint keycode)
115 if (keycode == NoSymbol) return 0;
117 /* go through each of the modifier masks (eg ShiftMask, CapsMask...) */
118 for (i = 0; i < NUM_MASKS; ++i) {
119 /* go through each keycode that is bound to the mask */
120 for (j = 0; j < modmap->max_keypermod; ++j) {
121 /* compare with a keycode that is bound to the mask (i) */
122 if (modmap->modifiermap[i*modmap->max_keypermod + j] == keycode)
129 guint obt_keyboard_only_modmasks(guint mask)
132 /* strip off these lock keys. they shouldn't affect key bindings */
133 mask &= ~LockMask; /* use the LockMask, not what capslock is bound to,
134 because you could bind it to something else and it
135 should work as that modifier then. i think capslock
137 mask &= ~obt_keyboard_modkey_to_modmask(OBT_KEYBOARD_MODKEY_NUMLOCK);
138 mask &= ~obt_keyboard_modkey_to_modmask(OBT_KEYBOARD_MODKEY_SCROLLLOCK);
142 guint obt_keyboard_modkey_to_modmask(ObtModkeysKey key)
144 return modkeys_keys[key];
147 static void set_modkey_mask(guchar mask, KeySym sym)
149 /* find what key this is, and bind it to the mask */
151 if (sym == XK_Num_Lock)
152 modkeys_keys[OBT_KEYBOARD_MODKEY_NUMLOCK] |= mask;
153 else if (sym == XK_Scroll_Lock)
154 modkeys_keys[OBT_KEYBOARD_MODKEY_SCROLLLOCK] |= mask;
156 else if (sym == XK_Super_L && super_l)
157 modkeys_keys[OBT_KEYBOARD_MODKEY_SUPER] |= mask;
158 else if (sym == XK_Super_L && !super_l)
159 /* left takes precident over right, so erase any masks the right
161 modkeys_keys[OBT_KEYBOARD_MODKEY_SUPER] = mask, super_l = TRUE;
162 else if (sym == XK_Super_R && !super_l)
163 modkeys_keys[OBT_KEYBOARD_MODKEY_SUPER] |= mask;
165 else if (sym == XK_Hyper_L && hyper_l)
166 modkeys_keys[OBT_KEYBOARD_MODKEY_HYPER] |= mask;
167 else if (sym == XK_Hyper_L && !hyper_l)
168 modkeys_keys[OBT_KEYBOARD_MODKEY_HYPER] = mask, hyper_l = TRUE;
169 else if (sym == XK_Hyper_R && !hyper_l)
170 modkeys_keys[OBT_KEYBOARD_MODKEY_HYPER] |= mask;
172 else if (sym == XK_Alt_L && alt_l)
173 modkeys_keys[OBT_KEYBOARD_MODKEY_ALT] |= mask;
174 else if (sym == XK_Alt_L && !alt_l)
175 modkeys_keys[OBT_KEYBOARD_MODKEY_ALT] = mask, alt_l = TRUE;
176 else if (sym == XK_Alt_R && !alt_l)
177 modkeys_keys[OBT_KEYBOARD_MODKEY_ALT] |= mask;
179 else if (sym == XK_Meta_L && meta_l)
180 modkeys_keys[OBT_KEYBOARD_MODKEY_META] |= mask;
181 else if (sym == XK_Meta_L && !meta_l)
182 modkeys_keys[OBT_KEYBOARD_MODKEY_META] = mask, meta_l = TRUE;
183 else if (sym == XK_Meta_R && !meta_l)
184 modkeys_keys[OBT_KEYBOARD_MODKEY_META] |= mask;
186 /* CapsLock, Shift, and Control are special and hard-coded */
189 KeyCode* obt_keyboard_keysym_to_keycode(KeySym sym)
194 ret = g_new(KeyCode, 1);
198 /* go through each keycode and look for the keysym */
199 for (i = min_keycode; i <= max_keycode; ++i)
200 for (j = 0; j < keysyms_per_keycode; ++j)
201 if (sym == keymap[(i-min_keycode) * keysyms_per_keycode + j]) {
202 ret = g_renew(KeyCode, ret, ++n);
209 gchar *obt_keyboard_keycode_to_string(guint keycode)
213 if ((sym = XKeycodeToKeysym(obt_display, keycode, 0)) != NoSymbol)
214 return g_locale_to_utf8(XKeysymToString(sym), -1, NULL, NULL, NULL);
218 gunichar obt_keyboard_keycode_to_unichar(guint keycode)
223 if ((key = obt_keyboard_keycode_to_string(keycode)) != NULL &&
224 /* don't accept keys that aren't a single letter, like "space" */
227 unikey = g_utf8_get_char_validated(key, -1);
228 if (unikey == (gunichar)-1 || unikey == (gunichar)-2 || unikey == 0)