gir_ffi 0.4.3 → 0.5.0

data/lib/gir_ffi/builder/field.rb

@@ -1,5 +1,7 @@
-require 'gir_ffi/builder/argument'
+require 'gir_ffi/argument_builder'
+require 'gir_ffi/return_value_builder'
 require 'gir_ffi/variable_name_generator'
+require 'gir_ffi/setter_argument_info'
 
 module GirFFI
   module Builder
@@ -44,14 +46,14 @@ module GirFFI
       end
 
       def return_value_builder
-        @rv_builder ||= ReturnValueFactory.builder_for_field_getter(
-          VariableNameGenerator.new, @info.name, @info.field_type, :return)
+        vargen = VariableNameGenerator.new
+        @rv_builder ||= ReturnValueBuilder.new vargen, @info.field_type, false
       end
 
       def setter_builder
-        type = @info.field_type
         vargen = VariableNameGenerator.new
-        Builder::InArgument.builder_for vargen, "value", type, :in, @libmodule
+        argument_info = SetterArgumentInfo.new "value", @info.field_type
+        ArgumentBuilder.new vargen, argument_info
       end
     end
   end

data/lib/gir_ffi/builder/module.rb

@@ -1,6 +1,6 @@
 require 'gir_ffi/builder_helper'
 require 'gir_ffi/module_base'
-require 'gir_ffi/builder/function'
+require 'gir_ffi/function_builder'
 require 'indentation'
 
 module GirFFI
@@ -60,15 +60,6 @@ module GirFFI
       @module
     end
 
-    def pretty_print
-      buf = "module #{@safe_namespace}\n"
-      gir.infos(@namespace).each do |info|
-        buf << sub_builder(info).pretty_print.indent
-        buf << "\n"
-      end
-      buf << "end"
-    end
-
     private
 
     def build_dependencies
@@ -103,13 +94,11 @@ module GirFFI
           @lib.ffi_lib(*libspec.split(/,/))
         end
       end
-
-      optionally_define_constant(@lib, :CALLBACKS) { [] }
     end
 
     def sub_builder info
       if info.info_type == :function
-        Builder::Function.new(info, libmodule)
+        FunctionBuilder.new(info, libmodule)
       else
         Builder::Type.builder_for info
       end
@@ -126,7 +115,7 @@ module GirFFI
     end
 
     def function_definition info, libmodule
-      Builder::Function.new(info, libmodule).generate
+      FunctionBuilder.new(info, libmodule).generate
     end
 
     def gir

data/lib/gir_ffi/builder/property.rb

@@ -1,5 +1,3 @@
-require 'gir_ffi/info_ext/i_property_info'
-
 module GirFFI
   module Builder
     # Creates property getter and setter code for a given IPropertyInfo.

data/lib/gir_ffi/builder/type/callback.rb

@@ -13,14 +13,6 @@ module GirFFI
           end
         end
 
-        def pretty_print
-          args = argument_types.map do |arg|
-            arg.is_a?(FFI::Enum) ? arg.tag : arg.inspect
-          end
-          return "#{@classname} = Lib.callback #{callback_sym.inspect}, " +
-            "[#{args.join(', ')}], #{return_type.inspect}"
-        end
-
         def callback_sym
           @classname.to_sym
         end

data/lib/gir_ffi/builder/type/constant.rb

@@ -8,10 +8,6 @@ module GirFFI
       # triggered by a missing constant in the parent namespace.  The
       # constant will be attached to the appropriate namespace module.
       class Constant < Base
-        def pretty_print
-          "#{@classname} = #{info.value.inspect}"
-        end
-
         private
 
         def instantiate_class

data/lib/gir_ffi/builder/type/enum.rb

@@ -7,10 +7,6 @@ module GirFFI
       # attached to the appropriate namespace module, and will be defined
       # as an enum for FFI.
       class Enum < RegisteredType
-        def pretty_print
-          "#{@classname} = Lib.enum #{enum_sym.inspect}, #{value_spec.inspect}"
-        end
-
         private
 
         def enum_sym

data/lib/gir_ffi/builder/type/interface.rb

@@ -10,10 +10,6 @@ module GirFFI
       class Interface < RegisteredType
         include WithMethods
 
-        def pretty_print
-          "module #{@classname}\n  extend InterfaceBase\nend"
-        end
-
         private
 
         # FIXME: The word 'class' is not really correct.

data/lib/gir_ffi/builder/type/object.rb

@@ -1,6 +1,5 @@
 require 'gir_ffi/builder/type/struct_based'
 require 'gir_ffi/builder/property'
-require 'gir_ffi/info_ext/i_property_info'
 require 'gir_ffi/object_base'
 
 module GirFFI

data/lib/gir_ffi/builder/type/struct_based.rb

@@ -12,12 +12,6 @@ module GirFFI
         include WithMethods
         include WithLayout
 
-        def pretty_print
-          buf = "class #{@classname}\n"
-          buf << pretty_print_methods
-          buf << "end"
-        end
-
         private
 
         def setup_class

