Merge pull request #137 from Over-Run/lwjgl3

Author: squid233

.github/workflows/publish.yml

@@ -35,8 +35,6 @@ jobs:
         uses: gradle/actions/setup-gradle@v4
         with:
           cache-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }}
-      - name: Download natives
-        run: ./gradlew downloadLatestNatives
       - name: Build with Gradle Wrapper
         run: ./gradlew build
       - name: Stage

README.md

@@ -8,6 +8,8 @@
 
 ## Overview
 
+[//]: # (TODO: new API)
+
 ```java
 void main() {
     // use MemorySegment to represent memory addresses
@@ -48,14 +50,13 @@ which enables cross-platform access to a set of C library bindings, providing va
 
 [LWJGL 3](https://github.com/LWJGL/lwjgl3) is also a Java library that enables cross-platform access.
 
-LWJGL 3 uses JNI to access native functions, in OverrunGL, however,
-the [FFM API](https://openjdk.org/jeps/454) is used, which makes the linking to native functions more convenient
-as well as providing better memory management.
+LWJGL 3.4.0 still uses JNI-style APIs, but delegates to the FFM backend when on JDK 25 or later.
+OverrunGL provides FFM-style APIs, where raw pointers are represented as `MemorySegment`.
 
 ## Getting Started
 
 You can check the [wiki](https://github.com/Over-Run/overrungl/wiki) or
-the [samples](modules/samples/src/test/java/overrungl/demo). To run samples, check [run.md](doc/build/run.md).
+the [samples](modules/samples/src/test/java/overrungl/demo).
 
 Feel free to ask questions in [discussions](https://github.com/Over-Run/overrungl/discussions) in case you have trouble in setup works, such as environment configuring.
 
@@ -76,7 +77,8 @@ dependencies {
     implementation(platform("io.github.over-run:overrungl-bom:<VERSION>"))
     implementation("io.github.over-run:overrungl")
     implementation("io.github.over-run:overrungl-glfw")
-    runtimeOnly("io.github.over-run:overrungl-glfw::natives-<OS>-<ARCH>")
+    implementation(platform("org.lwjgl:lwjgl-bom:<VERSION>"))
+    runtimeOnly("org.lwjgl:lwjgl-glfw::natives-<OS>-<ARCH>")
 }
 ```
 
@@ -89,7 +91,7 @@ Add this maven repository to use snapshot versions:
 
 ```kotlin
 repositories {
-    maven("https://central.sonatype.com/repository/maven-snapshots/")
+    maven("https://central.sonatype.com/repository/maven-snapshots")
 }
 ```
 

SECURITY.md

@@ -4,9 +4,11 @@
 
 Only the latest version will be supported as we are currently working on 0.x versions.
 
-| Version | Supported          |
-|---------|--------------------|
-| 0.1.x   | :white_check_mark: |
+| Version       | Supported          |
+|---------------|--------------------|
+|               |                    |
+| 0.3.x         | :heavy_check_mark: |
+| 0.1.x ~ 0.2.x | :x:                |
 
 ## Reporting a Vulnerability
 

build.gradle.kts

@@ -1,18 +1,6 @@
-import groovy.json.JsonSlurper
-import org.gradle.kotlin.dsl.support.unzipTo
 import org.jreleaser.model.Active
-import java.net.URI
 import java.net.http.HttpClient
-import java.net.http.HttpRequest
-import java.net.http.HttpResponse
-import java.nio.file.Files
-import java.security.DigestInputStream
-import java.security.MessageDigest
 import java.time.LocalDate
-import kotlin.io.path.createDirectories
-import kotlin.io.path.exists
-import kotlin.io.path.writeText
-import kotlin.jvm.optionals.getOrNull
 
 plugins {
     `java-platform`
@@ -142,196 +130,6 @@ jreleaser {
     }
 }
 
-tasks.register("downloadLatestNatives") {
-    val token = rootProject.findProperty("overrungl.native.download.github.token") as String?
-        ?: System.getProperty("OVERRUNGL_NATIVE_DOWNLOAD_GITHUB_TOKEN")
-        ?: System.getenv("OVERRUNGL_NATIVE_DOWNLOAD_GITHUB_TOKEN")
-    val nativesPath = rootDir.resolve("natives").toPath()
-    val nativesInfoPath = nativesPath.resolve("info")
-    val nativesInfoETagPath = nativesInfoPath.resolve("etag.json")
-    val nativesInfoBindingJsonMap = NativeBinding.entries.associateWith { binding ->
-        nativesInfoPath.resolve("${binding.bindingName}.json")
-    }
-    val nativesZipETagPath = nativesPath.resolve("etag.json")
-    val nativesBindingZipMap = NativeBinding.entries.associateWith { binding ->
-        nativesPath.resolve("${binding.bindingName}.zip")
-    }
-
-    doLast {
-        suggestGitHubToken(token)
-
-        nativesPath.createDirectories()
-        nativesInfoPath.createDirectories()
-
-        println("Downloading latest native library builds")
-
-        val httpClient = HttpClient.newBuilder()
-            .followRedirects(HttpClient.Redirect.NORMAL)
-            .build()
-
-        // https://docs.github.com/en/rest/using-the-rest-api/best-practices-for-using-the-rest-api?apiVersion=2022-11-28
-
-        // ETag
-        val infoETagMap = mutableMapOf<String, String>()
-        if (nativesInfoETagPath.exists()) {
-            val map = JsonSlurper().parse(nativesInfoETagPath) as Map<*, *>
-            map.forEach { (k, v) -> infoETagMap[k as String] = v as String }
-        }
-        val zipETagMap = mutableMapOf<String, String>()
-        if (nativesZipETagPath.exists()) {
-            val map = JsonSlurper().parse(nativesZipETagPath) as Map<*, *>
-            map.forEach { (k, v) -> zipETagMap[k as String] = v as String }
-        }
-
-        // fetch release info
-        NativeBinding.entries.forEach { binding ->
-            println("Fetching release information for ${binding.bindingName} from ${binding.repo}")
-
-            val request = HttpRequest.newBuilder()
-                .uri(URI.create("https://api.github.com/repos/${binding.repo}/releases/latest"))
-                .header("Accept", "application/vnd.github+json")
-                .also {
-                    if (token != null) {
-                        it.header("Authorization", "Bearer $token")
-                    }
-                }
-                .header("X-GitHub-Api-Version", "2022-11-28")
-                .also {
-                    infoETagMap[binding.bindingName].also { eTag ->
-                        if (eTag != null && nativesInfoBindingJsonMap[binding]!!.exists()) {
-                            it.header("if-none-match", "\"$eTag\"")
-                        }
-                    }
-                }
-                .build()
-            val response = httpClient.send(request, HttpResponse.BodyHandlers.ofString())
-
-            if (response.statusCode() == 304) {
-                println("Skipped for ${binding.bindingName}.json because it is not modified")
-                return@forEach
-            }
-
-            if (response.statusCode() != 200) {
-                System.err.println("warning: failed to download ${binding.bindingName}.json; response code: ${response.statusCode()}")
-                return@forEach
-            }
-
-            val eTag = response.headers().firstValue("etag").getOrNull()
-            if (eTag != null) {
-                infoETagMap[binding.bindingName] = eTag.substring(1, eTag.length - 1)
-            }
-
-            nativesInfoBindingJsonMap[binding]!!.writeText(response.body())
-        }
-
-        // cache info ETag
-        println("Caching release information")
-        nativesInfoETagPath.writeText(buildString {
-            append("{")
-            infoETagMap.entries.joinTo(this, separator = ",") {
-                "\"${it.key}\":\"${it.value}\""
-            }
-            append("}")
-        })
-
-
-        // download assets
-        val invalidZips = mutableListOf<String>()
-        NativeBinding.entries.forEach { binding ->
-            println("Downloading asset for ${binding.bindingName}")
-
-            val map = JsonSlurper().parse(nativesInfoBindingJsonMap[binding]!!) as Map<*, *>
-            val assets = (map["assets"] as List<*>).let { it.map { e -> e as Map<*, *> } }
-            val asset = assets.first { it["name"] == "${binding.bindingName}.zip" }
-            val zipPath = nativesBindingZipMap[binding]!!
-
-            val request = HttpRequest.newBuilder()
-                .uri(URI.create(asset["url"] as String))
-                .header("Accept", "application/octet-stream")
-                .also {
-                    if (token != null) {
-                        it.header("Authorization", "Bearer $token")
-                    }
-                }
-                .header("X-GitHub-Api-Version", "2022-11-28")
-                .also {
-                    zipETagMap[binding.bindingName].also { eTag ->
-                        if (eTag != null && zipPath.exists()) {
-                            it.header("if-none-match", "\"$eTag\"")
-                        }
-                    }
-                }
-                .build()
-            val response = httpClient.send(request, HttpResponse.BodyHandlers.ofInputStream())
-
-            if (response.statusCode() == 304) {
-                println("Skipped for ${binding.bindingName}.zip because it is not modified")
-                response.body().close()
-                return@forEach
-            }
-
-            if (response.statusCode() != 200) {
-                System.err.println("warning: failed to download ${binding.bindingName}.zip; response code: ${response.statusCode()}")
-                response.body().close()
-                return@forEach
-            }
-
-            val eTag = response.headers().firstValue("etag").getOrNull()
-            if (eTag != null) {
-                zipETagMap[binding.bindingName] = eTag.substring(1, eTag.length - 1)
-            }
-
-            Files.newOutputStream(zipPath).buffered().use { os ->
-                response.body().buffered().use { it.transferTo(os) }
-            }
-
-            // validate
-            println("Validating ${binding.bindingName}.zip")
-            val sha256 = (asset["digest"] as String?)?.substringAfter("sha256:")
-            if (sha256 == null) {
-                System.err.println("warning: digest for ${binding.bindingName}.zip is null")
-                return@forEach
-            }
-            val md = MessageDigest.getInstance("SHA-256")
-            DigestInputStream(Files.newInputStream(zipPath), md).use {
-                it.readAllBytes()
-            }
-            val byteArray = sha256.windowed(2, step = 2)
-                .map { it.toUByte(16).toByte() }
-                .toByteArray()
-            val digest = md.digest()
-            if (!byteArray.contentEquals(digest)) {
-                invalidZips.add(binding.bindingName)
-            }
-        }
-
-        // cache zip ETag
-        println("Caching zip information")
-        nativesZipETagPath.writeText(buildString {
-            append("{")
-            zipETagMap.entries.joinTo(this, separator = ",") {
-                "\"${it.key}\":\"${it.value}\""
-            }
-            append("}")
-        })
-
-        if (invalidZips.isNotEmpty()) {
-            throw IllegalStateException(
-                "these files are incomplete or broken; please delete them and rerun this task:\n${
-                    invalidZips.joinToString(separator = "\n") { "    $it.zip" }
-                }"
-            )
-        }
-
-
-        // extract files
-        NativeBinding.entries.forEach { binding ->
-            println("Extracting ${binding.bindingName}.zip")
-            unzipTo(nativesPath.toFile(), nativesBindingZipMap[binding]!!.toFile())
-        }
-    }
-}
-
 tasks.register("updateKhr") {
     val token = rootProject.findProperty("overrungl.native.download.github.token") as String?
         ?: System.getProperty("OVERRUNGL_NATIVE_DOWNLOAD_GITHUB_TOKEN")
@@ -352,3 +150,35 @@ tasks.register("updateKhr") {
         httpClient.downloadRepoFile(token, "KhronosGroup", "OpenGL-Registry", "xml/gl.xml", glXml)
     }
 }
