flutter/dev/tools/gen_keycodes/lib/web_code_gen.dart
Michael Goderbauer 5491c8c146
Auto-format Framework (#160545)
This auto-formats all *.dart files in the repository outside of the
`engine` subdirectory and enforces that these files stay formatted with
a presubmit check.

**Reviewers:** Please carefully review all the commits except for the
one titled "formatted". The "formatted" commit was auto-generated by
running `dev/tools/format.sh -a -f`. The other commits were hand-crafted
to prepare the repo for the formatting change. I recommend reviewing the
commits one-by-one via the "Commits" tab and avoiding Github's "Files
changed" tab as it will likely slow down your browser because of the
size of this PR.

---------

Co-authored-by: Kate Lovett <katelovett@google.com>
Co-authored-by: LongCatIsLooong <31859944+LongCatIsLooong@users.noreply.github.com>
2024-12-19 20:06:21 +00:00

88 lines
3.0 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';
/// Generates the key mapping for Web, based on the information in the key
/// data structure given to it.
class WebCodeGenerator extends PlatformCodeGenerator {
WebCodeGenerator(super.keyData, super.logicalData, String logicalLocationMap)
: _logicalLocationMap = parseMapOfListOfNullableString(logicalLocationMap);
/// This generates the map of Web KeyboardEvent codes to logical key ids.
String get _webLogicalKeyCodeMap {
final OutputLines<String> lines = OutputLines<String>('Web logical map');
for (final LogicalKeyEntry entry in logicalData.entries) {
final int plane = getPlane(entry.value);
if (plane == kUnprintablePlane.value) {
for (final String name in entry.webNames) {
lines.add(name, " '$name': ${toHex(entry.value, digits: 11)},");
}
}
}
return lines.sortedJoin().trimRight();
}
/// This generates the map of Web KeyboardEvent codes to physical key USB HID codes.
String get _webPhysicalKeyCodeMap {
final OutputLines<String> lines = OutputLines<String>('Web physical map');
for (final PhysicalKeyEntry entry in keyData.entries) {
for (final String webCode in entry.webCodes()) {
lines.add(webCode, " '$webCode': ${toHex(entry.usbHidCode)}, // ${entry.constantName}");
}
}
return lines.sortedJoin().trimRight();
}
/// This generates the map of Web number pad codes to logical key ids.
String get _webLogicalLocationMap {
final OutputLines<String> lines = OutputLines<String>('Web logical location map');
_logicalLocationMap.forEach((String webKey, List<String?> locations) {
final String valuesString = locations
.map((String? value) {
return value == null ? 'null' : toHex(logicalData.entryByName(value).value, digits: 11);
})
.join(', ');
final String namesString = locations
.map((String? value) {
return value == null ? 'null' : logicalData.entryByName(value).constantName;
})
.join(', ');
lines.add(webKey, " '$webKey': <int?>[$valuesString], // $namesString");
});
return lines.sortedJoin().trimRight();
}
final Map<String, List<String?>> _logicalLocationMap;
@override
String get templatePath => path.join(dataRoot, 'web_key_map_dart.tmpl');
@override
String outputPath(String platform) => path.join(
PlatformCodeGenerator.engineRoot,
'lib',
'web_ui',
'lib',
'src',
'engine',
'key_map.g.dart',
);
@override
Map<String, String> mappings() {
return <String, String>{
'WEB_LOGICAL_KEY_CODE_MAP': _webLogicalKeyCodeMap,
'WEB_PHYSICAL_KEY_CODE_MAP': _webPhysicalKeyCodeMap,
'WEB_LOGICAL_LOCATION_MAP': _webLogicalLocationMap,
};
}
}