gir_ffi 0.13.0 → 0.13.1

data/lib/gir_ffi/struct_like_base.rb

@@ -39,12 +39,14 @@ module GirFFI
       # Create an unowned copy of the struct represented by val
       def copy_from(val)
         return unless val
+
         disown copy from(val)
       end
 
       # Wrap an owned copy of the struct represented by val
       def wrap_copy(val)
         return unless val
+
         own copy(val)
       end
 
@@ -52,6 +54,7 @@ module GirFFI
       def wrap_own(val)
         return unless val
         return if val.null?
+
         own wrap(val)
       end
 

data/lib/gir_ffi/type_map.rb

@@ -58,5 +58,26 @@ module GirFFI
         map_basic_type(type)
       end
     end
+
+    FLATTENED_TAG_TO_GTYPE_MAP = {
+      [:array, true]     => GObject::TYPE_ARRAY,
+      [:c, true]         => GObject::TYPE_POINTER,
+      [:gboolean, false] => GObject::TYPE_BOOLEAN,
+      [:ghash, true]     => GObject::TYPE_HASH_TABLE,
+      [:glist, true]     => GObject::TYPE_POINTER,
+      [:gint32, false]   => GObject::TYPE_INT,
+      [:gint64, false]   => GObject::TYPE_INT64,
+      [:guint64, false]  => GObject::TYPE_UINT64,
+      [:strv, true]      => GObject::TYPE_STRV,
+      [:utf8, true]      => GObject::TYPE_STRING,
+      [:void, true]      => GObject::TYPE_POINTER,
+      [:void, false]     => GObject::TYPE_NONE
+    }.freeze
+
+    def self.type_info_to_gtype(type_info)
+      return type_info.interface.gtype if type_info.tag == :interface
+
+      FLATTENED_TAG_TO_GTYPE_MAP.fetch [type_info.flattened_tag, type_info.pointer?]
+    end
   end
 end

data/lib/gir_ffi/user_defined_object_info.rb

@@ -20,8 +20,8 @@ module GirFFI
       @klass
     end
 
-    def install_property(property)
-      @properties << UserDefinedPropertyInfo.new(property)
+    def install_property(param_spec)
+      @properties << param_spec
     end
 
     def install_vfunc_implementation(name, implementation = nil)
@@ -58,6 +58,10 @@ module GirFFI
       nil
     end
 
+    def abstract?
+      false
+    end
+
     attr_writer :g_name
 
     def g_name

data/lib/gir_ffi/user_defined_property_info.rb

@@ -1,95 +1,137 @@
 # frozen_string_literal: true
 
 module GirFFI
-  # Represents a property of a user defined type.
+  # Represents a property of a user defined type. Wraps a GParamSpec with
+  # useful helper methods for building property accessors etc.
   class UserDefinedPropertyInfo
-    def initialize(param_spec)
-      @param_spec = param_spec
-    end
+    # Type info for user-defined property
+    class UserDefinedTypeInfo
+      include InfoExt::ITypeInfo
 
-    attr_reader :param_spec
+      def initialize(param_spec)
+        @param_spec = param_spec
+      end
 
-    def name
-      @param_spec.get_name
-    end
+      # TODO: Unify with InfoExt::ITypeInfo.flattened_tag_to_gtype_map
+      G_TYPE_TAG_MAP = {
+        GObject::TYPE_BOOLEAN => :gboolean,
+        GObject::TYPE_CHAR => :gint8,
+        GObject::TYPE_UCHAR => :guint8,
+        GObject::TYPE_FLOAT => :gfloat,
+        GObject::TYPE_DOUBLE => :gdouble,
+        GObject::TYPE_INT => :gint,
+        GObject::TYPE_UINT => :guint,
+        GObject::TYPE_LONG => :glong,
+        GObject::TYPE_ULONG => :gulong,
+        GObject::TYPE_INT64 => :gint64,
+        GObject::TYPE_UINT64 => :guint64,
+        GObject::TYPE_ENUM => :interface,
+        GObject::TYPE_FLAGS => :interface,
+        GObject::TYPE_STRING => :utf8,
+        GObject::TYPE_BOXED => :interface,
+        GObject::TYPE_OBJECT => :interface
+      }.freeze
 
