X-Plane Remote Access Plugin and Client Library
HotkeyHandler.h
1 // Copyright (c) 2013 by István Váradi
2 
3 // This file is part of XPLRA, a remote-access plugin for X-Plane
4 
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are met:
7 
8 // 1. Redistributions of source code must retain the above copyright notice, this
9 // list of conditions and the following disclaimer.
10 // 2. Redistributions in binary form must reproduce the above copyright notice,
11 // this list of conditions and the following disclaimer in the documentation
12 // and/or other materials provided with the distribution.
13 
14 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
15 // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
18 // ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21 // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 
25 // The views and conclusions contained in the software and documentation are those
26 // of the authors and should not be interpreted as representing official policies,
27 // either expressed or implied, of the FreeBSD Project.
28 
29 #ifndef XPLRA_HOTKEYHANDLER_H
30 #define XPLRA_HOTKEYHANDLER_H
31 //------------------------------------------------------------------------------
32 
33 #include <hu/varadiistvan/scpl/Mutex.h>
34 
35 #include <XPLMDefs.h>
36 
37 #include <list>
38 
39 #include <inttypes.h>
40 
41 //------------------------------------------------------------------------------
42 
43 namespace hu { namespace varadiistvan { namespace scpl { namespace io {
44 
45 class DataStream;
46 
47 } } } }
48 
49 //------------------------------------------------------------------------------
50 
51 namespace xplra {
52 
53 //------------------------------------------------------------------------------
54 
59 {
60 public:
64  class Hotkeys
65  {
66  private:
70  size_t numHotkeys;
71 
75  uint16_t* hotkeys;
76 
81  uint8_t* pressed;
82 
83  public:
88  Hotkeys(size_t numHotkeys, hu::varadiistvan::scpl::io::DataStream& stream);
89 
93  ~Hotkeys();
94 
98  bool isValid() const;
99 
107  bool handleKey(uint16_t code);
108 
113  void writePressed(hu::varadiistvan::scpl::io::DataStream& stream);
114  };
115 
116  friend class Hotkeys;
117 
118 private:
122  typedef std::list<Hotkeys*> hotkeySets_t;
123 
127  static int keyCallback(char c, XPLMKeyFlags flags, char virtualKey,
128  void* refCon);
129 
133  hu::varadiistvan::scpl::Mutex mutex;
134 
139 
140 public:
144  HotkeyHandler();
145 
149  void registerHotkeys(Hotkeys* hotkeys);
150 
154  void unregisterHotkeys(Hotkeys* hotkeys);
155 
156 protected:
162  bool handleKey(char c, XPLMKeyFlags flags, char virtualKey);
163 };
164 
165 //------------------------------------------------------------------------------
166 // Inline definitions
167 //------------------------------------------------------------------------------
168 
170 {
171  return hotkeys!=0;
172 }
173 
174 //------------------------------------------------------------------------------
175 
176 } /* namespace xplra */
177 
178 //------------------------------------------------------------------------------
179 #endif // XPLRA_HOTKEYHANDLER_H
180 
181 // Local Variables:
182 // mode: C++
183 // c-basic-offset: 4
184 // indent-tabs-mode: nil
185 // End:
bool handleKey(uint16_t code)
Hotkeys(size_t numHotkeys, hu::varadiistvan::scpl::io::DataStream &stream)
void writePressed(hu::varadiistvan::scpl::io::DataStream &stream)
std::list< Hotkeys * > hotkeySets_t
bool handleKey(char c, XPLMKeyFlags flags, char virtualKey)
hotkeySets_t hotkeySets
static int keyCallback(char c, XPLMKeyFlags flags, char virtualKey, void *refCon)
void unregisterHotkeys(Hotkeys *hotkeys)
hu::varadiistvan::scpl::Mutex mutex
void registerHotkeys(Hotkeys *hotkeys)
Python client module for the X-Plane Remote Access plugin.
Definition: DataRefTask.h:41