Skip to content

Commit

Permalink
chore: ExtendedPhysicalKeyboardKey support linux platform
Browse files Browse the repository at this point in the history
  • Loading branch information
lijy91 committed Mar 2, 2024
1 parent 9179e4a commit 8195adc
Show file tree
Hide file tree
Showing 9 changed files with 151 additions and 53 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
liberapay: lijy91
32 changes: 32 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: build

on:
push:
branches: [main]
pull_request:
types: [opened, reopened]

jobs:
build-macos:
runs-on: macos-latest
steps:
- uses: actions/checkout@v3
- uses: subosito/flutter-action@v2
with:
flutter-version: "3.19.2"
channel: "stable"
- working-directory: ./example
run: |
flutter build macos --release
build-web:
runs-on: macos-latest
steps:
- uses: actions/checkout@v3
- uses: subosito/flutter-action@v2
with:
flutter-version: "3.19.2"
channel: "stable"
- working-directory: ./example
run: |
flutter build web --release
28 changes: 28 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: lint

on:
push:
branches: [main]
pull_request:
types: [opened, reopened]

jobs:
analyze:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: subosito/flutter-action@v2
with:
flutter-version: "3.19.2"
channel: "stable"
- run: flutter analyze --fatal-infos

format:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: subosito/flutter-action@v2
with:
flutter-version: "3.19.2"
channel: "stable"
- run: dart format . --fix --set-exit-if-changed
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 0.1.3

* chore: `ExtendedPhysicalKeyboardKey` support linux platform

## 0.1.2

