gir_ffi 0.7.4 → 0.7.5

data/lib/gir_ffi/builders/interface_builder.rb

@@ -1,13 +1,10 @@
 require 'gir_ffi/builders/registered_type_builder'
-require 'gir_ffi/builders/with_methods'
 require 'gir_ffi/interface_base'
 
 module GirFFI
   module Builders
     # Implements the creation of a module representing an Interface.
     class InterfaceBuilder < RegisteredTypeBuilder
-      include WithMethods
-
       def interface_struct
         @interface_struct ||= Builder.build_class iface_struct_info
       end

data/lib/gir_ffi/builders/mapping_method_builder.rb

@@ -1,5 +1,6 @@
 require 'gir_ffi/builders/callback_argument_builder'
 require 'gir_ffi/builders/callback_return_value_builder'
+require 'gir_ffi/builders/argument_builder_collection'
 
 module GirFFI
   module Builders
@@ -7,72 +8,30 @@ module GirFFI
     # handler. This method converts arguments from C to Ruby, and the
     # result from Ruby to C.
     class MappingMethodBuilder
-      def self.for_callback argument_infos, return_type_info
+      def self.for_callback argument_infos, return_value_info
         vargen = VariableNameGenerator.new
-        argument_builders = argument_infos.map {|arg|
-          CallbackArgumentBuilder.new vargen, arg }
-        set_up_argument_relations argument_infos, argument_builders
-        new return_type_info, vargen, argument_builders
-      end
-
-      def self.for_signal receiver_info, argument_infos, user_data_info, return_type_info
-        vargen = VariableNameGenerator.new
-
-        receiver_builder = CallbackArgumentBuilder.new vargen, receiver_info
-        argument_builders = argument_infos.map {|arg|
-          CallbackArgumentBuilder.new vargen, arg }
-        user_data_builder = CallbackArgumentBuilder.new vargen, user_data_info
-
-        set_up_argument_relations argument_infos, argument_builders
-        user_data_builder.is_closure = true
 
-        argument_builders.unshift receiver_builder
-        argument_builders.push user_data_builder
+        argument_builders = argument_infos.map {|arg| CallbackArgumentBuilder.new vargen, arg }
+        return_value_builder = CallbackReturnValueBuilder.new(vargen, return_value_info)
 
-        new return_type_info, vargen, argument_builders
+        new ArgumentBuilderCollection.new(return_value_builder, argument_builders)
       end
 
-      def self.for_vfunc receiver_info, argument_infos, return_type_info
+      def self.for_vfunc receiver_info, argument_infos, return_value_info
         vargen = VariableNameGenerator.new
 
         receiver_builder = CallbackArgumentBuilder.new vargen, receiver_info
-        argument_builders = argument_infos.map {|arg|
-          CallbackArgumentBuilder.new vargen, arg }
-
-        set_up_argument_relations argument_infos, argument_builders
-
-        argument_builders.unshift receiver_builder
+        argument_builders = argument_infos.map {|arg| CallbackArgumentBuilder.new vargen, arg }
+        return_value_builder = CallbackReturnValueBuilder.new(vargen, return_value_info)
 
-        new return_type_info, vargen, argument_builders
+        new ArgumentBuilderCollection.new(return_value_builder, argument_builders,
+                                          receiver_builder: receiver_builder)
       end
 
-      def self.set_up_argument_relations argument_infos, argument_builders
-        argument_infos.each do |arg|
-          if (idx = arg.closure) >= 0
-            argument_builders[idx].is_closure = true
-          end
-        end
-        argument_builders.each do |bldr|
-          if (idx = bldr.array_length_idx) >= 0
-            other = argument_builders[idx]
-
-            bldr.length_arg = other
-            other.array_arg = bldr
-          end
-        end
+      def initialize argument_builder_collection
+        @argument_builder_collection = argument_builder_collection
       end
 
-      def initialize return_type_info, vargen, argument_builders
-        @vargen = vargen
-        @argument_builders = argument_builders
-
-        @return_type_info = return_type_info
-      end
-
-      attr_reader :return_type_info
-      attr_reader :vargen
-      attr_reader :argument_builders
-
       def method_definition
         code = "def self.call_with_argument_mapping(#{method_arguments.join(', ')})"
         method_lines.each { |line| code << "\n  #{line}" }
@@ -80,61 +39,34 @@ module GirFFI
       end
 
       def method_lines
-        parameter_preparation + call_to_proc + return_value_conversion + return_value
+        @argument_builder_collection.parameter_preparation +
+          call_to_proc +
+          @argument_builder_collection.return_value_conversion +
+          return_value
       end
 
       def return_value
