backends/keymapper/hardware-key.h

   1 /* ScummVM - Graphic Adventure Engine
   2 *
   3 * ScummVM is the legal property of its developers, whose names
   4 * are too numerous to list here. Please refer to the COPYRIGHT
   5 * file distributed with this source distribution.
   6 *
   7 * This program is free software; you can redistribute it and/or
   8 * modify it under the terms of the GNU General Public License
   9 * as published by the Free Software Foundation; either version 2
  10 * of the License, or (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 * You should have received a copy of the GNU General Public License
  18 * along with this program; if not, write to the Free Software
  19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20 *
  21 * $URL$
  22 * $Id$
  23 *
  24 */
  25
  26 #ifndef COMMON_HARDWARE_KEY_H
  27 #define COMMON_HARDWARE_KEY_H
  28
  29 #include "common/scummsys.h"
  30
  31 #ifdef ENABLE_KEYMAPPER
  32
  33 #include "backends/keymapper/types.h"
  34
  35 namespace Common {
  36
  37
  38 #define HWKEY_ID_SIZE (30)
  39
  40 /**
  41 * Describes an available hardware key
  42 */
  43 struct HardwareKey {
  44         /** unique id used for saving/loading to config */
  45         char hwKeyId[HWKEY_ID_SIZE];
  46
  47         /** Human readable description */
  48         String description;
  49
  50         /**
  51         * The KeyState that is generated by the back-end
  52         * when this hardware key is pressed.
  53         */
  54         KeyState key;
  55
  56         KeyType type;
  57         ActionType preferredAction;
  58
  59         HardwareKey(const char *i, KeyState ky = KeyState(), String desc = "",
  60                                 KeyType typ = kGenericKeyType, ActionType prefAct = kGenericActionType)
  61                 : key(ky), description(desc), type(typ), preferredAction(prefAct) {
  62                 assert(i);
  63                 strncpy(hwKeyId, i, HWKEY_ID_SIZE);
  64         }
  65 };
  66
  67
  68 /**
  69  * Simple class to encapsulate a device's set of HardwareKeys.
  70  * Each device should instantiate this and call addHardwareKey a number of times
  71  * in its constructor to define the device's available keys.
  72  */
  73 class HardwareKeySet {
  74 public:
  75
  76         virtual ~HardwareKeySet() {
  77                 List<const HardwareKey*>::const_iterator it;
  78
  79                 for (it = _keys.begin(); it != _keys.end(); it++)
  80                         delete *it;
  81         }
  82
  83         void addHardwareKey(HardwareKey *key) {
  84                 checkForKey(key);
  85                 _keys.push_back(key);
  86         }
  87
  88         const HardwareKey *findHardwareKey(const char *id) const {
  89                 List<const HardwareKey*>::const_iterator it;
  90
  91                 for (it = _keys.begin(); it != _keys.end(); it++) {
  92                         if (strncmp((*it)->hwKeyId, id, HWKEY_ID_SIZE) == 0)
  93                                 return (*it);
  94                 }
  95                 return 0;
  96         }
  97
  98         const HardwareKey *findHardwareKey(const KeyState& keystate) const {
  99                 List<const HardwareKey*>::const_iterator it;
 100
 101                 for (it = _keys.begin(); it != _keys.end(); it++) {
 102                         if ((*it)->key == keystate)
 103                                 return (*it);
 104                 }
 105                 return 0;
 106         }
 107
 108         const List<const HardwareKey*> &getHardwareKeys() const {
 109                 return _keys;
 110         }
 111
 112         uint size() const {
 113                 return _keys.size();
 114         }
 115
 116
 117 private:
 118
 119         void checkForKey(HardwareKey *key) {
 120                 List<const HardwareKey*>::iterator it;
 121
 122                 for (it = _keys.begin(); it != _keys.end(); it++) {
 123                         if (strncmp((*it)->hwKeyId, key->hwKeyId, HWKEY_ID_SIZE) == 0)
 124                                 error("Error adding HardwareKey '%s' - id of %s already in use!", key->description.c_str(), key->hwKeyId);
 125                         else if ((*it)->key == key->key)
 126                                 error("Error adding HardwareKey '%s' - key already in use!", key->description.c_str());
 127                 }
 128         }
 129
 130         List<const HardwareKey*> _keys;
 131 };
 132
 133
 134 } // end of namespace Common
 135
 136 #endif // #ifdef ENABLE_KEYMAPPER
 137
 138 #endif // #ifndef COMMON_HARDWARE_KEY_H