gir_ffi 0.5.1 → 0.5.2

data/lib/gir_ffi/module_base.rb

@@ -7,9 +7,7 @@ module GirFFI
     end
 
     def const_missing classname
-      klass = load_class classname
-      return super if klass.nil?
-      klass
+      load_class(classname) || super
     end
 
     def load_class classname

data/lib/gir_ffi/return_value_builder.rb

@@ -10,10 +10,7 @@ module GirFFI
 
     def post
       if needs_wrapping?
-        if specialized_type_tag == :zero_terminated
-          # FIXME: This is almost certainly wrong.
-          [ "#{retname} = #{argument_class_name}.wrap(#{cvar})" ]
-        elsif [ :interface, :object ].include?(specialized_type_tag) && @is_constructor
+        if [ :interface, :object ].include?(specialized_type_tag) && @is_constructor
           [ "#{retname} = self.constructor_wrap(#{cvar})" ]
         else
           [ "#{retname} = #{argument_class_name}.wrap(#{return_value_conversion_arguments})" ]

data/lib/gir_ffi/version.rb

@@ -1,4 +1,3 @@
 module GirFFI
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end
-

data/lib/gir_ffi/zero_terminated.rb

@@ -0,0 +1,42 @@
+module GirFFI
+  # Represents a null-terminated array.
+  class ZeroTerminated
+    include Enumerable
+
+    attr_reader :element_type
+
+    def initialize elm_t, ptr
+      @element_type = elm_t
+      @ptr = ptr
+    end
+
+    def to_ptr
+      @ptr
+    end
+
+    def self.from type, arg
+      self.new type, InPointer.from_array(type, arg)
+    end
+
+    def self.wrap type, arg
+      self.new type, arg
+    end
+
+    def each
+      return if @ptr.null?
+      offset = 0
+      while val = read_value(offset)
+        offset += FFI.type_size(:int32)
+        yield val
+      end
+    end
+
+    private
+
+    def read_value offset
+      val = @ptr.get_int32(offset)
+      return val unless val == 0
+    end
+  end
+end
+

data/lib/gir_ffi.rb

@@ -8,6 +8,7 @@ require 'gir_ffi/info_ext'
 
 require 'gir_ffi/in_pointer'
 require 'gir_ffi/in_out_pointer'
+require 'gir_ffi/zero_terminated'
 require 'gir_ffi/arg_helper'
 require 'gir_ffi/callback'
 require 'gir_ffi/callback_helper'

data/test/ffi-gobject/value_test.rb

@@ -54,6 +54,17 @@ describe GObject::Value do
       result = gv.ruby_value
       assert_equal true, result
     end
+
+    it "works with a ByteArray" do
+      ba = GLib::ByteArray.new.append("some bytes")
+      v = GObject::Value.new.init(GObject.type_from_name("GByteArray"))
+      v.set_boxed ba
+
+      result = v.ruby_value
+
+      result.to_string.must_equal "some bytes"
+      result.must_be_kind_of GLib::ByteArray
+    end
   end
 
   describe "::from" do
@@ -70,5 +81,23 @@ describe GObject::Value do
       gv2.ruby_value.must_equal 21
     end
   end
-end
 
+  describe "#set_value" do
+    before do
+      GirFFI.setup :GIMarshallingTests
+    end
+
+    it "raises an error when setting an incompatible object type" do
+      o = GIMarshallingTests::Object.new 1
+      v = GObject::Value.new.init(GIMarshallingTests::OverridesObject.get_gtype)
+      proc { v.set_value o }.must_raise ArgumentError
+    end
+
+    it "works with a ByteArray" do
+      ba = GLib::ByteArray.new.append("some bytes")
+      v = GObject::Value.new.init(GObject.type_from_name("GByteArray"))
+      v.set_value ba
+      v.ruby_value.to_string.must_equal "some bytes"
+    end
+  end
+end

data/test/ffi-gobject_introspection/i_object_info_test.rb

@@ -5,13 +5,13 @@ module GirFFI
     context "An IObjectInfo object" do
 
       setup do
-	gir = GObjectIntrospection::IRepository.default
-	gir.require 'GObject', nil
-	@info = gir.find_by_name 'GObject', 'Object'
+        gir = GObjectIntrospection::IRepository.default
+        gir.require 'GObject', nil
+        @info = gir.find_by_name 'GObject', 'Object'
       end
 
       should "find a vfunc by name" do
-	assert_not_nil @info.find_vfunc("finalize")
+        assert_not_nil @info.find_vfunc("finalize")
       end
     end
 

data/test/ffi-gobject_test.rb

@@ -43,6 +43,18 @@ describe GObject do
       sb2 = Regress::TestSimpleBoxedA.wrap b2
       assert sb.equals(sb2)
     end
