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-2007   Dana 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 "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 "actions.h"
  28 #include "menuframe.h"
  29 #include "config.h"
  30 #include "keytree.h"
  31 #include "keyboard.h"
  32 #include "translate.h"
  33 #include "moveresize.h"
  34 #include "popup.h"
  35 #include "gettext.h"
  36 #include "obt/keyboard.h"
  37
  38 #include <glib.h>
  39
  40 KeyBindingTree *keyboard_firstnode = NULL;
  41 static ObPopup *popup = NULL;
  42 static KeyBindingTree *curpos;
  43
  44 static void grab_keys(gboolean grab)
  45 {
  46     KeyBindingTree *p;
  47
  48     ungrab_all_keys(obt_root(ob_screen));
  49
  50     if (grab) {
  51         p = curpos ? curpos->first_child : keyboard_firstnode;
  52         while (p) {
  53             if (p->key)
  54                 grab_key(p->key, p->state, obt_root(ob_screen),
  55                          GrabModeAsync);
  56             p = p->next_sibling;
  57         }
  58         if (curpos)
  59             grab_key(config_keyboard_reset_keycode,
  60                      config_keyboard_reset_state,
  61                      obt_root(ob_screen), GrabModeAsync);
  62     }
  63 }
  64
  65 static gboolean chain_timeout(gpointer data)
  66 {
  67     keyboard_reset_chains(0);
  68     return FALSE; /* don't repeat */
  69 }
  70
  71 static void set_curpos(KeyBindingTree *newpos)
  72 {
  73     if (curpos == newpos) return;
  74
  75     grab_keys(FALSE);
  76     curpos = newpos;
  77     grab_keys(TRUE);
  78
  79     if (curpos != NULL) {
  80         gchar *text = NULL;
  81         GList *it;
  82         Rect *a;
  83
  84         for (it = curpos->keylist; it; it = g_list_next(it)) {
  85             gchar *oldtext = text;
  86             if (text == NULL)
  87                 text = g_strdup(it->data);
  88             else
  89                 text = g_strconcat(text, " - ", it->data, NULL);
  90             g_free(oldtext);
  91         }
  92
  93         a = screen_physical_area_primary(FALSE);
  94         popup_position(popup, NorthWestGravity, a->x + 10, a->y + 10);
  95         /* 1 second delay for the popup to show */
  96         popup_delay_show(popup, G_USEC_PER_SEC, text);
  97         g_free(text);
  98         g_free(a);
  99     } else {
 100         popup_hide(popup);
 101     }
 102 }
 103
 104 void keyboard_reset_chains(gint break_chroots)
 105 {
 106     KeyBindingTree *p;
 107
 108     for (p = curpos; p; p = p->parent) {
 109         if (p->chroot) {
 110             if (break_chroots == 0) break; /* stop here */
 111             if (break_chroots > 0)
 112                 --break_chroots;
 113         }
 114     }
 115     set_curpos(p);
 116 }
 117
 118 void keyboard_unbind_all(void)
 119 {
 120     tree_destroy(keyboard_firstnode);
 121     keyboard_firstnode = NULL;
 122 }
 123
 124 void keyboard_chroot(GList *keylist)
 125 {
 126     /* try do it in the existing tree. if we can't that means it is an empty
 127        chroot binding. so add it to the tree then. */
 128     if (!tree_chroot(keyboard_firstnode, keylist)) {
 129         KeyBindingTree *tree;
 130         if (!(tree = tree_build(keylist)))
 131             return;
 132         tree_chroot(tree, keylist);
 133         tree_assimilate(tree);
 134     }
 135 }
 136
 137 gboolean keyboard_bind(GList *keylist, ObActionsAct *action)
 138 {
 139     KeyBindingTree *tree, *t;
 140     gboolean conflict;
 141
 142     g_assert(keylist != NULL);
 143     g_assert(action != NULL);
 144
 145     if (!(tree = tree_build(keylist)))
 146         return FALSE;
 147
 148     if ((t = tree_find(tree, &conflict)) != NULL) {
 149         /* already bound to something, use the existing tree */
 150         tree_destroy(tree);
 151         tree = NULL;
 152     } else
 153         t = tree;
 154
 155     if (conflict) {
 156         g_message(_("Conflict with key binding in config file"));
 157         tree_destroy(tree);
 158         return FALSE;
 159     }
 160
 161     /* find the bottom node */
 162     for (; t->first_child; t = t->first_child);
 163
 164     /* set the action */
 165     t->actions = g_slist_append(t->actions, action);
 166     /* assimilate this built tree into the main tree. assimilation
 167        destroys/uses the tree */
 168     if (tree) tree_assimilate(tree);
 169
 170     return TRUE;
 171 }
 172
 173 #if 0
 174 gboolean keyboard_process_interactive_grab(const XEvent *e, ObClient **client)
 175 {
 176     gboolean handled = FALSE;
 177     gboolean done = FALSE;
 178     gboolean cancel = FALSE;
 179     guint state;
 180
 181     state = obt_keyboard_only_modmasks(ev->xkey.state);
 182     if (e->type == KeyRelease) {
 183         /* remove from the state the mask of the modifier key being
 184            released, if it is a modifier key being released that is */
 185         state &= ~obt_keyboard_keycode_to_modmask(e->xkey.keycode);
 186     }
 187
 188     if (istate.active) {
 189         if ((e->type == KeyRelease && !(istate.state & state))) {
 190             done = TRUE;
 191             handled = TRUE;
 192         } else if (e->type == KeyPress) {
 193             /*if (e->xkey.keycode == ob_keycode(OB_KEY_RETURN))
 194               done = TRUE;
 195               else */if (e->xkey.keycode == ob_keycode(OB_KEY_ESCAPE)) {
 196                   cancel = done = TRUE;
 197                   handled = TRUE;
 198               }
 199         } else if (e->type == ButtonPress) {
 200             cancel = TRUE;
 201             done = TRUE;
 202             handled = FALSE;
 203         }
 204
 205         if (done)
 206             keyboard_interactive_end(state, cancel, e->xkey.time,TRUE);
 207
 208         if (handled)
 209             *client = istate.client;
 210     }
 211
 212     return handled;
 213 }
 214 #endif
 215
 216 gboolean keyboard_event(ObClient *client, const XEvent *e)
 217 {
 218     KeyBindingTree *p;
 219     gboolean used;
 220     guint state;
 221
 222     if (e->type == KeyRelease) {
 223         grab_key_passive_count(-1);
 224         return FALSE;
 225     }
 226
 227     g_assert(e->type == KeyPress);
 228     grab_key_passive_count(1);
 229
 230     state = obt_keyboard_only_modmasks(e->xkey.state);
 231
 232     if (e->xkey.keycode == config_keyboard_reset_keycode &&
 233         state == config_keyboard_reset_state)
 234     {
 235         obt_main_loop_timeout_remove(ob_main_loop, chain_timeout);
 236         keyboard_reset_chains(-1);
 237         return TRUE;
 238     }
 239
 240     used = FALSE;
 241     if (curpos == NULL)
 242         p = keyboard_firstnode;
 243     else
 244         p = curpos->first_child;
 245     while (p) {
 246         if (p->key == e->xkey.keycode &&
 247             p->state == state)
 248         {
 249             /* if we hit a key binding, then close any open menus and run it */
 250             if (menu_frame_visible)
 251                 menu_frame_hide_all();
 252
 253             if (p->first_child != NULL) { /* part of a chain */
 254                 obt_main_loop_timeout_remove(ob_main_loop, chain_timeout);
 255                 /* 3 second timeout for chains */
 256                 obt_main_loop_timeout_add(ob_main_loop, 3 * G_USEC_PER_SEC,
 257                                           chain_timeout, NULL,
 258                                           g_direct_equal, NULL);
 259                 set_curpos(p);
 260             } else if (p->chroot)         /* an empty chroot */
 261                 set_curpos(p);
 262             else {
 263                 GSList *it;
 264
 265                 for (it = p->actions; it; it = g_slist_next(it))
 266                     if (actions_act_is_interactive(it->data)) break;
 267                 if (it == NULL) /* reset if the actions are not interactive */
 268                     keyboard_reset_chains(0);
 269
 270                 actions_run_acts(p->actions, OB_USER_ACTION_KEYBOARD_KEY,
 271                                  e->xkey.state, e->xkey.x_root, e->xkey.y_root,
 272                                  0, OB_FRAME_CONTEXT_NONE, client);
 273             }
 274             break;
 275             used = TRUE;
 276         }
 277         p = p->next_sibling;
 278     }
 279     return used;
 280 }
 281
 282 static void node_rebind(KeyBindingTree *node)
 283 {
 284     if (node->first_child) {
 285         /* find leaf nodes */
 286         node_rebind(node->first_child);
 287
 288         /* for internal nodes, add them to the tree if they
 289            are a chroot, but do this after adding their
 290            children */
 291         if (node->chroot)
 292             keyboard_chroot(node->keylist);
 293     }
 294     else {
 295         /* for leaf nodes, rebind each action assigned to it */
 296         while (node->actions) {
 297             /* add each action, and remove them from the original tree so
 298                they don't get free'd on us */
 299             keyboard_bind(node->keylist, node->actions->data);
 300             node->actions = g_slist_delete_link(node->actions, node->actions);
 301         }
 302
 303         if (node->chroot)
 304             keyboard_chroot(node->keylist);
 305     }
 306
 307     /* go through each sibling */
 308     if (node->next_sibling) node_rebind(node->next_sibling);
 309 }
 310
 311 void keyboard_rebind(void)
 312 {
 313     KeyBindingTree *old;
 314
 315     old = keyboard_firstnode;
 316     keyboard_firstnode = NULL;
 317     node_rebind(old);
 318
 319     tree_destroy(old);
 320     set_curpos(NULL);
 321     grab_keys(TRUE);
 322 }
 323
 324 void keyboard_startup(gboolean reconfig)
 325 {
 326     grab_keys(TRUE);
 327     popup = popup_new();
 328     popup_set_text_align(popup, RR_JUSTIFY_CENTER);
 329 }
 330
 331 void keyboard_shutdown(gboolean reconfig)
 332 {
 333     obt_main_loop_timeout_remove(ob_main_loop, chain_timeout);
 334
 335     keyboard_unbind_all();
 336     set_curpos(NULL);
 337
 338     popup_free(popup);
 339     popup = NULL;
 340 }