InputDevice.h revision af9e8d38184c6ba4d2d3eb5bde7014a66dd8a78b
1/* 2 * Copyright (C) 2012 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 _ANDROIDFW_INPUT_DEVICE_H 18#define _ANDROIDFW_INPUT_DEVICE_H 19 20#include <androidfw/Input.h> 21#include <androidfw/KeyCharacterMap.h> 22 23namespace android { 24 25/* 26 * Identifies a device. 27 */ 28struct InputDeviceIdentifier { 29 inline InputDeviceIdentifier() : 30 bus(0), vendor(0), product(0), version(0) { 31 } 32 33 // Information provided by the kernel. 34 String8 name; 35 String8 location; 36 String8 uniqueId; 37 uint16_t bus; 38 uint16_t vendor; 39 uint16_t product; 40 uint16_t version; 41 42 // A composite input device descriptor string that uniquely identifies the device 43 // even across reboots or reconnections. The value of this field is used by 44 // upper layers of the input system to associate settings with individual devices. 45 // It is hashed from whatever kernel provided information is available. 46 // Ideally, the way this value is computed should not change between Android releases 47 // because that would invalidate persistent settings that rely on it. 48 String8 descriptor; 49}; 50 51/* 52 * Describes the characteristics and capabilities of an input device. 53 */ 54class InputDeviceInfo { 55public: 56 InputDeviceInfo(); 57 InputDeviceInfo(const InputDeviceInfo& other); 58 ~InputDeviceInfo(); 59 60 struct MotionRange { 61 int32_t axis; 62 uint32_t source; 63 float min; 64 float max; 65 float flat; 66 float fuzz; 67 }; 68 69 void initialize(int32_t id, int32_t generation, 70 const String8& name, const String8& descriptor); 71 72 inline int32_t getId() const { return mId; } 73 inline int32_t getGeneration() const { return mGeneration; } 74 inline const String8 getName() const { return mName; } 75 inline const String8 getDescriptor() const { return mDescriptor; } 76 inline uint32_t getSources() const { return mSources; } 77 78 const MotionRange* getMotionRange(int32_t axis, uint32_t source) const; 79 80 void addSource(uint32_t source); 81 void addMotionRange(int32_t axis, uint32_t source, 82 float min, float max, float flat, float fuzz); 83 void addMotionRange(const MotionRange& range); 84 85 inline void setKeyboardType(int32_t keyboardType) { mKeyboardType = keyboardType; } 86 inline int32_t getKeyboardType() const { return mKeyboardType; } 87 88 inline void setKeyCharacterMap(const sp<KeyCharacterMap>& value) { 89 mKeyCharacterMap = value; 90 } 91 92 inline sp<KeyCharacterMap> getKeyCharacterMap() const { 93 return mKeyCharacterMap; 94 } 95 96 inline const Vector<MotionRange>& getMotionRanges() const { 97 return mMotionRanges; 98 } 99 100private: 101 int32_t mId; 102 int32_t mGeneration; 103 String8 mName; 104 String8 mDescriptor; 105 uint32_t mSources; 106 int32_t mKeyboardType; 107 sp<KeyCharacterMap> mKeyCharacterMap; 108 109 Vector<MotionRange> mMotionRanges; 110}; 111 112/* Types of input device configuration files. */ 113enum InputDeviceConfigurationFileType { 114 INPUT_DEVICE_CONFIGURATION_FILE_TYPE_CONFIGURATION = 0, /* .idc file */ 115 INPUT_DEVICE_CONFIGURATION_FILE_TYPE_KEY_LAYOUT = 1, /* .kl file */ 116 INPUT_DEVICE_CONFIGURATION_FILE_TYPE_KEY_CHARACTER_MAP = 2, /* .kcm file */ 117}; 118 119/* 120 * Gets the path of an input device configuration file, if one is available. 121 * Considers both system provided and user installed configuration files. 122 * 123 * The device identifier is used to construct several default configuration file 124 * names to try based on the device name, vendor, product, and version. 125 * 126 * Returns an empty string if not found. 127 */ 128extern String8 getInputDeviceConfigurationFilePathByDeviceIdentifier( 129 const InputDeviceIdentifier& deviceIdentifier, 130 InputDeviceConfigurationFileType type); 131 132/* 133 * Gets the path of an input device configuration file, if one is available. 134 * Considers both system provided and user installed configuration files. 135 * 136 * The name is case-sensitive and is used to construct the filename to resolve. 137 * All characters except 'a'-'z', 'A'-'Z', '0'-'9', '-', and '_' are replaced by underscores. 138 * 139 * Returns an empty string if not found. 140 */ 141extern String8 getInputDeviceConfigurationFilePathByName( 142 const String8& name, InputDeviceConfigurationFileType type); 143 144} // namespace android 145 146#endif // _ANDROIDFW_INPUT_DEVICE_H 147