/*
   client/keyboard.h
   This file is part of the Osirion project and is distributed under
   the terms and conditions of the GNU General Public License version 2
*/

#ifndef __INCLUDED_CLIENT_KEYBOARD_H__
#define __INCLUDED_CLIENT_KEYBOARD_H__

#include <string>
#include <map>
#include <list>

#include "SDL/SDL.h"

#include "client/action.h"
#include "client/key.h"

namespace client {

class Keyboard
{
public:
	Keyboard();
	~Keyboard();

	/// find a key on a keysym
	Key *find(unsigned int keysym);

	/// find a key on name
	Key *find(std::string const & name);

	/// bind a string to a key
	void bind(std::string const &name, const std::string str);

	/// clear the string bound to a key
	void unbind(std::string const &name);

	/// celar all key binds
	void unbindall();

	/// list keyboard key names
	void list_keys();

	/// list actions
	void list_actions();

	/// list keyboard binds
	void list_binds();

	/// list binds for a singe key
	void list_bind(std::string const &name);

	/// load keyboard binds
	void load_binds();

	/// save keyboard binds
	void save_binds();

	/// a key has been pressed
	Key *press(unsigned int sym);

	/// a key has been pressed
	Key *release(unsigned int sym);

private:
	typedef std::map<unsigned int, Key *>::iterator iterator;
	
	inline iterator begin() { return keys.begin(); }
	
	inline iterator end() { return keys.end(); }

	void add_key(const char *name, const unsigned int keysym, const char ascii=0, const char *bind=0);

	void add_action(const char *name, Action::Identifier action, const char *info = 0);

	std::map<unsigned int, Key *> keys;
	std::list<Action *> actions;

	bool numlock;
	bool capslock;
};

/// convert SDL_keysym to a keystroke
unsigned int translate_keysym(const SDL_keysym &keysym);

/// set the keyboard input mode
/** @param input true for console input, false for game input
 */
void setkeyboardmode(bool input);

}

#endif // __INCLUDED_CLIENT_KEYBOARD_H__