fix: Some cleanup and making pointers usable

Author: L3tum

src/Connection.php

@@ -4,33 +4,33 @@
 
 abstract class Connection extends VipsObject
 {
+    /**
+     * A pointer to the underlying Connection. This is the same as the
+     * GObject, just cast to Connection to help FFI.
+     *
+     * @internal
+     */
+    public \FFI\CData $pointer;
+
+    public function __construct(\FFI\CData $pointer)
+    {
+        $this->pointer = \FFI::cast(FFI::ctypes('VipsConnection'), $pointer);
+        parent::__construct($pointer);
+    }
+
     /**
      * Get the filename associated with a connection. Return null if there is no associated file.
      */
     public function filename(): ?string
     {
-        $so = \FFI::cast(FFI::ctypes('VipsConnection'), $this->pointer);
-        $pointer = FFI::vips()->vips_connection_filename($so);
-
-        if (\FFI::isNull($pointer)) {
-            return null;
-        }
-
-        return \FFI::string($pointer);
+        return FFI::vips()->vips_connection_filename($this->pointer);
     }
 
     /**
      * Make a human-readable name for a connection suitable for error messages.
      */
     public function nick(): ?string
     {
-        $so = \FFI::cast(FFI::ctypes('VipsConnection'), $this->pointer);
-        $pointer = FFI::vips()->vips_connection_nick($so);
-
-        if (\FFI::isNull($pointer)) {
-            return null;
-        }
-
-        return \FFI::string($pointer);
+        return FFI::vips()->vips_connection_nick($this->pointer);
     }
 }

src/FFI.php

@@ -751,6 +751,11 @@ private static function init(): void
             "VipsOperation" => self::$vips->type("VipsOperation*"),
             "VipsImage" => self::$vips->type("VipsImage*"),
             "VipsInterpolate" => self::$vips->type("VipsInterpolate*"),
+            "VipsConnection" => self::$vips->type("VipsConnection*"),
+            "VipsSource" => self::$vips->type("VipsSource*"),
+            "VipsSourceCustom" => self::$vips->type("VipsSourceCustom*"),
+            "VipsTarget" => self::$vips->type("VipsTarget*"),
+            "VipsTargetCustom" => self::$vips->type("VipsTargetCustom*"),
         ];
 
         self::$gtypes = [
@@ -774,6 +779,8 @@ private static function init(): void
 
             "GObject" => self::$gobject->g_type_from_name("GObject"),
             "VipsImage" => self::$gobject->g_type_from_name("VipsImage"),
+
+            "GCallback" => self::$gobject->g_type_from_name("GCallback"),
         ];
 
         // map vips format names to c type names

src/Image.php

@@ -901,6 +901,38 @@ public function newFromImage($value): Image
         ]);
     }
 
+    /**
+     * Find the name of the load operation vips will use to load a VipsSource, for
+     * example 'VipsForeignLoadJpegSource'. You can use this to work out what
+     * options to pass to newFromSource().
+     *
+     * @param VipsSource $source The source to test
+     * @return string|null The name of the load operation, or null.
+     */
+    public static function findLoadSource(VipsSource $source): ?string
+    {
+        return FFI::vips()->vips_foreign_find_load_source(\FFI::cast(FFI::ctypes('VipsSource'), $source->pointer));
+    }
+
+    /**
+     * @throws Exception
+     */
+    public static function newFromSource(VipsSource $source, string $string_options = '', array $options = []): self
+    {
+        $loader = self::findLoadSource($source);
+        if ($loader === null) {
+            throw new Exception('unable to load from source');
+        }
+
+        if ($string_options !== '') {
+            $options = array_merge([
+                "string_options" => $string_options,
+            ], $options);
+        }
+
+        return VipsOperation::call($loader, null, [$source], $options);
+    }
+
     /**
      * Write an image to a file.
      *
@@ -1040,6 +1072,28 @@ public function writeToArray(): array
         return $result;
     }
 
+    /**
+     * @throws Exception
+     */
+    public function writeToTarget(VipsTarget $target, string $suffix, array $options = []): void
+    {
+        $filename = Utils::filenameGetFilename($suffix);
+        $string_options = Utils::filenameGetOptions($suffix);
+        $saver = FFI::vips()->vips_foreign_find_save_target($filename);
+
+        if ($saver === '') {
+            throw new Exception("can't save to target with filename $filename");
+        }
+
+        if ($string_options !== '') {
+            $options = array_merge([
+                "string_options" => $string_options,
+            ], $options);
+        }
+
+        VipsOperation::call($saver, $this, [$target], $options);
+    }
+
     /**
      * Copy to memory.
      *

src/VipsObject.php

@@ -56,7 +56,7 @@ abstract class VipsObject extends GObject
      *
      * @internal
      */
