keybindings underway. dont work yet
[mikachu/openbox.git] / src / bindings.hh
1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
2 #ifndef __binding_hh
3 #define __binding_hh
4
5 /*! @file binding.hh
6   @brief I dunno.. some binding stuff?
7 */
8
9 #include <string>
10 #include <vector>
11
12 namespace ob {
13
14 typedef struct Binding {
15   unsigned int modifiers;
16   unsigned int key;
17
18   bool operator==(struct Binding &b2) { return key == b2.key &&
19                                           modifiers == b2.modifiers; }
20   bool operator!=(struct Binding &b2) { return key != b2.key ||
21                                           modifiers != b2.modifiers; }
22   Binding(unsigned int mod, unsigned int k) { modifiers = mod; key = k; }
23 } Binding;
24
25 typedef struct BindingTree {
26   Binding binding;
27   std::string text;
28   int id;     // the id given for the binding in add()
29   bool chain; // true if this is a chain to another key (not an action)
30
31   struct BindingTree *next_sibling; // the next binding in the tree at the same
32                                     // level
33   struct BindingTree *first_child;  // the first child of this binding (next
34                                     // binding in a chained sequence).
35   BindingTree(int id) : binding(0, 0) {
36     this->id = id; chain = true; next_sibling = first_child = 0;
37   }
38   BindingTree() : binding(0, 0) {
39     this->id = -1; chain = true; next_sibling = first_child = 0;
40   }
41 } BindingTree;
42
43 class OBBindings {
44 public:
45   //! A list of strings
46   typedef std::vector<std::string> StringVect;
47
48 private:
49   BindingTree _bindings;// root nodes (these dont have siblings!)
50
51 public:
52   //! Initializes an OBBinding object
53   OBBindings();
54   //! Destroys the OBBinding object
55   virtual ~OBBindings();
56
57   //! Adds a new binding
58   /*!
59     A binding will fail to be added if the binding already exists (as part of
60     a chain or not), or if any of the strings in the keylist are invalid.    
61     @return true if the binding could be added; false if it could not.
62   */
63   bool add(const StringVect &keylist, int id);
64
65   //! Removes a key binding
66   /*!
67     @return The id of the binding that was removed, or '< 0' if none were
68             removed.
69   */
70   int remove(const StringVect &keylist);
71
72   //! Removes all key bindings
73   void remove_all();
74
75   //! Finds a keybinding and returns its id or '< 0' if it isn't found.
76   /*!
77     @return -1 if the keybinding was not found but does not conflict with
78     any others; -2 if the keybinding conflicts with another.
79   */
80   int find(const StringVect &keylist);
81
82   // XXX: need an exec() function or something that will be used by openbox
83   //      and hold state for which chain we're in etc. (it could have a timer
84   //      for reseting too...)
85
86   void display();
87 };
88
89 }
90
91 #endif // __binding_hh