gir_ffi 0.2.0 → 0.2.1

data/History.txt

@@ -1,3 +1,8 @@
+== 0.2.1 / 2011-11-20
+
+* Fix handling of output parameters that are arrays of pointers to
+  structures (i.e., of type Foo***).
+
 == 0.2.0 / 2011-11-19
 
 * Add support for properties, with #get_property and #set_property.

data/lib/gir_ffi/arg_helper.rb

@@ -23,34 +23,12 @@ module GirFFI
       FFI::Pointer.new(obj.object_id)
     end
 
-    # Converts an outptr to a string array.
-    def self.outptr_to_utf8_array ptr, size
-      block = ptr.read_pointer
-      return nil if block.null?
-      ptr_to_utf8_array block, size
-    end
-
-    # Converts an outptr to an array of int.
-    def self.outptr_to_int32_array ptr, size
-      block = ptr.read_pointer
-      return nil if block.null?
-      ptr_to_gint32_array block, size
-    end
-
-    # Converts an outptr to an array of the given class.
-    def self.outptr_to_interface_array klass, ptr, size
-      block = ptr.read_pointer
-      return nil if block.null?
-      ptr_to_interface_array klass, block, size
-    end
-
-    class << self
-      alias outptr_to_int_array outptr_to_int32_array
-      alias outptr_to_gint32_array outptr_to_int32_array
-    end
-
     def self.ptr_to_typed_array type, ptr, size
-      if type == :utf8
+      if type.is_a? Class
+        ptr_to_interface_array type, ptr, size
+      elsif type.is_a? Array
+        ptr_to_interface_pointer_array type[1], ptr, size
+      elsif type == :utf8
         ptr_to_utf8_array ptr, size
       else
         ffi_type = TypeMap.map_basic_type type
@@ -84,6 +62,13 @@ module GirFFI
       end
     end
 
+    def self.ptr_to_interface_pointer_array klass, ptr, size
+      ptrs = ptr.read_array_of_pointer(size)
+      ptrs.map do |optr|
+        klass.wrap(optr)
+      end
+    end
+
     if RUBY_VERSION < "1.9"
       def self.ptr_to_utf8 ptr
         ptr.null? ? nil : ptr.read_string

data/lib/gir_ffi/builder/argument/base.rb

@@ -56,12 +56,24 @@ module GirFFI
 
         def argument_class_name
           iface = type_info.interface
+          # FIXME: Extract to ITypeInfo.
           "::#{iface.safe_namespace}::#{iface.name}"
         end
 
-        def subtype_class_name index=0
-          iface = type_info.param_type(index).interface
-          "::#{iface.safe_namespace}::#{iface.name}"
+        def subtype_tag_or_class_name index=0
+          type = type_info.param_type(index)
+          tag = type.tag
+          base = if tag == :interface
+                   iface = type.interface
+                   "::#{iface.safe_namespace}::#{iface.name}"
+                 else
+                   tag.inspect
+                 end
+          if type.pointer?
+            "[:pointer, #{base}]"
+          else
+            base
+          end
         end
 
         def array_size

data/lib/gir_ffi/builder/argument.rb

@@ -238,15 +238,12 @@ module GirFFI::Builder
   # Implements argument processing for array arguments with direction
   # :out.
   class CArrayOutArgument < PointerLikeOutArgument
-    def postpost
-      tag = subtype_tag
-
-      args = [callarg, array_size]
-      if tag == :interface or tag == :interface_pointer
-        args.unshift subtype_class_name
-      end
+    def pre
+      [ "#{callarg} = GirFFI::InOutPointer.for_array #{subtype_tag_or_class_name}" ]
+    end
 
-      [ "#{retname} = GirFFI::ArgHelper.outptr_to_#{tag}_array #{args.join ', '}" ]
+    def postpost
+      [ "#{retname} = #{callarg}.to_sized_array_value #{array_size}" ]
     end
   end
 
@@ -384,9 +381,8 @@ module GirFFI::Builder
     end
 
     def postpost
-      tag = subtype_tag
       size = array_size
-      pst = [ "#{retname} = GirFFI::ArgHelper.outptr_to_#{tag}_array #{callarg}, #{size}" ]
+      pst = [ "#{retname} = #{callarg}.to_sized_array_value #{size}" ]
       pst
     end
 

data/lib/gir_ffi/in_out_pointer.rb

@@ -2,6 +2,8 @@ module GirFFI
   # The InOutPointer class handles conversion between ruby types and
   # pointers for arguments with direction :inout and :out.
   class InOutPointer < FFI::Pointer
