gir_ffi 0.7.8 → 0.7.9

data/lib/gir_ffi.rb

@@ -29,7 +29,7 @@ module GirFFI
     info = UserDefinedTypeInfo.new(klass, &block)
     Builders::UserDefinedBuilder.new(info).build_class
 
-    klass.get_gtype
+    klass.gtype
   end
 end
 

data/lib/gir_ffi/boxed_base.rb

@@ -0,0 +1,40 @@
+require 'gir_ffi/class_base'
+
+module GirFFI
+  # Base class for generated classes representing boxed types.
+  class BoxedBase < ClassBase
+    extend FFI::DataConverter
+
+    def self.native_type
+      FFI::Type::Struct.new(self::Struct)
+    end
+
+    # @deprecated Use #to_ffi_type instead. Will be removed in 0.8.0.
+    def self.to_ffitype
+      to_ffi_type
+    end
+
+    def self.to_ffi_type
+      self
+    end
+
+    def self.to_native value, _context
+      value.struct
+    end
+
+    def self.get_value_from_pointer pointer
+      pointer.to_ptr
+    end
+
+    def self.copy_value_to_pointer value, pointer, offset = 0
+      size = self::Struct.size
+      pointer.put_bytes offset, value.to_ptr.read_bytes(size), 0, size
+    end
+
+    def self._allocate
+      obj = _real_new
+      obj.instance_variable_set :@struct, self::Struct.new
+      obj
+    end
+  end
+end

data/lib/gir_ffi/builders/argument_builder.rb

@@ -143,11 +143,19 @@ module GirFFI
         if skipped?
           NullConvertor.new('0')
         elsif closure?
-          ClosureToPointerConvertor.new(name)
+          ClosureToPointerConvertor.new(pre_convertor_argument)
         elsif @type_info.needs_ruby_to_c_conversion_for_functions?
-          RubyToCConvertor.new(@type_info, name)
+          RubyToCConvertor.new(@type_info, pre_convertor_argument)
         else
-          NullConvertor.new(name)
+          NullConvertor.new(pre_convertor_argument)
+        end
+      end
+
+      def pre_convertor_argument
+        if ownership_transfer == :everything && specialized_type_tag == :object
+          "#{name}.ref"
+        else
+          name
         end
       end
     end

data/lib/gir_ffi/builders/base_argument_builder.rb

@@ -60,6 +60,10 @@ module GirFFI
         type_info.array_length
       end
 
+      def ownership_transfer
+        arginfo.ownership_transfer
+      end
+
       def safe name
         if KEYWORDS.include? name
           "#{name}_"

data/lib/gir_ffi/builders/boxed_builder.rb

@@ -0,0 +1,29 @@
+require 'gir_ffi/builders/registered_type_builder'
+require 'gir_ffi/builders/with_layout'
+
+module GirFFI
+  module Builders
+    # Implements the creation of a class representing boxed types.
+    class BoxedBuilder < RegisteredTypeBuilder
+      include WithLayout
+
+      private
+
+      def setup_class
+        setup_layout
+        setup_constants
+        stub_methods
+        setup_field_accessors
+        provide_constructor
+      end
+
+      def provide_constructor
+        return if info.find_method 'new'
+
+        (class << klass; self; end).class_eval {
+          alias_method :new, :_allocate
+        }
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/callback_builder.rb

@@ -25,7 +25,9 @@ module GirFFI
       end
 
       def mapping_method_definition
-        return_value_info = ReturnValueInfo.new info.return_type
+        return_value_info = ReturnValueInfo.new(info.return_type,
+                                                info.caller_owns,
+                                                info.skip_return?)
         MappingMethodBuilder.for_callback(info.args,
                                           return_value_info).method_definition
       end

data/lib/gir_ffi/builders/callback_return_value_builder.rb

@@ -45,7 +45,15 @@ module GirFFI
       end
 
       def post_convertor
-        @post_convertor ||= RubyToCConvertor.new(type_info, capture_variable_name)
+        @post_convertor ||= RubyToCConvertor.new(type_info, post_convertor_argument)
+      end
+
+      def post_convertor_argument
+        if ownership_transfer == :everything && specialized_type_tag == :object
+          "#{capture_variable_name}.ref"
+        else
+          capture_variable_name
+        end
       end
 
       def void_return_value?

data/lib/gir_ffi/builders/field_builder.rb

@@ -7,6 +7,59 @@ module GirFFI
   module Builders
     # Creates field getter and setter code for a given IFieldInfo.
     class FieldBuilder
