(#3357) provide a mechanism to move the cursor to a position immediately

include/miral/miral/window_manager_tools.h

@@ -256,6 +256,13 @@ class WindowManagerTools
      */
     void invoke_under_lock(std::function<void()> const& callback);
 
+    /**
+     * Move the cursor to the provided point. If the point is outside of the range of the outputs,
+     * the point is clamped.
+     * @param point
+     */
+    void move_cursor_to(mir::geometry::PointF point);
+
 private:
     WindowManagerToolsImplementation* tools;
 };

src/miral/basic_window_manager.cpp

@@ -25,6 +25,9 @@
 #include <mir/shell/display_layout.h>
 #include <mir/shell/persistent_surface_store.h>
 #include <mir/shell/surface_specification.h>
+#include <mir/input/virtual_input_device.h>
+#include <mir/input/event_builder.h>
+#include <mir/input/input_sink.h>
 
 #include <boost/throw_exception.hpp>
 
@@ -99,7 +102,8 @@ miral::BasicWindowManager::BasicWindowManager(
     display_layout(display_layout),
     persistent_surface_store{persistent_surface_store},
     policy(build(WindowManagerTools{this})),
-    display_config_monitor{std::make_shared<DisplayConfigurationListeners>()}
+    display_config_monitor{std::make_shared<DisplayConfigurationListeners>()},
+    pointer_device{std::make_shared<mir::input::VirtualInputDevice>("basic-window-manager", mir::input::DeviceCapability::pointer)}
 {
     display_config_monitor->add_listener(this);
     display_configuration_observers.register_interest(display_config_monitor);
@@ -2981,3 +2985,21 @@ void miral::BasicWindowManager::update_application_zones_and_attached_windows()
         area->zone_policy_knows_about = area->application_zone;
     }
 }
+
+void miral::BasicWindowManager::move_cursor_to(mir::geometry::PointF point)
+{
+    pointer_device->if_started_then([&](input::InputSink* sink, input::EventBuilder* builder)
+    {
+        std::chrono::nanoseconds now = std::chrono::system_clock::now().time_since_epoch();
+        auto event = builder->pointer_event(
+            now,
+            mir_pointer_action_motion,
+            0,
+            point,
+            DisplacementF{0, 0},
+            mir_pointer_axis_source_none,
+            events::ScrollAxisH(),
+            events::ScrollAxisV());
+        sink->handle_input(std::move(event));
+    });
+}

src/miral/basic_window_manager.h

@@ -45,6 +45,7 @@ namespace mir
 {
 namespace shell { class DisplayLayout; class PersistentSurfaceStore; }
 namespace graphics { class DisplayConfigurationObserver; }
+namespace input { class VirtualInputDevice; }
 }
 
 namespace miral
@@ -192,6 +193,8 @@ class BasicWindowManager : public virtual mir::shell::WindowManager,
 
     void invoke_under_lock(std::function<void()> const& callback) override;
 
+    void move_cursor_to(mir::geometry::PointF point) override;
+
 private:
     /// An area for windows to be placed in
     struct DisplayArea
@@ -272,6 +275,7 @@ class BasicWindowManager : public virtual mir::shell::WindowManager,
     wwbimap_t workspaces_to_windows;
 
     std::shared_ptr<DisplayConfigurationListeners> const display_config_monitor;
+    std::shared_ptr<mir::input::VirtualInputDevice> const pointer_device;
 
     struct Locker;
 

src/miral/window_management_trace.cpp

@@ -938,3 +938,12 @@ try {
     return policy->advise_application_zone_delete(application_zone);
 }
 MIRAL_TRACE_EXCEPTION
+
+void miral::WindowManagementTrace::move_cursor_to(mir::geometry::PointF point)
+try {
+    std::stringstream out;
+    out << point;
+    mir::log_info("%s cursor=%s", __func__, out.str().c_str());
+    wrapped.move_cursor_to(point);
+}
+MIRAL_TRACE_EXCEPTION

src/miral/window_management_trace.h

@@ -132,6 +132,8 @@ class WindowManagementTrace
         MirWindowState new_state,
         Rectangle const& new_placement) -> Rectangle override;
 
+    void move_cursor_to(mir::geometry::PointF point) override;
+
 public:
     virtual void advise_begin() override;
 

src/miral/window_manager_tools.cpp

@@ -143,3 +143,6 @@ void miral::WindowManagerTools::for_each_window_in_workspace(
     std::shared_ptr<miral::Workspace> const& workspace,
     std::function<void(miral::Window const&)> const& callback)
 { tools->for_each_window_in_workspace(workspace, callback); }
+
+void miral::WindowManagerTools::move_cursor_to(mir::geometry::PointF point)
+{ tools->move_cursor_to(point); }

src/miral/window_manager_tools_implementation.h

@@ -89,6 +89,7 @@ class WindowManagerToolsImplementation
     virtual void for_each_window_in_workspace(
         std::shared_ptr<Workspace> const& workspace,
         std::function<void(Window const& window)> const& callback) = 0;
+    virtual void move_cursor_to(mir::geometry::PointF point) = 0;
 
 /** @} */