gir_ffi 0.15.0 → 0.15.5

data/test/gir_ffi/builders/function_builder_test.rb

@@ -1,550 +0,0 @@
-# frozen_string_literal: true
-
-require "gir_ffi_test_helper"
-
-describe GirFFI::Builders::FunctionBuilder do
-  describe "#method_definition" do
-    let(:builder) { GirFFI::Builders::FunctionBuilder.new function_info }
-    let(:code) { builder.method_definition }
-
-    describe "generally" do
-      let(:function_info) { get_method_introspection_data "GObject", "Object", "get_property" }
-
-      it "returns the same result when called twice" do
-        original = builder.method_definition
-        copy = builder.method_definition
-        _(copy).must_equal original
-      end
-    end
-
-    describe "for Regress:test_array_fixed_out_objects" do
-      let(:function_info) { get_introspection_data "Regress", "test_array_fixed_out_objects" }
-      it "builds a correct definition" do
-        _(code).must_equal <<~CODE
-          def self.test_array_fixed_out_objects
-            _v1 = FFI::MemoryPointer.new :pointer
-            Regress::Lib.regress_test_array_fixed_out_objects _v1
-            _v2 = GirFFI::SizedArray.wrap([:pointer, Regress::TestObj], 2, _v1.get_pointer(0))
-            return _v2
-          end
-        CODE
-      end
-    end
-
-    describe "for functions having a linked length argument" do
-      let(:function_info) { get_introspection_data "Regress", "test_array_gint16_in" }
-      it "builds a correct definition" do
-        _(code).must_equal <<~CODE
-          def self.test_array_gint16_in(ints)
-            n_ints = ints.nil? ? 0 : ints.length
-            _v1 = n_ints
-            _v2 = GirFFI::SizedArray.from(:gint16, -1, ints)
-            _v3 = Regress::Lib.regress_test_array_gint16_in _v1, _v2
-            return _v3
-          end
-        CODE
-      end
-    end
-
-    describe "for methods taking a zero-terminated array with length argument" do
-      let(:function_info) { get_method_introspection_data "Regress", "AnnotationObject", "parse_args" }
-      it "builds a correct definition" do
-        _(code).must_equal <<~CODE
-          def parse_args(argv)
-            argc = argv.nil? ? 0 : argv.length
-            _v1 = FFI::MemoryPointer.new :int32
-            _v1.put_int32 0, argc
-            _v2 = FFI::MemoryPointer.new :pointer
-            _v2.put_pointer 0, GLib::Strv.from(argv)
-            Regress::Lib.regress_annotation_object_parse_args self, _v1, _v2
-            _v3 = GLib::Strv.wrap(_v2.get_pointer(0))
-            return _v3
-          end
-        CODE
-      end
-    end
-
-    describe "for functions with callbacks" do
-      let(:function_info) { get_introspection_data "Regress", "test_callback_destroy_notify" }
-      it "builds a correct definition" do
-        _(code).must_equal <<~CODE
-          def self.test_callback_destroy_notify(&callback)
-            _v1 = Regress::TestCallbackUserData.from(callback)
-            _v2 = GirFFI::ArgHelper.store(_v1)
-            _v3 = GLib::DestroyNotify.default
-            _v4 = Regress::Lib.regress_test_callback_destroy_notify _v1, _v2, _v3
-            return _v4
-          end
-        CODE
-      end
-    end
-
-    describe "for functions that take a GValue" do
-      let(:function_info) { get_introspection_data "GIMarshallingTests", "gvalue_in" }
-      it "creates a call to GObject::Value#from" do
-        _(code).must_equal <<~CODE
-          def self.gvalue_in(value)
-            _v1 = GObject::Value.from(value)
-            GIMarshallingTests::Lib.gi_marshalling_tests_gvalue_in _v1
-          end
-        CODE
-      end
-    end
-
-    describe "for functions that return a GValue" do
-      let(:function_info) { get_introspection_data "GIMarshallingTests", "gvalue_return" }
-      it "creates a call to #get_value" do
-        _(code).must_equal <<~CODE
-          def self.gvalue_return
-            _v1 = GIMarshallingTests::Lib.gi_marshalling_tests_gvalue_return
-            _v2 = GObject::Value.wrap(_v1).get_value
-            return _v2
-          end
-        CODE
-      end
-    end
-
-    describe "for functions that have a GValue out argument" do
-      let(:function_info) { get_introspection_data "GIMarshallingTests", "gvalue_out" }
-      it "creates a call to #get_value" do
-        _(code).must_equal <<~CODE
-          def self.gvalue_out
-            _v1 = FFI::MemoryPointer.new :pointer
-            GIMarshallingTests::Lib.gi_marshalling_tests_gvalue_out _v1
-            _v2 = GObject::Value.wrap(_v1.get_pointer(0)).get_value
-            return _v2
-          end
-        CODE
-      end
-    end
-
-    describe "for functions that have a caller-allocated GValue out argument" do
-      let(:function_info) { get_introspection_data "GIMarshallingTests", "gvalue_out_caller_allocates" }
-
-      it "creates a call to #get_value" do
-        _(code).must_equal <<~CODE
-          def self.gvalue_out_caller_allocates
-            _v1 = GObject::Value.new
-            GIMarshallingTests::Lib.gi_marshalling_tests_gvalue_out_caller_allocates _v1
-            _v2 = _v1.get_value
-            return _v2
-          end
-        CODE
-      end
-    end
-
-    describe "for functions with a nullable input array" do
-      let(:function_info) { get_introspection_data "Regress", "test_array_int_null_in" }
-      it "builds correct definition" do
-        _(code).must_equal <<~CODE
-          def self.test_array_int_null_in(arr = nil)
-            len = arr.nil? ? 0 : arr.length
-            _v1 = len
-            _v2 = GirFFI::SizedArray.from(:gint32, -1, arr)
-            Regress::Lib.regress_test_array_int_null_in _v2, _v1
-          end
-        CODE
-      end
-    end
-
-    describe "for functions with a nullable output array" do
-      let(:function_info) { get_introspection_data "Regress", "test_array_int_null_out" }
-      it "builds correct definition" do
-        _(code).must_equal <<~CODE
-          def self.test_array_int_null_out
-            _v1 = FFI::MemoryPointer.new :int32
-            _v2 = FFI::MemoryPointer.new :pointer
-            Regress::Lib.regress_test_array_int_null_out _v2, _v1
-            _v3 = _v1.get_int32(0)
-            _v4 = GirFFI::SizedArray.wrap(:gint32, _v3, _v2.get_pointer(0))
-            return _v4
-          end
-        CODE
-      end
-    end
-
-    describe "for a method with an inout array with size argument" do
-      let(:function_info) { get_method_introspection_data "GIMarshallingTests", "Object", "method_array_inout" }
-      it "builds the correct definition" do
-        _(code).must_equal <<~CODE
-          def method_array_inout(ints)
-            length = ints.nil? ? 0 : ints.length
-            _v1 = FFI::MemoryPointer.new :int32
-            _v1.put_int32 0, length
-            _v2 = FFI::MemoryPointer.new :pointer
-            _v2.put_pointer 0, GirFFI::SizedArray.from(:gint32, -1, ints)
-            GIMarshallingTests::Lib.gi_marshalling_tests_object_method_array_inout self, _v2, _v1
-            _v3 = _v1.get_int32(0)
-            _v4 = GirFFI::SizedArray.wrap(:gint32, _v3, _v2.get_pointer(0))
-            return _v4
-          end
-        CODE
-      end
-    end
-
-    describe "for a simple method" do
-      let(:function_info) { get_method_introspection_data "Regress", "TestObj", "instance_method" }
-
-      it "builds a correct definition" do
-        _(code).must_equal <<~CODE
-          def instance_method
-            _v1 = Regress::Lib.regress_test_obj_instance_method self
-            return _v1
-          end
-        CODE
-      end
-    end
-
-    describe "for GLib::Variant.get_strv" do
-      let(:function_info) { get_method_introspection_data "GLib", "Variant", "get_strv" }
-      it "builds a correct definition" do
-        size_type = ":uint#{FFI.type_size(:size_t) * 8}"
-        _(code).must_equal <<~CODE
-          def get_strv
-            _v1 = FFI::MemoryPointer.new #{size_type}
-            _v2 = GLib::Lib.g_variant_get_strv self, _v1
-            _v3 = GLib::Strv.wrap(_v2)
-            return _v3
-          end
-        CODE
-      end
-    end
-
-    describe "for Regress.has_parameter_named_attrs" do
-      let(:function_info) { get_introspection_data "Regress", "has_parameter_named_attrs" }
-
-      it "builds a correct definition" do
-        _(code).must_equal <<~CODE
-          def self.has_parameter_named_attrs(foo, attributes)
-            _v1 = foo
-            GirFFI::ArgHelper.check_fixed_array_size 32, attributes, \"attributes\"
-            _v2 = GirFFI::SizedArray.from([:pointer, :guint32], 32, attributes)
-            Regress::Lib.regress_has_parameter_named_attrs _v1, _v2
-          end
-        CODE
-      end
-    end
-
-    describe "for GIMarshallingTests::Object#method_int8_arg_and_out_callee" do
-      let(:function_info) do
-        get_method_introspection_data("GIMarshallingTests", "Object",
-                                      "method_int8_arg_and_out_callee")
-      end
-
-      it "builds a correct definition" do
-        _(code).must_equal <<~CODE
-          def method_int8_arg_and_out_callee(arg)
-            _v1 = arg
-            _v2 = FFI::MemoryPointer.new :pointer
-            GIMarshallingTests::Lib.gi_marshalling_tests_object_method_int8_arg_and_out_callee self, _v1, _v2
-            _v3 = _v2.get_pointer(0).get_int8(0)
-            return _v3
-          end
-        CODE
-      end
-    end
-
-    describe "object ownership transfer" do
-      describe "for GIMarshallingTests::Object#full_in" do
-        let(:function_info) do
-          get_method_introspection_data("GIMarshallingTests", "Object",
-                                        "full_in")
-        end
-
-        # NOTE: This method is transfer-ownership: none, despite the name.
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def full_in
-              GIMarshallingTests::Lib.gi_marshalling_tests_object_full_in self
-            end
-          CODE
-        end
-      end
-
-      describe "for GIMarshallingTests::Object.full_inout" do
-        let(:function_info) do
-          get_method_introspection_data("GIMarshallingTests", "Object",
-                                        "full_inout")
-        end
-
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def self.full_inout(object)
-              _v1 = FFI::MemoryPointer.new :pointer
-              _v1.put_pointer 0, GIMarshallingTests::Object.from(object && object.ref)
-              GIMarshallingTests::Lib.gi_marshalling_tests_object_full_inout _v1
-              _v2 = GIMarshallingTests::Object.wrap(_v1.get_pointer(0))
-              return _v2
-            end
-          CODE
-        end
-      end
-
-      describe "for GIMarshallingTests::Object.full_out" do
-        let(:function_info) do
-          get_method_introspection_data("GIMarshallingTests", "Object",
-                                        "full_out")
-        end
-
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def self.full_out
-              _v1 = FFI::MemoryPointer.new :pointer
-              GIMarshallingTests::Lib.gi_marshalling_tests_object_full_out _v1
-              _v2 = GIMarshallingTests::Object.wrap(_v1.get_pointer(0))
-              return _v2
-            end
-          CODE
-        end
-      end
-
-      describe "for GIMarshallingTests::Object.full_return" do
-        let(:function_info) do
-          get_method_introspection_data("GIMarshallingTests", "Object",
-                                        "full_return")
-        end
-
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def self.full_return
-              _v1 = GIMarshallingTests::Lib.gi_marshalling_tests_object_full_return
-              _v2 = GIMarshallingTests::Object.wrap(_v1)
-              return _v2
-            end
-          CODE
-        end
-      end
-
-      describe "for GIMarshallingTests::Object#none_in" do
-        let(:function_info) do
-          get_method_introspection_data("GIMarshallingTests", "Object",
-                                        "none_in")
-        end
-
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def none_in
-              GIMarshallingTests::Lib.gi_marshalling_tests_object_none_in self
-            end
-          CODE
-        end
-      end
-
-      describe "for GIMarshallingTests::Object.none_inout" do
-        let(:function_info) do
-          get_method_introspection_data("GIMarshallingTests", "Object",
-                                        "none_inout")
-        end
-
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def self.none_inout(object)
-              _v1 = FFI::MemoryPointer.new :pointer
-              _v1.put_pointer 0, GIMarshallingTests::Object.from(object)
-              GIMarshallingTests::Lib.gi_marshalling_tests_object_none_inout _v1
-              _v2 = GIMarshallingTests::Object.wrap(_v1.get_pointer(0)).tap { |it| it && it.ref }
-              return _v2
-            end
-          CODE
-        end
-      end
-
-      describe "for GIMarshallingTests::Object.none_out" do
-        let(:function_info) do
-          get_method_introspection_data("GIMarshallingTests", "Object",
-                                        "none_out")
-        end
-
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def self.none_out
-              _v1 = FFI::MemoryPointer.new :pointer
-              GIMarshallingTests::Lib.gi_marshalling_tests_object_none_out _v1
-              _v2 = GIMarshallingTests::Object.wrap(_v1.get_pointer(0)).tap { |it| it && it.ref }
-              return _v2
-            end
-          CODE
-        end
-      end
-
-      describe "for GIMarshallingTests::Object.none_return" do
-        let(:function_info) do
-          get_method_introspection_data("GIMarshallingTests", "Object",
-                                        "none_return")
-        end
-
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def self.none_return
-              _v1 = GIMarshallingTests::Lib.gi_marshalling_tests_object_none_return
-              _v2 = GIMarshallingTests::Object.wrap(_v1).tap { |it| it && it.ref }
-              return _v2
-            end
-          CODE
-        end
-      end
-
-      describe "for Regress::TestObj#instance_method_full" do
-        let(:function_info) do
-          get_method_introspection_data("Regress", "TestObj",
-                                        "instance_method_full")
-        end
-
-        it "builds a correct definition including self.ref" do
-          _(code).must_equal <<~CODE
-            def instance_method_full
-              Regress::Lib.regress_test_obj_instance_method_full self.ref
-            end
-          CODE
-        end
-      end
-    end
-
-    describe "struct ownership transfer" do
-      describe "for Regress::FooRectangle#add" do
-        let(:function_info) do
-          get_method_introspection_data("Regress", "FooRectangle",
-                                        "add")
-        end
-
-        it "builds a correct definition without #ref" do
-          _(code).must_equal <<~CODE
-            def add(r2)
-              _v1 = Regress::FooRectangle.from(r2)
-              Regress::Lib.regress_foo_rectangle_add self, _v1
-            end
-          CODE
-        end
-      end
-    end
-
-    describe "boxed struct ownership transfer" do
-      describe "for GIMarshallingTests::BoxedStruct.inout" do
-        let(:function_info) do
-          get_method_introspection_data("GIMarshallingTests", "BoxedStruct", "inout")
-        end
-
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def self.inout(struct_)
-              _v1 = FFI::MemoryPointer.new :pointer
-              _v1.put_pointer 0, GIMarshallingTests::BoxedStruct.copy_from(struct_)
-              GIMarshallingTests::Lib.gi_marshalling_tests_boxed_struct_inout _v1
-              _v2 = GIMarshallingTests::BoxedStruct.wrap_own(_v1.get_pointer(0))
-              return _v2
-            end
-          CODE
-        end
-      end
-
-      describe "for GIMarshallingTests::BoxedStruct.out" do
-        let(:function_info) do
-          get_method_introspection_data("GIMarshallingTests", "BoxedStruct", "out")
-        end
-
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def self.out
-              _v1 = FFI::MemoryPointer.new :pointer
-              GIMarshallingTests::Lib.gi_marshalling_tests_boxed_struct_out _v1
-              _v2 = GIMarshallingTests::BoxedStruct.wrap_copy(_v1.get_pointer(0))
-              return _v2
-            end
-          CODE
-        end
-      end
-
-      describe "for GIMarshallingTests::BoxedStruct.returnv" do
-        let(:function_info) do
-          get_method_introspection_data("GIMarshallingTests", "BoxedStruct", "returnv")
-        end
-
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def self.returnv
-              _v1 = GIMarshallingTests::Lib.gi_marshalling_tests_boxed_struct_returnv
-              _v2 = GIMarshallingTests::BoxedStruct.wrap_copy(_v1)
-              return _v2
-            end
-          CODE
-        end
-      end
-    end
-
-    describe "string ownership transfer" do
-      describe "for Regress.test_utf8_out" do
-        let(:function_info) { get_introspection_data "Regress", "test_utf8_out" }
-
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def self.test_utf8_out
-              _v1 = FFI::MemoryPointer.new :pointer
-              Regress::Lib.regress_test_utf8_out _v1
-              _v2 = GirFFI::AllocationHelper.free_after _v1.get_pointer(0), &:to_utf8
-              return _v2
-            end
-          CODE
-        end
-      end
-    end
-
-    describe "for functions with an allow-none ingoing parameter" do
-      let(:function_info) { get_introspection_data "Regress", "test_utf8_null_in" }
-      it "builds correct definition with default parameter value" do
-        _(code).must_equal <<~CODE
-          def self.test_utf8_null_in(in_ = nil)
-            _v1 = GirFFI::InPointer.from_utf8(in_)
-            Regress::Lib.regress_test_utf8_null_in _v1
-          end
-        CODE
-      end
-    end
-
-    describe "for functions where some allow-none cannot be honored" do
-      let(:function_info) { get_introspection_data "GIMarshallingTests", "array_in_utf8_two_in_out_of_order" }
-      it "builds correct definition with default parameter value on the later arguments" do
-        _(code).must_equal <<~CODE
-          def self.array_in_utf8_two_in_out_of_order(a, ints, b = nil)
-            length = ints.nil? ? 0 : ints.length
-            _v1 = length
-            _v2 = GirFFI::InPointer.from_utf8(a)
-            _v3 = GirFFI::InPointer.from_utf8(b)
-            _v4 = GirFFI::SizedArray.from(:gint32, -1, ints)
-            GIMarshallingTests::Lib.gi_marshalling_tests_array_in_utf8_two_in_out_of_order _v1, _v2, _v4, _v3
-          end
-        CODE
-      end
-    end
-
-    describe "ownership transfer for an ingoing array of structs" do
-      describe "with no ownership transfer of the elements" do
-        let(:function_info) { get_introspection_data "GIMarshallingTests", "array_struct_in" }
-
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def self.array_struct_in(structs)
-              length = structs.nil? ? 0 : structs.length
-              _v1 = length
-              _v2 = GirFFI::SizedArray.from([:pointer, GIMarshallingTests::BoxedStruct], -1, structs)
-              GIMarshallingTests::Lib.gi_marshalling_tests_array_struct_in _v2, _v1
-            end
-          CODE
-        end
-      end
-      describe "with ownership transfer of the elements" do
-        let(:function_info) { get_introspection_data "GIMarshallingTests", "array_struct_take_in" }
-
-        it "builds a correct definition" do
-          _(code).must_equal <<~CODE
-            def self.array_struct_take_in(structs)
-              length = structs.nil? ? 0 : structs.length
-              _v1 = length
-              _v2 = GirFFI::SizedArray.copy_from([:pointer, GIMarshallingTests::BoxedStruct], -1, structs)
-              GIMarshallingTests::Lib.gi_marshalling_tests_array_struct_take_in _v2, _v1
-            end
-          CODE
-        end
-      end
-    end
-  end
-end