gir_ffi 0.2.2 → 0.2.3

data/test/unit/class_base_test.rb

@@ -0,0 +1,48 @@
+require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
+
+describe GirFFI::ClassBase do
+  describe "a simple descendant" do
+    before do
+      @klass = Class.new GirFFI::ClassBase
+    end
+
+    it "has #from as a pass-through method" do
+      result = @klass.from :foo
+      result.must_equal :foo
+    end
+  end
+
+  describe "a descendant with multiple builders" do
+    it "looks up class methods in all builders" do
+      mock(builder = Object.new).setup_method("foo") { true }
+      klass = Class.new GirFFI::ClassBase
+      klass.const_set :GIR_FFI_BUILDER, builder
+
+      mock(sub_builder = Object.new).setup_method("foo") { false }
+      sub_klass = Class.new klass do
+        def self.foo; end
+      end
+      sub_klass.const_set :GIR_FFI_BUILDER, sub_builder
+
+      sub_klass.setup_and_call :foo
+    end
+
+    it "looks up class methods in all builders" do
+      mock(builder = Object.new).setup_instance_method("foo") { true }
+      klass = Class.new GirFFI::ClassBase
+      klass.const_set :GIR_FFI_BUILDER, builder
+
+      mock(sub_builder = Object.new).setup_instance_method("foo") { false }
+      sub_klass = Class.new klass do
+        def foo; end
+        def initialize; end
+        def self.new; self._real_new; end
+      end
+      sub_klass.const_set :GIR_FFI_BUILDER, sub_builder
+
+      obj = sub_klass.new
+
+      obj.setup_and_call :foo
+    end
+  end
+end

data/test/unit/function_builder_test.rb

@@ -13,13 +13,13 @@ describe GirFFI::Builder::Function do
 
   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
+    fbuilder = GirFFI::Builder::Function.new go, DummyLib
     code = fbuilder.generate
 
     expected = <<-CODE
-      def test_array_fixed_out_objects 
+      def self.test_array_fixed_out_objects 
         _v1 = GirFFI::InOutPointer.for_array [:pointer, ::Regress::TestObj]
-        ::Lib.regress_test_array_fixed_out_objects _v1
+        DummyLib.regress_test_array_fixed_out_objects _v1
         _v2 = _v1.to_sized_array_value 2
         return _v2
       end
@@ -28,8 +28,148 @@ describe GirFFI::Builder::Function do
     assert_equal expected.reset_indentation, code
   end
 
-end
+  it "builds a correct definition for functions having a linked length argument" do
+    go = get_introspection_data 'Regress', 'test_array_gint16_in'
+    fbuilder = GirFFI::Builder::Function.new go, DummyLib
+    code = fbuilder.generate
+
+    expected = <<-CODE
+      def self.test_array_gint16_in ints
+        n_ints = ints.nil? ? 0 : ints.length
+        _v1 = n_ints
+        _v2 = GirFFI::InPointer.from_array :gint16, ints
+        _v3 = DummyLib.regress_test_array_gint16_in _v1, _v2
+        return _v3
+      end
+    CODE
+
+    assert_equal expected.reset_indentation, code
+  end
 
+  it "builds a correct definition for functions with callbacks" do
+    go = get_introspection_data 'Regress', 'test_callback_destroy_notify'
+    fbuilder = GirFFI::Builder::Function.new go, DummyLib
+    code = fbuilder.generate
+
+    expected = <<-CODE
+      def self.test_callback_destroy_notify callback, user_data, notify
+        _v1 = GirFFI::CallbackHelper.wrap_in_callback_args_mapper \"Regress\", \"TestCallbackUserData\", callback
+        DummyLib::CALLBACKS << _v1
+        _v2 = GirFFI::ArgHelper.object_to_inptr user_data
+        _v3 = GirFFI::CallbackHelper.wrap_in_callback_args_mapper \"GLib\", \"DestroyNotify\", notify
+        DummyLib::CALLBACKS << _v3
+        _v4 = DummyLib.regress_test_callback_destroy_notify _v1, _v2, _v3
+        return _v4
+      end
+    CODE
 