+
+ext["lwjglNatives"] = Pair(
+    System.getProperty("os.name")!!,
+    System.getProperty("os.arch")!!
+).let { (name, arch) ->
+    when {
+        "FreeBSD".equals(name) ->
+            "natives-freebsd"
+
+        arrayOf("Linux", "SunOS", "Unit").any { name.startsWith(it) } ->
+            if (arrayOf("arm", "aarch64").any { arch.startsWith(it) })
+                "natives-linux${if (arch.contains("64") || arch.startsWith("armv8")) "-arm64" else "-arm32"}"
+            else if (arch.startsWith("ppc"))
+                "natives-linux-ppc64le"
+            else if (arch.startsWith("riscv"))
+                "natives-linux-riscv64"
+            else
+                "natives-linux"
+
+        arrayOf("Mac OS X", "Darwin").any { name.startsWith(it) } ->
+            "natives-macos${if (arch.startsWith("aarch64")) "-arm64" else ""}"
+
+        arrayOf("Windows").any { name.startsWith(it) } ->
+            if (arch.contains("64"))
+                "natives-windows${if (arch.startsWith("aarch64")) "-arm64" else ""}"
+            else
+                "natives-windows-x86"
+
+        else ->
+            throw Error("Unrecognized or unsupported platform. Please set \"lwjglNatives\" manually")
+    }
+}

buildSrc/src/main/kotlin/OverrunGLModuleExtension.kt

@@ -7,5 +7,5 @@ import org.gradle.api.provider.Property
 abstract class OverrunGLModuleExtension {
     abstract val artifactName: Property<String>
     abstract val publishInfo: Property<Artifact>
-    abstract val nativeBinding: Property<NativeBinding>
+    abstract val lwjglArtifactName: Property<String>
 }