Merge lp:~nick-dedekind/unity/smart-scopes.static-resultview-focus into lp:~unity-team/unity/libunity-7.0-breakage

[Nick Dedekind]

Save/Restore dash category focus when adding/removing/reordering categories.

Save/Restore dash category focus when adding/removing/reordering categories.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:3122
http://jenkins.qa.ubuntu.com/job/unity-team-unity-libunity-7.0-breakage-ci/65/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-team-unity-libunity-7.0-breakage-raring-amd64-ci/65/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-unity-libunity-7.0-breakage-ci/65/rebuild

review: Needs Fixing (continuous-integration)

[Nick Dedekind (nick-dedekind)]

requires Nux r779 or above.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:3124
http://jenkins.qa.ubuntu.com/job/unity-team-unity-libunity-7.0-breakage-ci/66/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-team-unity-libunity-7.0-breakage-raring-amd64-ci/66/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-unity-libunity-7.0-breakage-ci/66/rebuild

review: Needs Fixing (continuous-integration)

[Nick Dedekind (nick-dedekind)]

Fixed issue with category visibility changes.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:3125
http://jenkins.qa.ubuntu.com/job/unity-team-unity-libunity-7.0-breakage-ci/69/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-team-unity-libunity-7.0-breakage-raring-amd64-ci/69/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-unity-libunity-7.0-breakage-ci/69/rebuild

review: Needs Fixing (continuous-integration)

[Andrea Azzarone (azzar1)]

LGTM and works here.

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/unity-team-unity-libunity-7.0-breakage-autolanding/58/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-team-unity-libunity-7.0-breakage-raring-amd64-autolanding/58/console

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/unity-team-unity-libunity-7.0-breakage-autolanding/59/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-team-unity-libunity-7.0-breakage-raring-amd64-autolanding/59/console

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3126
http://jenkins.qa.ubuntu.com/job/unity-team-unity-libunity-7.0-breakage-ci/78/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-unity-libunity-7.0-breakage-raring-amd64-ci/78

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-unity-libunity-7.0-breakage-ci/78/rebuild

review: Approve (continuous-integration)

[Michal Hruby (mhr3)]

review: Approve

=== modified file 'dash/DashView.cpp'
--- dash/DashView.cpp	2013-04-25 15:31:32 +0000
+++ dash/DashView.cpp	2013-05-03 17:13:27 +0000
@@ -153,6 +153,12 @@
     scopes_->scope_added.connect(sigc::mem_fun(this, &DashView::OnScopeAdded));
     scopes_->LoadScopes();
   }
+
+  // If nux resets the focus, we need to set it back to the default focus item.
+  nux::GetWindowCompositor().key_nav_focus_change.connect([this](nux::Area *area, bool has_focus, nux::KeyNavDirection direction) {
+    if (visible_ && !area)
+      nux::GetWindowCompositor().SetKeyFocusArea(default_focus());
+  });
 }
 
 DashView::~DashView()

=== modified file 'dash/PlacesGroup.cpp'
--- dash/PlacesGroup.cpp	2013-03-22 12:44:53 +0000
+++ dash/PlacesGroup.cpp	2013-05-03 17:13:27 +0000
@@ -661,5 +661,40 @@
   wrapper.add("name-label-baseline", _name->GetBaseline());
 }
 
+glib::Variant PlacesGroup::GetCurrentFocus() const
+{
+  if (_header_view && _header_view->HasKeyFocus())
+  {
+    return g_variant_new_string("HeaderView");
+  }
+  else if (_child_view && _child_view->HasKeyFocus())
+  {
+    return g_variant_new("(si)", "ResultView", _child_view->GetSelectedIndex());
+  }
+  return glib::Variant();
+}
+
+void PlacesGroup::SetCurrentFocus(glib::Variant const& variant)
+{
+  if (g_variant_is_of_type(variant, G_VARIANT_TYPE_STRING))
+  {
+    std::string str = glib::gchar_to_string(g_variant_get_string(variant, NULL));
+    if (str == "HeaderView" && _header_view)
+      nux::GetWindowCompositor().SetKeyFocusArea(_header_view);
+  }
+  else if (g_variant_is_of_type(variant, G_VARIANT_TYPE("(si)")))
+  {
+    glib::String str;
+
+    gint32 index;
+    g_variant_get(variant, "(si)", &str, &index);
+    if (str.Str() == "ResultView" && _child_view)
+    {
+      _child_view->SetSelectedIndex(index);
+      nux::GetWindowCompositor().SetKeyFocusArea(_child_view);
+    }
+  }
+}
+
 } // namespace dash
 } // namespace unity

