vips_image_get() has an error return

now returns -1 for error, or ["out" => value] for success

Author: jcupitt

ChangeLog

@@ -3,7 +3,9 @@ vips extension changelog
 Version 0.1.1 (2016-10-03)
 --------------------------
 	* Support draw operations
-	* Add vips_error_buffer()
+	* Add vips_error_buffer(), remove docref messages
+	* return 0/-1 everywhere for error
+	* vips_image_get() returns ["out" => value] | -1
 
 Version 0.1.0 (2016-09-20)
 --------------------------

README.md

@@ -135,7 +135,6 @@ libvips.
 
 Run:
 
-
 ```
 $ make
 ```
@@ -144,15 +143,12 @@ To build the module to the `modules/` directory in this repository.
 
 Don't post php-vips test results to php.net! Stop this with:
 
-
 ```
 $ export NO_INTERACTION=1
 ```
 
-
 Test with:
 
-
 ```
 $ make test
 ```

tests/004.phpt

@@ -6,7 +6,7 @@ vips can get image header fields
 <?php 
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
   $image = vips_image_new_from_file($filename)["out"];
-  $width = vips_image_get($image, "width");
+  $width = vips_image_get($image, "width")["out"];
   if ($width == 1600) {
     echo("pass\n");
   }

tests/007.phpt

@@ -6,7 +6,7 @@ new_from_file supports optional args
 <?php 
   $filename = dirname(__FILE__) . "/images/img_0076.jpg";
   $image = vips_image_new_from_file($filename, ["shrink" => 8])["out"];
-  $width = vips_image_get($image, "width");
+  $width = vips_image_get($image, "width")["out"];
   if ($width == 200) {
 	echo "pass";
   }

tests/012.phpt

@@ -8,13 +8,13 @@ new_from_buffer works
   $buffer = file_get_contents($filename);
 
   $image = vips_image_new_from_buffer($buffer)["out"];
-  $width1 = vips_image_get($image, "width");
+  $width1 = vips_image_get($image, "width")["out"];
 
   $image = vips_image_new_from_buffer($buffer, "shrink=2")["out"];
-  $width2 = vips_image_get($image, "width");
+  $width2 = vips_image_get($image, "width")["out"];
 
   $image = vips_image_new_from_buffer($buffer, "", ["shrink" => 4])["out"];
-  $width3 = vips_image_get($image, "width");
+  $width3 = vips_image_get($image, "width")["out"];
 
   if ($width1 == 1600 &&
 	$width2 = 800 &&

tests/014.phpt

@@ -5,12 +5,12 @@ new_from_array works
 --FILE--
 <?php 
   $image = vips_image_new_from_array([1, 2, 3]);
-  $width1 = vips_image_get($image, "width");
-  $height1 = vips_image_get($image, "height");
+  $width1 = vips_image_get($image, "width")["out"];
+  $height1 = vips_image_get($image, "height")["out"];
 
   $image = vips_image_new_from_array([[1, 2, 3], [4, 5, 6]]);
-  $width2 = vips_image_get($image, "width");
-  $height2 = vips_image_get($image, "height");
+  $width2 = vips_image_get($image, "width")["out"];
+  $height2 = vips_image_get($image, "height")["out"];
 
   if ($width1 == 3 &&
 	$height1 == 1 &&

tests/016.phpt

@@ -5,16 +5,16 @@ new_from_array has optional scale and offset
 --FILE--
 <?php 
   $image = vips_image_new_from_array([1, 2, 3]);
-  $scale1 = vips_image_get($image, "scale");
-  $offset1 = vips_image_get($image, "offset");
+  $scale1 = vips_image_get($image, "scale")["out"];
+  $offset1 = vips_image_get($image, "offset")["out"];
 
   $image = vips_image_new_from_array([1, 2, 3], 8);
-  $scale2 = vips_image_get($image, "scale");
-  $offset2 = vips_image_get($image, "offset");
+  $scale2 = vips_image_get($image, "scale")["out"];
+  $offset2 = vips_image_get($image, "offset")["out"];
 
   $image = vips_image_new_from_array([1, 2, 3], 8, 12);
-  $scale3 = vips_image_get($image, "scale");
-  $offset3 = vips_image_get($image, "offset");
+  $scale3 = vips_image_get($image, "scale")["out"];
+  $offset3 = vips_image_get($image, "offset")["out"];
 
   if ($scale1 == 1 &&
 	$offset1 == 0 &&

tests/029.phpt

@@ -0,0 +1,22 @@
+--TEST--
+can get error messages
+--SKIPIF--
+<?php if (!extension_loaded("vips")) print "skip"; ?>
+--FILE--
+<?php 
+  $filename = dirname(__FILE__) . "/images/img_0076.jpg";
+  $image = vips_image_new_from_file($filename)["out"];
+
+  $rg = vips_call("extract_band", $image, 0, ["n" => 2])["out"];
+
+  # this should error out since it's 2 band image + 3 band image
+  $err = vips_call("add", $image, $rg);
+  $msg = vips_error_buffer();
+
+  if ($err == -1 &&
+    $msg == "add: not one band or 3 bands\n") {
+    echo "pass";
+  }
+?>
+--EXPECT--
+pass