gir_ffi 0.10.2 → 0.11.0

data/test/gir_ffi/builders/user_defined_builder_test.rb

@@ -2,6 +2,7 @@
 require 'gir_ffi_test_helper'
 
 GirFFI.setup :GIMarshallingTests
+GirFFI.setup :Regress
 
 describe GirFFI::Builders::UserDefinedBuilder do
   let(:klass) do
@@ -9,20 +10,20 @@ describe GirFFI::Builders::UserDefinedBuilder do
                      Class.new(GIMarshallingTests::Object))
   end
   let(:builder) { GirFFI::Builders::UserDefinedBuilder.new info }
-  let(:info) { GirFFI::UserDefinedTypeInfo.new klass }
+  let(:info) { GirFFI::UserDefinedObjectInfo.new klass }
 
   describe '#build_class' do
     before do
       builder.build_class
     end
 
-    describe 'with type info containing one property' do
+    describe 'with type info containing one integer property' do
       let(:info) do
-        GirFFI::UserDefinedTypeInfo.new klass do |it|
-          it.install_property GObject.param_spec_int('foo', 'foo bar',
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_int('foo-bar', 'foo bar',
                                                      'The Foo Bar Property',
                                                      10, 20, 15,
-                                                     3)
+                                                     readwrite: true)
         end
       end
 
@@ -32,32 +33,379 @@ describe GirFFI::Builders::UserDefinedBuilder do
         q.instance_size.must_be :>, GIMarshallingTests::Object::Struct.size
       end
 
-      it 'gives the types Struct the fields :parent and :foo' do
-        klass::Struct.members.must_equal [:parent, :foo]
+      it "gives the type's Struct fields for the parent and the property" do
+        klass::Struct.members.must_equal [:parent, :foo_bar]
       end
 
       it 'creates accessor functions for the property' do
         obj = klass.new
-        obj.foo = 13
-        obj.foo.must_equal 13
+        obj.foo_bar = 13
+        obj.foo_bar.must_equal 13
       end
 
       it 'makes the property retrievable using #get_property' do
         obj = klass.new
-        obj.foo = 13
-        obj.get_property('foo').must_equal 13
+        obj.foo_bar = 13
+        obj.get_property('foo-bar').must_equal 13
       end
 
       it 'makes the property settable using #set_property' do
         obj = klass.new
