gir_ffi 0.14.1 → 0.15.4

data/lib/gir_ffi/boolean.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ffi'
+require "ffi"
 
 module GirFFI
   # Class representing a boolean (natively, an int).

data/lib/gir_ffi/boxed_base.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
 
-require 'gir_ffi/class_base'
+require "gir_ffi/class_base"
 
 module GirFFI
   # Base class for generated classes representing boxed types.
-  class BoxedBase < StructBase
-    def initialize
-      store_pointer(nil)
-    end
-
+  class BoxedBase < StructLikeBase
     def self.make_finalizer(struct)
       proc do
         if struct.owned?

data/lib/gir_ffi/builder.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'gir_ffi/builders/type_builder'
-require 'gir_ffi/builders/module_builder'
-require 'gir_ffi/builder_helper'
-require 'gir_ffi/unintrospectable_type_info'
-require 'gir_ffi/unintrospectable_boxed_info'
+require "gir_ffi/builders/type_builder"
+require "gir_ffi/builders/module_builder"
+require "gir_ffi/builder_helper"
+require "gir_ffi/unintrospectable_type_info"
+require "gir_ffi/unintrospectable_boxed_info"
 
 module GirFFI
   # Builds modules and classes based on information found in the
@@ -19,11 +19,17 @@ module GirFFI
 
     def self.build_by_gtype(gtype)
       info = GObjectIntrospection::IRepository.default.find_by_gtype gtype
-      info ||= case GObject.type_fundamental gtype
-               when GObject::TYPE_BOXED
-                 UnintrospectableBoxedInfo.new gtype
-               when GObject::TYPE_OBJECT
-                 UnintrospectableTypeInfo.new gtype
+      info ||= begin
+                 fund = GObject.type_fundamental gtype
+                 if fund == GObject::TYPE_BOXED
+                   UnintrospectableBoxedInfo.new gtype
+                 elsif fund == GObject::TYPE_OBJECT
+                   UnintrospectableTypeInfo.new gtype
+                 elsif fund >= GObject::TYPE_RESERVED_USER_FIRST
+                   UnintrospectableTypeInfo.new gtype
+                 else
+                   raise "Unable to handle type #{GObject.type_name gtype}"
+                 end
                end
 
       build_class info
@@ -36,10 +42,12 @@ module GirFFI
         unless modul.const_defined? :GIR_FFI_BUILDER
           raise "The module #{module_name} was already defined elsewhere"
         end
+
+        return modul
       end
       Builders::ModuleBuilder.new(module_name,
                                   namespace: namespace,
-                                  version: version).generate
+                                  version:   version).generate
     end
 
     # TODO: Move elsewhere, perhaps to FunctionBuilder.

data/lib/gir_ffi/builder_helper.rb

@@ -11,8 +11,16 @@ module GirFFI
       end
     end
 
-    def get_or_define_class(namespace, name, parent)
-      optionally_define_constant(namespace, name) { Class.new parent }
+    def get_or_define_class(namespace, name, parent = nil)
+      klass = optionally_define_constant(namespace, name) do
+        parent ||= yield
+        Class.new parent
+      end
+      if parent && klass.superclass != parent
+        raise "Expected #{klass} to have superclass #{parent}, found #{klass.superclass}"
+      end
+
+      klass
     end
 
     def get_or_define_module(parent, name)

data/lib/gir_ffi/builders/argument_builder.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'gir_ffi/builders/base_argument_builder'
-require 'gir_ffi/builders/closure_to_pointer_convertor'
-require 'gir_ffi/builders/full_c_to_ruby_convertor'
-require 'gir_ffi/builders/ruby_to_c_convertor'
-require 'gir_ffi/builders/pointer_value_convertor'
-require 'gir_ffi/builders/null_convertor'
+require "gir_ffi/builders/base_argument_builder"
+require "gir_ffi/builders/closure_to_pointer_convertor"
+require "gir_ffi/builders/full_c_to_ruby_convertor"
+require "gir_ffi/builders/ruby_to_c_convertor"
+require "gir_ffi/builders/pointer_value_convertor"
+require "gir_ffi/builders/null_convertor"
 
 module GirFFI
   module Builders
@@ -91,8 +91,8 @@ module GirFFI
       end
 
       def ingoing_value_storage
-        PointerValueConvertor.new(type_spec).
-          value_to_pointer(call_argument_name, ingoing_convertor.conversion)
+        PointerValueConvertor.new(type_spec)
+          .value_to_pointer(call_argument_name, ingoing_convertor.conversion)
       end
 
       def has_post_conversion?
