gir_ffi 0.10.2 → 0.11.0

data/lib/gir_ffi/arg_helper.rb

@@ -10,45 +10,28 @@ module GirFFI
   module ArgHelper
     OBJECT_STORE = ObjectStore.new
 
-    def self.ptr_to_utf8_length(ptr, len)
-      ptr.null? ? nil : ptr.read_string(len)
-    end
-
     def self.check_error(errpp)
       err = GLib::Error.wrap(errpp.read_pointer)
       raise GLibError, err if err
     end
 
     def self.check_fixed_array_size(size, arr, name)
-      unless arr.size == size
+      unless arr.size.equal? size
         raise ArgumentError, "#{name} should have size #{size}"
       end
     end
 
-    def self.cast_from_pointer(type, it)
+    # NOTE: Only used in List, SList and HashTable classes.
+    # TODO: Stop using basic types and instead cast type to an ITypeInfo
+    # look-alike.
+    def self.cast_from_pointer(type, ptr)
       case type
-      when :utf8, :filename
-        it.to_utf8
-      when :gint32, :gint8
-        cast_pointer_to_int32 it
+      when Symbol
+        cast_from_simple_type_pointer(type, ptr)
       when Class
-        type.wrap it
-      when :guint32
-        it.address
+        type.wrap ptr
       when Array
-        main_type, subtype = *type
-        raise "Unexpected main type #{main_type}" if main_type != :pointer
-        case subtype
-        when Array
-          container_type, *element_type = *subtype
-          raise "Unexpected container type #{container_type}" if container_type != :ghash
-          GLib::HashTable.wrap(element_type, it)
-        else
-          raise "Unexpected subtype #{subtype}"
-        end
-
-      else
-        raise "Don't know how to cast #{type}"
+        cast_from_complex_type_pointer(type, ptr)
       end
     end
 
@@ -67,5 +50,32 @@ module GirFFI
     def self.store(obj)
       OBJECT_STORE.store(obj)
     end
+
+    def self.cast_from_simple_type_pointer(type, ptr)
+      case type
+      when :utf8, :filename
+        ptr.to_utf8
+      when :gint32, :gint8
+        cast_pointer_to_int32 ptr
+      when :guint32
+        ptr.address
+      else
+        raise "Don't know how to cast #{type}"
+      end
+    end
+
+    def self.cast_from_complex_type_pointer(type, ptr)
+      main_type, (container_type, *element_type) = *type
+      case main_type
+      when :pointer
+        case container_type
+        when :ghash
+          return GLib::HashTable.wrap(element_type, ptr)
+        end
+      end
+      raise "Don't know how to cast #{type}"
+    end
+
+    private_class_method :cast_from_complex_type_pointer, :cast_from_simple_type_pointer
   end
 end

data/lib/{gir_ffi-base/glib → gir_ffi}/boolean.rb

@@ -1,19 +1,21 @@
 # frozen_string_literal: true
 require 'ffi'
-require 'gir_ffi-base/glib'
 
-module GLib
-  # Implementation of gboolean
+module GirFFI
+  # Class representing a boolean (natively, an int).
   class Boolean
     extend FFI::DataConverter
     native_type FFI::Type::INT
 
+    FROM_NATIVE = { 0 => false, 1 => true }.freeze
+    TO_NATIVE = FROM_NATIVE.invert
+
     def self.from_native(value, _context)
-      value != 0 ? true : false
+      FROM_NATIVE.fetch(value)
     end
 
     def self.to_native(value, _context)
-      value ? 1 : 0
+      TO_NATIVE.fetch(value)
     end
 
     def self.size

data/lib/gir_ffi/boxed_base.rb

@@ -5,50 +5,32 @@ module GirFFI
   # Base class for generated classes representing boxed types.
   class BoxedBase < StructBase
     def initialize
-      store_pointer(self.class::Struct.new.to_ptr)
+      store_pointer(nil)
     end
 
-    def self.make_finalizer(struct, gtype)
+    def self.make_finalizer(struct)
       proc do
         if struct.owned?
-          struct.owned = false
+          struct.owned = nil
           GObject.boxed_free gtype, struct.to_ptr
         end
       end
     end
 
