Re-enable CJK omnibox suggest on Metro UI

chrome/browser/ui/views/omnibox/omnibox_view_win.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/ui/views/omnibox/omnibox_view_win.h"
 
 #include <algorithm>
 #include <locale>
 #include <string>
 
 #include <richedit.h>
 #include <textserv.h>
 
 #include "base/auto_reset.h"
 #include "base/basictypes.h"
+#include "base/bind.h"
 #include "base/i18n/rtl.h"
 #include "base/lazy_instance.h"
 #include "base/memory/ref_counted.h"
 #include "base/string_util.h"
 #include "base/utf_string_conversions.h"
 #include "base/win/iat_patch_function.h"
 #include "base/win/metro.h"
 #include "base/win/scoped_hdc.h"
 #include "base/win/scoped_select_object.h"
 #include "base/win/windows_version.h"
@@ skipping 20 matching lines @@
 #include "ui/base/accessibility/accessible_view_state.h"
 #include "ui/base/clipboard/clipboard.h"
 #include "ui/base/clipboard/scoped_clipboard_writer.h"
 #include "ui/base/dragdrop/drag_drop_types.h"
 #include "ui/base/dragdrop/drag_source.h"
 #include "ui/base/dragdrop/drop_target.h"
 #include "ui/base/dragdrop/os_exchange_data.h"
 #include "ui/base/dragdrop/os_exchange_data_provider_win.h"
 #include "ui/base/events/event.h"
 #include "ui/base/events/event_constants.h"
+#include "ui/base/ime/win/tsf_bridge.h"
+#include "ui/base/ime/win/tsf_event_router.h"
 #include "ui/base/keycodes/keyboard_codes.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/l10n/l10n_util_win.h"
 #include "ui/base/win/mouse_wheel_util.h"
 #include "ui/gfx/canvas.h"
 #include "ui/gfx/image/image.h"
 #include "ui/views/button_drag_utils.h"
 #include "ui/views/controls/menu/menu_item_view.h"
 #include "ui/views/controls/menu/menu_model_adapter.h"
 #include "ui/views/controls/menu/menu_runner.h"
@@ skipping 465 matching lines @@
     // Non-read-only edit controls have a drop target.  Revoke it so that we can
     // install our own.  Revoking automatically deletes the existing one.
     HRESULT hr = RevokeDragDrop(m_hWnd);
     DCHECK_EQ(S_OK, hr);
 
     // Register our drop target.  The scoped_refptr here will delete the drop
     // target if it fails to register itself correctly on |m_hWnd|.  Otherwise,
     // the edit control will invoke RevokeDragDrop when it's being destroyed, so
     // we don't have to do so.
     scoped_refptr<EditDropTarget> drop_target(new EditDropTarget(this));
+
+    if (base::win::IsTsfAwareRequired())
+      tsf_event_router_ = ui::TsfEventRouter::Create();
   }
 }
 
 OmniboxViewWin::~OmniboxViewWin() {
   // Explicitly release the text object model now that we're done with it, and
   // before we free the library. If the library gets unloaded before this
   // released, it becomes garbage. Note that since text_object_model_ is lazy
   // initialized, it may still be null.
   if (text_object_model_)
     text_object_model_->Release();
 
   // We balance our reference count and unpatch when the last instance has
   // been destroyed.  This prevents us from relying on the AtExit or static
   // destructor sequence to do our unpatching, which is generally fragile.
   g_paint_patcher.Pointer()->DerefPatch();
+
+  if (tsf_event_router_)

[Peter Kasting, 2012/10/19 18:40:57]

Tiny nit: This should probably go above the paint patcher bit, since that object
was inited first (and it's best to shut things down in the reverse order of
startup)

[Seigo Nonaka, 2012/10/22 03:11:04]

Done.

+    tsf_event_router_->SetManager(NULL, NULL);
 }
 
 views::View* OmniboxViewWin::parent_view() const {
   return parent_view_;
 }
 
 void OmniboxViewWin::SaveStateToTab(WebContents* tab) {
   DCHECK(tab);
 
   const OmniboxEditModel::State model_state(model()->GetStateForTabSwitch());
@@ skipping 340 matching lines @@
         native_view_host_,
         ui::AccessibilityTypes::EVENT_SELECTION_CHANGED,
         true);
   } else if (delete_at_end_pressed_) {
     model()->OnChanged();
   }
 
   return something_changed;
 }
 
