Logo Search packages:      
Sourcecode: scummvm version File versions  Download package

hardware-key.h

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* $URL: https://scummvm.svn.sourceforge.net/svnroot/scummvm/scummvm/tags/release-1-1-0/backends/keymapper/hardware-key.h $
* $Id: hardware-key.h 44634 2009-10-04 21:26:33Z fingolfin $
*
*/

#ifndef COMMON_HARDWARE_KEY_H
#define COMMON_HARDWARE_KEY_H

#include "common/scummsys.h"

#ifdef ENABLE_KEYMAPPER

#include "backends/keymapper/types.h"

namespace Common {


#define HWKEY_ID_SIZE (30)

/**
* Describes an available hardware key
*/
struct HardwareKey {
      /** unique id used for saving/loading to config */
      char hwKeyId[HWKEY_ID_SIZE];

      /** Human readable description */
      String description;

      /**
      * The KeyState that is generated by the back-end
      * when this hardware key is pressed.
      */
      KeyState key;

      KeyType type;
      ActionType preferredAction;

      HardwareKey(const char *i, KeyState ky = KeyState(), String desc = "",
                        KeyType typ = kGenericKeyType, ActionType prefAct = kGenericActionType)
            : key(ky), description(desc), type(typ), preferredAction(prefAct) {
            assert(i);
            strncpy(hwKeyId, i, HWKEY_ID_SIZE);
      }
};


/**
 * Simple class to encapsulate a device's set of HardwareKeys.
 * Each device should instantiate this and call addHardwareKey a number of times
 * in its constructor to define the device's available keys.
 */
class HardwareKeySet {
public:

      virtual ~HardwareKeySet() {
            List<const HardwareKey*>::const_iterator it;

            for (it = _keys.begin(); it != _keys.end(); it++)
                  delete *it;
      }

      void addHardwareKey(HardwareKey *key) {
            checkForKey(key);
            _keys.push_back(key);
      }

      const HardwareKey *findHardwareKey(const char *id) const {
            List<const HardwareKey*>::const_iterator it;

            for (it = _keys.begin(); it != _keys.end(); it++) {
                  if (strncmp((*it)->hwKeyId, id, HWKEY_ID_SIZE) == 0)
                        return (*it);
            }
            return 0;
      }

      const HardwareKey *findHardwareKey(const KeyState& keystate) const {
            List<const HardwareKey*>::const_iterator it;

            for (it = _keys.begin(); it != _keys.end(); it++) {
                  if ((*it)->key == keystate)
                        return (*it);
            }
            return 0;
      }

      const List<const HardwareKey*> &getHardwareKeys() const {
            return _keys;
      }

      uint size() const {
            return _keys.size();
      }


private:

      void checkForKey(HardwareKey *key) {
            List<const HardwareKey*>::iterator it;

            for (it = _keys.begin(); it != _keys.end(); it++) {
                  if (strncmp((*it)->hwKeyId, key->hwKeyId, HWKEY_ID_SIZE) == 0)
                        error("Error adding HardwareKey '%s' - id of %s already in use!", key->description.c_str(), key->hwKeyId);
                  else if ((*it)->key == key->key)
                        error("Error adding HardwareKey '%s' - key already in use!", key->description.c_str());
            }
      }

      List<const HardwareKey*> _keys;
};


} // End of namespace Common

#endif // #ifdef ENABLE_KEYMAPPER

#endif // #ifndef COMMON_HARDWARE_KEY_H

Generated by  Doxygen 1.6.0   Back to index