-    def accessor_name
-      @param_spec.accessor_name
-    end
+      def tag
+        @tag ||= G_TYPE_TAG_MAP.fetch(fundamental_value_type)
+      end
 
-    def writable?
-      @param_spec.flags[:writable]
-    end
+      # TODO: Unify with InfoExt::ITypeInfo.flattened_tag_to_gtype_map
+      G_TYPE_POINTER_MAP = {
+        GObject::TYPE_BOOLEAN => false,
+        GObject::TYPE_CHAR => false,
+        GObject::TYPE_UCHAR => false,
+        GObject::TYPE_FLOAT => false,
+        GObject::TYPE_DOUBLE => false,
+        GObject::TYPE_INT => false,
+        GObject::TYPE_UINT => false,
+        GObject::TYPE_LONG => false,
+        GObject::TYPE_ULONG => false,
+        GObject::TYPE_INT64 => false,
+        GObject::TYPE_UINT64 => false,
+        GObject::TYPE_ENUM => false,
+        GObject::TYPE_FLAGS => false,
+        GObject::TYPE_STRING => true,
+        GObject::TYPE_BOXED => true,
+        GObject::TYPE_OBJECT => true
+      }.freeze
+
+      def pointer?
+        G_TYPE_POINTER_MAP.fetch(fundamental_value_type)
+      end
+
+      G_TYPE_INTERFACE_TAG_MAP = {
+        GObject::TYPE_ENUM => :enum,
+        GObject::TYPE_FLAGS => :flags,
+        GObject::TYPE_BOXED => :struct,
+        GObject::TYPE_OBJECT => :object
+      }.freeze
+
+      def interface_type
+        G_TYPE_INTERFACE_TAG_MAP.fetch(fundamental_value_type) if interface?
+      end
+
+      def hidden_struct_type?
+        false
+      end
+
+      def interface_class
+        @interface_class ||= Builder.build_by_gtype @param_spec.value_type if interface?
+      end
 
-    def value_type
-      @param_spec.value_type
+      def interface_class_name
+        interface_class.name if interface?
+      end
+
+      def ffi_type
+        GirFFI::TypeMap.map_basic_type(tag)
+      end
+
+      private
+
+      def value_type
+        @param_spec.value_type
+      end
+
+      def fundamental_value_type
+        @fundamental_value_type ||= GObject.type_fundamental value_type
+      end
+
+      def interface?
+        tag == :interface
+      end
     end
 
-    # TODO: Unify with InfoExt::ITypeInfo.flattened_tag_to_gtype_map
-    G_TYPE_POINTER_MAP = {
-      GObject::TYPE_BOOLEAN => false,
-      GObject::TYPE_CHAR => false,
-      GObject::TYPE_UCHAR => false,
-      GObject::TYPE_FLOAT => false,
-      GObject::TYPE_DOUBLE => false,
-      GObject::TYPE_INT => false,
-      GObject::TYPE_UINT => false,
-      GObject::TYPE_LONG => false,
-      GObject::TYPE_ULONG => false,
-      GObject::TYPE_INT64 => false,
-      GObject::TYPE_UINT64 => false,
-      GObject::TYPE_ENUM => false,
-      GObject::TYPE_FLAGS => false,
-      GObject::TYPE_STRING => true,
-      GObject::TYPE_BOXED => true,
-      GObject::TYPE_OBJECT => true
-    }.freeze
-
-    def pointer_type?
-      G_TYPE_POINTER_MAP.fetch(fundamental_value_type)
+    def initialize(param_spec, container, offset)
+      @param_spec = param_spec
+      @container = container
+      @offset = offset
     end
 
