gir_ffi 0.15.9 → 0.16.1

data/lib/gir_ffi/builders/argument_builder_collection.rb

@@ -28,11 +28,11 @@ module GirFFI
 
       def capture_variable_names
         @capture_variable_names ||=
-          all_builders.map(&:capture_variable_name).compact
+          all_builders.filter_map(&:capture_variable_name)
       end
 
       def call_argument_names
-        @call_argument_names ||= argument_builders.map(&:call_argument_name).compact
+        @call_argument_names ||= argument_builders.filter_map(&:call_argument_name)
       end
 
       def method_argument_names
@@ -50,7 +50,7 @@ module GirFFI
       end
 
       def return_value_names
-        @return_value_names ||= all_builders.map(&:return_value_name).compact
+        @return_value_names ||= all_builders.filter_map(&:return_value_name)
       end
 
       def has_return_values?
@@ -149,7 +149,7 @@ module GirFFI
 
       def base_argument_names(arguments)
         required_found = false
-        arguments.reverse.map do |it|
+        arguments.reverse.filter_map do |it|
           name = it.method_argument_name
           if it.allow_none? && !required_found
             "#{name} = nil"
@@ -157,7 +157,7 @@ module GirFFI
             required_found = true
             name
           end
-        end.compact.reverse
+        end.reverse
       end
     end
   end

data/lib/gir_ffi/builders/base_argument_builder.rb

@@ -6,13 +6,13 @@ module GirFFI
     # classes are used by FunctionBuilder to create the code that
     # processes each argument before and after the actual function call.
     class BaseArgumentBuilder
-      KEYWORDS = %w(
+      KEYWORDS = %w[
         alias and begin break case class def do
         else elsif end ensure false for if in
         module next nil not or redo rescue retry
         return self super then true undef unless
         until when while yield
-      ).freeze
+      ].freeze
 
       attr_reader :arginfo, :related_callback_builder
 

data/lib/gir_ffi/builders/base_method_builder.rb

@@ -21,14 +21,30 @@ module GirFFI
         @receiver_info = receiver_info
       end
 
-      def variable_generator
-        @variable_generator ||= VariableNameGenerator.new
-      end
-
       def method_definition
         template.method_definition
       end
 
+      # Methods used by MethodTemplate
+
+      def invocation
+        "#{lib_name}.#{@info.symbol} #{function_call_arguments.join(", ")}".strip
+      end
+
+      def method_arguments
+        argument_builder_collection.method_argument_names
+      end
+
+      def preparation
+        []
+      end
+
+      private
+
+      def variable_generator
+        @variable_generator ||= VariableNameGenerator.new
+      end
+
       def template
         @template ||= MethodTemplate.new(self, argument_builder_collection)
       end
@@ -47,8 +63,8 @@ module GirFFI
       end
 
       def return_value_builder
-        @return_value_builder = @return_value_builder_class.new(variable_generator,
-                                                                return_value_info)
+        @return_value_builder ||= @return_value_builder_class.new(variable_generator,
+                                                                  return_value_info)
       end
 
       def receiver_builder
@@ -59,7 +75,7 @@ module GirFFI
         @argument_builder_collection ||=
           ArgumentBuilderCollection.new(return_value_builder, argument_builders,
                                         error_argument_builder: error_argument,
-                                        receiver_builder:       receiver_builder)
+                                        receiver_builder: receiver_builder)
       end
 
       def error_argument
@@ -71,22 +87,6 @@ module GirFFI
           end
       end
 
-      # Methods used by MethodTemplate
-
-      def invocation
-        "#{lib_name}.#{@info.symbol} #{function_call_arguments.join(', ')}".strip
-      end
-
-      def method_arguments
-        argument_builder_collection.method_argument_names
-      end
-
-      def preparation
-        []
-      end
-
-      private
-
       def lib_name
         "#{@info.safe_namespace}::Lib"
       end

data/lib/gir_ffi/builders/constructor_builder.rb

@@ -45,7 +45,7 @@ module GirFFI
       end
 
       def invocation
-        "obj.__send__ #{initializer_name.to_sym.inspect}, #{method_arguments.join(', ')}"
+        "obj.__send__ #{initializer_name.to_sym.inspect}, #{method_arguments.join(", ")}"
       end
 
       def result

data/lib/gir_ffi/builders/function_builder.rb

@@ -18,7 +18,7 @@ module GirFFI
 
       def result
         if argument_builder_collection.has_return_values?
