146b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown/* 246b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * Copyright (C) 2010 The Android Open Source Project 346b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * 446b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * Licensed under the Apache License, Version 2.0 (the "License"); 546b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * you may not use this file except in compliance with the License. 646b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * You may obtain a copy of the License at 746b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * 846b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * http://www.apache.org/licenses/LICENSE-2.0 946b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * 1046b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * Unless required by applicable law or agreed to in writing, software 1146b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * distributed under the License is distributed on an "AS IS" BASIS, 1246b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1346b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * See the License for the specific language governing permissions and 1446b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * limitations under the License. 1546b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown */ 1646b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown 1746b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brownpackage android.view; 1846b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown 19a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wrightimport dalvik.system.CloseGuard; 20a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 21a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wrightimport android.os.Looper; 22a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wrightimport android.os.MessageQueue; 23a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wrightimport android.util.Pools.Pool; 24a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wrightimport android.util.Pools.SimplePool; 25a931d5218cfee89c7629ffa6cde324fa966449f9Ashok Bhatimport android.util.LongSparseArray; 26a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 27a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wrightimport java.lang.ref.WeakReference; 28a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 2946b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown/** 3046b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown * An input queue provides a mechanism for an application to receive incoming 311e4b9f3936d6f357e89360293e05a0e16d5fa440Dianne Hackborn * input events. Currently only usable from native code. 3246b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown */ 3346b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brownpublic final class InputQueue { 34a931d5218cfee89c7629ffa6cde324fa966449f9Ashok Bhat private final LongSparseArray<ActiveInputEvent> mActiveEventArray = 35a931d5218cfee89c7629ffa6cde324fa966449f9Ashok Bhat new LongSparseArray<ActiveInputEvent>(20); 36a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright private final Pool<ActiveInputEvent> mActiveInputEventPool = 37a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright new SimplePool<ActiveInputEvent>(20); 38a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 39a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright private final CloseGuard mCloseGuard = CloseGuard.get(); 40a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 41a931d5218cfee89c7629ffa6cde324fa966449f9Ashok Bhat private long mPtr; 42a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 43a931d5218cfee89c7629ffa6cde324fa966449f9Ashok Bhat private static native long nativeInit(WeakReference<InputQueue> weakQueue, 44a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright MessageQueue messageQueue); 45a931d5218cfee89c7629ffa6cde324fa966449f9Ashok Bhat private static native long nativeSendKeyEvent(long ptr, KeyEvent e, boolean preDispatch); 46a931d5218cfee89c7629ffa6cde324fa966449f9Ashok Bhat private static native long nativeSendMotionEvent(long ptr, MotionEvent e); 47a931d5218cfee89c7629ffa6cde324fa966449f9Ashok Bhat private static native void nativeDispose(long ptr); 48a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 49a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright /** @hide */ 50a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright public InputQueue() { 51a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright mPtr = nativeInit(new WeakReference<InputQueue>(this), Looper.myQueue()); 52a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 53a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright mCloseGuard.open("dispose"); 54a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 55a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 56a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright @Override 57a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright protected void finalize() throws Throwable { 58a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright try { 59a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright dispose(true); 60a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } finally { 61a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright super.finalize(); 62a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 63a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 64a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 65a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright /** @hide */ 66a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright public void dispose() { 67a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright dispose(false); 68a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 69a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 70a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright /** @hide */ 71a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright public void dispose(boolean finalized) { 72a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright if (mCloseGuard != null) { 73a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright if (finalized) { 74a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright mCloseGuard.warnIfOpen(); 75a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 76a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright mCloseGuard.close(); 77a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 78a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 79a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright if (mPtr != 0) { 80a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright nativeDispose(mPtr); 81a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright mPtr = 0; 82a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 83a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 84a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 85a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright /** @hide */ 86a931d5218cfee89c7629ffa6cde324fa966449f9Ashok Bhat public long getNativePtr() { 87a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright return mPtr; 88a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 89a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 90a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright /** @hide */ 91a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright public void sendInputEvent(InputEvent e, Object token, boolean predispatch, 92a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright FinishedInputEventCallback callback) { 93a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright ActiveInputEvent event = obtainActiveInputEvent(token, callback); 94a931d5218cfee89c7629ffa6cde324fa966449f9Ashok Bhat long id; 95a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright if (e instanceof KeyEvent) { 96a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright id = nativeSendKeyEvent(mPtr, (KeyEvent) e, predispatch); 97a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } else { 98a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright id = nativeSendMotionEvent(mPtr, (MotionEvent) e); 99a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 100a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright mActiveEventArray.put(id, event); 101a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 102a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 103a931d5218cfee89c7629ffa6cde324fa966449f9Ashok Bhat private void finishInputEvent(long id, boolean handled) { 104a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright int index = mActiveEventArray.indexOfKey(id); 105a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright if (index >= 0) { 106a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright ActiveInputEvent e = mActiveEventArray.valueAt(index); 107a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright mActiveEventArray.removeAt(index); 108a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright e.mCallback.onFinishedInputEvent(e.mToken, handled); 109a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright recycleActiveInputEvent(e); 110a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 111a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 112a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 113a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright private ActiveInputEvent obtainActiveInputEvent(Object token, 114a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright FinishedInputEventCallback callback) { 115a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright ActiveInputEvent e = mActiveInputEventPool.acquire(); 116a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright if (e == null) { 117a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright e = new ActiveInputEvent(); 118a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 119a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright e.mToken = token; 120a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright e.mCallback = callback; 121a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright return e; 122a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 123a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 124a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright private void recycleActiveInputEvent(ActiveInputEvent e) { 125a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright e.recycle(); 126a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright mActiveInputEventPool.release(e); 127a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 128a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 129a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright private final class ActiveInputEvent { 130a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright public Object mToken; 131a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright public FinishedInputEventCallback mCallback; 132a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 133a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright public void recycle() { 134a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright mToken = null; 135a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright mCallback = null; 136a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 137a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright } 138a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 139bfba7cab94cd9cf28e561159dbbe934dc83a6f0aDianne Hackborn /** 140bfba7cab94cd9cf28e561159dbbe934dc83a6f0aDianne Hackborn * Interface to receive notification of when an InputQueue is associated 141bfba7cab94cd9cf28e561159dbbe934dc83a6f0aDianne Hackborn * and dissociated with a thread. 142bfba7cab94cd9cf28e561159dbbe934dc83a6f0aDianne Hackborn */ 1431e4b9f3936d6f357e89360293e05a0e16d5fa440Dianne Hackborn public static interface Callback { 144bfba7cab94cd9cf28e561159dbbe934dc83a6f0aDianne Hackborn /** 145bfba7cab94cd9cf28e561159dbbe934dc83a6f0aDianne Hackborn * Called when the given InputQueue is now associated with the 146bfba7cab94cd9cf28e561159dbbe934dc83a6f0aDianne Hackborn * thread making this call, so it can start receiving events from it. 147bfba7cab94cd9cf28e561159dbbe934dc83a6f0aDianne Hackborn */ 1481e4b9f3936d6f357e89360293e05a0e16d5fa440Dianne Hackborn void onInputQueueCreated(InputQueue queue); 149a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 150bfba7cab94cd9cf28e561159dbbe934dc83a6f0aDianne Hackborn /** 151bfba7cab94cd9cf28e561159dbbe934dc83a6f0aDianne Hackborn * Called when the given InputQueue is no longer associated with 152bfba7cab94cd9cf28e561159dbbe934dc83a6f0aDianne Hackborn * the thread and thus not dispatching events. 153bfba7cab94cd9cf28e561159dbbe934dc83a6f0aDianne Hackborn */ 1541e4b9f3936d6f357e89360293e05a0e16d5fa440Dianne Hackborn void onInputQueueDestroyed(InputQueue queue); 1551e4b9f3936d6f357e89360293e05a0e16d5fa440Dianne Hackborn } 1561e4b9f3936d6f357e89360293e05a0e16d5fa440Dianne Hackborn 1571e4b9f3936d6f357e89360293e05a0e16d5fa440Dianne Hackborn /** @hide */ 158a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright public static interface FinishedInputEventCallback { 159a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright void onFinishedInputEvent(Object token, boolean handled); 16046b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown } 161a44dd26a75e24cc021802288fb81f4761e47be6bMichael Wright 16246b9ac0ae2162309774a7478cd9d4e578747bfc2Jeff Brown} 163