Merge lp:~unity-team/unity/unity.text-entry-im into lp:unity

[Brandon Schaefer]

IMTextEntry now only handles copy/cut and pasting, everything else is in nux::TextEntry

[Thomi Richards (thomir-deactivatedaccount)]

I've had a look through this, and it looks good to me.

review: Approve

[Jay Taoko (jaytaoko)]

Approved!

review: Approve

[Unity Merger (unity-merger)]

The Jenkins job https://jenkins.qa.ubuntu.com/job/automerge-unity/333/console reported an error when processing this lp:~unity-team/unity/unity.text-entry-im branch.
Not merging it.

[Brandon Schaefer (brandontschaefer)]

-- checking for modules 'compiz;nux-2.0>=2.0.0;libbamf3;dee-1.0;gio-2.0;gio-unix-2.0;dbusmenu-glib-0.4;x11;libstartup-notification-1.0;gthread-2.0;indicator3-0.4;atk;unity-misc>=0.4.0;gconf-2.0;libutouch-geis;gtk+-3.0>=3.1;sigc++-2.0;json-glib-1.0;libnotify;gnome-desktop-3.0;gdu;ibus-1.0;unity>=4.99.0'
-- package 'ibus-1.0' not found

Hmm I thought "libibus-1.0-dev" had been added to unity

[Tim Penhey (thumper)]

Changes look good, lets try it.

review: Approve

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

This breaks the middle-click paste to me: https://code.launchpad.net/~3v1n0/unity/middle-click-paste-in-dash/+merge/87311

review: Needs Fixing

[Brandon Schaefer (brandontschaefer)]

Sorry, I must have missed that while deleting everything! Here is the fix again:
https://code.launchpad.net/~brandontschaefer/unity/unity.fix-middle-paste-reg/+merge/94441

=== modified file 'plugins/unityshell/src/DashController.cpp'
--- plugins/unityshell/src/DashController.cpp	2012-02-15 10:54:48 +0000
+++ plugins/unityshell/src/DashController.cpp	2012-02-23 10:16:31 +0000
@@ -278,6 +278,8 @@
   window_->EnableInputWindow(false, "Dash", true, false);
   visible_ = false;
 
+  nux::GetWindowCompositor().SetKeyFocusArea(NULL,nux::KEY_NAV_NONE);
+
   if (restore)
     PluginAdapter::Default ()->restoreInputFocus ();
 

=== modified file 'plugins/unityshell/src/IMTextEntry.cpp'
--- plugins/unityshell/src/IMTextEntry.cpp	2012-02-23 08:55:35 +0000
+++ plugins/unityshell/src/IMTextEntry.cpp	2012-02-23 10:16:31 +0000
@@ -21,7 +21,6 @@
 
 #include "IMTextEntry.h"
 
-#include <boost/lexical_cast.hpp>
 #include <NuxCore/Logger.h>
 #include <UnityCore/GLibWrapper.h>
 
@@ -36,127 +35,20 @@
 NUX_IMPLEMENT_OBJECT_TYPE(IMTextEntry);
 
 IMTextEntry::IMTextEntry()
