Replace PeekMessage for TSF awareness

base/message_pump_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 "base/message_pump_win.h"
 
+#include <imm.h>
 #include <math.h>
+#include <msctf.h>
+#include <Windows.h>
 
 #include "base/debug/trace_event.h"
 #include "base/message_loop.h"
 #include "base/metrics/histogram.h"
 #include "base/process_util.h"
+#include "base/win/metro.h"
+#include "base/win/scoped_comptr.h"
 #include "base/win/wrapped_window_proc.h"
 
+namespace base {
+
+static const wchar_t kWndClass[] = L"Chrome_MessagePumpWindow";
+
+// Message sent to get an additional time slice for pumping (processing) another
+// task (a series of such messages creates a continuous task pump).
+static const int kMsgHaveWork = WM_USER + 1;
+
+class MessagePumpTSFInternal {
+ public:
+  TfClientId client_id;
+  bool is_initialized;
+  base::win::ScopedComPtr<ITfThreadMgr> thread_mgr;
+  base::win::ScopedComPtr<ITfMessagePump> message_pump;
+  base::win::ScopedComPtr<ITfKeystrokeMgr> keystroke_mgr;
+  MessagePumpTSFInternal()
+      : client_id(TF_CLIENTID_NULL), is_initialized(true) {
+    is_initialized &= SUCCEEDED(thread_mgr.CreateInstance(CLSID_TF_ThreadMgr));
+    if (!thread_mgr)
+      return;
+
+    is_initialized &= SUCCEEDED(message_pump.QueryFrom(thread_mgr));
+    is_initialized &= SUCCEEDED(keystroke_mgr.QueryFrom(thread_mgr));
+    // When activate succeeded, |client_id| is set valid value.
+    is_initialized &= SUCCEEDED(thread_mgr->Activate(&client_id));
+  }
+  ~MessagePumpTSFInternal() {
+    if (thread_mgr && client_id != TF_CLIENTID_NULL)
+      thread_mgr->Deactivate();
+  }
+
+  bool ForwardKeyMessageForTSF(const MSG& msg) {
+    if (!is_initialized)
+      return false;
+
+    if(msg.message == WM_KEYDOWN) {
+      BOOL eaten = FALSE;
+      HRESULT hr = keystroke_mgr->TestKeyDown(msg.wParam, msg.lParam, &eaten);
+      if (FAILED(hr) && !eaten)
+        return false;
+      eaten = FALSE;
+      hr = keystroke_mgr->KeyDown(msg.wParam, msg.lParam, &eaten);
+      return (SUCCEEDED(hr) && eaten);
+    }
+
+    if(msg.message == WM_KEYUP) {
+      BOOL eaten = FALSE;
+      HRESULT hr = keystroke_mgr->TestKeyUp(msg.wParam, msg.lParam, &eaten);
+      if (FAILED(hr) && !eaten)
+        return false;
+      eaten = FALSE;
+      hr = keystroke_mgr->KeyUp(msg.wParam, msg.lParam, &eaten);
+      return (SUCCEEDED(hr) && eaten);
+    }
+
+    return false;
+  }
+
+  bool PeekMessageForTSF(MSG* msg, HWND hwnd, UINT wmin, UINT wmax, UINT wmsg) {
+    if (!is_initialized)
+      // FallBack.
+      return !!::PeekMessage(msg, hwnd, wmin, wmax, wmsg);
+
+    BOOL result = FALSE;
+    if(FAILED(message_pump->PeekMessage(msg, hwnd, wmin, wmax, wmsg, &result)))
+      result = FALSE;
+    return !!result;
+  }
+};
+
 namespace {
 
 enum MessageLoopProblems {
   MESSAGE_POST_ERROR,
   COMPLETION_POST_ERROR,
   SET_TIMER_ERROR,
   MESSAGE_LOOP_PROBLEM_MAX,
 };
 
 }  // namespace
 
-namespace base {
-
-static const wchar_t kWndClass[] = L"Chrome_MessagePumpWindow";
-
-// Message sent to get an additional time slice for pumping (processing) another
-// task (a series of such messages creates a continuous task pump).
-static const int kMsgHaveWork = WM_USER + 1;
-
 //-----------------------------------------------------------------------------
 // MessagePumpWin public:
 
 void MessagePumpWin::AddObserver(MessagePumpObserver* observer) {
   observers_.AddObserver(observer);
 }
 
 void MessagePumpWin::RemoveObserver(MessagePumpObserver* observer) {
   observers_.RemoveObserver(observer);
 }
@@ skipping 46 matching lines @@
     delay = 0;
 
   return delay;
 }
 
 //-----------------------------------------------------------------------------
 // MessagePumpForUI public:
 
 MessagePumpForUI::MessagePumpForUI() : instance_(NULL) {
   InitMessageWnd();
+
+  if (base::win::IsTsfAwareRequired())
+    tsf_message_pump_.reset(new MessagePumpTSFInternal);
 }
 
 MessagePumpForUI::~MessagePumpForUI() {
+  if (base::win::IsTsfAwareRequired())
+    tsf_message_pump_.reset(NULL);
   DestroyWindow(message_hwnd_);
   UnregisterClass(kWndClass, instance_);
 }
 
 void MessagePumpForUI::ScheduleWork() {
   if (InterlockedExchange(&have_work_, 1))
     return;  // Someone else continued the pumping.
 
   // Make sure the MessagePump does some work for us.
   BOOL ret = PostMessage(message_hwnd_, kMsgHaveWork,
@@ skipping 62 matching lines @@
     return;
 
   // Create a mini-message-pump to force immediate processing of only Windows
   // WM_PAINT messages.  Don't provide an infinite loop, but do enough peeking
   // to get the job done.  Actual common max is 4 peeks, but we'll be a little
   // safe here.
   const int kMaxPeekCount = 20;
   int peek_count;
   for (peek_count = 0; peek_count < kMaxPeekCount; ++peek_count) {
     MSG msg;
-    if (!PeekMessage(&msg, NULL, 0, 0, PM_REMOVE | PM_QS_PAINT))
+    if (!PeekMessageInternal(&msg, NULL, 0, 0, PM_REMOVE | PM_QS_PAINT))
       break;
     ProcessMessageHelper(msg);
     if (state_->should_quit)  // Handle WM_QUIT.
       break;
   }
   // Histogram what was really being used, to help to adjust kMaxPeekCount.
   DHISTOGRAM_COUNTS("Loop.PumpOutPendingPaintMessages Peeks", peek_count);
 }
 
 //-----------------------------------------------------------------------------
@@ skipping 101 matching lines @@
     // This causes the MsgWaitForMultipleObjectsEx API to return indicating
     // that messages are ready for processing (specifically mouse messages
     // intended for the child window. Occurs if the child window has capture)
     // The subsequent PeekMessages call fails to return any messages thus
     // causing us to enter a tight loop at times.
     // The WaitMessage call below is a workaround to give the child window
     // sometime to process its input messages.
     MSG msg = {0};
     DWORD queue_status = GetQueueStatus(QS_MOUSE);
     if (HIWORD(queue_status) & QS_MOUSE &&
-       !PeekMessage(&msg, NULL, WM_MOUSEFIRST, WM_MOUSELAST, PM_NOREMOVE)) {
+       !PeekMessageInternal(&msg, NULL, WM_MOUSEFIRST, WM_MOUSELAST,
+                            PM_NOREMOVE)) {
       WaitMessage();
     }
     return;
   }
 
   DCHECK_NE(WAIT_FAILED, result) << GetLastError();
 }
 
 void MessagePumpForUI::HandleWorkMessage() {
   // If we are being called outside of the context of Run, then don't try to do
@@ skipping 36 matching lines @@
   // If there are sent messages in the queue then PeekMessage internally
   // dispatches the message and returns false. We return true in this
   // case to ensure that the message loop peeks again instead of calling
   // MsgWaitForMultipleObjectsEx again.
   bool sent_messages_in_queue = false;
   DWORD queue_status = GetQueueStatus(QS_SENDMESSAGE);
   if (HIWORD(queue_status) & QS_SENDMESSAGE)
     sent_messages_in_queue = true;
 
   MSG msg;
-  if (PeekMessage(&msg, NULL, 0, 0, PM_REMOVE))
+  if (PeekMessageInternal(&msg, NULL, 0, 0, PM_REMOVE))
     return ProcessMessageHelper(msg);
 
   return sent_messages_in_queue;
 }
 
 bool MessagePumpForUI::ProcessMessageHelper(const MSG& msg) {
   TRACE_EVENT1("base", "MessagePumpForUI::ProcessMessageHelper",
                "message", msg.message);
   if (WM_QUIT == msg.message) {
     // Repost the QUIT message so that it will be retrieved by the primary
     // GetMessage() loop.
     state_->should_quit = true;
     PostQuitMessage(static_cast<int>(msg.wParam));
     return false;
   }
 
   // While running our main message pump, we discard kMsgHaveWork messages.
   if (msg.message == kMsgHaveWork && msg.hwnd == message_hwnd_)
     return ProcessPumpReplacementMessage();
 
   if (CallMsgFilter(const_cast<MSG*>(&msg), kMessageFilterCode))
     return true;
 
   WillProcessMessage(msg);
 
-  if (state_->dispatcher) {
-    if (!state_->dispatcher->Dispatch(msg))
-      state_->should_quit = true;
-  } else {
-    TranslateMessage(&msg);
-    DispatchMessage(&msg);
+  bool is_key_dispatched_by_tsf = false;
+  if (base::win::IsTsfAwareRequired()) {
+    is_key_dispatched_by_tsf = tsf_message_pump_->ForwardKeyMessageForTSF(msg);
+  }
+
+  if (!is_key_dispatched_by_tsf) {
+    if (state_->dispatcher) {
+      if (!state_->dispatcher->Dispatch(msg))
+        state_->should_quit = true;
+    } else {
+      TranslateMessage(&msg);
+      DispatchMessage(&msg);
+    }
   }
 
   DidProcessMessage(msg);
   return true;
 }
 
 bool MessagePumpForUI::ProcessPumpReplacementMessage() {
   // When we encounter a kMsgHaveWork message, this method is called to peek
   // and process a replacement message, such as a WM_PAINT or WM_TIMER.  The
   // goal is to make the kMsgHaveWork as non-intrusive as possible, even though
   // a continuous stream of such messages are posted.  This method carefully
   // peeks a message while there is no chance for a kMsgHaveWork to be pending,
   // then resets the have_work_ flag (allowing a replacement kMsgHaveWork to
   // possibly be posted), and finally dispatches that peeked replacement.  Note
   // that the re-post of kMsgHaveWork may be asynchronous to this thread!!
 
   bool have_message = false;
   MSG msg;
   // We should not process all window messages if we are in the context of an
   // OS modal loop, i.e. in the context of a windows API call like MessageBox.
   // This is to ensure that these messages are peeked out by the OS modal loop.
   if (MessageLoop::current()->os_modal_loop()) {
     // We only peek out WM_PAINT and WM_TIMER here for reasons mentioned above.
-    have_message = PeekMessage(&msg, NULL, WM_PAINT, WM_PAINT, PM_REMOVE) ||
-                   PeekMessage(&msg, NULL, WM_TIMER, WM_TIMER, PM_REMOVE);
+    have_message =
+      PeekMessageInternal(&msg, NULL, WM_PAINT, WM_PAINT, PM_REMOVE) ||
+      PeekMessageInternal(&msg, NULL, WM_TIMER, WM_TIMER, PM_REMOVE);
   } else {
-    have_message = (0 != PeekMessage(&msg, NULL, 0, 0, PM_REMOVE));
+    have_message = PeekMessageInternal(&msg, NULL, 0, 0, PM_REMOVE);
   }
 
   DCHECK(!have_message || kMsgHaveWork != msg.message ||
          msg.hwnd != message_hwnd_);
 
   // Since we discarded a kMsgHaveWork message, we must update the flag.
   int old_have_work = InterlockedExchange(&have_work_, 0);
   DCHECK(old_have_work);
 
   // We don't need a special time slice if we didn't have_message to process.
   if (!have_message)
     return false;
 
   // Guarantee we'll get another time slice in the case where we go into native
   // windows code.   This ScheduleWork() may hurt performance a tiny bit when
   // tasks appear very infrequently, but when the event queue is busy, the
   // kMsgHaveWork events get (percentage wise) rarer and rarer.
   ScheduleWork();
   return ProcessMessageHelper(msg);
 }
 
+bool MessagePumpForUI::PeekMessageInternal(
+    MSG* msg, HWND hwnd, UINT wmin, UINT wmax, UINT wmsg) {
+  if (base::win::IsTsfAwareRequired())
+    return tsf_message_pump_->PeekMessageForTSF(msg, hwnd, wmin, wmax, wmsg);
+
+  return !!::PeekMessage(msg, hwnd, wmin, wmax, wmsg);
+}
+
 //-----------------------------------------------------------------------------
 // MessagePumpForIO public:
 
 MessagePumpForIO::MessagePumpForIO() {
   port_.Set(CreateIoCompletionPort(INVALID_HANDLE_VALUE, NULL, NULL, 1));
   DCHECK(port_.IsValid());
 }
 
 void MessagePumpForIO::ScheduleWork() {
   if (InterlockedExchange(&have_work_, 1))
@@ skipping 163 matching lines @@
 
 void MessagePumpForIO::WillProcessIOEvent() {
   FOR_EACH_OBSERVER(IOObserver, io_observers_, WillProcessIOEvent());
 }
 
 void MessagePumpForIO::DidProcessIOEvent() {
   FOR_EACH_OBSERVER(IOObserver, io_observers_, DidProcessIOEvent());
 }
 
 }  // namespace base