Merge lp:~azzar1/unity/hud-reset-5.0 into lp:unity/5.0

[Andrea Azzarone]

Backport lp:~andyrock/unity/hud-reset

== Problem ==
Hud flickers when show up. Read the bug description for more info.

== Test ==
Unity test added. I had to add an hud::AbstractView class to do it.

[Tim Penhey (thumper)]

review: Approve

=== added file 'plugins/unityshell/src/HudAbstractView.cpp'
--- plugins/unityshell/src/HudAbstractView.cpp	1970-01-01 00:00:00 +0000
+++ plugins/unityshell/src/HudAbstractView.cpp	2012-06-15 18:20:23 +0000
@@ -0,0 +1,33 @@
+/*
+ * Copyright (C) 2012 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU 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 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.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Andrea Azzarone <[e-mail]>
+ */
+
+#include "HudAbstractView.h"
+
+namespace unity
+{
+namespace hud
+{
+
+NUX_IMPLEMENT_OBJECT_TYPE(AbstractView);
+
+AbstractView::AbstractView()
+  : nux::View(NUX_TRACKER_LOCATION)
+{}
+
+} // namespace hud
+} // namespace unity

=== added file 'plugins/unityshell/src/HudAbstractView.h'
--- plugins/unityshell/src/HudAbstractView.h	1970-01-01 00:00:00 +0000
+++ plugins/unityshell/src/HudAbstractView.h	2012-06-15 18:20:23 +0000
@@ -0,0 +1,66 @@
+/*
+ * Copyright (C) 2012 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU 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 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.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Andrea Azzarone <[e-mail]>
+ */
+
+#ifndef UNITYSHELL_HUD_ABSTRACT_VIEW_H
+#define UNITYSHELL_HUD_ABSTRACT_VIEW_H
+
+#include <memory>
+#include <string>
+
+#include <Nux/Nux.h>
+#include <Nux/View.h>
+#include <UnityCore/Hud.h>
+
+#include "Introspectable.h"
+
+namespace unity
+{
+namespace hud
+{
+
+class AbstractView : public nux::View, public unity::debug::Introspectable
+{
+  NUX_DECLARE_OBJECT_TYPE(AbstractView, nux::View);
+public:
+  typedef nux::ObjectPtr<AbstractView> Ptr;
+
+  AbstractView();
+
+  virtual void AboutToShow() = 0;
+  virtual void AboutToHide() = 0;
+  virtual void Relayout() = 0;
+  virtual void ResetToDefault() = 0;
+  virtual void SearchFinished() = 0;
+  virtual void SetIcon(std::string const& icon_name, unsigned int tile_size, unsigned int size, unsigned int padding) = 0;
+  virtual void SetQueries(Hud::Queries queries) = 0;
+  virtual void SetWindowGeometry(nux::Geometry const& absolute_geo, nux::Geometry const& geo) = 0;
+  virtual void ShowEmbeddedIcon(bool show) = 0;
+
+  virtual nux::View* default_focus() const = 0;
+
+  // signals
+  sigc::signal<void, std::string> search_changed;
+  sigc::signal<void, std::string> search_activated;
+  sigc::signal<void, Query::Ptr> query_activated;
+  sigc::signal<void, Query::Ptr> query_selected;
+};
+
+} // namespace hud
+} // namespace unity
+
+#endif // UNITYSHELL_HUD_ABSTRACT_VIEW_H

=== modified file 'plugins/unityshell/src/HudController.cpp'
--- plugins/unityshell/src/HudController.cpp	2012-04-24 11:37:05 +0000
+++ plugins/unityshell/src/HudController.cpp	2012-06-15 18:20:23 +0000
@@ -16,12 +16,14 @@
  * Authored by: Gord Allott <[e-mail]>
  */
 
+#include <config.h>
+
 #include "HudController.h"
 
 #include <NuxCore/Logger.h>
 #include <Nux/HLayout.h>
 #include <UnityCore/Variant.h>
-#include "PluginAdapter.h"
+#include "WindowManager.h"
 #include "PanelStyle.h"
 #include "UBusMessages.h"
 #include "UScreen.h"
