Merge lp:~vbkaisetsu/unity/bug957927 into lp:unity

[Koichi Akabe]

Ensures hud ignores key presses once ibus is active

I fixed bug #957927
Please merge this branch.

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

Hi Koichi, thanks for your patch.
However, you need to sign the Canonical Contributor Agreement to get it merged.

[Koichi Akabe (vbkaisetsu)]

Hi,
Thank you for your information.
I sent the CCA on the internet just now.

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

Ok, the agreement is there.
So, I guess we need to wait the nux branch to be merged.

[Alex Launi (alexlauni)]

This needs a test. It should be very simple to write an autopilot test to ensure that this does not regress. Please ping me, or anyone else on irc if you need help with autopilot testing.

review: Needs Fixing

[Koichi Akabe (vbkaisetsu)]

Hi Alex,
I added autopilot codes for ibus-anthy and ibus-pinyin. But I didn't add for ibus-hangul because it commits hangul on input components.

Please review it.

[Gord Allott (gordallott)]

+1 here

review: Approve

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

This needs to be merged with trunk, other than that it's fine.

[Koichi Akabe (vbkaisetsu)]

It has many changes, but I think it was merged correctly.

[Brandon Schaefer (brandontschaefer)]

Looks good to me. +1.

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 13:26:27 +0000
@@ -806,7 +806,7 @@
   // DashView::KeyNavIteration.
    nux::InputArea* focus_area = nux::GetWindowCompositor().GetKeyFocusArea();
 
-  if (key_symbol == nux::NUX_KEYDOWN)
+  if (key_symbol == nux::NUX_KEYDOWN && !search_bar_->im_preedit)
   {
     std::list<nux::Area*> tabs;
     for (auto category : active_lens_view_->categories())
@@ -881,7 +881,7 @@
     }
   }
 