-        obj.set_property('foo', 20)
-        obj.foo.must_equal 20
+        obj.set_property('foo-bar', 20)
+        obj.foo_bar.must_equal 20
+      end
+
+      it 'keeps parent properties accessible through their accessors' do
+        obj = klass.new
+        obj.int = 24
+        obj.int.must_equal 24
+      end
+
+      it 'keeps parent properties accessible through get_property and set_property' do
+        obj = klass.new
+        obj.set_property('int', 24)
+        obj.get_property('int').must_equal 24
+      end
+    end
+
+    describe 'with type info containing properties of several different types' do
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_string('string-prop', 'string property',
+                                                        'The String Property',
+                                                        'this is the default value',
+                                                        readwrite: true)
+          it.install_property GObject.param_spec_int('int-prop', 'integer property',
+                                                     'The Integer Property',
+                                                     10, 20, 15,
+                                                     readwrite: true)
+          it.install_property GObject.param_spec_long('long-prop', 'long property',
+                                                      'The Long Property',
+                                                      10.0, 50.0, 42.0,
+                                                      readwrite: true)
+        end
+      end
+
+      it 'registers a type of the proper size' do
+        expected_size = klass::Struct.size
+        gtype = klass.gtype
+        q = GObject.type_query gtype
+        q.instance_size.must_equal expected_size
+      end
+
+      it "gives the type's Struct fields for the parent and the properties with the correct offsets" do
+        offsets = klass::Struct.offsets
+        alignment = klass::Struct.alignment
+        alignment.must_equal 8 # TODO: Fix tests for platforms where this fails.
+        offsets.must_equal [[:parent, 0], [:string_prop, 32], [:int_prop, 40], [:long_prop, 48]]
+      end
+
+      it 'creates accessor functions for the string property' do
+        obj = klass.new
+        obj.string_prop = 'hello!'
+        obj.string_prop.must_equal 'hello!'
+      end
+
+      it 'creates accessor functions for the integer property' do
+        obj = klass.new
+        obj.int_prop = 13
+        obj.int_prop.must_equal 13
+      end
+    end
+
+    describe 'with a boxed property' do
+      let(:boxed_gtype) { GIMarshallingTests::BoxedStruct.gtype }
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_boxed('boxed-prop', 'boxed property',
+                                                       'The Boxed Property',
+                                                       boxed_gtype,
+                                                       readwrite: true)
+        end
+      end
+
+      it 'registers a type of the proper size' do
+        expected_size = klass::Struct.size
+        gtype = klass.gtype
+        q = GObject.type_query gtype
+        q.instance_size.must_equal expected_size
+      end
+
+      it "gives the type's Struct fields for the parent and the property" do
+        klass::Struct.members.must_equal [:parent, :boxed_prop]
+      end
+
+      it 'creates accessor functions for the property' do
+        obj = klass.new
+        boxed = GIMarshallingTests::BoxedStruct.new
+        boxed.long_ = 423
+        obj.boxed_prop = boxed
+        obj.boxed_prop.long_.must_equal 423
+      end
+    end
+
+    describe 'with an object property' do
+      let(:object_gtype) { GIMarshallingTests::Object.gtype }
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_object('object-prop', 'object property',
+                                                        'The Object Property',
+                                                        object_gtype,
+                                                        readwrite: true)
+        end
+      end
+
+      it 'registers a type of the proper size' do
+        expected_size = klass::Struct.size
+        gtype = klass.gtype
+        q = GObject.type_query gtype
+        q.instance_size.must_equal expected_size
+      end
+
+      it "gives the type's Struct fields for the parent and the property" do
+        klass::Struct.members.must_equal [:parent, :object_prop]
+      end
+
+      it 'creates accessor functions for the property' do
+        obj = klass.new
+        object = GIMarshallingTests::Object.new 42
+        object.int = 423
+        obj.object_prop = object
+        obj.object_prop.int.must_equal 423
+      end
+    end
+
+    describe 'with a boolean property' do
+      let(:object_gtype) { GIMarshallingTests::Object.gtype }
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_boolean('the-prop', 'the property',
+                                                         'The Property',
+                                                         true,
+                                                         readwrite: true)
+        end
+      end
+
+      it 'creates accessor functions for the property' do
+        obj = klass.new
+        obj.the_prop = true
+        obj.the_prop.must_equal true
+      end
+    end
+
+    describe 'with a char property' do
+      let(:object_gtype) { GIMarshallingTests::Object.gtype }
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_char('the-prop', 'the property',
+                                                      'The Property',
+                                                      -20, 100, 15,
+                                                      readwrite: true)
+        end
+      end
+
+      it 'creates accessor functions for the property' do
+        obj = klass.new
+        obj.the_prop = -13
+        obj.the_prop.must_equal(-13)
+      end
+    end
+
+    describe 'with a uchar property' do
+      let(:object_gtype) { GIMarshallingTests::Object.gtype }
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_uchar('the-prop', 'the property',
+                                                       'The Property',
+                                                       10, 100, 15,
+                                                       readwrite: true)
+        end
+      end
+
+      it 'creates accessor functions for the property' do
+        obj = klass.new
+        obj.the_prop = 13
+        obj.the_prop.must_equal 13
+      end
+    end
+
+    describe 'with a uint property' do
+      let(:object_gtype) { GIMarshallingTests::Object.gtype }
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_uint('the-prop', 'the property',
+                                                      'The Property',
+                                                      10, 100, 15,
+                                                      readwrite: true)
+        end
+      end
+
+      it 'creates accessor functions for the property' do
+        obj = klass.new
+        obj.the_prop = 423
+        obj.the_prop.must_equal 423
+      end
+    end
+
+    describe 'with a ulong property' do
+      let(:object_gtype) { GIMarshallingTests::Object.gtype }
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_ulong('the-prop', 'the property',
+                                                       'The Property',
+                                                       10, 100, 15,
+                                                       readwrite: true)
+        end
+      end
+
+      it 'creates accessor functions for the property' do
+        obj = klass.new
+        obj.the_prop = 423_432
+        obj.the_prop.must_equal 423_432
+      end
+    end
+
+    describe 'with a int64 property' do
+      let(:object_gtype) { GIMarshallingTests::Object.gtype }
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_int64('the-prop', 'the property',
+                                                       'The Property',
+                                                       10, 100, 15,
+                                                       readwrite: true)
+        end
+      end
+
+      it 'creates accessor functions for the property' do
+        obj = klass.new
+        obj.the_prop = -423_432
+        obj.the_prop.must_equal(-423_432)
+      end
+    end
+
+    describe 'with a uint64 property' do
+      let(:object_gtype) { GIMarshallingTests::Object.gtype }
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_uint64('the-prop', 'the property',
+                                                        'The Property',
+                                                        10, 100, 15,
+                                                        readwrite: true)
+        end
+      end
+
+      it 'creates accessor functions for the property' do
+        obj = klass.new
+        obj.the_prop = 423_432
+        obj.the_prop.must_equal 423_432
+      end
+    end
+
+    describe 'with a float property' do
+      let(:object_gtype) { GIMarshallingTests::Object.gtype }
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_float('the-prop', 'the property',
+                                                       'The Property',
+                                                       10.0, 100.0, 15.0,
+                                                       readwrite: true)
+        end
+      end
+
+      it 'creates accessor functions for the property' do
+        obj = klass.new
+        obj.the_prop = 42.23
+        obj.the_prop.must_be_within_epsilon 42.23
+      end
+    end
+
+    describe 'with a double property' do
+      let(:object_gtype) { GIMarshallingTests::Object.gtype }
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_double('the-prop', 'the property',
+                                                        'The Property',
+                                                        10.0, 100.0, 15.0,
+                                                        readwrite: true)
+        end
+      end
+
+      it 'creates accessor functions for the property' do
+        obj = klass.new
+        obj.the_prop = 42.23
+        obj.the_prop.must_equal 42.23
+      end
+    end
+
+    describe 'with an enum property' do
+      let(:object_gtype) { GIMarshallingTests::Object.gtype }
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          prop = GObject.param_spec_enum('the-prop', 'the property',
+                                         'The Property',
+                                         GIMarshallingTests::GEnum.gtype, 0,
+                                         readwrite: true)
+          it.install_property prop
+        end
+      end
+
+      it 'creates accessor functions for the property' do
+        obj = klass.new
+        obj.the_prop = :value2
+        obj.the_prop.must_equal :value2
+      end
+    end
+
+    describe 'with a flags property' do
+      let(:object_gtype) { GIMarshallingTests::Object.gtype }
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          prop = GObject.param_spec_flags('the-prop', 'the property',
+                                          'The Property',
+                                          GIMarshallingTests::Flags.gtype, 0,
+                                          readwrite: true)
+          it.install_property prop
+        end
+      end
+
+      it 'creates accessor functions for the property' do
+        obj = klass.new
+        obj.the_prop = { value2: true }
+        obj.the_prop.must_equal value2: true
+      end
+    end
+
+    describe 'when deriving from a class with hidden struct size' do
+      let(:parent_class) { Regress::TestInheritDrawable }
+      let(:parent_size) do
+        GObject.type_query(parent_class.gtype).instance_size
+      end
+      let(:klass) do
+        Object.const_set("DerivedClass#{Sequence.next}", Class.new(parent_class))
+      end
+      let(:info) do
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_property GObject.param_spec_int('int-prop', 'integer property',
+                                                     'Integer Property',
+                                                     10, 20, 15,
+                                                     readwrite: true)
+        end
+      end
+
+      it 'registers a type that is bigger than the parent' do
+        klass_size = GObject.type_query(klass.gtype).instance_size
+        klass_size.must_be :>, parent_size
+      end
+
+      it 'leaves enough space in derived struct layout' do
+        struct_size = klass::Struct.size
+        struct_size.must_be :>, parent_size
       end
     end
 
     describe 'with type info containing an overridden g_name' do
       let(:info) do