* feat: Extension methods for `LogicalKeyboardKey` and `PhysicalKeyboardKey`
Expand Down
70 changes: 43 additions & 27 deletions example/pubspec.lock
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ packages:
dependency: transitive
description:
name: file
sha256: "1b92bec4fc2a72f59a8e15af5f52cd441e4a7860b49499d69dfa817af20e925d"
sha256: "5fc22d7c25582e38ad9a8515372cd9a93834027aacf1801cf01164dac0ffa08c"
url: "https://pub.dev"
source: hosted
version: "6.1.4"
version: "7.0.0"
flutter:
dependency: "direct main"
description: flutter
Expand All @@ -82,6 +82,30 @@ packages:
description: flutter
source: sdk
version: "0.0.0"
leak_tracker:
dependency: transitive
description:
name: leak_tracker
sha256: "78eb209deea09858f5269f5a5b02be4049535f568c07b275096836f01ea323fa"
url: "https://pub.dev"
source: hosted
version: "10.0.0"
leak_tracker_flutter_testing:
dependency: transitive
description:
name: leak_tracker_flutter_testing
sha256: b46c5e37c19120a8a01918cfaf293547f47269f7cb4b0058f21531c2465d6ef0
url: "https://pub.dev"
source: hosted
version: "2.0.1"
leak_tracker_testing:
dependency: transitive
description:
name: leak_tracker_testing
sha256: a597f72a664dbd293f3bfc51f9ba69816f84dcd403cdac7066cb3f6003f3ab47
url: "https://pub.dev"
source: hosted
version: "2.0.1"
lints:
dependency: transitive
description:
Expand All @@ -94,26 +118,26 @@ packages:
dependency: transitive
description:
name: matcher
sha256: "1803e76e6653768d64ed8ff2e1e67bea3ad4b923eb5c56a295c3e634bad5960e"
sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
url: "https://pub.dev"
source: hosted
version: "0.12.16"
version: "0.12.16+1"
material_color_utilities:
dependency: transitive
description:
name: material_color_utilities
sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41"
sha256: "0e0a020085b65b6083975e499759762399b4475f766c21668c4ecca34ea74e5a"
url: "https://pub.dev"
source: hosted
version: "0.5.0"
version: "0.8.0"
meta:
dependency: transitive
description:
name: meta
sha256: a6e590c838b18133bb482a2745ad77c5bb7715fb0451209e1a7567d416678b8e
sha256: d584fa6707a52763a52446f02cc621b077888fb63b93bbcb1143a7be5a0c0c04
url: "https://pub.dev"
source: hosted
version: "1.10.0"
version: "1.11.0"
mostly_reasonable_lints:
dependency: "direct dev"
description:
Expand All @@ -126,26 +150,26 @@ packages:
dependency: transitive
description:
name: path
sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917"
sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
url: "https://pub.dev"
source: hosted
version: "1.8.3"
version: "1.9.0"
platform:
dependency: transitive
description:
name: platform
sha256: ae68c7bfcd7383af3629daafb32fb4e8681c7154428da4febcff06200585f102
sha256: "12220bb4b65720483f8fa9450b4332347737cf8213dd2840d8b2c823e47243ec"
url: "https://pub.dev"
source: hosted
version: "3.1.2"
version: "3.1.4"
process:
dependency: transitive
description:
name: process
sha256: "53fd8db9cec1d37b0574e12f07520d582019cb6c44abf5479a01505099a34a09"
sha256: "21e54fd2faf1b5bdd5102afd25012184a6793927648ea81eea80552ac9405b32"
url: "https://pub.dev"
source: hosted
version: "4.2.4"
version: "5.0.2"
sky_engine:
dependency: transitive
description: flutter
Expand Down Expand Up @@ -213,7 +237,7 @@ packages:
path: ".."
relative: true
source: path
version: "0.1.1"
version: "0.1.3"
vector_math:
dependency: transitive
description:
Expand All @@ -226,26 +250,18 @@ packages:
dependency: transitive
description:
name: vm_service
sha256: c538be99af830f478718b51630ec1b6bee5e74e52c8a802d328d9e71d35d2583
url: "https://pub.dev"
source: hosted
version: "11.10.0"
web:
dependency: transitive
description:
name: web
sha256: afe077240a270dcfd2aafe77602b4113645af95d0ad31128cc02bce5ac5d5152
sha256: b3d56ff4341b8f182b96aceb2fa20e3dcb336b9f867bc0eafc0de10f1048e957
url: "https://pub.dev"
source: hosted
version: "0.3.0"
version: "13.0.0"
webdriver:
dependency: transitive
description:
name: webdriver
sha256: "3c923e918918feeb90c4c9fdf1fe39220fa4c0e8e2c0fffaded174498ef86c49"
sha256: "003d7da9519e1e5f329422b36c4dcdf18d7d2978d1ba099ea4e45ba490ed845e"
url: "https://pub.dev"
source: hosted
version: "3.0.2"
version: "3.0.3"
sdks:
dart: ">=3.2.4 <4.0.0"
flutter: ">=3.3.0"
54 changes: 30 additions & 24 deletions lib/src/extensions/keyboard_key.dart
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import 'package:flutter/services.dart';
import 'package:uni_platform/uni_platform.dart';
import 'package:uni_platform/src/uni_platform.dart';