@@ -38,7 +40,7 @@
 nux::logging::Logger logger("unity.hud.controller");
 }
 
-Controller::Controller()
+Controller::Controller(std::function<AbstractView*(void)> const& function)
   : launcher_width(64)
   , launcher_locked_out(false)
   , multiple_launchers(true)
@@ -52,6 +54,7 @@
   , view_(nullptr)
   , monitor_index_(0)
   , type_wait_handle_(0)
+  , view_function_(function)
 {
   LOG_DEBUG(logger) << "hud startup";
   SetupWindow();
@@ -76,7 +79,7 @@
 
   launcher_width.changed.connect([&] (int new_width) { Relayout(); });
 
-  PluginAdapter::Default()->compiz_screen_ungrabbed.connect(sigc::mem_fun(this, &Controller::OnScreenUngrabbed));
+  WindowManager::Default()->compiz_screen_ungrabbed.connect(sigc::mem_fun(this, &Controller::OnScreenUngrabbed));
 
   hud_service_.queries_updated.connect(sigc::mem_fun(this, &Controller::OnQueriesFinished));
   EnsureHud();
@@ -109,16 +112,16 @@
   window_->mouse_down_outside_pointer_grab_area.connect(sigc::mem_fun(this, &Controller::OnMouseDownOutsideWindow));
   
   /* FIXME - first time we load our windows there is a race that causes the input window not to actually get input, this side steps that by causing an input window show and hide before we really need it. */
-  PluginAdapter::Default()->saveInputFocus ();
+  WindowManager::Default()->saveInputFocus ();
   window_->EnableInputWindow(true, "Hud", true, false);
   window_->EnableInputWindow(false, "Hud", true, false);
-  PluginAdapter::Default()->restoreInputFocus ();
+  WindowManager::Default()->restoreInputFocus ();
 }
 
 void Controller::SetupHudView()
 {
   LOG_DEBUG(logger) << "SetupHudView called";
-  view_ = new View();
+  view_ = view_function_();
 
   layout_ = new nux::VLayout(NUX_TRACKER_LOCATION);
   layout_->AddView(view_, 1, nux::MINOR_POSITION_TOP);
@@ -274,7 +277,7 @@
 
 void Controller::ShowHud()
 {
-  PluginAdapter* adaptor = PluginAdapter::Default();
+  WindowManager* adaptor = WindowManager::Default();
   LOG_DEBUG(logger) << "Showing the hud";
   EnsureHud();
 
@@ -397,7 +400,7 @@
 
   restore = true;
   if (restore)
-    PluginAdapter::Default ()->restoreInputFocus ();
+    WindowManager::Default ()->restoreInputFocus ();
 
   hud_service_.CloseQuery();
 
@@ -447,6 +450,7 @@
     if (!self->visible_)
     {
       self->window_->ShowWindow(false);
+      self->view_->ResetToDefault();
     }
     else
     {

=== modified file 'plugins/unityshell/src/HudController.h'
--- plugins/unityshell/src/HudController.h	2012-04-23 00:24:52 +0000
+++ plugins/unityshell/src/HudController.h	2012-06-15 18:20:23 +0000
@@ -16,9 +16,10 @@
  * Authored by: Neil Jagdish Patel <[e-mail]>
  */
 
-#ifndef UNITY_HUD_CONTROLLER_H_
-#define UNITY_HUD_CONTROLLER_H_
+#ifndef UNITYSHELL_HUD_CONTROLLER_H
+#define UNITYSHELL_HUD_CONTROLLER_H
 
+#include <functional>
 #include <memory>
 
 #include <gdk/gdk.h>
@@ -42,7 +43,7 @@
 public:
   typedef std::shared_ptr<Controller> Ptr;
 
-  Controller();
+  Controller(std::function<AbstractView*(void)> const& function = []() { return new View; });
   ~Controller();
 
   nux::BaseWindow* window() const;
@@ -59,6 +60,7 @@
   bool IsVisible();
 
 protected:
+  // Introspectable
   std::string GetName() const;
   void AddProperties(GVariantBuilder* builder);
 
@@ -104,16 +106,19 @@
   float last_opacity_;
   gint64 start_time_;
 
-  View* view_;
+  AbstractView* view_;
   guint ensure_id_;
   std::string focused_app_icon_;
   nux::Layout* layout_;
   uint monitor_index_;
   guint type_wait_handle_;
   std::string last_search_;
+
+  std::function<AbstractView*(void)> view_function_;
 };
 
-
-}
-}
-#endif
+} // namespace hud
+} // namespace unity
+
+#endif // UNITYSHELL_HUD_CONTROLLER_H
+