-        if return_value_builder.is_relevant?
-          ["return #{return_value_builder.return_value_name}"]
+        if (name = @argument_builder_collection.return_value_name)
+          ["return #{name}"]
         else
           []
         end
       end
 
-      def return_value_conversion
-        all_builders.map(&:post_conversion).flatten
-      end
-
       def call_to_proc
-        ["#{capture}_proc.call(#{call_arguments.join(', ')})"]
-      end
-
-      def parameter_preparation
-        argument_builders.sort_by.with_index {|arg, i|
-          [arg.type_info.array_length, i] }.map(&:pre_conversion).flatten
+        ["#{capture}_proc.call(#{@argument_builder_collection.call_argument_names.join(', ')})"]
       end
 
       def capture
-        @capture ||= capture_variable_names.any? ?
-          "#{capture_variable_names.join(", ")} = " :
-          ""
-      end
-
-      def capture_variable_names
-        @capture_variable_names ||=
-          all_builders.map(&:capture_variable_name).compact
-      end
-
-      def all_builders
-        @all_builders ||= [return_value_builder] + argument_builders
-      end
-
-      def call_arguments
-        @call_arguments ||= argument_builders.map(&:call_argument_name).compact
+        @capture ||= begin
+                       names = @argument_builder_collection.capture_variable_names
+                       names.any? ? "#{names.join(", ")} = " : ""
+                     end
       end
 
       def method_arguments
-        @method_arguments ||= argument_builders.map(&:method_argument_name).unshift('_proc')
-      end
-
-      def return_value_info
-        @return_value_info ||= ReturnValueInfo.new(return_type_info)
-      end
-
-      def return_value_builder
-        @return_value_builder ||= CallbackReturnValueBuilder.new(vargen, return_value_info)
+        @method_arguments ||= @argument_builder_collection.method_argument_names.dup.unshift('_proc')
       end
     end
   end
 end
-

data/lib/gir_ffi/builders/marshalling_method_builder.rb

@@ -0,0 +1,73 @@
+require 'gir_ffi/builders/closure_argument_builder'
+require 'gir_ffi/builders/callback_return_value_builder'
+require 'gir_ffi/builders/argument_builder_collection'
+
+module GirFFI
+  module Builders
+    # Implements the creation mapping method for a callback or signal
+    # handler. This method converts arguments from C to Ruby, and the
+    # result from Ruby to C.
+    class MarshallingMethodBuilder
+      def self.for_signal receiver_info, argument_infos, return_value_info
+        vargen = VariableNameGenerator.new
+
+        receiver_builder = ClosureArgumentBuilder.new vargen, receiver_info
+        argument_builders = argument_infos.map {|arg| ClosureArgumentBuilder.new vargen, arg }
+        return_value_builder = CallbackReturnValueBuilder.new(vargen, return_value_info)
+
+        new ArgumentBuilderCollection.new(return_value_builder, argument_builders,
+                                          receiver_builder: receiver_builder)
+      end
+
+      def initialize argument_builder_collection
+        @argument_builder_collection = argument_builder_collection
+      end
+
+      def method_definition
+        code = "def self.marshaller(#{marshaller_arguments.join(', ')})"
+        method_lines.each { |line| code << "\n  #{line}" }
+        code << "\nend\n"
+      end
+
+      def method_lines
+        param_values_unpack +
+          @argument_builder_collection.parameter_preparation +
+          call_to_closure +
+          @argument_builder_collection.return_value_conversion +
+          return_value
+      end
+
+      def return_value
+        if (name = @argument_builder_collection.return_value_name)
+          ["return_value.set_value #{name}"]
+        else
+          []
+        end
+      end
+
+      def call_to_closure
+        ["#{capture}wrap(closure.to_ptr).invoke_block(#{@argument_builder_collection.call_argument_names.join(', ')})"]
+      end
+
+      def param_values_unpack
+        ["#{method_arguments.join(", ")} = param_values.map(&:get_value_plain)" ]
+      end
+
+      def capture
+        @capture ||= begin
+                       names = @argument_builder_collection.capture_variable_names
+                       names.any? ? "#{names.join(", ")} = " : ""
+                     end
+      end
+
+      def method_arguments
+        # FIXME: Don't add _ if method_argument_names has more than one element
+        @method_arguments ||= @argument_builder_collection.method_argument_names.dup.push('_')
+      end
+
+      def marshaller_arguments
+        %w(closure return_value param_values _invocation_hint _marshal_data)
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/null_argument_builder.rb