+void OmniboxViewWin::OnTextUpdated() {
+  if (ignore_ime_messages_)
+    return;
+  OnAfterPossibleChangeInternal(true);
+  // Call OnBeforePossibleChange function here to get correct diff in next IME
+  // update. The Text Services Framework does not provide any notification
+  // before entering edit session, therefore we don't have good place to call
+  // OnBeforePossibleChange.
+  OnBeforePossibleChange();
+}
+
+void OmniboxViewWin::OnCandidateWindowCountChanged(size_t window_count) {
+  ime_candidate_window_open_ = (window_count != 0);
+  if (ime_candidate_window_open_) {
+    CloseOmniboxPopup();
+  } else if (model()->user_input_in_progress()) {
+    // UpdatePopup assumes user input is in progress, so only call it if
+    // that's the case. Otherwise, autocomplete may run on an empty user
+    // text.
+    UpdatePopup();
+  }
+}
+
 gfx::NativeView OmniboxViewWin::GetNativeView() const {
   return m_hWnd;
 }
 
 // static
 gfx::NativeView OmniboxViewWin::GetRelativeWindowForNativeView(
     gfx::NativeView edit_native_view) {
   // When an IME is attached to the rich-edit control, retrieve its window
   // handle, and the popup window of OmniboxPopupView will be shown under the
   // IME windows.
@@ skipping 15 matching lines @@
 
 int OmniboxViewWin::TextWidth() const {
   return WidthNeededToDisplay(GetText());
 }
 
 string16 OmniboxViewWin::GetInstantSuggestion() const {
   return parent_view_->GetInstantSuggestion();
 }
 
 bool OmniboxViewWin::IsImeComposing() const {
+  if (tsf_event_router_)
+    return tsf_event_router_->IsImeComposing();
   bool ime_composing = false;
   HIMC context = ImmGetContext(m_hWnd);
   if (context) {
     ime_composing = !!ImmGetCompositionString(context, GCS_COMPSTR, NULL, 0);
     ImmReleaseContext(m_hWnd, context);
   }
   return ime_composing;
 }
 
 int OmniboxViewWin::GetMaxEditWidth(int entry_width) const {
@@ skipping 408 matching lines @@
 LRESULT OmniboxViewWin::OnCreate(const CREATESTRUCTW* /*create_struct*/) {
   if (base::win::IsTsfAwareRequired()) {
     // Enable TSF support of RichEdit.
     SetEditStyle(SES_USECTF, SES_USECTF);
   }
   if (base::win::GetVersion() >= base::win::VERSION_WIN8) {
     BOOL touch_mode = RegisterTouchWindow(m_hWnd, TWF_WANTPALM);
     DCHECK(touch_mode);
   }
   SetMsgHandled(FALSE);
+
+  // To ensure OnBeforePossibleChange is called before any
+  // OnAfterPossibleChange call, we call OnBeforePossibleChange here. In the
+  // case of a pure TSF environment like on Metro UI, we can't get any chance
+  // to call OnBeforePossibleChange at the beginning of an edit session, if we

[Peter Kasting, 2012/10/19 18:40:57]

Nit: Slightly clearer:

  // When TSF is enabled, OnTextUpdated() may be called without any previous
  // call that would have indicated the start of an editing session.  In order
  // to guarantee we've always called OnBeforePossibleChange() before
  // OnAfterPossibleChange(), we therefore call that here.  Note that multiple
  // (i.e. unmatched) calls to this function in a row are safe.

[Seigo Nonaka, 2012/10/22 03:11:04]

Done.

+  // do not call OnBeforePossibleChange here, we would call
+  // OnAfterPossibleChange on the end of edit session without any
+  // OnBeforePossibleChange call.
+  OnBeforePossibleChange();

[Peter Kasting, 2012/10/19 18:40:57]

You should only do this when |tsf_event_router_| is non-NULL.

[Seigo Nonaka, 2012/10/22 03:11:04]

Done.

   return 0;
 }
 
 void OmniboxViewWin::OnCut() {
   OnCopy();
 
   // This replace selection will have no effect (even on the undo stack) if the
   // current selection is empty.
   ReplaceSel(L"", true);
 }
@@ skipping 186 matching lines @@
   // an in-progress IME composition will be completed at the new caret position,
   // resulting in the string jumping unexpectedly to the front of the edit.
   //
   // Crazy hack: If we just do PlaceCaretAt(0), and the beginning of the text is
   // currently scrolled out of view, we can wind up with a blinking cursor in
   // the toolbar at the current X coordinate of the beginning of the text.  By
   // first doing a reverse-select-all to scroll the beginning of the text into
   // view, we work around this CRichEditCtrl bug.
   SelectAll(true);
   PlaceCaretAt(0);
+
+  if (tsf_event_router_)
+    tsf_event_router_->SetManager(NULL, NULL);
 }
 
 void OmniboxViewWin::OnLButtonDblClk(UINT keys, const CPoint& point) {
   // Save the double click info for later triple-click detection.
   tracking_double_click_ = true;
   double_click_point_ = point;
   double_click_time_ = GetCurrentMessage()->time;
   possible_drag_ = false;
 
   // Modifying the selection counts as accepting any inline autocompletion, so
@@ skipping 307 matching lines @@
   }
 
   model()->OnSetFocus(GetKeyState(VK_CONTROL) < 0);
 
   // Restore saved selection if available.
   if (saved_selection_for_focus_change_.cpMin != -1) {
     SetSelectionRange(saved_selection_for_focus_change_);
     saved_selection_for_focus_change_.cpMin = -1;
   }
 
-  SetMsgHandled(false);
+  if (!tsf_event_router_) {
+    SetMsgHandled(false);
+  } else {
+    DefWindowProc();
+    // Document manager created by RichEdit can be obtained only after
+    // WM_SETFOCUS event is handled.
+    tsf_event_router_->SetManager(
+        ui::TsfBridge::GetInstance()->GetThreadManager(),
+        this);
+    SetMsgHandled(true);
+  }
 }
 
 LRESULT OmniboxViewWin::OnSetText(const wchar_t* text) {
   // Ignore all IME messages while we process this WM_SETTEXT message.
   // When SetWindowText() is called while an IME is composing text, the IME
   // calls SendMessage() to send a WM_IME_COMPOSITION message. When we receive
   // this WM_IME_COMPOSITION message, we update the omnibox and may call
   // SetWindowText() again. To stop this recursive message-handler call, we
   // stop updating the omnibox while we process a WM_SETTEXT message.
   // We wouldn't need to do this update anyway, because either we're in the
@@ skipping 779 matching lines @@
   return (rect.left - client_rect.left) + (client_rect.right - rect.right);
 }
 
 int OmniboxViewWin::WidthNeededToDisplay(const string16& text) const {
   // Use font_.GetStringWidth() instead of
   // PosFromChar(location_entry_->GetTextLength()) because PosFromChar() is
   // apparently buggy. In both LTR UI and RTL UI with left-to-right layout,
   // PosFromChar(i) might return 0 when i is greater than 1.
   return font_.GetStringWidth(text) + GetHorizontalMargin();
 }