1 /*
2  * Copyright (C) 2011 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_INPUT_WINDOW_H
18 #define _UI_INPUT_WINDOW_H
19 
20 #include <input/Input.h>
21 #include <input/InputTransport.h>
22 #include <ui/Rect.h>
23 #include <ui/Region.h>
24 #include <utils/RefBase.h>
25 #include <utils/Timers.h>
26 
27 #include "InputApplication.h"
28 
29 namespace android {
30 class Parcel;
31 
32 /*
33  * Describes the properties of a window that can receive input.
34  */
35 struct InputWindowInfo {
36     InputWindowInfo() = default;
37     InputWindowInfo(const Parcel& from);
38 
39     // Window flags from WindowManager.LayoutParams
40     enum {
41         FLAG_ALLOW_LOCK_WHILE_SCREEN_ON     = 0x00000001,
42         FLAG_DIM_BEHIND        = 0x00000002,
43         FLAG_BLUR_BEHIND        = 0x00000004,
44         FLAG_NOT_FOCUSABLE      = 0x00000008,
45         FLAG_NOT_TOUCHABLE      = 0x00000010,
46         FLAG_NOT_TOUCH_MODAL    = 0x00000020,
47         FLAG_TOUCHABLE_WHEN_WAKING = 0x00000040,
48         FLAG_KEEP_SCREEN_ON     = 0x00000080,
49         FLAG_LAYOUT_IN_SCREEN   = 0x00000100,
50         FLAG_LAYOUT_NO_LIMITS   = 0x00000200,
51         FLAG_FULLSCREEN      = 0x00000400,
52         FLAG_FORCE_NOT_FULLSCREEN   = 0x00000800,
53         FLAG_DITHER             = 0x00001000,
54         FLAG_SECURE             = 0x00002000,
55         FLAG_SCALED             = 0x00004000,
56         FLAG_IGNORE_CHEEK_PRESSES    = 0x00008000,
57         FLAG_LAYOUT_INSET_DECOR = 0x00010000,
58         FLAG_ALT_FOCUSABLE_IM = 0x00020000,
59         FLAG_WATCH_OUTSIDE_TOUCH = 0x00040000,
60         FLAG_SHOW_WHEN_LOCKED = 0x00080000,
61         FLAG_SHOW_WALLPAPER = 0x00100000,
62         FLAG_TURN_SCREEN_ON = 0x00200000,
63         FLAG_DISMISS_KEYGUARD = 0x00400000,
64         FLAG_SPLIT_TOUCH = 0x00800000,
65         FLAG_SLIPPERY = 0x20000000,
66         FLAG_NEEDS_MENU_KEY = 0x40000000,
67     };
68 
69     // Window types from WindowManager.LayoutParams
70     enum {
71         FIRST_APPLICATION_WINDOW = 1,
72         TYPE_BASE_APPLICATION   = 1,
73         TYPE_APPLICATION        = 2,
74         TYPE_APPLICATION_STARTING = 3,
75         LAST_APPLICATION_WINDOW = 99,
76         FIRST_SUB_WINDOW        = 1000,
77         TYPE_APPLICATION_PANEL  = FIRST_SUB_WINDOW,
78         TYPE_APPLICATION_MEDIA  = FIRST_SUB_WINDOW+1,
79         TYPE_APPLICATION_SUB_PANEL = FIRST_SUB_WINDOW+2,
80         TYPE_APPLICATION_ATTACHED_DIALOG = FIRST_SUB_WINDOW+3,
81         TYPE_APPLICATION_MEDIA_OVERLAY  = FIRST_SUB_WINDOW+4,
82         LAST_SUB_WINDOW         = 1999,
83         FIRST_SYSTEM_WINDOW     = 2000,
84         TYPE_STATUS_BAR         = FIRST_SYSTEM_WINDOW,
85         TYPE_SEARCH_BAR         = FIRST_SYSTEM_WINDOW+1,
86         TYPE_PHONE              = FIRST_SYSTEM_WINDOW+2,
87         TYPE_SYSTEM_ALERT       = FIRST_SYSTEM_WINDOW+3,
88         TYPE_KEYGUARD           = FIRST_SYSTEM_WINDOW+4,
89         TYPE_TOAST              = FIRST_SYSTEM_WINDOW+5,
90         TYPE_SYSTEM_OVERLAY     = FIRST_SYSTEM_WINDOW+6,
91         TYPE_PRIORITY_PHONE     = FIRST_SYSTEM_WINDOW+7,
92         TYPE_SYSTEM_DIALOG      = FIRST_SYSTEM_WINDOW+8,
93         TYPE_KEYGUARD_DIALOG    = FIRST_SYSTEM_WINDOW+9,
94         TYPE_SYSTEM_ERROR       = FIRST_SYSTEM_WINDOW+10,
95         TYPE_INPUT_METHOD       = FIRST_SYSTEM_WINDOW+11,
96         TYPE_INPUT_METHOD_DIALOG= FIRST_SYSTEM_WINDOW+12,
97         TYPE_WALLPAPER          = FIRST_SYSTEM_WINDOW+13,
98         TYPE_STATUS_BAR_PANEL   = FIRST_SYSTEM_WINDOW+14,
99         TYPE_SECURE_SYSTEM_OVERLAY = FIRST_SYSTEM_WINDOW+15,
100         TYPE_DRAG               = FIRST_SYSTEM_WINDOW+16,
101         TYPE_STATUS_BAR_SUB_PANEL  = FIRST_SYSTEM_WINDOW+17,
102         TYPE_POINTER            = FIRST_SYSTEM_WINDOW+18,
103         TYPE_NAVIGATION_BAR     = FIRST_SYSTEM_WINDOW+19,
104         TYPE_VOLUME_OVERLAY = FIRST_SYSTEM_WINDOW+20,
105         TYPE_BOOT_PROGRESS = FIRST_SYSTEM_WINDOW+21,
106         TYPE_INPUT_CONSUMER = FIRST_SYSTEM_WINDOW+22,
107         TYPE_NAVIGATION_BAR_PANEL = FIRST_SYSTEM_WINDOW+24,
108         TYPE_MAGNIFICATION_OVERLAY = FIRST_SYSTEM_WINDOW+27,
109         TYPE_ACCESSIBILITY_OVERLAY = FIRST_SYSTEM_WINDOW+32,
110         TYPE_DOCK_DIVIDER = FIRST_SYSTEM_WINDOW+34,
111         LAST_SYSTEM_WINDOW      = 2999,
112     };
113 
114     enum {
115         INPUT_FEATURE_DISABLE_TOUCH_PAD_GESTURES = 0x00000001,
116         INPUT_FEATURE_NO_INPUT_CHANNEL = 0x00000002,
117         INPUT_FEATURE_DISABLE_USER_ACTIVITY = 0x00000004,
118     };
119 
120     /* These values are filled in by the WM and passed through SurfaceFlinger
121      * unless specified otherwise.
122      */
123     sp<IBinder> token;
124     std::string name;
125     int32_t layoutParamsFlags;
126     int32_t layoutParamsType;
127     nsecs_t dispatchingTimeout;
128 
129     /* These values are filled in by SurfaceFlinger. */
130     int32_t frameLeft;
131     int32_t frameTop;
132     int32_t frameRight;
133     int32_t frameBottom;
134 
135     /*
136      * SurfaceFlinger consumes this value to shrink the computed frame. This is
137      * different from shrinking the touchable region in that it DOES shift the coordinate
138      * space where-as the touchable region does not and is more like "cropping". This
139      * is used for window shadows.
140      */
141     int32_t surfaceInset = 0;
142 
143     // A global scaling factor for all windows. Unlike windowScaleX/Y this results
144     // in scaling of the TOUCH_MAJOR/TOUCH_MINOR axis.
145     float globalScaleFactor;
146 
147     // Scaling factors applied to individual windows.
148     float windowXScale = 1.0f;
149     float windowYScale = 1.0f;
150 
151     /*
152      * This is filled in by the WM relative to the frame and then translated
153      * to absolute coordinates by SurfaceFlinger once the frame is computed.
154      */
155     Region touchableRegion;
156     bool visible;
157     bool canReceiveKeys;
158     bool hasFocus;
159     bool hasWallpaper;
160     bool paused;
161     int32_t layer;
162     int32_t ownerPid;
163     int32_t ownerUid;
164     int32_t inputFeatures;
165     int32_t displayId;
166     int32_t portalToDisplayId = ADISPLAY_ID_NONE;
167     InputApplicationInfo applicationInfo;
168     bool replaceTouchableRegionWithCrop;
169     wp<IBinder> touchableRegionCropHandle;
170 
171     void addTouchableRegion(const Rect& region);
172 
173     bool touchableRegionContainsPoint(int32_t x, int32_t y) const;
174     bool frameContainsPoint(int32_t x, int32_t y) const;
175 
176     /* Returns true if the window is of a trusted type that is allowed to silently
177      * overlay other windows for the purpose of implementing the secure views feature.
178      * Trusted overlays, such as IME windows, can partly obscure other windows without causing
179      * motion events to be delivered to them with AMOTION_EVENT_FLAG_WINDOW_IS_OBSCURED.
180      */
181     bool isTrustedOverlay() const;
182 
183     bool supportsSplitTouch() const;
184 
185     bool overlaps(const InputWindowInfo* other) const;
186 
187     status_t write(Parcel& output) const;
188     static InputWindowInfo read(const Parcel& from);
189 };
190 
191 
192 /*
193  * Handle for a window that can receive input.
194  *
195  * Used by the native input dispatcher to indirectly refer to the window manager objects
196  * that describe a window.
197  */
198 class InputWindowHandle : public RefBase {
199 public:
200 
getInfo()201     inline const InputWindowInfo* getInfo() const {
202         return &mInfo;
203     }
204 
205     sp<IBinder> getToken() const;
206 
getApplicationToken()207     sp<IBinder> getApplicationToken() {
208         return mInfo.applicationInfo.token;
209     }
210 
getName()211     inline std::string getName() const {
212         return mInfo.token ? mInfo.name : "<invalid>";
213     }
214 
getDispatchingTimeout(nsecs_t defaultValue)215     inline nsecs_t getDispatchingTimeout(nsecs_t defaultValue) const {
216         return mInfo.token ? mInfo.dispatchingTimeout : defaultValue;
217     }
218 
219     /**
220      * Requests that the state of this object be updated to reflect
221      * the most current available information about the application.
222      *
223      * This method should only be called from within the input dispatcher's
224      * critical section.
225      *
226      * Returns true on success, or false if the handle is no longer valid.
227      */
228     virtual bool updateInfo() = 0;
229 
230     /**
231      * Updates from another input window handle.
232      */
233     void updateFrom(const sp<InputWindowHandle> handle);
234 
235     /**
236      * Releases the channel used by the associated information when it is
237      * no longer needed.
238      */
239     void releaseChannel();
240 
241 protected:
242     explicit InputWindowHandle();
243     virtual ~InputWindowHandle();
244 
245     InputWindowInfo mInfo;
246 };
247 
248 } // namespace android
249 
250 #endif // _UI_INPUT_WINDOW_H
251