move samples to Samples/

Author: ktoso

.gitignore

@@ -14,6 +14,7 @@ BuildLogic/out/
 # Ignore gradle build artifacts
 .gradle
 **/build/
+lib/
 
 # Ignore package resolved
 Package.resolved
@@ -28,5 +29,4 @@ Package.resolved
 .gradletasknamecache
 
 # Ignore generated sources
-JavaSwiftKitDemo/src/generated/*
-SwiftKitExample/src/generated/**/*
+**/generated/

BuildLogic/src/main/kotlin/build-logic.java-common-conventions.gradle.kts

@@ -12,6 +12,8 @@
 //
 //===----------------------------------------------------------------------===//
 
+import java.util.*
+
 plugins {
     java
 }
@@ -40,16 +42,39 @@ tasks.withType(JavaCompile::class).forEach {
     it.options.compilerArgs.add("-Xlint:preview")
 }
 
+
+fun javaLibraryPaths(): List<String> {
+    val osName = System.getProperty("os.name")
+    val osArch = System.getProperty("os.arch")
+    val isLinux = osName.lowercase(Locale.getDefault()).contains("linux")
+
+    return listOf(
+        if (osName.lowercase(Locale.getDefault()).contains("linux")) {
+            """$rootDir/.build/$osArch-unknown-linux-gnu/debug/"""
+        } else {
+            if (osArch.equals("aarch64")) {
+                """$rootDir/.build/arm64-apple-macosx/debug/"""
+            } else {
+                """$rootDir/.build/$osArch-apple-macosx/debug/"""
+            }
+        },
+        if (isLinux) {
+            "/usr/lib/swift/linux"
+        } else {
+            // assume macOS
+            "/usr/lib/swift/"
+        }
+    )
+}
+
+
 // Configure paths for native (Swift) libraries
 tasks.test {
     jvmArgs(
         "--enable-native-access=ALL-UNNAMED",
 
         // Include the library paths where our dylibs are that we want to load and call
-        "-Djava.library.path=" + listOf(
-            """$rootDir/.build/arm64-apple-macosx/debug/""",
-            "/usr/lib/swift/"
-        ).joinToString(File.pathSeparator)
+        "-Djava.library.path=" + javaLibraryPaths().joinToString(File.pathSeparator)
     )
 }
 
@@ -60,10 +85,11 @@ tasks.withType<Test> {
 }
 
 