+    assert_equal expected.reset_indentation, code
+  end
+
+  it "builds correct definition for constructors" do
+    go = get_method_introspection_data 'Regress', 'TestObj', 'new_from_file'
+    fbuilder = GirFFI::Builder::Function.new go, DummyLib
+    code = fbuilder.generate
 
+    expected = <<-CODE
+      def self.new_from_file x
+        _v1 = GirFFI::InPointer.from :utf8, x
+        _v2 = FFI::MemoryPointer.new(:pointer).write_pointer nil
+        _v3 = DummyLib.regress_test_obj_new_from_file _v1, _v2
+        GirFFI::ArgHelper.check_error(_v2)
+        _v4 = self.constructor_wrap(_v3)
+        return _v4
+      end
+    CODE
+
+    assert_equal expected.reset_indentation, code
+  end
+
+  it "creates a call to GObject::Value#from for functions that take a GValue" do
+    go = get_introspection_data 'GIMarshallingTests', 'gvalue_in'
+    fbuilder = GirFFI::Builder::Function.new go, DummyLib
+    code = fbuilder.generate
+
+    expected = <<-CODE
+      def self.gvalue_in value
+        _v1 = ::GObject::Value.from value
+        DummyLib.gi_marshalling_tests_gvalue_in _v1
+        
+      end
+    CODE
+
+    assert_equal expected.reset_indentation, code
+  end
+
+  it "builds correct definition for functions with a nullable input array" do
+    go = get_introspection_data 'Regress', 'test_array_int_null_in'
+    fbuilder = GirFFI::Builder::Function.new go, DummyLib
+    code = fbuilder.generate
 
+    expected = <<-CODE
+      def self.test_array_int_null_in arr
+        _v1 = GirFFI::InPointer.from_array :gint32, arr
+        len = arr.nil? ? 0 : arr.length
+        _v2 = len
+        DummyLib.regress_test_array_int_null_in _v1, _v2
+        
+      end
+    CODE
+
+    assert_equal expected.reset_indentation, code
+  end
+
+  it "builds correct definition for functions with a nullable output array" do
+    go = get_introspection_data 'Regress', 'test_array_int_null_out'
+    fbuilder = GirFFI::Builder::Function.new go, DummyLib
+    code = fbuilder.generate
+
+    expected = <<-CODE
+      def self.test_array_int_null_out 
+        _v1 = GirFFI::InOutPointer.for_array :gint32
+        _v2 = GirFFI::InOutPointer.for :gint32
+        DummyLib.regress_test_array_int_null_out _v1, _v2
+        _v3 = _v2.to_value
+        _v4 = _v1.to_sized_array_value _v3
+        return _v4
+      end
+    CODE
+
+    assert_equal expected.reset_indentation, code
+  end
+
+  it "builds the correct definition for a method with an inout array with size argument" do
+    go = get_method_introspection_data 'GIMarshallingTests', 'Object', 'method_array_inout'
+    fbuilder = GirFFI::Builder::Function.new go, DummyLib
+    code = fbuilder.generate
+
+    expected = <<-CODE
+      def method_array_inout ints
+        _v1 = GirFFI::InOutPointer.from_array :gint32, ints
+        length = ints.length
+        _v2 = GirFFI::InOutPointer.from :gint32, length
+        DummyLib.gi_marshalling_tests_object_method_array_inout self, _v1, _v2
+        _v3 = _v2.to_value
+        _v4 = _v1.to_sized_array_value _v3
+        return _v4
+      end
+    CODE
+
+    assert_equal expected.reset_indentation, code
+  end
+
+  it "builds a correct definition for a simple method" do
+    go = get_method_introspection_data 'Gtk', 'Widget', 'show'
+    fbuilder = GirFFI::Builder::Function.new go, DummyLib
+    code = fbuilder.generate
+
+    expected = <<-CODE
+      def show 
+        DummyLib.gtk_widget_show self
+        
+      end
+    CODE
+
+    assert_equal expected.reset_indentation, code
+  end
+end

data/test/unit/hash_table_element_type_provider_test.rb

