diff --git a/.github/workflows/jnigen.yaml b/.github/workflows/jnigen.yaml index 30e958487..2a128ae45 100644 --- a/.github/workflows/jnigen.yaml +++ b/.github/workflows/jnigen.yaml @@ -352,6 +352,26 @@ jobs: - run: flutter pub get - run: flutter build windows + build_jni_example_macos: + runs-on: macos-latest + defaults: + run: + working-directory: ./pkgs/jni/example + steps: + - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 + - uses: subosito/flutter-action@44ac965b96f18d999802d4b807e3256d5a3f9fa1 + with: + channel: 'stable' + cache: true + cache-key: 'flutter-:os:-:channel:-:version:-:arch:-:hash:' + - uses: actions/setup-java@99b8673ff64fbf99d8d325f52d9a5bdedb8483e9 + with: + architecture: 'arm64' + distribution: 'temurin' + java-version: '11' + - run: flutter pub get + - run: flutter build macos + build_jni_example_android: runs-on: ubuntu-latest defaults: diff --git a/pkgs/jni/.metadata b/pkgs/jni/.metadata index 26fc23fe6..d1fc27d38 100644 --- a/pkgs/jni/.metadata +++ b/pkgs/jni/.metadata @@ -1,11 +1,11 @@ # This file tracks properties of this Flutter project. # Used by Flutter tool to assess capabilities and perform upgrades etc. # -# This file should be version controlled. +# This file should be version controlled and should not be manually edited. version: - revision: 676cefaaff197f27424942307668886253e1ec35 - channel: stable + revision: "a14f74ff3a1cbd521163c5f03d68113d50af93d3" + channel: "stable" project_type: plugin_ffi @@ -13,20 +13,20 @@ project_type: plugin_ffi migration: platforms: - platform: root - create_revision: 676cefaaff197f27424942307668886253e1ec35 - base_revision: 676cefaaff197f27424942307668886253e1ec35 + create_revision: a14f74ff3a1cbd521163c5f03d68113d50af93d3 + base_revision: a14f74ff3a1cbd521163c5f03d68113d50af93d3 - platform: android - create_revision: 676cefaaff197f27424942307668886253e1ec35 - base_revision: 676cefaaff197f27424942307668886253e1ec35 + create_revision: a14f74ff3a1cbd521163c5f03d68113d50af93d3 + base_revision: a14f74ff3a1cbd521163c5f03d68113d50af93d3 - platform: linux - create_revision: 676cefaaff197f27424942307668886253e1ec35 - base_revision: 676cefaaff197f27424942307668886253e1ec35 + create_revision: a14f74ff3a1cbd521163c5f03d68113d50af93d3 + base_revision: a14f74ff3a1cbd521163c5f03d68113d50af93d3 - platform: macos - create_revision: 676cefaaff197f27424942307668886253e1ec35 - base_revision: 676cefaaff197f27424942307668886253e1ec35 + create_revision: a14f74ff3a1cbd521163c5f03d68113d50af93d3 + base_revision: a14f74ff3a1cbd521163c5f03d68113d50af93d3 - platform: windows - create_revision: 676cefaaff197f27424942307668886253e1ec35 - base_revision: 676cefaaff197f27424942307668886253e1ec35 + create_revision: a14f74ff3a1cbd521163c5f03d68113d50af93d3 + base_revision: a14f74ff3a1cbd521163c5f03d68113d50af93d3 # User provided section diff --git a/pkgs/jni/CHANGELOG.md b/pkgs/jni/CHANGELOG.md index ce24bdb77..d2482428b 100644 --- a/pkgs/jni/CHANGELOG.md +++ b/pkgs/jni/CHANGELOG.md @@ -2,6 +2,7 @@ - **Breaking Change** Removed `Jni.accessors`. - Made most `Jni.env` methods into leaf functions to speed up their execution. +- Support Flutter macOS as a target. ## 0.10.1 diff --git a/pkgs/jni/example/lib/main.dart b/pkgs/jni/example/lib/main.dart index 6af02b6aa..b406a9d3e 100644 --- a/pkgs/jni/example/lib/main.dart +++ b/pkgs/jni/example/lib/main.dart @@ -4,11 +4,10 @@ // ignore_for_file: library_private_types_in_public_api -import 'package:flutter/material.dart'; - -import 'dart:io'; import 'dart:ffi'; +import 'dart:io'; +import 'package:flutter/material.dart'; import 'package:jni/jni.dart'; // An example of calling JNI methods using low level primitives. diff --git a/pkgs/jni/example/macos/Podfile b/pkgs/jni/example/macos/Podfile index dade8dfad..049abe295 100644 --- a/pkgs/jni/example/macos/Podfile +++ b/pkgs/jni/example/macos/Podfile @@ -1,4 +1,4 @@ -platform :osx, '10.11' +platform :osx, '10.14' # CocoaPods analytics sends network stats synchronously affecting flutter build latency. ENV['COCOAPODS_DISABLE_STATS'] = 'true' diff --git a/pkgs/jni/example/macos/Podfile.lock b/pkgs/jni/example/macos/Podfile.lock new file mode 100644 index 000000000..8ea731dd4 --- /dev/null +++ b/pkgs/jni/example/macos/Podfile.lock @@ -0,0 +1,22 @@ +PODS: + - FlutterMacOS (1.0.0) + - jni (0.0.1): + - FlutterMacOS + +DEPENDENCIES: + - FlutterMacOS (from `Flutter/ephemeral`) + - jni (from `Flutter/ephemeral/.symlinks/plugins/jni/macos`) + +EXTERNAL SOURCES: + FlutterMacOS: + :path: Flutter/ephemeral + jni: + :path: Flutter/ephemeral/.symlinks/plugins/jni/macos + +SPEC CHECKSUMS: + FlutterMacOS: 8f6f14fa908a6fb3fba0cd85dbd81ec4b251fb24 + jni: d08848714503eb300e23d543183127c08ac62572 + +PODFILE CHECKSUM: 353c8bcc5d5b0994e508d035b5431cfe18c1dea7 + +COCOAPODS: 1.15.2 diff --git a/pkgs/jni/example/macos/Runner.xcodeproj/project.pbxproj b/pkgs/jni/example/macos/Runner.xcodeproj/project.pbxproj index 79f7a2099..dee64ee2c 100644 --- a/pkgs/jni/example/macos/Runner.xcodeproj/project.pbxproj +++ b/pkgs/jni/example/macos/Runner.xcodeproj/project.pbxproj @@ -3,7 +3,7 @@ archiveVersion = 1; classes = { }; - objectVersion = 51; + objectVersion = 54; objects = { /* Begin PBXAggregateTarget section */ @@ -21,6 +21,7 @@ /* End PBXAggregateTarget section */ /* Begin PBXBuildFile section */ + 31B9E26D2EB59CABB0AF863B /* Pods_Runner.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = C69C493CCDF4A533867FCC8D /* Pods_Runner.framework */; }; 335BBD1B22A9A15E00E9071D /* GeneratedPluginRegistrant.swift in Sources */ = {isa = PBXBuildFile; fileRef = 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */; }; 33CC10F12044A3C60003C045 /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 33CC10F02044A3C60003C045 /* AppDelegate.swift */; }; 33CC10F32044A3C60003C045 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 33CC10F22044A3C60003C045 /* Assets.xcassets */; }; @@ -54,7 +55,7 @@ /* Begin PBXFileReference section */ 333000ED22D3DE5D00554162 /* Warnings.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Warnings.xcconfig; sourceTree = ""; }; 335BBD1A22A9A15E00E9071D /* GeneratedPluginRegistrant.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = GeneratedPluginRegistrant.swift; sourceTree = ""; }; - 33CC10ED2044A3C60003C045 /* jni_example.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = "jni_example.app"; sourceTree = BUILT_PRODUCTS_DIR; }; + 33CC10ED2044A3C60003C045 /* jni_example.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = jni_example.app; sourceTree = BUILT_PRODUCTS_DIR; }; 33CC10F02044A3C60003C045 /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = ""; }; 33CC10F22044A3C60003C045 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; name = Assets.xcassets; path = Runner/Assets.xcassets; sourceTree = ""; }; 33CC10F52044A3C60003C045 /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.xib; name = Base; path = Base.lproj/MainMenu.xib; sourceTree = ""; }; @@ -67,7 +68,11 @@ 33E51914231749380026EE4D /* Release.entitlements */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.entitlements; path = Release.entitlements; sourceTree = ""; }; 33E5194F232828860026EE4D /* AppInfo.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = AppInfo.xcconfig; sourceTree = ""; }; 7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Release.xcconfig; sourceTree = ""; }; + 908AD9024D8CB7D20F75E75C /* Pods-Runner.profile.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.profile.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.profile.xcconfig"; sourceTree = ""; }; 9740EEB21CF90195004384FC /* Debug.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; path = Debug.xcconfig; sourceTree = ""; }; + AE07195FEB458C1E77D7E93E /* Pods-Runner.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.debug.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"; sourceTree = ""; }; + C69C493CCDF4A533867FCC8D /* Pods_Runner.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Runner.framework; sourceTree = BUILT_PRODUCTS_DIR; }; + D0492A503298F9672919BFDC /* Pods-Runner.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.release.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -75,6 +80,7 @@ isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; files = ( + 31B9E26D2EB59CABB0AF863B /* Pods_Runner.framework in Frameworks */, ); runOnlyForDeploymentPostprocessing = 0; }; @@ -99,6 +105,7 @@ 33CEB47122A05771004F2AC0 /* Flutter */, 33CC10EE2044A3C60003C045 /* Products */, D73912EC22F37F3D000D13A0 /* Frameworks */, + 7E661A13EA75E31F6546B680 /* Pods */, ); sourceTree = ""; }; @@ -145,9 +152,20 @@ path = Runner; sourceTree = ""; }; + 7E661A13EA75E31F6546B680 /* Pods */ = { + isa = PBXGroup; + children = ( + AE07195FEB458C1E77D7E93E /* Pods-Runner.debug.xcconfig */, + D0492A503298F9672919BFDC /* Pods-Runner.release.xcconfig */, + 908AD9024D8CB7D20F75E75C /* Pods-Runner.profile.xcconfig */, + ); + path = Pods; + sourceTree = ""; + }; D73912EC22F37F3D000D13A0 /* Frameworks */ = { isa = PBXGroup; children = ( + C69C493CCDF4A533867FCC8D /* Pods_Runner.framework */, ); name = Frameworks; sourceTree = ""; @@ -159,11 +177,13 @@ isa = PBXNativeTarget; buildConfigurationList = 33CC10FB2044A3C60003C045 /* Build configuration list for PBXNativeTarget "Runner" */; buildPhases = ( + CE1500691A1FFA23834C0C88 /* [CP] Check Pods Manifest.lock */, 33CC10E92044A3C60003C045 /* Sources */, 33CC10EA2044A3C60003C045 /* Frameworks */, 33CC10EB2044A3C60003C045 /* Resources */, 33CC110E2044A8840003C045 /* Bundle Framework */, 3399D490228B24CF009A79C7 /* ShellScript */, + 3AA03BDC61C212440CD3E30B /* [CP] Embed Pods Frameworks */, ); buildRules = ( ); @@ -182,7 +202,7 @@ isa = PBXProject; attributes = { LastSwiftUpdateCheck = 0920; - LastUpgradeCheck = 1300; + LastUpgradeCheck = 1510; ORGANIZATIONNAME = ""; TargetAttributes = { 33CC10EC2044A3C60003C045 = { @@ -235,6 +255,7 @@ /* Begin PBXShellScriptBuildPhase section */ 3399D490228B24CF009A79C7 /* ShellScript */ = { isa = PBXShellScriptBuildPhase; + alwaysOutOfDate = 1; buildActionMask = 2147483647; files = ( ); @@ -270,6 +291,45 @@ shellPath = /bin/sh; shellScript = "\"$FLUTTER_ROOT\"/packages/flutter_tools/bin/macos_assemble.sh && touch Flutter/ephemeral/tripwire"; }; + 3AA03BDC61C212440CD3E30B /* [CP] Embed Pods Frameworks */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + "${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-frameworks-${CONFIGURATION}-input-files.xcfilelist", + ); + name = "[CP] Embed Pods Frameworks"; + outputFileListPaths = ( + "${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-frameworks-${CONFIGURATION}-output-files.xcfilelist", + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-Runner/Pods-Runner-frameworks.sh\"\n"; + showEnvVarsInLog = 0; + }; + CE1500691A1FFA23834C0C88 /* [CP] Check Pods Manifest.lock */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputFileListPaths = ( + ); + inputPaths = ( + "${PODS_PODFILE_DIR_PATH}/Podfile.lock", + "${PODS_ROOT}/Manifest.lock", + ); + name = "[CP] Check Pods Manifest.lock"; + outputFileListPaths = ( + ); + outputPaths = ( + "$(DERIVED_FILE_DIR)/Pods-Runner-checkManifestLockResult.txt", + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n"; + showEnvVarsInLog = 0; + }; /* End PBXShellScriptBuildPhase section */ /* Begin PBXSourcesBuildPhase section */ @@ -344,7 +404,7 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - MACOSX_DEPLOYMENT_TARGET = 10.11; + MACOSX_DEPLOYMENT_TARGET = 10.14; MTL_ENABLE_DEBUG_INFO = NO; SDKROOT = macosx; SWIFT_COMPILATION_MODE = wholemodule; @@ -423,7 +483,7 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - MACOSX_DEPLOYMENT_TARGET = 10.11; + MACOSX_DEPLOYMENT_TARGET = 10.14; MTL_ENABLE_DEBUG_INFO = YES; ONLY_ACTIVE_ARCH = YES; SDKROOT = macosx; @@ -470,7 +530,7 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - MACOSX_DEPLOYMENT_TARGET = 10.11; + MACOSX_DEPLOYMENT_TARGET = 10.14; MTL_ENABLE_DEBUG_INFO = NO; SDKROOT = macosx; SWIFT_COMPILATION_MODE = wholemodule; diff --git a/pkgs/jni/example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/pkgs/jni/example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme index 2b12d610f..11a9feee6 100644 --- a/pkgs/jni/example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme +++ b/pkgs/jni/example/macos/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -1,6 +1,6 @@ + + diff --git a/pkgs/jni/example/macos/Runner/DebugProfile.entitlements b/pkgs/jni/example/macos/Runner/DebugProfile.entitlements index dddb8a30c..9f56413f3 100644 --- a/pkgs/jni/example/macos/Runner/DebugProfile.entitlements +++ b/pkgs/jni/example/macos/Runner/DebugProfile.entitlements @@ -3,7 +3,7 @@ com.apple.security.app-sandbox - + com.apple.security.cs.allow-jit com.apple.security.network.server diff --git a/pkgs/jni/example/macos/Runner/Release.entitlements b/pkgs/jni/example/macos/Runner/Release.entitlements index 852fa1a47..e89b7f323 100644 --- a/pkgs/jni/example/macos/Runner/Release.entitlements +++ b/pkgs/jni/example/macos/Runner/Release.entitlements @@ -3,6 +3,6 @@ com.apple.security.app-sandbox - + diff --git a/pkgs/jni/example/pubspec.lock b/pkgs/jni/example/pubspec.lock index 0ce4ee8bd..65b6308b5 100644 --- a/pkgs/jni/example/pubspec.lock +++ b/pkgs/jni/example/pubspec.lock @@ -200,7 +200,7 @@ packages: path: ".." relative: true source: path - version: "0.9.3" + version: "0.11.0-wip" js: dependency: transitive description: diff --git a/pkgs/jni/lib/src/jni.dart b/pkgs/jni/lib/src/jni.dart index 4fa609cbd..49205dc8a 100644 --- a/pkgs/jni/lib/src/jni.dart +++ b/pkgs/jni/lib/src/jni.dart @@ -13,30 +13,38 @@ import '../jni.dart'; import 'accessors.dart'; import 'third_party/generated_bindings.dart'; -String _getLibraryFileName(String base) { +/// Load Dart-JNI Helper library. +/// +/// If path is provided, it's used to load the library. +/// Else just the platform-specific filename is passed to DynamicLibrary.open +/// +/// Flutter macOS applications pass a `null` [dir]. +DynamicLibrary _loadDartJniLibrary({String? dir, String? baseName}) { + String path; if (Platform.isLinux || Platform.isAndroid) { - return 'lib$base.so'; + baseName ??= 'dartjni'; + path = 'lib$baseName.so'; } else if (Platform.isWindows) { - return '$base.dll'; + baseName ??= 'dartjni'; + path = '$baseName.dll'; } else if (Platform.isMacOS) { - return 'lib$base.dylib'; + path = '${baseName ?? 'jni'}.framework/${baseName ?? 'jni'}'; } else { - throw UnsupportedError('cannot derive library name: unsupported platform'); + throw UnsupportedError('Unknown platform: ${Platform.operatingSystem}'); + } + if (dir != null) { + // Reverting back to dylib if on dart-standalone. + if (Platform.isMacOS) { + baseName ??= 'dartjni'; + path = 'lib$baseName.dylib'; + } + path = join(dir, path); } -} - -/// Load Dart-JNI Helper library. -/// -/// If path is provided, it's used to load the library. -/// Else just the platform-specific filename is passed to DynamicLibrary.open -DynamicLibrary _loadDartJniLibrary({String? dir, String baseName = 'dartjni'}) { - final fileName = _getLibraryFileName(baseName); - final libPath = (dir != null) ? join(dir, fileName) : fileName; try { - final dylib = DynamicLibrary.open(libPath); + final dylib = DynamicLibrary.open(path); return dylib; } catch (_) { - throw HelperNotFoundError(libPath); + throw HelperNotFoundError(path); } } @@ -44,19 +52,20 @@ DynamicLibrary _loadDartJniLibrary({String? dir, String baseName = 'dartjni'}) { abstract final class Jni { static final DynamicLibrary _dylib = _loadDartJniLibrary(dir: _dylibDir); static final JniBindings _bindings = JniBindings(_dylib); - static final _getJniEnvFn = _dylib.lookup('GetJniEnv'); - static final _getJniContextFn = _dylib.lookup('GetJniContextPtr'); /// Store dylibDir if any was used. static String? _dylibDir; /// Sets the directory where dynamic libraries are looked for. - /// On dart standalone, call this in new isolate before doing - /// any JNI operation. /// - /// (The reason is that dylibs need to be loaded in every isolate. - /// On flutter it's done by library. On dart standalone we don't - /// know the library path.) + /// On Dart-standalone, call this in new isolates before calling any JNI + /// functions. + /// + /// Dylibs need to be loaded in every isolate. + /// On Flutter it is done by library. On Dart-standalone the library path is + /// not known. + /// + /// Flutter macOS applications should not call this. static void setDylibDir({required String dylibDir}) { if (!Platform.isAndroid) { _dylibDir = dylibDir; @@ -111,6 +120,8 @@ abstract final class Jni { /// /// If the options are different than that of existing VM, the existing VM's /// options will remain in effect. + /// + /// Flutter macOS applications should pass `null` to [dylibDir]. static bool spawnIfNotExists({ String? dylibDir, List jvmOptions = const [], @@ -235,28 +246,10 @@ abstract final class Jni { JGlobalReference(_bindings.GetClassLoader()); } -typedef _SetJniGettersNativeType = Void Function(Pointer, Pointer); -typedef _SetJniGettersDartType = void Function(Pointer, Pointer); - /// Extensions for use by `jnigen` generated code. extension ProtectedJniExtensions on Jni { static final _jThrowableClass = JClass.forName('java/lang/Throwable'); - static Pointer Function(String) initGeneratedLibrary( - String name) { - var path = _getLibraryFileName(name); - if (Jni._dylibDir != null) { - path = join(Jni._dylibDir!, path); - } - final dl = DynamicLibrary.open(path); - final setJniGetters = - dl.lookupFunction<_SetJniGettersNativeType, _SetJniGettersDartType>( - 'setJniGetters'); - setJniGetters(Jni._getJniContextFn, Jni._getJniEnvFn); - final lookup = dl.lookup; - return lookup; - } - /// Returns a new DartException. static Pointer newDartException(Object exception) { JObjectPtr? cause; diff --git a/pkgs/jni/lib/src/third_party/jni_bindings_generated.dart b/pkgs/jni/lib/src/third_party/jni_bindings_generated.dart index 8f03912ba..ca6e70b4c 100644 --- a/pkgs/jni/lib/src/third_party/jni_bindings_generated.dart +++ b/pkgs/jni/lib/src/third_party/jni_bindings_generated.dart @@ -130,7 +130,7 @@ class JniBindings { } late final _SpawnJvmPtr = _lookup< - ffi.NativeFunction)>>( + ffi.NativeFunction)>>( 'SpawnJvm'); late final _SpawnJvm = _SpawnJvmPtr.asFunction)>(); diff --git a/pkgs/jni/macos/Classes/jni.c b/pkgs/jni/macos/Classes/jni.c new file mode 100644 index 000000000..2cd0273f3 --- /dev/null +++ b/pkgs/jni/macos/Classes/jni.c @@ -0,0 +1,5 @@ +// Relative import to be able to reuse the C sources. +// See the comment in ../jni.podspec for more information. +#include "../../src/dartjni.c" +#include "../../src/third_party/global_jni_env.c" +#include "../../src/include/dart_api_dl.c" diff --git a/pkgs/jni/macos/jni.podspec b/pkgs/jni/macos/jni.podspec new file mode 100644 index 000000000..68f60df88 --- /dev/null +++ b/pkgs/jni/macos/jni.podspec @@ -0,0 +1,41 @@ +# +# To learn more about a Podspec see http://guides.cocoapods.org/syntax/podspec.html. +# Run `pod lib lint jni.podspec` to validate before publishing. +# +Pod::Spec.new do |s| + s.name = 'jni' + s.version = '0.0.1' + s.summary = 'macOS implementation of JNI.' + s.description = <<-DESC +Enables interop with Java using JNI. + DESC + s.homepage = 'https://github.com/dart-lang/native/tree/main/pkgs/jni' + s.license = { :type => 'BSD', :file => '../LICENSE' } + s.author = { 'Hossein Yousefi' => 'yousefi@google.com' } + + # This will ensure the source files in Classes/ are included in the native + # builds of apps using this FFI plugin. Podspec does not support relative + # paths, so Classes contains a forwarder C file that relatively imports + # `../src/*` so that the C sources can be shared among all target platforms. + s.source = { :path => '.' } + s.source_files = 'Classes/**/*' + s.dependency 'FlutterMacOS' + s.xcconfig = { + 'LIBRARY_SEARCH_PATHS' => [ + '"$(JAVA_HOME)/lib/server"' + ], + 'HEADER_SEARCH_PATHS' => [ + '"$(JAVA_HOME)/include/darwin"', + '"$(JAVA_HOME)/include"' + ], + 'RUNPATH_SEARCH_PATH' => [ + '"$(JAVA_HOME)/lib/server"' + ], + 'OTHER_LDFLAGS' => [ + '-ljvm' + ] + } + s.platform = :osx, '10.11' + s.pod_target_xcconfig = { 'DEFINES_MODULE' => 'YES' } + s.swift_version = '5.0' +end diff --git a/pkgs/jni/pubspec.yaml b/pkgs/jni/pubspec.yaml index b829b1a12..81251a8c0 100644 --- a/pkgs/jni/pubspec.yaml +++ b/pkgs/jni/pubspec.yaml @@ -42,6 +42,8 @@ flutter: ffiPlugin: true windows: ffiPlugin: true + macos: + ffiPlugin: true android: ffiPlugin: true package: com.github.dart_lang.jni diff --git a/pkgs/jni/src/dartjni.c b/pkgs/jni/src/dartjni.c index 18a981a31..a453c979d 100644 --- a/pkgs/jni/src/dartjni.c +++ b/pkgs/jni/src/dartjni.c @@ -55,7 +55,7 @@ JniContext* jni = &jni_context; THREAD_LOCAL JNIEnv* jniEnv = NULL; JniExceptionMethods exceptionMethods; -void init() { +void init(void) { #ifndef _WIN32 // Init TLS keys. pthread_key_create(&tlsKey, detach_thread); @@ -82,7 +82,7 @@ void init() { "(Ljava/io/OutputStream;)V"); } -void deinit() { +void deinit(void) { #ifndef _WIN32 // Delete TLS keys. pthread_key_delete(tlsKey); @@ -108,26 +108,26 @@ JNIEXPORT void JNICALL JNI_OnUnload(JavaVM* jvm, void* reserved) { /// Get JVM associated with current process. /// Returns NULL if no JVM is running. FFI_PLUGIN_EXPORT -JavaVM* GetJavaVM() { +JavaVM* GetJavaVM(void) { return jni_context.jvm; } // Android specifics FFI_PLUGIN_EXPORT -jobject GetClassLoader() { +jobject GetClassLoader(void) { attach_thread(); return (*jniEnv)->NewGlobalRef(jniEnv, jni_context.classLoader); } FFI_PLUGIN_EXPORT -jobject GetApplicationContext() { +jobject GetApplicationContext(void) { attach_thread(); return (*jniEnv)->NewGlobalRef(jniEnv, jni_context.appContext); } FFI_PLUGIN_EXPORT -jobject GetCurrentActivity() { +jobject GetCurrentActivity(void) { attach_thread(); return (*jniEnv)->NewGlobalRef(jniEnv, jni_context.currentActivity); } @@ -201,7 +201,7 @@ BOOL WINAPI DllMain(HINSTANCE hinstDLL, // handle to DLL module pthread_mutex_t spawnLock = PTHREAD_MUTEX_INITIALIZER; #endif FFI_PLUGIN_EXPORT -int SpawnJvm(JavaVMInitArgs* initArgs) { +long SpawnJvm(JavaVMInitArgs* initArgs) { if (jni_context.jvm != NULL) { return DART_JNI_SINGLETON_EXISTS; } @@ -262,11 +262,11 @@ JniExceptionDetails GetExceptionDetails(jthrowable exception) { } // These will not be required after migrating to Dart-only bindings. -FFI_PLUGIN_EXPORT JniContext* GetJniContextPtr() { +FFI_PLUGIN_EXPORT JniContext* GetJniContextPtr(void) { return jni; } -FFI_PLUGIN_EXPORT JNIEnv* GetJniEnv() { +FFI_PLUGIN_EXPORT JNIEnv* GetJniEnv(void) { if (jni_context.jvm == NULL) { return NULL; } diff --git a/pkgs/jni/src/dartjni.h b/pkgs/jni/src/dartjni.h index 53a4ad15d..a784b4148 100644 --- a/pkgs/jni/src/dartjni.h +++ b/pkgs/jni/src/dartjni.h @@ -171,7 +171,7 @@ static inline void detach_thread(void* data) { } } -static inline void attach_thread() { +static inline void attach_thread(void) { if (jniEnv == NULL) { (*jni->jvm)->AttachCurrentThread(jni->jvm, __ENVP_CAST & jniEnv, NULL); #ifndef _WIN32 @@ -237,7 +237,7 @@ FFI_PLUGIN_EXPORT JNIEnv* GetJniEnv(void); /// Returns JNI_OK on success, and one of the documented JNI error codes on /// failure. It returns DART_JNI_SINGLETON_EXISTS if an attempt to spawn multiple /// JVMs is made, even if the underlying API potentially supports multiple VMs. -FFI_PLUGIN_EXPORT int SpawnJvm(JavaVMInitArgs* args); +FFI_PLUGIN_EXPORT long SpawnJvm(JavaVMInitArgs* args); /// Returns Application classLoader (on Android), /// which can be used to load application and platform classes. @@ -322,7 +322,7 @@ static inline jobject to_global_ref(jobject ref) { return g; } -static inline jthrowable check_exception() { +static inline jthrowable check_exception(void) { jthrowable exception = (*jniEnv)->ExceptionOccurred(jniEnv); if (exception != NULL) (*jniEnv)->ExceptionClear(jniEnv); if (exception == NULL) return NULL; diff --git a/pkgs/jni/src/third_party/global_jni_env.c b/pkgs/jni/src/third_party/global_jni_env.c index 2e7e44829..176feb4d4 100644 --- a/pkgs/jni/src/third_party/global_jni_env.c +++ b/pkgs/jni/src/third_party/global_jni_env.c @@ -31,7 +31,7 @@ #include "global_jni_env.h" -JniResult globalEnv_GetVersion() { +JniResult globalEnv_GetVersion(void) { attach_thread(); jint _result = (*jniEnv)->GetVersion(jniEnv); return (JniResult){.value = {.i = _result}, .exception = NULL}; @@ -150,7 +150,7 @@ JniResult globalEnv_ThrowNew(jclass clazz, char* message) { return (JniResult){.value = {.i = _result}, .exception = NULL}; } -JniResult globalEnv_ExceptionOccurred() { +JniResult globalEnv_ExceptionOccurred(void) { attach_thread(); jthrowable _result = (*jniEnv)->ExceptionOccurred(jniEnv); jthrowable _exception = check_exception(); @@ -161,13 +161,13 @@ JniResult globalEnv_ExceptionOccurred() { return (JniResult){.value = {.l = _result}, .exception = NULL}; } -jthrowable globalEnv_ExceptionDescribe() { +jthrowable globalEnv_ExceptionDescribe(void) { attach_thread(); (*jniEnv)->ExceptionDescribe(jniEnv); return NULL; } -jthrowable globalEnv_ExceptionClear() { +jthrowable globalEnv_ExceptionClear(void) { attach_thread(); (*jniEnv)->ExceptionClear(jniEnv); return NULL; @@ -2378,7 +2378,7 @@ jthrowable globalEnv_DeleteWeakGlobalRef(jweak obj) { return NULL; } -JniResult globalEnv_ExceptionCheck() { +JniResult globalEnv_ExceptionCheck(void) { attach_thread(); jboolean _result = (*jniEnv)->ExceptionCheck(jniEnv); jthrowable _exception = check_exception(); @@ -2784,7 +2784,7 @@ GlobalJniEnvStruct globalJniEnv = { .SetDoubleArrayElement = globalEnv_SetDoubleArrayElement, }; FFI_PLUGIN_EXPORT -GlobalJniEnvStruct* GetGlobalEnv() { +GlobalJniEnvStruct* GetGlobalEnv(void) { if (jni->jvm == NULL) { return NULL; } diff --git a/pkgs/jni/src/third_party/global_jni_env.h b/pkgs/jni/src/third_party/global_jni_env.h index c27bc0687..4d5546ed6 100644 --- a/pkgs/jni/src/third_party/global_jni_env.h +++ b/pkgs/jni/src/third_party/global_jni_env.h @@ -37,7 +37,7 @@ typedef struct GlobalJniEnvStruct { void* reserved1; void* reserved2; void* reserved3; - JniResult (*GetVersion)(); + JniResult (*GetVersion)(void); JniClassLookupResult (*DefineClass)(char* name, jobject loader, jbyte* buf, @@ -55,9 +55,9 @@ typedef struct GlobalJniEnvStruct { jboolean isStatic); JniResult (*Throw)(jthrowable obj); JniResult (*ThrowNew)(jclass clazz, char* message); - JniResult (*ExceptionOccurred)(); - jthrowable (*ExceptionDescribe)(); - jthrowable (*ExceptionClear)(); + JniResult (*ExceptionOccurred)(void); + jthrowable (*ExceptionDescribe)(void); + jthrowable (*ExceptionClear)(void); jthrowable (*FatalError)(char* msg); JniResult (*PushLocalFrame)(jint capacity); JniResult (*PopLocalFrame)(jobject result); @@ -438,7 +438,7 @@ typedef struct GlobalJniEnvStruct { jthrowable (*ReleaseStringCritical)(jstring str, jchar* carray); JniResult (*NewWeakGlobalRef)(jobject obj); jthrowable (*DeleteWeakGlobalRef)(jweak obj); - JniResult (*ExceptionCheck)(); + JniResult (*ExceptionCheck)(void); JniResult (*NewDirectByteBuffer)(void* address, jlong capacity); JniPointerResult (*GetDirectBufferAddress)(jobject buf); JniResult (*GetDirectBufferCapacity)(jobject buf); @@ -474,7 +474,7 @@ typedef struct GlobalJniEnvStruct { jsize index, jdouble element); } GlobalJniEnvStruct; -FFI_PLUGIN_EXPORT GlobalJniEnvStruct* GetGlobalEnv(); +FFI_PLUGIN_EXPORT GlobalJniEnvStruct* GetGlobalEnv(void); FFI_PLUGIN_EXPORT JniResult globalEnv_NewObject(jclass clazz, jmethodID methodID, ...); diff --git a/pkgs/jni/tool/wrapper_generators/generate_c_extensions.dart b/pkgs/jni/tool/wrapper_generators/generate_c_extensions.dart index 51be17f42..5e69fb5f5 100644 --- a/pkgs/jni/tool/wrapper_generators/generate_c_extensions.dart +++ b/pkgs/jni/tool/wrapper_generators/generate_c_extensions.dart @@ -45,7 +45,7 @@ const wrapperDeclIncludes = ''' const wrapperGetter = ''' FFI_PLUGIN_EXPORT -$wrapperName* GetGlobalEnv() { +$wrapperName* GetGlobalEnv(void) { if (jni->jvm == NULL) { return NULL; } @@ -54,7 +54,7 @@ $wrapperName* GetGlobalEnv() { '''; const wrapperGetterDecl = ''' -FFI_PLUGIN_EXPORT $wrapperName* GetGlobalEnv(); +FFI_PLUGIN_EXPORT $wrapperName* GetGlobalEnv(void); '''; bool hasVarArgs(String name) { @@ -99,10 +99,11 @@ String getFunctionFieldDecl(Member field, {required bool isField}) { final resultWrapper = getResultWrapper(getCType(functionType.returnType)); final name = field.name; final withVarArgs = hasVarArgs(name); - final params = functionType.parameters + var params = functionType.parameters .map((param) => '${getCType(param.type)} ${param.name}') .join(', ') + (withVarArgs ? ', ...' : ''); + if (params.isEmpty) params = 'void'; final willExport = withVarArgs ? 'FFI_PLUGIN_EXPORT ' : ''; if (isField) { return '${resultWrapper.returnType} (*$name)($params);'; @@ -238,11 +239,12 @@ String? getWrapperFunc(Member field) { final wrapperName = getWrapperFuncName(field.name); final returnType = getCType(outerFunctionType.returnType); final withVarArgs = hasVarArgs(field.name); - final params = [ + var params = [ ...outerFunctionType.parameters .map((param) => '${getCType(param.type)} ${param.name}'), if (withVarArgs) '...', ].join(', '); + if (params.isEmpty) params = 'void'; var returnCapture = returnType == 'void' ? '' : '$returnType $resultVar ='; if (constBufferReturningFunctions.contains(field.name)) { returnCapture = 'const $returnCapture'; diff --git a/pkgs/jnigen/README.md b/pkgs/jnigen/README.md index b303604e3..cc5455c8b 100644 --- a/pkgs/jnigen/README.md +++ b/pkgs/jnigen/README.md @@ -121,7 +121,7 @@ The complete example can be found in [jnigen/example/in_app_java](jnigen/example | Android | n/a | Supported | | Linux | Supported | Supported | | Windows | Supported | Supported | -| MacOS | Supported | Not Yet | +| MacOS | Supported | Supported | On Android, the flutter application runs embedded in Android JVM. On other platforms, a JVM needs to be explicitly spawned using `Jni.spawn`. `package:jni` provides the infrastructure for initializing and managing the JNI on both Android and Non-Android platforms. @@ -162,6 +162,14 @@ If JAVA_HOME not set, find the `java.exe` executable and set the environment var ### C tooling CMake and a standard C toolchain are required to build `package:jni`. +### macOS considerations + +In order to be able to spawn JVM from a Flutter macOS application, you must disable the sandboxing in `Release.entitlements`/`DebugProfile.entitlements` of your project. + +```xml +com.apple.security.app-sandbox +``` + ## FAQs #### I am getting ClassNotFoundError at runtime. diff --git a/pkgs/jnigen/test/simple_package_test/runtime_test_registrant.dart b/pkgs/jnigen/test/simple_package_test/runtime_test_registrant.dart index bc257b6b0..ad20b2c69 100644 --- a/pkgs/jnigen/test/simple_package_test/runtime_test_registrant.dart +++ b/pkgs/jnigen/test/simple_package_test/runtime_test_registrant.dart @@ -7,6 +7,7 @@ import 'dart:io'; import 'dart:isolate'; import 'package:jni/jni.dart'; +import 'package:path/path.dart' show join; import 'package:test/test.dart'; import '../test_util/callback_types.dart'; @@ -569,15 +570,18 @@ void registerTests(String groupName, TestRunnerCallback test) { $MyInterfaceImpl( voidCallback: voidCallbackResult.complete, stringCallback: (s) { + Jni.setDylibDir(dylibDir: join('build', 'jni_libs')); return (s.toDartString(releaseOriginal: true) * 2).toJString(); }, varCallback: (JInteger t) { + Jni.setDylibDir(dylibDir: join('build', 'jni_libs')); final result = (t.intValue(releaseOriginal: true) * 2).toJInteger(); varCallbackResult.complete(result); return result; }, manyPrimitives: (a, b, c, d) { + Jni.setDylibDir(dylibDir: join('build', 'jni_libs')); if (b) { final result = a + c + d.toInt(); manyPrimitivesResult.complete(result); @@ -696,6 +700,7 @@ void registerTests(String groupName, TestRunnerCallback test) { final stringConverter = StringConverter.implement($StringConverterImpl( parseToInt: (s) { + Jni.setDylibDir(dylibDir: join('build', 'jni_libs')); final value = int.tryParse(s.toDartString()); if (value == null) { // ignore: only_throw_errors @@ -713,6 +718,7 @@ void registerTests(String groupName, TestRunnerCallback test) { JObject future, JObjType<$T> T) async { final receivePort = ReceivePort(); await Isolate.spawn((sendPort) { + Jni.setDylibDir(dylibDir: join('build', 'jni_libs')); final futureClass = JClass.forName('java/util/concurrent/Future'); final getMethod = futureClass.instanceMethodId('get', '()Ljava/lang/Object;');