=== modified file 'plugins/unityshell/src/HudView.cpp'
--- plugins/unityshell/src/HudView.cpp	2012-06-06 15:37:05 +0000
+++ plugins/unityshell/src/HudView.cpp	2012-06-15 18:20:23 +0000
@@ -25,9 +25,8 @@
 #include <UnityCore/GLibWrapper.h>
 #include <UnityCore/Variant.h>
 #include <Nux/HLayout.h>
+#include <Nux/VLayout.h>
 
-#include <NuxCore/Logger.h>
-#include "HudButton.h"
 #include "UBusMessages.h"
 #include "DashStyle.h"
 
@@ -38,7 +37,9 @@
 
 namespace
 {
+
 nux::logging::Logger logger("unity.hud.view");
+
 const int grow_anim_length = 90 * 1000;
 const int pause_before_grow_length = 32 * 1000;
 
@@ -50,12 +51,13 @@
 const int bottom_padding = 10;
 const int left_padding = 11;
 const int right_padding = 0;
+
 }
 
 NUX_IMPLEMENT_OBJECT_TYPE(View);
 
 View::View()
-  : nux::View(NUX_TRACKER_LOCATION)
+  : AbstractView()
   , button_views_(NULL)
   , timeline_id_(0)
   , start_time_(0)
@@ -70,11 +72,6 @@
     QueueDraw();
   });
 
-  nux::ROPConfig rop;
-  rop.Blend = true;
-  rop.SrcBlend = GL_ONE;
-  rop.DstBlend = GL_ONE_MINUS_SRC_ALPHA;
-
   SetupViews();
   search_bar_->key_down.connect (sigc::mem_fun (this, &View::OnKeyDown));
 
@@ -171,6 +168,9 @@
 
 void View::ResetToDefault()
 {
+  SetQueries(Hud::Queries());
+  current_height_ = content_layout_->GetBaseHeight();
+
   search_bar_->search_string = "";
   search_bar_->search_hint = _("Type your command");
 }
@@ -277,7 +277,7 @@
   QueueDraw();
 }
 
