Merge lp:~azzar1/unity/lp-1155659 into lp:unity

[Andrea Azzarone]

Add more unit tests for TooltipManager. Don't reset time on every mouse movement.
Also reduce tooltip timeout lenght.

== Problem ==
Tooltip timeout should not be resetted on each mouse movement.

== Test ==
unit tests added.

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

Works good, tests pass! :)

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'launcher/Launcher.cpp'
--- launcher/Launcher.cpp	2013-03-14 20:28:48 +0000
+++ launcher/Launcher.cpp	2013-03-15 15:34:25 +0000
@@ -303,7 +303,6 @@
     icon->mouse_enter.emit(monitor);
 
   _icon_under_mouse = icon;
-  tooltip_manager_.SetIcon(icon);
 }
 
 bool Launcher::MouseBeyondDragThreshold() const
@@ -2224,7 +2223,7 @@
 void Launcher::RecvMouseMove(int x, int y, int dx, int dy, unsigned long button_flags, unsigned long key_flags)
 {
   SetMousePosition(x, y);
-  tooltip_manager_.MouseMoved();
+  tooltip_manager_.MouseMoved(_icon_under_mouse);
 
   if (!_hidden)
     UpdateChangeInMousePosition(dx, dy);

=== modified file 'launcher/TooltipManager.cpp'
--- launcher/TooltipManager.cpp	2013-03-15 12:34:14 +0000
+++ launcher/TooltipManager.cpp	2013-03-15 15:34:25 +0000
@@ -15,6 +15,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  * Authored by: Jacob Edwards <[e-mail]>
+ *              Andrea Azzarone <[e-mail]>
  */
 
 #include "TooltipManager.h"
@@ -23,104 +24,69 @@
 {
 namespace launcher
 {
-
 namespace
 {
-const unsigned int TOOLTIPS_SHOW_TIMEOUT_LENGTH = 1000;
+const unsigned int TOOLTIPS_SHOW_TIMEOUT_LENGTH = 500;
 }
 
 TooltipManager::TooltipManager()
-  : show_tooltips_(false)
-  , hovered_(false)
-  , timer_locked_(false)
+  : skip_timeout_(false)
 {}
 
-void TooltipManager::SetIcon(AbstractLauncherIcon::Ptr const& new_icon)
-{ 
-  if (icon_ == new_icon)
-    return;
-
-  // Unlock hover timer, in case the previous icon had no valid tooltip
-  timer_locked_ = false;
- 
-  if (show_tooltips_)
-  {
-    // Show new tooltip, get rid of the old olne
-    if (icon_)
-      icon_->HideTooltip();
-    if (new_icon)
-      new_icon->ShowTooltip();
-  }
-  else if (!new_icon)
-  {
-    // Stop the hover timer for null launcher space
-    StopTimer();
-  }
-  else
-  { 
-    AbstractLauncherIcon::IconType type = new_icon->GetIconType();
-    if ((type == AbstractLauncherIcon::IconType::HOME ||
-         type == AbstractLauncherIcon::IconType::HUD) &&
-         new_icon->GetQuirk(AbstractLauncherIcon::Quirk::ACTIVE))
-    {
-      // Lock the hover timer for no valid tooltip cases
-      timer_locked_ = true;
-      StopTimer();
-    }
-  }
-
-  icon_ = new_icon;
-}
-
-void TooltipManager::SetHover(bool on_launcher)
-{ 
-  if (hovered_ == on_launcher)
-    return;
-  hovered_ = on_launcher;
-
-  if (show_tooltips_ && !hovered_)
-  {
-    show_tooltips_ = false;
-    if (icon_)
-      icon_->HideTooltip();
-  }
-}
-
-void TooltipManager::MouseMoved()
+void TooltipManager::MouseMoved(AbstractLauncherIcon::Ptr const& icon_under_mouse)
 {
-  if (!icon_ || show_tooltips_)
+  if (icon_ == icon_under_mouse)
     return;
 
-  ResetTimer();
+  StopTimer();
+  if (icon_)
+    icon_->HideTooltip();
+  
+  icon_ = icon_under_mouse;
+
+  if (icon_ && !skip_timeout_)
+    ResetTimer(icon_);
+  else if (icon_ && skip_timeout_)
+    icon_->ShowTooltip();
 }
 
 void TooltipManager::IconClicked()
 {
+  if (icon_)
+    icon_->HideTooltip();
+}
+
+void TooltipManager::SetHover(bool hovered)
+{
+  if (!hovered)
+    Reset();
+}
+
+void TooltipManager::Reset()
+{
   StopTimer();
-  if (show_tooltips_ && icon_)
+
+  if (icon_)
     icon_->HideTooltip();
 
-  show_tooltips_ = false;
-  timer_locked_ = true;
+  icon_ = AbstractLauncherIcon::Ptr();
+  skip_timeout_ = false;
 }
 
-void TooltipManager::ResetTimer()
+void TooltipManager::ResetTimer(AbstractLauncherIcon::Ptr const& icon_under_mouse)
 {
-  if (timer_locked_)
-    return;
-
   hover_timer_.reset(new glib::Timeout(TOOLTIPS_SHOW_TIMEOUT_LENGTH));
   hover_timer_->Run([&] () {
-    show_tooltips_ = true;
-    icon_->ShowTooltip();
+    skip_timeout_ = true;
+    icon_under_mouse->ShowTooltip();
     return false;
   });
-}
-
+ }
+ 
 void TooltipManager::StopTimer()
 {
-  hover_timer_.reset();
+  hover_timer_.reset(); 
 }
 
-} // namespace launcher
-} // namespace unity
+}
+}