-  : TextEntry("", "", 80085)
-  , preedit_string("")
-  , im_enabled(false)
-  , im_active(false)
-  , focused_(false)
-{
-  g_setenv("IBUS_ENABLE_SYNC_MODE", "1", TRUE);
-  CheckIMEnabled();
-  im_enabled ? SetupMultiIM() : SetupSimpleIM();
-
-  key_nav_focus_change.connect([&](nux::Area* area, bool focus, nux::KeyNavDirection dir) 
-  { 
-    focus ? OnFocusIn() : OnFocusOut();
-  }); 
-  mouse_up.connect(sigc::mem_fun(this, &IMTextEntry::OnMouseButtonUp));
-}
-
-void IMTextEntry::CheckIMEnabled()
-{
-  const char* module = g_getenv("GTK_IM_MODULE");
-  if (module &&
-      g_strcmp0(module, "") &&
-      g_strcmp0(module, "gtk-im-context-simple"))
-    im_enabled = true;
-
-  LOG_DEBUG(logger) << "Input method support is "
-                    << (im_enabled ? "enabled" : "disabled");
-}
-
-void IMTextEntry::SetupSimpleIM()
-{
-  im_context_ = gtk_im_context_simple_new();
-
-  sig_manager_.Add(new Signal<void, GtkIMContext*, char*>(im_context_, "commit", sigc::mem_fun(this, &IMTextEntry::OnCommit)));
-  sig_manager_.Add(new Signal<void, GtkIMContext*>(im_context_, "preedit-changed", sigc::mem_fun(this, &IMTextEntry::OnPreeditChanged)));
-  sig_manager_.Add(new Signal<void, GtkIMContext*>(im_context_, "preedit-start", sigc::mem_fun(this, &IMTextEntry::OnPreeditStart)));
-  sig_manager_.Add(new Signal<void, GtkIMContext*>(im_context_, "preedit-end", sigc::mem_fun(this, &IMTextEntry::OnPreeditEnd)));
-}
-
-void IMTextEntry::SetupMultiIM()
-{
-  im_context_ = gtk_im_multicontext_new();
-
-  sig_manager_.Add(new Signal<void, GtkIMContext*, char*>(im_context_, "commit", sigc::mem_fun(this, &IMTextEntry::OnCommit)));
-  sig_manager_.Add(new Signal<void, GtkIMContext*>(im_context_, "preedit-changed", sigc::mem_fun(this, &IMTextEntry::OnPreeditChanged)));
-  sig_manager_.Add(new Signal<void, GtkIMContext*>(im_context_, "preedit-start", sigc::mem_fun(this, &IMTextEntry::OnPreeditStart)));
-  sig_manager_.Add(new Signal<void, GtkIMContext*>(im_context_, "preedit-end", sigc::mem_fun(this, &IMTextEntry::OnPreeditEnd)));
+  : TextEntry("", NUX_TRACKER_LOCATION)
+{
 }
 
 bool IMTextEntry::InspectKeyEvent(unsigned int event_type,
                                   unsigned int keysym,
                                   const char* character)
 {
-  bool propagate_event = !(TryHandleEvent(event_type, keysym, character));
-
-  LOG_DEBUG(logger) << "Input method "
-                    << (im_enabled ? gtk_im_multicontext_get_context_id(glib::object_cast<GtkIMMulticontext>(im_context_)) : "simple")
-                    << " "
-                    << (propagate_event ? "did not handle " : "handled ") 
-                    << "event ("
-                    << (event_type == NUX_KEYDOWN ? "press" : "release")
-                    << ") ";
-
-  if (propagate_event)
-    propagate_event = !TryHandleSpecial(event_type, keysym, character);
-
-  if (propagate_event)
-  {
-    text_input_mode_ = event_type == NUX_KEYDOWN;
-    propagate_event = TextEntry::InspectKeyEvent(event_type, keysym, character);
-    text_input_mode_ = false;
-
-    UpdateCursorLocation();
-  }
-  return propagate_event;
-}
-
-bool IMTextEntry::TryHandleEvent(unsigned int eventType,
-                                 unsigned int keysym,
-                                 const char* character)
-{
-  nux::Event event = nux::GetWindowThread()->GetGraphicsDisplay().GetCurrentEvent();
-  
-  CheckValidClientWindow(event.x11_window);
-  
-  GdkEventKey ev;
-  KeyEventToGdkEventKey(event, ev);
-
-  return gtk_im_context_filter_keypress(im_context_, &ev);
-}
-
-inline void IMTextEntry::CheckValidClientWindow(Window window)
-{
-  if (!client_window_)
-  {
-    client_window_ = gdk_x11_window_foreign_new_for_display(gdk_display_get_default(), window);
-    gtk_im_context_set_client_window(im_context_, client_window_);
-
-    if (focused_)
-    {
-      gtk_im_context_focus_in(im_context_);
-    }
-  }
-}
-
-void IMTextEntry::KeyEventToGdkEventKey(Event& event, GdkEventKey& gdk_event)
-{
-  gdk_event.type = event.type == nux::NUX_KEYDOWN ? GDK_KEY_PRESS : GDK_KEY_RELEASE;
-  gdk_event.window = client_window_;
-  gdk_event.send_event = FALSE;
-  gdk_event.time = event.x11_timestamp;
-  gdk_event.state = event.x11_key_state;
-  gdk_event.keyval = event.x11_keysym;
-
-  gchar* txt = const_cast<gchar*>(event.GetText());
-  gdk_event.length = strlen(txt);
-  gdk_event.string = txt;
-
-  gdk_event.hardware_keycode = event.x11_keycode;
-  gdk_event.group = 0;
-  gdk_event.is_modifier = 0;
+  bool need_to_filter_event = TryHandleSpecial(event_type, keysym, character);
+
+  if (need_to_filter_event)
+    need_to_filter_event = TextEntry::InspectKeyEvent(event_type, keysym, character);
+
+  return need_to_filter_event;
 }
 
 bool IMTextEntry::TryHandleSpecial(unsigned int eventType, unsigned int keysym, const char* character)
@@ -166,13 +58,14 @@
   bool shift = (event.GetKeyState() & NUX_STATE_SHIFT);
   bool ctrl = (event.GetKeyState() & NUX_STATE_CTRL);
 
+  /* If there is preedit, handle the event else where, but we
+     want to be able to copy/paste while ibus is active */
+  if (!preedit_.empty())
+    return true;
+
   if (eventType != NUX_KEYDOWN)
     return false;
 
-  /* If IM is active, de-activate Copy & Paste */
-  if (im_active)
-    return true;
-
   if (((keyval == NUX_VK_x) && ctrl && !shift) ||
       ((keyval == NUX_VK_DELETE) && shift && !ctrl))
   {
@@ -194,15 +87,16 @@
   }
   else
   {
-    return false;
+    return true;
   }
-  return true;
+  return false;
 }
 
 void IMTextEntry::Cut()
 {
   Copy();
   DeleteSelection();
+  QueueRefresh (true, true);
 }
 
 void IMTextEntry::Copy()