-void View::SetIcon(std::string icon_name, unsigned int tile_size, unsigned int size, unsigned int padding)
+void View::SetIcon(std::string const& icon_name, unsigned int tile_size, unsigned int size, unsigned int padding)
 {
   if (!icon_)
     return;
@@ -401,10 +401,9 @@
   LOG_DEBUG(logger) << "got search change";
   search_changed.emit(search_string);
 
-  std::list<HudButton::Ptr>::iterator it;
-  for(it = buttons_.begin(); it != buttons_.end(); ++it)
+  for (auto button : buttons_)
   {
-    (*it)->fake_focused = false;
+    button->fake_focused = false;
   }
   
   if (!buttons_.empty())

=== modified file 'plugins/unityshell/src/HudView.h'
--- plugins/unityshell/src/HudView.h	2012-06-06 15:37:05 +0000
+++ plugins/unityshell/src/HudView.h	2012-06-15 18:20:23 +0000
@@ -16,34 +16,32 @@
  * Authored by: Gordon Allott <[e-mail]>
  */
 
-#ifndef UNITY_HUD_VIEW_H_
-#define UNITY_HUD_VIEW_H_
+#ifndef UNITYSHELL_HUD_VIEW_H
+#define UNITYSHELL_HUD_VIEW_H
 
 #include <string>
 
 #include <Nux/Nux.h>
-#include <Nux/View.h>
 #include <Nux/VLayout.h>
 
-#include <UnityCore/Hud.h>
-#include "Introspectable.h"
-
-#include "UBusWrapper.h"
+#include "HudAbstractView.h"
 #include "HudIcon.h"
 #include "HudButton.h"
 #include "SearchBar.h"
 #include "OverlayRenderer.h"
+#include "UBusWrapper.h"
 
 namespace unity
 {
 namespace hud
 {
 
-class View : public nux::View, public unity::debug::Introspectable
+class View : public AbstractView
 {
-  NUX_DECLARE_OBJECT_TYPE(HudView, nux::View);
+  NUX_DECLARE_OBJECT_TYPE(HudView, AbstractView);
+public:
   typedef nux::ObjectPtr<View> Ptr;
-public:
+
   View();
   ~View();
 
@@ -54,7 +52,7 @@
   std::list<HudButton::Ptr> const& buttons() const;
 
   void SetQueries(Hud::Queries queries);
-  void SetIcon(std::string icon_name, unsigned int tile_size, unsigned int size, unsigned int padding);
+  void SetIcon(std::string const& icon_name, unsigned int tile_size, unsigned int size, unsigned int padding);
   void ShowEmbeddedIcon(bool show);
   void SearchFinished();
 
@@ -62,11 +60,6 @@
   void AboutToHide();
 
   void SetWindowGeometry(nux::Geometry const& absolute_geo, nux::Geometry const& geo);
-
-  sigc::signal<void, std::string> search_changed;
-  sigc::signal<void, std::string> search_activated;
-  sigc::signal<void, Query::Ptr> query_activated;
-  sigc::signal<void, Query::Ptr> query_selected;
   
 protected:
   virtual Area* FindKeyFocusArea(unsigned int event_type,
@@ -76,6 +69,7 @@
   void SetupViews();
   void OnSearchChanged(std::string const& search_string);
   virtual long PostLayoutManagement(long LayoutResult);
+
 private:
   void OnMouseButtonDown(int x, int y, unsigned long button, unsigned long key);
   void OnKeyDown (unsigned long event_type, unsigned long event_keysym,
@@ -121,7 +115,8 @@
   bool activated_signal_sent_;
 };
 
-
-}
-}
-#endif
+} // namespace hud
+} // namespace unity
+
+#endif // UNITYSHELL_HUD_VIEW_H
+

=== modified file 'plugins/unityshell/src/WindowManager.cpp'
--- plugins/unityshell/src/WindowManager.cpp	2012-04-26 05:56:55 +0000
+++ plugins/unityshell/src/WindowManager.cpp	2012-06-15 18:20:23 +0000
@@ -220,6 +220,16 @@
     g_debug("%s", G_STRFUNC);
   }
 
+  bool saveInputFocus()
+  {
+    return false;
+  }
+
+  bool restoreInputFocus()
+  {
+    return false;
+  }
+
   void AddProperties(GVariantBuilder* builder)
   {
   }

=== modified file 'plugins/unityshell/src/WindowManager.h'
--- plugins/unityshell/src/WindowManager.h	2012-04-26 05:56:55 +0000
+++ plugins/unityshell/src/WindowManager.h	2012-06-15 18:20:23 +0000
@@ -106,6 +106,8 @@
 
   virtual int WorkspaceCount() = 0;
 
+  virtual bool saveInputFocus() = 0;
+  virtual bool restoreInputFocus() = 0;
 
   // Signals
   sigc::signal<void, guint32> window_mapped;

