1 /* 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 17 #pragma once 18 19 #include <ftl/flags.h> 20 #include <gui/WindowInfo.h> 21 #include <gui/constants.h> 22 #include <input/InputTransport.h> 23 #include <ui/Transform.h> 24 #include <utils/BitSet.h> 25 #include <bitset> 26 27 namespace android::inputdispatcher { 28 29 /* 30 * An input target specifies how an input event is to be dispatched to a particular window 31 * including the window's input channel, control flags, a timeout, and an X / Y offset to 32 * be added to input event coordinates to compensate for the absolute position of the 33 * window area. 34 */ 35 struct InputTarget { 36 enum class Flags : uint32_t { 37 /* This flag indicates that the event is being delivered to a foreground application. */ 38 FOREGROUND = 1 << 0, 39 40 /* This flag indicates that the MotionEvent falls within the area of the target 41 * obscured by another visible window above it. The motion event should be 42 * delivered with flag AMOTION_EVENT_FLAG_WINDOW_IS_OBSCURED. */ 43 WINDOW_IS_OBSCURED = 1 << 1, 44 45 /* This flag indicates that a motion event is being split across multiple windows. */ 46 SPLIT = 1 << 2, 47 48 /* This flag indicates that the pointer coordinates dispatched to the application 49 * will be zeroed out to avoid revealing information to an application. This is 50 * used in conjunction with FLAG_DISPATCH_AS_OUTSIDE to prevent apps not sharing 51 * the same UID from watching all touches. */ 52 ZERO_COORDS = 1 << 3, 53 54 /* This flag indicates that the event should be sent as is. 55 * Should always be set unless the event is to be transmuted. */ 56 DISPATCH_AS_IS = 1 << 8, 57 58 /* This flag indicates that a MotionEvent with AMOTION_EVENT_ACTION_DOWN falls outside 59 * of the area of this target and so should instead be delivered as an 60 * AMOTION_EVENT_ACTION_OUTSIDE to this target. */ 61 DISPATCH_AS_OUTSIDE = 1 << 9, 62 63 /* This flag indicates that a hover sequence is starting in the given window. 64 * The event is transmuted into ACTION_HOVER_ENTER. */ 65 DISPATCH_AS_HOVER_ENTER = 1 << 10, 66 67 /* This flag indicates that a hover event happened outside of a window which handled 68 * previous hover events, signifying the end of the current hover sequence for that 69 * window. 70 * The event is transmuted into ACTION_HOVER_ENTER. */ 71 DISPATCH_AS_HOVER_EXIT = 1 << 11, 72 73 /* This flag indicates that the event should be canceled. 74 * It is used to transmute ACTION_MOVE into ACTION_CANCEL when a touch slips 75 * outside of a window. */ 76 DISPATCH_AS_SLIPPERY_EXIT = 1 << 12, 77 78 /* This flag indicates that the event should be dispatched as an initial down. 79 * It is used to transmute ACTION_MOVE into ACTION_DOWN when a touch slips 80 * into a new window. */ 81 DISPATCH_AS_SLIPPERY_ENTER = 1 << 13, 82 83 /* This flag indicates that the target of a MotionEvent is partly or wholly 84 * obscured by another visible window above it. The motion event should be 85 * delivered with flag AMOTION_EVENT_FLAG_WINDOW_IS_PARTIALLY_OBSCURED. */ 86 WINDOW_IS_PARTIALLY_OBSCURED = 1 << 14, 87 }; 88 89 /* Mask for all dispatch modes. */ 90 static constexpr const ftl::Flags<InputTarget::Flags> DISPATCH_MASK = 91 ftl::Flags<InputTarget::Flags>() | Flags::DISPATCH_AS_IS | Flags::DISPATCH_AS_OUTSIDE | 92 Flags::DISPATCH_AS_HOVER_ENTER | Flags::DISPATCH_AS_HOVER_EXIT | 93 Flags::DISPATCH_AS_SLIPPERY_EXIT | Flags::DISPATCH_AS_SLIPPERY_ENTER; 94 95 // The input channel to be targeted. 96 std::shared_ptr<InputChannel> inputChannel; 97 98 // Flags for the input target. 99 ftl::Flags<Flags> flags; 100 101 // Scaling factor to apply to MotionEvent as it is delivered. 102 // (ignored for KeyEvents) 103 float globalScaleFactor = 1.0f; 104 105 // Current display transform. Used for compatibility for raw coordinates. 106 ui::Transform displayTransform; 107 108 // The subset of pointer ids to include in motion events dispatched to this input target 109 // if FLAG_SPLIT is set. 110 std::bitset<MAX_POINTER_ID + 1> pointerIds; 111 // Event time for the first motion event (ACTION_DOWN) dispatched to this input target if 112 // FLAG_SPLIT is set. 113 std::optional<nsecs_t> firstDownTimeInTarget; 114 // The data is stored by the pointerId. Use the bit position of pointerIds to look up 115 // Transform per pointerId. 116 ui::Transform pointerTransforms[MAX_POINTERS]; 117 118 // The window that this input target is being dispatched to. It is possible for this to be 119 // null for cases like global monitors. 120 sp<gui::WindowInfoHandle> windowHandle; 121 122 void addPointers(std::bitset<MAX_POINTER_ID + 1> pointerIds, const ui::Transform& transform); 123 void setDefaultPointerTransform(const ui::Transform& transform); 124 125 /** 126 * Returns whether the default pointer information should be used. This will be true when the 127 * InputTarget doesn't have any bits set in the pointerIds bitset. This can happen for monitors 128 * and non splittable windows since we want all pointers for the EventEntry to go to this 129 * target. 130 */ 131 bool useDefaultPointerTransform() const; 132 133 /** 134 * Returns the default Transform object. This should be used when useDefaultPointerTransform is 135 * true. 136 */ 137 const ui::Transform& getDefaultPointerTransform() const; 138 139 std::string getPointerInfoString() const; 140 }; 141 142 std::string dispatchModeToString(int32_t dispatchMode); 143 144 } // namespace android::inputdispatcher 145