=== modified file 'dash/PlacesGroup.h'
--- dash/PlacesGroup.h	2013-03-11 17:20:46 +0000
+++ dash/PlacesGroup.h	2013-05-03 17:13:27 +0000
@@ -92,6 +92,9 @@
 
   sigc::signal<void, PlacesGroup*> expanded;
 
+  glib::Variant GetCurrentFocus() const;
+  void SetCurrentFocus(glib::Variant const& variant);
+
 protected:
   long ComputeContentSize();
 

=== modified file 'dash/ResultRendererTile.cpp'
--- dash/ResultRendererTile.cpp	2013-01-18 17:31:00 +0000
+++ dash/ResultRendererTile.cpp	2013-05-03 17:13:27 +0000
@@ -267,6 +267,14 @@
   glib::Object<GIcon> icon(g_icon_new_for_string(icon_name.c_str(), NULL));
   TextureContainer* container = row.renderer<TextureContainer*>();
 
+  if (container)
+  {
+    TextureCache& cache = TextureCache::GetDefault();
+    
+    BaseTexturePtr texture_prelight(cache.FindTexture("resultview_prelight", style.GetTileIconHightlightWidth(), style.GetTileIconHightlightHeight(),  sigc::mem_fun(this, &ResultRendererTile::DrawHighlight)));
+    container->prelight = texture_prelight;
+  }
+
   IconLoader::IconLoaderCallback slot = sigc::bind(sigc::mem_fun(this, &ResultRendererTile::IconLoaded), icon_hint, row);
 
   if (icon.IsType(G_TYPE_ICON))
@@ -363,18 +371,13 @@
 {
   TextureContainer *container = row.renderer<TextureContainer*>();
 
-  dash::Style& style = dash::Style::Instance();
-
   if (pixbuf && container)
   {
     TextureCache& cache = TextureCache::GetDefault();
     BaseTexturePtr texture(cache.FindTexture(icon_name, max_width, max_height,
                            sigc::bind(sigc::mem_fun(this, &ResultRendererTile::CreateTextureCallback), pixbuf)));
 
-    BaseTexturePtr texture_prelight(cache.FindTexture("resultview_prelight", style.GetTileIconHightlightWidth(), style.GetTileIconHightlightHeight(),  sigc::mem_fun(this, &ResultRendererTile::DrawHighlight)));
-
     container->icon = texture;
-    container->prelight = texture_prelight;
     container->drag_icon = pixbuf;
 
     NeedsRedraw.emit();

=== modified file 'dash/ResultView.cpp'
--- dash/ResultView.cpp	2013-04-24 16:47:23 +0000
+++ dash/ResultView.cpp	2013-05-03 17:13:27 +0000
@@ -123,6 +123,15 @@
   }
 }
 
+int ResultView::GetSelectedIndex() const
+{
+  return -1;
+}
+
+void ResultView::SetSelectedIndex(int index)
+{  
+}
+
 unsigned ResultView::GetNumResults()
 {
   if (result_model_)

=== modified file 'dash/ResultView.h'
--- dash/ResultView.h	2013-04-24 16:47:23 +0000
+++ dash/ResultView.h	2013-05-03 17:13:27 +0000
@@ -86,6 +86,9 @@
   void AddProperties(GVariantBuilder* builder);
   IntrospectableList GetIntrospectableChildren();
 
+  virtual int GetSelectedIndex() const;
+  virtual void SetSelectedIndex(int index);
+
   virtual void Activate(LocalResult const& local_result, int index, ActivateType type) = 0;
 
   std::vector<ResultViewTexture::Ptr> const& GetResultTextureContainers();

=== modified file 'dash/ResultViewGrid.cpp'
--- dash/ResultViewGrid.cpp	2013-04-17 15:10:39 +0000
+++ dash/ResultViewGrid.cpp	2013-05-03 17:13:27 +0000
@@ -942,12 +942,33 @@
 }
 
 int
