gir_ffi 0.6.7 → 0.7.0

data/lib/gir_ffi/builders/base_type_builder.rb

@@ -32,12 +32,12 @@ module GirFFI
     end
 
     def setup_constants
-      @klass.const_set :GIR_INFO, info
-      @klass.const_set :GIR_FFI_BUILDER, self
+      klass.const_set :GIR_INFO, info
+      klass.const_set :GIR_FFI_BUILDER, self
     end
 
     def already_set_up
-      const_defined_for @klass, :GIR_FFI_BUILDER
+      const_defined_for klass, :GIR_FFI_BUILDER
     end
 
     def gir

data/lib/gir_ffi/builders/c_to_ruby_convertor.rb

@@ -0,0 +1,34 @@
+class GirFFI::Builders::CToRubyConvertor
+  def initialize type_info, argument_name, length_arg
+    @type_info = type_info
+    @argument_name = argument_name
+    @length_arg = length_arg
+  end
+
+  def conversion
+    case @type_info.flattened_tag
+    when :utf8, :filename
+      "#{@argument_name}.to_utf8"
+    else
+      "#{@type_info.argument_class_name}.wrap(#{conversion_arguments})"
+    end
+  end
+
+  private
+
+  def conversion_arguments
+    if @type_info.flattened_tag == :c
+      "#{@type_info.element_type.inspect}, #{array_size}, #{@argument_name}"
+    else
+      @type_info.extra_conversion_arguments.map(&:inspect).push(@argument_name).join(", ")
+    end
+  end
+
+  def array_size
+    if @length_arg
+      @length_arg
+    else
+      @type_info.array_fixed_size
+    end
+  end
+end

data/lib/gir_ffi/builders/callback_argument_builder.rb

@@ -0,0 +1,73 @@
+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'
+
+module GirFFI
+  module Builders
+    class CallbackArgumentBuilder < BaseArgumentBuilder
+      def method_argument_name
+        @method_argument_name ||= name || new_variable
+      end
+
+      def pre_converted_name
+        @pre_converted_name ||= new_variable
+      end
+
+      def call_argument_name
+        if direction == :in
+          pre_converted_name unless array_arg
+        end
+      end
+
+      def capture_variable_name
+        if direction == :out
+          @capture_variable_name ||= new_variable
+        end
+      end
+
+      def pre_conversion
+        case direction
+        when :in
+          [ "#{pre_converted_name} = #{pre_convertor.conversion}" ]
+        when :out
+          [ "#{pre_converted_name} = #{out_parameter_preparation}" ]
+        end
+      end
+
+      def post_conversion
+        if direction == :out
+          [ "#{pre_converted_name}.set_value #{capture_variable_name}" ]
+        else
+          []
+        end
+      end
+
+      private
+
+      def pre_convertor
+        @pre_convertor ||= if is_closure
+                             ClosureConvertor.new(method_argument_name)
+                           elsif type_info.needs_conversion_for_callbacks?
+                             CToRubyConvertor.new(type_info,
+                                                  method_argument_name,
+                                                  length_argument_name)
+                           else
+                             NullConvertor.new(method_argument_name)
+                           end
+      end
+
+      def out_parameter_preparation
+        "GirFFI::InOutPointer.new(#{type_info.tag_or_class.inspect}, #{method_argument_name})"
+      end
+
+      def length_argument_name
+        length_arg && length_arg.pre_converted_name
+      end
+
+      def is_void_return_value?
+        specialized_type_tag == :void && !type_info.pointer?
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/callback_builder.rb

@@ -9,17 +9,27 @@ module GirFFI
     # as a callback for FFI.
     class CallbackBuilder < BaseTypeBuilder
       def instantiate_class
-        @klass ||= optionally_define_constant namespace_module, @classname do
-          cb = lib.callback callback_sym, argument_types, return_type
-          cb.instance_eval mapping_method_definition
-          cb.extend CallbackBase
-          cb
+        setup_class unless already_set_up
+      end
+
+      def setup_class
+        setup_callback
+        setup_constants
+        klass.class_eval mapping_method_definition
+      end
+
+      def setup_callback
+        optionally_define_constant klass, :Callback do
+          lib.callback callback_sym, argument_types, return_type
         end