-    # Wrap value and take ownership of it
-    def self.wrap_own(val)
-      wrap(val).tap { |it| it && it.struct.owned = true }
-    end
-
-    # Create an unowned copy of the struct represented by val
-    def self.copy_from(val)
-      copy from(val)
-    end
-
-    # Wrap an owned copy of the struct represented by val
-    def self.wrap_copy(val)
-      # TODO: Is this needed? We may get away with just copying on transfer away from us.
-      copy(wrap(val)).tap { |it| it && it.struct.owned = true }
-    end
-
     def self.copy(val)
-      return unless val
       ptr = GObject.boxed_copy(gtype, val)
       wrap(ptr)
     end
 
     private
 
-    def store_pointer(ptr)
+    def store_pointer(*)
       super
       make_finalizer
     end
 
     def make_finalizer
-      gtype = self.class.gtype
-      ObjectSpace.define_finalizer self, self.class.make_finalizer(@struct, gtype)
+      ObjectSpace.define_finalizer self, self.class.make_finalizer(struct)
     end
   end
 end

data/lib/gir_ffi/builder.rb

@@ -29,9 +29,9 @@ module GirFFI
     end
 
     def self.build_module(namespace, version = nil)
-      module_name = namespace.gsub(/^./, &:upcase)
-      if Kernel.const_defined? module_name
-        modul = Kernel.const_get module_name
+      module_name = namespace.sub(/\A./, &:upcase)
+      if const_defined? module_name
+        modul = const_get module_name
         unless modul.const_defined? :GIR_FFI_BUILDER
           raise "The module #{module_name} was already defined elsewhere"
         end

data/lib/gir_ffi/builders/argument_builder.rb

@@ -14,7 +14,6 @@ module GirFFI
         name if has_input_value? && !helper_argument?
       end
 
-      # TODO: Improve this so each method can only have one block argument.
       def block_argument?
         specialized_type_tag == :callback
       end
@@ -90,7 +89,7 @@ module GirFFI
         base = pointer_to_value_method_call call_argument_name, type_spec
         if needs_out_conversion?
           outgoing_convertor(base).conversion
-        elsif allocated_by_them?
+        elsif allocated_by_them? && specialized_type_tag != :void
           pointer_to_value_method_call base, sub_type_spec
         else
           base
@@ -98,7 +97,7 @@ module GirFFI
       end
 
       def outgoing_convertor(base)
