openbox/keyboard.c

   1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
   2
   3    keyboard.c for the Openbox window manager
   4    Copyright (c) 2003        Ben Jansens
   5
   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.
  10
  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.
  15
  16    See the COPYING file for a copy of the GNU General Public License.
  17 */
  18
  19 #include "mainloop.h"
  20 #include "focus.h"
  21 #include "screen.h"
  22 #include "frame.h"
  23 #include "openbox.h"
  24 #include "event.h"
  25 #include "grab.h"
  26 #include "client.h"
  27 #include "action.h"
  28 #include "prop.h"
  29 #include "config.h"
  30 #include "keytree.h"
  31 #include "keyboard.h"
  32 #include "translate.h"
  33 #include "moveresize.h"
  34
  35 #include <glib.h>
  36
  37 KeyBindingTree *keyboard_firstnode;
  38
  39 typedef struct {
  40     guint state;
  41     ObClient *client;
  42     GSList *actions;
  43     ObFrameContext context;
  44 } ObInteractiveState;
  45
  46 static GSList *interactive_states;
  47
  48 static KeyBindingTree *curpos;
  49
  50 static void grab_for_window(Window win, gboolean grab)
  51 {
  52     KeyBindingTree *p;
  53
  54     ungrab_all_keys(win);
  55
  56     if (grab) {
  57         p = curpos ? curpos->first_child : keyboard_firstnode;
  58         while (p) {
  59             grab_key(p->key, p->state, win, GrabModeAsync);
  60             p = p->next_sibling;
  61         }
  62         if (curpos)
  63             grab_key(config_keyboard_reset_keycode,
  64                      config_keyboard_reset_state,
  65                      win, GrabModeAsync);
  66     }
  67 }
  68
  69 void keyboard_grab_for_client(ObClient *c, gboolean grab)
  70 {
  71     grab_for_window(c->window, grab);
  72 }
  73
  74 static void grab_keys(gboolean grab)
  75 {
  76     GList *it;
  77
  78     grab_for_window(screen_support_win, grab);
  79     for (it = client_list; it; it = g_list_next(it))
  80         grab_for_window(((ObClient*)it->data)->window, grab);
  81 }
  82
  83 static gboolean chain_timeout(gpointer data)
  84 {
  85     keyboard_reset_chains();
  86
  87     return FALSE; /* don't repeat */
  88 }
  89
  90 void keyboard_reset_chains()
  91 {
  92     ob_main_loop_timeout_remove(ob_main_loop, chain_timeout);
  93
  94     if (curpos) {
  95         grab_keys(FALSE);
  96         curpos = NULL;
  97         grab_keys(TRUE);
  98     }
  99 }
 100
 101 void keyboard_unbind_all()
 102 {
 103     tree_destroy(keyboard_firstnode);
 104     keyboard_firstnode = NULL;
 105     grab_keys(FALSE);
 106     curpos = NULL;
 107 }
 108
 109 gboolean keyboard_bind(GList *keylist, ObAction *action)
 110 {
 111     KeyBindingTree *tree, *t;
 112     gboolean conflict;
 113     gboolean mods = TRUE;
 114
 115     g_assert(keylist != NULL);
 116     g_assert(action != NULL);
 117
 118     if (!(tree = tree_build(keylist)))
 119         return FALSE;
 120
 121     if ((t = tree_find(tree, &conflict)) != NULL) {
 122         /* already bound to something, use the existing tree */
 123         tree_destroy(tree);
 124         tree = NULL;
 125     } else
 126         t = tree;
 127
 128     if (conflict) {
 129         g_warning("conflict with binding");
 130         tree_destroy(tree);
 131         return FALSE;
 132     }
 133
 134     /* find if every key in this chain has modifiers, and also find the
 135        bottom node of the tree */
 136     while (t->first_child) {
 137         if (!t->state)
 138             mods = FALSE;
 139         t = t->first_child;
 140     }
 141
 142     /* when there are no modifiers in the binding, then the action cannot
 143        be interactive */
 144     if (!mods && action->data.any.interactive) {
 145         action->data.any.interactive = FALSE;
 146         action->data.inter.final = TRUE;
 147     }
 148
 149     /* set the action */
 150     t->actions = g_slist_append(t->actions, action);
 151     /* assimilate this built tree into the main tree. assimilation
 152        destroys/uses the tree */
 153     if (tree) tree_assimilate(tree);
 154
 155     return TRUE;
 156 }
 157
 158 gboolean keyboard_interactive_grab_in_progress()
 159 {
 160     return interactive_states != NULL;
 161 }
 162
 163 void keyboard_interactive_grab(guint state, ObClient *client,
 164                                ObAction *action)
 165 {
 166     ObInteractiveState *s;
 167
 168     g_assert(action->data.any.interactive);
 169
 170     if (moveresize_in_progress)
 171         moveresize_end(FALSE);
 172
 173     if (!interactive_states) {
 174         if (!grab_keyboard(TRUE))
 175             return;
 176         if (!grab_pointer(TRUE, OB_CURSOR_NONE)) {
 177             grab_keyboard(FALSE);
 178             return;
 179         }
 180     }
 181
 182     s = g_new(ObInteractiveState, 1);
 183
 184     s->state = state;
 185     s->client = client;
 186     s->actions = g_slist_append(NULL, action);
 187
 188     interactive_states = g_slist_append(interactive_states, s);
 189 }
 190
 191 void keyboard_interactive_end(ObInteractiveState *s,
 192                               guint state, gboolean cancel)
 193 {
 194     action_run_interactive(s->actions, s->client, state, cancel, TRUE);
 195
 196     g_slist_free(s->actions);
 197     g_free(s);
 198
 199     interactive_states = g_slist_remove(interactive_states, s);
 200
 201     if (!interactive_states) {
 202         grab_keyboard(FALSE);
 203         grab_pointer(FALSE, OB_CURSOR_NONE);
 204         keyboard_reset_chains();
 205     }
 206 }
 207
 208 void keyboard_interactive_end_client(gpointer data)
 209 {
 210     GSList *it, *next;
 211     ObClient *c = data;
 212
 213     for (it = interactive_states; it; it = next) {
 214         ObInteractiveState *s = it->data;
 215
 216         next = g_slist_next(it);
 217
 218         if (s->client == c)
 219             keyboard_interactive_end(s, 0, FALSE);
 220     }
 221 }
 222
 223 gboolean keyboard_process_interactive_grab(const XEvent *e, ObClient **client)
 224 {
 225     GSList *it, *next;
 226     gboolean handled = FALSE;
 227     gboolean done = FALSE;
 228     gboolean cancel = FALSE;
 229
 230     for (it = interactive_states; it; it = next) {
 231         ObInteractiveState *s = it->data;
 232
 233         next = g_slist_next(it);
 234
 235         if ((e->type == KeyRelease &&
 236              !(s->state & e->xkey.state)))
 237             done = TRUE;
 238         else if (e->type == KeyPress) {
 239             if (e->xkey.keycode == ob_keycode(OB_KEY_RETURN))
 240                 done = TRUE;
 241             else if (e->xkey.keycode == ob_keycode(OB_KEY_ESCAPE))
 242                 cancel = done = TRUE;
 243         }
 244         if (done) {
 245             keyboard_interactive_end(s, e->xkey.state, cancel);
 246
 247             handled = TRUE;
 248         } else
 249             *client = s->client;
 250     }
 251
 252     return handled;
 253 }
 254
 255 void keyboard_event(ObClient *client, const XEvent *e)
 256 {
 257     KeyBindingTree *p;
 258
 259     g_assert(e->type == KeyPress);
 260
 261     if (e->xkey.keycode == config_keyboard_reset_keycode &&
 262         e->xkey.state == config_keyboard_reset_state)
 263     {
 264         keyboard_reset_chains();
 265         return;
 266     }
 267
 268     if (curpos == NULL)
 269         p = keyboard_firstnode;
 270     else
 271         p = curpos->first_child;
 272     while (p) {
 273         if (p->key == e->xkey.keycode &&
 274             p->state == e->xkey.state)
 275         {
 276             if (p->first_child != NULL) { /* part of a chain */
 277                 ob_main_loop_timeout_remove(ob_main_loop, chain_timeout);
 278                 /* 5 second timeout for chains */
 279                 ob_main_loop_timeout_add(ob_main_loop, 5 * G_USEC_PER_SEC,
 280                                          chain_timeout, NULL, NULL);
 281                 grab_keys(FALSE);
 282                 curpos = p;
 283                 grab_keys(TRUE);
 284             } else {
 285
 286                 keyboard_reset_chains();
 287
 288                 action_run_key(p->actions, client, e->xkey.state,
 289                                e->xkey.x_root, e->xkey.y_root);
 290             }
 291             break;
 292         }
 293         p = p->next_sibling;
 294     }
 295 }
 296
 297 void keyboard_startup(gboolean reconfig)
 298 {
 299     grab_keys(TRUE);
 300
 301     if (!reconfig)
 302         client_add_destructor(keyboard_interactive_end_client);
 303 }
 304
 305 void keyboard_shutdown(gboolean reconfig)
 306 {
 307     GSList *it;
 308
 309     if (!reconfig)
 310         client_remove_destructor(keyboard_interactive_end_client);
 311
 312     for (it = interactive_states; it; it = g_slist_next(it))
 313         g_free(it->data);
 314     g_slist_free(interactive_states);
 315     interactive_states = NULL;
 316
 317     ob_main_loop_timeout_remove(ob_main_loop, chain_timeout);
 318
 319     keyboard_unbind_all();
 320 }
 321