Merge branch 'main' into wip-arenas

Author: ktoso

.github/workflows/pull_request.yml

@@ -2,7 +2,7 @@ name: pull_request
 
 on:
   pull_request:
-    types: [ opened, reopened, synchronize ]
+    types: [opened, reopened, synchronize]
 
 jobs:
   soundness:
@@ -12,19 +12,16 @@ jobs:
       # FIXME: Something is off with the format task and it gets "stuck", need to investigate
       format_check_enabled: false
       license_header_check_project_name: Swift.org
-      # FIXME: we're about to remove _Subprocess immediately anyway, so rather than fixing it one by one remove this adjusted list and use the default again ASAP
-      # swift-subprocess includes the word "kill" because SIGKILL signal handling so we allow it
-      unacceptable_language_check_word_list: "blacklist whitelist slave master sane sanity insane insanity killed killing hang hung hanged hanging" #ignore-unacceptable-language
 
   test-java:
     name: Java tests (swift:${{ matrix.swift_version }} jdk:${{matrix.jdk_vendor}} os:${{ matrix.os_version }})
     runs-on: ubuntu-latest
     strategy:
       fail-fast: true
       matrix:
-        swift_version: [ 'nightly-main' ]
-        os_version: [ 'jammy' ]
-        jdk_vendor: [ 'Corretto' ]
+        swift_version: ['nightly-main']
+        os_version: ['jammy']
+        jdk_vendor: ['Corretto']
     container:
       image: ${{ (contains(matrix.swift_version, 'nightly') && 'swiftlang/swift') || 'swift' }}:${{ matrix.swift_version }}-${{ matrix.os_version }}
     env:
@@ -68,9 +65,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        swift_version: [ 'nightly-main' ]
-        os_version: [ 'jammy' ]
-        jdk_vendor: [ 'Corretto' ]
+        swift_version: ['nightly-main']
+        os_version: ['jammy']
+        jdk_vendor: ['Corretto']
     container:
       image: ${{ (contains(matrix.swift_version, 'nightly') && 'swiftlang/swift') || 'swift' }}:${{ matrix.swift_version }}-${{ matrix.os_version }}
     env:
@@ -106,6 +103,9 @@ jobs:
       # run the actual build
       - name: Generate sources (make) (Temporary)
         # TODO: this should be triggered by the respective builds
-        run: "make jextract-run"
+        run: "make jextract-generate"
       - name: Test Swift
         run: "swift test"
+      - name: Build (Swift) Sample Apps
+        run: |
+          find Samples/ -name Package.swift -maxdepth 2 -exec swift build --package-path $(dirname {}) \;;

.licenseignore

@@ -5,6 +5,7 @@
 .swift-format
 .github/*
 *.md
+**/*.config
 CONTRIBUTORS.txt
 LICENSE.txt
 NOTICE.txt

Makefile

@@ -53,34 +53,39 @@ endif
 
 SAMPLES_DIR := "Samples"
 
-all: generate-all
+all:
+	@echo "Welcome to swift-java! There are several makefile targets to choose from:"
+	@echo "  javakit-run: Run the JavaKit example program that uses Java libraries from Swift."
+	@echo "  javakit-generate: Regenerate the Swift wrapper code for the various JavaKit libraries from Java. This only has to be done when changing the Java2Swift tool."
+	@echo "  jextract-run: Run the Java example code that uses the wrapped Swift library. NOTE: this requires development toolchain described in the README."
+	@echo "  jextract-generate: Generate Java wrapper code for the example Swift library allowing Swift to be called from Java. NOTE: this requires development toolchain described in the README."
 
 $(BUILD_DIR)/debug/libJavaKit.$(LIB_SUFFIX) $(BUILD_DIR)/debug/Java2Swift:
 	swift build
 
-run: $(BUILD_DIR)/debug/libJavaKit.$(LIB_SUFFIX) $(BUILD_DIR)/debug/libExampleSwiftLibrary.$(LIB_SUFFIX)
-	./gradlew Samples:JavaKitSampleApp:run
+javakit-run:
+	cd Samples/JavaKitSampleApp && swift build && java -cp .build/plugins/outputs/javakitsampleapp/JavaKitExample/destination/JavaCompilerPlugin/Java -Djava.library.path=.build/debug com.example.swift.JavaKitSampleMain
 
 Java2Swift: $(BUILD_DIR)/debug/Java2Swift
 
 generate-JavaKit: Java2Swift
 	mkdir -p Sources/JavaKit/generated
-	$(BUILD_DIR)/debug/Java2Swift --module-name JavaKit -o Sources/JavaKit/generated java.lang.Object=JavaObject java.util.Enumeration java.lang.Throwable java.lang.Exception java.lang.RuntimeException java.lang.Error=JavaError
+	$(BUILD_DIR)/debug/Java2Swift --module-name JavaKit -o Sources/JavaKit/generated Sources/JavaKit/Java2Swift.config
 
 generate-JavaKitReflection: Java2Swift generate-JavaKit
 	mkdir -p Sources/JavaKitReflection/generated