-    protected \FFI\CData $pointer;
+    private \FFI\CData $pointer;
 
     /**
      * A pointer to the underlying GObject. This is the same as the

src/VipsSource.php

@@ -4,6 +4,20 @@
 
 class VipsSource extends Connection
 {
+    /**
+     * A pointer to the underlying VipsSource. This is the same as the
+     * GObject, just cast to VipsSource to help FFI.
+     *
+     * @internal
+     */
+    public \FFI\CData $pointer;
+
+    public function __construct(\FFI\CData $pointer)
+    {
+        $this->pointer = \FFI::cast(FFI::ctypes('VipsSource'), $pointer);
+        parent::__construct($pointer);
+    }
+
     /**
      * Make a new source from a file descriptor (a small integer).
      * Make a new source that is attached to the descriptor. For example:

src/VipsSourceCustom.php

@@ -6,10 +6,18 @@
 
 class VipsSourceCustom extends VipsSource
 {
+    /**
+     * A pointer to the underlying VipsSourceCustom. This is the same as the
+     * GObject, just cast to VipsSourceCustom to help FFI.
+     *
+     * @internal
+     */
+    public \FFI\CData $pointer;
+
     public function __construct()
     {
-        $source = \FFI::cast(FFI::ctypes('VipsSource'), FFI::vips()->vips_source_custom_new());
-        parent::__construct($source);
+        $this->pointer = FFI::vips()->vips_source_custom_new();
+        parent::__construct($this->pointer);
     }
 
     /**

src/VipsSourceResource.php

@@ -12,7 +12,8 @@ class VipsSourceResource extends VipsSourceCustom
     private $resource;
 
     /**
-     * The resource passed in will become "owned" by this class. On destruction of this class, the resource will be closed.
+     * The resource passed in will become "owned" by this class.
+     * On destruction of this class, the resource will be closed.
      *
      * @param resource $resource
      */

src/VipsTarget.php

@@ -4,6 +4,20 @@
 
 class VipsTarget extends Connection
 {
+    /**
+     * A pointer to the underlying VipsTarget. This is the same as the
+     * GObject, just cast to VipsTarget to help FFI.
+     *
+     * @internal
+     */
+    public \FFI\CData $pointer;
+
+    public function __construct(\FFI\CData $pointer)
+    {
+        $this->pointer = \FFI::cast(FFI::ctypes('VipsTarget'), $pointer);
+        parent::__construct($pointer);
+    }
+
     public static function newToDescriptor(int $descriptor): self
     {
         $pointer = FFI::vips()->vips_target_new_to_descriptor($descriptor);

src/VipsTargetCustom.php

@@ -6,10 +6,18 @@
 
 class VipsTargetCustom extends VipsTarget
 {
+    /**
+     * A pointer to the underlying VipsTargetCustom. This is the same as the
+     * GObject, just cast to VipsTargetCustom to help FFI.
+     *
+     * @internal
+     */
+    public \FFI\CData $pointer;
+
     public function __construct()
     {
-        $pointer = \FFI::cast(FFI::ctypes('VipsTarget'), FFI::vips()->vips_target_custom_new());
-        parent::__construct($pointer);
+        $this->pointer = FFI::vips()->vips_target_custom_new();
+        parent::__construct($this->pointer);
     }
 
     public function onWrite(Closure $callback): void

src/VipsTargetResource.php

@@ -10,7 +10,8 @@ class VipsTargetResource extends VipsTargetCustom
     private $resource;
 
     /**
-     * The resource passed in will become "owned" by this class. On destruction of this class, the resource will be closed.
+     * The resource passed in will become "owned" by this class.
+     * On destruction of this class, the resource will be closed.
      *
      * @param resource $resource
      */