+    attr_reader :value_type, :sub_type
+
     def initialize ptr, type, ffi_type, sub_type=nil
       super ptr
       @ffi_type = ffi_type
@@ -37,11 +39,11 @@ module GirFFI
       end
     end
 
-    def self.for type
+    def self.for type, sub_type=nil
       ffi_type = TypeMap.map_basic_type_or_string type
       ptr = AllocationHelper.safe_malloc(FFI.type_size ffi_type)
       ptr.send "put_#{ffi_type}", 0, nil_value_for(type)
-      self.new ptr, type, ffi_type
+      self.new ptr, type, ffi_type, sub_type
     end
 
     def self.from type, value, sub_type=nil
@@ -58,6 +60,10 @@ module GirFFI
       self.from :pointer, ptr, type
     end
 
+    def self.for_array type
+      self.for :pointer, type
+    end
+
     class << self
       def adjust_value_in type, value
         case type

data/lib/gir_ffi/version.rb

@@ -1,4 +1,4 @@
 module GirFFI
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end
 

data/test/arg_helper_test.rb

@@ -1,52 +1,6 @@
 require File.expand_path('gir_ffi_test_helper.rb', File.dirname(__FILE__))
 
 class ArgHelperTest < MiniTest::Spec
-  context "The outptr_to_utf8_array method" do
-    context "when called with a valid pointer to a string array" do
-      setup do
-	p = GirFFI::AllocationHelper.safe_malloc FFI.type_size(:pointer) * 2
-	p.write_array_of_pointer ["one", "two"].map {|str|
-	  len = str.bytesize
-	  GirFFI::AllocationHelper.safe_malloc(len + 1).write_string(str).put_char(len, 0)
-	}
-	@ptr = GirFFI::AllocationHelper.safe_malloc FFI.type_size(:pointer)
-	@ptr.write_pointer p
-      end
-
-      should "return the string array" do
-	assert_equal ["one", "two"],
-	  GirFFI::ArgHelper.outptr_to_utf8_array(@ptr, 2)
-      end
-    end
-
-    context "when called with a pointer to a string array containing a null pointer" do
-      setup do
-	ptrs = ["one", "two"].map {|str|
-	  len = str.bytesize
-	  GirFFI::AllocationHelper.safe_malloc(len + 1).write_string(str).put_char(len, 0)
-	}
-	ptrs << nil
-	p = GirFFI::AllocationHelper.safe_malloc FFI.type_size(:pointer) * 3
-	p.write_array_of_pointer ptrs
-	@ptr = GirFFI::AllocationHelper.safe_malloc FFI.type_size(:pointer)
-	@ptr.write_pointer p
-      end
-
-      should "render the null pointer as nil" do
-	assert_equal ["one", "two", nil],
-	  GirFFI::ArgHelper.outptr_to_utf8_array(@ptr, 3)
-      end
-    end
-
-    context "when called with a pointer to null" do
-      should "return nil" do
-	ptr = GirFFI::InOutPointer.for :pointer
-        assert ptr.read_pointer.null?
-	assert_nil GirFFI::ArgHelper.outptr_to_utf8_array(ptr, 0)
-      end
-    end
-  end
-
   context "The object_to_inptr method" do
     context "when called with an object implementing to_ptr" do
       should "return the result of to_ptr" do

data/test/function_definition_builder_test.rb

@@ -14,7 +14,7 @@ class FunctionDefinitionBuilderTest < MiniTest::Spec
 	  _v2 = GirFFI::InOutPointer.from_array :utf8, argv
 	  ::Lib.gtk_init _v1, _v2
 	  _v3 = _v1.to_value
-	  _v4 = GirFFI::ArgHelper.outptr_to_utf8_array _v2, _v3
+	  _v4 = _v2.to_sized_array_value _v3
 	  return _v4
 	end
       "
@@ -96,11 +96,11 @@ class FunctionDefinitionBuilderTest < MiniTest::Spec
 
       expected =
 	"def test_array_int_null_out
-	  _v1 = GirFFI::InOutPointer.for :pointer
+	  _v1 = GirFFI::InOutPointer.for_array :gint32
 	  _v2 = GirFFI::InOutPointer.for :gint32
 	  ::Lib.regress_test_array_int_null_out _v1, _v2
 	  _v3 = _v2.to_value
-	  _v4 = GirFFI::ArgHelper.outptr_to_gint32_array _v1, _v3
+	  _v4 = _v1.to_sized_array_value _v3
 	  return _v4
 	end"
 
