+/* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
+
+ keyboard.c for the Openbox window manager
+ Copyright (c) 2006 Mikael Magnusson
+ Copyright (c) 2003-2007 Dana Jansens
+
+ 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.
+
+ See the COPYING file for a copy of the GNU General Public License.
+*/
+
+#include "mainloop.h"
#include "focus.h"
+#include "screen.h"
+#include "frame.h"
#include "openbox.h"
+#include "event.h"
+#include "grab.h"
+#include "client.h"
+#include "action.h"
+#include "prop.h"
+#include "menuframe.h"
+#include "config.h"
+#include "keytree.h"
#include "keyboard.h"
-#include "clientwrap.h"
+#include "translate.h"
+#include "moveresize.h"
+#include "popup.h"
+#include "gettext.h"
-#include <Python.h>
#include <glib.h>
-#ifdef HAVE_STRING_H
-# include <string.h>
-#endif
-typedef struct KeyBindingTree {
+typedef struct {
+ gboolean active;
guint state;
- guint key;
- GList *keylist;
- PyObject *func;
-
- /* the next binding in the tree at the same level */
- struct KeyBindingTree *next_sibling;
- /* the first child of this binding (next binding in a chained sequence).*/
- struct KeyBindingTree *first_child;
-} KeyBindingTree;
-
+ ObClient *client;
+ ObAction *action;
+} ObInteractiveState;
-static KeyBindingTree *firstnode, *curpos;
-static guint reset_key, reset_state;
-static gboolean grabbed, user_grabbed;
-static PyObject *grab_func;
+KeyBindingTree *keyboard_firstnode = NULL;
+static ObPopup *popup = NULL;
+static ObInteractiveState istate;
+static KeyBindingTree *curpos;
-/***************************************************************************
-
- Define the type 'KeyboardData'
-
- ***************************************************************************/
+static void grab_keys(gboolean grab)
+{
+ KeyBindingTree *p;
+
+ ungrab_all_keys(RootWindow(ob_display, ob_screen));
+
+ if (grab) {
+ p = curpos ? curpos->first_child : keyboard_firstnode;
+ while (p) {
+ grab_key(p->key, p->state, RootWindow(ob_display, ob_screen),
+ GrabModeAsync);
+ p = p->next_sibling;
+ }
+ if (curpos)
+ grab_key(config_keyboard_reset_keycode,
+ config_keyboard_reset_state,
+ RootWindow(ob_display, ob_screen), GrabModeAsync);
+ }
+}
-typedef struct KeyboardData {
- PyObject_HEAD
- PyObject *keychain;
- guint state;
- guint keycode;
- gboolean press;
-} KeyboardData;
+static gboolean chain_timeout(gpointer data)
+{
+ keyboard_reset_chains(0);
+ return FALSE; /* don't repeat */
+}
-staticforward PyTypeObject KeyboardDataType;
+static void set_curpos(KeyBindingTree *newpos)
+{
+ if (curpos == newpos) return;
-/***************************************************************************
-
- Type methods/struct
-
- ***************************************************************************/
+ grab_keys(FALSE);
+ curpos = newpos;
+ grab_keys(TRUE);
+
+ if (curpos != NULL) {
+ gchar *text = NULL;
+ GList *it;
+
+ for (it = curpos->keylist; it; it = g_list_next(it)) {
+ gchar *oldtext = text;
+ if (text == NULL)
+ text = g_strdup(it->data);
+ else
+ text = g_strconcat(text, " - ", it->data, NULL);
+ g_free(oldtext);
+ }
+
+ popup_position(popup, NorthWestGravity, 10, 10);
+ /* 1 second delay for the popup to show */
+ popup_delay_show(popup, G_USEC_PER_SEC, text);
+ g_free(text);
+ } else {
+ popup_hide(popup);
+ }
+}
-static PyObject *keybdata_new(PyObject *keychain, guint state,
- guint keycode, gboolean press)
+void keyboard_reset_chains(gint break_chroots)
{
- KeyboardData *data = PyObject_New(KeyboardData, &KeyboardDataType);
- data->keychain = keychain;
- Py_INCREF(keychain);
- data->state = state;
- data->keycode = keycode;
- data->press = press;
- return (PyObject*) data;
+ KeyBindingTree *p;
+
+ for (p = curpos; p; p = p->parent) {
+ if (p->chroot) {
+ if (break_chroots == 0) break; /* stop here */
+ if (break_chroots > 0)
+ --break_chroots;
+ }
+ }
+ set_curpos(p);
}
-static void keybdata_dealloc(KeyboardData *self)
+void keyboard_unbind_all()
{
- Py_DECREF(self->keychain);
- PyObject_Del((PyObject*)self);
+ tree_destroy(keyboard_firstnode);
+ keyboard_firstnode = NULL;
}
-static PyObject *keybdata_getattr(KeyboardData *self, char *name)
+void keyboard_chroot(GList *keylist)
{
- if (!strcmp(name, "keychain")) {
- Py_INCREF(self->keychain);
- return self->keychain;
- } else if (!strcmp(name, "state"))
- return PyInt_FromLong(self->state);
- else if (!strcmp(name, "keycode"))
- return PyInt_FromLong(self->keycode);
- else if (!strcmp(name, "press"))
- return PyInt_FromLong(!!self->press);
-
- PyErr_Format(PyExc_AttributeError, "no such attribute '%s'", name);
- return NULL;
+ /* try do it in the existing tree. if we can't that means it is an empty
+ chroot binding. so add it to the tree then. */
+ if (!tree_chroot(keyboard_firstnode, keylist)) {
+ KeyBindingTree *tree;
+ if (!(tree = tree_build(keylist)))
+ return;
+ tree_chroot(tree, keylist);
+ tree_assimilate(tree);
+ }
}
-static PyTypeObject KeyboardDataType = {
- PyObject_HEAD_INIT(NULL)
- 0,
- "KeyboardData",
- sizeof(KeyboardData),
- 0,
- (destructor) keybdata_dealloc, /*tp_dealloc*/
- 0, /*tp_print*/
- (getattrfunc) keybdata_getattr, /*tp_getattr*/
- 0, /*tp_setattr*/
- 0, /*tp_compare*/
- 0, /*tp_repr*/
- 0, /*tp_as_number*/
- 0, /*tp_as_sequence*/
- 0, /*tp_as_mapping*/
- 0, /*tp_hash */
-};
-
-/***************************************************************************/
-
-
-
-static gboolean grab_keyboard(gboolean grab)
+gboolean keyboard_bind(GList *keylist, ObAction *action)
{
- gboolean ret = TRUE;
-
- g_message("grab_keyboard(%s). grabbed: %d", (grab?"True":"False"),grabbed);
+ KeyBindingTree *tree, *t;
+ gboolean conflict;
+ gboolean mods = TRUE;
+
+ g_assert(keylist != NULL);
+ g_assert(action != NULL);
+
+ if (!(tree = tree_build(keylist)))
+ return FALSE;
+
+ if ((t = tree_find(tree, &conflict)) != NULL) {
+ /* already bound to something, use the existing tree */
+ tree_destroy(tree);
+ tree = NULL;
+ } else
+ t = tree;
+
+ if (conflict) {
+ g_message(_("Conflict with key binding in config file"));
+ tree_destroy(tree);
+ return FALSE;
+ }
- user_grabbed = grab;
- if (!grabbed) {
- if (grab)
- ret = XGrabKeyboard(ob_display, ob_root, 0, GrabModeAsync,
- GrabModeAsync, CurrentTime) == GrabSuccess;
- else
- XUngrabKeyboard(ob_display, CurrentTime);
+ /* find if every key in this chain has modifiers, and also find the
+ bottom node of the tree */
+ while (t->first_child) {
+ if (!t->state)
+ mods = FALSE;
+ t = t->first_child;
}
- return ret;
-}
-/***************************************************************************
-
- Define the type 'Keyboard'
+ /* when there are no modifiers in the binding, then the action cannot
+ be interactive */
+ if (!mods && action->data.any.interactive) {
+ action->data.any.interactive = FALSE;
+ action->data.inter.final = TRUE;
+ }
- ***************************************************************************/
+ /* set the action */
+ t->actions = g_slist_append(t->actions, action);
+ /* assimilate this built tree into the main tree. assimilation
+ destroys/uses the tree */
+ if (tree) tree_assimilate(tree);
-#define IS_KEYBOARD(v) ((v)->ob_type == &KeyboardType)
-#define CHECK_KEYBOARD(self, funcname) { \
- if (!IS_KEYBOARD(self)) { \
- PyErr_SetString(PyExc_TypeError, \
- "descriptor '" funcname "' requires a 'Keyboard' " \
- "object"); \
- return NULL; \
- } \
+ return TRUE;
}
-typedef struct Keyboard {
- PyObject_HEAD
-} Keyboard;
+static void keyboard_interactive_end(guint state, gboolean cancel, Time time,
+ gboolean ungrab)
+{
+ GSList *alist;
-staticforward PyTypeObject KeyboardType;
+ g_assert(istate.active);
+ /* ungrab first so they won't be NotifyWhileGrabbed */
+ if (ungrab)
+ ungrab_keyboard();
-static PyObject *keyb_clearBinds(Keyboard *self, PyObject *args)
+ /* set this before running the actions so they know the keyboard is not
+ grabbed */
+ istate.active = FALSE;
+
+ alist = g_slist_append(NULL, istate.action);
+ action_run_interactive(alist, istate.client, state, time, cancel, TRUE);
+ g_slist_free(alist);
+}
+
+static void keyboard_interactive_end_client(ObClient *client, gpointer data)
{
- CHECK_KEYBOARD(self, "clearBinds");
- if (!PyArg_ParseTuple(args, ":clearBinds"))
- return NULL;
- clearall();
- Py_INCREF(Py_None);
- return Py_None;
+ if (istate.active && istate.client == client)
+ istate.client = NULL;
}
-static PyObject *keyb_grab(Keyboard *self, PyObject *args)
+
+void keyboard_interactive_cancel()
{
- PyObject *func;
-
- CHECK_KEYBOARD(self, "grab");
- if (!PyArg_ParseTuple(args, "O:grab", &func))
- return NULL;
- if (!PyCallable_Check(func)) {
- PyErr_SetString(PyExc_ValueError, "expected a callable object");
- return NULL;
- }
- if (!grab_keyboard(TRUE)) {
- PyErr_SetString(PyExc_RuntimeError, "failed to grab keyboard");
- return NULL;
- }
- grab_func = func;
- Py_INCREF(grab_func);
- Py_INCREF(Py_None);
- return Py_None;
+ keyboard_interactive_end(0, TRUE, event_curtime, TRUE);
}
-static PyObject *keyb_ungrab(Keyboard *self, PyObject *args)
+gboolean keyboard_interactive_grab(guint state, ObClient *client,
+ ObAction *action)
{
- CHECK_KEYBOARD(self, "ungrab");
- if (!PyArg_ParseTuple(args, ":ungrab"))
- return NULL;
- grab_keyboard(FALSE);
- Py_XDECREF(grab_func);
- grab_func = NULL;
- Py_INCREF(Py_None);
- return Py_None;
+ g_assert(action->data.any.interactive);
+
+ if (!istate.active) {
+ if (!grab_keyboard())
+ return FALSE;
+ } else if (action->func != istate.action->func) {
+ keyboard_interactive_end(state, TRUE, action->data.any.time, FALSE);
+ }
+
+ istate.active = TRUE;
+ istate.state = state;
+ istate.client = client;
+ istate.action = action;
+
+ return TRUE;
}
-#define METH(n, d) {#n, (PyCFunction)keyb_##n, METH_VARARGS, #d}
-
-static PyMethodDef KeyboardMethods[] = {
- METH(bind,
- "bind(keychain, func)\n\n"
- "Binds a key-chain to a function. The keychain is a tuple of strings "
- "which define a chain of key presses. Each member of the tuple has "
- "the format [Modifier-]...[Key]. Modifiers can be 'mod1', 'mod2', "
- "'mod3', 'mod4', 'mod5', 'control', and 'shift'. The keys on your "
- "keyboard that are bound to each of these modifiers can be found by "
- "running 'xmodmap'. The Key can be any valid key definition. Key "
- "definitions can be found by running 'xev', pressing the key while "
- "its window is focused, and watching its output. Here are some "
- "examples of valid keychains: ('a'), ('F7'), ('control-a', 'd'), "
- "('control-mod1-x', 'control-mod4-g'), ('F1', 'space'). The func "
- "must have a definition similar to 'def func(keydata, client)'. A "
- "keychain cannot be bound to more than one function."),
- METH(clearBinds,
- "clearBinds()\n\n"
- "Removes all bindings that were previously made by bind()."),
- METH(grab,
- "grab(func)\n\n"
- "Grabs the entire keyboard, causing all possible keyboard events to "
- "be passed to the given function. CAUTION: Be sure when you grab() "
- "that you also have an ungrab() that will execute, or you will not "
- "be able to type until you restart Openbox. The func must have a "
- "definition similar to 'def func(keydata)'. The keyboard cannot be "
- "grabbed if it is already grabbed."),
- METH(ungrab,
- "ungrab()\n\n"
- "Ungrabs the keyboard. The keyboard cannot be ungrabbed if it is not "
- "grabbed."),
- { NULL, NULL, 0, NULL }
-};
-
-/***************************************************************************
-
- Type methods/struct
-
- ***************************************************************************/
-
-static void keyb_dealloc(PyObject *self)
+gboolean keyboard_process_interactive_grab(const XEvent *e, ObClient **client)
{
- PyObject_Del(self);
+ gboolean handled = FALSE;
+ gboolean done = FALSE;
+ gboolean cancel = FALSE;
+
+ if (istate.active) {
+ if ((e->type == KeyRelease && !(istate.state & e->xkey.state))) {
+ done = TRUE;
+ handled = TRUE;
+ } else if (e->type == KeyPress) {
+ /*if (e->xkey.keycode == ob_keycode(OB_KEY_RETURN))
+ done = TRUE;
+ else */if (e->xkey.keycode == ob_keycode(OB_KEY_ESCAPE)) {
+ cancel = done = TRUE;
+ handled = TRUE;
+ }
+ } else if (e->type == ButtonPress) {
+ cancel = TRUE;
+ done = TRUE;
+ handled = FALSE;
+ }
+
+ if (done)
+ keyboard_interactive_end(e->xkey.state, cancel, e->xkey.time,TRUE);
+
+ if (handled)
+ *client = istate.client;
+ }
+
+ return handled;
}
-static PyTypeObject KeyboardType = {
- PyObject_HEAD_INIT(NULL)
- 0,
- "Keyboard",
- sizeof(Keyboard),
- 0,
- (destructor) keyb_dealloc, /*tp_dealloc*/
- 0, /*tp_print*/
- 0, /*tp_getattr*/
- 0, /*tp_setattr*/
- 0, /*tp_compare*/
- 0, /*tp_repr*/
- 0, /*tp_as_number*/
- 0, /*tp_as_sequence*/
- 0, /*tp_as_mapping*/
- 0, /*tp_hash */
-};
-
-/**************************************************************************/
-
-void keyboard_startup()
+void keyboard_event(ObClient *client, const XEvent *e)
{
- PyObject *input, *inputdict, *ptr;
- gboolean b;
+ KeyBindingTree *p;
- curpos = firstnode = NULL;
- grabbed = user_grabbed = FALSE;
+ g_assert(e->type == KeyPress);
- b = translate("C-G", &reset_state, &reset_key);
- g_assert(b);
+ if (e->xkey.keycode == config_keyboard_reset_keycode &&
+ e->xkey.state == config_keyboard_reset_state)
+ {
+ ob_main_loop_timeout_remove(ob_main_loop, chain_timeout);
+ keyboard_reset_chains(-1);
+ return;
+ }
- KeyboardType.ob_type = &PyType_Type;
- KeyboardType.tp_methods = KeyboardMethods;
- PyType_Ready(&KeyboardType);
- PyType_Ready(&KeyboardDataType);
+ if (curpos == NULL)
+ p = keyboard_firstnode;
+ else
+ p = curpos->first_child;
+ while (p) {
+ if (p->key == e->xkey.keycode &&
+ p->state == e->xkey.state)
+ {
+ /* if we hit a key binding, then close any open menus and run it */
+ if (menu_frame_visible)
+ menu_frame_hide_all();
+
+ if (p->first_child != NULL) { /* part of a chain */
+ ob_main_loop_timeout_remove(ob_main_loop, chain_timeout);
+ /* 3 second timeout for chains */
+ ob_main_loop_timeout_add(ob_main_loop, 3 * G_USEC_PER_SEC,
+ chain_timeout, NULL,
+ g_direct_equal, NULL);
+ set_curpos(p);
+ } else if (p->chroot) /* an empty chroot */
+ set_curpos(p);
+ else {
+ keyboard_reset_chains(0);
+
+ action_run_key(p->actions, client, e->xkey.state,
+ e->xkey.x_root, e->xkey.y_root,
+ e->xkey.time);
+ }
+ break;
+ }
+ p = p->next_sibling;
+ }
+}
- /* get the input module/dict */
- input = PyImport_ImportModule("input"); /* new */
- g_assert(input != NULL);
- inputdict = PyModule_GetDict(input); /* borrowed */
- g_assert(inputdict != NULL);
+gboolean keyboard_interactively_grabbed()
+{
+ return istate.active;
+}
- /* add a Keyboard instance to the input module */
- ptr = (PyObject*) PyObject_New(Keyboard, &KeyboardType);
- PyDict_SetItemString(inputdict, "Keyboard", ptr);
- Py_DECREF(ptr);
+void keyboard_startup(gboolean reconfig)
+{
+ grab_keys(TRUE);
+ popup = popup_new(FALSE);
- Py_DECREF(input);
+ if (!reconfig)
+ client_add_destroy_notify(keyboard_interactive_end_client, NULL);
}
-void keyboard_shutdown()
+void keyboard_shutdown(gboolean reconfig)
{
- if (grabbed || user_grabbed) {
- grabbed = FALSE;
- grab_keyboard(FALSE);
- }
- grab_keys(FALSE);
- destroytree(firstnode);
- firstnode = NULL;
+ if (!reconfig)
+ client_remove_destroy_notify(keyboard_interactive_end_client);
+
+ if (istate.active)
+ keyboard_interactive_cancel();
+
+ ob_main_loop_timeout_remove(ob_main_loop, chain_timeout);
+
+ keyboard_unbind_all();
+ set_curpos(NULL);
+
+ popup_free(popup);
+ popup = NULL;
}
projects / chaz / openbox / blobdiff