/* 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$
* $Id$
*
*/

#ifndef COMMON_HARDWAREKEY
#define COMMON_HARDWAREKEY

#include "backends/keymapper/action.h"

namespace Common {

/**
* Describes an available hardware key 
*/
struct HardwareKey {
	/** unique id used for saving/loading to config */
	int32 id;
	/** Human readable description */
	String description; 
	/** 
	* The KeyState that is generated by the back-end 
	* when this hardware key is pressed.
	*/
	KeyState key;

	ActionCategory preferredCategory;
	ActionType preferredType;
	int16 group;

	HardwareKey(int32 i, KeyState ks = KeyState(), String des = "",
				ActionCategory cat = kGenericActionCategory,
				ActionType ty = kGenericActionType,	int gr = 0) {
		id = i;
		key = ks;
		description = des;
		preferredCategory = cat;
		preferredType = ty;
		group = gr;
	}
};


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

	HardwareKeySet() {}
	virtual ~HardwareKeySet() {
		List<HardwareKey*>::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(int32 id) const {
		List<HardwareKey*>::iterator it;
		for (it = _keys.begin(); it != _keys.end(); it++) {
			if ((*it)->id == id)
				return (*it);
		}
		return 0;
	}

	const HardwareKey *findHardwareKey(const KeyState& keystate) const {
		List<HardwareKey*>::iterator it;
		for (it = _keys.begin(); it != _keys.end(); it++) {
			if ((*it)->key == keystate)
				return (*it);
		}
		return 0;
	}

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

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


private:

	void checkForKey(HardwareKey *key) {
		List<HardwareKey*>::iterator it;
		for (it = _keys.begin(); it != _keys.end(); it++) {
			if ((*it)->id == key->id)
				error("Error adding HardwareKey '%s' - id of %d already in use!", key->description.c_str(), key->id);
			else if ((*it)->key == key->key)
				error("Error adding HardwareKey '%s' - key already in use!", key->description.c_str());
		}
	}

	List<HardwareKey*> _keys;
};


} // end of namespace Common

#endif