@@ -114,7 +114,7 @@ module GirFFI
 
       def outgoing_convertor(base)
         FullCToRubyConvertor.new(type_info, base, length_argument_name,
-                                 ownership_transfer: @arginfo.ownership_transfer)
+                                 ownership_transfer: arginfo.ownership_transfer)
       end
 
       def sub_type_spec
@@ -138,11 +138,11 @@ 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
-        length_arg && length_arg.post_converted_name
+        length_arg&.post_converted_name
       end
 
       def needs_size_check?
@@ -155,12 +155,12 @@ module GirFFI
       end
 
       def skipped_in?
-        @arginfo.skip?
+        arginfo.skip?
       end
 
       def skipped_out?
-        @arginfo.skip? ||
-          @array_arg && @array_arg.specialized_type_tag == :strv
+        arginfo.skip? ||
+          array_arg && array_arg.specialized_type_tag == :strv
       end
 
       def has_output_value?
@@ -176,7 +176,7 @@ module GirFFI
       end
 
       def array_length_assignment
-        arrname = @array_arg.name
+        arrname = array_arg.name
         "#{name} = #{arrname}.nil? ? 0 : #{arrname}.length"
       end
 
@@ -200,14 +200,14 @@ module GirFFI
 
       def caller_allocated_object?
         [:struct, :array].include?(specialized_type_tag) &&
-          @arginfo.caller_allocates?
+          arginfo.caller_allocates?
       end
 
-      DESTROY_NOTIFIER = 'GLib::DestroyNotify.default'.freeze
+      DESTROY_NOTIFIER = "GLib::DestroyNotify.default"
 
       def ingoing_convertor
         if skipped_in?
-          NullConvertor.new('0')
+          NullConvertor.new("0")
         elsif destroy_notifier?
           NullConvertor.new(DESTROY_NOTIFIER)
         elsif user_data?
@@ -233,7 +233,7 @@ module GirFFI
       end
 
       def callback_argument_name
-        @related_callback_builder.call_argument_name
+        related_callback_builder.call_argument_name
       end
     end
   end

data/lib/gir_ffi/builders/argument_builder_collection.rb

@@ -121,8 +121,8 @@ module GirFFI
       end
 
       def sorted_base_argument_builders
-        @sorted_base_argument_builders ||= @base_argument_builders.
-          sort_by.with_index { |arg, i| [arg.array_length_idx, i] }
+        @sorted_base_argument_builders ||= @base_argument_builders
+          .sort_by.with_index { |arg, i| [arg.array_length_idx, i] }
       end
 
       def split_off_block_argument

data/lib/gir_ffi/builders/base_argument_builder.rb

@@ -14,7 +14,8 @@ module GirFFI
         until when while yield
       ).freeze
 
-      attr_reader :arginfo
+      attr_reader :arginfo, :related_callback_builder
+
       attr_accessor :length_arg, :array_arg
 
       def initialize(var_gen, arginfo)

data/lib/gir_ffi/builders/base_method_builder.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'gir_ffi/builders/argument_builder'
-require 'gir_ffi/builders/argument_builder_collection'
-require 'gir_ffi/builders/method_template'
-require 'gir_ffi/builders/null_argument_builder'
-require 'gir_ffi/error_argument_info'
-require 'gir_ffi/return_value_info'
-require 'gir_ffi/variable_name_generator'
+require "gir_ffi/builders/argument_builder"
+require "gir_ffi/builders/argument_builder_collection"
+require "gir_ffi/builders/method_template"
+require "gir_ffi/builders/null_argument_builder"
+require "gir_ffi/error_argument_info"
+require "gir_ffi/return_value_info"
+require "gir_ffi/variable_name_generator"
 
 module GirFFI
   module Builders
@@ -59,7 +59,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

data/lib/gir_ffi/builders/base_return_value_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'gir_ffi/builders/base_argument_builder'
+require "gir_ffi/builders/base_argument_builder"
 
 module GirFFI
   module Builders

data/lib/gir_ffi/builders/base_type_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'gir_ffi/builder_helper'
+require "gir_ffi/builder_helper"
 
 module GirFFI
   # Base class for type builders.
@@ -35,7 +35,7 @@ module GirFFI
     end
 
     def setup_constants
-      klass.const_set :GIR_INFO, info
+      optionally_define_constant(klass, :GIR_INFO) { info }
       klass.const_set :GIR_FFI_BUILDER, self
     end
 

data/lib/gir_ffi/builders/c_to_ruby_convertor.rb

@@ -35,19 +35,19 @@ module GirFFI
         when :struct, :union
           case @ownership_transfer
           when :everything
-            'wrap_own'
+            "wrap_own"
           when :nothing
-            'wrap_copy'
+            "wrap_copy"
           else
-            'wrap'
+            "wrap"
           end
         else
