Shim vips library loading to fix Windows lookup, and allow multiple a…

…ttempts (#57)

.github/workflows/checks.yml

@@ -23,12 +23,41 @@ jobs:
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v3
         with:
-          gradle-version: 8.9
+          gradle-version: 8.10.1
 
       - name: Run checks
         run: ./gradlew build check shadowJar
 
       - name: Run samples
         run: |
           vips --version || (sudo apt update && sudo apt install libvips-dev)
-          ./run_samples.sh
+          ./run_samples.sh
+
+  windows-sense-check:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          distribution: "temurin"
+          java-version: 22
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v3
+        with:
+          gradle-version: 8.10.1
+
+      - name: Run samples
+        shell: pwsh
+        run: |
+          Invoke-WebRequest "https://github.com/libvips/build-win64-mxe/releases/download/v8.15.3/vips-dev-w64-web-8.15.3-static-ffi.zip" -OutFile "vips_w64.zip"
+          (Get-FileHash .\vips_w64.zip).Hash -eq "60500d990c6063a1e95f1ff29a540c5943537ccbed4dd55711947b68229774ee"
+          Expand-Archive vips_w64.zip
+          $env:Path = "$pwd\vips_w64\vips-dev-8.15;$pwd\vips_w64\vips-dev-8.15\bin;" + $env:Path 
+          Write-Output $env:Path
+          Get-ChildItem .\vips_w64\vips-dev-8.15
+          .\gradlew.bat sample:clean sample:shadowJar
+          java -jar sample/build/libs/sample-all.jar

.github/workflows/release.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v3
         with:
-          gradle-version: 8.9
+          gradle-version: 8.10.1
 
       - name: Run checks
         run: ./gradlew build check shadowJar

.gitignore

@@ -8,7 +8,6 @@ build
 
 jextract*
 logo*
-native_libs/lib*
 includes.txt
 includes_filtered.txt
 hs_err*

.run/Discover Vips operations.run.xml

@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Discover Vips operations" type="JetRunConfigurationType">
     <envs>
-      <env name="DYLD_LIBRARY_PATH" value="native_libs" />
+      <env name="DYLD_LIBRARY_PATH" value="/opt/homebrew/lib" />
     </envs>
     <option name="MAIN_CLASS_NAME" value="vipsffm.DiscoverVipsOperationsKt" />
     <module name="vips-ffm.generator.main" />

.run/Generate V classes.run.xml

@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Generate V classes" type="JetRunConfigurationType">
     <envs>
-      <env name="DYLD_LIBRARY_PATH" value="native_libs" />
+      <env name="DYLD_LIBRARY_PATH" value="/opt/homebrew/lib" />
     </envs>
     <option name="MAIN_CLASS_NAME" value="vipsffm.GenerateVClasses" />
     <module name="vips-ffm.generator.main" />

.run/Generate VipsHelper class.run.xml

@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Generate VipsHelper class" type="JetRunConfigurationType">
     <envs>
-      <env name="DYLD_LIBRARY_PATH" value="native_libs" />
+      <env name="DYLD_LIBRARY_PATH" value="/opt/homebrew/lib" />
     </envs>
     <option name="MAIN_CLASS_NAME" value="vipsffm.GenerateVipsHelperClass" />
     <module name="vips-ffm.generator.main" />

.run/Run samples.run.xml

@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run samples" type="JetRunConfigurationType">
     <envs>
-      <env name="DYLD_LIBRARY_PATH" value="native_libs" />
+      <env name="DYLD_LIBRARY_PATH" value="/opt/homebrew/lib" />
     </envs>
     <option name="MAIN_CLASS_NAME" value="vipsffm.SampleRunner" />
     <module name="vips-ffm.sample.main" />

README.md

@@ -18,7 +18,7 @@ repositories {
 }
 
 dependencies {
-    implementation("app.photofox.vips-ffm:vips-ffm-core:0.4.0")
+    implementation("app.photofox.vips-ffm:vips-ffm-core:0.5.0")
 }
 ```
 

core/build.gradle.kts

@@ -50,7 +50,6 @@ tasks.withType<Test> {
         exceptionFormat = TestExceptionFormat.FULL
     }
     jvmArgs("--enable-native-access=ALL-UNNAMED")
-    environment(mapOf("DYLD_LIBRARY_PATH" to "native_libs"))
     outputs.upToDateWhen { false }
 }
 
@@ -61,7 +60,6 @@ tasks.named("check") {
 
 tasks.withType<JavaExec>().configureEach {
     jvmArgs("--enable-native-access=ALL-UNNAMED")
-    environment(mapOf("DYLD_LIBRARY_PATH" to "native_libs"))
     javaLauncher.set(project.javaToolchains.launcherFor(java.toolchain))
 }
 

core/src/main/java/app/photofox/vipsffm/VipsLibLookup.java

@@ -0,0 +1,87 @@
+package app.photofox.vipsffm;
+
+import java.lang.foreign.Arena;
+import java.lang.foreign.SymbolLookup;
+import java.util.List;
+import java.util.Optional;
+
+public class VipsLibLookup {
+
+    public static SymbolLookup buildSymbolLoader(Arena arena) {
+        var vipsLoader = findVipsLoader(arena);
+        if (vipsLoader == null) {
+            throw new UnsatisfiedLinkError("could not make loader for libvips");
+        }
+        var glibLoader = findGlibLoader(arena);
+        if (glibLoader == null) {
+            throw new UnsatisfiedLinkError("could not make loader for glib");
+        }
+        var gobjectLoader = findGObjectLoader(arena);
+        if (gobjectLoader == null) {
+            throw new UnsatisfiedLinkError("could not make loader for gobject");
+        }
+
+        return vipsLoader.or(glibLoader).or(gobjectLoader);
+    }
+
+    private static SymbolLookup findVipsLoader(Arena arena) {
+        var abiNumber = Optional.ofNullable(System.getProperty("vipsffm.abinumber.vips.override"))
+                .orElse("42");
+        var names = List.of(
+            "vips", // default unix-like
+            "vips." + abiNumber, // some linux systems don't symlink and need abi number
+            "libvips-" + abiNumber // windows needs everything
+        );
+        for (var name : names) {
+            var attempt = attemptLibraryLookup(name, arena);
+            if (attempt.isPresent()) {
+                return attempt.get();
+            }
+        }
+        return null;
+    }
+
+    private static SymbolLookup findGlibLoader(Arena arena) {
+        var abiNumber = Optional.ofNullable(System.getProperty("vipsffm.abinumber.glib.override"))
+                .orElse("0");
+        var names = List.of(
+                "glib-2.0", // default unix-like
+                "glib-2.0." + abiNumber, // some linux systems don't symlink and need abi number
+                "libglib-2.0-" + abiNumber // windows needs everything
+        );
+        for (var name : names) {
+            var attempt = attemptLibraryLookup(name, arena);
+            if (attempt.isPresent()) {
+                return attempt.get();
+            }
+        }
+        return null;
+    }
+
+    private static SymbolLookup findGObjectLoader(Arena arena) {
+        var abiNumber = Optional.ofNullable(System.getProperty("vipsffm.abinumber.gobject.override"))
+                .orElse("0");
+        var names = List.of(
+                "gobject-2.0", // default unix-like
+                "gobject-2.0." + abiNumber, // some linux systems don't symlink and need abi number
+                "libgobject-2.0-" + abiNumber // windows needs everything
+        );
+        for (var name : names) {
+            var attempt = attemptLibraryLookup(name, arena);
+            if (attempt.isPresent()) {
+                return attempt.get();
+            }
+        }
+        return null;
+    }
+
+    static Optional<SymbolLookup> attemptLibraryLookup(String name, Arena arena) {
+        try {
+            return Optional.of(
+                SymbolLookup.libraryLookup(System.mapLibraryName(name), arena)
+            );
+        } catch (IllegalArgumentException _) {
+            return Optional.empty();
+        }
+    }
+}

core/src/main/java/app/photofox/vipsffm/jextract/VipsRaw.java

@@ -1,16 +1,14 @@
 // Generated by jextract
 
 package app.photofox.vipsffm.jextract;
+import app.photofox.vipsffm.VipsLibLookup;
 
 import java.lang.invoke.*;
 import java.lang.foreign.*;
-import java.nio.ByteOrder;
 import java.util.*;
-import java.util.function.*;
 import java.util.stream.*;
 
 import static java.lang.foreign.ValueLayout.*;
-import static java.lang.foreign.MemoryLayout.PathElement.*;
 
 public class VipsRaw {
 
@@ -55,7 +53,7 @@ static MemoryLayout align(MemoryLayout layout, long align) {
         };
     }
 
-    static final SymbolLookup SYMBOL_LOOKUP = SymbolLookup.libraryLookup(System.mapLibraryName("vips"), LIBRARY_ARENA)
+    static final SymbolLookup SYMBOL_LOOKUP = VipsLibLookup.buildSymbolLoader(LIBRARY_ARENA)
             .or(SymbolLookup.loaderLookup())
             .or(Linker.nativeLinker().defaultLookup());
 

generate_ffm_bindings.sh

@@ -68,6 +68,4 @@ set -x
 @includes_filtered.txt \
 "$LIBVIPS_ENTRY_PATH"
 
-export DYLD_LIBRARY_PATH="native_libs"
-
 ./gradlew clean generator:run

generator/build.gradle.kts

@@ -45,6 +45,9 @@ tasks.withType<Test> {
 
 application {
     mainClass = "vipsffm.MainKt"
-    applicationDefaultJvmArgs = listOf("--enable-preview", "--enable-native-access=ALL-UNNAMED", "-Xlog:library", "-Djava.library.path=${rootProject.projectDir}/native_libs")
+    applicationDefaultJvmArgs = listOf(
+        "--enable-preview",
+        "--enable-native-access=ALL-UNNAMED"
+    )
     tasks.run.get().workingDir = rootProject.projectDir
 }

generator/src/main/kotlin/vipsffm/GenerateVClasses.kt

@@ -63,8 +63,6 @@ object GenerateVClasses {
     private val vNamedEnumType = ClassName.get("app.photofox.vipsffm", "VNamedEnum")
 
     @JvmStatic fun main(args: Array<String>) {
-        System.loadLibrary("vips")
-
         val operations = Arena.ofConfined().use {
             DiscoverVipsOperations.run(it)
         }

generator/src/main/kotlin/vipsffm/Main.kt

@@ -1,6 +1,7 @@
 package vipsffm
 
 fun main(args: Array<String>) {
+    ReplaceVipsLoader.main(args)
     GenerateVipsHelperClass.main(args)
     GenerateVClasses.main(args)
 }

generator/src/main/kotlin/vipsffm/ReplaceVipsLoader.kt

@@ -0,0 +1,22 @@
+package vipsffm
+
+import java.nio.file.Files
+import java.nio.file.Path
+
+object ReplaceVipsLoader {
+
+    @JvmStatic fun main(args: Array<String>) {
+        val vipsRawPath = Path.of("core/src/main/java/app/photofox/vipsffm/jextract/VipsRaw.java")
+
+        val content = String(Files.readAllBytes(vipsRawPath), Charsets.UTF_8)
+            .replace(
+                "SymbolLookup.libraryLookup(System.mapLibraryName(\"vips\"), LIBRARY_ARENA)",
+                "VipsLibLookup.buildSymbolLoader(LIBRARY_ARENA)"
+            )
+            .replace(
+                "package app.photofox.vipsffm.jextract;\n\n",
+                "package app.photofox.vipsffm.jextract;\nimport app.photofox.vipsffm.VipsLibLookup;\n\n",
+            )
+        Files.write(vipsRawPath, content.toByteArray(Charsets.UTF_8))
+    }
+}

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.1-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

run_samples.sh

@@ -5,7 +5,7 @@ echo "building samples..."
 ./gradlew sample:clean sample:shadowJar
 
 if [[ "$OSTYPE" == "darwin"* ]]; then
-  export DYLD_LIBRARY_PATH=native_libs
+  export DYLD_LIBRARY_PATH=/opt/homebrew/lib
 fi
 
 echo "running samples..."

sample/build.gradle.kts

@@ -40,12 +40,10 @@ tasks.withType<Test> {
         events = TestLogEvent.values().toSet() - TestLogEvent.STARTED
         exceptionFormat = TestExceptionFormat.FULL
     }
-    environment(mapOf("DYLD_LIBRARY_PATH" to "native_libs"))
     outputs.upToDateWhen { false }
 }
 
 tasks.withType<JavaExec>().configureEach {
-    environment(mapOf("DYLD_LIBRARY_PATH" to "native_libs"))
     javaLauncher.set(project.javaToolchains.launcherFor(java.toolchain))
 }
 
@@ -58,5 +56,4 @@ tasks.withType<Jar>().configureEach {
 application {
     mainClass = "vipsffm.SampleRunner"
     applicationDefaultJvmArgs = listOf("--enable-native-access=ALL-UNNAMED")
-    // todo: figure out how to set DYLD_LIBRARY_PATH here
 }