-    # TODO: Unify with InfoExt::ITypeInfo.flattened_tag_to_gtype_map
-    G_TYPE_TAG_MAP = {
-      GObject::TYPE_BOOLEAN => :gboolean,
-      GObject::TYPE_CHAR => :gint8,
-      GObject::TYPE_UCHAR => :guint8,
-      GObject::TYPE_FLOAT => :gfloat,
-      GObject::TYPE_DOUBLE => :gdouble,
-      GObject::TYPE_INT => :gint,
-      GObject::TYPE_UINT => :guint,
-      GObject::TYPE_LONG => :glong,
-      GObject::TYPE_ULONG => :gulong,
-      GObject::TYPE_INT64 => :gint64,
-      GObject::TYPE_UINT64 => :guint64,
-      GObject::TYPE_ENUM => :interface,
-      GObject::TYPE_FLAGS => :interface,
-      GObject::TYPE_STRING => :utf8,
-      GObject::TYPE_BOXED => :interface,
-      GObject::TYPE_OBJECT => :interface
-    }.freeze
-
-    def type_tag
-      G_TYPE_TAG_MAP.fetch(fundamental_value_type)
+    attr_reader :container, :offset, :param_spec
+
+    def name
+      @param_spec.accessor_name
     end
 
-    G_TYPE_INTERFACE_TAG_MAP = {
-      GObject::TYPE_ENUM => :enum,
-      GObject::TYPE_FLAGS => :flags,
-      GObject::TYPE_BOXED => :struct,
-      GObject::TYPE_OBJECT => :object
-    }.freeze
+    def field_type
+      @field_type ||= UserDefinedTypeInfo.new @param_spec
+    end
 
-    def interface_type_tag
-      G_TYPE_INTERFACE_TAG_MAP.fetch(fundamental_value_type)
+    def related_array_length_field
+      nil
     end
 
-    def fundamental_value_type
-      @fundamental_value_type ||= GObject.type_fundamental value_type
+    def writable?
+      param_spec.flags[:writable]
     end
 
     def ffi_type
-      GirFFI::TypeMap.map_basic_type(type_tag)
+      field_type.ffi_type
+    end
+
+    def field_symbol
+      name.to_sym
     end
   end
 end

data/lib/gir_ffi/version.rb

@@ -2,5 +2,5 @@
 
 # Current GirFFI version
 module GirFFI
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.13.1'.freeze
 end

data/lib/gir_ffi/zero_terminated.rb

@@ -26,6 +26,7 @@ module GirFFI
 
     def each
       return if @ptr.null?
+
       offset = 0
       while (val = read_value(offset))
         offset += ffi_type_size
@@ -41,7 +42,7 @@ module GirFFI
 
     def read_value(offset)
       val = fetch_value(offset)
-      val unless val.zero?
+      val unless null_value? val
     end
 
     def getter_method
@@ -77,5 +78,29 @@ module GirFFI
     def ffi_type_size
       @ffi_type_size ||= FFI.type_size(ffi_type)
     end
+
+    def null_check_strategy
+      @null_check_strategy ||=
+        if ffi_type == :pointer
+          :pointer
+        elsif ffi_type.is_a? Symbol
+          :numeric
+        elsif ffi_type < GirFFI::ClassBase
+          :pointer
+        elsif ffi_type.singleton_class.include? GirFFI::EnumBase
+          :enum
+        end
+    end
+
+    def null_value?(val)
+      case null_check_strategy
+      when :pointer
+        val.null?
+      when :enum
+        ffi_type.to_native(val, nil) == 0
+      else
+        val == 0
+      end
+    end
   end
 end

data/tasks/test.rake

@@ -110,6 +110,7 @@ class Listener
     return true if attrs['disguised'] == '1'
     return true if attrs['introspectable'] == '0'
     return true if attrs['glib:is-gtype-struct-for']
+
     false
   end
 end

data/test/ffi-gobject_introspection/i_repository_test.rb

@@ -69,14 +69,13 @@ describe GObjectIntrospection::IRepository do
 
     it 'passes its struct pointer to the c function just in case' do
       gir.require 'GObject', '2.0'
-      ptr = gir.instance_variable_get(:@gobj)
       allow(GObjectIntrospection::Lib).to receive(:g_irepository_get_dependencies).
         and_call_original
 
       gir.dependencies('GObject')
 
       expect(GObjectIntrospection::Lib).to have_received(:g_irepository_get_dependencies).
-        with(ptr, 'GObject')
+        with(gir, 'GObject')
     end
   end
 end

data/test/gir_ffi/builder_test.rb

@@ -87,7 +87,7 @@ describe GirFFI::Builder do
 
       found_klass = GirFFI::Builder.build_by_gtype gtype
       found_klass.name.must_be_nil