+
+    should "allow specifying signal detail" do
+      a = 1
+      o = Regress::TestSubObj.new
+
+      callback = FFI::Function.new(:void, [:pointer, :pointer, :pointer]) { a = 2 }
+      ::GObject::Lib.g_signal_connect_data o, "notify::detail", callback, nil, nil, 0
+
+      GObject.signal_emit o, "notify::detail"
+
+      a.must_equal 2
+    end
   end
 
   describe "::signal_connect" do
@@ -92,6 +104,14 @@ describe GObject do
       end
     end
 
+    should "allow specifying signal detail" do
+      a = 1
+      o = Regress::TestSubObj.new
+      GObject.signal_connect(o, "notify::detail", 2) { |i, _, d| a = d }
+      GObject.signal_emit o, "notify::detail"
+      assert_equal 2, a
+    end
+
     describe "connecting a signal with extra arguments" do
       setup do
         @a = nil

data/test/gir_ffi/arg_helper_test.rb

@@ -67,15 +67,15 @@ describe GirFFI::ArgHelper do
   describe "#object_to_inptr" do
     describe "when called with an object implementing to_ptr" do
       it "returns the result of to_ptr" do
-	obj = Object.new
-	def obj.to_ptr; :test_value; end
-	assert_equal :test_value, GirFFI::ArgHelper.object_to_inptr(obj)
+        obj = Object.new
+        def obj.to_ptr; :test_value; end
+        assert_equal :test_value, GirFFI::ArgHelper.object_to_inptr(obj)
       end
     end
 
     describe "when called with nil" do
       it "returns nil" do
-	assert_equal nil, GirFFI::ArgHelper.object_to_inptr(nil)
+        assert_equal nil, GirFFI::ArgHelper.object_to_inptr(nil)
       end
     end
 

data/test/gir_ffi/argument_builder_test.rb

@@ -35,6 +35,22 @@ describe GirFFI::ArgumentBuilder do
         builder.post.must_equal [ ]
       end
     end
+
+    describe "for :zero_terminated" do
+      before do
+        stub(type_info).tag { :array }
+        stub(type_info).flattened_tag { :zero_terminated }
+        stub(type_info).element_type { :foo }
+      end
+
+      it "has the correct value for #pre" do
+        builder.pre.must_equal [ "_v1 = GirFFI::ZeroTerminated.from(:foo, foo)" ]
+      end
+
+      it "has the correct value for #post" do
+        builder.post.must_equal [ ]
+      end
+    end
   end
 
   describe "for an argument with direction :out" do

data/test/gir_ffi/builder_test.rb

@@ -80,11 +80,6 @@ describe GirFFI::Builder do
       assert_equal [FFI.find_type(:pointer)], dn.param_types
     end
 
-    # FIXME: Test passes but does not test what it claims to test.
-    should "define ffi enum type ConnectFlags" do
-      assert_equal({:after => 1, :swapped => 2}, GObject::ConnectFlags.to_h)
-    end
-
     after do
       restore_module :Regress
       restore_module :GObject

data/test/gir_ffi/in_pointer_test.rb

@@ -16,9 +16,24 @@ describe GirFFI::InPointer do
     it "handles type tag :interface_pointer" do
       GirFFI::InPointer.from_array :interface_pointer, []
     end
+
+    it "handles enum types" do
+      e = FFI::Enum.new [:foo, :bar, :baz]
+      ptr = GirFFI::InPointer.from_array e, [:bar, :foo, :baz]
+      ptr.read_array_of_int32(3).must_equal [1, 0, 2]
+    end
+
+    it "handles typed pointers" do
+      p1 = GirFFI::InPointer.from :gint32, 42
+      p2 = GirFFI::InPointer.from :gint32, 24
+
+      ptr = GirFFI::InPointer.from_array [:pointer, :uint32], [p1, p2]
+
+      ptr.read_array_of_pointer(2).must_equal [p1, p2]
+    end
   end
 
-  describe "an instance created with .from_array" do
+  describe "an instance created with .from_array :gint32" do
     before do
       @result = GirFFI::InPointer.from_array :gint32, [24, 13]
     end
@@ -31,6 +46,10 @@ describe GirFFI::InPointer do
     it "is an instance of GirFFI::InPointer" do
       assert_instance_of GirFFI::InPointer, @result
     end
+
+    it "is zero-terminated" do
+      assert_equal 0, @result.get_int(8)
+    end
   end
 
   describe "an instance created with .from_array :utf8" do

data/test/gir_ffi/info_ext/i_arg_info_test.rb