@@ -119,7 +119,7 @@ class FunctionDefinitionBuilderTest < MiniTest::Spec
           _v2 = GirFFI::InOutPointer.from :gint32, length
           ::Lib.gi_marshalling_tests_object_method_array_inout self, _v1, _v2
           _v3 = _v2.to_value
-          _v4 = GirFFI::ArgHelper.outptr_to_gint32_array _v1, _v3
+          _v4 = _v1.to_sized_array_value _v3
           return _v4
 	end"
 

data/test/integration/generated_regress_test.rb

@@ -560,6 +560,29 @@ class GeneratedRegressTest < MiniTest::Spec
       Regress.set_abort_on_error true
     end
 
+    describe "#test_array_fixed_out_objects" do
+      before do
+        @result = Regress.test_array_fixed_out_objects
+      end
+
+      it "returns an array of two items" do
+        assert_equal 2, @result.length
+      end
+
+      it "returns an array TestObj objects" do
+        @result.each {|o|
+          assert_instance_of Regress::TestObj, o
+        }
+      end
+
+      it "returns objects with the correct GType" do
+        gtype = Regress::TestObj.get_gtype
+        @result.each {|o|
+          assert_equal gtype, GObject.type_from_instance(o)
+        }
+      end
+    end
+
     describe "#test_array_fixed_size_int_in" do
       should "return the correct result" do
 	assert_equal 5 + 4 + 3 + 2 + 1, Regress.test_array_fixed_size_int_in([5, 4, 3, 2, 1])

data/test/unit/arg_helper_test.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
+
+describe GirFFI::ArgHelper do
+  describe "::ptr_to_typed_array" do
+    describe "for pointers to class types" do
+      it "reads an array of pointers and wraps each in the class" do
+        c = Class.new do
+          def self.wrap a; "wrapped: #{a}"; end
+        end
+
+        mock(ptr = Object.new).read_array_of_pointer(2) { [:a, :b] }
+
+        result = GirFFI::ArgHelper.ptr_to_typed_array [:pointer, c], ptr, 2
+
+        assert_equal ["wrapped: a", "wrapped: b"], result
+      end
+    end
+  end
+end

data/test/unit/argument_builder_test.rb

@@ -0,0 +1,59 @@
+require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
+
+describe GirFFI::Builder::Argument::Base do
+  describe "#subtype_tag_or_class_name" do
+    describe "for a simple type" do
+      it "returns the string ':void'" do
+        mock(subtype = Object.new).tag { :void }
+        mock(subtype).pointer? { false }
+
+        mock(info = Object.new).param_type(0) { subtype }
+
+        builder = GirFFI::Builder::Argument::Base.new nil, 'foo', info, nil
+        assert_equal ":void", builder.subtype_tag_or_class_name
+      end
+    end
+
+    describe "for an array of simple type :foo" do
+      it "returns the string ':foo'" do
+        mock(subtype = Object.new).tag { :foo }
+        mock(subtype).pointer? { false }
+
+        mock(info = Object.new).param_type(0) { subtype }
+
+        builder = GirFFI::Builder::Argument::Base.new nil, 'bar', info, nil
+        assert_equal ":foo", builder.subtype_tag_or_class_name
+      end
+    end
+
+    describe "for an array of interface class Foo::Bar" do
+      it "returns the string '::Foo::Bar'" do
+        mock(interface = Object.new).safe_namespace { "Foo" }
+        mock(interface).name { "Bar" }
+
+        mock(subtype = Object.new).tag { :interface }
+        mock(subtype).interface { interface }
+        mock(subtype).pointer? { false }
+
+        mock(info = Object.new).param_type(0) { subtype }
+
+        builder = GirFFI::Builder::Argument::Base.new nil, 'bar', info, nil
+        assert_equal "::Foo::Bar", builder.subtype_tag_or_class_name
+      end
+    end
+
+    describe "for an array of pointer to simple type :foo" do
+      it "returns the string '[:pointer, :foo]'" do
+        mock(subtype = Object.new).tag { :foo }
+        mock(subtype).pointer? { true }
+
+        mock(info = Object.new).param_type(0) { subtype }
+
+        builder = GirFFI::Builder::Argument::Base.new nil, 'bar', info, nil
+        assert_equal "[:pointer, :foo]", builder.subtype_tag_or_class_name
+      end
+    end
+
+  end
+end
+

data/test/unit/function_builder_test.rb

@@ -10,6 +10,23 @@ describe GirFFI::Builder::Function do
       assert_equal "result_from_generate", builder.pretty_print
     end
   end
