Add web changes

Author: gspencergoog

lib/ui/key.dart

@@ -17,20 +17,20 @@ enum KeyEventType {
   repeat;
 
   String get label {
-  return switch (this) {
-    down => 'down',
-    up => 'up',
-    repeat => 'repeat',
-  };
-}
+    return switch (this) {
+      down => 'Down',
+      up => 'Up',
+      repeat => 'Repeat',
+    };
+  }
 }
 
 /// The source device for the key event.
 ///
-/// Not all platforms supply an accurate source.
+/// Not all platforms supply an accurate type.
 ///
 /// Defaults to [keyboard].
-// Must match the KeyEventSource enum in ui/window/key_data.h.
+// Must match the KeyEventDeviceType enum in ui/window/key_data.h.
 enum KeyEventDeviceType {
   /// The source is a keyboard.
   keyboard,

lib/ui/window/key_data.h

@@ -27,8 +27,8 @@ enum class KeyEventType : int64_t {
 // Not all platforms supply an accurate source.
 //
 // Defaults to [keyboard].
-// Must match the KeyEventSource enum in ui/key.dart.
-enum class KeyEventSource : int64_t {
+// Must match the KeyEventDeviceType enum in ui/key.dart.
+enum class KeyEventDeviceType : int64_t {
   // The source is a keyboard.
   kKeyboard = 0,
 
@@ -65,7 +65,7 @@ struct alignas(8) KeyData {
   //
   // The value is 1 for true, and 0 for false.
   uint64_t synthesized;
-  KeyEventSource source;
+  KeyEventDeviceType deviceType;
 
   // Sets all contents of `Keydata` to 0.
   void Clear();

lib/web_ui/lib/key.dart

@@ -2,7 +2,6 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-
 part of ui;
 
 /// The type of a key event.
@@ -15,7 +14,49 @@ enum KeyEventType {
   up,
 
   /// The key is held, causing a repeated key input.
-  repeat,
+  repeat;
+
+  String get label {
+    return switch (this) {
+      down => 'Down',
+      up => 'Up',
+      repeat => 'Repeat',
+    };
+  }
+}
+
+/// The source device for the key event.
+///
+/// Not all platforms supply an accurate type.
+///
+/// Defaults to [keyboard].
+// Must match the KeyEventDeviceType enum in ui/window/key_data.h.
+enum KeyEventDeviceType {
+  /// The source is a keyboard.
+  keyboard,
+
+  /// The source is a directional pad on something like a television remote
+  /// control or similar.
+  directionalPad,
+
+  /// The source is a gamepad button
+  gamepad,
+
+  /// The source is a joystick button
+  joystick,
+
+  /// The source is a device connected to an HDMI bus.
+  hdmi;
+
+  String get label {
+    return switch (this) {
+      keyboard => 'Keyboard',
+      directionalPad => 'Directional Pad',
+      gamepad => 'Gamepad',
+      joystick => 'Joystick',
+      hdmi => 'HDMI',
+    };
+  }
 }
 
 /// Information about a key event.
@@ -24,6 +65,7 @@ class KeyData {
   const KeyData({
     required this.timeStamp,
     required this.type,
+    required this.deviceType,
     required this.physical,
     required this.logical,
     required this.character,
@@ -32,13 +74,18 @@ class KeyData {
 
   /// Time of event dispatch, relative to an arbitrary timeline.
   ///
-  /// For [KeyEventType.synchronize] and [KeyEventType.cancel] events, the [timeStamp]
-  /// might not be the actual time that the key press or release happens.
+  /// For synthesized events, the [timeStamp] might not be the actual time that
+  /// the key press or release happens.
   final Duration timeStamp;
 
   /// The type of the event.
   final KeyEventType type;
 
+  /// The source device of this key event.
+  ///
+  /// Defaults to [KeyEventDeviceType.keyboard].
+  final KeyEventDeviceType deviceType;
+
   /// The key code for the physical key that has changed.
   final int physical;
 
@@ -59,17 +106,18 @@ class KeyData {
   ///
   /// For example, some key downs or ups might be lost when the window loses
   /// focus. Some platforms provides ways to query whether a key is being held.
-  /// If Flutter detects an inconsistency between the state Flutter records and
-  /// the state returned by the system, Flutter will synthesize a corresponding
-  /// event to synchronize the state without breaking the event model.
+  /// If the embedder detects an inconsistency between its internal record and
+  /// the state returned by the system, the embedder will synthesize a
+  /// corresponding event to synchronize the state without breaking the event
+  /// model.
   ///
   /// As another example, macOS treats CapsLock in a special way by sending
-  /// down and up events at the down of alterate presses to indicate the
+  /// down and up events at the down of alternate presses to indicate the
   /// direction in which the lock is toggled instead of that the physical key is
-  /// going. Flutter normalizes the behavior by converting a native down event
-  /// into a down event followed immediately by a synthesized up event, and
-  /// the native up event also into a down event followed immediately by a
-  /// synthesized up event.
+  /// going. A macOS embedder should normalize the behavior by converting a
+  /// native down event into a down event followed immediately by a synthesized
+  /// up event, and the native up event also into a down event followed
+  /// immediately by a synthesized up event.
   ///
   /// Synthesized events do not have a trustworthy [timeStamp], and should not be
   /// processed as if the key actually went down or up at the time of the
@@ -95,8 +143,22 @@ class KeyData {
           return ' (Unprintable)';
         case 0x002:
           return ' (Flutter)';
+        case 0x011:
+          return ' (Android)';
+        case 0x012:
+          return ' (Fuchsia)';
+        case 0x013:
+          return ' (iOS)';
+        case 0x014:
+          return ' (macOS)';
+        case 0x015:
+          return ' (GTK)';
+        case 0x016:
+          return ' (Windows)';
         case 0x017:
           return ' (Web)';
+        case 0x018:
+          return ' (GLFW)';
       }
       return '';
     })();
@@ -105,7 +167,7 @@ class KeyData {
 
   String? _escapeCharacter() {
     if (character == null) {
-      return character ?? '<none>';
+      return '<none>';
     }
     switch (character!) {
       case '\n':
@@ -133,29 +195,25 @@ class KeyData {
   }
 
   @override
-  String toString() => 'KeyData(type: ${_typeToString(type)}, physical: 0x${physical.toRadixString(16)}, '
-    'logical: ${_logicalToString()}, character: ${_escapeCharacter()}${_quotedCharCode()}${synthesized ? ', synthesized' : ''})';
+  String toString() {
+    return 'KeyData(key ${type.label}, '
+           'deviceType: ${deviceType.label}), '
+           'physical: 0x${physical.toRadixString(16)}, '
+           'logical: ${_logicalToString()}, '
+           'character: ${_escapeCharacter()}${_quotedCharCode()}'
+           '${synthesized ? ', synthesized' : ''}';
+  }
 
   /// Returns a complete textual description of the information in this object.
   String toStringFull() {
     return '$runtimeType('
-            'type: ${_typeToString(type)}, '
-            'timeStamp: $timeStamp, '
-            'physical: 0x${physical.toRadixString(16)}, '
-            'logical: 0x${logical.toRadixString(16)}, '
-            'character: $character, '
-            'synthesized: $synthesized'
+           'type: ${type.label}, '
+           'deviceType: ${deviceType.label}, '
+           'timeStamp: $timeStamp, '
+           'physical: 0x${physical.toRadixString(16)}, '
+           'logical: 0x${logical.toRadixString(16)}, '
+           'character: ${_escapeCharacter()}, '
+           'synthesized: $synthesized'
            ')';
   }
-
-  static String _typeToString(KeyEventType type) {
-    switch (type) {
-      case KeyEventType.up:
-        return 'up';
-      case KeyEventType.down:
-        return 'down';
-      case KeyEventType.repeat:
-        return 'repeat';
-    }
-  }
 }

lib/web_ui/lib/src/engine/keyboard_binding.dart

@@ -73,6 +73,7 @@ const int _kDeadKeyMeta = 0x80000000;
 
 const ui.KeyData _emptyKeyData = ui.KeyData(
   type: ui.KeyEventType.down,
+  deviceType: ui.KeyEventDeviceType.keyboard,
   timeStamp: Duration.zero,
   logical: 0,
   physical: 0,
@@ -357,6 +358,7 @@ class KeyboardConverter {
       () => ui.KeyData(
         timeStamp: currentTimeStamp + _kKeydownCancelDurationMac,
         type: ui.KeyEventType.up,
+        deviceType: ui.KeyEventDeviceType.keyboard,
         physical: physicalKey,
         logical: logicalKey,
         character: null,
@@ -430,6 +432,7 @@ class KeyboardConverter {
         () => ui.KeyData(
           timeStamp: timeStamp,
           type: ui.KeyEventType.up,
+          deviceType: ui.KeyEventDeviceType.keyboard,
           physical: physicalKey,
           logical: logicalKey(),
           character: null,
@@ -465,6 +468,7 @@ class KeyboardConverter {
           _dispatchKeyData!(ui.KeyData(
             timeStamp: timeStamp,
             type: ui.KeyEventType.up,
+            deviceType: ui.KeyEventDeviceType.keyboard,
             physical: physicalKey,
             logical: logicalKey(),
             character: null,
@@ -533,6 +537,7 @@ class KeyboardConverter {
           _dispatchKeyData!(ui.KeyData(
             timeStamp: timeStamp,
             type: ui.KeyEventType.up,
+            deviceType: ui.KeyEventDeviceType.keyboard,
             physical: physicalKey,
             logical: testeeLogicalKey,
             character: null,
@@ -557,6 +562,7 @@ class KeyboardConverter {
     final ui.KeyData keyData = ui.KeyData(
       timeStamp: timeStamp,
       type: type,
+      deviceType: ui.KeyEventDeviceType.keyboard,
       physical: physicalKey,
       logical: lastLogicalRecord ?? logicalKey(),
       character: type == ui.KeyEventType.up ? null : character,
@@ -669,6 +675,7 @@ class KeyboardConverter {
     performDispatchKeyData(ui.KeyData(
       timeStamp: _eventTimeStampToDuration(domTimestamp),
       type: ui.KeyEventType.down,
+      deviceType: ui.KeyEventDeviceType.keyboard,
       physical: physical,
       logical: logical,
       character: null,
@@ -682,6 +689,7 @@ class KeyboardConverter {
     performDispatchKeyData(ui.KeyData(
       timeStamp: _eventTimeStampToDuration(domTimestamp),
       type: ui.KeyEventType.up,
+      deviceType: ui.KeyEventDeviceType.keyboard,
       physical: physical,
       logical: logical,
       character: null,

shell/platform/embedder/embedder.cc

@@ -2352,21 +2352,21 @@ static inline flutter::KeyEventType MapKeyEventType(
   return flutter::KeyEventType::kUp;
 }
 
-static inline flutter::KeyEventSource MapKeyEventSource(
+static inline flutter::KeyEventDeviceType MapKeyEventDeviceType(
     FlutterKeyEventDeviceType event_kind) {
   switch (event_kind) {
     case kFlutterKeyEventDeviceTypeKeyboard:
-      return flutter::KeyEventSource::kKeyboard;
+      return flutter::KeyEventDeviceType::kKeyboard;
     case kFlutterKeyEventDeviceTypeDirectionalPad:
-      return flutter::KeyEventSource::kDirectionalPad;
+      return flutter::KeyEventDeviceType::kDirectionalPad;
     case kFlutterKeyEventDeviceTypeGamepad:
-      return flutter::KeyEventSource::kGamepad;
+      return flutter::KeyEventDeviceType::kGamepad;
     case kFlutterKeyEventDeviceTypeJoystick:
-      return flutter::KeyEventSource::kJoystick;
+      return flutter::KeyEventDeviceType::kJoystick;
     case kFlutterKeyEventDeviceTypeHdmi:
-      return flutter::KeyEventSource::kHdmi;
+      return flutter::KeyEventDeviceType::kHdmi;
   }
-  return flutter::KeyEventSource::kKeyboard;
+  return flutter::KeyEventDeviceType::kKeyboard;
 }
 
 // Send a platform message to the framework.
@@ -2428,7 +2428,7 @@ FlutterEngineResult FlutterEngineSendKeyEvent(FLUTTER_API_SYMBOL(FlutterEngine)
   key_data.timestamp = static_cast<uint64_t>(SAFE_ACCESS(event, timestamp, 0));
   key_data.type = MapKeyEventType(
       SAFE_ACCESS(event, type, FlutterKeyEventType::kFlutterKeyEventTypeUp));
-  key_data.source = MapKeyEventSource(SAFE_ACCESS(
+  key_data.deviceType = MapKeyEventDeviceType(SAFE_ACCESS(
       event, device_type,
       FlutterKeyEventDeviceType::kFlutterKeyEventDeviceTypeKeyboard));
   key_data.physical = SAFE_ACCESS(event, physical, 0);

shell/platform/embedder/tests/embedder_unittests.cc

@@ -2098,7 +2098,7 @@ FlutterKeyEventType UnserializeKeyEventType(uint64_t kind) {
 
 // Convert `source` in integer form to its enum form.
 //
-// It performs a revesed mapping from `_serializeKeyEventSource`
+// It performs a revesed mapping from `_serializeKeyEventDeviceType`
 // in shell/platform/embedder/fixtures/main.dart.
 FlutterKeyEventDeviceType UnserializeKeyEventDeviceType(uint64_t source) {
   switch (source) {