Unify InputMethodIMM32 into InputMethodWin again

ui/base/ime/input_method_win.h

 // Copyright (c) 2011 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.
 
 #ifndef UI_BASE_IME_INPUT_METHOD_WIN_H_
 #define UI_BASE_IME_INPUT_METHOD_WIN_H_
 
 #include <windows.h>
 
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "ui/base/ime/input_method_base.h"
 #include "ui/base/ime/win/imm32_manager.h"
 
 namespace ui {
 
 // A common InputMethod implementation shared between IMM32 and TSF.

[yukawa, 2014/02/19 06:53:43]

Oops, I'll update this line too.

[yukawa, 2014/02/19 10:02:42]

Done.

 class UI_BASE_EXPORT InputMethodWin : public InputMethodBase {
  public:
   InputMethodWin(internal::InputMethodDelegate* delegate,
                  HWND toplevel_window_handle);
 
+ private:

[Yuki, 2014/02/19 05:37:13]

I think InputMethodWin is just a concrete implementation of InputMethod, and
it's not good to change the visibility.  Public methods should remain as
public:.

[yukawa, 2014/02/19 06:53:43]

Hmm, I sometimes use this style but I'll follow your suggestion if you dislike
this style?
Have you read this sort of articles?
http://stackoverflow.com/questions/2170688/private-virtual-method-in-c
What do you think?

[Yuki, 2014/02/19 07:13:57]

Good article, but it wouldn't apply to this case.  Whether or not you made these
methods private: or not, they're public: in the most superclass InputMethod, and
they're callable.

  InputMethodWin* a = new InputMethodWin(...);
  InputMethod* b = a;
  a->IsActive();  // Invalid call because of private:
  b->IsActive();  // Okay

This difference doesn't make much sense IMHO, especially when we'd like a is-a
relationship between them.

[yukawa, 2014/02/19 10:02:42]

Done. I left public and protected as they are. Do they fit your request?

On 2014/02/19 07:13:57, Yuki wrote:

   // Overridden from InputMethod:
   virtual void Init(bool focused) OVERRIDE;
+  virtual void OnFocus() OVERRIDE;
+  virtual void OnBlur() OVERRIDE;
+  virtual bool OnUntranslatedIMEMessage(const base::NativeEvent& event,
+                                        NativeEventResult* result) OVERRIDE;
   virtual bool DispatchKeyEvent(const ui::KeyEvent& event) OVERRIDE;
+  virtual void OnTextInputTypeChanged(const TextInputClient* client) OVERRIDE;
+  virtual void OnCaretBoundsChanged(const TextInputClient* client) OVERRIDE;
+  virtual void CancelComposition(const TextInputClient* client) OVERRIDE;
   virtual void OnInputLocaleChanged() OVERRIDE;
   virtual std::string GetInputLocale() OVERRIDE;
   virtual bool IsActive() OVERRIDE;
+  virtual bool IsCandidatePopupOpen() const OVERRIDE;
 
- protected:
   // Overridden from InputMethodBase:
   // If a derived class overrides this method, it should call parent's
   // implementation.
+  virtual void OnWillChangeFocusedClient(TextInputClient* focused_before,
+                                         TextInputClient* focused) OVERRIDE;
   virtual void OnDidChangeFocusedClient(TextInputClient* focused_before,
                                         TextInputClient* focused) OVERRIDE;
 
-  // Some IMEs rely on WM_IME_REQUEST message even when TSF is enabled. So
-  // OnImeRequest (and its actual implementations as OnDocumentFeed,
-  // OnReconvertString, and OnQueryCharPosition) are placed in this base class.
-  LRESULT OnImeRequest(UINT message,
-                       WPARAM wparam,
-                       LPARAM lparam,
-                       BOOL* handled);
   // For both WM_CHAR and WM_SYSCHAR
   LRESULT OnChar(HWND window_handle,
                  UINT message,
                  WPARAM wparam,
                  LPARAM lparam,
                  BOOL* handled);
 
+  LRESULT OnImeSetContext(HWND window_handle,
+                          UINT message,
+                          WPARAM wparam,
+                          LPARAM lparam,
+                          BOOL* handled);
+  LRESULT OnImeStartComposition(HWND window_handle,
+                                UINT message,
+                                WPARAM wparam,
+                                LPARAM lparam,
+                                BOOL* handled);
+  LRESULT OnImeComposition(HWND window_handle,
+                           UINT message,
+                           WPARAM wparam,
+                           LPARAM lparam,
+                           BOOL* handled);
+  LRESULT OnImeEndComposition(HWND window_handle,
+                              UINT message,
+                              WPARAM wparam,
+                              LPARAM lparam,
+                              BOOL* handled);
+  LRESULT OnImeNotify(UINT message,
+                      WPARAM wparam,
+                      LPARAM lparam,
+                      BOOL* handled);
+
+  // Some IMEs rely on WM_IME_REQUEST message even when TSF is enabled. So
+  // OnImeRequest (and its actual implementations as OnDocumentFeed,
+  // OnReconvertString, and OnQueryCharPosition) are placed in this base class.
+  LRESULT OnImeRequest(UINT message,
+                       WPARAM wparam,
+                       LPARAM lparam,
+                       BOOL* handled);
   LRESULT OnDocumentFeed(RECONVERTSTRING* reconv);
   LRESULT OnReconvertString(RECONVERTSTRING* reconv);
   LRESULT OnQueryCharPosition(IMECHARPOSITION* char_positon);
 
   // Returns the window handle to which |text_input_client| is bound.
   // On Aura environment, |toplevel_window_handle_| is always returned.
   HWND GetAttachedWindowHandle(const TextInputClient* text_input_client) const;
 
   // Returns true if the Win32 native window bound to |client| is considered
   // to be ready for receiving keyboard input.
   bool IsWindowFocused(const TextInputClient* client) const;
 
-  // Indicates if the current input locale has an IME.
-  bool active_;
+  bool DispatchFabricatedKeyEvent(const ui::KeyEvent& event);
+
+  // Asks the client to confirm current composition text.
+  void ConfirmCompositionText();
+
+  // Enables or disables the IME according to the current text input type.
+  void UpdateIMEState();
 
   // Windows IMM32 wrapper.
   // (See "ui/base/ime/win/ime_input.h" for its details.)
   ui::IMM32Manager imm32_manager_;
 
- private:
-  bool DispatchFabricatedKeyEvent(const ui::KeyEvent& event);
-
   // The toplevel window handle.
   // On non-Aura environment, this value is not used and always NULL.
   const HWND toplevel_window_handle_;
 
   // Name of the current input locale.
   std::string locale_;
 
   // The new text direction and layout alignment requested by the user by
   // pressing ctrl-shift. It'll be sent to the text input client when the key
   // is released.
   base::i18n::TextDirection pending_requested_direction_;
 
   // Represents if WM_CHAR[wparam=='\r'] should be dispatched to the focused
   // text input client or ignored silently. This flag is introduced as a quick
   // workaround against crbug.com/319100
   // TODO(yukawa, IME): Figure out long-term solution.
   bool accept_carriage_return_;
 
+  // Indicates if the current input locale has an IME.
+  bool active_;
+
+  // True when an IME should be allowed to process key events.
+  bool enabled_;
+
+  // True if we know for sure that a candidate window is open.
+  bool is_candidate_popup_open_;
+
+  // Window handle where composition is on-going. NULL when there is no
+  // composition.
+  HWND composing_window_handle_;
+
   DISALLOW_COPY_AND_ASSIGN(InputMethodWin);
 };
 
 }  // namespace ui
 
 #endif  // UI_BASE_IME_INPUT_METHOD_WIN_H_