1d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright/* 2d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * Copyright (C) 2011 The Android Open Source Project 3d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * 4d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * Licensed under the Apache License, Version 2.0 (the "License"); 5d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * you may not use this file except in compliance with the License. 6d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * You may obtain a copy of the License at 7d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * 8d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * http://www.apache.org/licenses/LICENSE-2.0 9d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * 10d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * Unless required by applicable law or agreed to in writing, software 11d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * distributed under the License is distributed on an "AS IS" BASIS, 12d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * See the License for the specific language governing permissions and 14d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * limitations under the License. 15d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright */ 16d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 17d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright#ifndef _UI_INPUT_APPLICATION_H 18d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright#define _UI_INPUT_APPLICATION_H 19d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 20d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright#include <input/Input.h> 21d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 22d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright#include <utils/RefBase.h> 23d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright#include <utils/Timers.h> 24d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright#include <utils/String8.h> 25d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 26d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wrightnamespace android { 27d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 28d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright/* 29d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * Describes the properties of an application that can receive input. 30d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright */ 31d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wrightstruct InputApplicationInfo { 32d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright String8 name; 33d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright nsecs_t dispatchingTimeout; 34d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright}; 35d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 36d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 37d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright/* 38d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * Handle for an application that can receive input. 39d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * 40d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * Used by the native input dispatcher as a handle for the window manager objects 41d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * that describe an application. 42d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright */ 43d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wrightclass InputApplicationHandle : public RefBase { 44d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wrightpublic: 45d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright inline const InputApplicationInfo* getInfo() const { 46d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright return mInfo; 47d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright } 48d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 49d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright inline String8 getName() const { 50d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright return mInfo ? mInfo->name : String8("<invalid>"); 51d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright } 52d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 53d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright inline nsecs_t getDispatchingTimeout(nsecs_t defaultValue) const { 54d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright return mInfo ? mInfo->dispatchingTimeout : defaultValue; 55d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright } 56d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 57d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright /** 58d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * Requests that the state of this object be updated to reflect 59d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * the most current available information about the application. 60d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * 61d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * This method should only be called from within the input dispatcher's 62d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * critical section. 63d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * 64d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * Returns true on success, or false if the handle is no longer valid. 65d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright */ 66d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright virtual bool updateInfo() = 0; 67d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 68d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright /** 69d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * Releases the storage used by the associated information when it is 70d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright * no longer needed. 71d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright */ 72d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright void releaseInfo(); 73d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 74d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wrightprotected: 75d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright InputApplicationHandle(); 76d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright virtual ~InputApplicationHandle(); 77d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 78d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright InputApplicationInfo* mInfo; 79d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright}; 80d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 81d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright} // namespace android 82d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright 83d02c5b6aace05d9fd938e2d03705ac4f60f8da19Michael Wright#endif // _UI_INPUT_APPLICATION_H 84