mirror of
https://github.com/flutter/flutter.git
synced 2025-06-03 00:51:18 +00:00

Rewrites tools/gen_keycodes, the script that generates key mappings across the framework and the engine.
126 lines
4.8 KiB
Dart
126 lines
4.8 KiB
Dart
// 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 'constants.dart';
|
|
import 'logical_key_data.dart';
|
|
import 'physical_key_data.dart';
|
|
import 'utils.dart';
|
|
|
|
const List<String> kModifiersOfInterest = <String>[
|
|
'ShiftLeft',
|
|
'ShiftRight',
|
|
'ControlLeft',
|
|
'ControlRight',
|
|
'AltLeft',
|
|
'AltRight',
|
|
'MetaLeft',
|
|
'MetaRight',
|
|
];
|
|
|
|
// The name of keys that require special attention.
|
|
const List<String> kSpecialPhysicalKeys = <String>['CapsLock'];
|
|
const List<String> kSpecialLogicalKeys = <String>['CapsLock'];
|
|
|
|
String _toConstantVariableName(String variableName) {
|
|
return 'k${variableName[0].toUpperCase()}${variableName.substring(1)}';
|
|
}
|
|
|
|
/// Generates the key mapping for macOS, based on the information in the key
|
|
/// data structure given to it.
|
|
class MacOsCodeGenerator extends PlatformCodeGenerator {
|
|
MacOsCodeGenerator(PhysicalKeyData keyData, LogicalKeyData logicalData)
|
|
: super(keyData, logicalData);
|
|
|
|
/// This generates the map of macOS key codes to physical keys.
|
|
String get _scanCodeMap {
|
|
final StringBuffer scanCodeMap = StringBuffer();
|
|
for (final PhysicalKeyEntry entry in keyData.entries) {
|
|
if (entry.macOsScanCode != null) {
|
|
scanCodeMap.writeln(' @${toHex(entry.macOsScanCode)} : @${toHex(entry.usbHidCode)}, // ${entry.constantName}');
|
|
}
|
|
}
|
|
return scanCodeMap.toString().trimRight();
|
|
}
|
|
|
|
String get _keyCodeToLogicalMap {
|
|
final StringBuffer result = StringBuffer();
|
|
for (final LogicalKeyEntry entry in logicalData.entries) {
|
|
zipStrict(entry.macOsKeyCodeValues, entry.macOsKeyCodeNames, (int macOsValue, String macOsName) {
|
|
result.writeln(' @${toHex(macOsValue)} : @${toHex(entry.value, digits: 10)}, // $macOsName');
|
|
});
|
|
}
|
|
return result.toString().trimRight();
|
|
}
|
|
|
|
/// This generates the mask values for the part of a key code that defines its plane.
|
|
String get _maskConstants {
|
|
final StringBuffer buffer = StringBuffer();
|
|
for (final MaskConstant constant in maskConstants) {
|
|
buffer.writeln('/**');
|
|
buffer.write(constant.description
|
|
.map((String line) => wrapString(line, prefix: ' * '))
|
|
.join(' *\n'));
|
|
buffer.writeln(' */');
|
|
buffer.writeln('const uint64_t ${_toConstantVariableName(constant.name)} = ${toHex(constant.value, digits: 11)};');
|
|
buffer.writeln('');
|
|
}
|
|
return buffer.toString().trimRight();
|
|
}
|
|
|
|
/// This generates a map from the key code to a modifier flag.
|
|
String get _keyToModifierFlagMap {
|
|
final StringBuffer modifierKeyMap = StringBuffer();
|
|
for (final String name in kModifiersOfInterest) {
|
|
modifierKeyMap.writeln(' @${toHex(logicalData.entryByName(name).macOsKeyCodeValues[0])} : @(kModifierFlag${lowerCamelToUpperCamel(name)}),');
|
|
}
|
|
return modifierKeyMap.toString().trimRight();
|
|
}
|
|
|
|
/// This generates a map from the modifier flag to the key code.
|
|
String get _modifierFlagToKeyMap {
|
|
final StringBuffer modifierKeyMap = StringBuffer();
|
|
for (final String name in kModifiersOfInterest) {
|
|
modifierKeyMap.writeln(' @(kModifierFlag${lowerCamelToUpperCamel(name)}) : @${toHex(logicalData.entryByName(name).macOsKeyCodeValues[0])},');
|
|
}
|
|
return modifierKeyMap.toString().trimRight();
|
|
}
|
|
|
|
/// This generates some keys that needs special attention.
|
|
String get _specialKeyConstants {
|
|
final StringBuffer specialKeyConstants = StringBuffer();
|
|
for (final String keyName in kSpecialPhysicalKeys) {
|
|
specialKeyConstants.writeln('const uint64_t k${keyName}PhysicalKey = ${toHex(keyData.entryByName(keyName).usbHidCode)};');
|
|
}
|
|
for (final String keyName in kSpecialLogicalKeys) {
|
|
specialKeyConstants.writeln('const uint64_t k${lowerCamelToUpperCamel(keyName)}LogicalKey = ${toHex(logicalData.entryByName(keyName).value)};');
|
|
}
|
|
return specialKeyConstants.toString().trimRight();
|
|
}
|
|
|
|
@override
|
|
String get templatePath => path.join(dataRoot, 'macos_key_code_map_cc.tmpl');
|
|
|
|
@override
|
|
String outputPath(String platform) => path.join(PlatformCodeGenerator.engineRoot,
|
|
'shell', 'platform', 'darwin', 'macos', 'framework', 'Source', 'KeyCodeMap.mm');
|
|
|
|
@override
|
|
Map<String, String> mappings() {
|
|
// There is no macOS keycode map since macOS uses keycode to represent a physical key.
|
|
// The LogicalKeyboardKey is generated by raw_keyboard_macos.dart from the unmodified characters
|
|
// from NSEvent.
|
|
return <String, String>{
|
|
'MACOS_SCAN_CODE_MAP': _scanCodeMap,
|
|
'MACOS_KEYCODE_LOGICAL_MAP': _keyCodeToLogicalMap,
|
|
'MASK_CONSTANTS': _maskConstants,
|
|
'KEYCODE_TO_MODIFIER_FLAG_MAP': _keyToModifierFlagMap,
|
|
'MODIFIER_FLAG_TO_KEYCODE_MAP': _modifierFlagToKeyMap,
|
|
'SPECIAL_KEY_CONSTANTS': _specialKeyConstants,
|
|
};
|
|
}
|
|
}
|