IME refactoring: ChromeOS introduce input methods State.

chromeos/ime/input_method_manager.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 CHROMEOS_IME_INPUT_METHOD_MANAGER_H_
 #define CHROMEOS_IME_INPUT_METHOD_MANAGER_H_
 
 #include <map>
 #include <string>
 #include <vector>
 
+#include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "chromeos/chromeos_export.h"
 #include "chromeos/ime/input_method_descriptor.h"
 
 namespace ui {
 class Accelerator;
 }  // namespace ui
 
 namespace chromeos {
 class ComponentExtensionIMEManager;
 class InputMethodEngineInterface;
 namespace input_method {
 class InputMethodUtil;
 class ImeKeyboard;
 
 // This class manages input methodshandles.  Classes can add themselves as
 // observers. Clients can get an instance of this library class by:
 // InputMethodManager::Get().
 class CHROMEOS_EXPORT InputMethodManager {
  public:
-  enum State {
+  enum UIState {

[Shu Chen, 2014/08/04 14:55:24]

Maybe better to name it as "UISession" or "UIScreen".

[Alexander Alekseev, 2014/08/06 23:39:45]

I've renamed it to UISessionState, because set method named 'SetSession' doesn't
explain what is happenng. So I named them SetSessionState, and enum
UISessionState.

On the other hand, there are a lot of "enum UIState" all around chromium code.

     STATE_LOGIN_SCREEN = 0,
     STATE_BROWSER_SCREEN,
     STATE_LOCK_SCREEN,
     STATE_TERMINATING,
   };
 
   class Observer {
    public:
     virtual ~Observer() {}
     // Called when the current input method is changed.  |show_message|
     // indicates whether the user should be notified of this change.
     virtual void InputMethodChanged(InputMethodManager* manager,
                                     bool show_message) = 0;
   };
 
   // CandidateWindowObserver is notified of events related to the candidate
   // window.  The "suggestion window" used by IMEs such as ibus-mozc does not
   // count as the candidate window (this may change if we later want suggestion
   // window events as well).  These events also won't occur when the virtual
   // keyboard is used, since it controls its own candidate window.
   class CandidateWindowObserver {
    public:
     virtual ~CandidateWindowObserver() {}
     // Called when the candidate window is opened.
     virtual void CandidateWindowOpened(InputMethodManager* manager) = 0;
     // Called when the candidate window is closed.
     virtual void CandidateWindowClosed(InputMethodManager* manager) = 0;
   };
 
+  class State : public base::RefCounted<InputMethodManager::State> {
+   protected:
+    friend base::RefCounted<InputMethodManager::State>;
+
+    virtual ~State();
+  };
+
   virtual ~InputMethodManager() {}
 
   // Gets the global instance of InputMethodManager. Initialize() must be called
   // first.
   static CHROMEOS_EXPORT InputMethodManager* Get();
 
   // Sets the global instance. |instance| will be owned by the internal pointer
   // and deleted by Shutdown().
   // TODO(nona): Instanciate InputMethodManagerImpl inside of this function once
   //             crbug.com/164375 is fixed.
@@ skipping 114 matching lines @@
   // Switches to an input method (or keyboard layout) which is associated with
   // the |accelerator|.
   virtual bool SwitchInputMethod(const ui::Accelerator& accelerator) = 0;
 
   // If keyboard layout can be uset at login screen
   virtual bool IsLoginKeyboard(const std::string& layout) const = 0;
 
   // Migrates the input method id to extension-based input method id.
   virtual bool MigrateInputMethods(
       std::vector<std::string>* input_method_ids) = 0;
+
+  virtual scoped_refptr<State> CreateNewState(
+      const std::string& debug_name) const = 0;
+
+  virtual void SetState(scoped_refptr<State> state) = 0;
 };
 
 }  // namespace input_method
 }  // namespace chromeos
 
 #endif  // CHROMEOS_IME_INPUT_METHOD_MANAGER_H_