=== modified file 'launcher/TooltipManager.h'
--- launcher/TooltipManager.h	2013-03-15 12:34:14 +0000
+++ launcher/TooltipManager.h	2013-03-15 15:34:25 +0000
@@ -15,10 +15,11 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  * Authored by: Jacob Edwards <[e-mail]>
+ *              Andrea Azzarone <[e-mail]>
  */
 
-#ifndef TOOLTIPMANAGER
-#define TOOLTIPMANAGER
+#ifndef LAUNCHER_TOOLTIP_MANAGER_H
+#define LAUNCHER_TOOLTIP_MANAGER_H
 
 #include <boost/noncopyable.hpp>
 #include <UnityCore/GLibSource.h>
@@ -35,23 +36,21 @@
 public:
   TooltipManager();
 
-  void SetHover(bool on_launcher);
-  void SetIcon(AbstractLauncherIcon::Ptr const& new_icon);
-  void MouseMoved();
+  void SetHover(bool hovered);
+  void MouseMoved(AbstractLauncherIcon::Ptr const& icon_under_mouse);
   void IconClicked();
 
 private:
-  void ResetTimer();
+  void Reset();
+  void ResetTimer(AbstractLauncherIcon::Ptr const& icon_under_mouse);
   void StopTimer();
 
-  bool show_tooltips_;
-  bool hovered_;
+  bool skip_timeout_;
   AbstractLauncherIcon::Ptr icon_;
   glib::Source::UniquePtr hover_timer_;
-  bool timer_locked_;
 };
 
-} // namespace launcher
-} // namespace unity 
+}
+}
 
 #endif

=== modified file 'tests/test_tooltip_manager.cpp'
--- tests/test_tooltip_manager.cpp	2013-03-05 18:51:05 +0000
+++ tests/test_tooltip_manager.cpp	2013-03-15 15:34:25 +0000
@@ -15,40 +15,79 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
  * Authored by: Jacob Edwards <[e-mail]>
+ *              Andrea Azzarone <[e-mail]>
  */
 
-#include <gtest/gtest.h>
+#include <gmock/gmock.h>
 using namespace testing;
 
 #include "launcher/TooltipManager.h"
 #include "launcher/MockLauncherIcon.h"
