gir_ffi 0.15.0 → 0.15.5

data/lib/gir_ffi/builders/base_argument_builder.rb

@@ -14,8 +14,8 @@ module GirFFI
         until when while yield
       ).freeze
 
-      attr_reader :arginfo
-      attr_reader :related_callback_builder
+      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

@@ -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_type_builder.rb

@@ -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/callback_argument_builder.rb

@@ -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

data/lib/gir_ffi/builders/callback_builder.rb

@@ -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

@@ -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}"]

data/lib/gir_ffi/builders/enum_builder.rb

@@ -16,7 +16,7 @@ module GirFFI
       end
 
       def value_spec
-        info.values.map do |vinfo|
+        value_infos.map do |vinfo|
           val = GirFFI::ArgHelper.cast_uint32_to_int32(vinfo.value)
           [vinfo.name.to_sym, val]
         end.flatten
@@ -42,7 +42,7 @@ module GirFFI
       end
 
       def setup_value_constants
-        info.values.each do |vinfo|
+        value_infos.each do |vinfo|
           optionally_define_constant klass, vinfo.constant_name do
             vinfo.value
           end
@@ -51,9 +51,9 @@ module GirFFI
 
       def setup_inspect
         klass.instance_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def self.inspect
-            "#{@namespace}::#{@classname}"
-          end
+          def self.inspect                  # def self.inspect
+            "#{@namespace}::#{@classname}"  #   "GFoo::Bar"
+          end                               # end
         RUBY
       end
 
@@ -64,6 +64,10 @@ module GirFFI
       def superclass
         EnumBase
       end
+
+      def value_infos
+        @value_infos ||= info.values
+      end
     end
   end
 end

data/lib/gir_ffi/builders/field_builder.rb

@@ -58,7 +58,8 @@ module GirFFI
         private
 
         def pointer_to_value_conversion
-          PointerValueConvertor.new(field_type_tag).pointer_to_value(field_ptr, field_offset)
+          PointerValueConvertor.new(field_type_tag)
+            .pointer_to_value(field_ptr, field_offset)
         end
 
         def field_offset
@@ -281,8 +282,8 @@ module GirFFI
       private
 
       def value_storage(typed_ptr, builder)
-        PointerValueConvertor.new(field_type_tag).
-          value_to_pointer(typed_ptr, builder.call_argument_name, info.offset)
+        PointerValueConvertor.new(field_type_tag)
+          .value_to_pointer(typed_ptr, builder.call_argument_name, info.offset)
       end
 
       def field_type_tag

data/lib/gir_ffi/builders/function_builder.rb

@@ -39,7 +39,7 @@ module GirFFI
       def receiver_call_argument
         container_type_info = ReceiverTypeInfo.new(container_info)
         if @info.instance_ownership_transfer == :everything &&
-            container_type_info.flattened_tag == :object
+           container_type_info.flattened_tag == :object
           "self.ref"
         else
           "self"

data/lib/gir_ffi/builders/interface_builder.rb

@@ -8,7 +8,9 @@ module GirFFI
     # Implements the creation of a module representing an Interface.
     class InterfaceBuilder < RegisteredTypeBuilder
       def interface_struct
-        @interface_struct ||= Builder.build_class iface_struct_info
+        @interface_struct ||=
+          StructBuilder.new(iface_struct_info,
+                            superclass: GObject::TypeInterface).build_class
       end
 
       private

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

@@ -12,13 +12,16 @@ module GirFFI
     # handler. This method converts arguments from C to Ruby, and the
     # result from Ruby to C.
     class MarshallingMethodBuilder < BaseMethodBuilder
-      def self.for_signal(receiver_info, info)
+      def self.for_signal(info)
+        container_info = info.container
+        container_type_info = ReceiverTypeInfo.new(container_info)
+        receiver_info = ReceiverArgumentInfo.new(container_type_info)
         new receiver_info, info
       end
 
       def initialize(receiver_info, info)
         super(info, ClosureReturnValueBuilder,
-              receiver_info: receiver_info,
+              receiver_info:          receiver_info,
               argument_builder_class: ClosureArgumentBuilder)
       end
 

data/lib/gir_ffi/builders/method_template.rb

@@ -18,10 +18,10 @@ module GirFFI
       end
 
       def method_definition
-        code = "def #{qualified_method_name}"
-        code += "(#{method_arguments.join(', ')})" if method_arguments.any?
-        method_lines.each { |line| code += "\n  #{line}" }
-        code + "\nend\n"
+        code = +"def #{qualified_method_name}"
+        code << "(#{method_arguments.join(', ')})" if method_arguments.any?
+        method_lines.each { |line| code << "\n  #{line}" }
+        code << "\nend\n"
       end
 
       private

data/lib/gir_ffi/builders/module_builder.rb

@@ -43,7 +43,7 @@ module GirFFI
       def find_namespaced_class_info(classname)
         name = classname.to_s
         info = gir.find_by_name(@namespace, name) ||
-          gir.find_by_name(@namespace, name.sub(/^./, &:downcase))
+               gir.find_by_name(@namespace, name.sub(/^./, &:downcase))
         unless info
           raise NameError,
                 "Class #{classname} not found in namespace #{@namespace}"
@@ -88,7 +88,9 @@ module GirFFI
         lib.extend FFI::Library
         lib.extend FFI::BitMasks
         lib.ffi_lib_flags :global, :lazy
-        lib.ffi_lib(*shared_library_specification.split(/,/)) if shared_library_specification
+        if shared_library_specification
+          lib.ffi_lib(*shared_library_specification.split(/,/))
+        end
       end
 
       def shared_library_specification

