menu: add mouse manager for handling mouse focus and clicks

5 files changed, 246 insertions, 0 deletions

diff --git a/src/menu/application.cpp b/src/menu/application.cpp
index 28eaf480..e18abf24 100644
--- a/src/menu/application.cpp
+++ b/src/menu/application.cpp
@@ -24,6 +24,7 @@
 
 #include "application.hpp"
 #include "event_manager.hpp"
+#include "mouse_manager.hpp"
 #include <exception>
 #include "software_mouse_pointer.hpp"
 #include "frames/loading_frame.hpp"
@@ -89,6 +90,7 @@ namespace usdx
 	{
 		SDL_Event event;
 		EventManager event_manager;
+		MouseManager mouse_manager(event_manager);
 		boost::thread event_thread(boost::bind(&EventManager::handle_events, &event_manager));
 
 		SoftwareMousePointer pointer(this, &event_manager);
diff --git a/src/menu/drawable_control.cpp b/src/menu/drawable_control.cpp
index 76749840..1dc36072 100644
--- a/src/menu/drawable_control.cpp
+++ b/src/menu/drawable_control.cpp
@@ -252,4 +252,32 @@ namespace usdx
 
 		return NULL;
 	}
+
+	void DrawableControl::mouse_move(const Point<int>& p)
+	{
+	}
+
+	void DrawableControl::mouse_down(uint8_t button, const Point<int>& p)
+	{
+	}
+
+	void DrawableControl::mouse_up(uint8_t button, const Point<int>& p)
+	{
+	}
+
+	void DrawableControl::mouse_enter(void)
+	{
+	}
+
+	void DrawableControl::mouse_leave(void)
+	{
+	}
+
+	void DrawableControl::mouse_click(uint8_t button, const Point<int>& p)
+	{
+	}
+
+	void DrawableControl::mouse_dbl_click(uint8_t button, const Point<int>& p)
+	{
+	}
 };
diff --git a/src/menu/drawable_control.hpp b/src/menu/drawable_control.hpp
index 9e15966e..7627cbed 100644
--- a/src/menu/drawable_control.hpp
+++ b/src/menu/drawable_control.hpp
@@ -135,6 +135,15 @@ namespace usdx
 
 		const Rectangle<int> get_absolut_rect(void) const;
 		virtual DrawableControl* get_component_at(const Point<int>& p);
+
+		virtual void mouse_move(const Point<int>& p);
+		virtual void mouse_down(uint8_t button, const Point<int>& p);
+		virtual void mouse_up(uint8_t button, const Point<int>& p);
+		virtual void mouse_enter(void);
+		virtual void mouse_leave(void);
+
+		virtual void mouse_click(uint8_t button, const Point<int>& p);
+		virtual void mouse_dbl_click(uint8_t button, const Point<int>& p);
 	};
 };
 
