Merge lp:~brandontschaefer/nux/xim-preedit-support into lp:nux

[Brandon Schaefer]

Adds preedit support to XIM. Such as preedit rendering in the TextEntry.

Move XIM support from GraphicsDisplayX11 to WindowThread.

Add preedit support to XIM.

Had to move XIM support from GraphicsDisplayX11 to WindowThread

This should land when this branch lands:
https://code.launchpad.net/~brandontschaefer/unity/libnux-bump/+merge/200334

[lp:~brandontschaefer/nux/xim-preedit-support]

834. By Brandon Schaefer on 2013-12-18

* Don't need that header

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:834
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~brandontschaefer/nux/xim-preedit-support/+merge/199569/+edit-commit-message

http://jenkins.qa.ubuntu.com/job/nux-ci/97/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/nux-trusty-amd64-ci/19/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/nux-trusty-armhf-ci/19
    FAILURE: http://jenkins.qa.ubuntu.com/job/nux-trusty-i386-ci/19/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/nux-ci/97/rebuild

review: Needs Fixing (continuous-integration)

[Christopher Townsend (townsend)]

Couple of things right off the bat.

1. Need a commit message :)
2. Is there a bug associated with this work?
3. How do you test this? What is the old behavior and what am I expecting with this change?

Thanks!

review: Needs Information

[Brandon Schaefer (brandontschaefer)]

Hey Chris,

So there are some AP tests in unity. The old bevaior should be the same, ie. type in the an IM and text gets commited. Whats changed is they style, now preedit gets rendered to the TextEntry while the user types in they IM. Some IMs such as fctix doesn't support it by default (for some reason). So to test it out you'll need to go into:

$HOME/.config/fcitx/conf/fcitx-xim.config

Then set:
UseOnTheSpotStyle=True

[lp:~brandontschaefer/nux/xim-preedit-support]

835. By Brandon Schaefer on 2014-01-02

[ Brandon Schaefer ]
Add XIM preedit support

Update the deb change log

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:835
http://jenkins.qa.ubuntu.com/job/nux-ci/99/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/nux-trusty-amd64-ci/21
    SUCCESS: http://jenkins.qa.ubuntu.com/job/nux-trusty-armhf-ci/21
    SUCCESS: http://jenkins.qa.ubuntu.com/job/nux-trusty-i386-ci/21

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/nux-ci/99/rebuild

review: Approve (continuous-integration)

[Christopher Townsend (townsend)]

If $XMODIFIERS is blank, I get a seg fault crash. I don't think is default, but I'm sure it will happen.

Also,

839 +//#include "Nux.h"
840 +//#include "TextEntry.h"
841 +

needs to be removed since it's commented out.

review: Needs Fixing

[lp:~brandontschaefer/nux/xim-preedit-support]

836. By Brandon Schaefer on 2014-01-02

* Fix a crash when XMOD was blank. We need to make sure we are passing in a NULL
  name if we don't have any callbacks!

[Brandon Schaefer (brandontschaefer)]

Fixed issue, I was passing in XNPreeditAttributes and XNStatusAttributes to XCreateIC even when p_list and s_list was NULL. If they were NULL I can't pass in XNPreeditAttributes, instead it should also pass in a NULL name, so it doesn't try to access a NULL list.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:836
http://jenkins.qa.ubuntu.com/job/nux-ci/100/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/nux-trusty-amd64-ci/22
    SUCCESS: http://jenkins.qa.ubuntu.com/job/nux-trusty-armhf-ci/22
    SUCCESS: http://jenkins.qa.ubuntu.com/job/nux-trusty-i386-ci/22

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/nux-ci/100/rebuild

review: Approve (continuous-integration)

[Christopher Townsend (townsend)]

I think the Nux version should be bumped to 4.0.5. As I mentioned in https://code.launchpad.net/~brandontschaefer/unity/libnux-bump/+merge/200334/comments/465544, the Nux version built in the daily-ppa is already greater than the version you have proposed here.

review: Needs Fixing

[lp:~brandontschaefer/nux/xim-preedit-support]

837. By Brandon Schaefer on 2014-01-03

* Bump to 4.0.5

838. By Brandon Schaefer on 2014-01-03

[ Brandon Schaefer ]
* Add XIM preedit support
* Bump version to 4.0.5

Update changelog

839. By Brandon Schaefer on 2014-01-03

* Add missing space

840. By Brandon Schaefer on 2014-01-03

* Back to 1

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:837
http://jenkins.qa.ubuntu.com/job/nux-ci/101/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/nux-trusty-amd64-ci/23
    SUCCESS: http://jenkins.qa.ubuntu.com/job/nux-trusty-armhf-ci/23
    SUCCESS: http://jenkins.qa.ubuntu.com/job/nux-trusty-i386-ci/23

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/nux-ci/101/rebuild

review: Approve (continuous-integration)

[Christopher Townsend (townsend)]

Great, this all looks good now!

review: Approve

=== modified file 'Nux/MainLoopGLib.cpp'
--- Nux/MainLoopGLib.cpp	2013-11-06 13:56:07 +0000
+++ Nux/MainLoopGLib.cpp	2014-01-03 16:37:28 +0000
@@ -43,6 +43,11 @@
     unsigned int id;
   } TimeoutData;
 
+  Event GetSystemEvent(WindowThread* window_thread)
+  {
+    return window_thread->GetNextEvent();
+  }
+
   gboolean nux_timeout_dispatch(gpointer user_data)
   {
     bool repeat = false;
@@ -59,8 +64,7 @@
     }
     else
     {
-      Event event;
-      dd->window_thread->GetGraphicsDisplay().GetSystemEvent(&event);
+      Event event = GetSystemEvent(dd->window_thread);
       return_code = dd->window_thread->ProcessEvent(event);
     }
 