-        @klass
+      end
+
+      def klass
+        @klass ||= get_or_define_class namespace_module, @classname, CallbackBase
       end
 
       def mapping_method_definition
-        MappingMethodBuilder.new(info.args, info.return_type).method_definition
+        MappingMethodBuilder.for_callback(info.args, info.return_type).method_definition
       end
 
       def callback_sym
@@ -27,11 +37,11 @@ module GirFFI
       end
 
       def argument_types
-        @info.argument_ffi_types
+        @argument_types ||= @info.argument_ffi_types
       end
 
       def return_type
-        @info.return_ffi_type
+        @return_type ||= @info.return_ffi_type
       end
     end
   end

data/lib/gir_ffi/builders/callback_return_value_builder.rb

@@ -0,0 +1,54 @@
+require 'gir_ffi/builders/return_value_builder'
+require 'gir_ffi/builders/ruby_to_c_convertor'
+
+module GirFFI
+  module Builders
+    class CallbackReturnValueBuilder < BaseArgumentBuilder
+      def is_relevant?
+        !is_void_return_value? && !arginfo.skip?
+      end
+
+      def capture_variable_name
+        if is_relevant?
+          @capture_variable_name ||= new_variable
+        end
+      end
+
+      def post_converted_name
+        @post_converted_name ||= if has_post_conversion?
+                                   new_variable
+                                 else
+                                   capture_variable_name
+                                 end
+      end
+
+      def return_value_name
+        if is_relevant?
+          post_converted_name unless array_arg
+        end
+      end
+
+      def post_conversion
+        if has_post_conversion?
+          [ "#{post_converted_name} = #{post_convertor.conversion}" ]
+        else
+          []
+        end
+      end
+
+      private
+
+      def has_post_conversion?
+        type_info.needs_conversion_for_callbacks?
+      end
+
+      def post_convertor
+        @post_convertor ||= RubyToCConvertor.new(type_info, capture_variable_name)
+      end
+
+      def is_void_return_value?
+        specialized_type_tag == :void && !type_info.pointer?
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/closure_convertor.rb

@@ -0,0 +1,9 @@
+class GirFFI::Builders::ClosureConvertor
+  def initialize argument_name
+    @argument_name = argument_name
+  end
+
+  def conversion
+    "GirFFI::ArgHelper::OBJECT_STORE[#{@argument_name}.address]"
+  end
+end

data/lib/gir_ffi/builders/closure_to_pointer_convertor.rb

@@ -0,0 +1,9 @@
+class GirFFI::Builders::ClosureToPointerConvertor
+  def initialize argument_name
+    @argument_name = argument_name
+  end
+
+  def conversion
+    "GirFFI::InPointer.from_closure_data(#{@argument_name})"
+  end
+end

data/lib/gir_ffi/builders/constructor_result_convertor.rb

@@ -0,0 +1,9 @@
+class GirFFI::Builders::ConstructorResultConvertor
+  def initialize argument_name
+    @argument_name = argument_name
+  end
+
+  def conversion
+    "self.constructor_wrap(#{@argument_name})"
+  end
+end

data/lib/gir_ffi/builders/enum_builder.rb

@@ -24,21 +24,26 @@ module GirFFI
       end
 
       def instantiate_class
-        @klass = get_or_define_module namespace_module, @classname
-        @enum = optionally_define_constant @klass, :Enum do
+        @enum = optionally_define_constant klass, :Enum do
           lib.enum(enum_sym, value_spec)
         end
-        unless already_set_up
-          @klass.extend superclass
-          setup_constants
-          setup_gtype_getter
-          stub_methods
-          setup_inspect
-        end
+        setup_class unless already_set_up
+      end
+
+      def setup_class
+        klass.extend superclass
+        setup_constants
+        setup_gtype_getter
+        stub_methods
+        setup_inspect
+      end
+
+      def klass
+        @klass ||= get_or_define_module namespace_module, @classname
       end
 
       def setup_inspect