@@ -0,0 +1,39 @@
+require 'gir_ffi_test_helper'
+
+describe GirFFI::InfoExt::IArgInfo do
+  let(:testclass) { Class.new do
+    include GirFFI::InfoExt::IArgInfo
+  end }
+  let(:arg_info) { testclass.new }
+
+  describe "#cast_signal_argument" do
+    describe "with info for an enum" do
+      before do
+        enuminfo = get_introspection_data 'GLib', 'DateMonth'
+        stub(type_info = Object.new).interface { enuminfo }
+        stub(type_info).tag { :interface }
+        stub(arg_info).argument_type { type_info }
+      end
+
+      it "casts an integer to its enum symbol" do
+        res = arg_info.cast_signal_argument 7
+        assert_equal :july, res
+      end
+    end
+
+    describe "with info for an interface" do
+      before do
+        ifaceinfo = get_introspection_data 'Regress', 'TestInterface'
+        stub(type_info = Object.new).interface { ifaceinfo }
+        stub(type_info).tag { :interface }
+        stub(arg_info).argument_type { type_info }
+      end
+
+      it "casts the argument by calling #to_object on it" do
+        mock(ptr = Object.new).to_object { "good-result" }
+        res = arg_info.cast_signal_argument ptr
+        res.must_equal "good-result"
+      end
+    end
+  end
+end

data/test/gir_ffi/info_ext/i_signal_info_test.rb

@@ -0,0 +1,51 @@
+require 'gir_ffi_test_helper'
+
+describe GirFFI::InfoExt::ISignalInfo do
+  describe "#cast_back_signal_arguments" do
+    it "correctly casts back pointers for the test-with-static-scope-arg signal" do
+      o = Regress::TestSubObj.new
+      b = Regress::TestSimpleBoxedA.new
+      ud = GirFFI::ArgHelper.object_to_inptr "Hello!"
+
+      assert_equal "Hello!", GirFFI::ArgHelper::OBJECT_STORE[ud.address]
+
+      sig = o.class.find_signal "test-with-static-scope-arg"
+
+      gva = sig.cast_back_signal_arguments(o.to_ptr, b.to_ptr, ud)
+
+      klasses = gva.map {|it| it.class}
+      klasses.must_equal [ Regress::TestSubObj,
+                           Regress::TestSimpleBoxedA,
+                           String ]
+      gva[2].must_equal "Hello!"
+    end
+  end
+
+  describe "#signal_arguments_to_gvalue_array" do
+    describe "the result of wrapping test-with-static-scope-arg" do
+      setup do
+        o = Regress::TestSubObj.new
+        b = Regress::TestSimpleBoxedA.new
+        sig = o.class.find_signal "test-with-static-scope-arg"
+
+        @gva = sig.signal_arguments_to_gvalue_array(o, b)
+      end
+
+      should "be a GObject::ValueArray" do
+        assert_instance_of GObject::ValueArray, @gva
+      end
+
+      should "contain two values" do
+        assert_equal 2, @gva.n_values
+      end
+
+      should "have a first value with GType for TestSubObj" do
+        assert_equal Regress::TestSubObj.get_gtype, (@gva.get_nth 0).current_gtype
+      end
+
+      should "have a second value with GType for TestSimpleBoxedA" do
+        assert_equal Regress::TestSimpleBoxedA.get_gtype, (@gva.get_nth 1).current_gtype
+      end
+    end
+  end
+end

data/test/gir_ffi/info_ext/i_type_info_test.rb

@@ -67,9 +67,9 @@ describe GirFFI::InfoExt::ITypeInfo do
   describe "#type_specification" do
     describe "for a simple type" do
       it "returns the type tag" do
-	stub(type_info).tag { :uint32 }
+        stub(type_info).tag { :uint32 }
 
-	type_info.type_specification.must_equal ":uint32"
+        type_info.type_specification.must_equal ":uint32"
       end
     end
 
@@ -78,12 +78,12 @@ describe GirFFI::InfoExt::ITypeInfo do
         stub(elmtype_info).tag { :utf8 }
         stub(elmtype_info).pointer? { true }
 
-	stub(type_info).tag { :array }
-	stub(type_info).param_type(0) { elmtype_info }
-	stub(type_info).zero_terminated? { true }
-	stub(type_info).array_type { :c }
+        stub(type_info).tag { :array }
+        stub(type_info).param_type(0) { elmtype_info }
+        stub(type_info).zero_terminated? { true }
+        stub(type_info).array_type { :c }
 
-	type_info.type_specification.must_equal "[:strv, :utf8]"
+        type_info.type_specification.must_equal "[:strv, :utf8]"
       end
     end
 
@@ -92,12 +92,12 @@ describe GirFFI::InfoExt::ITypeInfo do
         stub(elmtype_info).tag { :filename }
         stub(elmtype_info).pointer? { true }
 
-	stub(type_info).tag { :array }
-	stub(type_info).param_type(0) { elmtype_info }
-	stub(type_info).zero_terminated? { true }
-	stub(type_info).array_type { :c }
+        stub(type_info).tag { :array }
+        stub(type_info).param_type(0) { elmtype_info }
+        stub(type_info).zero_terminated? { true }
+        stub(type_info).array_type { :c }
 