+using unity::launcher::MockLauncherIcon;
+using unity::launcher::TooltipManager;
+
 #include "test_utils.h"
 
-namespace unity
-{
-namespace launcher
-{
-
 namespace
 {
 
-TEST(TestTooltipManager, TestHideAndShowTooltip)
-{
-  // Makes sure that TooltipManager calls icon->ShowTooltip() when the mouse
-  // hovers it, and icon->HideTooltip() after the mouse dehovers it.
-  TooltipManager tm;
-  MockLauncherIcon* icon = new MockLauncherIcon();
-
-  tm.SetIcon(AbstractLauncherIcon::Ptr(icon));
-  tm.MouseMoved();
-  Utils::WaitForTimeoutMSec(1050);
-
-  EXPECT_TRUE(icon->IsTooltipVisible());
-  tm.SetIcon(AbstractLauncherIcon::Ptr());
-  EXPECT_FALSE(icon->IsTooltipVisible());
-}
-
-}
-
-} // launcher
-} // unity
+bool CheckIsTooltipVisible(nux::ObjectPtr<MockLauncherIcon> const& icon, bool value) {
+  return icon->IsTooltipVisible() == value;
+}
+
+struct TestTooltipManager : public Test {
+  TooltipManager tooltip_manager;
+};
+
+TEST_F(TestTooltipManager, MouseMoved)
+{
+  nux::ObjectPtr<MockLauncherIcon> icon1(new MockLauncherIcon());
+  nux::ObjectPtr<MockLauncherIcon> icon2(new MockLauncherIcon());
+
+  tooltip_manager.MouseMoved(icon1);
+  ASSERT_FALSE(icon1->IsTooltipVisible()); // don't skip the timeout!
+  Utils::WaitUntil(std::bind(CheckIsTooltipVisible, icon1, true));
+  Utils::WaitUntil(std::bind(CheckIsTooltipVisible, icon2, false));
+
+  tooltip_manager.MouseMoved(icon2);
+  ASSERT_FALSE(icon1->IsTooltipVisible());
+  ASSERT_TRUE(icon2->IsTooltipVisible());
+
+  tooltip_manager.MouseMoved(nux::ObjectPtr<MockLauncherIcon>());
+  ASSERT_FALSE(icon1->IsTooltipVisible());
+  ASSERT_FALSE(icon2->IsTooltipVisible());
+
+  tooltip_manager.MouseMoved(icon1);
+  ASSERT_TRUE(icon1->IsTooltipVisible());
+  ASSERT_FALSE(icon2->IsTooltipVisible());
+}
+
+TEST_F(TestTooltipManager, IconClicked)
+{
+  nux::ObjectPtr<MockLauncherIcon> icon(new MockLauncherIcon());
+
+  tooltip_manager.MouseMoved(icon);
+  ASSERT_FALSE(icon->IsTooltipVisible()); // don't skip the timeout!
+  Utils::WaitUntil(std::bind(CheckIsTooltipVisible, icon, true));
+
+  tooltip_manager.IconClicked();
+  ASSERT_FALSE(icon->IsTooltipVisible());
+}
+
+TEST_F(TestTooltipManager, SetHover)
+{
+  nux::ObjectPtr<MockLauncherIcon> icon(new MockLauncherIcon());
+
+  tooltip_manager.MouseMoved(icon);
+  ASSERT_FALSE(icon->IsTooltipVisible()); // don't skip the timeout!
+  Utils::WaitUntil(std::bind(CheckIsTooltipVisible, icon, true));
+
+  tooltip_manager.SetHover(false);
+  ASSERT_FALSE(icon->IsTooltipVisible());
+
+  tooltip_manager.MouseMoved(icon);
+  ASSERT_FALSE(icon->IsTooltipVisible()); // don't skip the timeout!
+  Utils::WaitUntil(std::bind(CheckIsTooltipVisible, icon, true));
+}
+
+}