-ResultViewGrid::GetSelectedIndex()
+ResultViewGrid::GetSelectedIndex() const
 {
   return selected_index_;
 }
 
 void
+ResultViewGrid::SetSelectedIndex(int index)
+{
+  unsigned num_results = GetNumResults();
+  if (num_results == 0)
+  {
+    focused_result_ = LocalResult();
+    index = -1;
+  }
+  else
+  {
+    if (index >= 0 && (unsigned)index >= num_results)
+      index = num_results-1;
+
+    ResultIterator iter(GetIteratorAtRow(index));
+    focused_result_ = (*iter);
+  }
+
+  selected_index_ = index;
+}
+
+void
 ResultViewGrid::UpdateRenderTextures()
 {
   nux::Geometry root_geo(GetAbsoluteGeometry());

=== modified file 'dash/ResultViewGrid.h'
--- dash/ResultViewGrid.h	2013-03-27 11:18:56 +0000
+++ dash/ResultViewGrid.h	2013-05-03 17:13:27 +0000
@@ -49,7 +49,9 @@
 
   sigc::signal<void> selection_change;
 
-  int GetSelectedIndex();
+  virtual int GetSelectedIndex() const;
+  virtual void SetSelectedIndex(int index);
+  
   virtual unsigned GetIndexAtPosition(int x, int y);
 
   virtual void Activate(LocalResult const& local_result, int index, ActivateType type);

=== modified file 'dash/ScopeView.cpp'
--- dash/ScopeView.cpp	2013-05-02 23:07:06 +0000
+++ dash/ScopeView.cpp	2013-05-03 17:13:27 +0000
@@ -43,6 +43,8 @@
 namespace dash
 {
 DECLARE_LOGGER(logger, "unity.dash.scopeview");
+DECLARE_LOGGER(focus_logger, "unity.dash.scopeview.focus");
+
 namespace
 {
 const int CARD_VIEW_GAP_VERT  = 24; // pixels
@@ -158,6 +160,7 @@
 , filter_expansion_pushed_(false)
 , scope_connected_(scope ? scope->connected : false)
 , search_on_next_connect_(false)
+, current_focus_category_position_(-1)
 {
   SetupViews(show_filters);
 
@@ -165,6 +168,8 @@
   filters_expanded.changed.connect(sigc::mem_fun(this, &ScopeView::OnScopeFilterExpanded));
   view_type.changed.connect(sigc::mem_fun(this, &ScopeView::OnViewTypeChanged));
 
+  key_nav_focus_connection_ = nux::GetWindowCompositor().key_nav_focus_change.connect(sigc::mem_fun(this, &ScopeView::OnCompositorKeyNavFocusChanged));
+
   if (scope_)
   {
     categories_updated = scope_->categories.changed.connect([this](Categories::Ptr const& categories) { SetupCategories(categories); });
@@ -312,17 +317,23 @@
   categories->model.changed.connect(resync_categories);
   resync_categories(categories->model());
 
-  scope_->category_order.changed.connect([this](std::vector<unsigned int> const& category_order) {
-    category_order_ = category_order;
-    OnCategoryOrderChanged();
-  });
+  scope_->category_order.changed.connect(sigc::mem_fun(this, &ScopeView::OnCategoryOrderChanged));
 }
 
 
-void ScopeView::OnCategoryOrderChanged()
+void ScopeView::OnCategoryOrderChanged(std::vector<unsigned int> const& order)
 {
   LOG_DEBUG(logger) << "Reordering categories for " << scope_->name();
 
+  //////////////////////////////////////////////////
+  // Find the current focus category position && result index
+  // This is to keep the focus in the same place if categories are being added/removed/reordered
+  PushResultFocus("reorder");
+  key_nav_focus_connection_.block(true);
+  //////////////////////////////////////////////////
+
+  category_order_ = order;
+
   for (auto iter = category_views_.begin(); iter != category_views_.end(); ++iter)
   {
     PlacesGroup::Ptr group = *iter;
@@ -331,10 +342,6 @@
 
   if (scope_)
   {
-    Categories::Ptr category_model = scope_->categories();
-    if (!category_model)
-      return;
-
     // there should be ~10 categories, so this shouldn't be too big of a deal
     for (unsigned i = 0; i < category_order_.size(); i++)
     {
@@ -346,6 +353,14 @@
       scroll_layout_->AddView(category_views_[desired_category_index].GetPointer(), 0);       
     }
   }
+
+  //////////////////////////////////////////////////
+  // Update current focus category position && result index
+  // This is to keep the focus in the same place if categories are being added/removed/reordered
+  PopResultFocus("reorder");
+  key_nav_focus_connection_.block(false);
+  //////////////////////////////////////////////////
+
   QueueRelayout();
 }
 
@@ -418,6 +433,12 @@
                     << ", " << renderer_name
                     << ", " << boost::lexical_cast<int>(index) << ")";
 
+  //////////////////////////////////////////////////
+  // Find the current focus category position && result index
+  // This is to keep the focus in the same place if categories are being added/removed/reordered
+  PushResultFocus("add");
+  key_nav_focus_connection_.block(true);
+  //////////////////////////////////////////////////
 
   PlacesGroup::Ptr group(CreatePlacesGroup(category));
   AddChild(group.GetPointer());
@@ -433,7 +454,9 @@
     category_order_.push_back(index);
   }
   else
+  {
     view_index = find_view_index - category_order_.begin();
+  }
 
   category_views_.insert(category_views_.begin() + index, group);
 
@@ -494,6 +517,13 @@
                           nux::MinorDimensionSize::MINOR_SIZE_FULL, 100.0f,
                           (nux::LayoutPosition)view_index);
 
+  //////////////////////////////////////////////////
+  // Update current focus category position && result index
+  // This is to keep the focus in the same place if categories are being added/removed/reordered
+  PopResultFocus("add");
+  key_nav_focus_connection_.block(false);
+  //////////////////////////////////////////////////
+
   if (reset_filter_models)
   {
     QueueReinitializeFilterCategoryModels(index);
@@ -537,6 +567,13 @@
   if (last_expanded_group_ == group)
     last_expanded_group_.Release();
 
+  //////////////////////////////////////////////////
+  // Find the current focus category position && result index
+  // This is to keep the focus in the same place if categories are being added/removed/reordered
+  PushResultFocus("remove");
+  key_nav_focus_connection_.block(true);
+  //////////////////////////////////////////////////
+
   counts_.erase(group);
   category_views_.erase(category_pos);
 
@@ -547,8 +584,15 @@
  
   scroll_layout_->RemoveChildObject(group.GetPointer());
   RemoveChild(group.GetPointer());
+
+  //////////////////////////////////////////////////
+  // Update current focus category position && result index
+  // This is to keep the focus in the same place if categories are being added/removed/reordered
+  PopResultFocus("remove");
+  key_nav_focus_connection_.block(false);
+  //////////////////////////////////////////////////
+
   QueueRelayout();
-
   if (reset_filter_models)
   {
     QueueReinitializeFilterCategoryModels(index);
@@ -725,6 +769,8 @@
 
   PlacesGroup::Ptr new_expanded_group;
 
+  PushResultFocus("count check");
+
   for (auto iter = category_order_.begin(); iter != category_order_.end(); ++iter)
   {
     unsigned int category_index = *iter;
@@ -757,6 +803,8 @@
   }
 
   last_expanded_group_ = new_expanded_group;
+
+  PopResultFocus("count check");
 }
 
 void ScopeView::HideResultsMessage()
@@ -1102,5 +1150,91 @@
     .add("no-results-active", no_results_active_);
 }
 
+void ScopeView::OnCompositorKeyNavFocusChanged(nux::Area* area, bool has_focus, nux::KeyNavDirection)
+{
+  if (!IsVisible())
+    return;
+
+  LOG_DEBUG(focus_logger) << "Global focus changed to  " << (area ? area->Type().name : "NULL");
+
+  if (area && has_focus)
+  {
+    // If we've change the focus to a places group child, then we need to update it's focus.
+    bool found_group = false;
+    while(area)
+    {
+      if (area->Type().IsDerivedFromType(PlacesGroup::StaticObjectType))
+      {
+        found_group = true;
+        break;
+      }
+      // opimise to break out if we reach this level as it will never be a group.
+      else if (area == this)
+        break;
+      area = area->GetParentObject();
+    }
+
+    if (!found_group && current_focus_category_position_ != -1)
+    {
+      LOG_DEBUG(focus_logger) << "Resetting focus for position " << current_focus_category_position_;
+      current_focus_category_position_ = -1;
+      current_focus_variant_ = nullptr;
+    }
+  }
+}
+
+void ScopeView::PushResultFocus(const char* reason)
+{  
+  int current_category_position = 0;
+  for (auto iter = category_order_.begin(); iter != category_order_.end(); ++iter)
+  {
+    unsigned category_index = *iter;
+    if (category_views_.size() <= category_index)
+      continue;
+    PlacesGroup::Ptr group = category_views_[category_index];
+    if (!group || !group->IsVisible())
+      continue;
+
+    nux::Area* focus_area = nux::GetWindowCompositor().GetKeyFocusArea();
+    while(focus_area)
+    {
+      if (focus_area == group.GetPointer())
+      {
+        current_focus_category_position_ = current_category_position;
+        current_focus_variant_ = group->GetCurrentFocus();
+        LOG_DEBUG(focus_logger) << "Saving focus for position " << current_focus_category_position_ << " due to '" << reason << "'";
+        break;
+      }
+      // opimise to break out if we reach this level as it will never be a group.
+      else if (focus_area == this)
+        break;
+      focus_area = focus_area->GetParentObject();
+    }
+    current_category_position++;
+  }
+}
+
+void ScopeView::PopResultFocus(const char* reason)
+{
+  int current_category_position = 0;
+  for (auto iter = category_order_.begin(); iter != category_order_.end(); ++iter)
+  {
+    unsigned category_index = *iter;
+    if (category_views_.size() <= category_index)
+      continue;
+    PlacesGroup::Ptr group = category_views_[category_index];
+    if (!group || !group->IsVisible())
+      continue;
+
+    if (current_category_position == current_focus_category_position_)
+    {
+      group->SetCurrentFocus(current_focus_variant_);
+      LOG_DEBUG(focus_logger) << "Restoring focus for position " << current_focus_category_position_ << " due to '" << reason << "'";
+      break;
+    }
+    current_category_position++;
+  }
+}
+
 }
 }

=== modified file 'dash/ScopeView.h'
--- dash/ScopeView.h	2013-04-25 15:31:32 +0000
+++ dash/ScopeView.h	2013-05-03 17:13:27 +0000
@@ -111,7 +111,7 @@
   void QueueReinitializeFilterCategoryModels(unsigned int index);
   bool ReinitializeCategoryResultModels();
   void ClearCategories();
-  void OnCategoryOrderChanged();
+  void OnCategoryOrderChanged(std::vector<unsigned int> const& order);
 
   void QueueCategoryCountsCheck();
   void CheckCategoryCounts();
@@ -119,6 +119,9 @@
   void CheckNoResults(glib::HintsMap const& hints);
   void HideResultsMessage();
 
+  void PushResultFocus(const char* reason);
+  void PopResultFocus(const char* reason);
+
   ResultView* GetResultViewForCategory(unsigned int category_index);
 
   virtual PlacesGroup::Ptr CreatePlacesGroup(Category const& category);
@@ -132,6 +135,8 @@
   virtual std::string GetName() const;
   virtual void AddProperties(GVariantBuilder* builder);
 
+  void OnCompositorKeyNavFocusChanged(nux::Area*, bool, nux::KeyNavDirection);
+
   std::string get_search_string() const;
 
   CategoryGroups category_views_;
@@ -177,6 +182,10 @@
   bool scope_connected_;
   bool search_on_next_connect_;
 
+  int current_focus_category_position_;
+  glib::Variant current_focus_variant_;
+  sigc::connection key_nav_focus_connection_;
+
   friend class TestScopeView;
 };
 

=== modified file 'debian/control'
--- debian/control	2013-04-25 09:24:36 +0000
+++ debian/control	2013-05-03 17:13:27 +0000
@@ -28,7 +28,7 @@
                libunity-misc-dev (>= 4.0.4),
                libgrail-dev (>= 1.0.20),
                libxcb-icccm4-dev,
-               libnux-4.0-dev (>= 4.0.1),
+               libnux-4.0-dev (>= 4.0.2),
                compiz-dev (>= 1:0.9.9~daily13.01.25bzr3586),
                libcompizconfig0-dev (>= 1:0.9.9~daily12.12.05-0ubuntu2),
                xsltproc,