@@ -128,8 +132,7 @@
     nux_glib_threads_lock();
     WindowThread *window_thread = NUX_STATIC_CAST(WindowThread *, user_data);
 
-    Event event;
-    window_thread->GetGraphicsDisplay().GetSystemEvent(&event);
+    Event event = GetSystemEvent(window_thread);
     unsigned int return_code = window_thread->ProcessEvent(event);
 
     if (return_code == 0 && !window_thread->IsEmbeddedWindow())
 
=== modified file 'Nux/Makefile.am'
--- Nux/Makefile.am	2013-04-18 13:28:09 +0000
+++ Nux/Makefile.am	2014-01-03 16:37:28 +0000
@@ -129,7 +129,10 @@
 
 if USE_X11
 source_cpp += \
-  $(srcdir)/InputMethodIBus.cpp
+  $(srcdir)/InputMethodIBus.cpp \
+  $(srcdir)/XICClient.cpp \
+  $(srcdir)/XIMCallbacks.cpp \
+  $(srcdir)/XIMController.cpp
 endif
 
 if HAVE_GEIS
@@ -243,8 +246,10 @@
 endif
 
 if USE_X11
-source_cpp += \
-  $(srcdir)/InputMethodIBus.h
+source_h += \
+  $(srcdir)/InputMethodIBus.h \
+  $(srcdir)/XICClient.h \
+  $(srcdir)/XIMController.h
 endif
 
 if HAVE_GEIS
 
=== modified file 'Nux/TextEntry.cpp'
--- Nux/TextEntry.cpp	2013-11-04 14:59:20 +0000
+++ Nux/TextEntry.cpp	2014-01-03 16:37:28 +0000
@@ -884,7 +884,7 @@
         need_im_reset_ = true;
 #if defined(USE_X11)
         ime_->Focus();
-        nux::GetWindowThread()->GetGraphicsDisplay().XICFocus();
+        nux::GetWindowThread()->XICFocus(this);
 #endif
         //gtk_im_context_focus_in(im_context_);
         //UpdateIMCursorLocation();
@@ -907,7 +907,7 @@
         need_im_reset_ = true;
 #if defined(USE_X11)
         ime_->Blur();
-        nux::GetWindowThread()->GetGraphicsDisplay().XICUnFocus();
+        nux::GetWindowThread()->XICUnFocus();
 #endif
         //gtk_im_context_focus_out(im_context_);
       }
@@ -1033,6 +1033,35 @@
     }
   }
 
+  void TextEntry::PreeditStarted()
+  {
+    ime_active_ = true;
+  }
+
+  void TextEntry::UpdatePreedit(std::string const& preedit, int cursor)
+  {
+    preedit_ = preedit;
+    preedit_cursor_ = cursor;
+    QueueRefresh(true, true);
+  }
+
+  void TextEntry::UpdatePreeditAttribs(PangoAttrList* list)
+  {
+    if (preedit_attrs_)
+    {
+      pango_attr_list_unref(preedit_attrs_);
+      preedit_attrs_ = NULL;
+    }
+
+    preedit_attrs_ = list;
+  }
+
+  void TextEntry::ClearPreedit()
+  {
+    ResetPreedit();
+    QueueRefresh(true, true);
+  }
+
   void TextEntry::DrawText(CairoGraphics *canvas)
   {
     PangoLayout *layout = EnsureLayout();
 
=== modified file 'Nux/TextEntry.h'
--- Nux/TextEntry.h	2013-11-04 14:59:20 +0000
+++ Nux/TextEntry.h	2014-01-03 16:37:28 +0000
@@ -227,6 +227,11 @@
     bool PasswordMode() const;
     std::string GetPasswordChar();
 
+    void PreeditStarted();
+    void UpdatePreedit(std::string const& preedit, int cursor);
+    void UpdatePreeditAttribs(PangoAttrList* list);
+    void ClearPreedit();
+
   protected:
     bool _block_focus; // used to selectively ignore focus keyevents
 
 
=== modified file 'Nux/WindowThread.cpp'
--- Nux/WindowThread.cpp	2013-11-07 11:53:10 +0000
+++ Nux/WindowThread.cpp	2014-01-03 16:37:28 +0000
@@ -118,6 +118,7 @@
   WindowThread::~WindowThread()
   {
 #if (defined(NUX_OS_LINUX) || defined(NUX_USE_GLIB_LOOP_ON_WINDOWS)) && (!defined(NUX_DISABLE_GLIB_LOOP))
+    xim_controller_.reset();
     CleanupGlibLoop();
 #endif
 
@@ -521,6 +522,24 @@
 
   extern EventToNameStruct EventToName[];
 
+  Event WindowThread::GetNextEvent()
+  {
+    Event event;
+    graphics_display_->GetSystemEvent(&event);
+
+#if defined(NUX_OS_LINUX) && defined(USE_X11)
+    // Make sure the current xic is synced up with the current event window
+    if ((event.type == KeyPress || event.type == KeyRelease) &&
+         event.x11_window && xim_controller_->GetCurrentWindow() != event.x11_window)
+    {
+      xim_controller_->SetFocusedWindow(event.x11_window);
+      graphics_display_->SetCurrentXIC(xim_controller_->GetXIC());
+    }
+#endif
+
+    return event;
+  }
+
 #if (!defined(NUX_OS_LINUX) && !defined(NUX_USE_GLIB_LOOP_ON_WINDOWS)) || defined(NUX_DISABLE_GLIB_LOOP)
 #ifdef NUX_GESTURES_SUPPORT
   Event *WindowThread::FetchNextEvent()
@@ -1148,6 +1167,8 @@
     timer_manager_ = new TimerHandler(this);
     window_compositor_ = new WindowCompositor(this);
 
+    xim_controller_ = std::make_shared<XIMController>(graphics_display_->GetX11Display());
+
     SetThreadState(THREADRUNNING);
     thread_ctor_called_ = true;
     return true;
@@ -1245,7 +1266,7 @@
       x11display_ = XOpenDisplay(NULL);
       ownx11display_ = true;
     }
-      
+
     graphics_display_ = gGLWindowManager.CreateFromForeignWindow(x11display_, X11Window, OpenGLContext);
 
     if (graphics_display_ == 0)
@@ -1264,6 +1285,8 @@
     timer_manager_ = new TimerHandler(this);
     window_compositor_ = new WindowCompositor(this);
 
+    xim_controller_ = std::make_shared<XIMController>(graphics_display_->GetX11Display());
+
     SetThreadState(THREADRUNNING);
     thread_ctor_called_ = true;
 
@@ -1776,6 +1799,19 @@
       _external_fds.erase (it);
     }
   }
