InputWindow.h revision 51eb29fa9a2ffe9c5adb9ea25bfbd51992ff16a4 
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#include <utils/String8.h>
27
28#include "InputApplication.h"
29
30namespace android {
31
32
33/*
34 * Describes the properties of a window that can receive input.
35 */
36struct InputWindowInfo {
37    // Window flags from WindowManager.LayoutParams
38    enum {
39        FLAG_ALLOW_LOCK_WHILE_SCREEN_ON     = 0x00000001,
40        FLAG_DIM_BEHIND        = 0x00000002,
41        FLAG_BLUR_BEHIND        = 0x00000004,
42        FLAG_NOT_FOCUSABLE      = 0x00000008,
43        FLAG_NOT_TOUCHABLE      = 0x00000010,
44        FLAG_NOT_TOUCH_MODAL    = 0x00000020,
45        FLAG_TOUCHABLE_WHEN_WAKING = 0x00000040,
46        FLAG_KEEP_SCREEN_ON     = 0x00000080,
47        FLAG_LAYOUT_IN_SCREEN   = 0x00000100,
48        FLAG_LAYOUT_NO_LIMITS   = 0x00000200,
49        FLAG_FULLSCREEN      = 0x00000400,
50        FLAG_FORCE_NOT_FULLSCREEN   = 0x00000800,
51        FLAG_DITHER             = 0x00001000,
52        FLAG_SECURE             = 0x00002000,
53        FLAG_SCALED             = 0x00004000,
54        FLAG_IGNORE_CHEEK_PRESSES    = 0x00008000,
55        FLAG_LAYOUT_INSET_DECOR = 0x00010000,
56        FLAG_ALT_FOCUSABLE_IM = 0x00020000,
57        FLAG_WATCH_OUTSIDE_TOUCH = 0x00040000,
58        FLAG_SHOW_WHEN_LOCKED = 0x00080000,
59        FLAG_SHOW_WALLPAPER = 0x00100000,
60        FLAG_TURN_SCREEN_ON = 0x00200000,
61        FLAG_DISMISS_KEYGUARD = 0x00400000,
62        FLAG_SPLIT_TOUCH = 0x00800000,
63        FLAG_SLIPPERY = 0x20000000,
64        FLAG_NEEDS_MENU_KEY = 0x40000000,
65    };
66
67    // Private Window flags from WindowManager.LayoutParams
68    enum {
69        PRIVATE_FLAG_SYSTEM_ERROR = 0x00000100,
70    };
71
72    // Window types from WindowManager.LayoutParams
73    enum {
74        FIRST_APPLICATION_WINDOW = 1,
75        TYPE_BASE_APPLICATION   = 1,
76        TYPE_APPLICATION        = 2,
77        TYPE_APPLICATION_STARTING = 3,
78        LAST_APPLICATION_WINDOW = 99,
79        FIRST_SUB_WINDOW        = 1000,
80        TYPE_APPLICATION_PANEL  = FIRST_SUB_WINDOW,
81        TYPE_APPLICATION_MEDIA  = FIRST_SUB_WINDOW+1,
82        TYPE_APPLICATION_SUB_PANEL = FIRST_SUB_WINDOW+2,
83        TYPE_APPLICATION_ATTACHED_DIALOG = FIRST_SUB_WINDOW+3,
84        TYPE_APPLICATION_MEDIA_OVERLAY  = FIRST_SUB_WINDOW+4,
85        LAST_SUB_WINDOW         = 1999,
86        FIRST_SYSTEM_WINDOW     = 2000,
87        TYPE_STATUS_BAR         = FIRST_SYSTEM_WINDOW,
88        TYPE_SEARCH_BAR         = FIRST_SYSTEM_WINDOW+1,
89        TYPE_PHONE              = FIRST_SYSTEM_WINDOW+2,
90        TYPE_SYSTEM_ALERT       = FIRST_SYSTEM_WINDOW+3,
91        TYPE_KEYGUARD           = FIRST_SYSTEM_WINDOW+4,
92        TYPE_TOAST              = FIRST_SYSTEM_WINDOW+5,
93        TYPE_SYSTEM_OVERLAY     = FIRST_SYSTEM_WINDOW+6,
94        TYPE_PRIORITY_PHONE     = FIRST_SYSTEM_WINDOW+7,
95        TYPE_SYSTEM_DIALOG      = FIRST_SYSTEM_WINDOW+8,
96        TYPE_KEYGUARD_DIALOG    = FIRST_SYSTEM_WINDOW+9,
97        TYPE_SYSTEM_ERROR       = FIRST_SYSTEM_WINDOW+10,
98        TYPE_INPUT_METHOD       = FIRST_SYSTEM_WINDOW+11,
99        TYPE_INPUT_METHOD_DIALOG= FIRST_SYSTEM_WINDOW+12,
100        TYPE_WALLPAPER          = FIRST_SYSTEM_WINDOW+13,
101        TYPE_STATUS_BAR_PANEL   = FIRST_SYSTEM_WINDOW+14,
102        TYPE_SECURE_SYSTEM_OVERLAY = FIRST_SYSTEM_WINDOW+15,
103        TYPE_DRAG               = FIRST_SYSTEM_WINDOW+16,
104        TYPE_STATUS_BAR_SUB_PANEL  = FIRST_SYSTEM_WINDOW+17,
105        TYPE_POINTER            = FIRST_SYSTEM_WINDOW+18,
106        TYPE_NAVIGATION_BAR     = FIRST_SYSTEM_WINDOW+19,
107        TYPE_VOLUME_OVERLAY = FIRST_SYSTEM_WINDOW+20,
108        TYPE_BOOT_PROGRESS = FIRST_SYSTEM_WINDOW+21,
109        TYPE_MAGNIFICATION_OVERLAY = FIRST_SYSTEM_WINDOW+22,
110        LAST_SYSTEM_WINDOW      = 2999,
111    };
112
113    enum {
114        INPUT_FEATURE_DISABLE_TOUCH_PAD_GESTURES = 0x00000001,
115        INPUT_FEATURE_NO_INPUT_CHANNEL = 0x00000002,
116        INPUT_FEATURE_DISABLE_USER_ACTIVITY = 0x00000004,
117    };
118
119    sp<InputChannel> inputChannel;
120    String8 name;
121    int32_t layoutParamsFlags;
122    int32_t layoutParamsPrivateFlags;
123    int32_t layoutParamsType;
124    nsecs_t dispatchingTimeout;
125    int32_t frameLeft;
126    int32_t frameTop;
127    int32_t frameRight;
128    int32_t frameBottom;
129    float scaleFactor;
130    Region touchableRegion;
131    bool visible;
132    bool canReceiveKeys;
133    bool hasFocus;
134    bool hasWallpaper;
135    bool paused;
136    int32_t layer;
137    int32_t ownerPid;
138    int32_t ownerUid;
139    int32_t inputFeatures;
140    int32_t displayId;
141
142    void addTouchableRegion(const Rect& region);
143
144    bool touchableRegionContainsPoint(int32_t x, int32_t y) const;
145    bool frameContainsPoint(int32_t x, int32_t y) const;
146
147    /* Returns true if the window is of a trusted type that is allowed to silently
148     * overlay other windows for the purpose of implementing the secure views feature.
149     * Trusted overlays, such as IME windows, can partly obscure other windows without causing
150     * motion events to be delivered to them with AMOTION_EVENT_FLAG_WINDOW_IS_OBSCURED.
151     */
152    bool isTrustedOverlay() const;
153
154    bool supportsSplitTouch() const;
155};
156
157
158/*
159 * Handle for a window that can receive input.
160 *
161 * Used by the native input dispatcher to indirectly refer to the window manager objects
162 * that describe a window.
163 */
164class InputWindowHandle : public RefBase {
165public:
166    const sp<InputApplicationHandle> inputApplicationHandle;
167
168    inline const InputWindowInfo* getInfo() const {
169        return mInfo;
170    }
171
172    inline sp<InputChannel> getInputChannel() const {
173        return mInfo ? mInfo->inputChannel : NULL;
174    }
175
176    inline String8 getName() const {
177        return mInfo ? mInfo->name : String8("<invalid>");
178    }
179
180    inline nsecs_t getDispatchingTimeout(nsecs_t defaultValue) const {
181        return mInfo ? mInfo->dispatchingTimeout : defaultValue;
182    }
183
184    /**
185     * Requests that the state of this object be updated to reflect
186     * the most current available information about the application.
187     *
188     * This method should only be called from within the input dispatcher's
189     * critical section.
190     *
191     * Returns true on success, or false if the handle is no longer valid.
192     */
193    virtual bool updateInfo() = 0;
194
195    /**
196     * Releases the storage used by the associated information when it is
197     * no longer needed.
198     */
199    void releaseInfo();
200
201protected:
202    InputWindowHandle(const sp<InputApplicationHandle>& inputApplicationHandle);
203    virtual ~InputWindowHandle();
204
205    InputWindowInfo* mInfo;
206};
207
208} // namespace android
209
210#endif // _UI_INPUT_WINDOW_H
211