=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2012-06-06 15:37:05 +0000
+++ tests/CMakeLists.txt	2012-06-15 18:20:23 +0000
@@ -197,6 +197,7 @@
 # Tests that require X
   add_executable(test-gtest
                  test_hud_button.cpp
+                 test_hud_controller.cpp
                  test_dashview_impl.cpp
                  test_texture_cache.cpp
                  test_main.cpp
@@ -209,6 +210,7 @@
                  test_switcher_model.cpp
                  ${UNITY_SRC}/AbstractLauncherIcon.cpp
                  ${UNITY_SRC}/AbstractPlacesGroup.cpp
+                 ${UNITY_SRC}/Animator.cpp
                  ${UNITY_SRC}/BackgroundEffectHelper.cpp
                  ${UNITY_SRC}/CairoBaseWindow.cpp
                  ${UNITY_SRC}/DashSettings.cpp
@@ -224,7 +226,9 @@
                  ${UNITY_SRC}/IconTextureSource.cpp
                  ${UNITY_SRC}/IMTextEntry.cpp
                  ${UNITY_SRC}/Introspectable.cpp
+                 ${UNITY_SRC}/HudAbstractView.cpp
                  ${UNITY_SRC}/HudButton.cpp
+                 ${UNITY_SRC}/HudController.cpp
                  ${UNITY_SRC}/HudIcon.cpp
                  ${UNITY_SRC}/HudIconTextureSource.cpp
                  ${UNITY_SRC}/HudPrivate.cpp

=== added file 'tests/test_hud_controller.cpp'
--- tests/test_hud_controller.cpp	1970-01-01 00:00:00 +0000
+++ tests/test_hud_controller.cpp	2012-06-15 18:20:23 +0000
@@ -0,0 +1,87 @@
+/*
+ * 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: Andrea Azzarone <[e-mail]>
+ *
+ */
+
+#include <gmock/gmock.h>
+using namespace testing;
+
+#include "HudController.h"
+#include "DashStyle.h"
+#include "PanelStyle.h"
+#include "DashSettings.h"
+#include "WindowManager.h"
+#include "test_utils.h"
+using namespace unity;
+
+namespace
+{
+
+class MockHudView : public hud::AbstractView
+{
+public:
+  typedef nux::ObjectPtr<MockHudView> Ptr;
+
+  MOCK_METHOD0(AboutToShow, void());
+  MOCK_METHOD0(AboutToHide, void());
+  MOCK_METHOD0(Relayout, void());
+  MOCK_METHOD0(ResetToDefault, void());
+  MOCK_METHOD0(SearchFinished, void());
+  MOCK_METHOD4(SetIcon, void(std::string const&, unsigned int tile_size, unsigned int size, unsigned int padding));
+  MOCK_METHOD1(SetQueries, void(hud::Hud::Queries queries));
+  MOCK_METHOD2(SetWindowGeometry, void(nux::Geometry const& absolute_geo, nux::Geometry const& geo));
+  MOCK_METHOD1(ShowEmbeddedIcon, void(bool show));
+  MOCK_CONST_METHOD0(default_focus, nux::View*());
+  MOCK_CONST_METHOD0(GetName, std::string());
+  MOCK_METHOD1(AddProperties, void(GVariantBuilder*));
+  MOCK_METHOD2(Draw, void(nux::GraphicsEngine&, bool));
+
+};
+
+class TestHudController : public Test
+{
+public:
+  virtual void SetUp()
+  {
+    WindowManager::SetDefault(WindowManager::Default());
+    view = new MockHudView;
+    controller.reset(new hud::Controller([&view]{ return view.GetPointer(); }));
+  }
+
+  dash::Settings unity_settings;
+  dash::Style dash_style;
+  panel::Style panel_style;
+
+  hud::Controller::Ptr controller;
+  MockHudView::Ptr view;
+};
+
+TEST_F(TestHudController, TestHideHud)
+{
+  controller->ShowHud();
+
+  EXPECT_CALL(*view, ResetToDefault())
+    .Times(1);
+
+  controller->HideHud();
+  // view->ResetToDefault should be called at the end of the fade out effect. So wait for it.
+  Utils::WaitForTimeout(2);
+}
+
+}

=== modified file 'tests/test_main.cpp'
--- tests/test_main.cpp	2012-05-23 13:11:59 +0000
+++ tests/test_main.cpp	2012-06-15 18:20:23 +0000
@@ -1,12 +1,13 @@
 #include <gtest/gtest.h>
 #include <gio/gio.h>
+#include <gtk/gtk.h>
 #include <NuxCore/Logger.h>
 #include <Nux/Nux.h>
 
 int main(int argc, char** argv)
 {
   ::testing::InitGoogleTest(&argc, argv);
-  g_type_init();
+  gtk_init(&argc, &argv);
   
   nux::NuxInitialize (0);
   nux::WindowThread* wnd_thread = nux::CreateNuxWindow("Tests", 300, 200, nux::WINDOWSTYLE_NORMAL, NULL, false, NULL, NULL);