-          'wrap'
+          "wrap"
         end
       end
 
       def conversion_argument_list
-        conversion_arguments.join(', ')
+        conversion_arguments.join(", ")
       end
 
       def conversion_arguments

data/lib/gir_ffi/builders/callback_argument_builder.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'gir_ffi/builders/base_argument_builder'
-require 'gir_ffi/builders/c_to_ruby_convertor'
-require 'gir_ffi/builders/closure_convertor'
-require 'gir_ffi/builders/null_convertor'
-require 'gir_ffi/builders/pointer_value_convertor'
+require "gir_ffi/builders/base_argument_builder"
+require "gir_ffi/builders/c_to_ruby_convertor"
+require "gir_ffi/builders/closure_convertor"
+require "gir_ffi/builders/null_convertor"
+require "gir_ffi/builders/pointer_value_convertor"
 
 module GirFFI
   module Builders
@@ -19,6 +19,8 @@ module GirFFI
         false
       end
 
+      # All arguments to the argument mapper must always be provided. They may
+      # be nil, though.
       def allow_none?
         false
       end
@@ -53,7 +55,7 @@ module GirFFI
         when :inout
           [out_parameter_preparation, ingoing_pre_conversion]
         when :error
-          [out_parameter_preparation, 'begin']
+          [out_parameter_preparation, "begin"]
         end
       end
 
@@ -65,7 +67,7 @@ module GirFFI
           [
             "rescue => #{result_name}",
             value_to_pointer_conversion,
-            'end'
+            "end"
           ]
         else
           []
@@ -166,7 +168,7 @@ module GirFFI
       end
 
       def length_argument_name
-        length_arg && length_arg.pre_converted_name
+        length_arg&.pre_converted_name
       end
     end
   end

data/lib/gir_ffi/builders/callback_builder.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'gir_ffi/builders/base_type_builder'
-require 'gir_ffi/builders/mapping_method_builder'
-require 'gir_ffi/callback_base'
+require "gir_ffi/builders/base_type_builder"
+require "gir_ffi/builders/mapping_method_builder"
+require "gir_ffi/callback_base"
 
 module GirFFI
   module Builders
@@ -16,6 +16,20 @@ module GirFFI
         klass.class_eval mapping_method_definition, __FILE__, __LINE__
       end
 
+      def mapping_method_definition
+        MappingMethodBuilder.for_callback(info).method_definition
+      end
+
+      def argument_ffi_types
+        @argument_ffi_types ||= @info.argument_ffi_types
+      end
+
+      def return_ffi_type
+        @return_ffi_type ||= @info.return_ffi_type
+      end
+
+      private
+
       def setup_callback
         optionally_define_constant klass, :Callback do
           lib.callback callback_sym, argument_ffi_types, return_ffi_type
@@ -23,24 +37,24 @@ module GirFFI
       end
 
       def klass
-        @klass ||= get_or_define_class namespace_module, @classname, CallbackBase
+        @klass ||= get_or_define_class container_module, @classname, CallbackBase
       end
 
-      def mapping_method_definition
-        MappingMethodBuilder.for_callback(info).method_definition
+      def container_module
+        @container_module ||=
+          if @info.container
+            type_info = @info.container
+            field_info = type_info.container
+            container_class_info = field_info.container
+            namespace_module.const_get container_class_info.safe_name
+          else
+            namespace_module
+          end
       end
 
       def callback_sym
         @classname.to_sym
       end
-
-      def argument_ffi_types
-        @argument_ffi_types ||= @info.argument_ffi_types
-      end
-
-      def return_ffi_type
-        @return_ffi_type ||= @info.return_ffi_type
-      end
     end
   end
 end

data/lib/gir_ffi/builders/callback_return_value_builder.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'gir_ffi/builders/base_return_value_builder'
-require 'gir_ffi/builders/ruby_to_c_convertor'
+require "gir_ffi/builders/base_return_value_builder"
+require "gir_ffi/builders/ruby_to_c_convertor"
 
 module GirFFI
   module Builders
@@ -9,11 +9,7 @@ module GirFFI
     # callbacks.
     class CallbackReturnValueBuilder < BaseReturnValueBuilder
       def post_conversion
-        if has_post_conversion?
-          optional_outgoing_ref + base_post_conversion
-        else
-          []
-        end
+        optional_outgoing_ref + base_post_conversion
       end
 
       private
@@ -35,7 +31,9 @@ module GirFFI
       end
 
       def base_post_conversion
-        if specialized_type_tag == :object
+        if !has_post_conversion?
+          []
+        elsif specialized_type_tag == :object
           ["#{post_converted_name} = #{post_convertor.conversion}.to_ptr"]
         else
           ["#{post_converted_name} = #{post_convertor.conversion}"]