support use of "-" in arg names

php-vips 1.x used to allow "-" as a component separator in arg names,
but we forgot to implement this in v2.

Thanks andrews05

See #153

Author: jcupitt

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `:vips` will be documented in this file.
 
+## master
+
+- allow "-" as a name component separator [andrews05]
+
 ## 2.0.3 - 2022-07-04
 
 - Fix on Windows [kleisauke]

install-vips.sh

@@ -121,8 +121,8 @@ public function __construct($operation_name)
         $argumentFlags = [];
         for ($i = 0; $i < $n_args; $i++) {
             if (($p_flags[$i] & ArgumentFlags::CONSTRUCT) != 0) {
-                # libvips uses '-' to separate parts of arg names, but we
-                # need '_' for php
+                # make sure we're using "_" to separate arg components, though
+                # I think libvips is "_" everywhere now
                 $name = \FFI::string($p_names[$i]);
                 $name = str_replace("-", "_", $name);
                 $argumentFlags[$name] = $p_flags[$i];

src/Introspect.php

@@ -91,6 +91,7 @@ public function getDescription(): string
     // FIXME add a cache for this thing
     public function getPspec(string $name): ?\FFI\CData
     {
+        $name = str_replace("-", "_", $name);
         $pspec = Config::gobject()->new("GParamSpec*[1]");
         $argument_class = Config::vips()->new("VipsArgumentClass*[1]");
         $argument_instance = Config::vips()->new("VipsArgumentInstance*[1]");
@@ -140,6 +141,7 @@ public function getArgumentDescription(string $name): string
      */
     public function get(string $name)
     {
+        $name = str_replace("-", "_", $name);
         $gvalue = new GValue();
         $gvalue->setType($this->getType($name));
 
@@ -159,6 +161,7 @@ public function set(string $name, $value): void
     {
         Utils::debugLog("set", [$name => $value]);
 
+        $name = str_replace("-", "_", $name);
         $gvalue = new GValue();
         $gvalue->setType($this->getType($name));
         $gvalue->set($value);

src/VipsObject.php

@@ -290,6 +290,7 @@ public static function callBase(
         /* Set optional.
          */
         foreach ($options as $name => $value) {
+            $name = str_replace("-", "_", $name);
             if (!in_array($name, $operation->introspect->optional_input) &&
                 !in_array($name, $operation->introspect->optional_output)) {
                 $operation->unrefOutputs();
@@ -324,6 +325,7 @@ public static function callBase(
          */
         $option_keys = array_keys($options);
         foreach ($operation->introspect->optional_output as $name) {
+            $name = str_replace("-", "_", $name);
             if (in_array($name, $option_keys)) {
                 $result[$name] = $operation->get($name);
             }
@@ -335,7 +337,9 @@ public static function callBase(
 
         $result = self::wrapResult($result);
 
-        Utils::debugLog($operation_name, ['result' => var_export($result, true)]);
+        Utils::debugLog($operation_name, [
+            'result' => var_export($result, true)
+        ]);
 
         return $result;
     }

src/VipsOperation.php

@@ -10,13 +10,27 @@ class CallTest extends TestCase
     public function testVipsCall()
     {
         $image = Vips\Image::newFromArray([1, 2, 3]);
-        $image = $image->embed(10, 20, 3000, 2000, ['extend' => Vips\Extend::COPY]);
+        $image = $image->embed(10, 20, 3000, 2000, [
+            'extend' => Vips\Extend::COPY
+        ]);
 
         $this->assertEquals($image->width, 3000);
         $this->assertEquals($image->height, 2000);
         $this->assertEquals($image->bands, 1);
     }
 
+    public function testVipsCallHyphen()
+    {
+        # should work with "-" as well as "_"
+        $image = Vips\Image::worley(64, 64, [
+            "cell-size" => 8
+        ]);
+
+        $this->assertEquals($image->width, 64);
+        $this->assertEquals($image->height, 64);
+        $this->assertEquals($image->bands, 1);
+    }
+
     public function testVipsCallStatic()
     {
         $image = Vips\Image::black(1, 4, ['bands' => 3]);