@@ -2,8 +2,11 @@ module GirFFI
   # Argument builder that does nothing. Implements the Null Object pattern.
   class NullArgumentBuilder
     def initialize *; end
+
     def pre; []; end
+
     def post; []; end
+
     def callarg; end
   end
 end

data/lib/gir_ffi/builders/null_builder.rb

@@ -1,4 +1,5 @@
 module GirFFI
+  # Object Builder that does nothing. Implements the Null Object pattern.
   class NullBuilder
     def find_signal _
       nil

data/lib/gir_ffi/builders/object_builder.rb

@@ -1,6 +1,5 @@
 require 'gir_ffi/builders/registered_type_builder'
 require 'gir_ffi/builders/with_layout'
-require 'gir_ffi/builders/with_methods'
 require 'gir_ffi/builders/property_builder'
 require 'gir_ffi/object_base'
 
@@ -8,7 +7,6 @@ module GirFFI
   module Builders
     # Implements the creation of a class representing a GObject Object.
     class ObjectBuilder < RegisteredTypeBuilder
-      include WithMethods
       include WithLayout
 
       def find_signal signal_name

data/lib/gir_ffi/builders/property_builder.rb

@@ -44,7 +44,7 @@ module GirFFI
       private
 
       def converting_getter_def
-        return <<-CODE.reset_indentation
+        <<-CODE.reset_indentation
         def #{getter_name}
           #{getter_builder.capture_variable_name} = get_property("#{property_name}").get_value_plain
           #{getter_builder.post_conversion.join("\n")}
@@ -54,7 +54,7 @@ module GirFFI
       end
 
       def simple_getter_def
-        return <<-CODE.reset_indentation
+        <<-CODE.reset_indentation
         def #{getter_name}
           get_property("#{property_name}").get_value
         end
@@ -67,7 +67,7 @@ module GirFFI
       end
 
       def converting_setter_def
