fixups to enums

Author: jcupitt

examples/generate_phpdoc.rb

@@ -8,15 +8,14 @@
 
 # Regenerate docs with something like:
 #
-#   ./generate_phpdoc.rb > AutoDocs.php
-#
-# See https://www.phpdoc.org/docs/latest/references/phpdoc/tags/method.html for
-# docs on the @method syntax. We generate something like:
-#
-# @method [return type] [name]([[type] [parameter]<, ...>]) [<description>]
-#
-# @method Image embed(Image $in, integer $x, integer $y, integer $width, 
-#   integer $height, array $options = []) embed an image in a larger image
+#   cd src
+#   ../examples/generate_phpdoc.rb 
+
+# gobject-introspection 3.0.7 crashes a lot if it GCs while doing 
+# something
+GC.disable
+
+Vips::init
 
 # these have hand-written methods, don't autodoc them
 $no_generate = %w( 
@@ -31,6 +30,16 @@
     extract_area
 )
 
+# Find all the vips enums 
+$enums = []
+Vips.constants.each do |name|
+    const = Vips.const_get name
+    if const.respond_to? :superclass and
+        const.superclass == GLib::Enum
+        $enums << name.to_s
+    end
+end
+
 # map Ruby type names to PHP type names
 $to_php_map = {
     "Vips::Image" => "Image",
@@ -49,15 +58,26 @@
     "Vips::Blob" => "string",
     "gchararray" => "string",
     "gpointer" => "string",
-    "VipsBandFormat" => "BandFormat",
-    "VipsCoding" => "Coding",
-    "VipsInterpretation" => "Interpretation",
-    "VipsDemandStyle" => "DemandStyle",
 }
 
 class Vips::Argument
     def to_php
-        $to_php_map.include?(type) ? $to_php_map[type] : ""
+        return $to_php_map[type] if $to_php_map.include?(type) 
+        return type if $enums.include?(type)
+
+        # is there a "Vips" at the front of the type name? remove it and try the
+        # enums again
+        trim = type.to_s.tap{|s| s.slice!("Vips")}
+        return "Enum\\" + trim if $enums.include?(trim)
+
+        # is there a "::" at the front of the type name? remove it and try the
+        # enums again
+        trim.slice! "::"
+        return "Enum\\" + trim if $enums.include?(trim)
+
+        # no mapping found
+        puts "no mapping found for #{type}"
+        return ""
     end
 end
 
@@ -190,32 +210,35 @@ def generate_class(file, gtype)
  * @version   GIT:ad44dfdd31056a41cbf217244ce62e7a702e0282
  * @link      https://github.com/jcupitt/php-vips
  */
+EOF
 
-namespace Jcupitt\\Vips;
-
-/**
- * %s
- *
+class_header = <<EOF
  * @category  Images
  * @package   Jcupitt\\Vips
  * @author    John Cupitt <jcupitt@gmail.com>
  * @copyright 2016 John Cupitt
  * @license   https://opensource.org/licenses/MIT MIT
  * @version   Release:0.1.2
  * @link      https://github.com/jcupitt/php-vips
- *
 EOF
 
-# gobject-introspection 3.0.7 crashes a lot if it GCs while doing 
-# something
-GC.disable
-
-Vips::init
-
 # The image class is the most complex
 puts "Generating ImageAutodoc.php ..."
 File.open("ImageAutodoc.php", "w") do |file|
-    file << preamble % "Autodocs for the Image class."
+    file << preamble 
+    file << "\n"
+    file << "namespace Jcupitt\\Vips;\n"
+    file << "\n"
+
+    $enums.each do |name|
+        file << "use Jcupitt\\Vips\\Enum\\#{name};\n"
+    end
+
+    file << "\n"
+    file << "/**\n"
+    file << " * Autodocs for the Image class.\n"
+    file << class_header 
+    file << " *\n"
 
     generate_class file, GLib::Type["VipsOperation"]
 
@@ -236,36 +259,37 @@ def generate_class(file, gtype)
 
     file << <<EOF
  */
-class ImageAutodoc
+abstract class ImageAutodoc
 {
 }
 
 ?>
 EOF
 end
 
-# do the various constants, like VipsInterpretation
-Vips.constants.each do |name|
+# generate all the enums
+$enums.each do |name|
     const = Vips.const_get name