-	$(BUILD_DIR)/debug/Java2Swift --module-name JavaKitReflection --manifests Sources/JavaKit/generated/JavaKit.swift2java -o Sources/JavaKitReflection/generated java.lang.reflect.Method java.lang.reflect.Type java.lang.reflect.Constructor java.lang.reflect.Parameter java.lang.reflect.ParameterizedType java.lang.reflect.Executable java.lang.reflect.AnnotatedType java.lang.reflect.TypeVariable java.lang.reflect.WildcardType java.lang.reflect.GenericArrayType java.lang.reflect.AccessibleObject java.lang.annotation.Annotation java.lang.reflect.GenericDeclaration java.lang.reflect.Field
+	$(BUILD_DIR)/debug/Java2Swift --module-name JavaKitReflection --depends-on JavaKit=Sources/JavaKit/Java2Swift.config -o Sources/JavaKitReflection/generated Sources/JavaKitReflection/Java2Swift.config
 
 generate-JavaKitJar: Java2Swift generate-JavaKit
 	mkdir -p Sources/JavaKitJar/generated
-	$(BUILD_DIR)/debug/Java2Swift --module-name JavaKitJar --manifests Sources/JavaKit/generated/JavaKit.swift2java -o Sources/JavaKitJar/generated java.util.jar.Attributes java.util.jar.JarEntry	java.util.jar.JarFile java.util.jar.JarInputStream java.util.jar.JarOutputStream java.util.jar.Manifest
+	$(BUILD_DIR)/debug/Java2Swift --module-name JavaKitJar --depends-on JavaKit=Sources/JavaKit/Java2Swift.config -o Sources/JavaKitJar/generated Sources/JavaKitJar/Java2Swift.config
 
 generate-JavaKitNetwork: Java2Swift generate-JavaKit
 	mkdir -p Sources/JavaKitNetwork/generated
-	$(BUILD_DIR)/debug/Java2Swift --module-name JavaKitNetwork --manifests Sources/JavaKit/generated/JavaKit.swift2java -o Sources/JavaKitNetwork/generated java.net.URI java.net.URL java.net.URLClassLoader
+	$(BUILD_DIR)/debug/Java2Swift --module-name JavaKitNetwork --depends-on JavaKit=Sources/JavaKit/Java2Swift.config -o Sources/JavaKitNetwork/generated Sources/JavaKitNetwork/Java2Swift.config
+
+javakit-generate: generate-JavaKit generate-JavaKitReflection generate-JavaKitJar generate-JavaKitNetwork
 
