gir_ffi 0.6.7 → 0.7.0

data/test/gir_ffi_test.rb

@@ -67,11 +67,11 @@ describe GirFFI do
       before do
         @klass = Class.new GIMarshallingTests::OverridesObject
         Object.const_set "DerivedB#{Sequence.next}", @klass
-        @gtype = GirFFI.define_type @klass do
-          install_property GObject.param_spec_int("foo", "foo bar",
-                                                  "The Foo Bar Property",
-                                                  10, 20, 15,
-                                                  3)
+        @gtype = GirFFI.define_type @klass do |info|
+          info.install_property GObject.param_spec_int("foo", "foo bar",
+                                                       "The Foo Bar Property",
+                                                       10, 20, 15,
+                                                       3)
         end
       end
 

data/test/gir_ffi_test_helper.rb

@@ -31,6 +31,10 @@ class Minitest::Test
     get_introspection_data(namespace, klass).find_signal name
   end
 
+  def get_vfunc_introspection_data namespace, klass, name
+    get_introspection_data(namespace, klass).find_vfunc name
+  end
+
   SAVED_MODULES = {}
 
   def save_module name

data/test/integration/generated_gimarshallingtests_test.rb

@@ -7,6 +7,16 @@ GirFFI.setup :GIMarshallingTests
 
 # Tests generated methods and functions in the GIMarshallingTests namespace.
 describe GIMarshallingTests do
+  let(:derived_klass) { Object.const_set("DerivedClass#{Sequence.next}",
+                                         Class.new(GIMarshallingTests::Object)) }
+
+  def make_derived_instance
+    GirFFI.define_type derived_klass do |info|
+      yield info if block_given?
+    end
+    derived_klass.new
+  end
+
   describe "GIMarshallingTests::BoxedStruct" do
     let(:instance) { GIMarshallingTests::BoxedStruct.new }
 
@@ -183,19 +193,30 @@ describe GIMarshallingTests do
 
   describe "GIMarshallingTests::Interface" do
     it "has a working method #test_int8_in" do
-      skip "Interfaces cannot be tested directly"
+      derived_klass.class_eval { include GIMarshallingTests::Interface }
+      instance = make_derived_instance do |info|
+        info.install_vfunc_implementation :test_int8_in, proc {|obj, in_| obj.int = in_ }
+      end
+      instance.test_int8_in 8
+      instance.int.must_equal 8
     end
   end
 
   describe "GIMarshallingTests::Interface2" do
-    it "must be tested" do
-      skip "Interfaces cannot be tested directly"
+    it "must be tested for clashes with Interface" do
+      skip "Needs more work to determine desired behavior"
     end
   end
 
   describe "GIMarshallingTests::Interface3" do
     it "has a working method #test_variant_array_in" do
-      skip "Interfaces cannot be tested directly"
+      derived_klass.class_eval { include GIMarshallingTests::Interface3 }
+      instance = make_derived_instance do |info|
+        info.install_vfunc_implementation :test_variant_array_in, proc {|obj, in_|
+          obj.int = in_.to_a.first.get_byte }
+      end
+      instance.test_variant_array_in [GLib::Variant.new_byte(42)]
+      instance.int.must_equal 42
     end
   end
 
@@ -325,8 +346,13 @@ describe GIMarshallingTests do
     it "has a working method #get_ref_info_for_vfunc_return_object_transfer_none" do
       skip "Needs vfunc setup"
     end
+
     it "has a working method #int8_in" do
-      skip "Needs vfunc setup"
+      derived_instance = make_derived_instance do |info|
+        info.install_vfunc_implementation :method_int8_in, proc {|obj, in_| obj.int = in_ }
+      end
+      derived_instance.int8_in 23
+      derived_instance.int.must_equal 23
     end
 
     it "has a working method #int8_out" do
@@ -367,19 +393,31 @@ describe GIMarshallingTests do
     end
 
     it "has a working method #method_int8_in" do
-      skip "Needs vfunc setup"
+      derived_instance = make_derived_instance do |info|
+        info.install_vfunc_implementation :method_int8_in, proc {|obj, in_| obj.int = in_ }
+      end
+      derived_instance.method_int8_in 108
+      derived_instance.int.must_equal 108
     end
 
     it "has a working method #method_int8_out" do
-      skip "Needs vfunc setup"
+      derived_instance = make_derived_instance do |info|
+        info.install_vfunc_implementation :method_int8_out, proc {|obj| 42 }
+      end
+      derived_instance.method_int8_out.must_equal 42
     end
 
     it "has a working method #method_str_arg_out_ret" do
