blob: f46038ef73677df07bf0d4de4f0768c5f0935083 [file] [log] [blame]
Prabir Pradhanb56e92c2023-06-09 23:40:37 +00001/*
2 * Copyright 2023 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#pragma once
18
19#include "InputListener.h"
20#include "NotifyArgs.h"
21#include "PointerChoreographerPolicyInterface.h"
22
Byoungho Jungda10dd32023-10-06 17:03:45 +090023#include <android-base/thread_annotations.h>
Prabir Pradhan19767602023-11-03 16:53:31 +000024#include <type_traits>
Byoungho Jungda10dd32023-10-06 17:03:45 +090025
Prabir Pradhanb56e92c2023-06-09 23:40:37 +000026namespace android {
27
Byoungho Jung99326452023-11-03 20:19:17 +090028struct SpriteIcon;
29
Prabir Pradhanb56e92c2023-06-09 23:40:37 +000030/**
Prabir Pradhan19767602023-11-03 16:53:31 +000031 * A helper class that wraps a factory method that acts as a constructor for the type returned
32 * by the factory method.
33 */
34template <typename Factory>
35struct ConstructorDelegate {
36 constexpr ConstructorDelegate(Factory&& factory) : mFactory(std::move(factory)) {}
37
38 using ConstructedType = std::invoke_result_t<const Factory&>;
39 constexpr operator ConstructedType() const { return mFactory(); }
40
41 Factory mFactory;
42};
43
44/**
Prabir Pradhanb56e92c2023-06-09 23:40:37 +000045 * PointerChoreographer manages the icons shown by the system for input interactions.
46 * This includes showing the mouse cursor, stylus hover icons, and touch spots.
47 * It is responsible for accumulating the location of the mouse cursor, and populating
48 * the cursor position for incoming events, if necessary.
49 */
50class PointerChoreographerInterface : public InputListenerInterface {
51public:
52 /**
Byoungho Jungda10dd32023-10-06 17:03:45 +090053 * Set the display that pointers, like the mouse cursor and drawing tablets,
54 * should be drawn on.
55 */
56 virtual void setDefaultMouseDisplayId(int32_t displayId) = 0;
57 virtual void setDisplayViewports(const std::vector<DisplayViewport>& viewports) = 0;
58 virtual std::optional<DisplayViewport> getViewportForPointerDevice(
59 int32_t associatedDisplayId = ADISPLAY_ID_NONE) = 0;
60 virtual FloatPoint getMouseCursorPosition(int32_t displayId) = 0;
Byoungho Jung6f5b16b2023-10-27 18:22:07 +090061 virtual void setShowTouchesEnabled(bool enabled) = 0;
Byoungho Jungd6fe27b2023-10-27 20:49:38 +090062 virtual void setStylusPointerIconEnabled(bool enabled) = 0;
Prabir Pradhan521f4fc2023-12-04 19:09:59 +000063 /**
64 * Set the icon that is shown for the given pointer. The request may fail in some cases, such
65 * as if the device or display was removed, or if the cursor was moved to a different display.
66 * Returns true if the icon was changed successfully, false otherwise.
67 */
Byoungho Jung99326452023-11-03 20:19:17 +090068 virtual bool setPointerIcon(std::variant<std::unique_ptr<SpriteIcon>, PointerIconStyle> icon,
69 int32_t displayId, DeviceId deviceId) = 0;
Prabir Pradhan502ddbd2024-01-19 02:22:38 +000070 /**
71 * Set whether pointer icons for mice, touchpads, and styluses should be visible on the
72 * given display.
73 */
74 virtual void setPointerIconVisibility(int32_t displayId, bool visible) = 0;
Byoungho Jung99326452023-11-03 20:19:17 +090075
Byoungho Jungda10dd32023-10-06 17:03:45 +090076 /**
Prabir Pradhanb56e92c2023-06-09 23:40:37 +000077 * This method may be called on any thread (usually by the input manager on a binder thread).
78 */
79 virtual void dump(std::string& dump) = 0;
80};
81
82class PointerChoreographer : public PointerChoreographerInterface {
83public:
84 explicit PointerChoreographer(InputListenerInterface& listener,
85 PointerChoreographerPolicyInterface&);
86 ~PointerChoreographer() override = default;
87
Byoungho Jungda10dd32023-10-06 17:03:45 +090088 void setDefaultMouseDisplayId(int32_t displayId) override;
89 void setDisplayViewports(const std::vector<DisplayViewport>& viewports) override;
90 std::optional<DisplayViewport> getViewportForPointerDevice(
91 int32_t associatedDisplayId) override;
92 FloatPoint getMouseCursorPosition(int32_t displayId) override;
Byoungho Jung6f5b16b2023-10-27 18:22:07 +090093 void setShowTouchesEnabled(bool enabled) override;
Byoungho Jungd6fe27b2023-10-27 20:49:38 +090094 void setStylusPointerIconEnabled(bool enabled) override;
Byoungho Jung99326452023-11-03 20:19:17 +090095 bool setPointerIcon(std::variant<std::unique_ptr<SpriteIcon>, PointerIconStyle> icon,
96 int32_t displayId, DeviceId deviceId) override;
Prabir Pradhan502ddbd2024-01-19 02:22:38 +000097 void setPointerIconVisibility(int32_t displayId, bool visible) override;
Byoungho Jungda10dd32023-10-06 17:03:45 +090098
Prabir Pradhanb56e92c2023-06-09 23:40:37 +000099 void notifyInputDevicesChanged(const NotifyInputDevicesChangedArgs& args) override;
100 void notifyConfigurationChanged(const NotifyConfigurationChangedArgs& args) override;
101 void notifyKey(const NotifyKeyArgs& args) override;
102 void notifyMotion(const NotifyMotionArgs& args) override;
103 void notifySwitch(const NotifySwitchArgs& args) override;
104 void notifySensor(const NotifySensorArgs& args) override;
105 void notifyVibratorState(const NotifyVibratorStateArgs& args) override;
106 void notifyDeviceReset(const NotifyDeviceResetArgs& args) override;
107 void notifyPointerCaptureChanged(const NotifyPointerCaptureChangedArgs& args) override;
108
109 void dump(std::string& dump) override;
110
111private:
Byoungho Jungda10dd32023-10-06 17:03:45 +0900112 void updatePointerControllersLocked() REQUIRES(mLock);
113 void notifyPointerDisplayIdChangedLocked() REQUIRES(mLock);
114 const DisplayViewport* findViewportByIdLocked(int32_t displayId) const REQUIRES(mLock);
115 int32_t getTargetMouseDisplayLocked(int32_t associatedDisplayId) const REQUIRES(mLock);
Prabir Pradhan990d8712024-03-05 00:31:36 +0000116 std::pair<int32_t /*displayId*/, PointerControllerInterface&> ensureMouseControllerLocked(
Byoungho Jungee6268f2023-10-30 17:27:26 +0900117 int32_t associatedDisplayId) REQUIRES(mLock);
Byoungho Jung6f5b16b2023-10-27 18:22:07 +0900118 InputDeviceInfo* findInputDeviceLocked(DeviceId deviceId) REQUIRES(mLock);
Prabir Pradhan502ddbd2024-01-19 02:22:38 +0000119 bool canUnfadeOnDisplay(int32_t displayId) REQUIRES(mLock);
Byoungho Jungda10dd32023-10-06 17:03:45 +0900120
121 NotifyMotionArgs processMotion(const NotifyMotionArgs& args);
122 NotifyMotionArgs processMouseEventLocked(const NotifyMotionArgs& args) REQUIRES(mLock);
Byoungho Jungee6268f2023-10-30 17:27:26 +0900123 NotifyMotionArgs processTouchpadEventLocked(const NotifyMotionArgs& args) REQUIRES(mLock);
Byoungho Jung6f5b16b2023-10-27 18:22:07 +0900124 void processTouchscreenAndStylusEventLocked(const NotifyMotionArgs& args) REQUIRES(mLock);
Byoungho Jungd6fe27b2023-10-27 20:49:38 +0900125 void processStylusHoverEventLocked(const NotifyMotionArgs& args) REQUIRES(mLock);
Byoungho Jung6f5b16b2023-10-27 18:22:07 +0900126 void processDeviceReset(const NotifyDeviceResetArgs& args);
Byoungho Jungda10dd32023-10-06 17:03:45 +0900127
Prabir Pradhan19767602023-11-03 16:53:31 +0000128 using ControllerConstructor =
129 ConstructorDelegate<std::function<std::shared_ptr<PointerControllerInterface>()>>;
Prabir Pradhan16788792023-11-08 21:07:21 +0000130 ControllerConstructor mTouchControllerConstructor GUARDED_BY(mLock);
Prabir Pradhan19767602023-11-03 16:53:31 +0000131 ControllerConstructor getMouseControllerConstructor(int32_t displayId) REQUIRES(mLock);
Byoungho Jungd6fe27b2023-10-27 20:49:38 +0900132 ControllerConstructor getStylusControllerConstructor(int32_t displayId) REQUIRES(mLock);
Prabir Pradhan19767602023-11-03 16:53:31 +0000133
Byoungho Jungda10dd32023-10-06 17:03:45 +0900134 std::mutex mLock;
135
Prabir Pradhanb56e92c2023-06-09 23:40:37 +0000136 InputListenerInterface& mNextListener;
Byoungho Jungda10dd32023-10-06 17:03:45 +0900137 PointerChoreographerPolicyInterface& mPolicy;
138
139 std::map<int32_t, std::shared_ptr<PointerControllerInterface>> mMousePointersByDisplay
140 GUARDED_BY(mLock);
Byoungho Jung6f5b16b2023-10-27 18:22:07 +0900141 std::map<DeviceId, std::shared_ptr<PointerControllerInterface>> mTouchPointersByDevice
142 GUARDED_BY(mLock);
Byoungho Jungd6fe27b2023-10-27 20:49:38 +0900143 std::map<DeviceId, std::shared_ptr<PointerControllerInterface>> mStylusPointersByDevice
144 GUARDED_BY(mLock);
Byoungho Jungda10dd32023-10-06 17:03:45 +0900145
146 int32_t mDefaultMouseDisplayId GUARDED_BY(mLock);
147 int32_t mNotifiedPointerDisplayId GUARDED_BY(mLock);
148 std::vector<InputDeviceInfo> mInputDeviceInfos GUARDED_BY(mLock);
Prabir Pradhan6506f6f2023-12-11 20:48:39 +0000149 std::set<DeviceId> mMouseDevices GUARDED_BY(mLock);
Byoungho Jungda10dd32023-10-06 17:03:45 +0900150 std::vector<DisplayViewport> mViewports GUARDED_BY(mLock);
Byoungho Jung6f5b16b2023-10-27 18:22:07 +0900151 bool mShowTouchesEnabled GUARDED_BY(mLock);
Byoungho Jungd6fe27b2023-10-27 20:49:38 +0900152 bool mStylusPointerIconEnabled GUARDED_BY(mLock);
Prabir Pradhan502ddbd2024-01-19 02:22:38 +0000153 std::set<int32_t /*displayId*/> mDisplaysWithPointersHidden;
Prabir Pradhanb56e92c2023-06-09 23:40:37 +0000154};
155
156} // namespace android