-          ["return #{argument_builder_collection.return_value_names.join(', ')}"]
+          ["return #{argument_builder_collection.return_value_names.join(", ")}"]
         else
           []
         end

data/lib/gir_ffi/builders/mapping_method_builder.rb

@@ -23,7 +23,7 @@ module GirFFI
 
       def initialize(receiver_info, info, builder_class)
         super(info, CallbackReturnValueBuilder,
-              receiver_info:          receiver_info,
+              receiver_info: receiver_info,
               argument_builder_class: builder_class)
       end
 

data/lib/gir_ffi/builders/marshalling_method_builder.rb

@@ -21,7 +21,7 @@ module GirFFI
 
       def initialize(receiver_info, info)
         super(info, ClosureReturnValueBuilder,
-              receiver_info:          receiver_info,
+              receiver_info: receiver_info,
               argument_builder_class: ClosureArgumentBuilder)
       end
 
@@ -32,14 +32,14 @@ module GirFFI
       end
 
       def method_arguments
-        %w(closure return_value param_values _invocation_hint _marshal_data)
+        %w[closure return_value param_values _invocation_hint _marshal_data]
       end
 
       def preparation
         if param_names.size == 1
           ["#{param_names.first} = param_values.first.get_value_plain"]
         else
-          ["#{param_names.join(', ')} = param_values.map(&:get_value_plain)"]
+          ["#{param_names.join(", ")} = param_values.map(&:get_value_plain)"]
         end
       end
 

data/lib/gir_ffi/builders/method_template.rb

@@ -19,7 +19,7 @@ module GirFFI
 
       def method_definition
         code = +"def #{qualified_method_name}"
-        code << "(#{method_arguments.join(', ')})" if method_arguments.any?
+        code << "(#{method_arguments.join(", ")})" if method_arguments.any?
         method_lines.each { |line| code << "\n  #{line}" }
         code << "\nend\n"
       end
@@ -27,7 +27,7 @@ module GirFFI
       private
 
       def qualified_method_name
-        "#{@builder.singleton_method? ? 'self.' : ''}#{@builder.method_name}"
+        "#{@builder.singleton_method? ? "self." : ""}#{@builder.method_name}"
       end
 
       def method_arguments

data/lib/gir_ffi/builders/object_builder.rb

@@ -18,7 +18,7 @@ module GirFFI
           ObjectBase
         end
 
-        def object_class_struct
+        def class_struct_class
           GObject::TypeClass
         end
 
@@ -35,12 +35,12 @@ module GirFFI
         seek_in_ancestor_infos { |info| info.find_property property_name }
       end
 
-      def object_class_struct
-        @object_class_struct ||=
+      def class_struct_class
+        @class_struct_class ||=
           begin