diff --git a/src/menu/mouse_manager.cpp b/src/menu/mouse_manager.cpp
new file mode 100644
index 00000000..0910da6f
--- /dev/null
+++ b/src/menu/mouse_manager.cpp
@@ -0,0 +1,137 @@
+/*
+ * UltraStar Deluxe - Karaoke Game
+ *
+ * UltraStar Deluxe 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; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ *
+ */
+
+#include "mouse_manager.hpp"
+#include "utils/rectangle.hpp"
+#include "container.hpp"
+#include "application.hpp"
+
+namespace usdx
+{
+	log4cpp::Category& MouseManager::log =
+		log4cpp::Category::getInstance("usdx.menu.mouse_manager");
+
+	MouseManager::MouseManager(EventManager& event_manager)
+		: last_active(NULL)
+	{
+		mouse_move_connection = event_manager.mouse_move.connect(
+			boost::bind(&MouseManager::on_mouse_move, this, _1));
+		mouse_down_connection = event_manager.mouse_down.connect(
+			boost::bind(&MouseManager::on_mouse_down, this, _1, _2));
+		mouse_up_connection = event_manager.mouse_up.connect(
+			boost::bind(&MouseManager::on_mouse_up, this, _1, _2));
+	}
+
+	MouseManager::~MouseManager()
+	{
+		mouse_move_connection.disconnect();
+		mouse_down_connection.disconnect();
+		mouse_up_connection.disconnect();
+	}
+
+	void MouseManager::find_active_element(const Point<int>& p)
+	{
+		DrawableControl *c = find_parent(last_active, p);
+		c = c->get_component_at(p);
+
+		if (last_active != c) {
+			if (last_active) {
+				last_active->mouse_leave();
+			}
+
+			last_active = c;
+
+			if (last_active) {
+				last_active->mouse_enter();
+			}
+		}
+	}
+
+	DrawableControl* MouseManager::find_parent(DrawableControl* current,
+											   const Point<int>& p) const
+	{
+		if (current == NULL) {
+			// start search from top level
+			return Application::get_instance();
+		}
+
+		if (!current->get_absolut_rect().is_in(p)) {
+			current = find_parent(current->get_parent(), p);
+		}
+
+		return current;
+	}
+
+	void MouseManager::on_mouse_move(const Point<int>& p)
+	{
+		find_active_element(p);
+
+		if (last_active) {
+			last_active->mouse_move(p);
+		}
+	}
+
+	void MouseManager::on_mouse_down(uint8_t button, const Point<int>& p)
+	{
+		find_active_element(p);
+
+		if (last_active) {
+			last_active->mouse_down(button, p);
+		}
+
+		event.add_event(last_active, button, MouseEvent::DOWN);
+	}
+
+	void MouseManager::on_mouse_up(uint8_t button, const Point<int>& p)
+	{
+		find_active_element(p);
+
+		if (last_active) {
+			last_active->mouse_up(button, p);
+		}
+
+		MouseEvent::Event e = event.add_event(last_active, button,
+											  MouseEvent::UP);
+
+		switch (e) {
+		case MouseEvent::CLICK:
+			last_active->mouse_click(button, p);
+			break;
+
+		case MouseEvent::DBL_CLICK:
+			last_active->mouse_dbl_click(button, p);
+			break;
+
+		default:
+			;
+		}
+	}
+
+	void MouseManager::deactivate_control(const DrawableControl* control)
+	{
+		if (last_active == control) {
+			last_active = NULL;
+		}
+	}
+};
diff --git a/src/menu/mouse_manager.hpp b/src/menu/mouse_manager.hpp
new file mode 100644
index 00000000..fe71ead3
--- /dev/null
+++ b/src/menu/mouse_manager.hpp
@@ -0,0 +1,70 @@
+/*
+ * UltraStar Deluxe - Karaoke Game
+ *
+ * UltraStar Deluxe 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; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ *
+ */
+
+#ifndef MOUSE_MANAGER_HPP
+#define MOUSE_MANAGER_HPP
+
+#include <log4cpp/Category.hh>
+
+#include <boost/signals2.hpp>
+#include "event_manager.hpp"
+#include "drawable_control.hpp"
+#include "utils/point.hpp"
+#include "mouse_event.hpp"
+
+namespace usdx
+{
+    class MouseManager
+	{
+	private:
+		static log4cpp::Category&  log;
+
+		DrawableControl *last_active;
+		MouseEvent event;
+
+		void find_active_element(const Point<int>& p);
+		DrawableControl* find_parent(DrawableControl* current, const Point<int>& p) const;
+
+		boost::signals2::connection mouse_move_connection;
+		boost::signals2::connection mouse_down_connection;
+		boost::signals2::connection mouse_up_connection;
+
+		void on_mouse_move(const Point<int>& p);
+		void on_mouse_down(uint8_t button, const Point<int>& p);
+		void on_mouse_up(uint8_t button, const Point<int>& p);
+
+	public:
+		MouseManager(EventManager& event_manager);
+		virtual ~MouseManager();
+
+		/**
+		 * This method used to remove the internal reference to the active
+		 * control. This should be called during deconstruction of each drawable
+		 * control.
+		 */
+		void deactivate_control(const DrawableControl* control);
+	};
+};
+
+#endif