data/lib/gir_ffi/builder/type/union.rb

@@ -12,10 +12,6 @@ module GirFFI
         include WithMethods
         include WithLayout
 
-        def pretty_print
-          "class #{@classname}\nend"
-        end
-
         private
 
         def setup_class

data/lib/gir_ffi/builder/type/with_layout.rb

@@ -1,5 +1,4 @@
 require 'gir_ffi/builder/field'
-require 'gir_ffi/info_ext/i_field_info'
 
 module GirFFI
   module Builder

data/lib/gir_ffi/builder/type/with_methods.rb

@@ -38,7 +38,7 @@ module GirFFI
         end
 
         def function_definition_builder go
-          Builder::Function.new(go, lib)
+          FunctionBuilder.new(go, lib)
         end
 
         def function_definition go
@@ -58,12 +58,6 @@ module GirFFI
             @klass.class_eval MethodStubber.new(minfo).method_stub
           end
         end
-
-        def pretty_print_methods
-          info.get_methods.map do |minfo|
-            function_definition_builder(minfo).pretty_print.indent + "\n"
-          end.join
-        end
       end
     end
   end

data/lib/gir_ffi/callback.rb

@@ -0,0 +1,9 @@
+module GirFFI
+  class Callback < Proc
+    def self.from namespace, name, prc
+      GirFFI::CallbackHelper.wrap_in_callback_args_mapper(namespace, name, prc).tap do |cb|
+        GirFFI::CallbackHelper.store_callback cb
+      end
+    end
+  end
+end

data/lib/gir_ffi/callback_helper.rb

@@ -1,10 +1,13 @@
 module GirFFI
+  # TODO: Turn module into a class, use instance methods.
   module CallbackHelper
+    CALLBACKS = []
+
     def self.wrap_in_callback_args_mapper namespace, name, prc
       return prc if FFI::Function === prc
       return nil if prc.nil?
       info = GObjectIntrospection::IRepository.default.find_by_name namespace, name
-      return Proc.new do |*args|
+      return Callback.new do |*args|
 	prc.call(*map_callback_args(args, info))
       end
     end
@@ -55,6 +58,10 @@ module GirFFI
         GirFFI::ArgHelper::OBJECT_STORE[arg.address]
       end
     end
+
+    def self.store_callback prc
+      CALLBACKS << prc
+    end
   end
 end
 

data/lib/gir_ffi/class_base.rb

@@ -11,8 +11,8 @@ module GirFFI
 
     def setup_and_call method, *arguments, &block
       result = self.class.ancestors.any? do |klass|
-        klass.respond_to?(:_setup_instance_method) &&
-          klass._setup_instance_method(method.to_s)
+        klass.respond_to?(:setup_instance_method) &&
+          klass.setup_instance_method(method.to_s)
       end
 
       unless result
@@ -24,8 +24,8 @@ module GirFFI
 
     def self.setup_and_call method, *arguments, &block
       result = self.ancestors.any? do |klass|
-        klass.respond_to?(:_setup_method) &&
-          klass._setup_method(method.to_s)
+        klass.respond_to?(:setup_method) &&
+          klass.setup_method(method.to_s)
       end
 
       unless result
@@ -36,40 +36,20 @@ module GirFFI
     end
 
     class << self
-      # @deprecated Compatibility function. Remove in version 0.5.0.
-      def ffi_structure
-        self::Struct
-      end
-
       def gir_info
         self.const_get :GIR_INFO
       end
 
-      # @deprecated Compatibility function. Remove in version 0.5.0.
-      def _builder
-        gir_ffi_builder
-      end
-
       def gir_ffi_builder
         self.const_get :GIR_FFI_BUILDER
       end
 
-      # @deprecated Compatibility function. Remove in version 0.5.0.
-      def _setup_method name
-        setup_method name
-      end
-
       def setup_method name
-        _builder.setup_method name
-      end
-
-      # @deprecated Compatibility function. Remove in version 0.5.0.
-      def _setup_instance_method name
-        setup_instance_method name
+        gir_ffi_builder.setup_method name
       end
 
       def setup_instance_method name
-        _builder.setup_instance_method name
+        gir_ffi_builder.setup_instance_method name
       end
 
       alias_method :_real_new, :new

data/lib/gir_ffi/error_argument_builder.rb

@@ -0,0 +1,17 @@
+require 'gir_ffi/base_argument_builder'
+
+module GirFFI
+  # Implements argument processing for error handling arguments. These
+  # arguments are not part of the introspected signature, but their
+  # presence is indicated by the 'throws' attribute of the function.
+  class ErrorArgumentBuilder < BaseArgumentBuilder
+    def pre
+      [ "#{callarg} = FFI::MemoryPointer.new(:pointer).write_pointer nil" ]
+    end
+
+    def post
+      [ "GirFFI::ArgHelper.check_error(#{callarg})" ]
+    end
+  end
+end
+

data/lib/gir_ffi/{builder/function.rb → function_builder.rb}