+
+  it "builds a correct definition of Regress:test_array_fixed_out_objects" do
+    go = get_introspection_data 'Regress', 'test_array_fixed_out_objects'
+    fbuilder = GirFFI::Builder::Function.new go, Lib
+    code = fbuilder.generate
+
+    expected =
+      "def test_array_fixed_out_objects
+        _v1 = GirFFI::InOutPointer.for_array [:pointer, ::Regress::TestObj]
+        ::Lib.regress_test_array_fixed_out_objects _v1
+        _v2 = _v1.to_sized_array_value 2
+        return _v2
+      end"
+
+    assert_equal cws(expected), cws(code)
+  end
+
 end
 
 

data/test/unit/in_out_pointer_test.rb

@@ -80,7 +80,7 @@ describe GirFFI::InOutPointer do
     end
   end
 
-  describe ".for" do
+  describe "::for" do
     it "handles :gboolean" do
       GirFFI::InOutPointer.for :gboolean
     end
@@ -90,6 +90,26 @@ describe GirFFI::InOutPointer do
     end
   end
 
+  describe "::for_array" do
+    it "handles :gint32" do
+      @ptr = GirFFI::InOutPointer.for_array :gint32
+      assert_equal :pointer, @ptr.value_type
+      assert_equal :gint32, @ptr.sub_type
+    end
+
+    it "handles GObject" do
+      @ptr = GirFFI::InOutPointer.for_array GObject::Object
+      assert_equal :pointer, @ptr.value_type
+      assert_equal GObject::Object, @ptr.sub_type
+    end
+
+    it "handles pointer to GObject" do
+      @ptr = GirFFI::InOutPointer.for_array [:pointer, GObject::Object]
+      assert_equal :pointer, @ptr.value_type
+      assert_equal [:pointer, GObject::Object], @ptr.sub_type
+    end
+  end
+
   describe "#to_value" do
     it "returns the held value" do
       ptr = GirFFI::InOutPointer.from :gint32, 123
@@ -114,16 +134,17 @@ describe GirFFI::InOutPointer do
         assert_equal "Some value", ptr.to_value
       end
     end
+  end
 
+  describe "#to_sized_array_value" do
     describe "for an array of :gint32" do
       before do
-        @result = GirFFI::InOutPointer.from_array :gint32, [1, 2, 3]
+        @ptr = GirFFI::InOutPointer.from_array :gint32, [1, 2, 3]
       end
 
       it "returns an array of integers with the correct values" do
-        assert_equal [1, 2, 3], @result.to_sized_array_value(3)
+        assert_equal [1, 2, 3], @ptr.to_sized_array_value(3)
       end
     end
-
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gir_ffi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-19 00:00:00.000000000 Z
+date: 2011-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &13966040 !ruby/object:Gem::Requirement
+  requirement: &12290620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.8
   type: :runtime
   prerelease: false
-  version_requirements: *13966040
+  version_requirements: *12290620
 - !ruby/object:Gem::Dependency
   name: indentation
-  requirement: &13964120 !ruby/object:Gem::Requirement
+  requirement: &12289700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *13964120
+  version_requirements: *12289700
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &13975240 !ruby/object:Gem::Requirement
+  requirement: &12288300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.0.2
   type: :development
   prerelease: false
-  version_requirements: *13975240
+  version_requirements: *12288300
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &13973360 !ruby/object:Gem::Requirement
+  requirement: &12285900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.2
   type: :development
   prerelease: false
-  version_requirements: *13973360
+  version_requirements: *12285900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &13987300 !ruby/object:Gem::Requirement
+  requirement: &12284940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *13987300
+  version_requirements: *12284940
 description: 
 email:
 - matijs@matijs.net
@@ -175,7 +175,9 @@ files:
 - test/girffi_test.rb
 - test/interface_type_builder_test.rb
 - test/unit/union_builder_test.rb
+- test/unit/argument_builder_test.rb
 - test/unit/callback_builder_test.rb
+- test/unit/arg_helper_test.rb
 - test/unit/constant_builder_test.rb
 - test/unit/function_builder_test.rb
 - test/unit/module_builder_test.rb
@@ -292,6 +294,8 @@ test_files:
 - test/test_helper.rb
 - test/type_builder_test.rb
 - test/unintrospectable_type_builder_test.rb
+- test/unit/arg_helper_test.rb
+- test/unit/argument_builder_test.rb
 - test/unit/builder_test.rb
 - test/unit/callback_builder_test.rb
 - test/unit/callback_helper_test.rb