@@ -0,0 +1,16 @@
+require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
+
+describe GirFFI::Builder::HashTableElementTypeProvider do
+  describe "#elm_t" do
+    it "returns a string with an array of the first two subtype tags" do
+      builder = Object.new
+      builder.extend GirFFI::Builder::HashTableElementTypeProvider
+
+      stub(builder).subtype_tag(0) { :foo }
+      stub(builder).subtype_tag(1) { :bar }
+
+      assert_equal "[:foo, :bar]", builder.elm_t
+    end
+  end
+end
+

data/test/unit/i_field_info_test.rb

@@ -0,0 +1,39 @@
+require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
+
+describe GirFFI::InfoExt::IFieldInfo do
+  describe "#layout_specification" do
+    it "returns an array of name, typespec and offset" do
+      testclass = Class.new do
+        include GirFFI::InfoExt::IFieldInfo
+      end
+
+      mock(type = Object.new).layout_specification_type { :bar }
+
+      field = testclass.new
+      mock(field).name { "foo" }
+      mock(field).field_type { type }
+      mock(field).offset { 0 }
+
+      result = field.layout_specification
+
+      assert_equal [:foo, :bar, 0], result
+    end
+
+    it "keeps a complex typespec intact" do
+      testclass = Class.new do
+        include GirFFI::InfoExt::IFieldInfo
+      end
+
+      mock(type = Object.new).layout_specification_type { [:bar, 2] }
+
+      field = testclass.new
+      mock(field).name { "foo" }
+      mock(field).field_type { type }
+      mock(field).offset { 0 }
+
+      result = field.layout_specification
+
+      assert_equal [:foo, [:bar, 2], 0], result
+    end
+  end
+end

data/test/unit/i_type_info_test.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
+
+describe GirFFI::InfoExt::ITypeInfo do
+  describe "#layout_specification_type" do
+    it "returns an array with elements subtype and size for type :array" do
+      testclass = Class.new do
+        include GirFFI::InfoExt::ITypeInfo
+      end
+
+      mock(subtype = Object.new).layout_specification_type { :foo }
+
+      type = testclass.new
+      mock(type).array_fixed_size { 2 }
+      mock(type).param_type(0) { subtype }
+
+      mock(GirFFI::Builder).itypeinfo_to_ffitype(type) { :array }
+
+      result = type.layout_specification_type
+
+      assert_equal [:foo, 2], result
+    end
+  end
+end

data/test/unit/list_element_type_provider_test.rb

@@ -0,0 +1,13 @@
+require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
+
+describe GirFFI::Builder::ListElementTypeProvider do
+  describe "#elm_t" do
+    it "returns a string with just the first subtype tag" do
+      builder = Object.new
+      builder.extend GirFFI::Builder::ListElementTypeProvider
+      mock(builder).subtype_tag { :foo }
+
+      assert_equal ":foo", builder.elm_t
+    end
+  end
+end

data/test/unit/module_builder_test.rb

@@ -54,7 +54,7 @@ describe GirFFI::Builder::Module do
     describe "for a :function argument" do
       it "creates a GirFFI::Builder::Function object" do
         builder = GirFFI::Builder::Module.new "Foo"
-        mock(builder).libmodule { Lib }
+        mock(builder).libmodule { DummyLib }
 
         stub(info = Object.new).info_type { :function }
 

data/test/unit/object_type_builder_test.rb

@@ -1,23 +1,6 @@
 require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
 
 describe GirFFI::Builder::Type::Object do