-      skip "Needs vfunc setup"
+      skip unless get_vfunc_introspection_data("GIMarshallingTests", "Object",
+                                               "method_str_arg_out_ret")
+      derived_instance = make_derived_instance do |info|
+        info.install_vfunc_implementation :method_str_arg_out_ret, proc {|obj, arg| [arg, 42] }
+      end
+      derived_instance.method_str_arg_out_ret("foo").must_equal ["foo", 42]
     end
 
     it "has a working method #method_variant_array_in" do
-      skip "Needs vfunc setup"
+      skip "This function is only found in the header"
     end
 
     it "has a working method #method_with_default_implementation" do
@@ -405,44 +443,92 @@ describe GIMarshallingTests do
     it "has a working method #vfunc_caller_allocated_out_parameter" do
       skip "Needs vfunc setup"
     end
+
     it "has a working method #vfunc_meth_with_error" do
       skip "Needs vfunc setup"
     end
+
     it "has a working method #vfunc_multiple_out_parameters" do
-      skip "Needs vfunc setup"
+      derived_instance = make_derived_instance do |info|
+        info.install_vfunc_implementation(
+          :vfunc_multiple_out_parameters,
+          proc {|*args| [42.1, -142.3] })
+      end
+      result = derived_instance.vfunc_multiple_out_parameters
+      result[0].must_be_close_to 42.1
+      result[1].must_be_close_to(-142.3)
     end
+
     it "has a working method #vfunc_one_out_parameter" do
-      skip "Needs vfunc setup"
+      derived_instance = make_derived_instance do |info|
+        info.install_vfunc_implementation(
+          :vfunc_one_out_parameter,
+          proc {|*args| 23.4 })
+      end
+      derived_instance.vfunc_one_out_parameter.
+        must_be_within_epsilon 23.4
     end
+
     it "has a working method #vfunc_out_enum" do
-      skip "Needs vfunc setup"
+      skip unless get_vfunc_introspection_data("GIMarshallingTests", "Object",
+                                               "vfunc_out_enum")
+      derived_instance = make_derived_instance do |info|
+        info.install_vfunc_implementation :vfunc_out_enum, proc {|obj| :value2 }
+      end
+      derived_instance.vfunc_out_enum.must_equal :value2
     end
+
     it "has a working method #vfunc_return_enum" do
-      skip "Needs vfunc setup"
+      skip unless get_vfunc_introspection_data("GIMarshallingTests", "Object",
+                                               "vfunc_return_enum")
+      derived_instance = make_derived_instance do |info|
+        info.install_vfunc_implementation :vfunc_return_enum, proc {|obj| :value2 }
+      end
+      derived_instance.vfunc_return_enum.must_equal :value2
     end
+
     it "has a working method #vfunc_return_value_and_multiple_out_parameters" do
-      skip "Needs vfunc setup"
+      derived_instance = make_derived_instance do |info|
+        info.install_vfunc_implementation(
+          :vfunc_return_value_and_multiple_out_parameters,
+          proc {|*args| [42, -142, 3] })
+      end
+      derived_instance.vfunc_return_value_and_multiple_out_parameters.
+        must_equal [42, -142, 3]
     end
+
     it "has a working method #vfunc_return_value_and_one_out_parameter" do
-      skip "Needs vfunc setup"
+      derived_instance = make_derived_instance do |info|
+        info.install_vfunc_implementation(
+          :vfunc_return_value_and_one_out_parameter,
+          proc {|*args| [42, -142] })
+      end
+      derived_instance.vfunc_return_value_and_one_out_parameter.
+        must_equal [42, -142]
     end
+
     it "has a working method #vfunc_return_value_only" do
-      skip "Needs vfunc setup"
+      derived_instance = make_derived_instance do |info|
+        info.install_vfunc_implementation :vfunc_return_value_only, proc {|obj| 0xdeadbeef }
+      end
+      result = derived_instance.vfunc_return_value_only
+      result.must_equal 0xdeadbeef
     end
+
     it "has a working method #vfunc_with_callback" do
       skip "Needs vfunc setup"
     end
 
     describe "its 'int' property" do
       it "can be retrieved with #get_property" do
-        assert_equal 42, instance.get_property("int")
+        assert_equal 42, instance.get_property("int").get_value
       end
       it "can be retrieved with #int" do
         assert_equal 42, instance.int
       end
       it "can be set with #set_property" do
         instance.set_property("int", 13)
