Implement IBusInputContextClient

chromeos/dbus/ibus/ibus_input_context_client.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 "chromeos/dbus/ibus/ibus_input_context_client.h"
+
+#include <string>
+#include "base/bind.h"
+#include "base/callback.h"
+#include "chromeos/dbus/ibus/ibus_constants.h"
+#include "chromeos/dbus/ibus/ibus_text.h"
+#include "dbus/bus.h"
+#include "dbus/message.h"
+#include "dbus/object_path.h"
+#include "dbus/object_proxy.h"
+
+namespace chromeos {
+
+namespace {
+const char kIBusInputContextInterface[] = "org.freedesktop.IBus.InputContext";
+
+// Signal names.
+const char kCommitTextSignal[] = "CommitText";
+const char kForwardKeyEventSignal[] = "ForwardKeyEvent";
+const char kHidePreeditTextSignal[] = "HidePreeditSignal";
+const char kShowPreeditTextSignal[] = "ShowPreeditText";
+const char kUpdatePreeditTextSignal[] = "UpdatePreeditText";
+
+// Method names.
+const char kFocusInMethod[] = "FocusIn";
+const char kFocusOutMethod[] = "FocusOut";
+const char kResetMethod[] = "Reset";
+const char kSetCapabilitiesMethod[] = "SetCapabilities";
+const char kSetCursorLocationMethod[] = "SetCursorLocation";
+const char kProcessKeyEventMethod[] = "ProcessKeyEvent";
+
+// The IBusInputContextClient implementation.
+class IBusInputContextClientImpl : public IBusInputContextClient {
+ public:
+  IBusInputContextClientImpl()
+      : proxy_(NULL),
+        weak_ptr_factory_(this) {
+  }
+
+  virtual ~IBusInputContextClientImpl() {}
+
+ public:
+  // IBusInputContextClient override.
+  virtual void Initialize(dbus::Bus* bus,
+                          const dbus::ObjectPath& object_path) OVERRIDE {
+    if (proxy_ != NULL) {
+      LOG(ERROR) << "IBusInputContextClient is already initialized.";
+      return;
+    }
+    proxy_ = bus->GetObjectProxy(kIBusServiceName, object_path);
+
+    ConnectSignals();
+  }
+
+  // IBusInputContextClient override.
+  virtual void Shutdown() OVERRIDE {
+    // Do not delete proxy here, proxy object is managed by dbus::Bus object.
+    proxy_ = NULL;
+  }
+
+  // IBusInputContextClient override.
+  virtual bool IsConnected() const OVERRIDE {
+    return proxy_ != NULL;
+  }
+
+  // IBusInputContextClient override.
+  virtual void SetCommitTextHandler(
+      const CommitTextHandler& commit_text_handler) OVERRIDE {

[satorux1, 2012/05/10 21:40:53]

if this function can be called only once, add this:

DCHECK(commit_text_handler_.is_null());

If the given callback should be non null, add this:

DCHECK(!commit_text_handler.is_null());

[Seigo Nonaka, 2012/05/10 22:26:08]

Support multiple calling.
On 2012/05/10 21:40:53, satorux1 wrote:

+    commit_text_handler_ = commit_text_handler;
+  }
+
+  // IBusInputContextClient override.
+  virtual void SetForwardKeyEventHandler(
+      const ForwardKeyEventHandler& forward_key_event_handler) OVERRIDE {
+    forward_key_event_handler_ = forward_key_event_handler;
+  }
+
+  // IBusInputContextClient override.
+  virtual void SetUpdatePreeditTextHandler(
+      const UpdatePreeditTextHandler& update_preedit_text_handler) OVERRIDE {
+    update_preedit_text_handler_ = update_preedit_text_handler;
+  }
+
+  // IBusInputContextClient override.
+  virtual void SetShowPreeditTextHandler(
+      const ShowPreeditTextHandler& show_preedit_text_handler) OVERRIDE {
+    show_preedit_text_handler_ = show_preedit_text_handler;
+  }
+
+  // IBusInputContextClient override.
+  virtual void SetHidePreeditTextHandler(
+      const HidePreeditTextHandler& hide_preedit_text_handler) OVERRIDE {
+    hide_preedit_text_handler_ = hide_preedit_text_handler;
+  }
+
+  // IBusInputContextClient override.
+  virtual void UnsetCommitTextHandler() OVERRIDE {
+    commit_text_handler_.Reset();
+  }
+
+  // IBusInputContextClient override.
+  virtual void UnsetForwardKeyEventHandler() OVERRIDE {
+    forward_key_event_handler_.Reset();
+  }
+
+  // IBusInputContextClient override.
+  virtual void UnsetUpdatePreeditTextHandler() OVERRIDE {
+    update_preedit_text_handler_.Reset();
+  }
+
+  // IBusInputContextClient override.
+  virtual void UnsetShowPreeditTextHandler() OVERRIDE {
+    show_preedit_text_handler_.Reset();
+  }
+
+  // IBusInputContextClient override.
+  virtual void UnsetHidePreeditTextHandler() OVERRIDE {
+    hide_preedit_text_handler_.Reset();
+  }
+
+  // IBusInputContextClient override.
+  virtual void SetCapabilities(uint32 capabilities) OVERRIDE {
+    dbus::MethodCall method_call(kIBusInputContextInterface,
+                                 kSetCapabilitiesMethod);
+    dbus::MessageWriter writer(&method_call);
+    writer.AppendUint32(capabilities);
+    proxy_->CallMethod(&method_call,
+                       dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
+                       base::Bind(&IBusInputContextClientImpl::DefaultCallback,
+                                  kSetCapabilitiesMethod));
+  }
+
+  // IBusInputContextClient override.
+  virtual void FocusIn() OVERRIDE {
+    dbus::MethodCall method_call(kIBusInputContextInterface, kFocusInMethod);
+    proxy_->CallMethod(&method_call,
+                       dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
+                       base::Bind(&IBusInputContextClientImpl::DefaultCallback,
+                                  kFocusInMethod));
+  }
+
+  // IBusInputContextClient override.
+  virtual void FocusOut() OVERRIDE {
+    dbus::MethodCall method_call(kIBusInputContextInterface, kFocusOutMethod);
+    proxy_->CallMethod(&method_call,
+                       dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
+                       base::Bind(&IBusInputContextClientImpl::DefaultCallback,
+                                  kFocusOutMethod));
+  }
+
+  // IBusInputContextClient override.
+  virtual void Reset() OVERRIDE {
+    dbus::MethodCall method_call(kIBusInputContextInterface, kResetMethod);
+    proxy_->CallMethod(&method_call,
+                       dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
+                       base::Bind(&IBusInputContextClientImpl::DefaultCallback,
+                                  kResetMethod));
+  }
+
+  // IBusInputContextClient override.
+  virtual void SetCursorLocation(int32 x, int32 y, int32 w, int32 h) OVERRIDE {
+    dbus::MethodCall method_call(kIBusInputContextInterface,
+                                 kSetCursorLocationMethod);
+    dbus::MessageWriter writer(&method_call);
+    writer.AppendInt32(x);
+    writer.AppendInt32(y);
+    writer.AppendInt32(w);
+    writer.AppendInt32(h);
+    proxy_->CallMethod(&method_call,
+                       dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
+                       base::Bind(&IBusInputContextClientImpl::DefaultCallback,
+                                  kSetCursorLocationMethod));
+  }
+
+  // IBusInputContextClient override.
+  virtual void ProcessKeyEvent(
+      uint32 keyval,
+      uint32 keycode,
+      uint32 state,
+      const ProcessKeyEventCallback& callback) OVERRIDE {
+    dbus::MethodCall method_call(kIBusInputContextInterface,
+                                 kProcessKeyEventMethod);
+    dbus::MessageWriter writer(&method_call);
+    writer.AppendUint32(keyval);
+    writer.AppendUint32(keycode);
+    writer.AppendUint32(state);
+    proxy_->CallMethod(
+        &method_call,
+        dbus::ObjectProxy::TIMEOUT_USE_DEFAULT,
+        base::Bind(&IBusInputContextClientImpl::OnProcessKeyEvent,
+                   callback));
+  }
+
+ private:
+  // Handles no response method call reply.
+  static void DefaultCallback(const std::string& method_name,
+                              dbus::Response* response) {
+    if (!response) {
+      LOG(ERROR) << "Failed to call method:" << method_name;

[satorux1, 2012/05/10 21:40:53]

"Failed to call method:" ->
"Failed to call method: "

[Seigo Nonaka, 2012/05/10 22:26:08]

Done.

+      return;
+    }
+  }
+
+  // Handles ProcessKeyEvent method call reply.
+  static void OnProcessKeyEvent(const ProcessKeyEventCallback& callback,
+                                dbus::Response* response) {
+    if (!response) {
+      LOG(ERROR) << "Cannot get input context:" << response->ToString();

[satorux1, 2012/05/10 21:40:53]

ditto. add a space after :

[Seigo Nonaka, 2012/05/10 22:26:08]

Done.

+      return;
+    }
+    dbus::MessageReader reader(response);
+    bool is_keyevent_used;
+    if (!reader.PopBool(&is_keyevent_used)) {
+      // The IBus message structure may changed.

[satorux1, 2012/05/10 21:40:53]

may be changed.

[Seigo Nonaka, 2012/05/10 22:26:08]

Done.

+      LOG(ERROR) << "Invalid response:" << response->ToString();
+      return;
+    }
+    callback.Run(is_keyevent_used);
+  }
+
+  // Handles CommitText signal.
+  void OnCommitText(dbus::Signal* signal) {
+    if (commit_text_handler_.is_null())
+      return;
+    dbus::MessageReader reader(signal);
+    IBusText ibus_text;
+    if (!PopIBusText(&reader, &ibus_text)) {
+      // The IBus message structure may changed.
+      LOG(ERROR) << "Invalid signal: " << signal->ToString();
+      return;
+    }
+    commit_text_handler_.Run(ibus_text);
+  }
+
+  // Handles ForwardKeyEvetn signal.
+  void OnForwardKeyEvent(dbus::Signal* signal) {
+    if (forward_key_event_handler_.is_null())
+      return;
+    dbus::MessageReader reader(signal);
+    uint32 keyval;
+    uint32 keycode;
+    uint32 state;

[satorux1, 2012/05/10 21:40:53]

Initialize them with 0

[Seigo Nonaka, 2012/05/10 22:26:08]

Done.

+    if (!reader.PopUint32(&keyval) ||
+        !reader.PopUint32(&keycode) ||
+        !reader.PopUint32(&state)) {
+      // The IBus message structure may changed.
+      LOG(ERROR) << "Invalid signal: " << signal->ToString();
+      return;
+    }
+    forward_key_event_handler_.Run(keyval, keycode, state);
+  }
+
+  // Handles UpdatePreeditText signal.
+  void OnUpdatePreeditText(dbus::Signal* signal) {
+    if (update_preedit_text_handler_.is_null())
+      return;
+    dbus::MessageReader reader(signal);
+    IBusText ibus_text;
+    uint32 cursor_pos;
+    bool visible;

[satorux1, 2012/05/10 21:40:53]

Please initialize variables of primitive types.

[Seigo Nonaka, 2012/05/10 22:26:08]

Done.

+    if (!PopIBusText(&reader, &ibus_text) ||
+        !reader.PopUint32(&cursor_pos) ||
+        !reader.PopBool(&visible)) {
+      // The IBus message structure may changed.
+      LOG(ERROR) << "Invalid signal: " << signal->ToString();
+      return;
+    }
+    update_preedit_text_handler_.Run(ibus_text, cursor_pos, visible);
+  }
+
+  // Handles ShowPreeditText signal.
+  void OnShowPreeditText(dbus::Signal* signal) {
+    if (!show_preedit_text_handler_.is_null())
+      show_preedit_text_handler_.Run();
+  }
+
+  // Handles HidePreeditText signal.
+  void OnHidePreeditText(dbus::Signal* signal) {
+    if (!hide_preedit_text_handler_.is_null())
+      hide_preedit_text_handler_.Run();
+  }
+
+  // Connects signals to signal handlers.
+  void ConnectSignals() {
+    proxy_->ConnectToSignal(
+        kIBusInputContextInterface,
+        kCommitTextSignal,
+        base::Bind(&IBusInputContextClientImpl::OnCommitText,
+                   weak_ptr_factory_.GetWeakPtr()),
+        base::Bind(&IBusInputContextClientImpl::OnSignalConnected,
+                   weak_ptr_factory_.GetWeakPtr()));
+
+    proxy_->ConnectToSignal(
+        kIBusInputContextInterface,
+        kForwardKeyEventSignal,
+        base::Bind(&IBusInputContextClientImpl::OnForwardKeyEvent,
+                   weak_ptr_factory_.GetWeakPtr()),
+        base::Bind(&IBusInputContextClientImpl::OnSignalConnected,
+                   weak_ptr_factory_.GetWeakPtr()));
+
+    proxy_->ConnectToSignal(
+        kIBusInputContextInterface,
+        kUpdatePreeditTextSignal,
+        base::Bind(&IBusInputContextClientImpl::OnUpdatePreeditText,
+                   weak_ptr_factory_.GetWeakPtr()),
+        base::Bind(&IBusInputContextClientImpl::OnSignalConnected,
+                   weak_ptr_factory_.GetWeakPtr()));
+
+    proxy_->ConnectToSignal(
+        kIBusInputContextInterface,
+        kShowPreeditTextSignal,
+        base::Bind(&IBusInputContextClientImpl::OnShowPreeditText,
+                   weak_ptr_factory_.GetWeakPtr()),
+        base::Bind(&IBusInputContextClientImpl::OnSignalConnected,
+                   weak_ptr_factory_.GetWeakPtr()));
+
+    proxy_->ConnectToSignal(
+        kIBusInputContextInterface,
+        kHidePreeditTextSignal,
+        base::Bind(&IBusInputContextClientImpl::OnHidePreeditText,
+                   weak_ptr_factory_.GetWeakPtr()),
+        base::Bind(&IBusInputContextClientImpl::OnSignalConnected,
+                   weak_ptr_factory_.GetWeakPtr()));
+  }
+
+  // Handles the result of signal connection setup.
+  void OnSignalConnected(const std::string& interface,
+                         const std::string& signal,
+                         bool succeeded) {
+    LOG_IF(ERROR, !succeeded) << "Connect to " << interface << " "
+                              << signal << " failed.";
+  }
+
+  dbus::ObjectProxy* proxy_;
+
+  // Signal handlers.
+  CommitTextHandler commit_text_handler_;
+  ForwardKeyEventHandler forward_key_event_handler_;
+  HidePreeditTextHandler hide_preedit_text_handler_;
+  ShowPreeditTextHandler show_preedit_text_handler_;
+  UpdatePreeditTextHandler update_preedit_text_handler_;
+
+  base::WeakPtrFactory<IBusInputContextClientImpl> weak_ptr_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(IBusInputContextClientImpl);
+};
+
+// A stub implementation of IBusInputContextClient.
+class IBusInputContextClientStubImpl : public IBusInputContextClient {
+ public:
+  IBusInputContextClientStubImpl() {}
+
+  virtual ~IBusInputContextClientStubImpl() {}
+
+ public:
+  // IBusInputContextClient override.
+  virtual void Initialize(dbus::Bus* bus,
+                          const dbus::ObjectPath& object_path) OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void Shutdown() OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual bool IsConnected() const OVERRIDE {
+    return true;
+  }
+  // IBusInputContextClient override.

[satorux1, 2012/05/10 21:40:53]

// IBusInputContextClient overrides.

[Seigo Nonaka, 2012/05/10 22:26:08]

Done.

+  virtual void SetCommitTextHandler(
+      const CommitTextHandler& commit_text_handler) OVERRIDE {}
+  // IBusInputContextClient override.

[satorux1, 2012/05/10 21:40:53]

Then please remove all // IBusInputContextClient override. 
from here.

[Seigo Nonaka, 2012/05/10 22:26:08]

Done.

+  virtual void SetForwardKeyEventHandler(
+      const ForwardKeyEventHandler& forward_key_event_handler) OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void SetUpdatePreeditTextHandler(
+      const UpdatePreeditTextHandler& update_preedit_text_handler) OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void SetShowPreeditTextHandler(
+      const ShowPreeditTextHandler& show_preedit_text_handler) OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void SetHidePreeditTextHandler(
+      const HidePreeditTextHandler& hide_preedit_text_handler) OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void UnsetCommitTextHandler() OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void UnsetForwardKeyEventHandler() OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void UnsetUpdatePreeditTextHandler() OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void UnsetShowPreeditTextHandler() OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void UnsetHidePreeditTextHandler() OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void SetCapabilities(uint32 capability) OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void FocusIn() OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void FocusOut() OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void Reset() OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void SetCursorLocation(int32 x, int32 y, int32 w, int32 h) OVERRIDE {}
+  // IBusInputContextClient override.
+  virtual void ProcessKeyEvent(
+      uint32 keyval,
+      uint32 keycode,
+      uint32 state,
+      const ProcessKeyEventCallback& callback) OVERRIDE {}
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(IBusInputContextClientStubImpl);
+};
+
+}  // namespace
+
+///////////////////////////////////////////////////////////////////////////////
+// IBusInputContextClient
+
+IBusInputContextClient::IBusInputContextClient() {}
+
+IBusInputContextClient::~IBusInputContextClient() {}
+
+// static
+IBusInputContextClient* IBusInputContextClient::Create(
+    DBusClientImplementationType type) {
+  if (type == REAL_DBUS_CLIENT_IMPLEMENTATION) {
+    return new IBusInputContextClientImpl();
+  }
+  DCHECK_EQ(STUB_DBUS_CLIENT_IMPLEMENTATION, type);
+  return new IBusInputContextClientStubImpl();
+}
+}  // namespace chromeos