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(guint state, ObClient *client,
 159                                    ObAction *action)
 160 {
 161     ObInteractiveState *s;
 162
 163     g_assert(action->data.any.interactive);
 164
 165     if (!interactive_states) {
 166         if (!grab_keyboard(TRUE))
 167             return FALSE;
 168         if (!grab_pointer(TRUE, OB_CURSOR_NONE)) {
 169             grab_keyboard(FALSE);
 170             return FALSE;
 171         }
 172     }
 173
 174     s = g_new(ObInteractiveState, 1);
 175
 176     s->state = state;
 177     s->client = client;
 178     s->actions = g_slist_append(NULL, action);
 179
 180     interactive_states = g_slist_append(interactive_states, s);
 181
 182     return TRUE;
 183 }
 184
 185 void keyboard_interactive_end(ObInteractiveState *s,
 186                               guint state, gboolean cancel)
 187 {
 188     action_run_interactive(s->actions, s->client, state, cancel, TRUE);
 189
 190     g_slist_free(s->actions);
 191     g_free(s);
 192
 193     interactive_states = g_slist_remove(interactive_states, s);
 194
 195     if (!interactive_states) {
 196         grab_keyboard(FALSE);
 197         grab_pointer(FALSE, OB_CURSOR_NONE);
 198         keyboard_reset_chains();
 199     }
 200 }
 201
 202 void keyboard_interactive_end_client(ObClient *client, gpointer data)
 203 {
 204     GSList *it, *next;
 205
 206     for (it = interactive_states; it; it = next) {
 207         ObInteractiveState *s = it->data;
 208
 209         next = g_slist_next(it);
 210
 211         if (s->client == client)
 212             s->client = NULL;
 213     }
 214 }
 215
 216 gboolean keyboard_process_interactive_grab(const XEvent *e, ObClient **client)
 217 {
 218     GSList *it, *next;
 219     gboolean handled = FALSE;
 220     gboolean done = FALSE;
 221     gboolean cancel = FALSE;
 222
 223     for (it = interactive_states; it; it = next) {
 224         ObInteractiveState *s = it->data;
 225
 226         next = g_slist_next(it);
 227
 228         if ((e->type == KeyRelease &&
 229              !(s->state & e->xkey.state)))
 230             done = TRUE;
 231         else if (e->type == KeyPress) {
 232             if (e->xkey.keycode == ob_keycode(OB_KEY_RETURN))
 233                 done = TRUE;
 234             else if (e->xkey.keycode == ob_keycode(OB_KEY_ESCAPE))
 235                 cancel = done = TRUE;
 236         }
 237         if (done) {
 238             keyboard_interactive_end(s, e->xkey.state, cancel);
 239
 240             handled = TRUE;
 241         } else
 242             *client = s->client;
 243     }
 244
 245     return handled;
 246 }
 247
 248 void keyboard_event(ObClient *client, const XEvent *e)
 249 {
 250     KeyBindingTree *p;
 251
 252     g_assert(e->type == KeyPress);
 253
 254     if (e->xkey.keycode == config_keyboard_reset_keycode &&
 255         e->xkey.state == config_keyboard_reset_state)
 256     {
 257         keyboard_reset_chains();
 258         return;
 259     }
 260
 261     if (curpos == NULL)
 262         p = keyboard_firstnode;
 263     else
 264         p = curpos->first_child;
 265     while (p) {
 266         if (p->key == e->xkey.keycode &&
 267             p->state == e->xkey.state)
 268         {
 269             if (p->first_child != NULL) { /* part of a chain */
 270                 ob_main_loop_timeout_remove(ob_main_loop, chain_timeout);
 271                 /* 5 second timeout for chains */
 272                 ob_main_loop_timeout_add(ob_main_loop, 5 * G_USEC_PER_SEC,
 273                                          chain_timeout, NULL, NULL);
 274                 grab_keys(FALSE);
 275                 curpos = p;
 276                 grab_keys(TRUE);
 277             } else {
 278
 279                 keyboard_reset_chains();
 280
 281                 action_run_key(p->actions, client, e->xkey.state,
 282                                e->xkey.x_root, e->xkey.y_root);
 283             }
 284             break;
 285         }
 286         p = p->next_sibling;
 287     }
 288 }
 289
 290 void keyboard_startup(gboolean reconfig)
 291 {
 292     grab_keys(TRUE);
 293
 294     if (!reconfig)
 295         client_add_destructor(keyboard_interactive_end_client, NULL);
 296 }
 297
 298 void keyboard_shutdown(gboolean reconfig)
 299 {
 300     GSList *it;
 301
 302     if (!reconfig)
 303         client_remove_destructor(keyboard_interactive_end_client);
 304
 305     for (it = interactive_states; it; it = g_slist_next(it))
 306         g_free(it->data);
 307     g_slist_free(interactive_states);
 308     interactive_states = NULL;
 309
 310     ob_main_loop_timeout_remove(ob_main_loop, chain_timeout);
 311
 312     keyboard_unbind_all();
 313 }
 314