-        assert_equal 13, instance.get_property("int")
+        assert_equal 13, instance.get_property("int").get_value
       end
       it "can be set with #int=" do
         instance.int = 1
@@ -536,7 +622,7 @@ describe GIMarshallingTests do
 
     describe "its 'some-boolean' property" do
       it "can be retrieved with #get_property" do
-        instance.get_property("some-boolean").must_equal false
+        instance.get_property("some-boolean").get_value.must_equal false
       end
 
       it "can be retrieved with #some_boolean" do
@@ -545,12 +631,12 @@ describe GIMarshallingTests do
 
       it "can be set with #set_property" do
         instance.set_property("some-boolean", true)
-        instance.get_property("some-boolean").must_equal true
+        instance.get_property("some-boolean").get_value.must_equal true
       end
 
       it "can be set with #some_boolean=" do
         instance.some_boolean = true
-        instance.get_property("some-boolean").must_equal true
+        instance.get_property("some-boolean").get_value.must_equal true
       end
     end
 
@@ -562,21 +648,22 @@ describe GIMarshallingTests do
       end
 
       it "can be retrieved with #get_property" do
-        instance.get_property("some-boxed-glist").must_equal nil
+        instance.get_property("some-boxed-glist").get_value.must_equal nil
       end
 
       it "can be retrieved with #some_boxed_glist" do
         instance.some_boxed_glist.must_equal nil
       end
 
-      it "can be set with #set_property" do
-        instance.set_property("some-boxed-glist", [1, 2, 3])
-        instance.get_property("some-boxed-glist").to_a.must_equal [1, 2, 3]
+      it "can be set with #set_property_extended" do
+        instance.set_property_extended("some-boxed-glist", [1, 2, 3])
+        instance.some_boxed_glist.to_a.must_equal [1, 2, 3]
       end
 
       it "can be set with #some_boxed_glist=" do
         instance.some_boxed_glist = [1, 2, 3]
         instance.some_boxed_glist.to_a.must_equal [1, 2, 3]
+        instance.get_property_extended("some-boxed-glist").to_a.must_equal [1, 2, 3]
       end
     end
 
@@ -588,7 +675,7 @@ describe GIMarshallingTests do
       end
 
       it "can be retrieved with #get_property" do
-        instance.get_property("some-boxed-struct").must_equal nil
+        instance.get_property("some-boxed-struct").get_value.must_equal nil
       end
 
       it "can be retrieved with #some_boxed_struct" do
@@ -599,7 +686,7 @@ describe GIMarshallingTests do
         boxed = GIMarshallingTests::BoxedStruct.new
         boxed.long_ = 42
         instance.set_property("some-boxed-struct", boxed)
-        instance.get_property("some-boxed-struct").long_.must_equal 42
+        instance.get_property("some-boxed-struct").get_value.long_.must_equal 42
       end
 
       it "can be set with #some_boxed_struct=" do
@@ -612,7 +699,7 @@ describe GIMarshallingTests do
 
     describe "its 'some-char' property" do
       it "can be retrieved with #get_property" do
-        instance.get_property("some-char").must_equal 0
+        instance.get_property("some-char").get_value.must_equal 0
       end
 
       it "can be retrieved with #some_char" do
@@ -621,7 +708,7 @@ describe GIMarshallingTests do
 
       it "can be set with #set_property" do
         instance.set_property "some-char", 42
-        instance.get_property("some-char").must_equal 42
+        instance.get_property("some-char").get_value.must_equal 42
       end
 
       it "can be set with #some_char=" do
@@ -632,7 +719,7 @@ describe GIMarshallingTests do
 
     describe "its 'some-double' property" do
       it "can be retrieved with #get_property" do
-        instance.get_property("some-double").must_equal 0.0
+        instance.get_property("some-double").get_value.must_equal 0.0
       end
 
       it "can be retrieved with #some_double" do
@@ -641,7 +728,7 @@ describe GIMarshallingTests do
 
       it "can be set with #set_property" do
         instance.set_property("some-double", 3.14)
-        instance.get_property("some-double").must_equal 3.14
+        instance.get_property("some-double").get_value.must_equal 3.14
       end
 
       it "can be set with #some_double=" do
@@ -652,7 +739,7 @@ describe GIMarshallingTests do
 
     describe "its 'some-float' property" do
       it "can be retrieved with #get_property" do
-        instance.get_property("some-float").must_equal 0.0
+        instance.get_property("some-float").get_value.must_equal 0.0
       end
 
       it "can be retrieved with #some_float" do
@@ -661,7 +748,7 @@ describe GIMarshallingTests do
 
       it "can be set with #set_property" do
         instance.set_property("some-float", 3.14)