-      found_klass.ancestors.must_include GirFFI::BoxedBase
+      found_klass.superclass.must_equal GirFFI::BoxedBase
     end
   end
 
@@ -136,6 +136,14 @@ describe GirFFI::Builder do
       GirFFI::Builder.attach_ffi_function(lib, info)
     end
 
+    it 'calls attach_function with the correct types for Regress.test_enum_param' do
+      info = get_introspection_data 'Regress', 'test_enum_param'
+      expect(lib).to receive(:attach_function).
+        with('regress_test_enum_param', [Regress::TestEnum], :pointer).
+        and_return true
+      GirFFI::Builder.attach_ffi_function(lib, info)
+    end
+
     it 'does not attach the function if it is already defined' do
       info = get_introspection_data 'Regress', 'test_array_gint32_in'
       allow(lib).to receive(:method_defined?).and_return true
@@ -275,12 +283,10 @@ describe GirFFI::Builder do
     end
 
     it 'sets up the inheritance chain' do
-      ancestors = Regress::TestSubObj.ancestors
-      assert_equal [
-        Regress::TestSubObj,
-        Regress::TestObj,
-        GObject::Object
-      ], ancestors[0..2]
+      Regress::TestSubObj.registered_ancestors.
+        must_equal [Regress::TestSubObj,
+                    Regress::TestObj,
+                    GObject::Object]
     end
 
     it 'creates a Regress::TestSubObj#to_ptr method' do

data/test/gir_ffi/builders/argument_builder_test.rb

@@ -57,10 +57,6 @@ describe GirFFI::Builders::ArgumentBuilder do
       let(:arg_info) { get_introspection_data('Regress', 'test_callback_user_data').args[1] }
 
       describe 'when it is a regular argument' do
-        before do
-          builder.closure = false
-        end
-
         it 'has the correct value for method_argument_name' do
           builder.method_argument_name.must_equal arg_info.name
         end
@@ -78,7 +74,7 @@ describe GirFFI::Builders::ArgumentBuilder do
         before do
           callback = Object.new
           allow(callback).to receive(:call_argument_name).and_return 'foo'
-          builder.closure = callback
+          builder.mark_as_user_data callback
         end
 
         it 'has the correct value for method_argument_name' do

data/test/gir_ffi/builders/callback_return_value_builder_test.rb

@@ -55,7 +55,7 @@ describe GirFFI::Builders::CallbackReturnValueBuilder do
     it 'converts the result' do
       # Ensure variable names are generated in order
       builder.capture_variable_name.must_equal '_v1'
-      builder.post_conversion.must_equal ['_v2 = GIMarshallingTests::Enum.from(_v1)']
+      builder.post_conversion.must_equal ['_v2 = GIMarshallingTests::Enum.to_int(_v1)']
     end
 
     it 'returns the result of the conversion' do

data/test/gir_ffi/builders/field_builder_test.rb

@@ -11,8 +11,8 @@ describe GirFFI::Builders::FieldBuilder do
     it 'creates the right getter method' do
       expected = <<-CODE.reset_indentation
         def some_int8
