Merge pull request #49 from Over-Run/glfw

[GLFW] Upgrade GLFW to 3.4
Over-Run · Mar 9, 2024 · ace41e5 · ace41e5
2 parents 5f5923f + 350441f
commit ace41e5
Show file tree

Hide file tree

Showing 28 changed files with 1,253 additions and 213 deletions.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -1,7 +1,7 @@
 name: Feature request
 description: Suggest an idea for this project
 title: "Feature: "
-labels: [ "enhancement", "P5" ]
+labels: [ "enh", "P4" ]
 assignees:
   - "squid233"
 body:

diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml
@@ -7,7 +7,12 @@
 
 name: Java CI with Gradle
 
-on: [ push, pull_request, workflow_dispatch ]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   build:

diff --git a/.github/workflows/javadoc.yml b/.github/workflows/javadoc.yml
@@ -0,0 +1,34 @@
+name: Javadoc
+
+on: [ release, workflow_dispatch ]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        java: [
+          22-ea
+        ]
+        os: [ ubuntu-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK ${{ matrix.java }}
+        uses: actions/setup-java@v4
+        with:
+          java-version: |
+            ${{ matrix.java }}
+            21
+          distribution: 'temurin'
+      - name: Grant execute permission for gradlew
+        if: ${{ runner.os != 'Windows' }}
+        run: chmod +x gradlew
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+      - name: Execute Gradle build
+        run: ./gradlew aggregateJavadoc
+      - name: Capture Javadoc
+        uses: actions/upload-artifact@v4
+        with:
+          name: javadoc
+          path: build/docs/javadoc/
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -135,7 +135,6 @@ artifactNameMap.forEach { (subprojectName, artifactName) ->
             // temporary maven repositories
             maven { url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots") }
             maven { url = uri("https://s01.oss.sonatype.org/content/repositories/releases") }
-            maven { url = uri("https://maven.aliyun.com/repository/central") }
         }
 
         val compileOnly by configurations

diff --git a/doc/notes/0.x/0.1.0.md b/doc/notes/0.x/0.1.0.md
@@ -4,7 +4,7 @@ _Not Released Yet_
 
 This version includes the following features:
 
-- GLFW 3.3.9
+- GLFW 3.4
 - OpenGL 1.0 ~ 4.6 functions and constants
 - OpenGL extension functions
 - OpenGL Loader

diff --git a/gradle.properties b/gradle.properties
@@ -18,5 +18,5 @@ jdkEnablePreview=true
 jdkEarlyAccessDoc=jdk22
 kotlinTargetJdkVersion=21
 
-overrunMarshalVersion=0.1.0-alpha.21-jdk22
+overrunMarshalVersion=0.1.0-alpha.23-jdk22
 overrunPlatformVersion=1.0.0
diff --git a/modules/overrungl.core/src/main/java/overrungl/OverrunGL.java b/modules/overrungl.core/src/main/java/overrungl/OverrunGL.java
@@ -16,8 +16,12 @@
 
 package overrungl;
 
+import java.io.InputStream;
+import java.net.URL;
+import java.net.URLClassLoader;
 import java.util.Objects;
 import java.util.function.Consumer;
+import java.util.jar.Manifest;
 
 /**
  * Constants of OverrunGL.
@@ -33,7 +37,7 @@ public final class OverrunGL {
     /**
      * The version of GLFW native libraries.
      */
-    public static final String GLFW_VERSION = "3.3.9.0";
+    public static final String GLFW_VERSION = "3.4.0.0";
     /**
      * The version of NFD native libraries.
      */
@@ -49,6 +53,24 @@ private OverrunGL() {
         //no instance
     }
 
+    /**
+     * {@return the actual version of OverrunGL from the jar file}
+     */
+    public static String actualVersion() {
+        try {
+            final URL url = ((URLClassLoader) OverrunGL.class.getClassLoader()).findResource("META-INF/MANIFEST.MF");
+            if (url == null) {
+                return VERSION;
+            }
+            try (InputStream stream = url.openStream()) {
+                final String value = new Manifest(stream).getMainAttributes().getValue("Implementation-Version");
+                return value != null ? value : VERSION;
+            }
+        } catch (Exception e) {
+            return VERSION;
+        }
+    }
+
     /**
      * Sets the API logger.
      *

diff --git a/modules/overrungl.core/src/main/java/overrungl/internal/RuntimeHelper.java b/modules/overrungl.core/src/main/java/overrungl/internal/RuntimeHelper.java
@@ -22,10 +22,7 @@
 import overrungl.OverrunGL;
 
 import java.io.IOException;
-import java.lang.foreign.Arena;
-import java.lang.foreign.Linker;
-import java.lang.foreign.MemoryLayout;
-import java.lang.foreign.SymbolLookup;
+import java.lang.foreign.*;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.Map;
@@ -51,6 +48,10 @@ public final class RuntimeHelper {
     public static final MemoryLayout LONG = CANONICAL_LAYOUTS.get("long"),
         SIZE_T = CANONICAL_LAYOUTS.get("size_t"),
         WCHAR_T = CANONICAL_LAYOUTS.get("wchar_t");
+    /**
+     * Is {@code size_t} of {@code long}?
+     */
+    public static final boolean SIZE_T_LONG = SIZE_T instanceof ValueLayout.OfLong;
 
     /**
      * constructor

diff --git a/modules/overrungl.core/src/main/java/overrungl/util/MemoryUtil.java b/modules/overrungl.core/src/main/java/overrungl/util/MemoryUtil.java
@@ -22,11 +22,11 @@
 
 import java.lang.foreign.*;
 import java.lang.invoke.MethodHandle;
-import java.util.Objects;
 
 import static java.lang.foreign.FunctionDescriptor.of;
 import static java.lang.foreign.ValueLayout.ADDRESS;
 import static overrungl.internal.RuntimeHelper.SIZE_T;
+import static overrungl.internal.RuntimeHelper.SIZE_T_LONG;
 
 /**
  * The standard-C memory allocator.
@@ -121,7 +121,8 @@ public static void checkAlignment(long alignment) throws IllegalArgumentExceptio
      */
     public static MemorySegment malloc(long size) {
         try {
-            final MemorySegment seg = ((MemorySegment) m_malloc.invokeExact(size)).reinterpret(size);
+            final MemorySegment seg = (SIZE_T_LONG ? (MemorySegment) m_malloc.invokeExact(size) : (MemorySegment) m_malloc.invokeExact(Math.toIntExact(size)))
+                .reinterpret(size);
             if (DEBUG) DebugAllocator.track(seg.address(), size);
             return seg;
         } catch (Throwable e) {
@@ -155,7 +156,8 @@ public static MemorySegment malloc(MemoryLayout layout) {
     public static MemorySegment calloc(long number, long size) {
         try {
             long byteSize = number * size;
-            final MemorySegment seg = ((MemorySegment) m_calloc.invokeExact(number, size)).reinterpret(byteSize);
+            final MemorySegment seg = (SIZE_T_LONG ? (MemorySegment) m_calloc.invokeExact(number, size) : (MemorySegment) m_calloc.invokeExact(Math.toIntExact(number), Math.toIntExact(size)))
+                .reinterpret(byteSize);
             if (DEBUG) DebugAllocator.track(seg.address(), byteSize);
             return seg;
         } catch (Throwable e) {
@@ -215,9 +217,9 @@ public static MemorySegment realloc(@Nullable MemorySegment memblock, long size)
             oldSize = DebugAllocator.untrack(ptr);
         }
         try {
-            MemorySegment segment = ((MemorySegment) m_realloc.invokeExact(
-                Objects.requireNonNullElse(memblock, MemorySegment.NULL),
-                size)).reinterpret(size);
+            final MemorySegment mem = memblock != null ? memblock : MemorySegment.NULL;
+            MemorySegment segment = (SIZE_T_LONG ? (MemorySegment) m_realloc.invokeExact(mem, size) : (MemorySegment) m_realloc.invokeExact(mem, Math.toIntExact(size)))
+                .reinterpret(size);
             if (DEBUG) {
                 if (!isNullptr(segment)) {
                     DebugAllocator.track(segment.address(), size);
@@ -270,7 +272,7 @@ public static void free(@Nullable MemorySegment memblock) {
      */
     public static MemorySegment memcpy(MemorySegment dest, MemorySegment src, long count) {
         try {
-            final var _ = (MemorySegment) m_memcpy.invokeExact(dest, src, count);
+            final var _ = SIZE_T_LONG ? (MemorySegment) m_memcpy.invokeExact(dest, src, count) : (MemorySegment) m_memcpy.invokeExact(dest, src, Math.toIntExact(count));
             return dest;
         } catch (Throwable e) {
             throw new AssertionError("should not reach here", e);
@@ -295,7 +297,7 @@ public static MemorySegment memcpy(MemorySegment dest, MemorySegment src, long c
      */
     public static MemorySegment memmove(MemorySegment dest, MemorySegment src, long count) {
         try {
-            final var _ = (MemorySegment) m_memmove.invokeExact(dest, src, count);
+            final var _ = SIZE_T_LONG ? (MemorySegment) m_memmove.invokeExact(dest, src, count) : (MemorySegment) m_memmove.invokeExact(dest, src, Math.toIntExact(count));
             return dest;
         } catch (Throwable e) {
             throw new AssertionError("should not reach here", e);
@@ -318,7 +320,7 @@ public static MemorySegment memmove(MemorySegment dest, MemorySegment src, long
      */
     public static MemorySegment memset(MemorySegment dest, int c, long count) {
         try {
-            final var _ = (MemorySegment) m_memset.invokeExact(dest, c, count);
+            final var _ = SIZE_T_LONG ? (MemorySegment) m_memset.invokeExact(dest, c, count) : (MemorySegment) m_memset.invokeExact(dest, c, Math.toIntExact(count));
             return dest;
         } catch (Throwable e) {
             throw new AssertionError("should not reach here", e);