-        @klass.instance_eval <<-EOS
+        klass.instance_eval <<-EOS
           def self.inspect
             "#{@namespace}::#{@classname}"
           end
@@ -46,17 +51,12 @@ module GirFFI
       end
 
       def already_set_up
-        @klass.respond_to? :get_gtype
+        klass.respond_to? :get_gtype
       end
 
       def superclass
         @superclass ||= EnumBase
       end
-
-      # FIXME: Remove duplication with ModuleBuilder
-      def get_or_define_module parent, name
-        optionally_define_constant(parent, name) { ::Module.new }
-      end
     end
   end
 end

data/lib/gir_ffi/builders/field_builder.rb

@@ -1,7 +1,7 @@
 require 'gir_ffi/builders/argument_builder'
 require 'gir_ffi/builders/return_value_builder'
 require 'gir_ffi/variable_name_generator'
-require 'gir_ffi/setter_argument_info'
+require 'gir_ffi/field_argument_info'
 
 module GirFFI
   module Builders
@@ -14,10 +14,24 @@ module GirFFI
       end
 
       def build
-        unless container_info.find_instance_method info.name
-          container_class.class_eval getter_def
-        end
-        container_class.class_eval setter_def if info.writable?
+        setup_getter
+        setup_setter
+      end
+
+      def setup_getter
+        container_class.class_eval getter_def unless container_defines_getter_method?
+      end
+
+      def container_defines_getter_method?
+        container_info.find_instance_method info.name
+      end
+
+      def setup_setter
+        container_class.class_eval setter_def if is_writable_field?
+      end
+
+      def is_writable_field?
+        info.writable?
       end
 
       def getter_def
@@ -30,9 +44,9 @@ module GirFFI
         def #{info.name}
           #{field_ptr} = @struct.to_ptr + #{info.offset}
           #{typed_ptr} = GirFFI::InOutPointer.new(#{field_type_tag_or_class.inspect}, #{field_ptr})
-          #{builder.callarg} = #{typed_ptr}.to_value
-          #{builder.post.join("\n")}
-          #{builder.retval}
+          #{builder.capture_variable_name} = #{typed_ptr}.to_value
+          #{builder.post_conversion.join("\n")}
+          #{builder.return_value_name}
         end
         CODE
       end
@@ -44,10 +58,10 @@ module GirFFI
         typed_ptr = builder.new_variable
 
         return <<-CODE.reset_indentation
-        def #{info.name}= #{builder.inarg}
+        def #{info.name}= #{builder.method_argument_name}
           #{field_ptr} = @struct.to_ptr + #{info.offset}
           #{typed_ptr} = GirFFI::InOutPointer.new(#{field_type_tag_or_class.inspect}, #{field_ptr})
-          #{builder.pre.join("\n          ")}
+          #{builder.pre_conversion.join("\n          ")}
           #{typed_ptr}.set_value #{builder.callarg}
         end
         CODE
@@ -79,15 +93,22 @@ module GirFFI
         @info.name.to_sym
       end
 
+      def field_type
+        @field_type ||= @info.field_type
+      end
+
+      def field_argument_info
+        @field_argument_info ||= FieldArgumentInfo.new "value", field_type
+      end
+
       def return_value_builder
-        vargen = VariableNameGenerator.new
-        @rv_builder ||= ReturnValueBuilder.new vargen, @info.field_type
+        @rv_builder ||= ReturnValueBuilder.new(VariableNameGenerator.new,
+                                               field_argument_info)
       end
 
       def setter_builder
-        vargen = VariableNameGenerator.new
-        argument_info = SetterArgumentInfo.new "value", @info.field_type
-        ArgumentBuilder.new vargen, argument_info
+        @setter_builder ||= ArgumentBuilder.new(VariableNameGenerator.new,
+                                                field_argument_info)
       end
     end
   end

data/lib/gir_ffi/builders/function_builder.rb

@@ -1,4 +1,6 @@
 require 'gir_ffi/builders/argument_builder'
