src/keytree.hh

   1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
   2 // keytree.hh for Epistrophy - a key handler for NETWM/EWMH window managers.
   3 // Copyright (c) 2002 - 2002 Ben Jansens <ben at orodu.net>
   4 //
   5 // Adapted slightly for inclusion in bbkeys by Jason 'vanRijn' Kasper
   6 //
   7 // Permission is hereby granted, free of charge, to any person obtaining a
   8 // copy of this software and associated documentation files (the "Software"),
   9 // to deal in the Software without restriction, including without limitation
  10 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11 // and/or sell copies of the Software, and to permit persons to whom the
  12 // Software is furnished to do so, subject to the following conditions:
  13 //
  14 // The above copyright notice and this permission notice shall be included in
  15 // all copies or substantial portions of the Software.
  16 //
  17 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  22 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  23 // DEALINGS IN THE SOFTWARE.
  24
  25 #ifndef _keytree_hh
  26 #define _keytree_hh
  27
  28 extern "C" {
  29 #include <X11/Xlib.h>
  30 }
  31
  32 #include <list>
  33 #include "actions.hh"
  34 #include "ScreenHandler.h"
  35
  36 class ScreenHandler;
  37
  38 struct keynode; // forward declaration
  39 typedef std::list<keynode *> ChildList;
  40
  41 struct keynode {
  42   Action *action;
  43   keynode *parent;
  44   ChildList children;
  45 };
  46
  47 class keytree {
  48 public:
  49   keytree(Display * display);
  50   virtual ~keytree();
  51
  52   Action * getAction(const XKeyEvent  * const e, unsigned int &, ScreenHandler * screen);
  53   void unloadBindings();
  54   inline void showTree() {showTree(_head); }
  55   inline bool isLeaf (keynode *node) { return node->children.empty(); }
  56   void grabDefaults(ScreenHandler * screen);
  57   void ungrabDefaults(ScreenHandler * screen);
  58   void showTree(keynode *);
  59
  60 private:
  61   friend class KeyClient;
  62   void grabChildren(keynode *, ScreenHandler * screen);
  63   void ungrabChildren(keynode *, ScreenHandler * screen);
  64
  65   void addAction(Action::ActionType, unsigned int, std::string, std::string);
  66   void advanceOnNewNode();
  67   void retract();
  68   void setCurrentNodeProps(Action::ActionType, unsigned int, std::string, std::string);
  69   void initialize();
  70
  71   void reset()
  72   { _current = _head; }
  73
  74   void clearTree(keynode *);
  75
  76   keynode *_head;
  77   keynode *_current;
  78   Display *_display;
  79 };
  80
  81 #endif // _keytree_hh