test for borders on static grav windows
[mikachu/openbox.git] / src / bindings.cc
1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
2
3 #ifdef HAVE_CONFIG_H
4 # include "../config.h"
5 #endif
6
7 #include "bindings.hh"
8 #include "screen.hh"
9 #include "openbox.hh"
10 #include "client.hh"
11 #include "frame.hh"
12 #include "python.hh"
13 #include "otk/display.hh"
14
15 extern "C" {
16 #include <X11/Xlib.h>
17
18 #include "gettext.h"
19 #define _(str) gettext(str)
20 }
21
22 namespace ob {
23
24 static bool buttonvalue(const std::string &button, unsigned int *val)
25 {
26   if (button == "Left" || button == "1" || button == "Button1") {
27     *val |= Button1;
28   } else if (button == "Middle" || button == "2" || button == "Button2") {
29     *val |= Button2;
30   } else if (button == "Right" || button == "3" || button == "Button3") {
31     *val |= Button3;
32   } else if (button == "Up" || button == "4" || button == "Button4") {
33     *val |= Button4;
34   } else if (button == "Down" || button == "5" || button == "Button5") {
35     *val |= Button5;
36   } else
37     return false;
38   return true;
39 }
40
41 static bool modvalue(const std::string &mod, unsigned int *val)
42 {
43   if (mod == "C") {           // control
44     *val |= ControlMask;
45   } else if (mod == "S") {    // shift
46     *val |= ShiftMask;
47   } else if (mod == "A" ||    // alt/mod1
48              mod == "M" ||
49              mod == "Mod1" ||
50              mod == "M1") {
51     *val |= Mod1Mask;
52   } else if (mod == "Mod2" ||   // mod2
53              mod == "M2") {
54     *val |= Mod2Mask;
55   } else if (mod == "Mod3" ||   // mod3
56              mod == "M3") {
57     *val |= Mod3Mask;
58   } else if (mod == "W" ||    // windows/mod4
59              mod == "Mod4" ||
60              mod == "M4") {
61     *val |= Mod4Mask;
62   } else if (mod == "Mod5" ||   // mod5
63              mod == "M5") {
64     *val |= Mod5Mask;
65   } else {                    // invalid
66     return false;
67   }
68   return true;
69 }
70
71 bool Bindings::translate(const std::string &str, Binding &b,bool askey) const
72 {
73   // parse out the base key name
74   std::string::size_type keybegin = str.find_last_of('-');
75   keybegin = (keybegin == std::string::npos) ? 0 : keybegin + 1;
76   std::string key(str, keybegin);
77
78   // parse out the requested modifier keys
79   unsigned int modval = 0;
80   std::string::size_type begin = 0, end;
81   while (begin != keybegin) {
82     end = str.find_first_of('-', begin);
83
84     std::string mod(str, begin, end-begin);
85     if (!modvalue(mod, &modval)) {
86       printf(_("Invalid modifier element in key binding: %s\n"), mod.c_str());
87       return false;
88     }
89     
90     begin = end + 1;
91   }
92
93   // set the binding
94   b.modifiers = modval;
95   if (askey) {
96     KeySym sym = XStringToKeysym(const_cast<char *>(key.c_str()));
97     if (sym == NoSymbol) {
98       printf(_("Invalid Key name in key binding: %s\n"), key.c_str());
99       return false;
100     }
101     if (!(b.key = XKeysymToKeycode(**otk::display, sym)))
102       printf(_("No valid keycode for Key in key binding: %s\n"), key.c_str());
103     return b.key != 0;
104   } else {
105     return buttonvalue(key, &b.key);
106   }
107 }
108
109 static void destroytree(KeyBindingTree *tree)
110 {
111   while (tree) {
112     KeyBindingTree *c = tree->first_child;
113     delete tree;
114     tree = c;
115   }
116 }
117
118 KeyBindingTree *Bindings::buildtree(const StringVect &keylist,
119                                       PyObject *callback) const
120 {
121   if (keylist.empty()) return 0; // nothing in the list.. return 0
122
123   KeyBindingTree *ret = 0, *p;
124
125   StringVect::const_reverse_iterator it, end = keylist.rend();
126   for (it = keylist.rbegin(); it != end; ++it) {
127     p = ret;
128     ret = new KeyBindingTree();
129     if (!p) {
130       // this is the first built node, the bottom node of the tree
131       ret->chain = false;
132       ret->callbacks.push_back(callback);
133     }
134     ret->first_child = p;
135     if (!translate(*it, ret->binding)) {
136       destroytree(ret);
137       ret = 0;
138       break;
139     }
140   }
141   return ret;
142 }
143
144
145 Bindings::Bindings()
146   : _curpos(&_keytree),
147     _resetkey(0,0),
148     _timer((otk::Timer *) 0)
149 {
150 //  setResetKey("C-g"); // set the default reset key
151 }
152
153
154 Bindings::~Bindings()
155 {
156   if (_timer)
157     delete _timer;
158
159   grabKeys(false);
160   removeAllKeys();
161 //  removeAllButtons(); XXX
162   removeAllEvents();
163 }
164
165
166 void Bindings::assimilate(KeyBindingTree *node)
167 {
168   KeyBindingTree *a, *b, *tmp, *last;
169
170   if (!_keytree.first_child) {
171     // there are no nodes at this level yet
172     _keytree.first_child = node;
173   } else {
174     a = _keytree.first_child;
175     last = a;
176     b = node;
177     while (a) {
178       last = a;
179       if (a->binding != b->binding) {
180         a = a->next_sibling;
181       } else {
182         tmp = b;
183         b = b->first_child;
184         delete tmp;
185         a = a->first_child;
186       }
187     }
188     if (last->binding != b->binding)
189       last->next_sibling = b;
190     else {
191       last->first_child = b->first_child;
192       delete b;
193     }
194   }
195 }
196
197
198 KeyBindingTree *Bindings::find(KeyBindingTree *search,
199                                  bool *conflict) const {
200   *conflict = false;
201   KeyBindingTree *a, *b;
202   a = _keytree.first_child;
203   b = search;
204   while (a && b) {
205     if (a->binding != b->binding) {
206       a = a->next_sibling;
207     } else {
208       if (a->chain == b->chain) {
209         if (!a->chain) {
210           // found it! (return the actual id, not the search's)
211           return a;
212         }
213       } else {
214         *conflict = true;
215         return 0; // the chain status' don't match (conflict!)
216       }
217       b = b->first_child;
218       a = a->first_child;
219     }
220   }
221   return 0; // it just isn't in here
222 }
223
224
225 bool Bindings::addKey(const StringVect &keylist, PyObject *callback)
226 {
227   KeyBindingTree *tree, *t;
228   bool conflict;
229
230   if (!(tree = buildtree(keylist, callback)))
231     return false; // invalid binding requested
232
233   t = find(tree, &conflict);
234   if (conflict) {
235     // conflicts with another binding
236     destroytree(tree);
237     return false;
238   }
239
240   if (t) {
241     // already bound to something
242     // XXX: look if callback is already bound to this key?
243     t->callbacks.push_back(callback);
244     destroytree(tree);
245   } else {
246     // grab the server here to make sure no key pressed go missed
247     otk::display->grab();
248     grabKeys(false);
249
250     // assimilate this built tree into the main tree
251     assimilate(tree); // assimilation destroys/uses the tree
252
253     grabKeys(true); 
254     otk::display->ungrab();
255   }
256  
257   Py_INCREF(callback);
258
259   return true;
260 }
261
262
263 bool Bindings::removeKey(const StringVect &keylist, PyObject *callback)
264 {
265   assert(false); // XXX: function not implemented yet
266
267   KeyBindingTree *tree;
268   bool conflict;
269
270   if (!(tree = buildtree(keylist, 0)))
271     return false; // invalid binding requested
272
273   KeyBindingTree *t = find(tree, &conflict);
274   if (t) {
275     CallbackList::iterator it = std::find(t->callbacks.begin(),
276                                           t->callbacks.end(),
277                                           callback);
278     if (it != t->callbacks.end()) {
279       // grab the server here to make sure no key pressed go missed
280       otk::display->grab();
281       grabKeys(false);
282       
283       _curpos = &_keytree;
284       
285       // XXX do shit here ...
286       Py_XDECREF(*it);
287       
288       grabKeys(true);
289       otk::display->ungrab();
290       
291       return true;
292     }
293   }
294   return false;
295 }
296
297
298 void Bindings::setResetKey(const std::string &key)
299 {
300   Binding b(0, 0);
301   if (translate(key, b)) {
302     // grab the server here to make sure no key pressed go missed
303     otk::display->grab();
304     grabKeys(false);
305     _resetkey.key = b.key;
306     _resetkey.modifiers = b.modifiers;
307     grabKeys(true);
308     otk::display->ungrab();
309   }
310 }
311
312
313 static void remove_branch(KeyBindingTree *first)
314 {
315   KeyBindingTree *p = first;
316
317   while (p) {
318     if (p->first_child)
319       remove_branch(p->first_child);
320     KeyBindingTree *s = p->next_sibling;
321     while(!p->callbacks.empty()) {
322       Py_XDECREF(p->callbacks.front());
323       p->callbacks.pop_front();
324     }
325     delete p;
326     p = s;
327   }
328 }
329
330
331 void Bindings::removeAllKeys()
332 {
333   grabKeys(false);
334   if (_keytree.first_child) {
335     remove_branch(_keytree.first_child);
336     _keytree.first_child = 0;
337   }
338   grabKeys(true);
339 }
340
341
342 void Bindings::grabKeys(bool grab)
343 {
344   for (int i = 0; i < openbox->screenCount(); ++i) {
345     Window root = otk::display->screenInfo(i)->rootWindow();
346
347     KeyBindingTree *p = _curpos->first_child;
348     while (p) {
349       if (grab) {
350         otk::display->grabKey(p->binding.key, p->binding.modifiers,
351                                 root, false, GrabModeAsync, GrabModeAsync,
352                                 false);
353       }
354       else
355         otk::display->ungrabKey(p->binding.key, p->binding.modifiers,
356                                   root);
357       p = p->next_sibling;
358     }
359
360     if (_resetkey.key)
361       if (grab)
362         otk::display->grabKey(_resetkey.key, _resetkey.modifiers,
363                                 root, false, GrabModeAsync, GrabModeAsync,
364                                 false);
365       else
366         otk::display->ungrabKey(_resetkey.key, _resetkey.modifiers,
367                                   root);
368   }
369 }
370
371
372 void Bindings::fireKey(int screen, unsigned int modifiers, unsigned int key,
373                          Time time)
374 {
375   if (key == _resetkey.key && modifiers == _resetkey.modifiers) {
376     resetChains(this);
377   } else {
378     KeyBindingTree *p = _curpos->first_child;
379     while (p) {
380       if (p->binding.key == key && p->binding.modifiers == modifiers) {
381         if (p->chain) {
382           if (_timer)
383             delete _timer;
384           _timer = new otk::Timer(5000, // 5 second timeout
385                                   (otk::Timer::TimeoutHandler)resetChains,
386                                   this);
387           // grab the server here to make sure no key pressed go missed
388           otk::display->grab();
389           grabKeys(false);
390           _curpos = p;
391           grabKeys(true);
392           otk::display->ungrab();
393         } else {
394           Client *c = openbox->focusedClient();
395           KeyData data(screen, c, time, modifiers, key);
396           CallbackList::iterator it, end = p->callbacks.end();
397           for (it = p->callbacks.begin(); it != end; ++it)
398             python_callback(*it, &data);
399           resetChains(this);
400         }
401         break;
402       }
403       p = p->next_sibling;
404     }
405   }
406 }
407
408 void Bindings::resetChains(Bindings *self)
409 {
410   if (self->_timer) {
411     delete self->_timer;
412     self->_timer = (otk::Timer *) 0;
413   }
414   // grab the server here to make sure no key pressed go missed
415   otk::display->grab();
416   self->grabKeys(false);
417   self->_curpos = &self->_keytree;
418   self->grabKeys(true);
419   otk::display->ungrab();
420 }
421
422
423 bool Bindings::addButton(const std::string &but, MouseContext context,
424                            MouseAction action, PyObject *callback)
425 {
426   assert(context >= 0 && context < NUM_MOUSE_CONTEXT);
427   
428   Binding b(0,0);
429   if (!translate(but, b, false))
430     return false;
431
432   ButtonBindingList::iterator it, end = _buttons[context].end();
433
434   // look for a duplicate binding
435   for (it = _buttons[context].begin(); it != end; ++it)
436     if ((*it)->binding.key == b.key &&
437         (*it)->binding.modifiers == b.modifiers) {
438       break;
439     }
440
441   ButtonBinding *bind;
442   
443   // the binding didnt exist yet, add it
444   if (it == end) {
445     bind = new ButtonBinding();
446     bind->binding.key = b.key;
447     bind->binding.modifiers = b.modifiers;
448     _buttons[context].push_back(bind);
449     // grab the button on all clients
450     for (int sn = 0; sn < openbox->screenCount(); ++sn) {
451       Screen *s = openbox->screen(sn);
452       Client::List::iterator c_it, c_end = s->clients.end();
453       for (c_it = s->clients.begin(); c_it != c_end; ++c_it) {
454         grabButton(true, bind->binding, context, *c_it);
455       }
456     }
457   } else
458     bind = *it;
459   bind->callbacks[action].push_back(callback);
460   Py_INCREF(callback);
461   return true;
462 }
463
464 void Bindings::removeAllButtons()
465 {
466   for (int i = 0; i < NUM_MOUSE_CONTEXT; ++i) {
467     ButtonBindingList::iterator it, end = _buttons[i].end();
468     for (it = _buttons[i].begin(); it != end; ++it) {
469       for (int a = 0; a < NUM_MOUSE_ACTION; ++a) {
470         while (!(*it)->callbacks[a].empty()) {
471           Py_XDECREF((*it)->callbacks[a].front());
472           (*it)->callbacks[a].pop_front();
473         }
474       }
475       // ungrab the button on all clients
476       for (int sn = 0; sn < openbox->screenCount(); ++sn) {
477         Screen *s = openbox->screen(sn);
478         Client::List::iterator c_it, c_end = s->clients.end();
479         for (c_it = s->clients.begin(); c_it != c_end; ++c_it) {
480           grabButton(false, (*it)->binding, (MouseContext)i, *c_it);
481         }
482       }
483     }
484   }
485 }
486
487 void Bindings::grabButton(bool grab, const Binding &b, MouseContext context,
488                             Client *client)
489 {
490   Window win;
491   int mode = GrabModeAsync;
492   unsigned int mask;
493   switch(context) {
494   case MC_Frame:
495     win = client->frame->window();
496     mask = ButtonPressMask | ButtonMotionMask | ButtonReleaseMask;
497     break;
498   case MC_Window:
499     win = client->frame->plate();
500     mode = GrabModeSync; // this is handled in fireButton
501     mask = ButtonPressMask; // can't catch more than this with Sync mode
502                             // the release event is manufactured by the
503                             // master buttonPressHandler
504     break;
505   default:
506     // any other elements already get button events, don't grab on them
507     return;
508   }
509   if (grab)
510     otk::display->grabButton(b.key, b.modifiers, win, false, mask, mode,
511                              GrabModeAsync, None, None, false);
512   else
513     otk::display->ungrabButton(b.key, b.modifiers, win);
514 }
515
516 void Bindings::grabButtons(bool grab, Client *client)
517 {
518   for (int i = 0; i < NUM_MOUSE_CONTEXT; ++i) {
519     ButtonBindingList::iterator it, end = _buttons[i].end();
520     for (it = _buttons[i].begin(); it != end; ++it)
521       grabButton(grab, (*it)->binding, (MouseContext)i, client);
522   }
523 }
524
525 void Bindings::fireButton(MouseData *data)
526 {
527   if (data->context == MC_Window) {
528     // Replay the event, so it goes to the client, and ungrab the device.
529     XAllowEvents(**otk::display, ReplayPointer, data->time);
530   }
531   
532   ButtonBindingList::iterator it, end = _buttons[data->context].end();
533   for (it = _buttons[data->context].begin(); it != end; ++it)
534     if ((*it)->binding.key == data->button &&
535         (*it)->binding.modifiers == data->state) {
536       CallbackList::iterator c_it,c_end = (*it)->callbacks[data->action].end();
537       for (c_it = (*it)->callbacks[data->action].begin();
538            c_it != c_end; ++c_it)
539         python_callback(*c_it, data);
540     }
541 }
542
543
544 bool Bindings::addEvent(EventAction action, PyObject *callback)
545 {
546   if (action < 0 || action >= NUM_EVENTS) {
547     return false;
548   }
549 #ifdef    XKB
550   if (action == EventBell && _eventlist[action].empty())
551     XkbSelectEvents(**otk::display, XkbUseCoreKbd,
552                     XkbBellNotifyMask, XkbBellNotifyMask);
553 #endif // XKB
554   _eventlist[action].push_back(callback);
555   Py_INCREF(callback);
556   return true;
557 }
558
559 bool Bindings::removeEvent(EventAction action, PyObject *callback)
560 {
561   if (action < 0 || action >= NUM_EVENTS) {
562     return false;
563   }
564   
565   CallbackList::iterator it = std::find(_eventlist[action].begin(),
566                                         _eventlist[action].end(),
567                                         callback);
568   if (it != _eventlist[action].end()) {
569     Py_XDECREF(*it);
570     _eventlist[action].erase(it);
571 #ifdef    XKB
572     if (action == EventBell && _eventlist[action].empty())
573       XkbSelectEvents(**otk::display, XkbUseCoreKbd,
574                       XkbBellNotifyMask, 0);
575 #endif // XKB
576     return true;
577   }
578   return false;
579 }
580
581 void Bindings::removeAllEvents()
582 {
583   for (int i = 0; i < NUM_EVENTS; ++i) {
584     while (!_eventlist[i].empty()) {
585       Py_XDECREF(_eventlist[i].front());
586       _eventlist[i].pop_front();
587     }
588   }
589 }
590
591 void Bindings::fireEvent(EventData *data)
592 {
593   CallbackList::iterator c_it, c_end = _eventlist[data->action].end();
594   for (c_it = _eventlist[data->action].begin(); c_it != c_end; ++c_it)
595     python_callback(*c_it, data);
596 }
597
598 }