/*
 * \brief  Input event structure
 * \author Norman Feske
 * \date   2006-08-16
 */

/*
 * Copyright (C) 2006-2013 Genode Labs GmbH
 *
 * This file is part of the Genode OS framework, which is distributed
 * under the terms of the GNU General Public License version 2.
 */

#ifndef _INCLUDE__INPUT__EVENT_H_
#define _INCLUDE__INPUT__EVENT_H_

#include <input/keycodes.h>

namespace Input { class Event; }


class Input::Event
{
	public:

		enum Type { INVALID, MOTION, PRESS, RELEASE, WHEEL, FOCUS, LEAVE, TOUCH };

	private:

		Type _type;

		/*
		 * For PRESS and RELEASE events, '_code' contains the key code.
		 * For FOCUS events, '_code' is set to 1 (focus) or 0 (unfocus).
		 */
		int _code;

		/*
		 * Absolute pointer position coordinates
		 */
		int _ax, _ay;

		/*
		 * Relative pointer motion vector
		 */
		int _rx, _ry;

	public:

		/**
		 * Constructors
		 */
		Event():
			_type(INVALID), _code(0), _ax(0), _ay(0), _rx(0), _ry(0) { }

		Event(Type type, int code, int ax, int ay, int rx, int ry):
			_type(type), _code(code),
			_ax(ax), _ay(ay), _rx(rx), _ry(ry) { }

		/**
		 * Accessors
		 */
		Type type() const { return _type; }
		int  code() const { return _code; }
		int  ax()   const { return _ax; }
		int  ay()   const { return _ay; }
		int  rx()   const { return _rx; }
		int  ry()   const { return _ry; }

		/**
		 * Return key code for press/release events
		 */
		Keycode keycode() const
		{
			return _type == PRESS || _type == RELEASE ? (Keycode)_code : KEY_UNKNOWN;
		}

		bool absolute_motion() const { return _type == MOTION && !_rx && !_ry; }
		bool relative_motion() const { return _type == MOTION && (_rx || _ry); }
		bool touch_release()   const { return _type == TOUCH && (_rx == -1) && (_ry == -1); }

		/*
		 * \deprecated use methods without the 'is_' prefix instead
		 */
		bool is_absolute_motion() const { return absolute_motion(); }
		bool is_relative_motion() const { return relative_motion(); }
		bool is_touch_release()   const { return touch_release(); }

		static Event create_touch_event(int ax, int ay, int id, bool last = false)
		{
			return Event(Type::TOUCH, id, ax, ay, last ? -1 : 0, last ? -1 : 0);
		}
};

#endif /* _INCLUDE__INPUT__EVENT_H_ */