-  if (direction == KEY_NAV_NONE || search_bar_->im_active)
+  if (direction == KEY_NAV_NONE || search_bar_->im_preedit)
   {
     // then send the event to the search entry
     return search_bar_->text_entry();

=== modified file 'plugins/unityshell/src/HudView.cpp'
--- plugins/unityshell/src/HudView.cpp	2012-04-01 00:45:53 +0000
+++ plugins/unityshell/src/HudView.cpp	2012-04-04 13:26:27 +0000
@@ -66,7 +66,6 @@
   , timeline_need_more_draw_(false)
   , selected_button_(0)
   , show_embedded_icon_(true)
-  , activated_signal_sent_(false)
 {
   renderer_.SetOwner(this);
   renderer_.need_redraw.connect([this] () {
@@ -81,11 +80,7 @@
   SetupViews();
   search_bar_->key_down.connect (sigc::mem_fun (this, &View::OnKeyDown));
 
-  search_bar_->activated.connect ([&]()
-  {
-    if (!activated_signal_sent_)
-      search_activated.emit(search_bar_->search_string);
-  });
+  search_bar_->activated.connect (sigc::mem_fun (this, &View::OnSearchbarActivated));
 
   search_bar_->text_entry()->SetLoseKeyFocusOnKeyNavDirectionUp(false);
   search_bar_->text_entry()->SetLoseKeyFocusOnKeyNavDirectionDown(false);
@@ -500,6 +495,25 @@
   return false;
 }
 
+void View::OnSearchbarActivated()
+{
+  // The "Enter" key has been received and the text entry has the key focus.
+  // If one of the button has the fake_focus, we get it to emit the query_activated signal.
+  if (!buttons_.empty())
+  {
+    std::list<HudButton::Ptr>::iterator it;
+    for(it = buttons_.begin(); it != buttons_.end(); ++it)
+    {
+      if ((*it)->fake_focused)
+      {
+        query_activated.emit((*it)->GetQuery());
+        return;
+      }
+    }
+  }
+  search_activated.emit(search_bar_->search_string);
+}
+
 nux::Area* View::FindKeyFocusArea(unsigned int event_type,
       unsigned long x11_key_code,
       unsigned long special_keys_state)
@@ -556,7 +570,7 @@
     return NULL;
   }
 
-  if (search_bar_->text_entry()->HasKeyFocus())
+  if (search_bar_->text_entry()->HasKeyFocus() && !search_bar_->im_preedit)
   {
     if (direction == nux::KEY_NAV_NONE ||
         direction == nux::KEY_NAV_UP ||
@@ -622,27 +636,11 @@
 
     if (event_type == nux::NUX_KEYDOWN && direction == nux::KEY_NAV_ENTER)
     {
-      activated_signal_sent_ = false;
-      // The "Enter" key has been received and the text entry has the key focus.
-      // If one of the button has the fake_focus, we get it to emit the query_activated signal.
-      if (!buttons_.empty())
-      {
-        std::list<HudButton::Ptr>::iterator it;
-        for(it = buttons_.begin(); it != buttons_.end(); ++it)
-        {
-          if ((*it)->fake_focused)
-          {
-            query_activated.emit((*it)->GetQuery());
-            activated_signal_sent_ = true;
-          }
-        }
-      }
-
       // We still choose the text_entry as the receiver of the key focus.
       return search_bar_->text_entry();
     }
   }
-  else if (direction == nux::KEY_NAV_NONE)
+  else if (direction == nux::KEY_NAV_NONE || search_bar_->im_preedit)
   {
     return search_bar_->text_entry();
   }
@@ -650,7 +648,7 @@
   {
     return next_object_to_key_focus_area_->FindKeyFocusArea(event_type, x11_key_code, special_keys_state);
   }
-  return NULL;
+  return search_bar_->text_entry();
 }
 
 }

=== modified file 'plugins/unityshell/src/HudView.h'
--- plugins/unityshell/src/HudView.h	2012-04-01 00:00:45 +0000
+++ plugins/unityshell/src/HudView.h	2012-04-04 13:26:27 +0000
@@ -82,6 +82,7 @@
   void Draw(nux::GraphicsEngine& gfx_context, bool force_draw);
   void DrawContent(nux::GraphicsEngine& gfx_context, bool force_draw);
   bool InspectKeyEvent(unsigned int eventType, unsigned int key_sym, const char* character);
+  void OnSearchbarActivated();
   bool AcceptKeyNavFocus();
   nux::Geometry GetBestFitGeometry(nux::Geometry const& for_geo);
 

=== modified file 'plugins/unityshell/src/IMTextEntry.cpp'
--- plugins/unityshell/src/IMTextEntry.cpp	2012-03-14 06:24:18 +0000
+++ plugins/unityshell/src/IMTextEntry.cpp	2012-04-04 13:26:27 +0000
@@ -151,4 +151,9 @@
     Paste(true);
   } 
 }
+
+bool IMTextEntry::im_preedit()
+{
+  return !preedit_.empty();
+}
 }

=== modified file 'plugins/unityshell/src/IMTextEntry.h'
--- plugins/unityshell/src/IMTextEntry.h	2012-03-14 06:24:18 +0000
+++ plugins/unityshell/src/IMTextEntry.h	2012-04-04 13:26:27 +0000
@@ -39,6 +39,7 @@
   NUX_DECLARE_OBJECT_TYPE(IMTextEntry, nux::TextEntry);
 public:
   IMTextEntry();
+  bool im_preedit();
 
 private:
   bool InspectKeyEvent(unsigned int eventType, unsigned int keysym, const char* character);

=== 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 13:26:27 +0000
@@ -272,6 +272,7 @@
   search_string.SetGetterFunction(sigc::mem_fun(this, &SearchBar::get_search_string));
   search_string.SetSetterFunction(sigc::mem_fun(this, &SearchBar::set_search_string));
   im_active.SetGetterFunction(sigc::mem_fun(this, &SearchBar::get_im_active));