@@ -221,122 +115,31 @@
   GdkAtom origin = primary ? GDK_SELECTION_PRIMARY : GDK_SELECTION_CLIPBOARD;
   glib::Object<GtkClipboard> clip(gtk_clipboard_get_for_display(gdk_display_get_default(),
                                                                 origin));
+
   auto callback = [](GtkClipboard* clip, const char* text, gpointer user_data)
    {
      IMTextEntry* self = static_cast<IMTextEntry*>(user_data);
      if (text)
-      self->InsertTextAt(self->cursor_, std::string(text));
+      self->InsertText(std::string(text));
    };
 
   gtk_clipboard_request_text(clip, callback, this);
 }
 
-void IMTextEntry::InsertTextAt(unsigned int position, std::string const& text)
+void IMTextEntry::InsertText(std::string const& text)
 {
   DeleteSelection();
 
   if (!text.empty())
   {
     std::string new_text(GetText());
-    new_text.insert(position, text);
+    new_text.insert(cursor_, text);
 
-    int cursor = position;
+    int cursor = cursor_;
     SetText(new_text.c_str());
     SetCursor(cursor + text.length());
-    UpdateCursorLocation();
-  }
-}
-
-void IMTextEntry::OnCommit(GtkIMContext* context, char* str)
-{
-  LOG_DEBUG(logger) << "Commit: " << str;
-  DeleteSelection();
-
-  if (str)
-  {
-    InsertTextAt(cursor_, std::string(str));
-  }
-}
-
-void IMTextEntry::OnPreeditChanged(GtkIMContext* context)
-{
-  glib::String preedit;
-  int cursor_pos = -1;
-
-  gtk_im_context_get_preedit_string(context, &preedit, &preedit_attrs_, &cursor_pos);
-
-  LOG_DEBUG(logger) << "Preedit changed: " << preedit;
-
-  preedit_ = preedit.Str();
-
-  if (!preedit.Str().empty()) {
-    preedit_cursor_ = preedit.Str().length();
-    QueueRefresh(true, true);
+    QueueRefresh (true, true);
     text_changed.emit(this);
-    UpdateCursorLocation();
-  }
-}
-
-void IMTextEntry::OnPreeditStart(GtkIMContext* context)
-{
-  im_active = true;
-
-  LOG_DEBUG(logger) << "Preedit start";
-}
-
-void IMTextEntry::OnPreeditEnd(GtkIMContext* context)
-{
-  im_active = false;
-  ResetPreedit();
-  gtk_im_context_reset(im_context_);
-
-  QueueRefresh(true, true);
-  text_changed.emit(this);
-
-  LOG_DEBUG(logger) << "Preedit ended";
-}
-
-void IMTextEntry::OnFocusIn()
-{
-  focused_ = true;
-  gtk_im_context_focus_in(im_context_);
-  gtk_im_context_reset(im_context_);
-  UpdateCursorLocation();
-}
-
-void IMTextEntry::OnFocusOut()
-{
-  focused_ = false;
-  gtk_im_context_focus_out(im_context_);
-}
-
-void IMTextEntry::UpdateCursorLocation()
-{
-  nux::Rect strong, weak;
-  GetCursorRects(&strong, &weak);
-  nux::Geometry geo = GetGeometry();
-
-  GdkRectangle area = { strong.x + geo.x, strong.y + geo.y, strong.width, strong.height };
-  gtk_im_context_set_cursor_location(im_context_, &area);
-}
-
-void IMTextEntry::OnMouseButtonUp(int x, int y, unsigned long bflags, unsigned long kflags)
-{
-  int button = nux::GetEventButton(bflags);
-
-  if (im_enabled && button == 3)
-  {
-    GtkWidget* menu = gtk_menu_new();
-    gtk_im_multicontext_append_menuitems(glib::object_cast<GtkIMMulticontext>(im_context_),
-                                         GTK_MENU_SHELL(menu));
-    gtk_menu_popup(GTK_MENU(menu), NULL, NULL, NULL, NULL, 3, GDK_CURRENT_TIME);
-  }
-  else if (button == 2)
-  {
-    SetCursor(XYToTextIndex(x, y));
-    UpdateCursorLocation();
-    Paste(true);
-  }
-}
-
+  }
+}
 }