-            parent_struct = parent_builder.object_class_struct
-            if object_class_struct_info
-              StructBuilder.new(object_class_struct_info,
+            parent_struct = parent_builder.class_struct_class
+            if class_struct_info
+              StructBuilder.new(class_struct_info,
                                 superclass: parent_struct).build_class
             else
               parent_struct
@@ -58,12 +58,6 @@ module GirFFI
         end
       end
 
-      protected
-
-      def object_class_struct_info
-        @object_class_struct_info ||= info.class_struct
-      end
-
       private
 
       def setup_class
@@ -76,6 +70,10 @@ module GirFFI
         setup_initializer
       end
 
+      def class_struct_info
+        @class_struct_info ||= info.class_struct
+      end
+
       # FIXME: Private method only used in subclass
       def layout_superclass
         GirFFI::Struct

data/lib/gir_ffi/builders/pointer_value_convertor.rb

@@ -23,7 +23,7 @@ module GirFFI
         when Module
           args = [value_exp, ptr_exp]
           args << offset unless offset == 0
-          "#{ffi_type_spec}.copy_value_to_pointer(#{args.join(', ')})"
+          "#{ffi_type_spec}.copy_value_to_pointer(#{args.join(", ")})"
         when Symbol
           "#{ptr_exp}.put_#{ffi_type_spec} #{offset}, #{value_exp}"
         end

data/lib/gir_ffi/builders/type_builder.rb

@@ -21,16 +21,16 @@ module GirFFI
       CACHE = {}
 
       TYPE_MAP = {
-        callback:               CallbackBuilder,
-        constant:               ConstantBuilder,
-        enum:                   EnumBuilder,
-        flags:                  FlagsBuilder,
-        interface:              InterfaceBuilder,
-        object:                 ObjectBuilder,
-        struct:                 StructBuilder,
-        union:                  UnionBuilder,
+        callback: CallbackBuilder,
+        constant: ConstantBuilder,
+        enum: EnumBuilder,
+        flags: FlagsBuilder,
+        interface: InterfaceBuilder,
+        object: ObjectBuilder,
+        struct: StructBuilder,
+        union: UnionBuilder,
         unintrospectable_boxed: UnintrospectableBoxedBuilder,
-        unintrospectable:       UnintrospectableBuilder
+        unintrospectable: UnintrospectableBuilder
       }.freeze
 
       def self.build(info)

data/lib/gir_ffi/builders/user_defined_builder.rb

@@ -78,17 +78,17 @@ module GirFFI
       end
 
       def class_init_proc
-        proc do |type_class_or_ptr, _data|
-          object_class_ptr = type_class_or_ptr.to_ptr
-          setup_properties object_class_ptr
-          setup_vfuncs object_class_ptr
+        proc do |type_class, _data|
+          class_struct_ptr = type_class.to_ptr
+          setup_properties class_struct_ptr
+          setup_vfuncs class_struct_ptr
         end
       end
 
       def interface_init_proc(interface)
-        proc do |interface_or_ptr, _data|
-          interface_ptr = interface_or_ptr.to_ptr
-          setup_interface_vfuncs interface, interface_ptr
+        proc do |type_interface, _data|
+          interface_struct_ptr = type_interface.to_ptr
+          setup_interface_vfuncs interface, interface_struct_ptr
         end
       end
 
@@ -108,42 +108,44 @@ module GirFFI
         parent_gtype.class_size + interface_gtypes.sum(&:class_size)
       end
 
-      def setup_properties(object_class_ptr)
-        object_class = GObject::ObjectClass.wrap object_class_ptr
+      def setup_properties(class_struct_ptr)
+        class_struct = GObject::ObjectClass.wrap class_struct_ptr
 
-        object_class.get_property = property_getter
-        object_class.set_property = property_setter
+        class_struct.struct[:get_property] = property_getter_func
+        class_struct.struct[:set_property] = property_setter_func
 
         property_fields.each_with_index do |property, index|
-          object_class.install_property index + 1, property.param_spec
+          class_struct.install_property index + 1, property.param_spec
         end
       end
 
-      def property_getter
-        proc do |object, _property_id, value, pspec|
+      def property_getter_func
+        getter = proc do |object, _property_id, value, pspec|
           value.set_value object.send(pspec.accessor_name)
         end
+        GObject::ObjectGetPropertyFunc.from getter
       end
 
-      def property_setter
-        proc do |object, _property_id, value, pspec|
+      def property_setter_func
+        setter = proc do |object, _property_id, value, pspec|
           object.send("#{pspec.accessor_name}=", value.get_value)
         end
+        GObject::ObjectSetPropertyFunc.from setter
       end
 
-      def setup_vfuncs(object_class_ptr)
+      def setup_vfuncs(class_struct_ptr)
         super_class_struct =
-          superclass.gir_ffi_builder.object_class_struct::Struct.new(object_class_ptr)
+          superclass.gir_ffi_builder.class_struct_class.wrap(class_struct_ptr)
 
         info.vfunc_implementations.each do |impl|
           setup_vfunc parent_info, super_class_struct, impl
         end
       end
 
-      def setup_interface_vfuncs(interface, interface_ptr)
+      def setup_interface_vfuncs(interface, interface_struct_ptr)
         interface_builder = interface.gir_ffi_builder
 
-        interface_struct = interface_builder.interface_struct::Struct.new(interface_ptr)
+        interface_struct = interface_builder.interface_struct.wrap(interface_struct_ptr)
         interface_info = interface_builder.info
 
         info.vfunc_implementations.each do |impl|
@@ -156,12 +158,8 @@ module GirFFI
         vfunc_info = ancestor_info.find_vfunc vfunc_name.to_s
         return unless vfunc_info
 
-        install_vfunc ancestor_struct, vfunc_name, vfunc_info, impl.implementation
-      end
-
-      def install_vfunc(container_struct, vfunc_name, vfunc_info, implementation)
-        vfunc = VFuncBuilder.new(vfunc_info).build_class
-        container_struct[vfunc_name] = vfunc.from implementation
+        vfunc_class = VFuncBuilder.new(vfunc_info).build_class
+        ancestor_struct.struct[vfunc_name] = vfunc_class.from(impl.implementation)
       end
 
       def properties

data/lib/gir_ffi/class_base.rb

@@ -29,10 +29,8 @@ module GirFFI
       send method_name, *arguments, &block
     end
 
-    # NOTE: JRuby should fix FFI::MemoryPointer#== to return true for
-    # equivalent FFI::Pointer. For now, user to_ptr.address
     def ==(other)
-      other.class == self.class && to_ptr.address == other.to_ptr.address
+      other.class == self.class && to_ptr == other.to_ptr
     end
 
     def self.setup_and_call(method, arguments, &block)

data/lib/gir_ffi/core.rb

@@ -40,11 +40,6 @@ module GirFFI
         raise ArgumentError, "#{klass} is not a user-defined class"
       end
 
-      if block_given?
-        warn "Using define_type with a block is deprecated." \
-             " Call the relevant functions inside the class definition instead."
-        yield info
-      end
       Builders::UserDefinedBuilder.new(info).build_class
 
       klass.gtype

data/lib/gir_ffi/ffi_ext/pointer.rb

@@ -4,6 +4,25 @@ module GirFFI
   module FFIExt
     # Extensions to FFI::Pointer
     module Pointer
+      def self.prepended(base)
+        base.class_eval do
+          size_t_getter =
+            case (size = FFI.type_size(:size_t))
+            when 4
+              :get_uint32
+            when 8
+              :get_uint64
+            else
+              raise NotImplementedError,
+                    "Don't know how to handle size_t types of size #{size}"
+            end
+
+          alias_method :get_size_t, size_t_getter
+
+          alias_method :get_gtype, :get_size_t
+        end
+      end
+
       def to_ptr
         self
       end
@@ -23,16 +42,7 @@ module GirFFI
   end
 end
 
-FFI::Pointer.prepend GirFFI::FFIExt::Pointer
-
-FFI::Pointer.class_eval do
-  size_t_getter = case FFI.type_size(:size_t)
-                  when 4
-                    :get_uint32
-                  when 8
-                    :get_uint64
-                  end
-
-  alias_method :get_size_t, size_t_getter
-  alias_method :get_gtype, :get_size_t
+# @api private
+class FFI::Pointer # rubocop:disable Style/ClassAndModuleChildren
+  prepend GirFFI::FFIExt::Pointer
 end

data/lib/gir_ffi/in_pointer.rb

@@ -75,13 +75,13 @@ module GirFFI
       end
 
       def from_module_type_array(type, ary)
-        if type == GObject::Value
-          from_gvalue_array type, ary
-        elsif type < GirFFI::ClassBase ||
-              type.singleton_class < GirFFI::InterfaceBase
-          from_struct_array type, ary
-        elsif type.singleton_class < GirFFI::EnumBase
+        return from_gvalue_array(type, ary) if type == GObject::Value
+
+        case type
+        when GirFFI::EnumLikeBase
           from_enum_array type, ary
+        when GirFFI::RegisteredTypeBase
+          from_struct_array type, ary
         else
           raise NotImplementedError, type
         end

data/lib/gir_ffi/info_ext/i_registered_type_info.rb

@@ -20,7 +20,7 @@ module GirFFI
 
       def find_instance_method(method)
         info = find_method method
-        return info if info&.method?
+        info if info&.method?
       end
 
       def find_method(_method)

data/lib/gir_ffi/info_ext/i_signal_info.rb

@@ -17,8 +17,14 @@ module GirFFI
       end
 
       def arguments_to_gvalues(instance, arguments)
-        arg_g_values = argument_types.zip(arguments).map do |type, arg|
-          type.make_g_value.tap { |it| it.set_value arg }
+        arg_g_values = args.zip(arguments).map do |arg_info, arg|
+          case arg_info.direction
+          when :in
+            type = arg_info.argument_type
+            type.make_g_value.tap { |it| it.set_value arg }
+          else
+            raise NotImplementedError
+          end
         end
 
         arg_g_values.unshift GObject::Value.wrap_instance(instance)
@@ -27,10 +33,6 @@ module GirFFI
       def gvalue_for_return_value
         return_type.make_g_value
       end
-
-      def argument_types
-        @argument_types ||= args.map(&:argument_type)
-      end
     end
   end
 end

data/lib/gir_ffi/info_ext/i_type_info.rb

@@ -8,17 +8,17 @@ module GirFFI
     module ITypeInfo
       FLATTENED_TAG_TO_GTYPE_MAP = {
         gboolean: GObject::TYPE_BOOLEAN,
-        gint32:   GObject::TYPE_INT,
-        gint64:   GObject::TYPE_INT64,
-        guint64:  GObject::TYPE_UINT64,
-        void:     GObject::TYPE_NONE
+        gint32: GObject::TYPE_INT,
+        gint64: GObject::TYPE_INT64,
+        guint64: GObject::TYPE_UINT64,
+        void: GObject::TYPE_NONE
       }.freeze
 
       FLATTENED_TAG_POINTER_TO_GTYPE_MAP = {
         array: GObject::TYPE_ARRAY,
         ghash: GObject::TYPE_HASH_TABLE,
-        strv:  GObject::TYPE_STRV,
-        utf8:  GObject::TYPE_STRING
+        strv: GObject::TYPE_STRV,
+        utf8: GObject::TYPE_STRING
       }.freeze
 
       def gtype
@@ -85,17 +85,17 @@ module GirFFI
       end
 
       TAG_TO_WRAPPER_CLASS_MAP = {
-        array:           "GLib::Array",
-        byte_array:      "GLib::ByteArray",
-        c:               "GirFFI::SizedArray",
-        error:           "GLib::Error",
-        ghash:           "GLib::HashTable",
-        glist:           "GLib::List",
-        gslist:          "GLib::SList",
-        ptr_array:       "GLib::PtrArray",
-        strv:            "GLib::Strv",
-        utf8:            "GirFFI::InPointer", # TODO: Create a string-like class
-        void:            "GirFFI::InPointer", # TODO: Create a void-pointer class
+        array: "GLib::Array",
+        byte_array: "GLib::ByteArray",
+        c: "GirFFI::SizedArray",
+        error: "GLib::Error",
+        ghash: "GLib::HashTable",
+        glist: "GLib::List",
+        gslist: "GLib::SList",
+        ptr_array: "GLib::PtrArray",
+        strv: "GLib::Strv",
+        utf8: "GirFFI::InPointer", # TODO: Create a string-like class
+        void: "GirFFI::InPointer", # TODO: Create a void-pointer class
         zero_terminated: "GirFFI::ZeroTerminated"
       }.freeze
 
@@ -214,13 +214,7 @@ module GirFFI
       end
 
       def subtype_ffi_type(index)
-        subtype = param_type(index).to_ffi_type
-        if subtype == :pointer
-          # NOTE: Don't use pointer directly to appease JRuby.
-          :"uint#{FFI.type_size(:pointer) * 8}"
-        else
-          subtype
-        end
+        param_type(index).to_ffi_type
       end
 
       def flattened_array_type

data/lib/gir_ffi/instance_method_setup.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module GirFFI
-  # Methods for setting up instance methods
+  # Methods for setting up instance methods.
+  #
+  # Depends on .gir_ffi_builder being defined in the extending class.
   module InstanceMethodSetup
     def setup_instance_method(name)
       gir_ffi_builder.setup_instance_method name

data/lib/gir_ffi/method_stubber.rb

@@ -10,7 +10,7 @@ module GirFFI
 
     def method_stub
       <<~STUB
-        def #{@info.method? ? '' : 'self.'}#{@info.safe_name} *args, &block
+        def #{@info.method? ? "" : "self."}#{@info.safe_name} *args, &block
           setup_and_call "#{@info.name}", args, &block
         end
       STUB

data/lib/gir_ffi/object_base.rb

@@ -7,8 +7,8 @@ module GirFFI
   class ObjectBase < ClassBase
     extend FFI::DataConverter
 
-    def object_class
-      self.class.object_class
+    def class_struct
+      self.class.class_struct
     end
 
     def self.native_type
@@ -64,11 +64,11 @@ module GirFFI
         raise GirFFI::SignalNotFoundError.new(name, self)
     end
 
-    def self.object_class
-      @object_class ||=
+    def self.class_struct
+      @class_struct ||=
         begin
           ptr = GObject::Lib.g_type_class_ref(gtype)
-          gir_ffi_builder.object_class_struct.wrap ptr
+          gir_ffi_builder.class_struct_class.wrap ptr
         end
     end
 

data/lib/gir_ffi/struct_like_base.rb

@@ -22,7 +22,6 @@ module GirFFI
         self
       end
 
-      # NOTE: Needed for JRuby's FFI
       def to_native(value, _context)
         value.struct
       end