2 * key.c - Key bindings configuration management
4 * Copyright © 2008 Julien Danjou <julien@danjou.info>
5 * Copyright © 2008 Pierre Habouzit <madcoder@debian.org>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 /* XStringToKeysym() */
27 #include "common/xutil.h"
29 LUA_OBJECT_FUNCS(keyb_t
, key
, "key")
32 key_unref_simplified(keyb_t
**b
)
34 key_unref(globalconf
.L
, *b
);
37 ARRAY_FUNCS(keyb_t
*, key
, key_unref_simplified
)
38 DO_LUA_TOSTRING(keyb_t
, key
, "key")
40 /** Garbage collect a key.
41 * \param L The Lua VM state.
45 luaA_key_gc(lua_State
*L
)
47 keyb_t
*kbp
= luaL_checkudata(L
, 1, "key");
48 luaL_unref(globalconf
.L
, LUA_REGISTRYINDEX
, kbp
->press
);
49 luaL_unref(globalconf
.L
, LUA_REGISTRYINDEX
, kbp
->release
);
54 keybindings_init(keybindings_t
*kb
)
56 key_array_init(&kb
->by_code
);
57 key_array_init(&kb
->by_sym
);
61 keybindings_wipe(keybindings_t
*kb
)
63 key_array_wipe(&kb
->by_code
);
64 key_array_wipe(&kb
->by_sym
);
68 key_ev_cmp(xcb_keysym_t keysym
, xcb_keycode_t keycode
,
69 unsigned long mod
, const keyb_t
*k
)
72 if(k
->keysym
!= keysym
)
73 return k
->keysym
> keysym
? 1 : -1;
76 if(k
->keycode
!= keycode
)
77 return k
->keycode
> keycode
? 1 : -1;
79 return ((k
->mod
== mod
|| k
->mod
== XCB_BUTTON_MASK_ANY
) ?
80 0 : (k
->mod
> mod
? 1 : -1));
84 key_cmp(const keyb_t
*k1
, const keyb_t
*k2
)
86 assert ((k1
->keysym
&& k2
->keysym
) || (k1
->keycode
&& k2
->keycode
));
87 assert ((!k1
->keysym
&& !k2
->keysym
) || (!k1
->keycode
&& !k2
->keycode
));
89 if(k1
->keysym
!= k2
->keysym
)
90 return k2
->keysym
> k1
->keysym
? 1 : -1;
91 if(k1
->keycode
!= k2
->keycode
)
92 return k2
->keycode
> k1
->keycode
? 1 : -1;
93 return k1
->mod
== k2
->mod
? 0 : (k2
->mod
> k1
->mod
? 1 : -1);
96 /** Grab key on a window.
97 * \param win The window.
101 window_grabkey(xcb_window_t win
, keyb_t
*k
)
104 xcb_grab_key(globalconf
.connection
, true, win
,
105 k
->mod
, k
->keycode
, XCB_GRAB_MODE_ASYNC
, XCB_GRAB_MODE_ASYNC
);
108 xcb_keycode_t
*keycodes
= xcb_key_symbols_get_keycode(globalconf
.keysyms
, k
->keysym
);
111 for(xcb_keycode_t
*kc
= keycodes
; *kc
; kc
++)
112 xcb_grab_key(globalconf
.connection
, true, win
,
113 k
->mod
, *kc
, XCB_GRAB_MODE_ASYNC
, XCB_GRAB_MODE_ASYNC
);
120 window_grabkeys(xcb_window_t win
, keybindings_t
*keys
)
122 for(int i
= 0; i
< keys
->by_code
.len
; i
++)
123 window_grabkey(win
, keys
->by_code
.tab
[i
]);
125 for(int i
= 0; i
< keys
->by_sym
.len
; i
++)
126 window_grabkey(win
, keys
->by_sym
.tab
[i
]);
129 /** Register a key which on top of the stack.
130 * \param keys The keybinding array where to put the key.
133 key_register(keybindings_t
*keys
)
135 keyb_t
*k
= key_ref(globalconf
.L
);
136 key_array_t
*arr
= k
->keysym
? &keys
->by_sym
: &keys
->by_code
;
137 int l
= 0, r
= arr
->len
;
141 switch(key_cmp(k
, arr
->tab
[i
]))
143 case -1: /* k < arr->tab[i] */
146 case 0: /* k == arr->tab[i] */
147 key_unref(globalconf
.L
, arr
->tab
[i
]);
150 case 1: /* k > arr->tab[i] */
156 key_array_splice(arr
, r
, 0, &k
, 1);
159 /** Return the keysym from keycode.
160 * \param detail The keycode received.
161 * \param state The modifier state.
165 key_getkeysym(xcb_keycode_t detail
, uint16_t state
)
169 /* 'col' (third parameter) is used to get the proper KeySym
170 * according to modifier (XCB doesn't provide an equivalent to
173 * If Mod5 is ON we look into second group.
175 if(state
& XCB_MOD_MASK_5
)
177 k0
= xcb_key_symbols_get_keysym(globalconf
.keysyms
, detail
, 2);
178 k1
= xcb_key_symbols_get_keysym(globalconf
.keysyms
, detail
, 3);
182 k0
= xcb_key_symbols_get_keysym(globalconf
.keysyms
, detail
, 0);
183 k1
= xcb_key_symbols_get_keysym(globalconf
.keysyms
, detail
, 1);
186 /* If the second column does not exists use the first one. */
190 /* The numlock modifier is on and the second KeySym is a keypad
192 if((state
& XCB_MOD_MASK_2
) && xcb_is_keypad_key(k1
))
194 /* The Shift modifier is on, or if the Lock modifier is on and
195 * is interpreted as ShiftLock, use the first KeySym */
196 if((state
& XCB_MOD_MASK_SHIFT
) || (state
& XCB_MOD_MASK_LOCK
))
202 /* The Shift and Lock modifers are both off, use the first
204 else if(!(state
& XCB_MOD_MASK_SHIFT
) && !(state
& XCB_MOD_MASK_LOCK
))
207 /* The Shift modifier is off and the Lock modifier is on and is
208 * interpreted as CapsLock */
209 else if(!(state
& XCB_MOD_MASK_SHIFT
) && (state
& XCB_MOD_MASK_LOCK
))
210 /* The first Keysym is used but if that KeySym is lowercase
211 * alphabetic, then the corresponding uppercase KeySym is used
215 /* The Shift modifier is on, and the Lock modifier is on and is
216 * interpreted as CapsLock */
217 else if((state
& XCB_MOD_MASK_SHIFT
) && (state
& XCB_MOD_MASK_LOCK
))
218 /* The second Keysym is used but if that KeySym is lowercase
219 * alphabetic, then the corresponding uppercase KeySym is used
223 /* The Shift modifer is on, or the Lock modifier is on and is
224 * interpreted as ShiftLock, or both */
225 else if((state
& XCB_MOD_MASK_SHIFT
) || (state
& XCB_MOD_MASK_LOCK
))
228 return XCB_NO_SYMBOL
;
233 key_find(keybindings_t
*keys
, const xcb_key_press_event_t
*ev
)
235 const key_array_t
*arr
= &keys
->by_sym
;
239 /* get keysym ignoring shift and mod5 */
240 keysym
= key_getkeysym(ev
->detail
, ev
->state
& ~(XCB_MOD_MASK_SHIFT
| XCB_MOD_MASK_5
| XCB_MOD_MASK_LOCK
));
248 switch(key_ev_cmp(keysym
, ev
->detail
, ev
->state
, arr
->tab
[i
]))
250 case -1: /* ev < arr->tab[i] */
253 case 0: /* ev == arr->tab[i] */
255 case 1: /* ev > arr->tab[i] */
260 if(arr
!= &keys
->by_code
)
262 arr
= &keys
->by_code
;
269 luaA_keystore(keyb_t
*key
, const char *str
, ssize_t len
)
275 key
->keysym
= XStringToKeysym(str
);
281 warn("there's no keysym named \"%s\"", str
);
285 key
->keycode
= atoi(str
+ 1);
289 /** Define a global key binding. This key binding will always be available.
290 * \param L The Lua VM state.
293 * \lparam A table with modifier keys: can be Control or Ctrl, Shift, Lock,
294 * Mod1, Mod2, Mod3, Mod4, Mod5 or Any.
295 * \lparam A key name.
296 * \lparam A function to execute on key press.
297 * \lparam A function to execute on key release.
301 luaA_key_new(lua_State
*L
)
306 luaA_ref press
= LUA_REFNIL
, release
= LUA_REFNIL
;
308 /* arg 2 is key mod table */
309 luaA_checktable(L
, 2);
311 key
= luaL_checklstring(L
, 3, &len
);
314 luaA_registerfct(L
, 4, &press
);
316 if(lua_gettop(L
) == 5 && !lua_isnil(L
, 5))
317 luaA_registerfct(L
, 5, &release
);
320 luaA_keystore(k
, key
, len
);
323 k
->release
= release
;
325 len
= lua_objlen(L
, 2);
326 for(i
= 1; i
<= len
; i
++)
329 lua_rawgeti(L
, 2, i
);
330 key
= luaL_checklstring(L
, -1, &blen
);
332 k
->mod
|= xutil_key_mask_fromstr(key
, blen
);
338 /** Set a key array with a Lua table.
339 * \param L The Lua VM state.
340 * \param idx The index of the Lua table.
341 * \param keys The array key to fill.
344 luaA_key_array_set(lua_State
*L
, int idx
, keybindings_t
*keys
)
346 luaA_checktable(L
, idx
);
348 keybindings_wipe(keys
);
349 keybindings_init(keys
);
352 while(lua_next(L
, idx
))
356 /** Push an array of key as an Lua table onto the stack.
357 * \param L The Lua VM state.
358 * \param keys The key array to push.
359 * \return The number of elements pushed on stack.
362 luaA_key_array_get(lua_State
*L
, keybindings_t
*keys
)
364 lua_createtable(L
, keys
->by_code
.len
+ keys
->by_sym
.len
, 0);
365 for(int i
= 0; i
< keys
->by_code
.len
; i
++)
367 key_push(L
, keys
->by_code
.tab
[i
]);
368 lua_rawseti(L
, -2, i
+ 1);
370 for(int i
= 0; i
< keys
->by_sym
.len
; i
++)
372 key_push(L
, keys
->by_sym
.tab
[i
]);
373 lua_rawseti(L
, -2, i
+ 1);
378 const struct luaL_reg awesome_key_methods
[] =
380 { "__call", luaA_key_new
},
383 const struct luaL_reg awesome_key_meta
[] =
385 { "__tostring", luaA_key_tostring
},
386 { "__gc", luaA_key_gc
},