gir_ffi 0.8.6 → 0.9.0

data/lib/gir_ffi/builders/argument_builder_collection.rb

@@ -1,14 +1,16 @@
 module GirFFI
   module Builders
-    # Class representing the argument and return value builders for a callback
-    # mapping function or marshaller. Implements collecting the conversion code
-    # and parameter and variable names for use by function builders.
+    # Class representing the argument and return value builders for a method,
+    # callback mapping function or marshaller. Implements collecting the
+    # conversion code and parameter and variable names for use by function
+    # builders.
     class ArgumentBuilderCollection
       attr_reader :return_value_builder
 
-      def initialize(return_value_builder, argument_builders, options = {})
-        @receiver_builder = options[:receiver_builder]
-        @error_argument_builder = options[:error_argument_builder]
+      def initialize(return_value_builder, argument_builders,
+                     receiver_builder: nil, error_argument_builder: nil)
+        @receiver_builder = receiver_builder
+        @error_argument_builder = error_argument_builder
         @base_argument_builders = argument_builders
         @return_value_builder = return_value_builder
         set_up_argument_relations
@@ -32,7 +34,21 @@ module GirFFI
       end
 
       def method_argument_names
-        @method_argument_names ||= argument_builders.map(&:method_argument_name).compact
+        @method_argument_names ||=
+          begin
+            base = []
+            block = nil
+            argument_builders.each do |it|
+              name = it.method_argument_name
+              if !block && it.block_argument?
+                block = "&#{name}"
+              else
+                base << name
+              end
+            end
+            base << block if block
+            base.compact
+          end
       end
 
       def return_value_name
@@ -58,8 +74,11 @@ module GirFFI
 
       def set_up_argument_relations
         @base_argument_builders.each do |bldr|
-          if (idx = bldr.closure) >= 0
-            @base_argument_builders[idx].closure = true
+          if (idx = bldr.closure_idx) >= 0
+            @base_argument_builders[idx].closure = bldr
+          end
+          if (idx = bldr.destroy_idx) >= 0
+            @base_argument_builders[idx].mark_as_destroy_notifier bldr
           end
         end
         all_builders.each do |bldr|

data/lib/gir_ffi/builders/base_argument_builder.rb

@@ -15,23 +15,13 @@ module GirFFI
       attr_reader :arginfo
       attr_accessor :length_arg, :array_arg
 
-      # TODO: closure unfortunately means two things in GLib: a closure
-      # argument (user_data), and the Closure class (a callable object). Make
-      # the distinction more explicit in GirFFI.
-      def closure?
-        @is_closure
-      end
-
-      def closure=(arg)
-        @is_closure = arg
-      end
-
       def initialize(var_gen, arginfo)
         @var_gen = var_gen
         @arginfo = arginfo
         @length_arg = nil
         @array_arg = nil
         @is_closure = false
+        @destroy_notifier = false
       end
 
       def name
@@ -60,10 +50,44 @@ module GirFFI
         type_info.array_length
       end
 
-      def closure
+      def closure_idx
         arginfo.closure
       end
 
+      def destroy_idx
+        arginfo.destroy
+      end
+
+      # TODO: closure unfortunately means two things in GLib: a closure
+      # argument (user_data), and the Closure class (a callable object). Make
+      # the distinction more explicit in GirFFI.
+      def closure=(arg)
+        @is_closure = arg
+      end
+
+      # TODO: Unify relationship set-up methods and improve naming. We
+      # currently have length_arg=, array_arg=, closure= and
+      # mark_as_destroy_notifier.
+      def mark_as_destroy_notifier(callback)
+        @destroy_notifier = callback
+      end
+
+      def array_length_parameter?
+        @array_arg
+      end
+
+      def closure?
+        @is_closure
+      end
+
+      def destroy_notifier?
+        @destroy_notifier
+      end
+
+      def helper_argument?
+        array_length_parameter? || closure? || destroy_notifier?
+      end
+
       def ownership_transfer
         arginfo.ownership_transfer
       end

data/lib/gir_ffi/builders/base_method_builder.rb

@@ -53,7 +53,7 @@ module GirFFI
       # Methods used by MethodTemplate
 
       def invocation
-        "#{lib_name}.#{@info.symbol} #{function_call_arguments.join(', ')}"
+        "#{lib_name}.#{@info.symbol} #{function_call_arguments.join(', ')}".strip
       end
 
       def method_arguments

data/lib/gir_ffi/builders/callback_argument_builder.rb