data/lib/gir_ffi/builders/null_argument_builder.rb

@@ -3,8 +3,6 @@
 module GirFFI
   # Argument builder that does nothing. Implements the Null Object pattern.
   class NullArgumentBuilder
-    def initialize(*); end
-
     def pre_conversion
       []
     end

data/lib/gir_ffi/builders/null_return_value_builder.rb

@@ -4,8 +4,6 @@ module GirFFI
   module Builders
     # Implements a blank return value matching ReturnValueBuilder's interface.
     class NullReturnValueBuilder
-      def initialize; end
-
       def array_length_idx
         -1
       end

data/lib/gir_ffi/builders/object_builder.rb

@@ -18,6 +18,10 @@ module GirFFI
           ObjectBase
         end
 
+        def object_class_struct
+          GObject::TypeClass
+        end
+
         def ancestor_infos
           []
         end
@@ -32,7 +36,16 @@ module GirFFI
       end
 
       def object_class_struct
-        @object_class_struct ||= Builder.build_class object_class_struct_info
+        @object_class_struct ||=
+          begin
+            parent_struct = parent_builder.object_class_struct
+            if object_class_struct_info
+              StructBuilder.new(object_class_struct_info,
+                                superclass: parent_struct).build_class
+            else
+              parent_struct
+            end
+          end
       end
 
       def ancestor_infos
@@ -48,8 +61,7 @@ module GirFFI
       protected
 
       def object_class_struct_info
-        @object_class_struct_info ||=
-          info.class_struct || parent_builder.object_class_struct_info
+        @object_class_struct_info ||= info.class_struct
       end
 
       private
@@ -107,9 +119,9 @@ module GirFFI
         return if vfunc_name == invoker_name
 
         klass.class_eval <<-DEF, __FILE__, __LINE__ + 1
-          def #{vfunc_name} *args, &block
-            #{invoker_name}(*args, &block)
-          end
+          def #{vfunc_name} *args, &block   # def foo *args, &block
+            #{invoker_name}(*args, &block)  #   foo_invoker *args, &block
+          end                               # end
         DEF
       end
 

data/lib/gir_ffi/builders/property_builder.rb

@@ -11,8 +11,7 @@ module GirFFI
   module Builders
     # Method builder used for the creation of property getter methods.
     class PropertyGetterBuilder
-      attr_reader :info
-      attr_reader :return_value_builder
+      attr_reader :info, :return_value_builder
 
       def initialize(info, return_value_builder)
         @return_value_builder = return_value_builder

data/lib/gir_ffi/builders/signal_closure_builder.rb

@@ -18,13 +18,11 @@ module GirFFI
       end
 
       def marshaller_definition
-        container_type_info = ReceiverTypeInfo.new(container_info)
-        receiver_info = ReceiverArgumentInfo.new(container_type_info)
-
-        MarshallingMethodBuilder.for_signal(receiver_info,
-                                            info).method_definition
+        MarshallingMethodBuilder.for_signal(info).method_definition
       end
 
+      private
+
       def klass
         @klass ||= get_or_define_class container_class, @classname, GObject::RubyClosure
       end

data/lib/gir_ffi/builders/struct_builder.rb

@@ -10,21 +10,48 @@ module GirFFI
     class StructBuilder < RegisteredTypeBuilder
       include StructLike
 
+      def initialize(info, superclass: nil)
+        @superclass = superclass
+        super info
+      end
+
+      def superclass
+        @superclass ||= if info.gtype_struct?
+                          gtype_struct_parent
+                        elsif GObject.type_fundamental(info.gtype) == GObject::TYPE_BOXED
+                          BoxedBase
+                        else
+                          StructBase
+                        end
+      end
+
+      private
+
       def layout_superclass
         GirFFI::Struct
       end
 
-      def superclass
-        # HACK: Inheritance chain is not expressed in GObject's code correctly.
-        return GObject::ObjectClass if info.full_type_name == "GObject::InitiallyUnownedClass"
-        return parent_field_type.tag_or_class if info.gtype_struct?
-        return BoxedBase if GObject.type_fundamental(info.gtype) == GObject::TYPE_BOXED
+      def klass
+        @klass ||= get_or_define_class(namespace_module, @classname) { superclass }
+      end
 
-        StructBase
+      def parent_info
+        @parent_info ||= parent_field_type&.interface
       end
 
       def parent_field_type
-        fields.first.field_type
+        fields.first&.field_type
+      end
+
+      def gtype_struct_parent
+        full_name = info.full_type_name
+        if full_name == "GObject::InitiallyUnownedClass"
+          GObject::ObjectClass
+        else
+          raise "Unable to calculate parent class for #{full_name}" unless parent_info
+
+          Builder.build_class parent_info
+        end
       end
     end
   end

data/lib/gir_ffi/builders/user_defined_builder.rb

@@ -12,6 +12,7 @@ module GirFFI
       end
 
       def setup_class
+        check_ancestry
         setup_layout
         register_type
         setup_constants
@@ -26,6 +27,12 @@ module GirFFI
 
       private
 
+      def check_ancestry
+        unless klass < GirFFI::ObjectBase
+          raise ArgumentError, "#{klass} is not a GObject class"
+        end
+      end
+
       def register_type
         @gtype = GObject.type_register_static(parent_gtype.to_i,
                                               info.g_name,
@@ -98,7 +105,7 @@ module GirFFI
       end
 
       def class_size
-        parent_gtype.class_size + interface_gtypes.map(&:class_size).inject(0, :+)
+        parent_gtype.class_size + interface_gtypes.map(&:class_size).sum
       end
 
       def setup_properties(object_class_ptr)