-val buildSwiftJExtract = tasks.register<Exec>("buildSwiftJExtract") {
-    description = "Builds Swift targets, including jextract-swift"
+// TODO: This is a crude workaround, we'll remove 'make' soon and properly track build dependencies
+val buildSwiftJExtract = tasks.register<Exec>("buildMake") {
+    description = "Triggers 'make' build"
 
-    workingDir("..")
+    workingDir(rootDir)
     commandLine("make")
 }
 

Makefile

@@ -37,17 +37,16 @@ BUILD_DIR := .build/$(ARCH_SUBDIR)-apple-macosx
 LIB_SUFFIX := dylib
 endif
 
+SAMPLES_DIR := "Samples"
+
 
 all: generate-all
 
 $(BUILD_DIR)/debug/libJavaKit.$(LIB_SUFFIX) $(BUILD_DIR)/debug/Java2Swift:
 	swift build
 
-./JavaSwiftKitDemo/build/classes/java/main/com/example/swift/HelloSubclass.class: JavaSwiftKitDemo/src/main/java/com/example/swift
-	./gradlew build
-
-run: $(BUILD_DIR)/debug/libJavaKit.$(LIB_SUFFIX) $(BUILD_DIR)/debug/libExampleSwiftLibrary.$(LIB_SUFFIX) JavaSwiftKitDemo/src/main/java/com/example/swift
-	java -cp JavaSwiftKitDemo/build/classes/java/main -Djava.library.path=$(BUILD_DIR)/debug/ com.example.swift.HelloSwift
+run: $(BUILD_DIR)/debug/libJavaKit.$(LIB_SUFFIX) $(BUILD_DIR)/debug/libExampleSwiftLibrary.$(LIB_SUFFIX)
+	./gradlew Samples:JavaKitSampleApp:run
 
 Java2Swift: $(BUILD_DIR)/debug/Java2Swift
 
@@ -71,7 +70,7 @@ generate-all: generate-JavaKit generate-JavaKitReflection generate-JavaKitJar ge
 			  jextract-swift
 clean:
 	rm -rf .build; \
-	rm -rf SwiftKitExample/src/generated/java/*
+	rm -rf Samples/SwiftKitExampleApp/src/generated/java/*
 
 format:
 	swift format --recursive . -i
@@ -106,14 +105,14 @@ jextract-run: jextract-swift generate-JExtract-interface-files
 	swift run jextract-swift  \
 		--package-name com.example.swift.generated \
 		--swift-module ExampleSwiftLibrary \
-		--output-directory SwiftKitExample/src/generated/java \
+		--output-directory ${SAMPLES_DIR}/SwiftKitSampleApp/src/generated/java \
 		$(BUILD_DIR)/jextract/ExampleSwiftLibrary/MySwiftLibrary.swiftinterface; \
 	swift run jextract-swift \
 		--package-name org.swift.swiftkit.generated \
 		--swift-module SwiftKitSwift \
-		--output-directory SwiftKitExample/src/generated/java \
+		--output-directory ${SAMPLES_DIR}/SwiftKitSampleApp/src/generated/java \
 		$(BUILD_DIR)/jextract/SwiftKitSwift/SwiftKit.swiftinterface
 
 
 jextract-run-java: jextract-swift generate-JExtract-interface-files
-	./gradlew run SwiftKitExample
+	./gradlew Samples:SwiftKitSampleApp:run

Samples/JavaKitSampleApp/build.gradle

@@ -0,0 +1,76 @@
+//===----------------------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+plugins {
+    id("build-logic.java-application-conventions")
+}
+
+group = "org.swift.javakit"
+version = "1.0-SNAPSHOT"
+
+repositories {
+    mavenCentral()
+}
+
+java {
+    toolchain {
+        languageVersion.set(JavaLanguageVersion.of(22))
+    }
+}
+
+dependencies {
+    implementation(project(':SwiftKit'))
+
+    testImplementation(platform("org.junit:junit-bom:5.10.0"))
+    testImplementation("org.junit.jupiter:junit-jupiter")
+}
+
+tasks.test {
+    useJUnitPlatform()
+}
+
+def javaLibraryPaths() {
+    def osName = System.getProperty("os.name")
+    def osArch = System.getProperty("os.arch")
+    def isLinux = osName.toLowerCase(Locale.getDefault()).contains("linux")
+
+    return [
+            osName.toLowerCase(Locale.getDefault()).contains("linux") ?
+                    "${rootDir}/.build/${osArch}-unknown-linux-gnu/debug/" :
+                    osArch == "aarch64" ?
+                            "${rootDir}/.build/arm64-apple-macosx/debug/" :
+                            "${rootDir}/.build/${osArch}-apple-macosx/debug/",
+            isLinux ?
+                    "/usr/lib/swift/linux" :
+                    // assume macOS
+                    "/usr/lib/swift/"
+    ]
+}
+
+application {
+    mainClass = "com.example.swift.JavaKitSampleMain"
+
+    // In order to silence:
+    //   WARNING: A restricted method in java.lang.foreign.SymbolLookup has been called
+    //   WARNING: java.lang.foreign.SymbolLookup::libraryLookup has been called by org.example.swift.JavaKitExample in an unnamed module
+    //   WARNING: Use --enable-native-access=ALL-UNNAMED to avoid a warning for callers in this module
+    //   WARNING: Restricted methods will be blocked in a future release unless native access is enabled
+    // FIXME: Find out the proper solution to this
+    applicationDefaultJvmArgs = [
+        "--enable-native-access=ALL-UNNAMED",
+
+        // Include the library paths where our dylibs are that we want to load and call
+        "-Djava.library.path=" + javaLibraryPaths().join(":")
+    ]
+}

SwiftKitExample/src/main/java/com/example/swift/HelloSubclass.java renamed to Samples/JavaKitSampleApp/src/main/java/com/example/swift/HelloSubclass.java

@@ -27,11 +27,6 @@ public HelloSwift() {
         this.value = initialValue;
     }
 
-    public static void main(String[] args) {
-        int result = new HelloSubclass("Swift").sayHello(17, 25);
-        System.out.println("sayHello(17, 25) = " + result);
-    }
-
     public native int sayHello(int x, int y);
     public native String throwMessageFromSwift(String message) throws Exception;
 

SwiftKitExample/src/main/java/com/example/swift/HelloSwift.java renamed to Samples/JavaKitSampleApp/src/main/java/com/example/swift/HelloSwift.java

@@ -0,0 +1,27 @@
+//===----------------------------------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+package com.example.swift;
+
+/**
+ * This sample shows off a {@link HelloSwift} type which is partially implemented in Swift.
+ * For the Swift implementation refer to
+ */
+public class JavaKitSampleMain {
+
+    public static void main(String[] args) {
+        int result = new HelloSubclass("Swift").sayHello(17, 25);
+        System.out.println("sayHello(17, 25) = " + result);
+    }
+}

Samples/JavaKitSampleApp/src/main/java/com/example/swift/JavaKitSampleMain.java

@@ -16,7 +16,7 @@ plugins {
     id("build-logic.java-application-conventions")
 }
 
-group = "org.swift.javakit"
+group = "org.swift.swiftkit"
 version = "1.0-SNAPSHOT"
 
 repositories {
@@ -61,12 +61,16 @@ configurations {
     generatedRuntimeOnly.extendsFrom(mainRuntimeOnly)
 }
 
+tasks.named("compileJava").configure {
+    dependsOn("jextract")
+}
+
 tasks.test {
     useJUnitPlatform()
 }
 
 application {
-    mainClass = "com.example.HelloJava2Swift"
+    mainClass = "com.example.swift.HelloJava2Swift"
 
     // In order to silence:
     //   WARNING: A restricted method in java.lang.foreign.SymbolLookup has been called
@@ -79,7 +83,7 @@ application {
 
         // Include the library paths where our dylibs are that we want to load and call
         "-Djava.library.path=" + [
-            """$rootDir/.build/arm64-apple-macosx/debug/""",
+            "$rootDir/.build/arm64-apple-macosx/debug/",
             "/usr/lib/swift/"
         ].join(":"),
 
@@ -88,13 +92,16 @@ application {
     ]
 }
 
-task printSourceSetInformation() {
-    doLast{
-        sourceSets.each { srcSet ->
-            println "["+srcSet.name+"]"
-            print "--> Source directories: "+srcSet.allJava.srcDirs+"\n"
-            print "--> Output directories: "+srcSet.output.classesDirs.files+"\n"
-            println ""
-        }
-    }
+task jextract(type: Exec) {
+    description = "Extracts Java accessor sources using jextract"
+    outputs.dir(layout.buildDirectory.dir("generated"))
+    inputs.dir("$rootDir/Sources/ExampleSwiftLibrary")
+
+    workingDir = rootDir
+    commandLine "make"
+    args "jextract-run"
+}
+
+tasks.named("compileGeneratedJava").configure {
+    dependsOn jextract
 }

SwiftKitExample/build.gradle renamed to Samples/SwiftKitSampleApp/build.gradle

@@ -12,9 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-package com.example;
-
-import org.swift.swiftkit.SwiftKit;
+package com.example.swift;
 
 public class CallMe {
     public static String callMeStatic() {

SwiftKitExample/src/main/java/com/example/CallMe.java renamed to Samples/SwiftKitSampleApp/src/main/java/com/example/swift/CallMe.java

@@ -12,7 +12,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-package com.example;
+package com.example.swift;
 
 // Import swift-extract generated sources
 import com.example.swift.generated.ExampleSwiftLibrary;

SwiftKitExample/src/main/java/com/example/HelloJava2Swift.java renamed to Samples/SwiftKitSampleApp/src/main/java/com/example/swift/HelloJava2Swift.java

@@ -15,12 +15,9 @@
 package org.swift.swiftkit;
 
 import com.example.swift.generated.MySwiftClass;
-import com.example.swift.ManualMySwiftClass;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 
-import java.lang.foreign.Arena;
-
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 

SwiftKitExample/src/main/java/com/example/swift/ManualJavaKitExample.java renamed to Samples/SwiftKitSampleApp/src/main/java/com/example/swift/ManualJavaKitExample.java

@@ -28,7 +28,11 @@ public func helloWorld() {
 }
 
 public func globalTakeInt(i: Int) {
-  p("int:\(i)")
+  p("i:\(i)")
+}
+
+public func globalTakeIntInt(i: Int, j: Int) {
+  p("i:\(i), j:\(j)")
 }
 
 public class MySwiftClass {

SwiftKitExample/src/main/java/com/example/swift/ManualMySwiftClass.java renamed to Samples/SwiftKitSampleApp/src/main/java/com/example/swift/ManualMySwiftClass.java

@@ -36,7 +36,7 @@ public struct SwiftToJava: AsyncParsableCommand {
 
   // TODO: Once we ship this, make this `.warning` by default
   @Option(name: .shortAndLong, help: "Configure the level of lots that should be printed")
-  var logLevel: Logger.Level = .trace
+  var logLevel: Logger.Level = .notice
 
   @Argument(help: "The Swift interface files to export to Java.")
   var swiftInterfaceFiles: [String]

SwiftKitExample/src/main/java/com/example/swift/Manual_MySwiftClass.java renamed to Samples/SwiftKitSampleApp/src/main/java/com/example/swift/Manual_MySwiftClass.java

@@ -110,7 +110,7 @@ extension Swift2JavaTranslator {
   }
 
   public func postProcessImportedDecls() async throws {
-    log.info(
+    log.debug(
       "Post process imported decls...",
       metadata: [
         "types": "\(importedTypes.count)",
@@ -143,7 +143,7 @@ extension Swift2JavaTranslator {
 
       log.info("Mapping members of: \(tyDecl.swiftTypeName)")
       tyDecl.initializers = try await tyDecl.initializers._mapAsync { initDecl in
-        dylib.log.logLevel = .trace
+        dylib.log.logLevel = .info
 
         let initDecl = try await dylib.fillInAllocatingInitMangledName(initDecl)
         log.info("Mapped initializer '\(initDecl.identifier)' -> '\(initDecl.swiftMangledName)'")