IME refactoring: ChromeOS introduce input methods State.

chrome/browser/chromeos/input_method/input_method_manager_impl.h

 // 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.
 
 #ifndef CHROME_BROWSER_CHROMEOS_INPUT_METHOD_INPUT_METHOD_MANAGER_IMPL_H_
 #define CHROME_BROWSER_CHROMEOS_INPUT_METHOD_INPUT_METHOD_MANAGER_IMPL_H_
 
 #include <map>
 #include <string>
 #include <vector>
@@ skipping 12 matching lines @@
 class ComponentExtensionIMEManagerDelegate;
 class InputMethodEngine;
 namespace input_method {
 class InputMethodDelegate;
 class ImeKeyboard;
 
 // The implementation of InputMethodManager.
 class InputMethodManagerImpl : public InputMethodManager,
                                public CandidateWindowController::Observer {
  public:
+  class State : public InputMethodManager::State {
+   public:
+    State();
+
+    // Init new state as a copy of other.
+    void InitFrom(const State& other);
+
+    std::string Dump() const;
+
+    std::string state_name;
+
+    // The input method which was/is selected.
+    InputMethodDescriptor previous_input_method_;
+    InputMethodDescriptor current_input_method_;
+    // The active input method ids cache.
+    std::vector<std::string> active_input_method_ids_;
+
+    // For screen locker. When the screen is locked, |previous_input_method_|,
+    // |current_input_method_|, and |active_input_method_ids_| above are copied
+    // to these "saved" variables.
+    InputMethodDescriptor saved_previous_input_method_;
+    InputMethodDescriptor saved_current_input_method_;
+    std::vector<std::string> saved_active_input_method_ids_;
+
+    // The engine map:
+    //   { input_method_id : Engine }.

[Shu Chen, 2014/08/07 15:40:19]

s/input_method_id/extension_id

[Alexander Alekseev, 2014/08/13 10:14:15]

Done.

+    typedef std::map<std::string, InputMethodEngineInterface*> EngineMap;
+    EngineMap engine_map_;

[Shu Chen, 2014/08/07 15:40:19]

The engine_map_ is not profile based now, and it's shared for multiple users.
So please keep this out of State.

[Alexander Alekseev, 2014/08/13 10:14:15]

Done.

+
+   protected:
+    friend base::RefCounted<chromeos::input_method::InputMethodManager::State>;
+    virtual ~State();
+  };
+
   // Constructs an InputMethodManager instance. The client is responsible for
-  // calling |SetState| in response to relevant changes in browser state.
+  // calling |SetUISessionState| in response to relevant changes in browser
+  // state.
   explicit InputMethodManagerImpl(scoped_ptr<InputMethodDelegate> delegate);
   virtual ~InputMethodManagerImpl();
 
-  // Receives notification of an InputMethodManager::State transition.
-  void SetState(State new_state);
+  // Receives notification of an InputMethodManager::UISessionState transition.
+  void SetUISessionState(UISessionState new_ui_session);
 
   // InputMethodManager override:
   virtual void InitializeComponentExtension() OVERRIDE;
   virtual void AddObserver(InputMethodManager::Observer* observer) OVERRIDE;
   virtual void AddCandidateWindowObserver(
       InputMethodManager::CandidateWindowObserver* observer) OVERRIDE;
   virtual void RemoveObserver(InputMethodManager::Observer* observer) OVERRIDE;
   virtual void RemoveCandidateWindowObserver(
       InputMethodManager::CandidateWindowObserver* observer) OVERRIDE;
   virtual scoped_ptr<InputMethodDescriptors>
@@ skipping 36 matching lines @@
 
   virtual ImeKeyboard* GetImeKeyboard() OVERRIDE;
   virtual InputMethodUtil* GetInputMethodUtil() OVERRIDE;
   virtual ComponentExtensionIMEManager*
       GetComponentExtensionIMEManager() OVERRIDE;
   virtual bool IsLoginKeyboard(const std::string& layout) const OVERRIDE;
 
   virtual bool MigrateInputMethods(
       std::vector<std::string>* input_method_ids) OVERRIDE;
 
+  virtual scoped_refptr<InputMethodManager::State> CreateNewState(
+      const std::string& debug_name) const OVERRIDE;
+  virtual void SetState(
+      scoped_refptr<InputMethodManager::State> state) OVERRIDE;
+
   // Sets |candidate_window_controller_|.
   void SetCandidateWindowControllerForTesting(
       CandidateWindowController* candidate_window_controller);
   // Sets |keyboard_|.
   void SetImeKeyboardForTesting(ImeKeyboard* keyboard);
   // Initialize |component_extension_manager_|.
   void InitializeComponentExtensionForTesting(
       scoped_ptr<ComponentExtensionIMEManagerDelegate> delegate);
 
  private:
@@ skipping 25 matching lines @@
   // done.
   void MaybeInitializeCandidateWindowController();
 
   // If |current_input_method_id_| is not in |input_method_ids|, switch to
   // input_method_ids[0]. If the ID is equal to input_method_ids[N], switch to
   // input_method_ids[N+1].
   void SwitchToNextInputMethodInternal(
       const std::vector<std::string>& input_method_ids,
       const std::string& current_input_method_id);
 
+  // Change system input method and inform observers. Doesn't modify state.
+  void ChangeInputMethodInternal(const InputMethodDescriptor& input_method_id,
+                                 bool show_message);
+
   // Change system input method.
-  // Returns true if the system input method is changed.
-  bool ChangeInputMethodInternal(const std::string& input_method_id,
-                                 bool show_message);
+  void LookupAndChangeInputMethodInternal(const std::string& input_method_id,
+                                          bool show_message);
 
   // Loads necessary component extensions.
   // TODO(nona): Support dynamical unloading.
   void LoadNecessaryComponentExtensions();
 
   // Adds new input method to given list if possible
   bool EnableInputMethodImpl(
       const std::string& input_method_id,
       std::vector<std::string>* new_active_input_method_ids) const;
 
   // Starts or stops the system input method framework as needed.
   // (after list of enabled input methods has been updated)
   void ReconfigureIMFramework();
 
   scoped_ptr<InputMethodDelegate> delegate_;
 
   // The current browser status.
-  State state_;
+  UISessionState ui_session_;
 
   // A list of objects that monitor the manager.
   ObserverList<InputMethodManager::Observer> observers_;
   ObserverList<CandidateWindowObserver> candidate_window_observers_;
 
-  // The input method which was/is selected.
-  InputMethodDescriptor previous_input_method_;
-  InputMethodDescriptor current_input_method_;
-  // The active input method ids cache.
-  std::vector<std::string> active_input_method_ids_;
-
   // The list of enabled extension IMEs.
   std::vector<std::string> enabled_extension_imes_;
 
-  // For screen locker. When the screen is locked, |previous_input_method_|,
-  // |current_input_method_|, and |active_input_method_ids_| above are copied
-  // to these "saved" variables.
-  InputMethodDescriptor saved_previous_input_method_;
-  InputMethodDescriptor saved_current_input_method_;
-  std::vector<std::string> saved_active_input_method_ids_;
+  scoped_refptr<InputMethodManagerImpl::State> state_;
 
   // Extra input methods that have been explicitly added to the menu, such as
   // those created by extension.
   std::map<std::string, InputMethodDescriptor> extra_input_methods_;
 
   // The candidate window.  This will be deleted when the APP_TERMINATING
   // message is sent.
   scoped_ptr<CandidateWindowController> candidate_window_controller_;
 
   // An object which provides miscellaneous input method utility functions. Note
   // that |util_| is required to initialize |keyboard_|.
   InputMethodUtil util_;
 
   // An object which provides component extension ime management functions.
   scoped_ptr<ComponentExtensionIMEManager> component_extension_ime_manager_;
 
   // An object for switching XKB layouts and keyboard status like caps lock and
   // auto-repeat interval.
   scoped_ptr<ImeKeyboard> keyboard_;
 
   base::ThreadChecker thread_checker_;
 
   base::WeakPtrFactory<InputMethodManagerImpl> weak_ptr_factory_;
 
-  // The engine map from extension_id to an engine.
-  std::map<std::string, InputMethodEngineInterface*> engine_map_;
-
   DISALLOW_COPY_AND_ASSIGN(InputMethodManagerImpl);
 };
 
 }  // namespace input_method
 }  // namespace chromeos
 
 #endif  // CHROME_BROWSER_CHROMEOS_INPUT_METHOD_INPUT_METHOD_MANAGER_IMPL_H_