Merge lp:~njpatel/nux/input-area-ungrab-on-destroy-3.0 into lp:nux/3.0

[Neil J. Patel]

InputArea: remove the pending grabs on destroy (it could cause crash otherwise)

THIS IS A CROSS MERGE FROM LP:NUX TO HAVE THIS FIX IN QUANTAL

When an InputArea grabs the keyboard or the pointer and then it gets destroyed, it is not removed from the window compositor list of the grabbed areas; this could cause a crash (mostly when doing current_keyboard_grab->end_keyboard_grab.emit(current_keyboard_grab);)

I think it's safer to remove all the references of the current area from the compositor on destroy.

Gtests included.

[Marco Trevisan (Treviño) (3v1n0)]

Correctly backported! ;)

review: Approve

=== modified file 'Nux/InputArea.cpp'
--- Nux/InputArea.cpp	2012-06-14 14:48:26 +0000
+++ Nux/InputArea.cpp	2012-09-18 18:08:22 +0000
@@ -67,9 +67,10 @@
 
   InputArea::~InputArea()
   {
+    while (GetWindowCompositor().GrabPointerRemove(this));
+    while (GetWindowCompositor().GrabKeyboardRemove(this));
   }
 
-  
   void InputArea::OnDraw(GraphicsEngine &graphics_engine, bool force_draw)
   {
     graphics_engine.QRP_Color(GetBaseX(), GetBaseY(), GetBaseWidth(), GetBaseHeight(), area_color_);

=== modified file 'tests/Makefile.am'
--- tests/Makefile.am	2012-08-13 20:48:38 +0000
+++ tests/Makefile.am	2012-09-18 18:08:22 +0000
@@ -77,6 +77,7 @@
   gtest-nux-textentry.cpp \
   gtest-nux-utils.h \
   gtest-nux-inputmethodibus.cpp \
+  gtest-nux-input-area.cpp \
   gtest-nux-view.cpp \
   gtest-nux-windowcompositor.cpp \
   gtest-nux-windowthread.cpp

=== added file 'tests/gtest-nux-input-area.cpp'
--- tests/gtest-nux-input-area.cpp	1970-01-01 00:00:00 +0000
+++ tests/gtest-nux-input-area.cpp	2012-09-18 18:08:22 +0000
@@ -0,0 +1,82 @@
+/*
+ * Copyright 2012 Canonical Ltd.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License version 3, as
+ * published by the  Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranties of
+ * MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR
+ * PURPOSE.  See the applicable version of the GNU Lesser General Public
+ * License for more details.
+ *
+ * You should have received a copy of both the GNU Lesser General Public
+ * License version 3 along with this program.  If not, see
+ * <http://www.gnu.org/licenses/>
+ *
+ * Authored by: Marco Trevisan <[e-mail]>
+ */
+
+#include <gmock/gmock.h>
+#include <boost/shared_ptr.hpp>
+#include "Nux/Nux.h"
+
+namespace {
+
+struct TestInputArea : public testing::Test
+{
+  void SetUp()
+  {
+    nux::NuxInitialize(0);
+    wnd_thread.reset(nux::CreateNuxWindow("InputArea Test", 300, 200, nux::WINDOWSTYLE_NORMAL,
+                                          NULL, false, NULL, NULL));
+    area = new nux::InputArea("InputArea");
+  }
+
+  boost::shared_ptr<nux::WindowThread> wnd_thread;
+  nux::ObjectPtr<nux::InputArea> area;
+};
+
+TEST_F(TestInputArea, GrabKeyboard)
+{
+  area->GrabKeyboard();
+  EXPECT_TRUE(nux::GetWindowCompositor().IsInKeyboardGrabStack(area.GetPointer()));
+}
+
+TEST_F(TestInputArea, GrabPointer)
+{
+  area->GrabPointer();
+  EXPECT_TRUE(nux::GetWindowCompositor().IsInPointerGrabStack(area.GetPointer()));
+}
+
+TEST_F(TestInputArea, UngrabsOnDestroy)
+{
+  nux::InputArea* area1 = new nux::InputArea("InputArea1");
+  nux::InputArea* area2 = new nux::InputArea("InputArea2");
+
+  // Adding some grabs
+  area1->GrabKeyboard();
+  area1->GrabPointer();
+  area2->GrabPointer();
+  area2->GrabKeyboard();
+  area1->GrabKeyboard();
+
+  ASSERT_TRUE(nux::GetWindowCompositor().IsInKeyboardGrabStack(area1));
+  ASSERT_TRUE(nux::GetWindowCompositor().IsInPointerGrabStack(area1));
+  ASSERT_TRUE(nux::GetWindowCompositor().IsInKeyboardGrabStack(area2));
+  ASSERT_TRUE(nux::GetWindowCompositor().IsInPointerGrabStack(area2));
+
+  // This should cleanup the references in the compositor
+  area1->UnReference();
+
+  EXPECT_FALSE(nux::GetWindowCompositor().IsInKeyboardGrabStack(area1));
+  EXPECT_FALSE(nux::GetWindowCompositor().IsInPointerGrabStack(area1));
+
+  area2->UnReference();
+
+  EXPECT_FALSE(nux::GetWindowCompositor().IsInKeyboardGrabStack(area2));
+  EXPECT_FALSE(nux::GetWindowCompositor().IsInPointerGrabStack(area2));
+}
+
+}