-	type_info.type_specification.must_equal "[:strv, :filename]"
+        type_info.type_specification.must_equal "[:strv, :filename]"
       end
     end
 
@@ -106,12 +106,12 @@ describe GirFFI::InfoExt::ITypeInfo do
         stub(elmtype_info).tag { :foo }
         stub(elmtype_info).pointer? { false }
 
-	stub(type_info).tag { :array }
+        stub(type_info).tag { :array }
         stub(type_info).param_type(0) { elmtype_info }
-	stub(type_info).zero_terminated? { true }
-	stub(type_info).array_type { :c }
+        stub(type_info).zero_terminated? { true }
+        stub(type_info).array_type { :c }
 
-	type_info.type_specification.must_equal "[:zero_terminated, :foo]"
+        type_info.type_specification.must_equal "[:zero_terminated, :foo]"
       end
     end
 
@@ -120,12 +120,12 @@ describe GirFFI::InfoExt::ITypeInfo do
         mock(elmtype_info).tag { :foo }
         mock(elmtype_info).pointer? { false }
 
-	mock(type_info).tag { :array }
+        mock(type_info).tag { :array }
         stub(type_info).param_type(0) { elmtype_info }
-	stub(type_info).zero_terminated? { false }
-	stub(type_info).array_type { :c }
+        stub(type_info).zero_terminated? { false }
+        stub(type_info).array_type { :c }
 
-	type_info.type_specification.must_equal "[:c, :foo]"
+        type_info.type_specification.must_equal "[:c, :foo]"
       end
     end
 

data/test/gir_ffi/return_value_builder_test.rb

@@ -146,12 +146,12 @@ describe GirFFI::ReturnValueBuilder do
   describe "for :zero_terminated" do
     before do
       stub(type_info).flattened_tag { :zero_terminated }
+      stub(type_info).element_type { :foo }
     end
 
     it "wraps the result in #post" do
       builder.callarg.must_equal "_v1"
-      # FIXME: This is almost certainly wrong, but matches original behavior.
-      builder.post.must_equal [ "_v2 = GirFFI::InPointer.wrap(_v1)" ]
+      builder.post.must_equal [ "_v2 = GirFFI::ZeroTerminated.wrap(:foo, _v1)" ]
     end
 
     it "returns the wrapped result" do

data/test/gir_ffi/zero_terminated_test.rb

@@ -0,0 +1,48 @@
+require 'gir_ffi_test_helper'
+
+describe GirFFI::ZeroTerminated do
+  describe ".from" do
+    let(:result) { GirFFI::ZeroTerminated.from :int32, [1, 2, 3] }
+
+    it "converts the passed array into a zero-terminated c array" do
+      ptr = result.to_ptr
+      ptr.read_array_of_int32(4).must_equal [1, 2, 3, 0]
+    end
+
+    it "returns a GirFFI::ZeroTerminated object" do
+      result.must_be_instance_of GirFFI::ZeroTerminated
+    end
+  end
+
+  describe ".wrap" do
+    it "wraps the given type and pointer" do
+      ptr = GirFFI::InPointer.from_array :int32, [1, 2, 3, 0]
+      zt = GirFFI::ZeroTerminated.wrap :foo, ptr
+      zt.element_type.must_equal :foo
+      zt.to_ptr.must_equal ptr
+    end
+  end
+
+  describe "#each" do
+    it "yields each element" do
+      zt = GirFFI::ZeroTerminated.from :int32, [1, 2, 3]
+      arr = []
+      zt.each do |int|
+        arr << int
+      end
+      arr.must_equal [1, 2, 3]
+    end
+
+    it "yields zero times for a ZeroTerminated wrapping a null pointer" do
+      zt = GirFFI::ZeroTerminated.wrap :int32, FFI::Pointer.new(0)
+      zt.each do |str|
+        flunk
+      end
+    end
+  end
+
+  it "includes Enumerable" do
+    GirFFI::ZeroTerminated.must_include Enumerable
+  end
+end
+

data/test/gir_ffi_test_helper.rb

@@ -8,11 +8,11 @@ module GObjectIntrospection
     def shared_library_with_regress namespace
       case namespace
       when "Regress"
-	return File.join(File.dirname(__FILE__), 'lib', 'libregress.so')
+        return File.join(File.dirname(__FILE__), 'lib', 'libregress.so')
       when "GIMarshallingTests"
-	return File.join(File.dirname(__FILE__), 'lib', 'libgimarshallingtests.so')
+        return File.join(File.dirname(__FILE__), 'lib', 'libgimarshallingtests.so')
       else
-	return shared_library_without_regress namespace
+        return shared_library_without_regress namespace
       end
     end