+      # Builder for field getters
+      class GetterBuilder
+        def initialize field_builder, return_value_builder
+          @field_builder = field_builder
+          @return_value_builder = return_value_builder
+        end
+
+        def singleton_method?
+          false
+        end
+
+        def method_name
+          @field_builder.field_name
+        end
+
+        def method_arguments
+          []
+        end
+
+        def preparation
+          [
+            "#{field_ptr} = @struct.to_ptr + #{field_offset}",
+            "#{typed_ptr} = GirFFI::InOutPointer.new(#{field_type_tag}, #{field_ptr})"
+          ]
+        end
+
+        def invocation
+          "#{typed_ptr}.to_value"
+        end
+
+        def result
+          [@return_value_builder.return_value_name]
+        end
+
+        private
+
+        def field_ptr
+          @field_ptr ||= @return_value_builder.new_variable
+        end
+
+        def typed_ptr
+          @typed_ptr ||= @return_value_builder.new_variable
+        end
+
+        def field_offset
+          @field_builder.field_offset
+        end
+
+        def field_type_tag
+          @field_builder.field_type_tag
+        end
+      end
+
       attr_reader :info
 
       def initialize field_info
@@ -31,20 +84,9 @@ module GirFFI
       end
 
       def getter_def
-        builder = return_value_builder
-
-        field_ptr = builder.new_variable
-        typed_ptr = builder.new_variable
-
-        <<-CODE.reset_indentation
-        def #{info.name}
-          #{field_ptr} = @struct.to_ptr + #{info.offset}
-          #{typed_ptr} = GirFFI::InOutPointer.new(#{field_type_tag_or_class}, #{field_ptr})
-          #{builder.capture_variable_name} = #{typed_ptr}.to_value
-          #{builder.post_conversion.join("\n")}
-          #{builder.return_value_name}
-        end
-        CODE
+        argument_builders = ArgumentBuilderCollection.new(return_value_builder, [])
+        getter_builder = GetterBuilder.new(self, return_value_builder)
+        MethodTemplate.new(getter_builder, argument_builders).method_definition
       end
 
       def setter_def
@@ -56,19 +98,27 @@ module GirFFI
         <<-CODE.reset_indentation
         def #{info.name}= #{builder.method_argument_name}
           #{field_ptr} = @struct.to_ptr + #{info.offset}
-          #{typed_ptr} = GirFFI::InOutPointer.new(#{field_type_tag_or_class}, #{field_ptr})
+          #{typed_ptr} = GirFFI::InOutPointer.new(#{field_type_tag}, #{field_ptr})
           #{builder.pre_conversion.join("\n          ")}
           #{typed_ptr}.set_value #{builder.call_argument_name}
         end
         CODE
       end
 
-      private
+      def field_name
+        @field_name ||= info.name
+      end
 
-      def field_type_tag_or_class
-        @field_type_tag_or_class ||= info.field_type.tag_or_class.inspect
+      def field_offset
+        @field_offset ||= info.offset
       end
 
+      def field_type_tag
+        @field_type_tag ||= info.field_type.tag_or_class.inspect
+      end
+
+      private
+
       def container_class
         @container_class ||= container_module.const_get(container_info.safe_name)
       end

data/lib/gir_ffi/builders/function_builder.rb

@@ -15,7 +15,9 @@ module GirFFI
         @info = info
         vargen = GirFFI::VariableNameGenerator.new
         @argument_builders = @info.args.map { |arg| ArgumentBuilder.new vargen, arg }
-        return_value_info = ReturnValueInfo.new(@info.return_type, @info.skip_return?)
+        return_value_info = ReturnValueInfo.new(@info.return_type,
+                                                @info.caller_owns,
+                                                @info.skip_return?)
         @return_value_builder = ReturnValueBuilder.new(vargen,
                                                        return_value_info,
                                                        @info.constructor?)
@@ -71,9 +73,17 @@ module GirFFI
 
       def function_call_arguments
         ca = @argument_builder_collection.call_argument_names
-        ca.unshift 'self' if @info.method?
+        ca.unshift receiver_call_argument if @info.method?
         ca
       end
+
+      def receiver_call_argument
+        if @info.instance_ownership_transfer == :everything
+          'self.ref'
+        else
+          'self'
+        end
+      end
     end
   end
 end

data/lib/gir_ffi/builders/mapping_method_builder.rb

@@ -1,24 +1,26 @@
 require 'gir_ffi/variable_name_generator'
 require 'gir_ffi/builders/callback_argument_builder'
+require 'gir_ffi/builders/vfunc_argument_builder'
 require 'gir_ffi/builders/callback_return_value_builder'
 require 'gir_ffi/builders/argument_builder_collection'
 require 'gir_ffi/builders/method_template'
 
 module GirFFI
   module Builders