+#if defined(NUX_OS_LINUX) && defined(USE_X11)
+  void WindowThread::XICFocus(TextEntry* text_entry)
+  {
+    xim_controller_->FocusInXIC();
+    xim_controller_->SetCurrentTextEntry(text_entry);
+    graphics_display_->SetCurrentXIC(xim_controller_->GetXIC());
+  }
+
+  void WindowThread::XICUnFocus()
+  {
+    xim_controller_->FocusOutXIC();
+  }
+#endif
 
   GraphicsDisplay& WindowThread::GetGraphicsDisplay() const
   {
 
=== modified file 'Nux/WindowThread.h'
--- Nux/WindowThread.h	2013-10-30 23:26:54 +0000
+++ Nux/WindowThread.h	2014-01-03 16:37:28 +0000
@@ -29,6 +29,10 @@
 #include "GeisAdapter.h"
 #endif
 
+#if defined(NUX_OS_LINUX) && defined(USE_X11)
+#include "XIMController.h"
+#endif
+
 namespace nux
 {
 
@@ -358,6 +362,8 @@
 
     std::vector<Geometry> GetPresentationListGeometries() const;
 
+    Event GetNextEvent();
+
 #ifdef NUX_GESTURES_SUPPORT
     /*!
       Simple wrapper for ProcessEvent for connection with GeisAdapter::event_ready
@@ -371,6 +377,11 @@
     void WatchFdForEvents(int fd, const FdWatchCallback &);
     void UnwatchFd(int fd);
 
+#if defined(NUX_OS_LINUX) && defined(USE_X11)
+    void XICFocus(TextEntry* text_entry);
+    void XICUnFocus();
+#endif
+
   protected:
 
     /*!
@@ -709,6 +720,10 @@
     std::unique_ptr<GeisAdapter> geis_adapter_;
 #endif
 
+#if defined(NUX_OS_LINUX) && defined(USE_X11)
+    std::shared_ptr<XIMController> xim_controller_;
+#endif
+
     /*!
         Add a timeout and return the timeout index.
         This function is used internally by Nux.
 
=== renamed file 'NuxGraphics/XICClient.cpp' => 'Nux/XICClient.cpp'
--- NuxGraphics/XICClient.cpp	2013-07-18 00:09:46 +0000
+++ Nux/XICClient.cpp	2014-01-03 16:37:28 +0000
@@ -1,5 +1,5 @@
 /*
-* Copyright 2012 Inalogic® Inc.
+* Copyright 2012-2013 Inalogic® Inc.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License, as
@@ -21,54 +21,260 @@
 
 #include "XICClient.h"
 
+#include "NuxCore/Logger.h"
+
+DECLARE_LOGGER(logger, "xic.client");
+
+using namespace std;
+
 namespace nux
 {
 
+int const FEEDBACK_MASK = (XIMUnderline | XIMReverse);
+
 XICClient::XICClient()
-  : xic_(NULL)
+  : xic_(nullptr)
   , xim_style_(0)
   , focused_(false)
 {
 }
 
-void XICClient::ResetXIC(XIM xim, Window window)
+void XICClient::ResetXIC(XIM xim, Window window, Display* display)
 {
   if (!xim_style_)
     SetupXIMStyle(xim);
 
-  SetupXIC(xim, window);
-}
-
-void XICClient::SetupXIC(XIM xim, Window window)
+  SetupXIC(xim, window, display);
+}
+
+void XICClient::SetCurrentTextEntry(TextEntry* text_entry)
+{
+  text_entry_ = text_entry;
+}
+
+static int preedit_caret_callback(XIC xic,
+                                  XPointer clientdata,
+                                  XIMPreeditCaretCallbackStruct* call_data)
+{
+  return 0;
+}
+
+static int status_start_callback(XIC xic,
+                                 XPointer clientdata,
+                                 XIMPreeditDrawCallbackStruct* call_data)
+{
+  return 0;
+}
+
+static void status_draw_callback(XIC xic,
+                                 XPointer clientdata,
+                                 XPointer* call_data)
+{
+}
+
+static void status_done_callback(XIC xic,
+                                 XPointer clientdata,
+                                 XPointer* call_data)
+{
+}
+
+XVaNestedList XICClient::GetPreeditCallbacks()
+{
+  preedit_start_cb_.callback = (XIMProc)XICClient::PreeditStartCallback;
+  preedit_start_cb_.client_data = nullptr;
+
+  preedit_done_cb_.callback = (XIMProc)XICClient::PreeditDoneCallback;
+  preedit_done_cb_.client_data = (XPointer)text_entry_;
+
+  preedit_draw_cb_.callback = (XIMProc)XICClient::PreeditDrawCallback;
+  preedit_draw_cb_.client_data = (XPointer)text_entry_;
+
+  preedit_caret_cb_.callback = (XIMProc)preedit_caret_callback;
+  preedit_caret_cb_.client_data = nullptr;
+
+  XVaNestedList p_list = nullptr;
+  p_list = XVaCreateNestedList(0,
+                               XNPreeditStartCallback, &preedit_start_cb_,
+                               XNPreeditDoneCallback,  &preedit_done_cb_,
+                               XNPreeditDrawCallback,  &preedit_draw_cb_,
+                               XNPreeditCaretCallback, &preedit_caret_cb_,
+                               nullptr);
+
+  return p_list;
+}
+
+XVaNestedList XICClient::GetStatusCallbacks()
+{
+  status_start_cb_.callback = (XIMProc)status_start_callback;
+  status_start_cb_.client_data = nullptr;
+
+  status_done_cb_.callback = (XIMProc)status_done_callback;
+  status_done_cb_.client_data = nullptr;
+
+  status_draw_cb_.callback = (XIMProc)status_draw_callback;
+  status_draw_cb_.client_data = nullptr;
+
+  XVaNestedList s_list = nullptr;
+  s_list = XVaCreateNestedList(0,
+                               XNStatusStartCallback, &status_start_callback,
+                               XNStatusDoneCallback,  &status_done_callback,
+                               XNStatusDrawCallback,  &status_draw_callback,
+                               nullptr);
+
+  return s_list;
+}
+
+XIMStyle XICClient::FilterXIMStyle()
+{
+  XIMStyle style = 0;
+
+  if (xim_style_ & XIMPreeditCallbacks)
+  {
+    style |= XIMPreeditCallbacks;
+  }
+  else if (xim_style_ & XIMPreeditNone)
+  {
+    style |= XIMPreeditNone;
+  }
+  else
+  {
+    style |= XIMPreeditNothing;
+  }
+
+  if (xim_style_ & XIMStatusCallbacks)
+  {
+    style |= XIMStatusCallbacks;
+  }
+  else if (xim_style_ & XIMStatusNone)
+  {
+    style |= XIMStatusNone;
+  }
+  else
+  {
+    style |= XIMStatusNothing;
+  }
+
+  return style;
+}
+
+void XICClient::SetupXIC(XIM xim, Window window, Display* display)
 {
   if (xic_)
     DestroyXIC();
 
-  xic_ = XCreateIC(xim, XNInputStyle, xim_style_, XNClientWindow, window, XNFocusWindow, window, NULL);
+  XIMStyle style = FilterXIMStyle();
+  
+  const char* p_name = nullptr;
+  XVaNestedList p_list = nullptr;
+  if (style & XIMPreeditCallbacks)
+  {
+    p_list = GetPreeditCallbacks();
+    p_name = XNPreeditAttributes;
+  }
+
+  const char* s_name = nullptr;
+  XVaNestedList s_list = nullptr;
+  if (style & XIMStatusCallbacks)
+  {
+    s_list = GetStatusCallbacks();
+    s_name = XNStatusAttributes;
+  }
+
+  xic_ = XCreateIC(xim, XNInputStyle, style,
+                   XNClientWindow, window,
+                   p_name, p_list,
+                   s_name, s_list,
+                   nullptr);
+
+  if (p_list)
+    XFree(p_list);
+  if (s_list)
+    XFree(s_list);
+
+  xim_style_ = style;
+}
+
+XIMStyle ChooseBetterStyle(XIMStyle style1, XIMStyle style2)
+{
+  XIMStyle s,t;
+  XIMStyle preedit = XIMPreeditArea | XIMPreeditCallbacks |
+                     XIMPreeditPosition | XIMPreeditNothing | XIMPreeditNone;
+
+  XIMStyle status = XIMStatusArea | XIMStatusCallbacks |
+                    XIMStatusNothing | XIMStatusNone;
+
+  if (style1 == 0)
+    return style2;
+
+  if (style2 == 0)
+    return style1;
+
+  if ((style1 & (preedit | status)) == (style2 & (preedit | status)))
+    return style1;
+
+  s = style1 & preedit;
+  t = style2 & preedit;
+  if (s != t)
+  {
+    if (s | t | XIMPreeditCallbacks)
+      return (s == XIMPreeditCallbacks) ? style1 : style2;
+    else if (s | t | XIMPreeditPosition)
+      return (s == XIMPreeditPosition)  ? style1 : style2;
+    else if (s | t | XIMPreeditArea)
+      return (s == XIMPreeditArea)      ? style1 : style2;
+    else if (s | t | XIMPreeditNothing)
+      return (s == XIMPreeditNothing)   ? style1 : style2;
+    else if (s | t | XIMPreeditNone)
+      return (s == XIMPreeditNone)      ? style1 : style2;
+  }
+  else
+  {
+    s = style1 & status;
+    t = style2 & status;
+
+    if (s | t | XIMStatusCallbacks)
+      return (s == XIMStatusCallbacks) ? style1 : style2;
+    else if (s | t | XIMStatusArea)
+      return (s == XIMStatusArea)      ? style1 : style2;
+    else if (s | t | XIMStatusNothing)
+      return (s == XIMStatusNothing)   ? style1 : style2;
+    else if (s | t | XIMStatusNone)
+      return (s == XIMStatusNone)      ? style1 : style2;
+  }
 }
 
 void XICClient::SetupXIMStyle(XIM xim)
 {
   int i;
-  XIMStyles *xim_styles = NULL;
-  XIMStyle root_style = (XIMPreeditNothing|XIMStatusNothing);
-
-  XGetIMValues(xim, XNQueryInputStyle, &xim_styles, NULL);
-
+  XIMStyles *xim_styles = nullptr;
+  XIMStyle prefered_style = XIMPreeditCallbacks | XIMStatusCallbacks;
+
+  XGetIMValues(xim, XNQueryInputStyle, &xim_styles, nullptr);
+
+  XIMStyle best = 0, style = 0;
   for (i = 0; i < xim_styles->count_styles; ++i)
-    if (xim_styles->supported_styles[i] == root_style)
+  {
+    style = xim_styles->supported_styles[i];
+
+    if ((style & prefered_style) == style)
+    {
+      best = ChooseBetterStyle(style, best);
       break;
+    }
+    else
+    {
+      best = ChooseBetterStyle(style, best);
+    }
+  }
 
-  if (i >= xim_styles->count_styles)
-    xim_style_ = 0;
-  xim_style_ = root_style;
+  xim_style_ = best;
 
   XFree(xim_styles);
 }
 
 bool XICClient::HasXIC() const
 {
-  return xic_ != NULL;
+  return xic_ != nullptr;
 }
 
 XIC XICClient::GetXIC() const
@@ -78,7 +284,7 @@
 
 void XICClient::Reinitialize()
 {
-  xic_ = NULL;
+  xic_ = nullptr;
   xim_style_ = 0;
   focused_ = false;
 }
@@ -111,7 +317,7 @@
   if (xic_)
   {
     XDestroyIC(xic_);
-    xic_ = NULL;
+    xic_ = nullptr;
   }
 }
 
 
=== renamed file 'NuxGraphics/XICClient.h' => 'Nux/XICClient.h'
--- NuxGraphics/XICClient.h	2012-11-27 19:30:57 +0000
+++ Nux/XICClient.h	2014-01-03 16:37:28 +0000
@@ -1,5 +1,5 @@
 /*
-* Copyright 2012 Inalogic® Inc.
+* Copyright 2012-2013 Inalogic® Inc.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License, as
@@ -27,13 +27,15 @@
 
 namespace nux
 {
+  class TextEntry;
 
 class XICClient
 {
 public:
   XICClient();
 
-  void ResetXIC(XIM xim, Window window);
+  void ResetXIC(XIM xim, Window window, Display* display);
+  void SetCurrentTextEntry(TextEntry* text_entry_);
 
   bool HasXIC() const;
   XIC GetXIC() const;
@@ -46,12 +48,32 @@
 
   void DestroyXIC();
 private:
-  void SetupXIC(XIM xim, Window window);
+  void SetupXIC(XIM xim, Window window, Display* display);
   void SetupXIMStyle(XIM xim);
 
+  XVaNestedList GetPreeditCallbacks();
+  XVaNestedList GetStatusCallbacks();
+  XIMStyle FilterXIMStyle();
+
+  static int PreeditStartCallback(XIC xic, XPointer clientdata, XPointer data);
+  static int PreeditDoneCallback(XIC xic, XPointer clientdata, XPointer data);
+
+  static int PreeditDrawCallback(XIC xic, XPointer clientdata,
+                                 XIMPreeditDrawCallbackStruct* call_data);
+
+  TextEntry* text_entry_;
   XIC xic_;
   XIMStyle xim_style_;
 
+  XIMCallback preedit_start_cb_;
+  XIMCallback preedit_done_cb_;
+  XIMCallback preedit_draw_cb_;
+  XIMCallback preedit_caret_cb_;
+
+  XIMCallback status_start_cb_;
+  XIMCallback status_done_cb_;
+  XIMCallback status_draw_cb_;
+
   bool focused_;
 };
 
 
=== added file 'Nux/XIMCallbacks.cpp'
--- Nux/XIMCallbacks.cpp	1970-01-01 00:00:00 +0000
+++ Nux/XIMCallbacks.cpp	2014-01-03 16:37:28 +0000
@@ -0,0 +1,189 @@
+// -*- Mode: C++; indent-tabs-mode: nil; tab-width: 2 -*-
+/*
+ * Copyright 2013 Inalogic® Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License, as
+ * published by the  Free Software Foundation; either version 2.1 or 3.0
+ * of the License.
+ *
+ * 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 along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ * Authored by: Brandon Schaefer
+ *
+ */
+
+
+#include "Nux.h"
+#include "TextEntry.h"
+#include "XICClient.h"
+
+#include <string>
+
+#include "NuxCore/Logger.h"
+
+DECLARE_LOGGER(logger, "xim.callbacks");
+
+using namespace std;
+
+namespace nux
+{
+
+int const FEEDBACK_MASK = (XIMUnderline | XIMReverse);
+
+int XICClient::PreeditStartCallback(XIC xic,
+                                    XPointer clientdata,
+                                    XPointer call_data)
+{
+  TextEntry* text_entry = (TextEntry*)clientdata;
+  if (text_entry)
+  {
+    text_entry->PreeditStarted();
+  }
+
+  return 0;
+}
+
+int XICClient::PreeditDoneCallback(XIC xic,
+                                   XPointer clientdata,
+                                   XPointer call_data)
+{
+  TextEntry* text_entry = (TextEntry*)clientdata;
+  if (text_entry)
+  {
+    text_entry->ClearPreedit();
+  }
+
+  return 0;
+}
+
+void add_feedback_attr(PangoAttrList* attrs,
+                            char const* str,
+                            XIMFeedback feedback,
+                            int start,
+                            int end)
+{
+  PangoAttribute* attr;
+
+  int start_index = g_utf8_offset_to_pointer(str, start) - str;
+  int end_index   = g_utf8_offset_to_pointer(str, end)   - str;
+
+  if (feedback & XIMUnderline)
+  {
+    attr = pango_attr_underline_new(PANGO_UNDERLINE_SINGLE);
+    attr->start_index = start_index;
+    attr->end_index = end_index;
+
+    pango_attr_list_insert (attrs, attr);
+  }
+
+  if (feedback & XIMReverse)
+  {
+    attr = pango_attr_foreground_new(0xFFFF, 0xFFFF, 0xFFFF);
+    attr->start_index = start_index;
+    attr->end_index = end_index;
+
+    pango_attr_list_insert (attrs, attr);
+
+    attr = pango_attr_background_new(0x0, 0x0, 0x0);
+
+    attr->start_index = start_index;
+    attr->end_index = end_index;
+
+    pango_attr_list_insert (attrs, attr);
+  }
+
+  if (feedback & ~FEEDBACK_MASK)
+  {
+    LOG_WARN(logger) << "Unrenderer feedback: " << (feedback & ~FEEDBACK_MASK);
+  }
+}
+
+void feedback_to_pango_list(PangoAttrList** attrs,
+                            char const* str,
+                            int nfeedbacks,
+                            XIMFeedback* feedbacks)
+{
+  XIMFeedback last_feedback = 0;
+  int start = -1;
+  int i = 0;
+
+  if (attrs)
+  {
+    *attrs = pango_attr_list_new();
+
+    for (i = 0; i < nfeedbacks; ++i)
+    {
+      XIMFeedback new_feedback = (feedbacks[i] & FEEDBACK_MASK);
+      if (new_feedback != last_feedback)
+      {
+        last_feedback = new_feedback;
+        start = i;
+      }
+      else
+      {
+        PangoAttribute* attr;
+
+        int start_index = g_utf8_offset_to_pointer(str, start) - str;
+        int end_index   = g_utf8_offset_to_pointer(str, i)   - str;
+
+        attr = pango_attr_foreground_new(0x0, 0x0, 0x0);
+        attr->start_index = start_index;
+        attr->end_index = end_index;
+
+        pango_attr_list_insert (*attrs, attr);
+
+        attr = pango_attr_background_new(0xFFFF, 0xFFFF, 0xFFFF);
+
+        attr->start_index = start_index;
+        attr->end_index = end_index;
+
+        pango_attr_list_insert (*attrs, attr);
+      }
+    }
+
+    if (start >= 0)
+      add_feedback_attr(*attrs, str, last_feedback, start, i);
+  }
+}
+
+int XICClient::PreeditDrawCallback(XIC xic,
+                                   XPointer clientdata,
+                                   XIMPreeditDrawCallbackStruct* call_data)
+{
+  TextEntry* text_entry = (TextEntry*)clientdata;
+
+  if (call_data->text && text_entry)
+  {
+    string preedit;
+
+    // TODO Actually handle this correctly...
+    if (call_data->text->encoding_is_wchar)
+    {
+      preedit = string("");
+    }
+    else
+    {
+      preedit = string(call_data->text->string.multi_byte);
+    }
+
+    PangoAttrList* preedit_attr;
+    feedback_to_pango_list(&preedit_attr, preedit.c_str(),
+                           call_data->text->length,
+                           call_data->text->feedback);
+
+    text_entry->UpdatePreeditAttribs(preedit_attr);
+    text_entry->UpdatePreedit(preedit, call_data->caret);
+  }
+
+  return 0;
+}
+
+}
 
=== renamed file 'NuxGraphics/XIMController.cpp' => 'Nux/XIMController.cpp'
--- NuxGraphics/XIMController.cpp	2013-10-10 23:36:28 +0000
+++ Nux/XIMController.cpp	2014-01-03 16:37:28 +0000
@@ -1,5 +1,5 @@
 /*
-* Copyright 2012 Inalogic® Inc.
+* Copyright 2012-2013 Inalogic® Inc.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License, as
@@ -32,7 +32,7 @@
 XIMController::XIMController(Display* display)
   : display_(display)
   , window_(0)
-  , xim_(NULL)
+  , xim_(nullptr)
 {
   InitXIMCallback();
 }
@@ -51,7 +51,15 @@
   window_ = window;
 
   if (xim_)
-    xic_client_.ResetXIC(xim_, window);
+    xic_client_.ResetXIC(xim_, window, display_);
+}
+
+void XIMController::SetCurrentTextEntry(TextEntry* text_entry)
+{
+  xic_client_.SetCurrentTextEntry(text_entry);
+
+  if (xim_)
+    xic_client_.ResetXIC(xim_, window_, display_);
 }
 
 void XIMController::RemoveFocusedWindow()
@@ -78,7 +86,7 @@
 void XIMController::FocusOutXIC()
 {
   xic_client_.FocusOutXIC();
-  xic_client_.DestroyXIC();
+  xic_client_.SetCurrentTextEntry(nullptr);
 }
 
 Window XIMController::GetCurrentWindow() const
@@ -131,12 +139,13 @@
 void XIMController::SetupXIM()
 {
   xim_ = XOpenIM(display_, NULL, NULL, NULL);
+
   if (xim_)
   {
     SetupXIMDestroyedCallback();
 
     if (window_)
-      xic_client_.ResetXIC(xim_, window_);
+      xic_client_.ResetXIC(xim_, window_, display_);
 
     XUnregisterIMInstantiateCallback (display_, NULL, NULL, NULL,
                                       XIMController::SetupXIMClientCallback,
 
=== renamed file 'NuxGraphics/XIMController.h' => 'Nux/XIMController.h'
--- NuxGraphics/XIMController.h	2013-10-10 23:36:28 +0000
+++ Nux/XIMController.h	2014-01-03 16:37:28 +0000
@@ -1,5 +1,5 @@
 /*
-* Copyright 2012 Inalogic® Inc.
+* Copyright 2012-2013 Inalogic® Inc.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License, as
@@ -29,6 +29,7 @@
 
 namespace nux
 {
+  class TextEntry;
 
 class XIMController
 {
@@ -37,6 +38,7 @@
   ~XIMController();
 
   void SetFocusedWindow(Window window);
+  void SetCurrentTextEntry(TextEntry* text_entry_);
   void RemoveFocusedWindow();
 
   bool IsXICValid() const;
 
=== modified file 'NuxGraphics/GraphicsDisplayX11.cpp'
--- NuxGraphics/GraphicsDisplayX11.cpp	2013-10-11 13:07:50 +0000
+++ NuxGraphics/GraphicsDisplayX11.cpp	2014-01-03 16:37:28 +0000
@@ -108,6 +108,7 @@
     , m_X11Screen(0)
     , m_X11Window(0)
     , m_X11VisualInfo(NULL)
+    , m_current_xic(NULL)
     , parent_window_(0)
     , m_GLCtx(NULL)
 #ifndef NUX_OPENGLES_20
@@ -172,9 +173,6 @@
     NUX_SAFE_DELETE( m_GraphicsContext );
     NUX_SAFE_DELETE( m_DeviceFactory );
 
-    // The XIM Controller needs to clean up before ~GraphicsDisplayX11
-    m_xim_controller.reset();
-
     if (m_CreatedFromForeignWindow == false)
     {
       DestroyOpenGLWindow();
@@ -258,16 +256,6 @@
   }
 #endif
 
-  void GraphicsDisplay::XICFocus()
-  {
-    m_xim_controller->FocusInXIC();
-  }
-
-  void GraphicsDisplay::XICUnFocus()
-  {
-    m_xim_controller->FocusOutXIC();
-  }
-
   // TODO: change windowWidth, windowHeight, to window_size;
   static NCriticalSection CreateOpenGLWindow_CriticalSection;
   bool GraphicsDisplay::CreateOpenGLWindow(const char* window_title,
@@ -659,16 +647,6 @@
       //XMapRaised(m_X11Display, m_X11Window);
     }
 
-    m_xim_controller = std::make_shared<XIMController>(m_X11Display);
-    m_xim_controller->SetFocusedWindow(m_X11Window);
-
-    if (m_xim_controller->IsXICValid())
-    {
-      long im_event_mask=0;
-      XGetICValues(m_xim_controller->GetXIC(), XNFilterEvents, &im_event_mask, NULL);
-      m_X11Attr.event_mask |= im_event_mask;
-    }
-
 #ifndef NUX_OPENGLES_20
     if (_has_glx_13)
     {
@@ -778,8 +756,6 @@
 
     gfx_interface_created_ = true;
 
-    m_xim_controller = std::make_shared<XIMController>(m_X11Display);
-
     // m_DeviceFactory = new GpuDevice(viewport_size_.GetWidth(), viewport_size_.GetHeight(), BITFMT_R8G8B8A8);
     m_DeviceFactory = new GpuDevice(viewport_size_.width, viewport_size_.height, BITFMT_R8G8B8A8,
         m_X11Display,
@@ -811,14 +787,9 @@
     return m_DeviceFactory;
   }
 
-  void GraphicsDisplay::SetFocusedWindowForXIMController(Window window)
-  {
-    m_xim_controller->SetFocusedWindow(window);
-  }
-
-  void GraphicsDisplay::RemoveFocusedWindowForXIMController()
-  {
-    m_xim_controller->RemoveFocusedWindow();
+  void GraphicsDisplay::SetCurrentXIC(XIC xic)
+  {
+    m_current_xic = xic;
   }
 
   int GraphicsDisplay::GetGlXMajor() const
@@ -1359,14 +1330,10 @@
       bool bProcessEvent = true;
       XNextEvent(m_X11Display, &xevent);
 
-      if ((xevent.type == KeyPress || xevent.type == KeyRelease) &&
-          m_xim_controller->GetCurrentWindow() != xevent.xkey.window)
-      {
-        m_xim_controller->SetFocusedWindow(xevent.xkey.window);
-      }
-
       if (XFilterEvent(&xevent, None) == True)
+      {
         return true;
+      }
 
       if (!_event_filters.empty())
       {
@@ -1687,7 +1654,6 @@
         m_pEvent->virtual_code = 0;
         //nuxDebugMsg("[GraphicsDisplay::ProcessXEvents]: FocusIn event.");
 
-        m_xim_controller->FocusInXIC();
         break;
       }
 
@@ -1704,7 +1670,6 @@
         m_pEvent->virtual_code = 0;
         //nuxDebugMsg("[GraphicsDisplay::ProcessXEvents]: FocusOut event.");
 
-        m_xim_controller->FocusOutXIC();
         break;
       }
 
@@ -1731,20 +1696,20 @@
             (keysym == NUX_VK_ESCAPE))
         {
           //temporary fix for TextEntry widget: filter some keys
-         skip = true;
+          skip = true;
         }
 
         if (!skip)
         {
           int num_char_stored = 0;
 
-          if (m_xim_controller->IsXICValid())
+          if (m_current_xic)
           {
             delete[] m_pEvent->dtext;
             m_pEvent->dtext = nullptr;
             Status status;
 
-            num_char_stored = XmbLookupString(m_xim_controller->GetXIC(), &xevent.xkey, nullptr,
+            num_char_stored = XmbLookupString(m_current_xic, &xevent.xkey, nullptr,
                                               0, (KeySym*) &m_pEvent->x11_keysym, &status);
 
             if (status == XLookupKeySym)
@@ -1755,7 +1720,7 @@
             {
               int buf_len = num_char_stored + 1;
               m_pEvent->dtext = new char[buf_len];
-              num_char_stored = XmbLookupString(m_xim_controller->GetXIC(), &xevent.xkey, m_pEvent->dtext,
+              num_char_stored = XmbLookupString(m_current_xic, &xevent.xkey, m_pEvent->dtext,
                                                 buf_len, (KeySym*) &m_pEvent->x11_keysym, nullptr);
 
               m_pEvent->dtext[num_char_stored] = 0;
 
=== modified file 'NuxGraphics/GraphicsDisplayX11.h'
--- NuxGraphics/GraphicsDisplayX11.h	2012-12-17 19:04:50 +0000
+++ NuxGraphics/GraphicsDisplayX11.h	2014-01-03 16:37:28 +0000
@@ -27,7 +27,6 @@
 #include "GLTimer.h"
 #include "GLDeviceObjects.h"
 #include "GLRenderStates.h"
-#include "XIMController.h"
 
 /* Xlib.h is the default header that is included and has the core functionallity */
 #include <X11/Xlib.h>
@@ -85,7 +84,7 @@
     Window      m_X11Window;
     XVisualInfo *m_X11VisualInfo;
 
-    std::shared_ptr<XIMController> m_xim_controller;
+    XIC m_current_xic;
 
     int         parent_window_;
 #ifndef NUX_OPENGLES_20
@@ -286,8 +285,7 @@
 
     GpuDevice* GetGpuDevice() const;
 
-    void SetFocusedWindowForXIMController(Window window);
-    void RemoveFocusedWindowForXIMController();
+    void SetCurrentXIC(XIC xic);
 
     // Dialog
     /*bool StartOpenFileDialog(FileDialogOption& fdo);
@@ -348,8 +346,6 @@
 
     void * KeyboardGrabData() { return _global_keyboard_grab_data; }
     void * PointerGrabData() { return _global_pointer_grab_data; }
-    void XICFocus();
-    void XICUnFocus();
 
   private:
     void InitGlobalGrabWindow();
 
=== modified file 'NuxGraphics/Makefile.am'
--- NuxGraphics/Makefile.am	2012-12-05 19:22:13 +0000
+++ NuxGraphics/Makefile.am	2014-01-03 16:37:28 +0000
@@ -93,9 +93,7 @@
 source_h += \
   $(srcdir)/GraphicsDisplayX11.h \
   $(srcdir)/VirtualKeyCodesX11.h \
-  $(srcdir)/XInputWindow.h \
-  $(srcdir)/XICClient.h \
-  $(srcdir)/XIMController.h
+  $(srcdir)/XInputWindow.h
 endif
 
 if !NUX_OPENGLES_20
@@ -170,9 +168,7 @@
 if USE_X11
 source_cpp += \
   $(srcdir)/GraphicsDisplayX11.cpp \
-  $(srcdir)/XInputWindow.cpp \
-  $(srcdir)/XICClient.cpp \
-  $(srcdir)/XIMController.cpp
+  $(srcdir)/XInputWindow.cpp
 endif
 
 if !NUX_OPENGLES_20
 
=== modified file 'NuxGraphics/XInputWindow.cpp'
--- NuxGraphics/XInputWindow.cpp	2013-07-18 23:07:45 +0000
+++ NuxGraphics/XInputWindow.cpp	2014-01-03 16:37:28 +0000
@@ -22,7 +22,6 @@
 #include "XInputWindow.h"
 #include "GraphicsDisplayX11.h"
 #include "GLThread.h"
-#include "XIMController.h"
 
 namespace nux
 {
@@ -396,8 +395,6 @@
 
   void XInputWindow::Hide()
   {
-    GetGraphicsDisplay()->RemoveFocusedWindowForXIMController();
-
     XMoveResizeWindow(display_, window_,
                       -100 - geometry_.width,
                       -100 - geometry_.height,
@@ -408,8 +405,6 @@
 
   void XInputWindow::Show()
   {
-    GetGraphicsDisplay()->SetFocusedWindowForXIMController(window_);
-
     shown_ = true;
     if (!mapped_)
     {
 
=== modified file 'configure.ac'
--- configure.ac	2013-10-29 22:13:58 +0000
+++ configure.ac	2014-01-03 16:37:28 +0000
@@ -15,7 +15,7 @@
 # 
 m4_define([nux_major_version], [4])
 m4_define([nux_minor_version], [0])
-m4_define([nux_micro_version], [4])
+m4_define([nux_micro_version], [5])
 
 m4_define([nux_api_version], [4.0])
 # Increase the number (to the current date) everytime you propose a branch that breaks the API or ABI
@@ -23,7 +23,7 @@
 # e.g.: december 5th, 2011 is: 20111205
 # To make more than one API change in a day, add a number to the date. Like 20111205.xx
 
-m4_define([nux_abi_version], [20131029.0])
+m4_define([nux_abi_version], [20131203.0])
 m4_define([nux_version],
           [nux_major_version.nux_minor_version.nux_micro_version])
 
 
=== modified file 'debian/changelog'
--- debian/changelog	2013-10-29 22:13:58 +0000
+++ debian/changelog	2014-01-03 16:37:28 +0000
@@ -1,3 +1,11 @@
+nux (4.0.5-0ubuntu1) UNRELEASED; urgency=low
+
+  [ Brandon Schaefer ]
+  * Add XIM preedit support
+  * Bump version to 4.0.5
+
+ -- Brandon Schaefer <[e-mail]>  Fri, 03 Jan 2014 08:31:35 -0800
+
 nux (4.0.4-0ubuntu1) UNRELEASED; urgency=low
 
   [ Sam Spilsbury ]