-        instance.get_property("some-float").must_be_close_to 3.14
+        instance.get_property("some-float").get_value.must_be_close_to 3.14
       end
 
       it "can be set with #some_float=" do
@@ -672,7 +759,7 @@ describe GIMarshallingTests do
 
     describe "its 'some-int' property" do
       it "can be retrieved with #get_property" do
-        instance.get_property("some-int").must_equal 0
+        instance.get_property("some-int").get_value.must_equal 0
       end
 
       it "can be retrieved with #some_int" do
@@ -681,7 +768,7 @@ describe GIMarshallingTests do
 
       it "can be set with #set_property" do
         instance.set_property "some-int", 4242
-        instance.get_property("some-int").must_equal 4242
+        instance.get_property("some-int").get_value.must_equal 4242
       end
 
       it "can be set with #some_int=" do
@@ -692,7 +779,7 @@ describe GIMarshallingTests do
 
     describe "its 'some-int64' property" do
       it "can be retrieved with #get_property" do
-        instance.get_property("some-int64").must_equal 0
+        instance.get_property("some-int64").get_value.must_equal 0
       end
 
       it "can be retrieved with #some_int64" do
@@ -701,7 +788,7 @@ describe GIMarshallingTests do
 
       it "can be set with #set_property" do
         instance.set_property "some-int64", 42_000_000_000_000
-        instance.get_property("some-int64").must_equal 42_000_000_000_000
+        instance.get_property("some-int64").get_value.must_equal 42_000_000_000_000
       end
 
       it "can be set with #some_int64=" do
@@ -712,7 +799,7 @@ describe GIMarshallingTests do
 
     describe "its 'some-long' property" do
       it "can be retrieved with #get_property" do
-        instance.get_property("some-long").must_equal 0
+        instance.get_property("some-long").get_value.must_equal 0
       end
 
       it "can be retrieved with #some_long" do
@@ -721,7 +808,7 @@ describe GIMarshallingTests do
 
       it "can be set with #set_property" do
         instance.set_property "some-long", 4242
-        instance.get_property("some-long").must_equal 4242
+        instance.get_property("some-long").get_value.must_equal 4242
       end
 
       it "can be set with #some_long=" do
@@ -738,7 +825,7 @@ describe GIMarshallingTests do
       end
 
       it "can be retrieved with #get_property" do
-        instance.get_property("some-object").must_be_nil
+        instance.get_property("some-object").get_value.must_be_nil
       end
 
       it "can be retrieved with #some_object" do
@@ -748,7 +835,7 @@ describe GIMarshallingTests do
       it "can be set with #set_property" do
         ob = GIMarshallingTests::Object.new 42
         instance.set_property "some-object", ob
-        instance.get_property("some-object").must_equal ob
+        instance.get_property("some-object").get_value.must_equal ob
       end
 
       it "can be set with #some_object=" do
@@ -766,16 +853,16 @@ describe GIMarshallingTests do
       end
 
       it "can be retrieved with #get_property" do
-        instance.get_property("some-strv").must_be :==, []
+        instance.get_property("some-strv").get_value.must_be :==, []
       end
 
       it "can be retrieved with #some_strv" do
         instance.some_strv.must_be :==, []
       end
 
-      it "can be set with #set_property" do
-        instance.set_property("some-strv", ["foo", "bar"])
-        instance.get_property("some-strv").must_be :==, ["foo", "bar"]
+      it "can be set with #set_property_extended" do
+        instance.set_property_extended("some-strv", ["foo", "bar"])
+        instance.get_property("some-strv").get_value.must_be :==, ["foo", "bar"]
       end
 
       it "can be set with #some_strv=" do
@@ -786,7 +873,7 @@ describe GIMarshallingTests do
 
     describe "its 'some-uchar' property" do
       it "can be retrieved with #get_property" do
-        instance.get_property("some-uchar").must_equal 0
+        instance.get_property("some-uchar").get_value.must_equal 0
       end
 
       it "can be retrieved with #some_uchar" do
@@ -795,7 +882,7 @@ describe GIMarshallingTests do
 
       it "can be set with #set_property" do
         instance.set_property "some-uchar", 42
-        instance.get_property("some-uchar").must_equal 42
+        instance.get_property("some-uchar").get_value.must_equal 42
       end
 
       it "can be set with #some_uchar=" do
@@ -806,7 +893,7 @@ describe GIMarshallingTests do
 
     describe "its 'some-uuint' property" do
       it "can be retrieved with #get_property" do
