Implement the mouse cursor channel (#32)

Author: JSUYA

flutter/shell/platform/tizen/BUILD.gn

@@ -46,6 +46,7 @@ config("flutter_tizen_config") {
     "${sysroot_path}/usr/include/feedback",
     "${sysroot_path}/usr/include/system",
     "${sysroot_path}/usr/include/tzsh",
+    "${sysroot_path}/usr/include/vconf",
     "${sysroot_path}/usr/include/wayland-extension",
   ]
 
@@ -85,6 +86,7 @@ template("embedder") {
       "channels/key_event_channel.cc",
       "channels/key_mapping.cc",
       "channels/lifecycle_channel.cc",
+      "channels/mouse_cursor_channel.cc",
       "channels/navigation_channel.cc",
       "channels/platform_channel.cc",
       "channels/platform_view_channel.cc",
@@ -134,6 +136,7 @@ template("embedder") {
       "feedback",
       "flutter_engine",
       "tbm",
+      "vconf",
       "wayland-client",
     ]
 

flutter/shell/platform/tizen/channels/mouse_cursor_channel.cc

@@ -0,0 +1,55 @@
+// Copyright 2023 The Flutter 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 "mouse_cursor_channel.h"
+
+#include "flutter/shell/platform/common/client_wrapper/include/flutter/standard_method_codec.h"
+#include "flutter/shell/platform/tizen/logger.h"
+
+namespace flutter {
+
+namespace {
+
+constexpr char kChannelName[] = "flutter/mousecursor";
+constexpr char kActivateSystemCursorMethod[] = "activateSystemCursor";
+constexpr char kKindKey[] = "kind";
+
+}  // namespace
+
+MouseCursorChannel::MouseCursorChannel(BinaryMessenger* messenger,
+                                       TizenViewBase* view)
+    : view_(view) {
+  channel_ = std::make_unique<MethodChannel<EncodableValue>>(
+      messenger, kChannelName, &StandardMethodCodec::GetInstance());
+  channel_->SetMethodCallHandler(
+      [this](const MethodCall<EncodableValue>& call,
+             std::unique_ptr<MethodResult<EncodableValue>> result) {
+        HandleMethodCall(call, std::move(result));
+      });
+}
+
+MouseCursorChannel::~MouseCursorChannel() {}
+
+void MouseCursorChannel::HandleMethodCall(
+    const MethodCall<EncodableValue>& method_call,
+    std::unique_ptr<MethodResult<EncodableValue>> result) {
+  const std::string& method_name = method_call.method_name();
+  if (method_name == kActivateSystemCursorMethod) {
+    const auto& arguments = std::get<EncodableMap>(*method_call.arguments());
+    auto kind_iter = arguments.find(EncodableValue(std::string(kKindKey)));
+    if (kind_iter == arguments.end()) {
+      result->Error("Argument error",
+                    "Missing argument while trying to activate system cursor");
+      return;
+    }
+
+    const auto& kind = std::get<std::string>(kind_iter->second);
+    view_->UpdateFlutterCursor(kind);
+    result->Success();
+  } else {
+    result->NotImplemented();
+  }
+}
+
+}  // namespace flutter

flutter/shell/platform/tizen/channels/mouse_cursor_channel.h

@@ -0,0 +1,36 @@
+// Copyright 2023 The Flutter 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 EMBEDDER_MOUSE_CURSOR_CHANNEL_H_
+#define EMBEDDER_MOUSE_CURSOR_CHANNEL_H_
+
+#include "flutter/shell/platform/common/client_wrapper/include/flutter/binary_messenger.h"
+#include "flutter/shell/platform/common/client_wrapper/include/flutter/encodable_value.h"
+#include "flutter/shell/platform/common/client_wrapper/include/flutter/method_channel.h"
+#include "flutter/shell/platform/tizen/tizen_view_base.h"
+
+namespace flutter {
+
+// Channel to set the system's cursor type.
+class MouseCursorChannel {
+ public:
+  explicit MouseCursorChannel(BinaryMessenger* messenger, TizenViewBase* view);
+  virtual ~MouseCursorChannel();
+
+ private:
+  // Called when a method is called on |channel_|;
+  void HandleMethodCall(
+      const flutter::MethodCall<EncodableValue>& method_call,
+      std::unique_ptr<flutter::MethodResult<EncodableValue>> result);
+
+  // The MethodChannel used for communication with the Flutter engine.
+  std::unique_ptr<flutter::MethodChannel<EncodableValue>> channel_;
+
+  // A reference to the native view managed by FlutterTizenView.
+  TizenViewBase* view_ = nullptr;
+};
+
+}  // namespace flutter
+
+#endif  // EMBEDDER_MOUSE_CURSOR_CHANNEL_H_

flutter/shell/platform/tizen/flutter_tizen_view.cc

@@ -84,6 +84,8 @@ void FlutterTizenView::SetEngine(std::unique_ptr<FlutterTizenEngine> engine) {
 
   platform_channel_ =
       std::make_unique<PlatformChannel>(messenger, tizen_view_.get());
+  mouse_cursor_channel_ =
+      std::make_unique<MouseCursorChannel>(messenger, tizen_view_.get());
   text_input_channel_ = std::make_unique<TextInputChannel>(
       internal_plugin_registrar_->messenger(),
       tizen_view_->input_method_context());

flutter/shell/platform/tizen/flutter_tizen_view.h

@@ -11,6 +11,7 @@
 
 #include "flutter/shell/platform/common/client_wrapper/include/flutter/plugin_registrar.h"
 #include "flutter/shell/platform/embedder/embedder.h"
+#include "flutter/shell/platform/tizen/channels/mouse_cursor_channel.h"
 #include "flutter/shell/platform/tizen/channels/platform_channel.h"
 #include "flutter/shell/platform/tizen/channels/text_input_channel.h"
 #include "flutter/shell/platform/tizen/channels/window_channel.h"
@@ -177,6 +178,9 @@ class FlutterTizenView : public TizenViewEventHandlerDelegate {
   // A plugin that implements the Flutter platform channel.
   std::unique_ptr<PlatformChannel> platform_channel_;
 
+  // A plugin that implements the Flutter cursor channel.
+  std::unique_ptr<MouseCursorChannel> mouse_cursor_channel_;
+
   // A plugin that implements the Flutter textinput channel.
   std::unique_ptr<TextInputChannel> text_input_channel_;
 

flutter/shell/platform/tizen/tizen_view_base.h

@@ -41,6 +41,8 @@ class TizenViewBase {
   // Returns the dpi of the screen.
   virtual int32_t GetDpi() = 0;
 
+  virtual void UpdateFlutterCursor(const std::string& kind) = 0;
+
   // Sets the delegate used to communicate state changes from render target to
   // view such as key presses, mouse position updates etc.
   void SetView(TizenViewEventHandlerDelegate* view_delegate) {

flutter/shell/platform/tizen/tizen_view_elementary.cc

@@ -367,6 +367,10 @@ void TizenViewElementary::Show() {
   evas_object_show(image_);
 }
 
+void TizenViewElementary::UpdateFlutterCursor(const std::string& kind) {
+  FT_LOG(Info) << "UpdateFlutterCursor is not supported.";
+}
+
 void TizenViewElementary::PrepareInputMethod() {
   input_method_context_ =
       std::make_unique<TizenInputMethodContext>(GetWindowId());

flutter/shell/platform/tizen/tizen_view_elementary.h

@@ -37,6 +37,8 @@ class TizenViewElementary : public TizenView {
 
   void Show() override;
 
+  void UpdateFlutterCursor(const std::string& kind) override;
+
  private:
   bool CreateView();
 

flutter/shell/platform/tizen/tizen_view_nui.cc

@@ -97,6 +97,10 @@ void TizenViewNui::OnKey(const char* device_name,
   }
 }
 
+void TizenViewNui::UpdateFlutterCursor(const std::string& kind) {
+  FT_LOG(Info) << "UpdateFlutterCursor is not supported.";
+}
+
 void TizenViewNui::PrepareInputMethod() {
   input_method_context_ =
       std::make_unique<TizenInputMethodContext>(GetWindowId());

flutter/shell/platform/tizen/tizen_view_nui.h

@@ -53,6 +53,8 @@ class TizenViewNui : public TizenView {
              size_t timestamp,
              bool is_down);
 
+  void UpdateFlutterCursor(const std::string& kind) override;
+
  private:
   void RegisterEventHandlers();