Remove PendingCreateICRequest.

ui/base/ime/input_method_ibus.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 "ui/base/ime/input_method_ibus.h"
 
 #include <X11/X.h>
 #include <X11/Xlib.h>
 #include <X11/Xutil.h>
 #undef FocusIn
@@ skipping 20 matching lines @@
 #include "ui/base/ime/text_input_client.h"
 #include "ui/base/keycodes/keyboard_code_conversion.h"
 #include "ui/base/keycodes/keyboard_code_conversion_x.h"
 #include "ui/base/keycodes/keyboard_codes.h"
 #include "ui/gfx/rect.h"
 
 namespace {
 
 const int kIBusReleaseMask = 1 << 30;
 const char kClientName[] = "chrome";
+const int kMaxRetryCount = 10;
 
 // Following capability mask is introduced from
 // http://ibus.googlecode.com/svn/docs/ibus-1.4/ibus-ibustypes.html#IBusCapabilite
 const uint32 kIBusCapabilityPreeditText = 1U;
 const uint32 kIBusCapabilityFocus = 8U;
 const uint32 kIBusCapabilitySurroundingText = 32U;
 
 XKeyEvent* GetKeyEvent(XEvent* event) {
   DCHECK(event && (event->type == KeyPress || event->type == KeyRelease));
   return &event->xkey;
@@ skipping 104 matching lines @@
                                           ibus_keyval_,
                                           handled);
     return;
   }
 
   // TODO(yusukes): Support non-native event (from e.g. a virtual keyboard).
   // See views::InputMethodIBus for details. Never forget to set 'character_'
   // and 'unmodified_character_' to support i18n VKs like a French VK!
 }
 
-// A class to hold information of a pending request for creating an ibus input
-// context.
-class InputMethodIBus::PendingCreateICRequest {
- public:
-  PendingCreateICRequest(InputMethodIBus* input_method,
-                         PendingCreateICRequest** request_ptr);
-  virtual ~PendingCreateICRequest();
-
-  // Set up signal handlers, or destroy object proxy if the input context is
-  // already abandoned.
-  void InitOrAbandonInputContext();
-
-  // Called if the create input context method call is failed.
-  void OnCreateInputContextFailed();
-
-  // Abandon this pending key event. Its result will just be discarded.
-  void Abandon() {
-    input_method_ = NULL;
-    request_ptr_ = NULL;
-    // Do not reset |ibus_client_| here.
-  }
-
- private:
-  InputMethodIBus* input_method_;
-  PendingCreateICRequest** request_ptr_;
-
-  DISALLOW_COPY_AND_ASSIGN(PendingCreateICRequest);
-};
-
-InputMethodIBus::PendingCreateICRequest::PendingCreateICRequest(
-    InputMethodIBus* input_method,
-    PendingCreateICRequest** request_ptr)
-    : input_method_(input_method),
-      request_ptr_(request_ptr) {
-}
-
-InputMethodIBus::PendingCreateICRequest::~PendingCreateICRequest() {
-  if (request_ptr_) {
-    DCHECK_EQ(*request_ptr_, this);
-    *request_ptr_ = NULL;
-  }
-}
-
-void InputMethodIBus::PendingCreateICRequest::OnCreateInputContextFailed() {
-  // TODO(nona): If the connection between Chrome and ibus-daemon terminates
-  // for some reason, the create ic request will fail. We might want to call
-  // ibus_client_->CreateContext() again after some delay.
-}
-
-void InputMethodIBus::PendingCreateICRequest::InitOrAbandonInputContext() {
-  if (input_method_) {
-    DCHECK(input_method_->IsContextReady());
-    input_method_->SetUpSignalHandlers();
-  } else {
-    GetInputContextClient()->ResetObjectProxy();
-  }
-}
-
 // InputMethodIBus implementation -----------------------------------------
 InputMethodIBus::InputMethodIBus(
     internal::InputMethodDelegate* delegate)
     : ibus_client_(new internal::IBusClient),
