blob: ca14b6e9bfdc4f56fc409962c519c4666c1802a4 [file] [log] [blame]
Jeff Brownb4ff35d2011-01-02 16:37:43 -08001/*
2 * Copyright (C) 2010 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#ifndef _UI_POINTER_CONTROLLER_H
18#define _UI_POINTER_CONTROLLER_H
19
Michael Wrighta0bc6b12020-06-26 20:25:34 +010020#include <PointerControllerInterface.h>
21#include <gui/DisplayEventReceiver.h>
Arthur Hungb9b32002018-12-18 17:39:43 +080022#include <input/DisplayViewport.h>
Jeff Brown9d3b1a42013-07-01 19:07:15 -070023#include <input/Input.h>
Jeff Brown8a90e6e2012-05-11 12:24:35 -070024#include <utils/BitSet.h>
Jeff Brown05dc66a2011-03-02 14:41:58 -080025#include <utils/Looper.h>
Michael Wrighta0bc6b12020-06-26 20:25:34 +010026#include <utils/RefBase.h>
27
28#include <map>
29#include <memory>
Michael Wright72a89132022-10-22 03:16:31 +010030#include <string>
Michael Wrighta0bc6b12020-06-26 20:25:34 +010031#include <vector>
32
Liam Harringtonc782be62020-07-17 19:48:24 +000033#include "MouseCursorController.h"
34#include "PointerControllerContext.h"
Michael Wrighta0bc6b12020-06-26 20:25:34 +010035#include "SpriteController.h"
Liam Harringtonc782be62020-07-17 19:48:24 +000036#include "TouchSpotController.h"
Jeff Brownb4ff35d2011-01-02 16:37:43 -080037
Jeff Brownb4ff35d2011-01-02 16:37:43 -080038namespace android {
39
Jeff Brown2352b972011-04-12 22:39:53 -070040/*
Jeff Brownb4ff35d2011-01-02 16:37:43 -080041 * Tracks pointer movements and draws the pointer sprite to a surface.
42 *
43 * Handles pointer acceleration and animation.
44 */
Michael Wrighta0bc6b12020-06-26 20:25:34 +010045class PointerController : public PointerControllerInterface {
Jeff Brownb4ff35d2011-01-02 16:37:43 -080046public:
Michael Wrighta0bc6b12020-06-26 20:25:34 +010047 static std::shared_ptr<PointerController> create(
48 const sp<PointerControllerPolicyInterface>& policy, const sp<Looper>& looper,
49 const sp<SpriteController>& spriteController);
Jeff Brown05dc66a2011-03-02 14:41:58 -080050
Prabir Pradhanf97fac32021-11-18 16:40:34 +000051 ~PointerController() override;
Jeff Brownb4ff35d2011-01-02 16:37:43 -080052
Siarhei Vishniakoua21a5492023-03-15 09:29:53 -070053 std::optional<FloatRect> getBounds() const override;
54 void move(float deltaX, float deltaY) override;
55 void setPosition(float x, float y) override;
56 FloatPoint getPosition() const override;
57 int32_t getDisplayId() const override;
58 void fade(Transition transition) override;
59 void unfade(Transition transition) override;
60 void setDisplayViewport(const DisplayViewport& viewport) override;
Jeff Brownb4ff35d2011-01-02 16:37:43 -080061
Siarhei Vishniakoua21a5492023-03-15 09:29:53 -070062 void setPresentation(Presentation presentation) override;
63 void setSpots(const PointerCoords* spotCoords, const uint32_t* spotIdToIndex,
64 BitSet32 spotIdBits, int32_t displayId) override;
65 void clearSpots() override;
Jeff Brown2352b972011-04-12 22:39:53 -070066
Brandon Pollack015f5d92022-06-02 06:59:33 +000067 void updatePointerIcon(PointerIconStyle iconId);
Jun Mukaid4eaef72015-10-30 15:54:33 -070068 void setCustomPointerIcon(const SpriteIcon& icon);
Jeff Brown2352b972011-04-12 22:39:53 -070069 void setInactivityTimeout(InactivityTimeout inactivityTimeout);
Liam Harringtonc782be62020-07-17 19:48:24 +000070 void doInactivityTimeout();
Jun Mukai19a56012015-11-24 11:25:52 -080071 void reloadPointerResources();
Liam Harringtonc782be62020-07-17 19:48:24 +000072 void onDisplayViewportsUpdated(std::vector<DisplayViewport>& viewports);
Jeff Brownb4ff35d2011-01-02 16:37:43 -080073
Prabir Pradhan5693cee2021-12-31 06:51:15 -080074 void onDisplayInfosChangedLocked(const std::vector<gui::DisplayInfo>& displayInfos)
75 REQUIRES(getLock());
76
Michael Wright72a89132022-10-22 03:16:31 +010077 void dump(std::string& dump);
78
Prabir Pradhan5693cee2021-12-31 06:51:15 -080079protected:
80 using WindowListenerConsumer =
81 std::function<void(const sp<android::gui::WindowInfosListener>&)>;
82
83 // Constructor used to test WindowInfosListener registration.
84 PointerController(const sp<PointerControllerPolicyInterface>& policy, const sp<Looper>& looper,
85 const sp<SpriteController>& spriteController,
86 WindowListenerConsumer registerListener,
87 WindowListenerConsumer unregisterListener);
Prabir Pradhanf97fac32021-11-18 16:40:34 +000088
Jeff Brownb4ff35d2011-01-02 16:37:43 -080089private:
Prabir Pradhan5693cee2021-12-31 06:51:15 -080090 PointerController(const sp<PointerControllerPolicyInterface>& policy, const sp<Looper>& looper,
91 const sp<SpriteController>& spriteController);
92
Liam Harringtonc782be62020-07-17 19:48:24 +000093 friend PointerControllerContext::LooperCallback;
94 friend PointerControllerContext::MessageHandler;
Jeff Brown2352b972011-04-12 22:39:53 -070095
Prabir Pradhan5693cee2021-12-31 06:51:15 -080096 // PointerController's DisplayInfoListener can outlive the PointerController because when the
97 // listener is registered, a strong pointer to the listener (which can extend its lifecycle)
98 // is given away. To avoid the small overhead of using two separate locks in these two objects,
99 // we use the DisplayInfoListener's lock in PointerController.
100 std::mutex& getLock() const;
Jeff Brown2352b972011-04-12 22:39:53 -0700101
Liam Harringtonc782be62020-07-17 19:48:24 +0000102 PointerControllerContext mContext;
Jeff Brown2352b972011-04-12 22:39:53 -0700103
Liam Harringtonc782be62020-07-17 19:48:24 +0000104 MouseCursorController mCursorController;
Jeff Brown2352b972011-04-12 22:39:53 -0700105
Jeff Brownb4ff35d2011-01-02 16:37:43 -0800106 struct Locked {
Jeff Brown2352b972011-04-12 22:39:53 -0700107 Presentation presentation;
Prabir Pradhan0e3d6652022-03-10 14:39:46 +0000108 int32_t pointerDisplayId = ADISPLAY_ID_NONE;
Jeff Brown2352b972011-04-12 22:39:53 -0700109
Prabir Pradhanf97fac32021-11-18 16:40:34 +0000110 std::vector<gui::DisplayInfo> mDisplayInfos;
Liam Harringtonc782be62020-07-17 19:48:24 +0000111 std::unordered_map<int32_t /* displayId */, TouchSpotController> spotControllers;
Prabir Pradhan5693cee2021-12-31 06:51:15 -0800112 } mLocked GUARDED_BY(getLock());
Jeff Brown05dc66a2011-03-02 14:41:58 -0800113
Prabir Pradhanf97fac32021-11-18 16:40:34 +0000114 class DisplayInfoListener : public gui::WindowInfosListener {
115 public:
Prabir Pradhan5693cee2021-12-31 06:51:15 -0800116 explicit DisplayInfoListener(PointerController* pc) : mPointerController(pc){};
Prabir Pradhanf97fac32021-11-18 16:40:34 +0000117 void onWindowInfosChanged(const std::vector<android::gui::WindowInfo>&,
118 const std::vector<android::gui::DisplayInfo>&) override;
Prabir Pradhan5693cee2021-12-31 06:51:15 -0800119 void onPointerControllerDestroyed();
120
121 // This lock is also used by PointerController. See PointerController::getLock().
122 std::mutex mLock;
Prabir Pradhanf97fac32021-11-18 16:40:34 +0000123
124 private:
Prabir Pradhan5693cee2021-12-31 06:51:15 -0800125 PointerController* mPointerController GUARDED_BY(mLock);
Prabir Pradhanf97fac32021-11-18 16:40:34 +0000126 };
Prabir Pradhan5693cee2021-12-31 06:51:15 -0800127
Prabir Pradhanf97fac32021-11-18 16:40:34 +0000128 sp<DisplayInfoListener> mDisplayInfoListener;
Prabir Pradhan5693cee2021-12-31 06:51:15 -0800129 const WindowListenerConsumer mUnregisterWindowInfosListener;
Prabir Pradhanf97fac32021-11-18 16:40:34 +0000130
Prabir Pradhan5693cee2021-12-31 06:51:15 -0800131 const ui::Transform& getTransformForDisplayLocked(int displayId) const REQUIRES(getLock());
Prabir Pradhanf97fac32021-11-18 16:40:34 +0000132
Prabir Pradhan5693cee2021-12-31 06:51:15 -0800133 void clearSpotsLocked() REQUIRES(getLock());
Jeff Brownb4ff35d2011-01-02 16:37:43 -0800134};
135
136} // namespace android
137
138#endif // _UI_POINTER_CONTROLLER_H