-        FullCToRubyConvertor.new(@type_info, base, length_argument_name,
+        FullCToRubyConvertor.new(type_info, base, length_argument_name,
                                  ownership_transfer: @arginfo.ownership_transfer)
       end
 
@@ -111,11 +110,11 @@ module GirFFI
       end
 
       def needs_out_conversion?
-        @type_info.needs_c_to_ruby_conversion_for_functions?
+        type_info.needs_c_to_ruby_conversion_for_functions?
       end
 
       def gvalue?
-        @type_info.gvalue?
+        type_info.gvalue?
       end
 
       # Check if an out argument needs to be allocated by them, the callee. Since
@@ -123,7 +122,7 @@ module GirFFI
       # is a pointer. For example, an out parameter of type gint8* will always
       # be allocated by the caller (that's us).
       def allocated_by_them?
-        !@arginfo.caller_allocates? && @type_info.pointer?
+        !@arginfo.caller_allocates? && type_info.pointer?
       end
 
       def length_argument_name
@@ -197,8 +196,8 @@ module GirFFI
           NullConvertor.new(DESTROY_NOTIFIER)
         elsif closure?
           ClosureToPointerConvertor.new(pre_convertor_argument, @is_closure)
-        elsif @type_info.needs_ruby_to_c_conversion_for_functions?
-          RubyToCConvertor.new(@type_info, pre_convertor_argument,
+        elsif type_info.needs_ruby_to_c_conversion_for_functions?
+          RubyToCConvertor.new(type_info, pre_convertor_argument,
                                ownership_transfer: ownership_transfer)
         else
           NullConvertor.new(pre_convertor_argument)

data/lib/gir_ffi/builders/base_argument_builder.rb

@@ -38,7 +38,6 @@ module GirFFI
       end
 
       def specialized_type_tag
-        # SMELL: Law of Demeter, due to this being arginfo.argument_type.flattened_tag
         type_info.flattened_tag
       end
 

data/lib/gir_ffi/builders/callback_argument_builder.rb

@@ -144,8 +144,8 @@ module GirFFI
 
       def out_parameter_preparation
         value = if allocated_by_us?
-                  ffi_type = TypeMap.type_specification_to_ffi_type type_spec[1]
-                  "GirFFI::AllocationHelper.allocate(#{ffi_type.inspect})" \
+                  ffi_type = TypeMap.type_specification_to_ffi_type type_spec.last
+                  "FFI::MemoryPointer.new(#{ffi_type.inspect})" \
                     ".tap { |ptr| #{method_argument_name}.put_pointer 0, ptr }"
                 else
                   method_argument_name

data/lib/gir_ffi/builders/callback_return_value_builder.rb

@@ -9,16 +9,14 @@ module GirFFI
     class CallbackReturnValueBuilder < BaseReturnValueBuilder
       def post_conversion
         if has_post_conversion?
-          if type_info.flattened_tag == :object
-            ["#{post_converted_name} = #{post_convertor.conversion}.to_ptr"]
-          else
-            ["#{post_converted_name} = #{post_convertor.conversion}"]
-          end
+          optional_outgoing_ref + base_post_conversion
         else
           []
         end
       end
 
+      private
+
       def has_post_conversion?
         relevant? && needs_ruby_to_c_conversion?
       end
@@ -27,19 +25,29 @@ module GirFFI
         type_info.needs_ruby_to_c_conversion_for_callbacks?
       end
 
-      private
-
-      def post_convertor
-        @post_convertor ||= RubyToCConvertor.new(type_info, post_convertor_argument)
+      def optional_outgoing_ref
+        if outgoing_ref_needed?
+          ["#{capture_variable_name}.ref"]
+        else
+          []
+        end
       end
 
-      def post_convertor_argument
-        if ownership_transfer == :everything && specialized_type_tag == :object
-          "#{capture_variable_name}.ref"
+      def base_post_conversion
+        if specialized_type_tag == :object
+          ["#{post_converted_name} = #{post_convertor.conversion}.to_ptr"]
         else
-          capture_variable_name
+          ["#{post_converted_name} = #{post_convertor.conversion}"]
         end
       end
+
+      def post_convertor
+        @post_convertor ||= RubyToCConvertor.new(type_info, capture_variable_name)
+      end
+
+      def outgoing_ref_needed?
+        ownership_transfer == :everything && specialized_type_tag == :object
+      end
     end
   end
 end

data/lib/gir_ffi/builders/field_builder.rb

@@ -229,8 +229,9 @@ module GirFFI
 
       attr_reader :info
 
-      def initialize(field_info)
+      def initialize(field_info, container_class)
         @info = field_info
+        @container_class = container_class
       end
 
       def build
@@ -285,13 +286,7 @@ module GirFFI
         @field_type_tag ||= field_type.tag_or_class
       end
 
-      def container_class
-        @container_class ||= container_module.const_get(container_info.safe_name)
-      end
-
-      def container_module
-        @container_module ||= Object.const_get(container_info.safe_namespace)
-      end
+      attr_reader :container_class
 
       def container_info
         @container_info ||= info.container
@@ -310,9 +305,8 @@ module GirFFI
                                                 field_argument_info)
       end
 
-      # rubocop:disable Style/ZeroLengthPredicate
       def hidden_struct_type?
-        field_type.flattened_tag == :struct && field_type.interface.size == 0
+        field_type.hidden_struct_type?
       end
     end
   end

data/lib/gir_ffi/builders/module_builder.rb

@@ -32,6 +32,10 @@ module GirFFI
         true
       end
 
+      def method_available?(method)
+        function_introspection_data(method.to_s) and true
+      end
+
       def build_namespaced_class(classname)
         info = find_namespaced_class_info(classname)
         Builder.build_class info
@@ -109,11 +113,9 @@ module GirFFI
       end
 
       def gir
-        unless defined? @gir
-          @gir = GObjectIntrospection::IRepository.default
-          @gir.require @namespace, @version
+        @gir ||= GObjectIntrospection::IRepository.default.tap do |it|
+          it.require @namespace, @version
         end
-        @gir
       end
     end
   end

data/lib/gir_ffi/builders/object_builder.rb

@@ -79,12 +79,7 @@ module GirFFI
       end
 
       def parent_info
-        unless defined? @parent_info
-          @parent_info = if (parent = info.parent) && parent != info
-                           parent
-                         end
-        end
-        @parent_info
+        info.parent
       end
 
       def superclass
@@ -105,7 +100,7 @@ module GirFFI
 
       def setup_field_accessors
         eligible_fields.each do |finfo|
-          FieldBuilder.new(finfo).build
+          FieldBuilder.new(finfo, klass).build
         end
       end
 
@@ -119,9 +114,7 @@ module GirFFI
       # TODO: Create object responsible for creating these invokers
       def setup_vfunc_invokers
         info.vfuncs.each do |vfinfo|
-          if (invoker = vfinfo.invoker)
-            define_vfunc_invoker vfinfo.name, invoker.name
-          end
+          define_vfunc_invoker vfinfo.name, vfinfo.invoker_name if vfinfo.has_invoker?
         end
       end
 
@@ -137,12 +130,19 @@ module GirFFI
       def provide_initializer
         return if info.find_method 'new'
 
-        # FIXME: Only valid if the object descends from GObject::Object
-        klass.class_eval "
-          def initialize(properties = {})
-            base_initialize(properties)
-          end
-        "
+        if info.abstract?
+          klass.class_eval <<-END
+            def initialize(*)
+              raise NoMethodError
+            end
+          END
+        else
+          klass.class_eval <<-END
+            def initialize(properties = {})
+              base_initialize(properties)
+            end
+          END
+        end
       end
 
       def setup_interfaces

data/lib/gir_ffi/builders/struct_builder.rb

@@ -16,12 +16,10 @@ module GirFFI
       def superclass
         if info.gtype_struct?
           # HACK: Inheritance chain is not expressed in GObject's code correctly.
-          if info.full_type_name == 'GObject::InitiallyUnownedClass'
-            return GObject::ObjectClass
-          else
-            type = fields.first.field_type
-            return type.tag_or_class if type.tag == :interface
-          end
+          type_name = info.full_type_name
+          return GObject::ObjectClass if type_name == 'GObject::InitiallyUnownedClass'
+          type = fields.first.field_type
+          return type.tag_or_class if type.tag == :interface
         end
 
         if GObject.type_fundamental(info.gtype) == GObject::TYPE_BOXED

data/lib/gir_ffi/builders/struct_like.rb

@@ -16,7 +16,7 @@ module GirFFI
 
       def setup_field_accessors
         fields.each do |finfo|
-          FieldBuilder.new(finfo).build
+          FieldBuilder.new(finfo, klass).build
         end
       end
     end

data/lib/gir_ffi/builders/user_defined_builder.rb

@@ -11,8 +11,8 @@ module GirFFI
       end
 
       def setup_class
-        register_type
         setup_layout
+        register_type
         setup_constants
         setup_property_accessors
         setup_constructor
@@ -86,8 +86,10 @@ module GirFFI
 
       def instance_size
         size = parent_gtype.instance_size
-        properties.each do
-          size += FFI.type_size(:int32)
+        alignment = struct_class.alignment
+        properties.each do |prop|
+          type_size = FFI.type_size(prop.ffi_type)
+          size += [type_size, alignment].max
         end
         size
       end
@@ -109,13 +111,13 @@ module GirFFI
 
       def property_getter
         proc do |object, _property_id, value, pspec|
-          value.set_value object.send(pspec.get_name)
+          value.set_value object.send(pspec.accessor_name)
         end
       end
 
       def property_setter
         proc do |object, _property_id, value, pspec|
-          object.send("#{pspec.get_name}=", value.get_value)
+          object.send("#{pspec.accessor_name}=", value.get_value)
         end
       end
 
@@ -167,34 +169,92 @@ module GirFFI
       end
 
       def layout_specification
-        parent_spec = [:parent, superclass::Struct, 0]
-        offset = superclass::Struct.size
-        fields_spec = properties.flat_map do |pinfo|
-          spec = [pinfo.name.to_sym, :int32, offset]
-          offset += FFI.type_size(:int32)
+        parent_spec = [:parent, superclass::Struct]
+        offset = parent_gtype.instance_size
+
+        alignment = superclass::Struct.alignment
+        fields_spec = properties.flat_map do |param_info|
+          field_name = param_info.accessor_name
+          ffi_type = param_info.ffi_type
+          type_size = FFI.type_size(ffi_type)
+          spec = [field_name, ffi_type, offset]
+          offset += [type_size, alignment].max
           spec
         end
         parent_spec + fields_spec
       end
 
-      def setup_property_accessors
-        properties.each do |pinfo|
-          setup_accessors_for_param_info pinfo
+      # TODO: Move this to its own file.
+      # TODO: See if this or FieldTypeInfo can be merged with with
+      # UserDefinedPropertyInfo.
+      class UserDefinedPropertyFieldInfo
+        # Field info for user-defined property
+        class FieldTypeInfo
+          include InfoExt::ITypeInfo
+
+          def initialize(property_info)
+            @property_info = property_info
+          end
+
+          def tag
+            @property_info.type_tag
+          end
+
+          def pointer?
+            @property_info.pointer_type?
+          end
+
+          def interface_type
+            @property_info.interface_type_tag if tag == :interface
+          end
+
+          def hidden_struct_type?
+            false
+          end
+
+          def interface_class
+            Builder.build_by_gtype @property_info.value_type if tag == :interface
+          end
+
+          def interface_class_name
+            interface_class.name if tag == :interface
+          end
         end
-      end
 
-      def setup_accessors_for_param_info(pinfo)
-        field_name = pinfo.name
-        code = <<-CODE
-        def #{field_name}
-          @struct[:#{field_name}]
+        def initialize(property_info, container, offset)
+          @property_info = property_info
+          @container = container
+          @offset = offset
         end
-        def #{field_name}= val
-          @struct[:#{field_name}] = val
+
+        attr_reader :container, :offset
+
+        def name
+          @property_info.accessor_name
         end
-        CODE
 
-        klass.class_eval code
+        def field_type
+          @field_type ||= FieldTypeInfo.new @property_info
+        end
+
+        def related_array_length_field
+          nil
+        end
+
+        def writable?
+          @property_info.writable?
+        end
+      end
+
+      def setup_property_accessors
+        offset = parent_gtype.instance_size
+        alignment = struct_class.alignment
+        properties.each do |param_info|
+          field_info = UserDefinedPropertyFieldInfo.new(param_info, info, offset)
+          type_size = FFI.type_size(param_info.ffi_type)
+          offset += [type_size, alignment].max
+          FieldBuilder.new(field_info, klass).build
+        end
       end
 
       def method_introspection_data(_method)

data/lib/gir_ffi/builders/vfunc_argument_builder.rb

@@ -7,8 +7,16 @@ module GirFFI
     # argument mapper for vfuncs.
     class VFuncArgumentBuilder < CallbackArgumentBuilder
       def pre_conversion
-        if ingoing_ref_needed
-          super + [pre_ref_count_increase]
+        if ingoing_ref_needed?
+          super + ["#{pre_converted_name}.ref"]
+        else
+          super
+        end
+      end
+
+      def post_conversion
+        if outgoing_ref_needed?
+          ["#{result_name}.ref"] + super
         else
           super
         end
@@ -16,26 +24,13 @@ module GirFFI
 
       private
 
-      def ingoing_ref_needed
+      def ingoing_ref_needed?
         direction == :in &&
           ownership_transfer == :nothing &&
           specialized_type_tag == :object
       end
 
-      def pre_ref_count_increase
-        "#{pre_converted_name}.ref"
-      end
-
-      # SMELL: Override private method
-      def post_convertor_argument
-        if outgoing_ref_needed
-          "#{super}.ref"
-        else
-          super
-        end
-      end
-
-      def outgoing_ref_needed
+      def outgoing_ref_needed?
         direction == :out &&
           ownership_transfer == :everything &&
           specialized_type_tag == :object

data/lib/gir_ffi/class_base.rb

@@ -31,10 +31,6 @@ module GirFFI
       other.class == self.class && to_ptr.address == other.to_ptr.address
     end
 
-    def initialize
-      raise NoMethodError
-    end
-
     def self.setup_and_call(method, arguments, &block)
       method_name = try_in_ancestors(:setup_method, method.to_s)