blob: af28e48121196b35cbdade79287fb544f6aeb55c [file] [log] [blame]
Garfield Tane84e6f92019-08-29 17:28:41 -07001/*
2 * Copyright (C) 2019 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
Prabir Pradhan48108662022-09-09 21:22:04 +000017#pragma once
Garfield Tane84e6f92019-08-29 17:28:41 -070018
19#include "InputDispatcherConfiguration.h"
20
21#include <binder/IBinder.h>
chaviw98318de2021-05-19 16:45:23 -050022#include <gui/InputApplication.h>
Garfield Tane84e6f92019-08-29 17:28:41 -070023#include <input/Input.h>
24#include <utils/RefBase.h>
Prabir Pradhan8ede1d12023-05-08 19:37:44 +000025#include <set>
Garfield Tane84e6f92019-08-29 17:28:41 -070026
27namespace android {
28
Garfield Tane84e6f92019-08-29 17:28:41 -070029/*
30 * Input dispatcher policy interface.
31 *
viktor8a478782023-06-17 09:06:40 +080032 * The input dispatcher policy is used by the input dispatcher to interact with the Window Manager
Garfield Tane84e6f92019-08-29 17:28:41 -070033 * and other system components.
34 *
35 * The actual implementation is partially supported by callbacks into the DVM
36 * via JNI. This interface is also mocked in the unit tests.
37 */
Prabir Pradhana41d2442023-04-20 21:30:40 +000038class InputDispatcherPolicyInterface {
Garfield Tane84e6f92019-08-29 17:28:41 -070039public:
Prabir Pradhana41d2442023-04-20 21:30:40 +000040 InputDispatcherPolicyInterface() = default;
41 virtual ~InputDispatcherPolicyInterface() = default;
42
Garfield Tane84e6f92019-08-29 17:28:41 -070043 /* Notifies the system that a configuration change has occurred. */
44 virtual void notifyConfigurationChanged(nsecs_t when) = 0;
45
Siarhei Vishniakou234129c2020-10-22 22:28:12 -050046 /* Notifies the system that an application does not have a focused window.
47 */
48 virtual void notifyNoFocusedWindowAnr(
49 const std::shared_ptr<InputApplicationHandle>& inputApplicationHandle) = 0;
50
Siarhei Vishniakou3c63fa42020-12-15 02:59:54 +000051 /* Notifies the system that a window just became unresponsive. This indicates that ANR
Prabir Pradhanedd96402022-02-15 01:46:16 -080052 * should be raised for this window. The window can be identified via its input token and the
53 * pid of the owner. The string reason contains information about the input event that we
54 * haven't received a response for.
Siarhei Vishniakou234129c2020-10-22 22:28:12 -050055 */
Prabir Pradhanaeebeb42023-06-13 19:53:03 +000056 virtual void notifyWindowUnresponsive(const sp<IBinder>& token, std::optional<gui::Pid> pid,
Prabir Pradhanedd96402022-02-15 01:46:16 -080057 const std::string& reason) = 0;
Siarhei Vishniakou234129c2020-10-22 22:28:12 -050058
Siarhei Vishniakou3c63fa42020-12-15 02:59:54 +000059 /* Notifies the system that a window just became responsive. This is only called after the
60 * window was first marked "unresponsive". This indicates that ANR dialog (if any) should
61 * no longer should be shown to the user. The window is eligible to cause a new ANR in the
Siarhei Vishniakou234129c2020-10-22 22:28:12 -050062 * future.
63 */
Prabir Pradhanaeebeb42023-06-13 19:53:03 +000064 virtual void notifyWindowResponsive(const sp<IBinder>& token, std::optional<gui::Pid> pid) = 0;
Garfield Tane84e6f92019-08-29 17:28:41 -070065
66 /* Notifies the system that an input channel is unrecoverably broken. */
67 virtual void notifyInputChannelBroken(const sp<IBinder>& token) = 0;
68 virtual void notifyFocusChanged(const sp<IBinder>& oldToken, const sp<IBinder>& newToken) = 0;
Chris Yef59a2f42020-10-16 12:55:26 -070069 virtual void notifySensorEvent(int32_t deviceId, InputDeviceSensorType sensorType,
70 InputDeviceSensorAccuracy accuracy, nsecs_t timestamp,
71 const std::vector<float>& values) = 0;
72 virtual void notifySensorAccuracy(int32_t deviceId, InputDeviceSensorType sensorType,
73 InputDeviceSensorAccuracy accuracy) = 0;
Chris Yefb552902021-02-03 17:18:37 -080074 virtual void notifyVibratorState(int32_t deviceId, bool isOn) = 0;
Garfield Tane84e6f92019-08-29 17:28:41 -070075
Garfield Tane84e6f92019-08-29 17:28:41 -070076 /* Filters an input event.
77 * Return true to dispatch the event unmodified, false to consume the event.
78 * A filter can also transform and inject events later by passing POLICY_FLAG_FILTERED
79 * to injectInputEvent.
80 */
Prabir Pradhana41d2442023-04-20 21:30:40 +000081 virtual bool filterInputEvent(const InputEvent& inputEvent, uint32_t policyFlags) = 0;
Garfield Tane84e6f92019-08-29 17:28:41 -070082
83 /* Intercepts a key event immediately before queueing it.
84 * The policy can use this method as an opportunity to perform power management functions
85 * and early event preprocessing such as updating policy flags.
86 *
87 * This method is expected to set the POLICY_FLAG_PASS_TO_USER policy flag if the event
88 * should be dispatched to applications.
89 */
Prabir Pradhana41d2442023-04-20 21:30:40 +000090 virtual void interceptKeyBeforeQueueing(const KeyEvent& keyEvent, uint32_t& policyFlags) = 0;
Garfield Tane84e6f92019-08-29 17:28:41 -070091
92 /* Intercepts a touch, trackball or other motion event before queueing it.
93 * The policy can use this method as an opportunity to perform power management functions
94 * and early event preprocessing such as updating policy flags.
95 *
96 * This method is expected to set the POLICY_FLAG_PASS_TO_USER policy flag if the event
97 * should be dispatched to applications.
98 */
Prabir Pradhana41d2442023-04-20 21:30:40 +000099 virtual void interceptMotionBeforeQueueing(int32_t displayId, nsecs_t when,
Garfield Tane84e6f92019-08-29 17:28:41 -0700100 uint32_t& policyFlags) = 0;
101
102 /* Allows the policy a chance to intercept a key before dispatching. */
103 virtual nsecs_t interceptKeyBeforeDispatching(const sp<IBinder>& token,
Prabir Pradhana41d2442023-04-20 21:30:40 +0000104 const KeyEvent& keyEvent,
Garfield Tane84e6f92019-08-29 17:28:41 -0700105 uint32_t policyFlags) = 0;
106
107 /* Allows the policy a chance to perform default processing for an unhandled key.
Prabir Pradhana41d2442023-04-20 21:30:40 +0000108 * Returns an alternate key event to redispatch as a fallback, if needed. */
109 virtual std::optional<KeyEvent> dispatchUnhandledKey(const sp<IBinder>& token,
110 const KeyEvent& keyEvent,
111 uint32_t policyFlags) = 0;
Garfield Tane84e6f92019-08-29 17:28:41 -0700112
113 /* Notifies the policy about switch events.
114 */
115 virtual void notifySwitch(nsecs_t when, uint32_t switchValues, uint32_t switchMask,
116 uint32_t policyFlags) = 0;
117
118 /* Poke user activity for an event dispatched to a window. */
Sean Stoutb4e0a592021-02-23 07:34:53 -0800119 virtual void pokeUserActivity(nsecs_t eventTime, int32_t eventType, int32_t displayId) = 0;
Garfield Tane84e6f92019-08-29 17:28:41 -0700120
Garfield Tane84e6f92019-08-29 17:28:41 -0700121 /* Notifies the policy that a pointer down event has occurred outside the current focused
122 * window.
123 *
124 * The touchedToken passed as an argument is the window that received the input event.
125 */
126 virtual void onPointerDownOutsideFocus(const sp<IBinder>& touchedToken) = 0;
Prabir Pradhan99987712020-11-10 18:43:05 -0800127
128 /* Change the Pointer Capture state in InputReader.
129 *
130 * InputDispatcher is solely responsible for updating the Pointer Capture state.
131 */
Prabir Pradhan5cc1a692021-08-06 14:01:18 +0000132 virtual void setPointerCapture(const PointerCaptureRequest&) = 0;
arthurhungf452d0b2021-01-06 00:19:52 +0800133
134 /* Notifies the policy that the drag window has moved over to another window */
135 virtual void notifyDropWindow(const sp<IBinder>& token, float x, float y) = 0;
Prabir Pradhan8ede1d12023-05-08 19:37:44 +0000136
137 /* Notifies the policy that there was an input device interaction with apps. */
138 virtual void notifyDeviceInteraction(int32_t deviceId, nsecs_t timestamp,
Prabir Pradhan8a5c41d2023-06-08 19:13:46 +0000139 const std::set<gui::Uid>& uids) = 0;
Garfield Tane84e6f92019-08-29 17:28:41 -0700140};
141
142} // namespace android