-          _v1 = @struct.to_ptr + #{field_info.offset}
-          _v2 = _v1.get_int8(0)
+          _v1 = @struct.to_ptr
+          _v2 = _v1.get_int8(#{field_info.offset})
           _v2
         end
       CODE
@@ -22,9 +22,9 @@ describe GirFFI::Builders::FieldBuilder do
     it 'creates the right setter method' do
       expected = <<-CODE.reset_indentation
         def some_int8= value
-          _v1 = @struct.to_ptr + #{field_info.offset}
+          _v1 = @struct.to_ptr
           _v2 = value
-          _v1.put_int8 0, _v2
+          _v1.put_int8 #{field_info.offset}, _v2
         end
       CODE
       instance.setter_def.must_equal expected
@@ -36,8 +36,8 @@ describe GirFFI::Builders::FieldBuilder do
     it 'creates the right getter method' do
       expected = <<-CODE.reset_indentation
         def nested_a
-          _v1 = @struct.to_ptr + #{field_info.offset}
-          _v2 = Regress::TestSimpleBoxedA.get_value_from_pointer(_v1, 0)
+          _v1 = @struct.to_ptr
+          _v2 = Regress::TestSimpleBoxedA.get_value_from_pointer(_v1, #{field_info.offset})
           _v3 = Regress::TestSimpleBoxedA.wrap(_v2)
           _v3
         end
@@ -48,9 +48,9 @@ describe GirFFI::Builders::FieldBuilder do
     it 'creates the right setter method' do
       expected = <<-CODE.reset_indentation
         def nested_a= value
-          _v1 = @struct.to_ptr + #{field_info.offset}
+          _v1 = @struct.to_ptr
           _v2 = Regress::TestSimpleBoxedA.copy_from(value)
-          Regress::TestSimpleBoxedA.copy_value_to_pointer(_v2, _v1)
+          Regress::TestSimpleBoxedA.copy_value_to_pointer(_v2, _v1, #{field_info.offset})
         end
       CODE
       instance.setter_def.must_equal expected
@@ -62,8 +62,8 @@ describe GirFFI::Builders::FieldBuilder do
     it 'creates the right getter method' do
       expected = <<-CODE.reset_indentation
         def some_enum
-          _v1 = @struct.to_ptr + #{field_info.offset}
-          _v2 = Regress::TestEnum.get_value_from_pointer(_v1, 0)
+          _v1 = @struct.to_ptr
+          _v2 = Regress::TestEnum.get_value_from_pointer(_v1, #{field_info.offset})
           _v2
         end
       CODE
@@ -76,8 +76,8 @@ describe GirFFI::Builders::FieldBuilder do
     it 'creates the right getter method' do
       expected = <<-CODE.reset_indentation
         def some_union
-          _v1 = @struct.to_ptr + #{field_info.offset}
-          _v2 = GirFFI::SizedArray.get_value_from_pointer(_v1, 0)
+          _v1 = @struct.to_ptr
+          _v2 = GirFFI::SizedArray.get_value_from_pointer(_v1, #{field_info.offset})
           _v3 = GirFFI::SizedArray.wrap(Regress::TestStructE__some_union__union, 2, _v2)
           _v3
         end
@@ -88,10 +88,10 @@ describe GirFFI::Builders::FieldBuilder do
     it 'creates the right setter method' do
       expected = <<-CODE.reset_indentation
         def some_union= value
-          _v1 = @struct.to_ptr + #{field_info.offset}
+          _v1 = @struct.to_ptr
           GirFFI::ArgHelper.check_fixed_array_size 2, value, \"value\"
           _v2 = GirFFI::SizedArray.copy_from(Regress::TestStructE__some_union__union, 2, value)
-          GirFFI::SizedArray.copy_value_to_pointer(_v2, _v1)
+          GirFFI::SizedArray.copy_value_to_pointer(_v2, _v1, #{field_info.offset})
         end
       CODE
       instance.setter_def.must_equal expected
@@ -103,9 +103,9 @@ describe GirFFI::Builders::FieldBuilder do
     it 'creates the right setter method' do
       expected = <<-CODE.reset_indentation
         def class_init= value
-          _v1 = @struct.to_ptr + #{field_info.offset}
+          _v1 = @struct.to_ptr
           _v2 = GObject::ClassInitFunc.from(value)
-          GObject::ClassInitFunc.copy_value_to_pointer(_v2, _v1)
+          GObject::ClassInitFunc.copy_value_to_pointer(_v2, _v1, #{field_info.offset})
         end
       CODE
       instance.setter_def.must_equal expected
@@ -120,10 +120,10 @@ describe GirFFI::Builders::FieldBuilder do
       skip if field_info.field_type.array_length < 0
       expected = <<-CODE.reset_indentation
         def param_types
-          _v1 = @struct.to_ptr + #{n_params_field_info.offset}
-          _v2 = _v1.get_uint32(0)
-          _v3 = @struct.to_ptr + #{field_info.offset}
-          _v4 = _v3.get_pointer(0)
+          _v1 = @struct.to_ptr
+          _v2 = _v1.get_uint32(#{n_params_field_info.offset})
+          _v3 = @struct.to_ptr
+          _v4 = _v3.get_pointer(#{field_info.offset})
           _v5 = GirFFI::SizedArray.wrap(:GType, _v2, _v4)
           _v5
         end