=== modified file 'plugins/unityshell/src/IMTextEntry.h'
--- plugins/unityshell/src/IMTextEntry.h	2012-02-13 09:49:45 +0000
+++ plugins/unityshell/src/IMTextEntry.h	2012-02-23 10:16:31 +0000
@@ -40,42 +40,13 @@
 public:
   IMTextEntry();
 
-  nux::Property<std::string> preedit_string;
-  nux::Property<bool> im_enabled;
-  nux::Property<bool> im_active;
-
 private:
-  void CheckIMEnabled();
-  void SetupSimpleIM();
-  void SetupMultiIM();
-
   bool InspectKeyEvent(unsigned int eventType, unsigned int keysym, const char* character);
-  bool TryHandleEvent(unsigned int eventType, unsigned int keysym, const char* character);
-  void KeyEventToGdkEventKey(Event& event, GdkEventKey& gdk_event);
-  inline void CheckValidClientWindow(Window window);
   bool TryHandleSpecial(unsigned int eventType, unsigned int keysym, const char* character);
-  void InsertTextAt(unsigned int position, std::string const& text);
+  void InsertText(std::string const& text);
   void Cut();
   void Copy();
   void Paste(bool primary = false);
-
-  void OnCommit(GtkIMContext* context, char* str);
-  void OnPreeditChanged(GtkIMContext* context);
-  void OnPreeditStart(GtkIMContext* context);
-  void OnPreeditEnd(GtkIMContext* context);
-
-  void OnFocusIn();
-  void OnFocusOut();
-
-  void UpdateCursorLocation();
-
-  void OnMouseButtonUp(int x, int y, unsigned long bflags, unsigned long kflags);
-
- private:
-  glib::SignalManager sig_manager_;
-  glib::Object<GtkIMContext> im_context_;
-  glib::Object<GdkWindow> client_window_;
-  bool focused_;
 };
 
 }