+  im_preedit.SetGetterFunction(sigc::mem_fun(this, &SearchBar::get_im_preedit));
   showing_filters.changed.connect(sigc::mem_fun(this, &SearchBar::OnShowingFiltersChanged));
   can_refine_search.changed.connect([&] (bool can_refine)
   {
@@ -596,6 +597,11 @@
   return pango_entry_->im_active();
 }
 
+bool SearchBar::get_im_preedit() const
+{
+  return pango_entry_->im_preedit();
+}
+
 //
 // Highlight
 //

=== 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 13:26:27 +0000
@@ -69,6 +69,7 @@
   nux::Property<bool> showing_filters;
   nux::Property<bool> can_refine_search;
   nux::ROProperty<bool> im_active;
+  nux::ROProperty<bool> im_preedit;
 
   sigc::signal<void> activated;
   sigc::signal<void, std::string const&> search_changed;
@@ -96,6 +97,7 @@
   std::string get_search_string() const;
   bool set_search_string(std::string const& string);
   bool get_im_active() const;
+  bool get_im_preedit() const;
   bool show_filter_hint_;
 
   static gboolean OnLiveSearchTimeout(SearchBar* self);

=== modified file 'tests/autopilot/autopilot/tests/test_ibus.py'
--- tests/autopilot/autopilot/tests/test_ibus.py	2012-04-02 20:18:58 +0000
+++ tests/autopilot/autopilot/tests/test_ibus.py	2012-04-04 13:26:27 +0000
@@ -161,3 +161,73 @@
         self.hud.ensure_hidden()
 
         self.assertEqual(self.result, hud_search_string)
+
+
+class IBusTestsPinyinIgnore(IBusTests):
+    """Tests for ignoring key events while the Pinyin input engine is active."""
+
+    def test_ignore_key_events_on_dash(self):
+        self.activate_input_engine_or_skip("pinyin")
+        self.dash.ensure_visible()
+        sleep(0.5)
+        self.activate_ibus()
+        sleep(0.5)
+        self.keyboard.type("cipan")
+        self.keyboard.press_and_release("Tab")
+        self.keyboard.type("  ")
+        dash_search_string = self.dash.get_searchbar().search_string
+        self.deactivate_ibus()
+        self.dash.ensure_hidden()
+
+        self.assertNotEqual("  ", dash_search_string)
+
+    def test_ignore_key_events_on_hud(self):
+        self.activate_input_engine_or_skip("pinyin")
+        self.hud.ensure_visible()
+        sleep(0.5)
+        self.keyboard.type("a")
+        self.activate_ibus()
+        sleep(0.5)
+        self.keyboard.type("riqi")
+        old_selected = self.hud.selected_button
+        self.keyboard.press_and_release("Down")
+        new_selected = self.hud.selected_button
+        self.deactivate_ibus()
+        self.hud.ensure_hidden()
+        
+        self.assertEqual(old_selected, new_selected)
+
+
+class IBusTestsAnthyIgnore(IBusTests):
+    """Tests for ignoring key events while the Anthy input engine is active."""
+
+    def test_ignore_key_events_on_dash(self):
+        self.activate_input_engine_or_skip("anthy")
+        self.dash.ensure_visible()
+        sleep(0.5)
+        self.activate_ibus()
+        sleep(0.5)
+        self.keyboard.type("shisutemu ")
+        self.keyboard.press_and_release("Tab")
+        self.keyboard.press_and_release("Ctrl+j")
+        dash_search_string = self.dash.get_searchbar().search_string
+        self.deactivate_ibus()
+        self.dash.ensure_hidden()
+
+        self.assertNotEqual("", dash_search_string)
+
+    def test_ignore_key_events_on_hud(self):
+        self.activate_input_engine_or_skip("anthy")
+        self.hud.ensure_visible()
+        sleep(0.5)
+        self.keyboard.type("a")
+        self.activate_ibus()
+        sleep(0.5)
+        self.keyboard.type("hiduke")
+        old_selected = self.hud.selected_button
+        self.keyboard.press_and_release("Down")
+        new_selected = self.hud.selected_button
+        self.deactivate_ibus()
+        self.hud.ensure_hidden()
+
+        self.assertEqual(old_selected, new_selected)