Merge lp:~mhr3/unity/fix-965492 into lp:unity

[Michal Hruby]

Ensure that the spinner is shown even for empty searches

The initial display of the home lens can take some time and during this time the user has no feedback that there's something going on inside the dash.

Whenever we display the dash, the Search() method of lenses is called, so we're properly notified when the search finishes (libunity makes sure of that). This allows us to display the spinner meanwhile, and user knows there's some activity going on.

Because of the timing nature of the change, there are no new tests, but at least existing tests still pass.

[Gord Allott (gordallott)]

+1 from me

review: Approve

=== modified file 'plugins/unityshell/src/DashView.cpp'
--- plugins/unityshell/src/DashView.cpp	2012-03-30 11:40:10 +0000
+++ plugins/unityshell/src/DashView.cpp	2012-04-04 15:50:26 +0000
@@ -146,6 +146,9 @@
     active_lens_view_->lens()->view_type = ViewType::LENS_VIEW;
   }
 
+  // this will make sure the spinner animates if the search takes a while
+  search_bar_->ForceSearchChanged();
+
   renderer_.AboutToShow();
 }
 
@@ -438,7 +441,7 @@
   LOG_DEBUG(logger) << "Live search reached: " << search_string;
   if (active_lens_view_)
   {
-    active_lens_view_->search_string = search_string;
+    active_lens_view_->PerformSearch(search_string);
   }
 }
 
@@ -491,6 +494,10 @@
 
   search_bar_->search_string = view->search_string;
   search_bar_->search_hint = view->lens()->search_hint;
+  // lenses typically return immediately from Search() if the search query
+  // doesn't change, so SearchFinished will be called in a few ms
+  // FIXME: if we're forcing a search here, why don't we get rid of view types?
+  search_bar_->ForceSearchChanged();
 
   bool expanded = view->filters_expanded;
   search_bar_->showing_filters = expanded;

=== modified file 'plugins/unityshell/src/LensView.cpp'
--- plugins/unityshell/src/LensView.cpp	2012-04-02 12:28:41 +0000
+++ plugins/unityshell/src/LensView.cpp	2012-04-04 15:50:26 +0000
@@ -117,7 +117,6 @@
 
 LensView::LensView()
   : nux::View(NUX_TRACKER_LOCATION)
-  , search_string("")
   , filters_expanded(false)
   , can_refine_search(false)
   , no_results_active_(false)
@@ -126,7 +125,6 @@
 
 LensView::LensView(Lens::Ptr lens, nux::Area* show_filters)
   : nux::View(NUX_TRACKER_LOCATION)
-  , search_string("")
   , filters_expanded(false)
   , can_refine_search(false)
   , lens_(lens)
@@ -142,7 +140,7 @@
   dash::Style::Instance().columns_changed.connect(sigc::mem_fun(this, &LensView::OnColumnsChanged));
 
   lens_->connected.changed.connect([&](bool is_connected) { if (is_connected) initial_activation_ = true; });
-  search_string.changed.connect([&](std::string const& search) { lens_->Search(search);  });
+  search_string.SetGetterFunction(sigc::mem_fun(this, &LensView::get_search_string));
   filters_expanded.changed.connect([&](bool expanded) { fscroll_view_->SetVisible(expanded); QueueRelayout(); OnColumnsChanged(); });
   view_type.changed.connect(sigc::mem_fun(this, &LensView::OnViewTypeChanged));
 
@@ -386,7 +384,7 @@
 {
   gint count = lens_->results()->count();
 
-  if (!count && !no_results_active_)
+  if (count == 0 && !no_results_active_ && !search_string_.empty())
   {
     std::stringstream markup;
     Lens::Hints::const_iterator it;
@@ -433,6 +431,17 @@
   }
 }
 
+void LensView::PerformSearch(std::string const& search_query)
+{
+  search_string_ = search_query;
+  lens_->Search(search_query);
+}
+
+std::string LensView::get_search_string() const
+{
+  return search_string_;
+}
+
 void LensView::OnGroupExpanded(PlacesGroup* group)
 {
   ResultViewGrid* grid = static_cast<ResultViewGrid*>(group->GetChildView());
@@ -467,7 +476,7 @@
   if (view_type != HIDDEN && initial_activation_)
   {
     /* We reset the lens for ourselves, in case this is a restart or something */
-    lens_->Search(search_string);
+    lens_->Search(search_string_);
     initial_activation_ = false;
   }
 

=== modified file 'plugins/unityshell/src/LensView.h'
--- plugins/unityshell/src/LensView.h	2012-03-21 14:18:06 +0000
+++ plugins/unityshell/src/LensView.h	2012-04-04 15:50:26 +0000
@@ -63,13 +63,14 @@
 
   virtual void ActivateFirst();
 
-  nux::Property<std::string> search_string;
+  nux::ROProperty<std::string> search_string;
   nux::Property<bool> filters_expanded;
   nux::Property<ViewType> view_type;
   nux::Property<bool> can_refine_search;
 
   sigc::signal<void, std::string const&> uri_activated;
 
+  void PerformSearch(std::string const& search_query);
   void CheckNoResults(Lens::Hints const& hints);
   void HideResultsMessage();
 
@@ -99,6 +100,8 @@
   virtual std::string GetName() const;
   virtual void AddProperties(GVariantBuilder* builder);
 
+  std::string get_search_string() const;
+
 private:
   UBusManager ubus_manager_;
   Lens::Ptr lens_;
@@ -106,6 +109,7 @@
   ResultCounts counts_;
   bool initial_activation_;
   bool no_results_active_;
+  std::string search_string_;
 
   nux::HLayout* layout_;
   LensScrollView* scroll_view_;

=== modified file 'plugins/unityshell/src/SearchBar.cpp'
--- plugins/unityshell/src/SearchBar.cpp	2012-03-27 15:20:51 +0000
+++ plugins/unityshell/src/SearchBar.cpp	2012-04-04 15:50:26 +0000
@@ -473,6 +473,30 @@
   activated.emit();
 }
 
+void SearchBar::ForceSearchChanged()
+{
+  // this method will emit search_changed (and live_search_reached after
+  // returning to mainloop) and starts animating the spinner
+
+  if (live_search_timeout_)
+    g_source_remove(live_search_timeout_);
+
+  live_search_timeout_ = g_idle_add_full(G_PRIORITY_DEFAULT,
+                                         (GSourceFunc)&OnLiveSearchTimeout,
+                                         this, NULL);
+
+  // Don't animate the spinner immediately, the searches are fast and
+  // the spinner would just flicker
+  if (start_spinner_timeout_)
+    g_source_remove(start_spinner_timeout_);
+
+  start_spinner_timeout_ = g_timeout_add(SPINNER_TIMEOUT * 2,
+                                         (GSourceFunc)&OnSpinnerStartCb,
+                                         this);
+
+  search_changed.emit(pango_entry_->GetText());
+}
+
 void
 SearchBar::SearchFinished()
 {

=== modified file 'plugins/unityshell/src/SearchBar.h'
--- plugins/unityshell/src/SearchBar.h	2012-03-27 15:09:26 +0000
+++ plugins/unityshell/src/SearchBar.h	2012-04-04 15:50:26 +0000
@@ -60,6 +60,7 @@
   SearchBar(bool show_filter_hint, NUX_FILE_LINE_PROTO);
   ~SearchBar();
 
+  void ForceSearchChanged();
   void SearchFinished();
   nux::TextEntry* text_entry() const;
   nux::View* show_filters() const;