// Copyright 2014 The Flutter Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. import 'package:path/path.dart' as path; import 'base_code_gen.dart'; import 'key_data.dart'; import 'utils.dart'; /// Generates the keyboard_maps.dart files, based on the information in the key /// data structure given to it. class KeyboardMapsCodeGenerator extends BaseCodeGenerator { KeyboardMapsCodeGenerator(KeyData keyData) : super(keyData); List<Key> get numpadKeyData { return keyData.data.where((Key entry) { return entry.constantName.startsWith('numpad') && entry.keyLabel != null; }).toList(); } List<Key> get functionKeyData { final RegExp functionKeyRe = RegExp(r'^f[0-9]+$'); return keyData.data.where((Key entry) { return functionKeyRe.hasMatch(entry.constantName); }).toList(); } /// This generates the map of GLFW number pad key codes to logical keys. String get glfwNumpadMap { final StringBuffer glfwNumpadMap = StringBuffer(); for (final Key entry in numpadKeyData) { if (entry.glfwKeyCodes != null) { for (final int code in entry.glfwKeyCodes.cast<int>()) { glfwNumpadMap.writeln(' $code: LogicalKeyboardKey.${entry.constantName},'); } } } return glfwNumpadMap.toString().trimRight(); } /// This generates the map of GLFW key codes to logical keys. String get glfwKeyCodeMap { final StringBuffer glfwKeyCodeMap = StringBuffer(); for (final Key entry in keyData.data) { if (entry.glfwKeyCodes != null) { for (final int code in entry.glfwKeyCodes.cast<int>()) { glfwKeyCodeMap.writeln(' $code: LogicalKeyboardKey.${entry.constantName},'); } } } return glfwKeyCodeMap.toString().trimRight(); } /// This generates the map of GTK number pad key codes to logical keys. String get gtkNumpadMap { final StringBuffer gtkNumpadMap = StringBuffer(); for (final Key entry in numpadKeyData) { if (entry.gtkKeyCodes != null) { for (final int code in entry.gtkKeyCodes.cast<int>()) { gtkNumpadMap.writeln(' $code: LogicalKeyboardKey.${entry.constantName},'); } } } return gtkNumpadMap.toString().trimRight(); } /// This generates the map of GTK key codes to logical keys. String get gtkKeyCodeMap { final StringBuffer gtkKeyCodeMap = StringBuffer(); for (final Key entry in keyData.data) { if (entry.gtkKeyCodes != null) { for (final int code in entry.gtkKeyCodes.cast<int>()) { gtkKeyCodeMap.writeln(' $code: LogicalKeyboardKey.${entry.constantName},'); } } } return gtkKeyCodeMap.toString().trimRight(); } /// This generates the map of XKB USB HID codes to physical keys. String get xkbScanCodeMap { final StringBuffer xkbScanCodeMap = StringBuffer(); for (final Key entry in keyData.data) { if (entry.xKbScanCode != null) { xkbScanCodeMap.writeln(' ${toHex(entry.xKbScanCode)}: PhysicalKeyboardKey.${entry.constantName},'); } } return xkbScanCodeMap.toString().trimRight(); } /// This generates the map of Android key codes to logical keys. String get androidKeyCodeMap { final StringBuffer androidKeyCodeMap = StringBuffer(); for (final Key entry in keyData.data) { if (entry.androidKeyCodes != null) { for (final int code in entry.androidKeyCodes.cast<int>()) { androidKeyCodeMap.writeln(' $code: LogicalKeyboardKey.${entry.constantName},'); } } } return androidKeyCodeMap.toString().trimRight(); } /// This generates the map of Android number pad key codes to logical keys. String get androidNumpadMap { final StringBuffer androidKeyCodeMap = StringBuffer(); for (final Key entry in numpadKeyData) { if (entry.androidKeyCodes != null) { for (final int code in entry.androidKeyCodes.cast<int>()) { androidKeyCodeMap.writeln(' $code: LogicalKeyboardKey.${entry.constantName},'); } } } return androidKeyCodeMap.toString().trimRight(); } /// This generates the map of Android scan codes to physical keys. String get androidScanCodeMap { final StringBuffer androidScanCodeMap = StringBuffer(); for (final Key entry in keyData.data) { if (entry.androidScanCodes != null) { for (final int code in entry.androidScanCodes.cast<int>()) { androidScanCodeMap.writeln(' $code: PhysicalKeyboardKey.${entry.constantName},'); } } } return androidScanCodeMap.toString().trimRight(); } /// This generates the map of Windows scan codes to physical keys. String get windowsScanCodeMap { final StringBuffer windowsScanCodeMap = StringBuffer(); for (final Key entry in keyData.data) { if (entry.windowsScanCode != null) { windowsScanCodeMap.writeln(' ${toHex(entry.windowsScanCode)}: PhysicalKeyboardKey.${entry.constantName},'); } } return windowsScanCodeMap.toString().trimRight(); } /// This generates the map of Windows number pad key codes to logical keys. String get windowsNumpadMap { final StringBuffer windowsNumPadMap = StringBuffer(); for (final Key entry in numpadKeyData) { if (entry.windowsKeyCodes != null){ for (final int code in entry.windowsKeyCodes) { windowsNumPadMap.writeln(' $code: LogicalKeyboardKey.${entry.constantName},'); } } } return windowsNumPadMap.toString().trimRight(); } /// This generates the map of Windows key codes to logical keys. String get windowsKeyCodeMap { final StringBuffer windowsKeyCodeMap = StringBuffer(); for (final Key entry in keyData.data) { if (entry.windowsKeyCodes != null) { for (final int code in entry.windowsKeyCodes) { windowsKeyCodeMap.writeln(' $code: LogicalKeyboardKey.${entry.constantName},'); } } } return windowsKeyCodeMap.toString().trimRight(); } /// This generates the map of macOS key codes to physical keys. String get macOsScanCodeMap { final StringBuffer macOsScanCodeMap = StringBuffer(); for (final Key entry in keyData.data) { if (entry.macOsScanCode != null) { macOsScanCodeMap.writeln(' ${toHex(entry.macOsScanCode)}: PhysicalKeyboardKey.${entry.constantName},'); } } return macOsScanCodeMap.toString().trimRight(); } /// This generates the map of macOS number pad key codes to logical keys. String get macOsNumpadMap { final StringBuffer macOsNumPadMap = StringBuffer(); for (final Key entry in numpadKeyData) { if (entry.macOsScanCode != null) { macOsNumPadMap.writeln(' ${toHex(entry.macOsScanCode)}: LogicalKeyboardKey.${entry.constantName},'); } } return macOsNumPadMap.toString().trimRight(); } String get macOsFunctionKeyMap { final StringBuffer macOsFunctionKeyMap = StringBuffer(); for (final Key entry in functionKeyData) { if (entry.macOsScanCode != null) { macOsFunctionKeyMap.writeln(' ${toHex(entry.macOsScanCode)}: LogicalKeyboardKey.${entry.constantName},'); } } return macOsFunctionKeyMap.toString().trimRight(); } /// This generates the map of Fuchsia key codes to logical keys. String get fuchsiaKeyCodeMap { final StringBuffer fuchsiaKeyCodeMap = StringBuffer(); for (final Key entry in keyData.data) { if (entry.usbHidCode != null) { fuchsiaKeyCodeMap.writeln(' ${toHex(entry.flutterId)}: LogicalKeyboardKey.${entry.constantName},'); } } return fuchsiaKeyCodeMap.toString().trimRight(); } /// This generates the map of Fuchsia USB HID codes to physical keys. String get fuchsiaHidCodeMap { final StringBuffer fuchsiaScanCodeMap = StringBuffer(); for (final Key entry in keyData.data) { if (entry.usbHidCode != null) { fuchsiaScanCodeMap.writeln(' ${toHex(entry.usbHidCode)}: PhysicalKeyboardKey.${entry.constantName},'); } } return fuchsiaScanCodeMap.toString().trimRight(); } /// This generates the map of Web KeyboardEvent codes to logical keys. String get webLogicalKeyMap { final StringBuffer result = StringBuffer(); for (final Key entry in keyData.data) { if (entry.name != null) { result.writeln(" '${entry.name}': LogicalKeyboardKey.${entry.constantName},"); } } return result.toString().trimRight(); } /// This generates the map of Web KeyboardEvent codes to physical keys. String get webPhysicalKeyMap { final StringBuffer result = StringBuffer(); for (final Key entry in keyData.data) { if (entry.name != null) { result.writeln(" '${entry.name}': PhysicalKeyboardKey.${entry.constantName},"); } } return result.toString().trimRight(); } /// This generates the map of Web number pad codes to logical keys. String get webNumpadMap { final StringBuffer result = StringBuffer(); for (final Key entry in numpadKeyData) { if (entry.name != null) { result.writeln(" '${entry.name}': LogicalKeyboardKey.${entry.constantName},"); } } return result.toString().trimRight(); } @override String get templatePath => path.join(flutterRoot.path, 'dev', 'tools', 'gen_keycodes', 'data', 'keyboard_maps.tmpl'); @override Map<String, String> mappings() { return <String, String>{ 'ANDROID_SCAN_CODE_MAP': androidScanCodeMap, 'ANDROID_KEY_CODE_MAP': androidKeyCodeMap, 'ANDROID_NUMPAD_MAP': androidNumpadMap, 'FUCHSIA_SCAN_CODE_MAP': fuchsiaHidCodeMap, 'FUCHSIA_KEY_CODE_MAP': fuchsiaKeyCodeMap, 'MACOS_SCAN_CODE_MAP': macOsScanCodeMap, 'MACOS_NUMPAD_MAP': macOsNumpadMap, 'MACOS_FUNCTION_KEY_MAP': macOsFunctionKeyMap, 'GLFW_KEY_CODE_MAP': glfwKeyCodeMap, 'GLFW_NUMPAD_MAP': glfwNumpadMap, 'GTK_KEY_CODE_MAP': gtkKeyCodeMap, 'GTK_NUMPAD_MAP': gtkNumpadMap, 'XKB_SCAN_CODE_MAP': xkbScanCodeMap, 'WEB_LOGICAL_KEY_MAP': webLogicalKeyMap, 'WEB_PHYSICAL_KEY_MAP': webPhysicalKeyMap, 'WEB_NUMPAD_MAP': webNumpadMap, 'WINDOWS_LOGICAL_KEY_MAP': windowsKeyCodeMap, 'WINDOWS_PHYSICAL_KEY_MAP': windowsScanCodeMap, 'WINDOWS_NUMPAD_MAP': windowsNumpadMap, }; } }