-      pending_create_ic_request_(NULL),
+      input_context_state_(INPUT_CONTEXT_STOP),
+      create_input_context_fail_count_(0),
       context_focused_(false),
       composing_text_(false),
       composition_changed_(false),
       suppress_next_result_(false),
       weak_ptr_factory_(this) {
   SetDelegate(delegate);
 }
 
 InputMethodIBus::~InputMethodIBus() {
   AbandonAllPendingKeyEvents();
@@ skipping 178 matching lines @@
   OnTextInputTypeChanged(focused);
 
   UpdateContextFocusState();
   // Force to update caret bounds, in case the client thinks that the caret
   // bounds has not changed.
   OnCaretBoundsChanged(focused);
 }
 
 void InputMethodIBus::CreateContext() {
   DCHECK(IsConnected());
-  DCHECK(!pending_create_ic_request_);
 
-  pending_create_ic_request_ = new PendingCreateICRequest(
-      this, &pending_create_ic_request_);
+  if (input_context_state_ != INPUT_CONTEXT_STOP) {
+    DVLOG(1) << "Input context is already created or waiting ibus-daemon"
+                " response.";
+    return;
+  }
+
+  input_context_state_ = INPUT_CONTEXT_WAIT_CREATE_INPUT_CONTEXT_RESPONSE;
 
   // Creates the input context asynchronously.
+  DCHECK(!IsContextReady());
   chromeos::DBusThreadManager::Get()->GetIBusClient()->CreateInputContext(
       kClientName,
       base::Bind(&InputMethodIBus::CreateInputContextDone,
-                 weak_ptr_factory_.GetWeakPtr(),
-                 base::Unretained(pending_create_ic_request_)),
+                 weak_ptr_factory_.GetWeakPtr()),
       base::Bind(&InputMethodIBus::CreateInputContextFail,
-                 weak_ptr_factory_.GetWeakPtr(),
-                 base::Unretained(pending_create_ic_request_)));
+                 weak_ptr_factory_.GetWeakPtr()));
 }
 
 void InputMethodIBus::SetUpSignalHandlers() {
   DCHECK(IsContextReady());
 
   // connect input context signals
   chromeos::IBusInputContextClient* input_context_client =
       chromeos::DBusThreadManager::Get()->GetIBusInputContextClient();
   input_context_client->SetCommitTextHandler(
       base::Bind(&InputMethodIBus::OnCommitText,
@@ skipping 21 matching lines @@
 
   UpdateContextFocusState();
   // Since ibus-daemon is launched in an on-demand basis on Chrome OS, RWHVA (or
   // equivalents) might call OnCaretBoundsChanged() before the daemon starts. To
   // save the case, call OnCaretBoundsChanged() here.
   OnCaretBoundsChanged(GetTextInputClient());
   OnInputMethodChanged();
 }
 
 void InputMethodIBus::DestroyContext() {
-  if (pending_create_ic_request_) {
-    DCHECK(!IsContextReady());
-    // |pending_create_ic_request_| will be deleted in CreateInputContextDone().
-    pending_create_ic_request_->Abandon();
-    pending_create_ic_request_ = NULL;
+  if (input_context_state_ == INPUT_CONTEXT_STOP)
     return;
-  }
+  input_context_state_ = INPUT_CONTEXT_STOP;
   const chromeos::IBusInputContextClient* input_context =
       chromeos::DBusThreadManager::Get()->GetIBusInputContextClient();
   if (input_context && input_context->IsObjectProxyReady()) {
     // We can't use IsContextReady here because we want to destroy object proxy
     // regardless of connection. The IsContextReady contains connection check.
     ResetInputContext();
     DCHECK(!IsContextReady());
   }
 }
 
@@ skipping 401 matching lines @@
   context_focused_ = false;
 
   ConfirmCompositionText();
 
   // We are dead, so we need to ask the client to stop relying on us.
   OnInputMethodChanged();
   GetInputContextClient()->ResetObjectProxy();
 }
 
 void InputMethodIBus::CreateInputContextDone(
-    PendingCreateICRequest* ic_request,
     const dbus::ObjectPath& object_path) {
+  DCHECK_NE(INPUT_CONTEXT_RUNNING, input_context_state_);
+
+  if (input_context_state_ == INPUT_CONTEXT_STOP) {
+    // Corresponding to cancel abandon input context under waiting

[Yusuke Sato, 2012/08/07 20:03:44]

couldn't understand what this comment meant. please try to rephrase it..

[Seigo Nonaka, 2012/08/08 04:32:52]

Sorry forget to update this comment.
Done
On 2012/08/07 20:03:44, Yusuke Sato wrote:

+    // CreateInputContext response from ibus-daemon. Do nothing.
+    return;
+  }
+
   chromeos::DBusThreadManager::Get()->GetIBusInputContextClient()
       ->Initialize(chromeos::DBusThreadManager::Get()->GetIBusBus(),
                    object_path);
-  ic_request->InitOrAbandonInputContext();
-  delete ic_request;
+
+  input_context_state_ = INPUT_CONTEXT_RUNNING;
+  DCHECK(IsContextReady());
+  SetUpSignalHandlers();
 }
 
-void InputMethodIBus::CreateInputContextFail(
-    PendingCreateICRequest* ic_request) {
-  ic_request->OnCreateInputContextFailed();
-  delete ic_request;
+void InputMethodIBus::CreateInputContextFail() {
+  DCHECK_NE(INPUT_CONTEXT_RUNNING, input_context_state_);
+  if (input_context_state_ == INPUT_CONTEXT_STOP) {
+    // CreateInputContext failed but the input context is no longer
+    // necessary, thus do nothing.
+    return;
+  }
+
+  if (++create_input_context_fail_count_ >= kMaxRetryCount) {
+    DVLOG(1) << "CreateInputContext failed even tried "
+             << kMaxRetryCount << " times, give up.";

[Yusuke Sato, 2012/08/07 20:03:44]

don't we need to reset the counter to zero?

[Seigo Nonaka, 2012/08/08 04:32:52]

Yes, we need.
Done.
On 2012/08/07 20:03:44, Yusuke Sato wrote:

+    return;
+  }
+
+  // Try CreateInputContext again.
+  chromeos::DBusThreadManager::Get()->GetIBusClient()->CreateInputContext(
+      kClientName,
+      base::Bind(&InputMethodIBus::CreateInputContextDone,
+                 weak_ptr_factory_.GetWeakPtr()),
+      base::Bind(&InputMethodIBus::CreateInputContextFail,
+                 weak_ptr_factory_.GetWeakPtr()));
 }
 
 bool InputMethodIBus::IsConnected() {
   return chromeos::DBusThreadManager::Get()->GetIBusBus() != NULL;
 }
 
 bool InputMethodIBus::IsContextReady() {
   if (!IsConnected())
     return false;
   if (!GetInputContextClient())
@@ skipping 94 matching lines @@
   }
 
   // Use a black thin underline by default.
   if (out_composition->underlines.empty()) {
     out_composition->underlines.push_back(CompositionUnderline(
         0, length, SK_ColorBLACK, false /* thick */));
   }
 }
 
 }  // namespace ui