-    # Implements the creation mapping method for a callback or signal
+    # Implements the creation mapping method for a callback or vfunc
     # 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_value_info
-        new argument_infos, return_value_info
+        new argument_infos, return_value_info, CallbackArgumentBuilder
       end
 
       def self.for_vfunc receiver_info, argument_infos, return_value_info
-        new receiver_info, argument_infos, return_value_info
+        new receiver_info, argument_infos, return_value_info, VFuncArgumentBuilder
       end
 
-      def initialize receiver_info = nil, argument_infos, return_value_info
+      def initialize receiver_info = nil, argument_infos, return_value_info, builder_class
+        @argument_builder_class = builder_class
         receiver_builder = make_argument_builder receiver_info if receiver_info
         argument_builders = argument_infos.map { |info| make_argument_builder info }
         return_value_builder =
@@ -74,7 +76,7 @@ module GirFFI
       end
 
       def make_argument_builder argument_info
-        CallbackArgumentBuilder.new variable_generator, argument_info
+        @argument_builder_class.new variable_generator, argument_info
       end
     end
   end

data/lib/gir_ffi/builders/marshalling_method_builder.rb

@@ -6,7 +6,7 @@ require 'gir_ffi/builders/method_template'
 
 module GirFFI
   module Builders
-    # Implements the creation mapping method for a callback or signal
+    # Implements the creation mapping method for a signal
     # handler. This method converts arguments from C to Ruby, and the
     # result from Ruby to C.
     class MarshallingMethodBuilder

data/lib/gir_ffi/builders/module_builder.rb

@@ -35,7 +35,7 @@ module GirFFI
         info = gir.find_by_name @namespace, classname.to_s
         unless info
           raise NameError,
-            "Class #{classname} not found in namespace #{@namespace}"
+                "Class #{classname} not found in namespace #{@namespace}"
         end
         Builder.build_class info
       end

data/lib/gir_ffi/builders/registered_type_builder.rb

@@ -52,15 +52,6 @@ module GirFFI
         super
       end
 
-      # FIXME: Only used in some of the subclases. Make mixin?
-      def provide_constructor
-        return if info.find_method 'new'
-
-        (class << klass; self; end).class_eval {
-          alias_method :new, :_allocate
-        }
-      end
-
       def parent_info
         nil
       end

data/lib/gir_ffi/builders/return_value_builder.rb

@@ -33,7 +33,6 @@ module GirFFI
       end
 
       def post_conversion
-        # TODO: Avoid conditional by using NullConvertor
         if has_post_conversion?
           ["#{post_converted_name} = #{post_convertor.conversion}"]
         else

data/lib/gir_ffi/builders/signal_closure_builder.rb

@@ -20,7 +20,9 @@ module GirFFI
 
         container_type_info = ReceiverTypeInfo.new(container_info)
         receiver_info = ReceiverArgumentInfo.new(container_type_info)
-        return_value_info = ReturnValueInfo.new info.return_type
+        return_value_info = ReturnValueInfo.new(info.return_type,
+                                                info.caller_owns,
+                                                info.skip_return?)
 
         MarshallingMethodBuilder.for_signal(receiver_info,
                                             arg_infos,

data/lib/gir_ffi/builders/struct_builder.rb

@@ -1,28 +1,16 @@
-require 'gir_ffi/builders/registered_type_builder'
-require 'gir_ffi/builders/with_layout'
+require 'gir_ffi/builders/boxed_builder'
 require 'gir_ffi/struct_base'
 
 module GirFFI
   module Builders
     # Implements the creation of a class representing a Struct.
-    class StructBuilder < RegisteredTypeBuilder
-      include WithLayout
-
-      private
-
-      def setup_class
-        setup_layout
-        setup_constants
-        stub_methods
-        setup_field_accessors
-        provide_constructor
-      end
-
-      # FIXME: Private method only in subclass
+    class StructBuilder < BoxedBuilder
       def layout_superclass
         FFI::Struct
       end
 
+      private
+
       def superclass
         StructBase
       end

data/lib/gir_ffi/builders/union_builder.rb

@@ -1,28 +1,17 @@
-require 'gir_ffi/builders/registered_type_builder'
-require 'gir_ffi/builders/with_layout'
+require 'gir_ffi/builders/boxed_builder'
 require 'gir_ffi/union_base'
 
 module GirFFI
   module Builders
     # 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 WithLayout
-
+    class UnionBuilder < BoxedBuilder
       def layout_superclass
         FFI::Union
       end
 
       private
 
-      def setup_class
-        setup_layout
-        setup_constants
-        stub_methods
-        setup_field_accessors
-        provide_constructor
-      end
-
       def superclass
         UnionBase
       end