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