-  before do
-    GirFFI.setup :Regress
-  end
-
-  describe "#setup_method" do
-    it "sets up singleton methods defined in a class's parent" do
-      info = get_introspection_data 'Regress', 'TestSubObj'
-      assert_nil info.find_method "static_method"
-      parent = info.parent
-      assert_not_nil parent.find_method "static_method"
-
-      b = GirFFI::Builder::Type::Object.new(info)
-      b.setup_method "static_method"
-      pass
-    end
-  end
-
   describe "#find_property" do
     it "finds a property specified on the class itself" do
       builder = GirFFI::Builder::Type::Object.new(

data/test/unit/struct_builder_test.rb

@@ -1,5 +1,6 @@
 require File.expand_path('../gir_ffi_test_helper.rb', File.dirname(__FILE__))
 
+# FIXME: Test WithLayout directly, rather than through Struct.
 describe GirFFI::Builder::Type::Struct do
   describe "#pretty_print" do
     describe "for a struct with no methods" do
@@ -16,7 +17,7 @@ describe GirFFI::Builder::Type::Struct do
 
     describe "for a struct with a method" do
       it "returns a class block with the pretty printed method inside" do
-        # FIXME: Loads of mocks. Make info objects create their own builders.
+        # FIXME: Loads of mocks.
 
         # Function info and its builder
         stub(func_info = Object.new).info_type { :function }
@@ -42,28 +43,34 @@ describe GirFFI::Builder::Type::Struct do
 
   describe "for a struct with a simple layout" do
     before do
-      stub(@type = Object.new).pointer? { false }
-      stub(@type).tag { :gint32 }
+      @field = Object.new
 
-      stub(field = Object.new).field_type { @type }
-      stub(field).name { "bar" }
-      stub(field).offset { 0 }
-      stub(field).writable? { true }
-
-      stub(@struct = Object.new).safe_name { 'Bar' }
+      @struct = Object.new
+      stub(@struct).safe_name { 'Bar' }
       stub(@struct).namespace { 'Foo' }
-      stub(@struct).fields { [ field ] }
-      stub(@struct).find_method { }
+      stub(@struct).fields { [ @field ] }
 
       @builder = GirFFI::Builder::Type::Struct.new @struct
     end
 
     it "creates the correct layout specification" do
+      mock(@field).layout_specification { [:bar, :int32, 0] }
       spec = @builder.send :layout_specification
       assert_equal [:bar, :int32, 0], spec
     end
 
     it "creates getter and setter methods" do
+      # FIXME: Loads of stubs.
+
+      stub(type = Object.new).pointer? { false }
+      stub(type).tag { :gint32 }
+
+      stub(@field).field_type { type }
+      stub(@field).name { "bar" }
+      stub(@field).writable? { true }
+
+      stub(@struct).find_method { }
+
       m = Module.new { module Lib; end }
       stub(GirFFI::Builder).build_module('Foo') { m }
 
@@ -80,35 +87,18 @@ describe GirFFI::Builder::Type::Struct do
     end
   end
 
-  describe "for a struct with a layout with a fixed-length array" do
-    before do
-      stub(subtype = Object.new).pointer? { false }
-      stub(subtype).tag { :foo }
-
-      stub(@type = Object.new).pointer? { false }
-      stub(@type).tag { :array }
-      stub(@type).array_fixed_size { 2 }
-      stub(@type).param_type { subtype }
+  describe "for a struct with a layout with a complex type" do
+    it "does not flatten the complex type specification" do
+      mock(simplefield = Object.new).layout_specification { [:bar, :foo, 0] }
+      mock(complexfield = Object.new).layout_specification { [:baz, [:qux, 2], 0] }
+      mock(struct = Object.new).fields { [ simplefield, complexfield ] }
 
-      stub(field = Object.new).field_type { @type }
-      stub(field).name { "bar" }
-      stub(field).offset { 0 }
+      stub(struct).safe_name { 'Bar' }
+      stub(struct).namespace { 'Foo' }
 
-      stub(@struct = Object.new).safe_name { 'Bar' }
-      stub(@struct).namespace { 'Foo' }
-      stub(@struct).fields { [ field ] }
-    end
-
-    it "creates the correct ffi type for the array" do
-      builder = GirFFI::Builder::Type::Struct.new @struct
-      spec = builder.send :itypeinfo_to_ffitype_for_struct, @type
-      assert_equal [:foo, 2], spec
-    end
-
-    it "creates the correct layout specification" do
-      builder = GirFFI::Builder::Type::Struct.new @struct
+      builder = GirFFI::Builder::Type::Struct.new struct
       spec = builder.send :layout_specification
-      assert_equal [:bar, [:foo, 2], 0], spec
+      assert_equal [:bar, :foo, 0, :baz, [:qux, 2], 0], spec
     end
   end
 
@@ -130,5 +120,3 @@ describe GirFFI::Builder::Type::Struct do
     end
   end
 end
-
-