Home | History | Annotate | Download | only in input 
      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_APPLICATION_H
     18 #define _UI_INPUT_APPLICATION_H
     19 
     20 #include <string>
     21 
     22 #include <binder/IBinder.h>
     23 #include <binder/Parcel.h>
     24 
     25 #include <input/Input.h>
     26 #include <utils/RefBase.h>
     27 #include <utils/Timers.h>
     28 
     29 namespace android {
     30 
     31 /*
     32  * Describes the properties of an application that can receive input.
     33  */
     34 struct InputApplicationInfo {
     35     sp<IBinder> token;
     36     std::string name;
     37     nsecs_t dispatchingTimeout;
     38 
     39     status_t write(Parcel& output) const;
     40     static InputApplicationInfo read(const Parcel& from);
     41 };
     42 
     43 
     44 /*
     45  * Handle for an application that can receive input.
     46  *
     47  * Used by the native input dispatcher as a handle for the window manager objects
     48  * that describe an application.
     49  */
     50 class InputApplicationHandle : public RefBase {
     51 public:
     52     inline const InputApplicationInfo* getInfo() const {
     53         return &mInfo;
     54     }
     55 
     56     inline std::string getName() const {
     57         return !mInfo.name.empty() ? mInfo.name : "<invalid>";
     58     }
     59 
     60     inline nsecs_t getDispatchingTimeout(nsecs_t defaultValue) const {
     61         return mInfo.token ? mInfo.dispatchingTimeout : defaultValue;
     62     }
     63 
     64     inline sp<IBinder> getApplicationToken() const {
     65         return mInfo.token;
     66     }
     67 
     68     /**
     69      * Requests that the state of this object be updated to reflect
     70      * the most current available information about the application.
     71      *
     72      * This method should only be called from within the input dispatcher's
     73      * critical section.
     74      *
     75      * Returns true on success, or false if the handle is no longer valid.
     76      */
     77     virtual bool updateInfo() = 0;
     78 protected:
     79     InputApplicationHandle();
     80     virtual ~InputApplicationHandle();
     81 
     82     InputApplicationInfo mInfo;
     83 };
     84 
     85 } // namespace android
     86 
     87 #endif // _UI_INPUT_APPLICATION_H
     88