-        return <<-CODE.reset_indentation
+        <<-CODE.reset_indentation
         def #{setter_name} value
           #{setter_builder.pre_conversion.join("\n")}
           set_property("#{property_name}", #{setter_builder.callarg})
@@ -76,7 +76,7 @@ module GirFFI
       end
 
       def simple_setter_def
-        return <<-CODE.reset_indentation
+        <<-CODE.reset_indentation
         def #{setter_name} value
           set_property("#{property_name}", value)
         end

data/lib/gir_ffi/builders/registered_type_builder.rb

@@ -1,4 +1,5 @@
 require 'gir_ffi/builders/base_type_builder'
+require 'gir_ffi/method_stubber'
 require 'gir_ffi/class_base'
 
 module GirFFI
@@ -7,12 +8,45 @@ module GirFFI
     # of IRegisteredTypeInfo. These are types whose C representation is
     # complex, i.e., a struct or a union.
     class RegisteredTypeBuilder < BaseTypeBuilder
-      private
+      def setup_method method
+        go = info.find_method method
+        attach_and_define_method method, go, meta_class
+      end
+
+      def setup_instance_method method
+        go = info.find_instance_method method
+        attach_and_define_method method, go, build_class
+      end
 
       def target_gtype
         info.g_type
       end
 
+      private
+
+      def meta_class
+        (class << build_class; self; end)
+      end
+
+      def function_definition go
+        FunctionBuilder.new(go).generate
+      end
+
+      def attach_and_define_method method, go, modul
+        return unless go
+        method = go.safe_name
+        Builder.attach_ffi_function lib, go
+        modul.class_eval { remove_method method if method_defined? method }
+        build_class.class_eval function_definition(go)
+        method
+      end
+
+      def stub_methods
+        info.get_methods.each do |minfo|
+          klass.class_eval MethodStubber.new(minfo).method_stub
+        end
+      end
+
       def setup_constants
         klass.const_set :G_TYPE, target_gtype
         super

data/lib/gir_ffi/builders/return_value_builder.rb

@@ -42,17 +42,19 @@ module GirFFI
         end
       end
 
+      attr_reader :is_constructor
+
       private
 
       def has_post_conversion?
-        is_closure || needs_constructor_wrap? ||
+        is_closure || is_constructor ||
           type_info.needs_c_to_ruby_conversion_for_functions?
       end
 
       def post_convertor
         @post_convertor ||= if is_closure
                               ClosureConvertor.new(capture_variable_name)
-                            elsif needs_constructor_wrap?
+                            elsif is_constructor
                               ConstructorResultConvertor.new(capture_variable_name)
                             else
                               CToRubyConvertor.new(type_info,
@@ -65,10 +67,6 @@ module GirFFI
         length_arg && length_arg.post_converted_name
       end
 
-      def needs_constructor_wrap?
-        @is_constructor && specialized_type_tag == :object
-      end
-
       def is_void_return_value?
         specialized_type_tag == :void && !type_info.pointer?
       end

data/lib/gir_ffi/builders/ruby_to_c_convertor.rb

@@ -1,3 +1,5 @@
+# Builder that generates code to convert values from Ruby to C. Used by
+# argument builders.
 class GirFFI::Builders::RubyToCConvertor
   def initialize type_info, argument_name
     @type_info = type_info

data/lib/gir_ffi/builders/signal_closure_builder.rb

@@ -0,0 +1,46 @@
+require 'gir_ffi/builders/base_type_builder'
+require 'gir_ffi/builders/marshalling_method_builder'
+
+module GirFFI
+  module Builders
+    # Implements the creation of a closure class for handling a particular
+    # signal. The type will be attached to the appropriate class.
+    class SignalClosureBuilder < BaseTypeBuilder
+      def instantiate_class
+        unless already_set_up
+          setup_constants
+          klass.class_eval marshaller_definition
+        end
+        klass
+      end
+
+      def setup_method _method
+        nil
+      end
+
+      def marshaller_definition
+        arg_infos = info.args
+
+        container_type_info = ReceiverTypeInfo.new(container_info)
+        receiver_info = ReceiverArgumentInfo.new(container_type_info)
+        return_value_info = ReturnValueInfo.new info.return_type
+
+        MarshallingMethodBuilder.for_signal(receiver_info,
+                                            arg_infos,
+                                            return_value_info).method_definition
+      end
+
+      def klass
+        @klass ||= get_or_define_class container_class, @classname, GObject::RubyClosure
+      end
+
+      def container_class
+        @container_class ||= Builder.build_class(container_info)
+      end
+
+      def container_info
+        @container_info ||= info.container
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/struct_builder.rb

@@ -1,13 +1,11 @@
 require 'gir_ffi/builders/registered_type_builder'
 require 'gir_ffi/builders/with_layout'
-require 'gir_ffi/builders/with_methods'
 require 'gir_ffi/struct_base'
 
 module GirFFI
   module Builders
     # Implements the creation of a class representing a Struct.
     class StructBuilder < RegisteredTypeBuilder
-      include WithMethods
       include WithLayout
 
       private

data/lib/gir_ffi/builders/type_builder.rb

@@ -4,7 +4,7 @@ require 'gir_ffi/builders/enum_builder'
 require 'gir_ffi/builders/interface_builder'
 require 'gir_ffi/builders/object_builder'
 require 'gir_ffi/builders/struct_builder'
-require 'gir_ffi/builders/signal_builder'
+require 'gir_ffi/builders/signal_closure_builder'
 require 'gir_ffi/builders/unintrospectable_builder'
 require 'gir_ffi/builders/union_builder'
 require 'gir_ffi/builders/vfunc_builder'

data/lib/gir_ffi/builders/unintrospectable_builder.rb

@@ -20,7 +20,7 @@ module GirFFI
         setup_interfaces
       end
 
-      def setup_instance_method method
+      def setup_instance_method _method
         false
       end
 

data/lib/gir_ffi/builders/union_builder.rb

@@ -1,6 +1,5 @@
 require 'gir_ffi/builders/registered_type_builder'
 require 'gir_ffi/builders/with_layout'
-require 'gir_ffi/builders/with_methods'
 require 'gir_ffi/union_base'
 
 module GirFFI
@@ -8,7 +7,6 @@ module GirFFI
     # Implements the creation of a class representing union type. The
     # class will have a nested FFI::Union class to represent its C union.
     class UnionBuilder < RegisteredTypeBuilder
-      include WithMethods
       include WithLayout
 
       def layout_superclass

data/lib/gir_ffi/builders/user_defined_builder.rb

@@ -28,24 +28,16 @@ module GirFFI
       def setup_class
         setup_layout
         setup_constants
-        #stub_methods
         setup_property_accessors
-        #setup_vfunc_invokers
-        #setup_interfaces
         setup_constructor
       end
 
-      def gtype
+      def target_gtype
         @gtype
       end
 
       private
 
-      # FIXME: Is this really used?
-      def target_gtype
-        @gtype
-      end
-
       def parent
         @parent ||= gir.find_by_gtype(parent_gtype.to_i)
       end
@@ -81,14 +73,14 @@ module GirFFI
       end
 
       def class_init_proc
-        proc do |object_class_ptr, data|
+        proc do |object_class_ptr, _data|
           setup_properties object_class_ptr
           setup_vfuncs object_class_ptr
         end
       end
 
       def interface_init_proc interface
-        proc do |interface_ptr, data|
+        proc do |interface_ptr, _data|
           setup_interface_vfuncs interface, interface_ptr
         end
       end
@@ -98,7 +90,7 @@ module GirFFI
         properties.each do
           size += FFI.type_size(:int32)
         end
-        return size
+        size
       end
 
       def class_size
@@ -117,13 +109,13 @@ module GirFFI
       end
 
       def property_getter
-        proc do |object, property_id, value, pspec|
+        proc do |object, _property_id, value, pspec|
           value.set_value object.send(pspec.get_name)
         end
       end
 
       def property_setter
-        proc do |object, property_id, value, pspec|
+        proc do |object, _property_id, value, pspec|
           object.send("#{pspec.get_name}=", value.get_value)
         end
       end
@@ -167,10 +159,6 @@ module GirFFI
 
       def install_vfunc container_struct, vfunc_name, vfunc_info, implementation
         vfunc = VFuncBuilder.new(vfunc_info).build_class
-        # NOTE: This assigns a VFuncBase to a CallbackBase.
-        # This suggests that the two should be combined, but it seems
-        # CallbackBase will not cast the first argument correctly if used
-        # to map the implementation proc arguments.
         container_struct[vfunc_name] = vfunc.from implementation
       end
 

data/lib/gir_ffi/builders/vfunc_builder.rb

@@ -3,13 +3,14 @@ require 'gir_ffi/builders/base_type_builder'
 require 'gir_ffi/builders/mapping_method_builder'
 require 'gir_ffi/receiver_type_info'
 require 'gir_ffi/receiver_argument_info'
-require 'gir_ffi/vfunc_base'
+require 'gir_ffi/callback_base'
 
 module GirFFI
   module Builders
     # Implements the creation of a class representing the implementation of a
     # vfunc. This class will be able to turn a proc into an FFI::Function that
-    # can serve as such an implementation in C.
+    # can serve as such an implementation in C. The class will be namespaced
+    # inside class defining the vfunc.
     class VFuncBuilder < BaseTypeBuilder
       def instantiate_class
         unless already_set_up
@@ -27,11 +28,12 @@ module GirFFI
         arg_infos = info.args
         arg_infos << ErrorArgumentInfo.new if info.throws?
 
-        receiver_info = ReceiverArgumentInfo.new(receiver_type_info)
+        receiver_info = ReceiverArgumentInfo.new receiver_type_info
+        return_value_info = ReturnValueInfo.new info.return_type
 
         MappingMethodBuilder.for_vfunc(receiver_info,
                                        arg_infos,
-                                       info.return_type).method_definition
+                                       return_value_info).method_definition
       end
 
       def receiver_type_info

data/lib/gir_ffi/builders/with_layout.rb

@@ -4,8 +4,7 @@ module GirFFI
   module Builders
     # Implements the creation of classes representing types with layout,
     # i.e., :union, :struct, :object.
-    # Note: This module depends on the additional inclusion of
-    # WithMethods.
+    # Note: This module depends on methods in RegisteredTypeBuilder.
     module WithLayout
       def layout_specification
         spec = base_layout_specification

data/lib/gir_ffi/callback_base.rb

@@ -1,7 +1,7 @@
 require 'gir_ffi/type_base'
 
 module GirFFI
-  # Base module for callbacks.
+  # Base module for callbacks and vfuncs.
   # NOTE: Another option would be to derive this class from FFI::Function,
   # allowing a more natural implementation of from_native, to_native and wrap.
   class CallbackBase < Proc
@@ -12,13 +12,13 @@ module GirFFI
       FFI::Type::POINTER
     end
 
-    def self.from_native(value, _context)
+    def self.from_native value, _context
       return nil if !value || value.null?
       FFI::Function.new(gir_ffi_builder.return_ffi_type,
                         gir_ffi_builder.argument_ffi_types, value)
     end
 
-    def self.to_native(value, _context)
+    def self.to_native value, _context
       return nil unless value
       return value if FFI::Function === value
       value.to_native
@@ -45,7 +45,7 @@ module GirFFI
     def self.wrap_in_callback_args_mapper prc
       return nil unless prc
       return prc if FFI::Function === prc
-      return self.new do |*args|
+      new do |*args|
         call_with_argument_mapping(prc, *args)
       end
     end