-generate-all: generate-JavaKit generate-JavaKitReflection generate-JavaKitJar generate-JavaKitNetwork \
-			  jextract-swift
 clean:
 	rm -rf .build; \
 	rm -rf Samples/SwiftKitExampleApp/src/generated/java/*
@@ -112,11 +117,11 @@ jextract-swift: generate-JExtract-interface-files
 	swift build
 
 generate-JExtract-interface-files: $(BUILD_DIR)/debug/libJavaKit.$(LIB_SUFFIX)
-	echo "Generate .swiftinterface files..."
+	@echo "Generate .swiftinterface files..."
 	@$(call make_swiftinterface, "ExampleSwiftLibrary", "MySwiftLibrary")
 	@$(call make_swiftinterface, "SwiftKitSwift", "SwiftKit")
 
-jextract-run: jextract-swift generate-JExtract-interface-files
+jextract-generate: jextract-swift generate-JExtract-interface-files
 	swift run jextract-swift  \
 		--package-name com.example.swift.generated \
 		--swift-module ExampleSwiftLibrary \
@@ -129,5 +134,5 @@ jextract-run: jextract-swift generate-JExtract-interface-files
 		$(BUILD_DIR)/jextract/SwiftKitSwift/SwiftKit.swiftinterface
 
 
-jextract-run-java: jextract-swift generate-JExtract-interface-files
+jextract-run: jextract-generate
 	./gradlew Samples:SwiftKitSampleApp:run

Package.swift

@@ -43,11 +43,7 @@ let javaIncludePath = "\(javaHome)/include"
 let package = Package(
   name: "JavaKit",
   platforms: [
-    .macOS(.v13),
-    .iOS(.v13),
-    .tvOS(.v13),
-    .watchOS(.v6),
-    .macCatalyst(.v13),
+    .macOS(.v10_15)
   ],
   products: [
     // ==== JavaKit (i.e. calling Java directly Swift utilities)
@@ -56,6 +52,11 @@ let package = Package(
       targets: ["JavaKit"]
     ),
 
+    .library(
+      name: "JavaRuntime",
+      targets: ["JavaRuntime"]
+    ),
+
     .library(
       name: "JavaKitJar",
       targets: ["JavaKitReflection"]
@@ -86,6 +87,22 @@ let package = Package(
       targets: ["Java2Swift"]
     ),
 
+    // ==== Plugin for building Java code
+    .plugin(
+        name: "JavaCompilerPlugin",
+        targets: [
+            "JavaCompilerPlugin"
+        ]
+    ),
+
+    // ==== Plugin for wrapping Java classes in Swift
+    .plugin(
+        name: "Java2SwiftPlugin",
+        targets: [
+            "Java2SwiftPlugin"
+        ]
+    ),
+
     // ==== jextract-swift (extract Java accessors from Swift interface files)
 
     .executable(
@@ -107,11 +124,6 @@ let package = Package(
 
     // ==== Examples
 
-    .library(
-      name: "JavaKitExample",
-      type: .dynamic,
-      targets: ["JavaKitExample"]
-    ),
     .library(
       name: "ExampleSwiftLibrary",
       type: .dynamic,
@@ -144,7 +156,7 @@ let package = Package(
     .target(
       name: "JavaKit",
       dependencies: ["JavaRuntime", "JavaKitMacros", "JavaTypes"],
-      exclude: ["generated/JavaKit.swift2java"],
+      exclude: ["Java2Swift.config"],
       swiftSettings: [
         .swiftLanguageMode(.v5),
         .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
@@ -153,7 +165,7 @@ let package = Package(
     .target(
       name: "JavaKitJar",
       dependencies: ["JavaKit"],
-      exclude: ["generated/JavaKitJar.swift2java"],
+      exclude: ["Java2Swift.config"],
       swiftSettings: [
         .swiftLanguageMode(.v5),
         .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
@@ -162,7 +174,7 @@ let package = Package(
     .target(
       name: "JavaKitNetwork",
       dependencies: ["JavaKit"],
-      exclude: ["generated/JavaKitNetwork.swift2java"],
+      exclude: ["Java2Swift.config"],
       swiftSettings: [
         .swiftLanguageMode(.v5),
         .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
@@ -171,7 +183,7 @@ let package = Package(
     .target(
       name: "JavaKitReflection",
       dependencies: ["JavaKit"],
-      exclude: ["generated/JavaKitReflection.swift2java"],
+      exclude: ["Java2Swift.config"],
       swiftSettings: [
         .swiftLanguageMode(.v5),
         .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
@@ -197,14 +209,20 @@ let package = Package(
         .linkedLibrary("jvm"),
       ]
     ),
-    .target(
-      name: "JavaKitExample",
-      dependencies: ["JavaKit"],
-      swiftSettings: [
-        .swiftLanguageMode(.v5),
-        .unsafeFlags(["-I\(javaIncludePath)", "-I\(javaPlatformIncludePath)"])
-      ]
+
+    .plugin(
+        name: "JavaCompilerPlugin",
+        capability: .buildTool()
+    ),
+
+    .plugin(
+        name: "Java2SwiftPlugin",
+        capability: .buildTool(),
+        dependencies: [
+          "Java2Swift"
+        ]
     ),
+
     .target(
       name: "ExampleSwiftLibrary",
       dependencies: [],
@@ -230,6 +248,25 @@ let package = Package(
       ]
     ),
 
+    .target(
+      name: "Java2SwiftLib",
+      dependencies: [
+        .product(name: "SwiftBasicFormat", package: "swift-syntax"),
+        .product(name: "SwiftSyntax", package: "swift-syntax"),
+        .product(name: "SwiftSyntaxBuilder", package: "swift-syntax"),
+        "JavaKit",
+        "JavaKitJar",
+        "JavaKitReflection",
+        "JavaKitNetwork",
+        "JavaKitVM",
+        "JavaTypes",
+      ],
+      swiftSettings: [
+        .swiftLanguageMode(.v5),
+        .enableUpcomingFeature("BareSlashRegexLiterals")
+      ]
+    ),
+
     .executableTarget(
       name: "Java2Swift",
       dependencies: [
@@ -239,11 +276,11 @@ let package = Package(
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
         "JavaKit",
         "JavaKitJar",
-        "JavaKitReflection",
         "JavaKitNetwork",
         "JavaKitVM",
-        "JavaTypes",
+        "Java2SwiftLib",
       ],
+
       swiftSettings: [
         .swiftLanguageMode(.v5),
         .enableUpcomingFeature("BareSlashRegexLiterals")
@@ -301,7 +338,15 @@ let package = Package(
         .swiftLanguageMode(.v5)
       ]
     ),
-    
+
+    .testTarget(
+      name: "Java2SwiftTests",
+      dependencies: ["Java2SwiftLib"],
+      swiftSettings: [
+        .swiftLanguageMode(.v5)
+      ]
+    ),
+
     .testTarget(
       name: "JExtractSwiftTests",
       dependencies: [

Plugins/Java2SwiftPlugin/Configuration.swift

@@ -0,0 +1,28 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2024 Apple Inc. and the Swift.org project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of Swift.org project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+
+/// Configuration for the Java2Swift translation tool, provided on a per-target
+/// basis.
+///
+/// Note: there is a copy of this struct in the Java2Swift library. They
+/// must be kept in sync.
+struct Configuration: Codable {
+  /// The Java class path that should be passed along to the Java2Swift tool.
+  var classPath: String? = nil
+
+  /// The Java classes that should be translated to Swift. The keys are
+  /// canonical Java class names (e.g., java.util.Vector) and the values are
+  /// the corresponding Swift names (e.g., JavaVector).
+  var classes: [String: String] = [:]
+}