@@ -1,10 +1,13 @@
-require 'gir_ffi/builder/argument'
+require 'gir_ffi/argument_builder'
+require 'gir_ffi/return_value_builder'
+require 'gir_ffi/error_argument_builder'
+require 'gir_ffi/null_argument_builder'
 require 'gir_ffi/variable_name_generator'
 
-module GirFFI::Builder
+module GirFFI
   # Implements the creation of a Ruby function definition out of a GIR
   # IFunctionInfo.
-  class Function
+  class FunctionBuilder
     def initialize info, libmodule
       @info = info
       @libmodule = libmodule
@@ -12,8 +15,9 @@ module GirFFI::Builder
 
     def generate
       vargen = GirFFI::VariableNameGenerator.new
-      @data = @info.args.map {|arg| Argument.build vargen, arg, @libmodule}
-      @rvdata = ReturnValueFactory.build vargen, @info
+      @data = @info.args.map {|arg| ArgumentBuilder.new vargen, arg }
+      @rvdata = ReturnValueBuilder.new(vargen, @info.return_type,
+                                       @info.constructor?)
 
       alldata = @data.dup << @rvdata
 
@@ -29,14 +33,10 @@ module GirFFI::Builder
       return filled_out_template
     end
 
-    def pretty_print
-      generate
-    end
-
     private
 
     def setup_error_argument vargen
-      klass = @info.throws? ? ErrorArgument : NullArgument
+      klass = @info.throws? ? ErrorArgumentBuilder : NullArgumentBuilder
       @errarg = klass.new vargen, nil, nil, :error
     end
 
@@ -78,7 +78,10 @@ module GirFFI::Builder
     end
 
     def post
-      po = (@data.map(&:post) + @data.map(&:postpost) + @rvdata.post)
+      args = @data.sort_by {|arg| arg.type_info.array_length}
+
+      po = args.map {|arg|arg.post} +
+        @rvdata.post
       po.unshift @errarg.post
 
       po += @data.map {|item| item.cleanup}

data/lib/gir_ffi/in_out_pointer.rb

@@ -4,11 +4,17 @@ module GirFFI
   class InOutPointer < FFI::Pointer
     attr_reader :value_type, :sub_type
 
-    def initialize ptr, type, ffi_type, sub_type=nil
-      super ptr
-      @ffi_type = ffi_type
+    def initialize value, type, sub_type=nil
+      @ffi_type = TypeMap.map_basic_type_or_string type
       @value_type = type
       @sub_type = sub_type
+
+      value = adjust_value_in value
+
+      ptr = AllocationHelper.safe_malloc(FFI.type_size @ffi_type)
+      ptr.send "put_#{@ffi_type}", 0, value
+
+      super ptr
     end
 
     private :initialize
@@ -20,30 +26,26 @@ module GirFFI
 
     def to_sized_array_value size
       # FIXME: Simulated Polymorphism.
-      raise "Not allowed" if @value_type != :pointer or @sub_type.nil?
+      raise "Not allowed" if @ffi_type != :pointer or @sub_type.nil?
       block = self.read_pointer
       return nil if block.null?
       ArgHelper.ptr_to_typed_array @sub_type, block, size
     end
 
     def self.for type, sub_type=nil
-      ffi_type = TypeMap.map_basic_type_or_string type
-      ptr = AllocationHelper.safe_malloc(FFI.type_size ffi_type)
-      ptr.send "put_#{ffi_type}", 0, nil_value_for(type)
-      self.new ptr, type, ffi_type, sub_type
+      if Array === type
+        return self.new nil, *type
+      end
+      self.new nil, type, sub_type
     end
 
     def self.from type, value, sub_type=nil
       if Array === type
-        arr_t, sub_t = *type
+        _, sub_t = *type
         # TODO: Take array type into account (zero-terminated or not)
         return self.from_array sub_t, value
       end
-      value = adjust_value_in type, value
-      ffi_type = TypeMap.map_basic_type_or_string type
-      ptr = AllocationHelper.safe_malloc(FFI.type_size ffi_type)
-      ptr.send "put_#{ffi_type}", 0, value
-      self.new ptr, type, ffi_type, sub_type
+      self.new value, type, sub_type
     end
 
     def self.from_array type, array
@@ -52,33 +54,24 @@ module GirFFI
       self.from :pointer, ptr, type
     end
 
-    def self.for_array type
-      self.for :pointer, type
-    end
+    private
 
-    class << self
-      def adjust_value_in type, value
-        case type
-        when :gboolean
-          (value ? 1 : 0)
-        when :utf8
-          InPointer.from :utf8, value
-        else
-          value
-        end
-      end
+    def adjust_value_in value
+      return nil_value if value.nil?
 
-      def nil_value_for type
-        case type
-        when :utf8, :pointer
-          nil
-        else
-          0
-        end
+      case @value_type
+      when :gboolean
+        (value ? 1 : 0)
+      when :utf8
+        InPointer.from :utf8, value
+      else
+        value
       end
     end
 
-    private
+    def nil_value
+      @ffi_type == :pointer ? nil : 0
+    end
 
     def adjust_value_out value
       case @value_type