/// Map of logical key id to physical key id.
Map<int, int> _keymap = {
Expand Down Expand Up @@ -236,16 +236,25 @@ Map<int, int> _keymap = {
0x0020000031f: 0x0005ff1f, // Game Button Z
};

extension _ExtendedIterable<T> on Iterable<T> {
/// The first element satisfying [test], or `null` if there are none.
T? firstWhereOrNull(bool Function(T element) test) {
for (var element in this) {
if (test(element)) return element;
}
return null;
}
}

/// Extension methods for [LogicalKeyboardKey].
extension ExtendedLogicalKeyboardKey on LogicalKeyboardKey {
PhysicalKeyboardKey? get physicalKey {
int? usageCode = _keymap.entries
.firstWhere(
.firstWhereOrNull(
(entry) => entry.key == keyId,
orElse: () => const MapEntry(-1, -1),
)
.value;
if (usageCode == -1) return null;
?.value;
if (usageCode == null) return null;
return PhysicalKeyboardKey.findKeyByCode(usageCode);
}
}
Expand All @@ -254,34 +263,31 @@ extension ExtendedLogicalKeyboardKey on LogicalKeyboardKey {
extension ExtendedPhysicalKeyboardKey on PhysicalKeyboardKey {
LogicalKeyboardKey? get logicalKey {
int? keyId = _keymap.entries
.firstWhere(
(entry) => entry.value == usbHidUsage,
orElse: () => const MapEntry(-1, -1),
)
.key;
.firstWhereOrNull((entry) => entry.value == usbHidUsage)
?.key;
if (keyId == null) return null;
return LogicalKeyboardKey.findKeyByKeyId(keyId);
}

/// Returns the [keyCode] of this [PhysicalKeyboardKey].
int? get keyCode {
return UniPlatform.call<int?>(
linux: () {
int? matchedKeyCode = kGtkToLogicalKey.entries
.firstWhereOrNull((entry) => entry.value == logicalKey)
?.key;
if (matchedKeyCode != null) return matchedKeyCode;
return logicalKey?.keyId;
},
macos: () {
int? code = kMacOsToPhysicalKey.entries
.firstWhere(
(entry) => entry.value == this,
orElse: () => const MapEntry(-1, PhysicalKeyboardKey(-1)),
)
.key;
return code == -1 ? null : code;
return kMacOsToPhysicalKey.entries
.firstWhereOrNull((entry) => entry.value == this)
?.key;
},
windows: () {
int? code = kWindowsToLogicalKey.entries
.firstWhere(
(entry) => entry.value == logicalKey,
orElse: () => const MapEntry(-1, LogicalKeyboardKey(-1)),
)
.key;
return code == -1 ? null : code;
return kWindowsToLogicalKey.entries
.firstWhereOrNull((entry) => entry.value == logicalKey)
?.key;
},
);
}
Expand Down
1 change: 1 addition & 0 deletions lib/uni_platform.dart
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
library uni_platform;

export 'src/extensions/keyboard_key.dart';
export 'src/uni_platform.dart';
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: uni_platform
description: "Substitutes the Platform class, ensuring works across all platforms."
version: 0.1.2
version: 0.1.3
homepage: https://github.com/leanflutter/uni_platform

environment:
Expand Down
12 changes: 11 additions & 1 deletion test/src/extensions/keyboard_key_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import 'package:flutter/foundation.dart';
import 'package:flutter/services.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:uni_platform/src/extensions/keyboard_key.dart';
import 'package:uni_platform/uni_platform.dart';
import 'package:uni_platform/src/uni_platform.dart';

void main() {
test('Verify keymap', () async {
Expand Down Expand Up @@ -58,13 +58,23 @@ Map<int, int> _keymap = {
expect(PhysicalKeyboardKey.keyA.logicalKey, LogicalKeyboardKey.keyA);
expect(PhysicalKeyboardKey.keyB.logicalKey, LogicalKeyboardKey.keyB);
expect(PhysicalKeyboardKey.keyC.logicalKey, LogicalKeyboardKey.keyC);
UniPlatform.operatingSystem = 'linux';
expect(PhysicalKeyboardKey.keyA.keyCode, 0x61);
expect(PhysicalKeyboardKey.keyB.keyCode, 0x62);
expect(PhysicalKeyboardKey.keyC.keyCode, 0x63);
expect(PhysicalKeyboardKey.f12.keyCode, 0xffc9);
expect(PhysicalKeyboardKey.f13.keyCode, 0xffca);
UniPlatform.operatingSystem = 'macos';
expect(PhysicalKeyboardKey.keyA.keyCode, 0x00);
expect(PhysicalKeyboardKey.keyB.keyCode, 0x0b);
expect(PhysicalKeyboardKey.keyC.keyCode, 0x08);
expect(PhysicalKeyboardKey.f12.keyCode, 111);
expect(PhysicalKeyboardKey.f13.keyCode, 105);
UniPlatform.operatingSystem = 'windows';
expect(PhysicalKeyboardKey.keyA.keyCode, 0x41);
expect(PhysicalKeyboardKey.keyB.keyCode, 0x42);
expect(PhysicalKeyboardKey.keyC.keyCode, 0x43);
expect(PhysicalKeyboardKey.f12.keyCode, 0x7b);
expect(PhysicalKeyboardKey.f13.keyCode, 0x7c);
});
}

0 comments on commit 8195adc

Please sign in to comment.