-    if const.respond_to? :superclass and
-        const.superclass == GLib::Enum
-        puts "Generating #{name}.php ..."
-        File.open("#{name}.php", "w") do |file|
-            file << preamble % "The #{name} enum."
-            file << <<EOF
- */
-
-abstract class #{name} {
-EOF
-            const.values.each do |value|
-                next if value.nick == "last" 
-                file << "    const #{value.nick.upcase} = '#{value.nick}';\n"
-            end
-            file << <<EOF
-}
-?>
-EOF
+    puts "Generating #{name}.php ..."
+    File.open("#{name}.php", "w") do |file|
+        file << preamble 
+        file << "\n"
+        file << "namespace Jcupitt\\Vips\\Enum;\n"
+        file << "\n"
+        file << "/**\n"
+        file << " * The #{name} enum.\n"
+        file << class_header 
+        file << " */\n"
+        file << "abstract class #{name} {\n"
+
+        const.values.each do |value|
+            php_name = value.nick.tr "-", "_"
+            next if value.nick == "last" 
+            file << "    const #{php_name.upcase} = '#{php_name}';\n"
         end
+
+        file << "}\n"
+        file << "?>\n"
     end
 end
 

src/Access.php

@@ -37,24 +37,21 @@
  * @link      https://github.com/jcupitt/php-vips
  */
 
-namespace Jcupitt\Vips;
+namespace Jcupitt\Vips\Enum;
 
 /**
  * The Access enum.
- *
  * @category  Images
  * @package   Jcupitt\Vips
  * @author    John Cupitt <jcupitt@gmail.com>
  * @copyright 2016 John Cupitt
  * @license   https://opensource.org/licenses/MIT MIT
  * @version   Release:0.1.2
  * @link      https://github.com/jcupitt/php-vips
- *
  */
-
 abstract class Access {
     const RANDOM = 'random';
     const SEQUENTIAL = 'sequential';
-    const SEQUENTIAL-UNBUFFERED = 'sequential-unbuffered';
+    const SEQUENTIAL_UNBUFFERED = 'sequential_unbuffered';
 }
 ?>

src/Align.php

@@ -37,21 +37,18 @@
  * @link      https://github.com/jcupitt/php-vips
  */
 
-namespace Jcupitt\Vips;
+namespace Jcupitt\Vips\Enum;
 
 /**
  * The Align enum.
- *
  * @category  Images
  * @package   Jcupitt\Vips
  * @author    John Cupitt <jcupitt@gmail.com>
  * @copyright 2016 John Cupitt
  * @license   https://opensource.org/licenses/MIT MIT
  * @version   Release:0.1.2
  * @link      https://github.com/jcupitt/php-vips
- *
  */
-
 abstract class Align {
     const LOW = 'low';
     const CENTRE = 'centre';

src/Angle.php

@@ -37,21 +37,18 @@
  * @link      https://github.com/jcupitt/php-vips
  */
 
-namespace Jcupitt\Vips;
+namespace Jcupitt\Vips\Enum;
 
 /**
  * The Angle enum.
- *
  * @category  Images
  * @package   Jcupitt\Vips
  * @author    John Cupitt <jcupitt@gmail.com>
  * @copyright 2016 John Cupitt
  * @license   https://opensource.org/licenses/MIT MIT
  * @version   Release:0.1.2
  * @link      https://github.com/jcupitt/php-vips
- *
  */
-
 abstract class Angle {
     const D0 = 'd0';
     const D90 = 'd90';

src/Angle45.php

@@ -37,21 +37,18 @@
  * @link      https://github.com/jcupitt/php-vips
  */
 
-namespace Jcupitt\Vips;
+namespace Jcupitt\Vips\Enum;
 
 /**
  * The Angle45 enum.
- *
  * @category  Images
  * @package   Jcupitt\Vips
  * @author    John Cupitt <jcupitt@gmail.com>
  * @copyright 2016 John Cupitt
  * @license   https://opensource.org/licenses/MIT MIT
  * @version   Release:0.1.2
  * @link      https://github.com/jcupitt/php-vips
- *
  */
-
 abstract class Angle45 {
     const D0 = 'd0';
     const D45 = 'd45';