-        instance.get_property("some-uint").must_equal 0
+        instance.get_property("some-uint").get_value.must_equal 0
       end
 
       it "can be retrieved with #some_uint" do
@@ -815,7 +902,7 @@ describe GIMarshallingTests do
 
       it "can be set with #set_property" do
         instance.set_property "some-uint", 4242
-        instance.get_property("some-uint").must_equal 4242
+        instance.get_property("some-uint").get_value.must_equal 4242
       end
 
       it "can be set with #some_uint=" do
@@ -826,7 +913,7 @@ describe GIMarshallingTests do
 
     describe "its 'some-uint64' property" do
       it "can be retrieved with #get_property" do
-        instance.get_property("some-uint64").must_equal 0
+        instance.get_property("some-uint64").get_value.must_equal 0
       end
 
       it "can be retrieved with #some_uint64" do
@@ -835,7 +922,7 @@ describe GIMarshallingTests do
 
       it "can be set with #set_property" do
         instance.set_property "some-uint64", 42_000_000_000_000
-        instance.get_property("some-uint64").must_equal 42_000_000_000_000
+        instance.get_property("some-uint64").get_value.must_equal 42_000_000_000_000
       end
 
       it "can be set with #some_uint64=" do
@@ -846,7 +933,7 @@ describe GIMarshallingTests do
 
     describe "its 'some-ulong' property" do
       it "can be retrieved with #get_property" do
-        instance.get_property("some-ulong").must_equal 0
+        instance.get_property("some-ulong").get_value.must_equal 0
       end
 
       it "can be retrieved with #some_ulong" do
@@ -855,7 +942,7 @@ describe GIMarshallingTests do
 
       it "can be set with #set_property" do
         instance.set_property "some-ulong", 4242
-        instance.get_property("some-ulong").must_equal 4242
+        instance.get_property("some-ulong").get_value.must_equal 4242
       end
 
       it "can be set with #some_ulong=" do
@@ -872,7 +959,7 @@ describe GIMarshallingTests do
       end
 
       it "can be retrieved with #get_property" do
-        instance.get_property("some-variant").must_be_nil
+        instance.get_property("some-variant").get_value.must_be_nil
       end
 
       it "can be retrieved with #some_variant" do
@@ -882,7 +969,7 @@ describe GIMarshallingTests do
       it "can be set with #set_property" do
         value = GLib::Variant.new_string("Foo")
         instance.set_property "some-variant", value
-        instance.get_property("some-variant").must_equal value
+        instance.get_property("some-variant").get_value.must_equal value
       end
 
       it "can be set with #some_variant=" do
@@ -1299,19 +1386,29 @@ describe GIMarshallingTests do
   end
 
   it "has a working function #callback_multiple_out_parameters" do
-    skip "Out parameters for callbacks are not supported yet"
+    result = GIMarshallingTests.callback_multiple_out_parameters proc { |*args|
+      [12.0, 13.0]
+    }
+    result.must_equal [12.0, 13.0]
   end
 
   it "has a working function #callback_one_out_parameter" do
-    skip "Out parameters for callbacks are not supported yet"
+    result = GIMarshallingTests.callback_one_out_parameter proc { 42.0 }
+    result.must_equal 42.0
   end
 
   it "has a working function #callback_return_value_and_multiple_out_parameters" do
-    skip "Out parameters for callbacks are not supported yet"
+    result = GIMarshallingTests.callback_return_value_and_multiple_out_parameters proc { |*args|
+      [42, -142, 3]
+    }
+    result.must_equal [42, -142, 3]
   end
 
   it "has a working function #callback_return_value_and_one_out_parameter" do
-    skip "Out parameters for callbacks are not supported yet"
+    result = GIMarshallingTests.callback_return_value_and_one_out_parameter proc { |*args|
+      [42, -142]
+    }
+    result.must_equal [42, -142]
   end
 
   it "has a working function #callback_return_value_only" do
@@ -1906,6 +2003,13 @@ describe GIMarshallingTests do
     pass
   end
 
+  it "has a working function #gvalue_in_with_modification" do
+    skip unless get_introspection_data 'GIMarshallingTests', 'gvalue_in_with_modification'
+    gv = GObject::Value.wrap_ruby_value(42)
+    GIMarshallingTests.gvalue_in_with_modification gv
+    gv.get_value.must_equal 24
+  end
+
   it "has a working function #gvalue_in_with_type" do
     gv = GObject::Value.new
     gv.init GIMarshallingTests::SubSubObject.get_gtype