@@ -12,6 +12,10 @@ module GirFFI
         @method_argument_name ||= name || new_variable
       end
 
+      def block_argument?
+        false
+      end
+
       def pre_converted_name
         @pre_converted_name ||= new_variable
       end

data/lib/gir_ffi/builders/closure_to_pointer_convertor.rb

@@ -3,12 +3,13 @@ module GirFFI
     # Builder that generates code to convert closure arguments ('user data')
     # from Ruby to C. Used by argument builders.
     class ClosureToPointerConvertor
-      def initialize(argument_name)
+      def initialize(argument_name, callback_argument)
         @argument_name = argument_name
+        @callback_argument = callback_argument
       end
 
       def conversion
-        "GirFFI::InPointer.from_closure_data(#{@argument_name})"
+        "GirFFI::InPointer.from_closure_data(#{@callback_argument.call_argument_name}.object_id)"
       end
     end
   end

data/lib/gir_ffi/builders/constructor_builder.rb

@@ -27,7 +27,7 @@ module GirFFI
       end
 
       def method_arguments
-        ['*args']
+        ['*args', '&block']
       end
 
       def preparation

data/lib/gir_ffi/builders/enum_builder.rb

@@ -21,7 +21,7 @@ module GirFFI
       end
 
       def setup_class
-        setup_ffi_enum
+        setup_ffi_type
         klass.extend superclass
         setup_constants
         stub_methods
@@ -32,8 +32,8 @@ module GirFFI
         @klass ||= get_or_define_module namespace_module, @classname
       end
 
-      def setup_ffi_enum
-        @enum = optionally_define_constant klass, :Enum do
+      def setup_ffi_type
+        optionally_define_constant klass, :Enum do
           lib.enum(enum_sym, value_spec)
         end
       end
@@ -51,7 +51,7 @@ module GirFFI
       end
 
       def superclass
-        @superclass ||= EnumBase
+        EnumBase
       end
     end
   end

data/lib/gir_ffi/builders/error_argument_builder.rb

@@ -10,6 +10,10 @@ module GirFFI
         nil
       end
 
+      def block_argument?
+        false
+      end
+
       def return_value_name
         nil
       end

data/lib/gir_ffi/builders/field_builder.rb

@@ -9,10 +9,12 @@ module GirFFI
       # Convertor for fields for field getters. Used when building getter
       # methods.
       class GetterArgumentBuilder < BaseArgumentBuilder
-        def initialize(var_gen, field_argument_info, field_info, options = {})
+        def initialize(var_gen, field_argument_info, field_info,
+                       array_length_idx: -1)
           super(var_gen, field_argument_info)
           @field_info = field_info
-          @length_arg = options.fetch(:length_argument) { NullArgumentBuilder.new }
+          @length_arg = NullArgumentBuilder.new
+          @array_length_idx = array_length_idx
         end
 
         def pre_conversion
@@ -47,6 +49,10 @@ module GirFFI
           end
         end
 
+        def array_length_idx
+          @array_length_idx
+        end
+
         private
 
         def field_offset
@@ -98,6 +104,10 @@ module GirFFI
           -1
         end
 
+        def destroy
+          -1
+        end
+
         def direction
           :out
         end
@@ -163,22 +173,26 @@ module GirFFI
           @argument_builders ||=
             ArgumentBuilderCollection.new(
               NullReturnValueBuilder.new,
-              [getter_argument_builder, length_argument_builder])
+              base_argument_builders)
+        end
+
+        def base_argument_builders
+          if array_length_field
+            [getter_argument_builder, length_argument_builder]
+          else
+            [getter_argument_builder]
+          end
         end
 
         def getter_argument_builder
           @getter_argument_builder ||=
             GetterArgumentBuilder.new(var_gen, field_argument_info, @info,
-                                      length_argument: length_argument_builder)
+                                      array_length_idx: array_length_field ? 1 : -1)
         end
 
         def length_argument_builder
           @length_argument_builder ||=
-            if array_length_field
-              GetterArgumentBuilder.new(var_gen, length_argument_info, array_length_field)
-            else
-              NullArgumentBuilder.new
-            end
+            GetterArgumentBuilder.new(var_gen, length_argument_info, array_length_field)
         end
 
         def array_length_field

data/lib/gir_ffi/builders/flags_builder.rb