-        GirFFI::UserDefinedTypeInfo.new klass do |it|
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
           it.g_name = "OtherName#{Sequence.next}"
         end
       end
@@ -71,8 +419,8 @@ describe GirFFI::Builders::UserDefinedBuilder do
 
     describe 'with type info containing a vfunc' do
       let(:info) do
-        GirFFI::UserDefinedTypeInfo.new klass do |it|
-          it.install_vfunc_implementation :method_int8_in, proc {|instance, in_|
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
+          it.install_vfunc_implementation :method_int8_in, proc { |instance, in_|
             instance.int = in_
           }
         end
@@ -88,7 +436,7 @@ describe GirFFI::Builders::UserDefinedBuilder do
     describe 'with type info containing a vfunc from an included Interface' do
       let(:info) do
         klass.class_eval { include GIMarshallingTests::Interface }
-        GirFFI::UserDefinedTypeInfo.new klass do |it|
+        GirFFI::UserDefinedObjectInfo.new klass do |it|
           it.install_vfunc_implementation :test_int8_in,
                                           proc { |instance, in_| instance.int = in_ }
         end

data/test/gir_ffi/builders/vfunc_argument_builder_test.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+require 'gir_ffi_test_helper'
+
+describe GirFFI::Builders::VFuncArgumentBuilder do
+  let(:var_gen) { GirFFI::VariableNameGenerator.new }
+  let(:builder) { GirFFI::Builders::VFuncArgumentBuilder.new(var_gen, arg_info) }
+
+  describe 'for a plain in argument' do
+    let(:vfunc_info) do
+      get_vfunc_introspection_data 'GIMarshallingTests', 'Object', 'method_int8_in'
+    end
+    let(:arg_info) { vfunc_info.args[0] }
+
+    it 'has the correct value for #pre_conversion' do
+      builder.pre_conversion.must_equal ['_v1 = in_']
+    end
+
+    it 'has the correct value for #post_conversion' do
+      builder.post_conversion.must_equal []
+    end
+  end
+
+  describe 'for a transfer-none in argument' do
+    let(:vfunc_info) do
+      get_vfunc_introspection_data 'GIMarshallingTests', 'Object', 'vfunc_in_object_transfer_none'
+    end
+    let(:arg_info) { vfunc_info.args[0] }
+
+    it 'has the correct value for #pre_conversion' do
+      builder.pre_conversion.must_equal ['_v1 = GObject::Object.wrap(object)', '_v1.ref']
+    end
+
+    it 'has the correct value for #post_conversion' do
+      builder.post_conversion.must_equal []
+    end
+  end
+
+  describe 'for a transfer-none outgoing object argument' do
+    let(:vfunc_info) do
+      get_vfunc_introspection_data 'GIMarshallingTests', 'Object', 'vfunc_out_object_transfer_none'
+    end
+    let(:arg_info) { vfunc_info.args[0] }
+
+    it 'has the correct value for #pre_conversion' do
+      builder.pre_conversion.must_equal ['_v1 = object']
+    end
+
+    it 'has the correct value for #post_conversion' do
+      builder.post_conversion.must_equal ['_v1.put_pointer 0, GObject::Object.from(_v2)']
+    end
+  end
+
+  describe 'for a full-transfer outgoing object argument' do
+    let(:vfunc_info) do
+      get_vfunc_introspection_data 'GIMarshallingTests', 'Object', 'vfunc_out_object_transfer_full'
+    end
+    let(:arg_info) { vfunc_info.args[0] }
+
+    it 'has the correct value for #pre_conversion' do
+      builder.pre_conversion.must_equal ['_v1 = object']
+    end
+
+    it 'has the correct value for #post_conversion' do
+      builder.pre_conversion
+      builder.post_conversion.must_equal ['_v2.ref', '_v1.put_pointer 0, GObject::Object.from(_v2)']
+    end
+  end
+
+  describe 'for a full-transfer outgoing non-object argument' do
+    let(:vfunc_info) do
+      get_vfunc_introspection_data('GIMarshallingTests', 'Object',
+                                   'method_int8_arg_and_out_callee')
+    end
+    let(:arg_info) { vfunc_info.args[1] }
+
+    it 'has the correct value for #pre_conversion' do
+      builder.pre_conversion.
+        must_equal ['_v1 = FFI::MemoryPointer.new(:int8).tap { |ptr| out.put_pointer 0, ptr }']
+    end
+
+    it 'has the correct value for #post_conversion' do
+      builder.post_conversion.must_equal ['_v1.put_int8 0, _v2']
+    end
+  end
+
+  describe 'for a receiver argument' do
+    let(:object_info) { get_introspection_data('GIMarshallingTests', 'Object') }
+    let(:type_info) { GirFFI::ReceiverTypeInfo.new(object_info) }
+    let(:arg_info) { GirFFI::ReceiverArgumentInfo.new(type_info) }
+
+    it 'has the correct value for #pre_conversion' do
+      builder.pre_conversion.
+        must_equal ['_v1 = GIMarshallingTests::Object.wrap(_instance)']
+    end
+
+    it 'has the correct value for #post_conversion' do
+      builder.post_conversion.must_equal []
+    end
+  end
+end

data/test/gir_ffi/builders/vfunc_builder_test.rb

@@ -99,7 +99,7 @@ describe GirFFI::Builders::VFuncBuilder do
         def self.call_with_argument_mapping(_proc, _instance, arg, out)
           _v1 = GIMarshallingTests::Object.wrap(_instance)
           _v2 = arg
-          _v3 = GirFFI::AllocationHelper.allocate(:int8).tap { |ptr| out.put_pointer 0, ptr }
+          _v3 = FFI::MemoryPointer.new(:int8).tap { |ptr| out.put_pointer 0, ptr }
           _v4 = _proc.call(_v1, _v2)
           _v3.put_int8 0, _v4
         end
@@ -164,7 +164,8 @@ describe GirFFI::Builders::VFuncBuilder do
         def self.call_with_argument_mapping(_proc, _instance)
           _v1 = GIMarshallingTests::Object.wrap(_instance)
           _v2 = _proc.call(_v1)
-          _v3 = GObject::Object.from(_v2.ref).to_ptr
+          _v2.ref
+          _v3 = GObject::Object.from(_v2).to_ptr
           return _v3
         end
         CODE
@@ -203,7 +204,8 @@ describe GirFFI::Builders::VFuncBuilder do
           _v1 = GIMarshallingTests::Object.wrap(_instance)
           _v2 = object
           _v3 = _proc.call(_v1)
-          _v2.put_pointer 0, GObject::Object.from(_v3.ref)
+          _v3.ref
+          _v2.put_pointer 0, GObject::Object.from(_v3)
         end
         CODE
 

data/test/{gir_ffi_test.rb → gir_ffi/core_test.rb}

@@ -3,7 +3,7 @@ require 'gir_ffi_test_helper'
 
 GirFFI.setup :GIMarshallingTests
 
-describe GirFFI do
+describe GirFFI::Core do
   it 'sets up cairo as Cairo' do
     GirFFI.setup :cairo
     assert Object.const_defined?(:Cairo)
@@ -25,6 +25,13 @@ describe GirFFI do
     restore_module :GObject
   end
 
+  describe '.setup' do
+    it 'passes the desired version down to the module builder' do
+      expect(GirFFI::Builder).to receive(:build_module).with('Regress', '0.1')
+      GirFFI.setup :Regress, '0.1'
+    end
+  end
+
   describe '::define_type' do
     describe 'without a block' do
       before do
@@ -57,11 +64,6 @@ describe GirFFI do
         type = GObject.type_from_instance obj
         type.must_equal @gtype
       end
-
-      it 'makes GirFFI find the new class by GType' do
-        klass = GirFFI::Builder.build_by_gtype @gtype
-        klass.must_equal @klass
-      end
     end
 
     describe 'with a block with a call to #install_property' do

data/test/gir_ffi/in_out_pointer_test.rb

@@ -4,7 +4,7 @@ require 'gir_ffi_test_helper'
 describe GirFFI::InOutPointer do
   describe '.new' do
     it 'wraps an existing pointer and a type' do
-      ptr = GirFFI::AllocationHelper.safe_malloc(FFI.type_size(:int32))
+      ptr = FFI::MemoryPointer.new(:int32)
       ptr.put_int32 0, 42
       instance = GirFFI::InOutPointer.new :gint32, ptr
       instance.to_value.must_equal 42

data/test/gir_ffi/receiver_argument_info_test.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require 'gir_ffi_test_helper'
+require 'gir_ffi/receiver_argument_info'
+
+describe GirFFI::ReceiverArgumentInfo do
+  let(:dummy_type) { 'foo' }
+  let(:instance) { GirFFI::ReceiverArgumentInfo.new dummy_type }
+
+  describe '#argument_type' do
+    it 'returns the argument type' do
+      instance.argument_type.must_equal dummy_type
+    end
+  end
+
+  describe '#direction' do
+    it 'returns the correct value' do
+      instance.direction.must_equal :in
+    end
+  end
+
+  describe '#ownership_transfer' do
+    it 'returns the correct value' do
+      instance.ownership_transfer.must_equal :everything
+    end
+  end
+
+  describe '#name' do
+    it 'returns the correct value' do
+      instance.name.must_equal '_instance'
+    end
+  end
+end

data/test/gir_ffi/sized_array_test.rb

@@ -173,6 +173,40 @@ describe GirFFI::SizedArray do
     end
   end
 
+  describe '#size_in_bytes' do
+    it 'returns the correct value' do
+      sized = GirFFI::SizedArray.from :int32, 3, [1, 2, 3]
+
+      sized.size_in_bytes.must_equal 12
+    end
+  end
+
+  describe '.get_value_from_pointer' do
+    it 'returns just a pointer' do
+      sized = GirFFI::SizedArray.from :int32, 3, [1, 2, 3]
+      ptr = sized.to_ptr
+      GirFFI::SizedArray.get_value_from_pointer(ptr, 0).must_equal ptr
+    end
+
+    it 'offsets correctly' do
+      sized = GirFFI::SizedArray.from :int32, 3, [1, 2, 3]
+      ptr = sized.to_ptr
+      next_ptr = GirFFI::SizedArray.get_value_from_pointer(ptr, 4)
+      tail = GirFFI::SizedArray.from(:int32, 2, next_ptr)
+      tail.must_be :==, [2, 3]
+    end
+  end
+
+  describe '.copy_value_to_pointer' do
+    it 'copies data correctly' do
+      sized = GirFFI::SizedArray.from :int32, 3, [1, 2, 3]
+      target = FFI::MemoryPointer.new sized.size_in_bytes
+      GirFFI::SizedArray.copy_value_to_pointer(sized, target)
+      result = GirFFI::SizedArray.from :int32, 3, target
+      result.must_be :==, [1, 2, 3]
+    end
+  end
+
   it 'includes Enumerable' do
     GirFFI::SizedArray.must_include Enumerable
   end