| /* |
| * Copyright (C) 2010 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| #define LOG_TAG "Keyboard" |
| |
| #include <stdlib.h> |
| #include <unistd.h> |
| #include <limits.h> |
| |
| #include <input/Keyboard.h> |
| #include <input/InputEventLabels.h> |
| #include <input/KeyLayoutMap.h> |
| #include <input/KeyCharacterMap.h> |
| #include <input/InputDevice.h> |
| #include <utils/Errors.h> |
| #include <utils/Log.h> |
| |
| namespace android { |
| |
| // --- KeyMap --- |
| |
| KeyMap::KeyMap() { |
| } |
| |
| KeyMap::~KeyMap() { |
| } |
| |
| status_t KeyMap::load(const InputDeviceIdentifier& deviceIdentifier, |
| const PropertyMap* deviceConfiguration) { |
| // Use the configured key layout if available. |
| if (deviceConfiguration) { |
| String8 keyLayoutName; |
| if (deviceConfiguration->tryGetProperty(String8("keyboard.layout"), |
| keyLayoutName)) { |
| status_t status = loadKeyLayout(deviceIdentifier, keyLayoutName.c_str()); |
| if (status == NAME_NOT_FOUND) { |
| ALOGE("Configuration for keyboard device '%s' requested keyboard layout '%s' but " |
| "it was not found.", |
| deviceIdentifier.name.c_str(), keyLayoutName.string()); |
| } |
| } |
| |
| String8 keyCharacterMapName; |
| if (deviceConfiguration->tryGetProperty(String8("keyboard.characterMap"), |
| keyCharacterMapName)) { |
| status_t status = loadKeyCharacterMap(deviceIdentifier, keyCharacterMapName.c_str()); |
| if (status == NAME_NOT_FOUND) { |
| ALOGE("Configuration for keyboard device '%s' requested keyboard character " |
| "map '%s' but it was not found.", |
| deviceIdentifier.name.c_str(), keyCharacterMapName.string()); |
| } |
| } |
| |
| if (isComplete()) { |
| return OK; |
| } |
| } |
| |
| // Try searching by device identifier. |
| if (probeKeyMap(deviceIdentifier, "")) { |
| return OK; |
| } |
| |
| // Fall back on the Generic key map. |
| // TODO Apply some additional heuristics here to figure out what kind of |
| // generic key map to use (US English, etc.) for typical external keyboards. |
| if (probeKeyMap(deviceIdentifier, "Generic")) { |
| return OK; |
| } |
| |
| // Try the Virtual key map as a last resort. |
| if (probeKeyMap(deviceIdentifier, "Virtual")) { |
| return OK; |
| } |
| |
| // Give up! |
| ALOGE("Could not determine key map for device '%s' and no default key maps were found!", |
| deviceIdentifier.name.c_str()); |
| return NAME_NOT_FOUND; |
| } |
| |
| bool KeyMap::probeKeyMap(const InputDeviceIdentifier& deviceIdentifier, |
| const std::string& keyMapName) { |
| if (!haveKeyLayout()) { |
| loadKeyLayout(deviceIdentifier, keyMapName); |
| } |
| if (!haveKeyCharacterMap()) { |
| loadKeyCharacterMap(deviceIdentifier, keyMapName); |
| } |
| return isComplete(); |
| } |
| |
| status_t KeyMap::loadKeyLayout(const InputDeviceIdentifier& deviceIdentifier, |
| const std::string& name) { |
| std::string path(getPath(deviceIdentifier, name, |
| INPUT_DEVICE_CONFIGURATION_FILE_TYPE_KEY_LAYOUT)); |
| if (path.empty()) { |
| return NAME_NOT_FOUND; |
| } |
| |
| status_t status = KeyLayoutMap::load(path, &keyLayoutMap); |
| if (status) { |
| return status; |
| } |
| |
| keyLayoutFile = path; |
| return OK; |
| } |
| |
| status_t KeyMap::loadKeyCharacterMap(const InputDeviceIdentifier& deviceIdentifier, |
| const std::string& name) { |
| std::string path = getPath(deviceIdentifier, name, |
| INPUT_DEVICE_CONFIGURATION_FILE_TYPE_KEY_CHARACTER_MAP); |
| if (path.empty()) { |
| return NAME_NOT_FOUND; |
| } |
| |
| status_t status = KeyCharacterMap::load(path, |
| KeyCharacterMap::FORMAT_BASE, &keyCharacterMap); |
| if (status) { |
| return status; |
| } |
| |
| keyCharacterMapFile = path; |
| return OK; |
| } |
| |
| std::string KeyMap::getPath(const InputDeviceIdentifier& deviceIdentifier, |
| const std::string& name, InputDeviceConfigurationFileType type) { |
| return name.empty() |
| ? getInputDeviceConfigurationFilePathByDeviceIdentifier(deviceIdentifier, type) |
| : getInputDeviceConfigurationFilePathByName(name, type); |
| } |
| |
| |
| // --- Global functions --- |
| |
| bool isKeyboardSpecialFunction(const PropertyMap* config) { |
| if (config == nullptr) { |
| return false; |
| } |
| bool isSpecialFunction = false; |
| config->tryGetProperty(String8("keyboard.specialFunction"), isSpecialFunction); |
| return isSpecialFunction; |
| } |
| |
| bool isEligibleBuiltInKeyboard(const InputDeviceIdentifier& deviceIdentifier, |
| const PropertyMap* deviceConfiguration, const KeyMap* keyMap) { |
| // TODO: remove the third OR statement (SPECIAL_FUNCTION) in Q |
| if (!keyMap->haveKeyCharacterMap() || isKeyboardSpecialFunction(deviceConfiguration) |
| || keyMap->keyCharacterMap->getKeyboardType() |
| == KeyCharacterMap::KEYBOARD_TYPE_SPECIAL_FUNCTION) { |
| return false; |
| } |
| |
| if (deviceConfiguration) { |
| bool builtIn = false; |
| if (deviceConfiguration->tryGetProperty(String8("keyboard.builtIn"), builtIn) |
| && builtIn) { |
| return true; |
| } |
| } |
| |
| return strstr(deviceIdentifier.name.c_str(), "-keypad"); |
| } |
| |
| static int32_t setEphemeralMetaState(int32_t mask, bool down, int32_t oldMetaState) { |
| int32_t newMetaState; |
| if (down) { |
| newMetaState = oldMetaState | mask; |
| } else { |
| newMetaState = oldMetaState & |
| ~(mask | AMETA_ALT_ON | AMETA_SHIFT_ON | AMETA_CTRL_ON | AMETA_META_ON); |
| } |
| |
| return normalizeMetaState(newMetaState); |
| } |
| |
| int32_t normalizeMetaState(int32_t oldMetaState) { |
| int32_t newMetaState = oldMetaState; |
| if (newMetaState & (AMETA_ALT_LEFT_ON | AMETA_ALT_RIGHT_ON)) { |
| newMetaState |= AMETA_ALT_ON; |
| } |
| |
| if (newMetaState & (AMETA_SHIFT_LEFT_ON | AMETA_SHIFT_RIGHT_ON)) { |
| newMetaState |= AMETA_SHIFT_ON; |
| } |
| |
| if (newMetaState & (AMETA_CTRL_LEFT_ON | AMETA_CTRL_RIGHT_ON)) { |
| newMetaState |= AMETA_CTRL_ON; |
| } |
| |
| if (newMetaState & (AMETA_META_LEFT_ON | AMETA_META_RIGHT_ON)) { |
| newMetaState |= AMETA_META_ON; |
| } |
| return newMetaState; |
| } |
| |
| static int32_t toggleLockedMetaState(int32_t mask, bool down, int32_t oldMetaState) { |
| if (down) { |
| return oldMetaState; |
| } else { |
| return oldMetaState ^ mask; |
| } |
| } |
| |
| int32_t updateMetaState(int32_t keyCode, bool down, int32_t oldMetaState) { |
| switch (keyCode) { |
| case AKEYCODE_ALT_LEFT: |
| return setEphemeralMetaState(AMETA_ALT_LEFT_ON, down, oldMetaState); |
| case AKEYCODE_ALT_RIGHT: |
| return setEphemeralMetaState(AMETA_ALT_RIGHT_ON, down, oldMetaState); |
| case AKEYCODE_SHIFT_LEFT: |
| return setEphemeralMetaState(AMETA_SHIFT_LEFT_ON, down, oldMetaState); |
| case AKEYCODE_SHIFT_RIGHT: |
| return setEphemeralMetaState(AMETA_SHIFT_RIGHT_ON, down, oldMetaState); |
| case AKEYCODE_SYM: |
| return setEphemeralMetaState(AMETA_SYM_ON, down, oldMetaState); |
| case AKEYCODE_FUNCTION: |
| return setEphemeralMetaState(AMETA_FUNCTION_ON, down, oldMetaState); |
| case AKEYCODE_CTRL_LEFT: |
| return setEphemeralMetaState(AMETA_CTRL_LEFT_ON, down, oldMetaState); |
| case AKEYCODE_CTRL_RIGHT: |
| return setEphemeralMetaState(AMETA_CTRL_RIGHT_ON, down, oldMetaState); |
| case AKEYCODE_META_LEFT: |
| return setEphemeralMetaState(AMETA_META_LEFT_ON, down, oldMetaState); |
| case AKEYCODE_META_RIGHT: |
| return setEphemeralMetaState(AMETA_META_RIGHT_ON, down, oldMetaState); |
| case AKEYCODE_CAPS_LOCK: |
| return toggleLockedMetaState(AMETA_CAPS_LOCK_ON, down, oldMetaState); |
| case AKEYCODE_NUM_LOCK: |
| return toggleLockedMetaState(AMETA_NUM_LOCK_ON, down, oldMetaState); |
| case AKEYCODE_SCROLL_LOCK: |
| return toggleLockedMetaState(AMETA_SCROLL_LOCK_ON, down, oldMetaState); |
| default: |
| return oldMetaState; |
| } |
| } |
| |
| bool isMetaKey(int32_t keyCode) { |
| switch (keyCode) { |
| case AKEYCODE_ALT_LEFT: |
| case AKEYCODE_ALT_RIGHT: |
| case AKEYCODE_SHIFT_LEFT: |
| case AKEYCODE_SHIFT_RIGHT: |
| case AKEYCODE_SYM: |
| case AKEYCODE_FUNCTION: |
| case AKEYCODE_CTRL_LEFT: |
| case AKEYCODE_CTRL_RIGHT: |
| case AKEYCODE_META_LEFT: |
| case AKEYCODE_META_RIGHT: |
| case AKEYCODE_CAPS_LOCK: |
| case AKEYCODE_NUM_LOCK: |
| case AKEYCODE_SCROLL_LOCK: |
| return true; |
| default: |
| return false; |
| } |
| } |
| |
| |
| } // namespace android |