@@ -0,0 +1,28 @@
+require 'gir_ffi/builders/enum_builder'
+require 'gir_ffi/flags_base'
+
+module GirFFI
+  module Builders
+    # Implements the creation of a flags type. The type will be
+    # attached to the appropriate namespace module, and will be defined
+    # as a bit_mask for FFI.
+    class FlagsBuilder < EnumBuilder
+      def setup_ffi_type
+        optionally_define_constant klass, :BitMask do
+          lib.bit_mask(enum_sym, value_spec)
+        end
+      end
+
+      def value_spec
+        info.values.map do|vinfo|
+          val = GirFFI::ArgHelper.cast_uint32_to_int32(vinfo.value)
+          { vinfo.name.to_sym => val }
+        end.reduce(:merge)
+      end
+
+      def superclass
+        FlagsBase
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/full_c_to_ruby_convertor.rb

@@ -0,0 +1,18 @@
+require 'gir_ffi/builders/c_to_ruby_convertor'
+
+module GirFFI
+  module Builders
+    # Builder that generates code to convert values from C to Ruby, including
+    # GValue unpacking. Used by argument builders.
+    class FullCToRubyConvertor < CToRubyConvertor
+      def conversion
+        base = super
+        if @type_info.gvalue?
+          "#{base}.get_value"
+        else
+          base
+        end
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/module_builder.rb

@@ -83,6 +83,7 @@ module GirFFI
 
       def setup_lib_for_ffi
         lib.extend FFI::Library
+        lib.extend FFI::BitMasks
         lib.ffi_lib_flags :global, :lazy
         if shared_library_specification
           lib.ffi_lib(*shared_library_specification.split(/,/))

data/lib/gir_ffi/builders/null_argument_builder.rb

@@ -32,10 +32,18 @@ module GirFFI
       nil
     end
 
-    def closure
+    def closure_idx
       -1
     end
 
+    def destroy_idx
+      -1
+    end
+
+    def block_argument?
+      false
+    end
+
     def post_converted_name
       nil
     end

data/lib/gir_ffi/builders/object_builder.rb

@@ -38,6 +38,13 @@ module GirFFI
         @ancestor_infos ||= [info] + info.interfaces + parent_ancestor_infos
       end
 
+      protected
+
+      def object_class_struct_info
+        @object_class_struct_info ||=
+          info.class_struct || parent_builder.object_class_struct_info
+      end
+
       private
 
       def setup_class
@@ -131,10 +138,6 @@ module GirFFI
         end
       end
 
-      def object_class_struct_info
-        @object_class_struct_info ||= info.class_struct
-      end
-
       def seek_in_ancestor_infos
         ancestor_infos.each do |info|
           item = yield info

data/lib/gir_ffi/builders/property_builder.rb

@@ -50,7 +50,7 @@ module GirFFI
         capture = getter_builder.capture_variable_name
         <<-CODE.reset_indentation
         def #{getter_name}
-          #{capture} = get_property("#{property_name}").get_value_plain
+          #{capture} = get_property("#{property_name}")
           #{getter_builder.post_conversion.join("\n")}
           #{getter_builder.return_value_name}
         end
@@ -60,7 +60,7 @@ module GirFFI
       def simple_getter_def
         <<-CODE.reset_indentation
         def #{getter_name}
-          get_property("#{property_name}").get_value
+          get_property("#{property_name}")
         end
         CODE
       end

data/lib/gir_ffi/builders/return_value_builder.rb

@@ -1,5 +1,5 @@
 require 'gir_ffi/builders/base_argument_builder'
-require 'gir_ffi/builders/c_to_ruby_convertor'
+require 'gir_ffi/builders/full_c_to_ruby_convertor'
 require 'gir_ffi/builders/closure_convertor'
 
 module GirFFI
@@ -44,9 +44,9 @@ module GirFFI
         @post_convertor ||= if closure?
                               ClosureConvertor.new(capture_variable_name)
                             else
-                              CToRubyConvertor.new(type_info,
-                                                   capture_variable_name,
-                                                   length_argument_name)
+                              FullCToRubyConvertor.new(type_info,
+                                                       capture_variable_name,
+                                                       length_argument_name)
                             end
       end
 

data/lib/gir_ffi/builders/struct_builder.rb

@@ -9,9 +9,17 @@ module GirFFI
         FFI::Struct
       end
 
-      private
-
       def superclass
+        if info.gtype_struct?
+          # HACK: Inheritance chain is not expressed in GObject's code correctly.
+          if info.full_type_name == 'GObject::InitiallyUnownedClass'
+            return GObject::ObjectClass
+          else
+            type = fields.first.field_type
+            return type.tag_or_class if type.tag == :interface
+          end
+        end
+
         StructBase
       end
     end