+require 'gir_ffi/return_value_info'
+require 'gir_ffi/error_argument_info'
 require 'gir_ffi/builders/return_value_builder'
 require 'gir_ffi/builders/error_argument_builder'
 require 'gir_ffi/builders/null_argument_builder'
@@ -17,37 +19,44 @@ module GirFFI
         vargen = GirFFI::VariableNameGenerator.new
         @argument_builders = @info.args.map {|arg| ArgumentBuilder.new vargen, arg }
         @return_value_builder = ReturnValueBuilder.new(vargen,
-                                                       @info.return_type,
-                                                       @info.constructor?,
-                                                       @info.skip_return?)
+                                                       ReturnValueInfo.new(@info.return_type, @info.skip_return?),
+                                                       @info.constructor?)
 
-        link_array_length_arguments
+        set_up_argument_relations
         setup_error_argument vargen
         return filled_out_template
       end
 
       private
 
-      def libmodule
-        Object.const_get(@info.safe_namespace)::Lib
+      def lib_module_name
+        "#{@info.safe_namespace}::Lib"
       end
 
-      def link_array_length_arguments
+      def set_up_argument_relations
         alldata = @argument_builders.dup << @return_value_builder
 
-        alldata.each {|data|
-          idx = data.type_info.array_length
-          if idx > -1
+        alldata.each do |data|
+          if (idx = data.array_length_idx) >= 0
             other_data = @argument_builders[idx]
             data.length_arg = other_data
             other_data.array_arg = data
           end
-        }
+        end
+
+        @argument_builders.each do |data|
+          if (idx = data.arginfo.closure) >= 0
+            @argument_builders[idx].is_closure = true
+          end
+        end
       end
 
       def setup_error_argument vargen
-        klass = @info.throws? ? ErrorArgumentBuilder : NullArgumentBuilder
-        @errarg = klass.new vargen, nil, nil, :error
+        @errarg = if @info.throws?
+                    ErrorArgumentBuilder.new vargen, ErrorArgumentInfo.new
+                  else
+                    NullArgumentBuilder.new
+                  end
       end
 
       def filled_out_template
@@ -59,17 +68,17 @@ module GirFFI
       end
 
       def method_body
-        lines = preparation << function_call << post_processing << cleanup
+        lines = preparation << function_call << post_processing
         lines << "return #{return_values.join(', ')}" if has_return_values?
         lines.flatten.join("\n").indent
       end
 
       def function_call
-        "#{capture}#{libmodule}.#{@info.symbol} #{function_call_arguments.join(', ')}"
+        "#{capture}#{lib_module_name}.#{@info.symbol} #{function_call_arguments.join(', ')}"
       end
 
       def method_arguments
-        @argument_builders.map(&:inarg).compact
+        @argument_builders.map(&:method_argument_name).compact
       end
 
       def function_call_arguments
@@ -80,14 +89,14 @@ module GirFFI
       end
 
       def preparation
-        pr = @argument_builders.map(&:pre)
+        pr = @argument_builders.map(&:pre_conversion)
         pr << @errarg.pre
         pr.flatten
       end
 
       def capture
         if has_capture?
-          "#{@return_value_builder.callarg} = "
+          "#{@return_value_builder.capture_variable_name} = "
         else
           ""
         end
@@ -96,19 +105,15 @@ module GirFFI
       def post_processing
         # FIXME: Sorting knows too much about internals of ArgumentBuilder.
         args = @argument_builders.sort_by {|arg| arg.type_info.array_length}
-        args << @return_value_builder
-        args.unshift @errarg
-
-        args.map {|arg| arg.post}
-      end
 
-      def cleanup
-        @argument_builders.map {|item| item.cleanup}
+        result = args.map {|arg| arg.post_conversion}
+        result.unshift @errarg.post
+        result << @return_value_builder.post_conversion
       end
 
       def return_values
-        @return_values ||= ([@return_value_builder.retval] +
-                            @argument_builders.map(&:retval)).compact
+        @return_values ||= ([@return_value_builder.return_value_name] +
+                            @argument_builders.map(&:return_value_name)).compact
       end
 
       def has_return_values?