Skip to content

F
Front-End
Unverified Commit cc9b78fc authored by Ferhat's avatar Ferhat Committed by GitHub
Browse files
Options

[web] Treeshake keymaps for web (4% code size reduction in hello world) (#75945)

parent 3e77f5e4
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 309 additions and 161 deletions
packages/flutter/lib/src/services/raw_keyboard.dart
View file @ cc9b78fc
...@@ -267,92 +267,106 @@ abstract class RawKeyEvent with Diagnosticable { ...@@ -267,92 +267,106 @@ abstract class RawKeyEvent with Diagnosticable {
String? character; String? character;
final String keymap = message['keymap'] as String; final String keymap = message['keymap'] as String;
switch (keymap) { if (kIsWeb) {
case 'android': final String? key = message['key'] as String?;
data = RawKeyEventDataAndroid( data = RawKeyEventDataWeb(
flags: message['flags'] as int? ?? 0, code: message['code'] as String? ?? '',
codePoint: message['codePoint'] as int? ?? 0, key: key ?? '',
keyCode: message['keyCode'] as int? ?? 0, metaState: message['metaState'] as int? ?? 0,
plainCodePoint: message['plainCodePoint'] as int? ?? 0, );
scanCode: message['scanCode'] as int? ?? 0, if (key != null && key.isNotEmpty) {
metaState: message['metaState'] as int? ?? 0, character = key;
eventSource: message['source'] as int? ?? 0, }
vendorId: message['vendorId'] as int? ?? 0, } else {
productId: message['productId'] as int? ?? 0, switch (keymap) {
deviceId: message['deviceId'] as int? ?? 0, case 'android':
repeatCount: message['repeatCount'] as int? ?? 0, data = RawKeyEventDataAndroid(
); flags: message['flags'] as int? ?? 0,
if (message.containsKey('character')) { codePoint: message['codePoint'] as int? ?? 0,
character = message['character'] as String?;
}
break;
case 'fuchsia':
final int codePoint = message['codePoint'] as int? ?? 0;
data = RawKeyEventDataFuchsia(
hidUsage: message['hidUsage'] as int? ?? 0,
codePoint: codePoint,
modifiers: message['modifiers'] as int? ?? 0,
);
if (codePoint != 0) {
character = String.fromCharCode(codePoint);
}
break;
case 'macos':
data = RawKeyEventDataMacOs(
characters: message['characters'] as String? ?? '',
charactersIgnoringModifiers: message['charactersIgnoringModifiers'] as String? ?? '',
keyCode: message['keyCode'] as int? ?? 0,
modifiers: message['modifiers'] as int? ?? 0);
character = message['characters'] as String?;
break;
case 'ios':
data = RawKeyEventDataIos(
characters: message['characters'] as String? ?? '',
charactersIgnoringModifiers: message['charactersIgnoringModifiers'] as String? ?? '',
keyCode: message['keyCode'] as int? ?? 0, keyCode: message['keyCode'] as int? ?? 0,
modifiers: message['modifiers'] as int? ?? 0); plainCodePoint: message['plainCodePoint'] as int? ?? 0,
break; scanCode: message['scanCode'] as int? ?? 0,
case 'linux': metaState: message['metaState'] as int? ?? 0,
final int unicodeScalarValues = message['unicodeScalarValues'] as int? ?? 0; eventSource: message['source'] as int? ?? 0,
data = RawKeyEventDataLinux( vendorId: message['vendorId'] as int? ?? 0,
keyHelper: KeyHelper(message['toolkit'] as String? ?? ''), productId: message['productId'] as int? ?? 0,
unicodeScalarValues: unicodeScalarValues, deviceId: message['deviceId'] as int? ?? 0,
repeatCount: message['repeatCount'] as int? ?? 0,
);
if (message.containsKey('character')) {
character = message['character'] as String?;
}
break;
case 'fuchsia':
final int codePoint = message['codePoint'] as int? ?? 0;
data = RawKeyEventDataFuchsia(
hidUsage: message['hidUsage'] as int? ?? 0,
codePoint: codePoint,
modifiers: message['modifiers'] as int? ?? 0,
);
if (codePoint != 0) {
character = String.fromCharCode(codePoint);
}
break;
case 'macos':
data = RawKeyEventDataMacOs(
characters: message['characters'] as String? ?? '',
charactersIgnoringModifiers: message['charactersIgnoringModifiers'] as String? ?? '',
keyCode: message['keyCode'] as int? ?? 0,
modifiers: message['modifiers'] as int? ?? 0);
character = message['characters'] as String?;
break;
case 'ios':
data = RawKeyEventDataIos(
characters: message['characters'] as String? ?? '',
charactersIgnoringModifiers: message['charactersIgnoringModifiers'] as String? ?? '',
keyCode: message['keyCode'] as int? ?? 0,
modifiers: message['modifiers'] as int? ?? 0);
break;
case 'linux':
final int unicodeScalarValues = message['unicodeScalarValues'] as int? ?? 0;
data = RawKeyEventDataLinux(
keyHelper: KeyHelper(message['toolkit'] as String? ?? ''),
unicodeScalarValues: unicodeScalarValues,
keyCode: message['keyCode'] as int? ?? 0,
scanCode: message['scanCode'] as int? ?? 0,
modifiers: message['modifiers'] as int? ?? 0,
isDown: message['type'] == 'keydown');
if (unicodeScalarValues != 0) {
character = String.fromCharCode(unicodeScalarValues);
}
break;
case 'windows':
final int characterCodePoint = message['characterCodePoint'] as int? ?? 0;
data = RawKeyEventDataWindows(
keyCode: message['keyCode'] as int? ?? 0, keyCode: message['keyCode'] as int? ?? 0,
scanCode: message['scanCode'] as int? ?? 0, scanCode: message['scanCode'] as int? ?? 0,
characterCodePoint: characterCodePoint,
modifiers: message['modifiers'] as int? ?? 0, modifiers: message['modifiers'] as int? ?? 0,
isDown: message['type'] == 'keydown'); );
if (unicodeScalarValues != 0) { if (characterCodePoint != 0) {
character = String.fromCharCode(unicodeScalarValues); character = String.fromCharCode(characterCodePoint);
} }
break; break;
case 'web': case 'web':
data = RawKeyEventDataWeb( final String? key = message['key'] as String?;
code: message['code'] as String? ?? '', data = RawKeyEventDataWeb(
key: message['key'] as String? ?? '', code: message['code'] as String? ?? '',
metaState: message['metaState'] as int? ?? 0, key: key ?? '',
); metaState: message['metaState'] as int? ?? 0,
character = message['key'] as String?; );
break; if (key != null && key.isNotEmpty) {
case 'windows': character = key;
final int characterCodePoint = message['characterCodePoint'] as int? ?? 0; }
data = RawKeyEventDataWindows( break;
keyCode: message['keyCode'] as int? ?? 0, default:
scanCode: message['scanCode'] as int? ?? 0, /// This exception would only be hit on platforms that haven't yet
characterCodePoint: characterCodePoint, /// implemented raw key events, but will only be triggered if the
modifiers: message['modifiers'] as int? ?? 0, /// engine for those platforms sends raw key event messages in the
); /// first place.
if (characterCodePoint != 0) { throw FlutterError('Unknown keymap for key events: $keymap');
character = String.fromCharCode(characterCodePoint); }
}
break;
default:
/// This exception would only be hit on platforms that haven't yet
/// implemented raw key events, but will only be triggered if the
/// engine for those platforms sends raw key event messages in the
/// first place.
throw FlutterError('Unknown keymap for key events: $keymap');
} }
final String type = message['type'] as String; final String type = message['type'] as String;
switch (type) { switch (type) {
case 'keydown': case 'keydown':
......
packages/flutter/test/widgets/raw_keyboard_listener_test.dart
View file @ cc9b78fc
...@@ -42,6 +42,37 @@ void main() { ...@@ -42,6 +42,37 @@ void main() {
expect(typedData.modifiers, RawKeyEventDataFuchsia.modifierLeftMeta); expect(typedData.modifiers, RawKeyEventDataFuchsia.modifierLeftMeta);
expect(typedData.isModifierPressed(ModifierKey.metaModifier, side: KeyboardSide.left), isTrue); expect(typedData.isModifierPressed(ModifierKey.metaModifier, side: KeyboardSide.left), isTrue);
await tester.pumpWidget(Container());
focusNode.dispose();
}, skip: isBrowser); // This is a Fuchsia-specific test.
testWidgets('Web key event', (WidgetTester tester) async {
final List<RawKeyEvent> events = <RawKeyEvent>[];
final FocusNode focusNode = FocusNode();
await tester.pumpWidget(
RawKeyboardListener(
focusNode: focusNode,
onKey: events.add,
child: Container(),
),
);
focusNode.requestFocus();
await tester.idle();
await tester.sendKeyEvent(LogicalKeyboardKey.metaLeft, platform: 'web');
await tester.idle();
expect(events.length, 2);
expect(events[0].runtimeType, equals(RawKeyDownEvent));
expect(events[0].data, isA<RawKeyEventDataWeb>());
final RawKeyEventDataWeb typedData = events[0].data as RawKeyEventDataWeb;
expect(typedData.code, 'MetaLeft');
expect(typedData.metaState, RawKeyEventDataWeb.modifierMeta);
expect(typedData.isModifierPressed(ModifierKey.metaModifier, side: KeyboardSide.left), isTrue);
await tester.pumpWidget(Container()); await tester.pumpWidget(Container());
focusNode.dispose(); focusNode.dispose();
}); });
......
packages/flutter_test/lib/src/event_simulation.dart
View file @ cc9b78fc
...@@ -4,6 +4,7 @@ ...@@ -4,6 +4,7 @@
import 'dart:io'; import 'dart:io';
import 'package:flutter/foundation.dart' show kIsWeb;
import 'package:flutter/services.dart'; import 'package:flutter/services.dart';
import 'test_async_utils.dart'; import 'test_async_utils.dart';
...@@ -85,40 +86,47 @@ class KeyEventSimulator { ...@@ -85,40 +86,47 @@ class KeyEventSimulator {
static int _getKeyCode(LogicalKeyboardKey key, String platform) { static int _getKeyCode(LogicalKeyboardKey key, String platform) {
assert(_osIsSupported(platform), 'Platform $platform not supported for key simulation'); assert(_osIsSupported(platform), 'Platform $platform not supported for key simulation');
late Map<int, LogicalKeyboardKey> map; if (kIsWeb) {
switch (platform) { // web doesn't have int type code. This check is used to treeshake
case 'android': // keyboard map code.
map = kAndroidToLogicalKey; return -1;
break; } else {
case 'fuchsia': late Map<int, LogicalKeyboardKey> map;
map = kFuchsiaToLogicalKey; switch (platform) {
break; case 'android':
case 'macos': map = kAndroidToLogicalKey;
// macOS doesn't do key codes, just scan codes. break;
return -1; case 'fuchsia':
case 'ios': map = kFuchsiaToLogicalKey;
// iOS doesn't do key codes, just scan codes. break;
return -1; case 'macos':
case 'web': // macOS doesn't do key codes, just scan codes.
// web doesn't have int type code return -1;
return -1; case 'ios':
case 'linux': // iOS doesn't do key codes, just scan codes.
map = kGlfwToLogicalKey; return -1;
break; case 'web':
case 'windows': // web doesn't have int type code.
map = kWindowsToLogicalKey; return -1;
break; case 'linux':
} map = kGlfwToLogicalKey;
int? keyCode; break;
for (final int code in map.keys) { case 'windows':
if (key.keyId == map[code]!.keyId) { map = kWindowsToLogicalKey;
keyCode = code; break;
break; }
int? keyCode;
for (final int code in map.keys) {
if (key.keyId == map[code]!.keyId) {
keyCode = code;
break;
}
} }
assert(keyCode != null, 'Key $key not found in $platform keyCode map');
return keyCode!;
} }
assert(keyCode != null, 'Key $key not found in $platform keyCode map');
return keyCode!;
} }
static String _getWebKeyCode(LogicalKeyboardKey key) { static String _getWebKeyCode(LogicalKeyboardKey key) {
String? result; String? result;
for (final String code in kWebToLogicalKey.keys) { for (final String code in kWebToLogicalKey.keys) {
...@@ -134,28 +142,33 @@ class KeyEventSimulator { ...@@ -134,28 +142,33 @@ class KeyEventSimulator {
static PhysicalKeyboardKey _findPhysicalKey(LogicalKeyboardKey key, String platform) { static PhysicalKeyboardKey _findPhysicalKey(LogicalKeyboardKey key, String platform) {
assert(_osIsSupported(platform), 'Platform $platform not supported for key simulation'); assert(_osIsSupported(platform), 'Platform $platform not supported for key simulation');
late Map<dynamic, PhysicalKeyboardKey> map; late Map<dynamic, PhysicalKeyboardKey> map;
switch (platform) { if (kIsWeb) {
case 'android': // This check is used to treeshake keymap code.
map = kAndroidToPhysicalKey; map = kWebToPhysicalKey;
break; } else {
case 'fuchsia': switch (platform) {
map = kFuchsiaToPhysicalKey; case 'android':
break; map = kAndroidToPhysicalKey;
case 'macos': break;
map = kMacOsToPhysicalKey; case 'fuchsia':
break; map = kFuchsiaToPhysicalKey;
case 'ios': break;
map = kIosToPhysicalKey; case 'macos':
break; map = kMacOsToPhysicalKey;
case 'linux': break;
map = kLinuxToPhysicalKey; case 'ios':
break; map = kIosToPhysicalKey;
case 'web': break;
map = kWebToPhysicalKey; case 'linux':
break; map = kLinuxToPhysicalKey;
case 'windows': break;
map = kWindowsToPhysicalKey; case 'web':
break; map = kWebToPhysicalKey;
break;
case 'windows':
map = kWindowsToPhysicalKey;
break;
}
} }
PhysicalKeyboardKey? result; PhysicalKeyboardKey? result;
for (final PhysicalKeyboardKey physicalKey in map.values) { for (final PhysicalKeyboardKey physicalKey in map.values) {
...@@ -191,6 +204,13 @@ class KeyEventSimulator { ...@@ -191,6 +204,13 @@ class KeyEventSimulator {
'keymap': platform, 'keymap': platform,
}; };
if (kIsWeb) {
result['code'] = _getWebKeyCode(key);
result['key'] = key.keyLabel;
result['metaState'] = _getWebModifierFlags(key, isDown);
return result;
}
switch (platform) { switch (platform) {
case 'android': case 'android':
result['keyCode'] = keyCode; result['keyCode'] = keyCode;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

HIAST - GitLab