gir_ffi 0.9.4 → 0.9.5

data/lib/gir_ffi/builders/property_builder.rb

@@ -1,6 +1,63 @@
 # frozen_string_literal: true
+require 'gir_ffi/builders/method_template'
+require 'gir_ffi/builders/argument_builder_collection'
+require 'gir_ffi/builders/property_argument_builder'
+require 'gir_ffi/builders/property_return_value_builder'
+require 'gir_ffi/variable_name_generator'
+require 'gir_ffi/field_argument_info'
+
 module GirFFI
   module Builders
+    # Method builder used for the creation of property getter methods.
+    class PropertyGetterBuilder
+      attr_reader :info
+      attr_reader :return_value_builder
+
+      def initialize(info, return_value_builder)
+        @return_value_builder = return_value_builder
+        @info = info
+      end
+
+      def method_definition
+        template.method_definition
+      end
+
+      def template
+        @template ||= MethodTemplate.new(self, argument_builder_collection)
+      end
+
+      def singleton_method?
+        false
+      end
+
+      def method_name
+        info.getter_name
+      end
+
+      def method_arguments
+        []
+      end
+
+      def preparation
+        []
+      end
+
+      def invocation
+        "get_property('#{info.name}')"
+      end
+
+      def result
+        [return_value_builder.return_value_name]
+      end
+
+      private
+
+      def argument_builder_collection
+        @argument_builder_collection ||=
+          ArgumentBuilderCollection.new(return_value_builder, [])
+      end
+    end
+
     # Creates property getter and setter code for a given IPropertyInfo.
     class PropertyBuilder
       def initialize(property_info)
@@ -24,51 +81,20 @@ module GirFFI
         container_class.class_eval setter_def
       end
 
-      # TODO: Fix argument builders so converting_getter_def can always be used.
       def getter_def
-        case type_info.tag
-        when :glist, :ghash
-          converting_getter_def
-        else
-          simple_getter_def
-        end
+        PropertyGetterBuilder.new(@info, getter_builder).method_definition
       end
 
-      # TODO: Fix argument builders so converting_setter_def can always be used.
       def setter_def
-        case type_info.flattened_tag
-        when :glist, :ghash, :strv
-          converting_setter_def
-        else
-          simple_setter_def
-        end
+        converting_setter_def
       end
 
       private
 
-      # TODO: Use a builder like MarshallingMethodBuilder
-      def converting_getter_def
-        capture = getter_builder.capture_variable_name
-        <<-CODE.reset_indentation
-        def #{getter_name}
-          #{capture} = get_property("#{property_name}")
-          #{getter_builder.post_conversion.join("\n")}
-          #{getter_builder.return_value_name}
-        end
-        CODE
-      end
-
-      def simple_getter_def
-        <<-CODE.reset_indentation
-        def #{getter_name}
-          get_property("#{property_name}")
-        end
-        CODE
-      end
-
       def getter_builder
-        @getter_builder ||= ReturnValueBuilder.new(VariableNameGenerator.new,
-                                                   argument_info)
+        @getter_builder ||=
+          PropertyReturnValueBuilder.new(VariableNameGenerator.new,
+                                         argument_info)
       end
 
       def converting_setter_def
@@ -80,17 +106,10 @@ module GirFFI
         CODE
       end
 
-      def simple_setter_def
-        <<-CODE.reset_indentation
-        def #{setter_name} value
-          set_property("#{property_name}", value)
-        end
-        CODE
-      end
-
       def setter_builder
-        @setter_builder ||= ArgumentBuilder.new(VariableNameGenerator.new,
-                                                argument_info)
+        @setter_builder ||=
+          PropertyArgumentBuilder.new(VariableNameGenerator.new,
+                                      argument_info)
       end
 
       def property_name

data/lib/gir_ffi/builders/property_return_value_builder.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'gir_ffi/builders/return_value_builder'
+
+module GirFFI
+  module Builders
+    # Implements building post-processing statements for return values of
+    # property getters.
+    class PropertyReturnValueBuilder < ReturnValueBuilder
+      def needs_c_to_ruby_conversion?
+        type_info.needs_c_to_ruby_conversion_for_properties?
+      end
+    end
+  end
+end

data/lib/gir_ffi/builders/return_value_builder.rb

@@ -1,32 +1,12 @@
 # frozen_string_literal: true
-require 'gir_ffi/builders/base_argument_builder'
+require 'gir_ffi/builders/base_return_value_builder'
 require 'gir_ffi/builders/full_c_to_ruby_convertor'
 require 'gir_ffi/builders/closure_convertor'
 
 module GirFFI
   module Builders
     # Implements building post-processing statements for return values.
-    class ReturnValueBuilder < BaseArgumentBuilder
-      def relevant?
-        !void_return_value? && !arginfo.skip?
-      end
-
-      def capture_variable_name
-        @capture_variable_name ||= new_variable if relevant?
-      end
-
-      def post_converted_name
-        @post_converted_name ||= if has_post_conversion?
-                                   new_variable
-                                 else
-                                   capture_variable_name
-                                 end
-      end
-
-      def return_value_name
-        post_converted_name if has_return_value_name?
-      end
-
+    class ReturnValueBuilder < BaseReturnValueBuilder
       def post_conversion
         if has_post_conversion?
           ["#{post_converted_name} = #{post_convertor.conversion}"]
@@ -35,12 +15,16 @@ module GirFFI
         end
       end
 
-      private
-
       def has_post_conversion?
-        closure? || type_info.needs_c_to_ruby_conversion_for_functions?
+        closure? || needs_c_to_ruby_conversion?
+      end
+
+      def needs_c_to_ruby_conversion?
+        type_info.needs_c_to_ruby_conversion_for_functions?
       end
 
+      private
+
       def post_convertor
         @post_convertor ||= if closure?
                               ClosureConvertor.new(capture_variable_name)
@@ -54,14 +38,6 @@ module GirFFI
       def length_argument_name
         length_arg && length_arg.post_converted_name
       end
-
-      def void_return_value?
-        specialized_type_tag == :void && !type_info.pointer?
-      end
-
-      def has_return_value_name?
-        relevant? && !array_arg
-      end
     end
   end
 end

data/lib/gir_ffi/callback_base.rb

@@ -13,6 +13,7 @@ module GirFFI
       FFI::Type::POINTER
     end
 
+    # TODO: Return instance of this class
     def self.from_native(value, _context)
       return nil if !value || value.null?
       FFI::Function.new(gir_ffi_builder.return_ffi_type,
@@ -74,6 +75,10 @@ module GirFFI
                      end
     end
 
+    def to_ptr
+      to_native.to_ptr
+    end
+
     def self.copy_value_to_pointer(value, pointer)
       pointer.put_pointer 0, to_native(value, nil)
     end

data/lib/gir_ffi/core.rb

@@ -23,9 +23,9 @@ require 'gir_ffi/version'
 # Main module containing classes and modules needed for generating GLib and
 # GObject bindings.
 module GirFFI
-  def self.setup(module_name, version = nil)
-    module_name = module_name.to_s
-    GirFFI::Builder.build_module module_name, version
+  def self.setup(namespace, version = nil)
+    namespace = namespace.to_s
+    GirFFI::Builder.build_module namespace, version
   end
 
   def self.define_type(klass, &block)

data/lib/gir_ffi/in_pointer.rb

@@ -35,7 +35,7 @@ module GirFFI
       case type
       when :utf8, :filename
         from_utf8 val
-      when :gint32, :guint32, :gint8
+      when :gint32, :guint32, :gint8, :GType
         new val
       when Class, :void
         val.to_ptr

data/lib/gir_ffi/info_ext/i_signal_info.rb

@@ -16,9 +16,8 @@ module GirFFI
       end
 
       def arguments_to_gvalues(instance, arguments)
-        arg_g_values = args.map { |info| info.argument_type.make_g_value }
-        arg_g_values.zip(arguments).each do |g_value, arg|
-          g_value.set_value arg
+        arg_g_values = args.zip(arguments).map do |info, arg|
+          info.argument_type.make_g_value.tap { |it| it.set_value arg }
         end
 
         arg_g_values.unshift GObject::Value.wrap_instance(instance)

data/lib/gir_ffi/info_ext/i_type_info.rb

@@ -7,24 +7,24 @@ module GirFFI
     module ITypeInfo
       def self.flattened_tag_to_gtype_map
         @flattened_tag_to_gtype_map ||= {
-          array:    GObject::TYPE_ARRAY,
-          c:        GObject::TYPE_POINTER,
-          gboolean: GObject::TYPE_BOOLEAN,
-          ghash:    GObject::TYPE_HASH_TABLE,
-          gint32:   GObject::TYPE_INT,
-          gint64:   GObject::TYPE_INT64,
-          guint64:  GObject::TYPE_UINT64,
-          strv:     GObject::TYPE_STRV,
-          utf8:     GObject::TYPE_STRING,
-          void:     GObject::TYPE_NONE
+          [:array, true]     => GObject::TYPE_ARRAY,
+          [:c, true]         => GObject::TYPE_POINTER,
+          [:gboolean, false] => GObject::TYPE_BOOLEAN,
+          [:ghash, true]     => GObject::TYPE_HASH_TABLE,
+          [:glist, true]     => GObject::TYPE_POINTER,
+          [:gint32, false]   => GObject::TYPE_INT,
+          [:gint64, false]   => GObject::TYPE_INT64,
+          [:guint64, false]  => GObject::TYPE_UINT64,
+          [:strv, true]      => GObject::TYPE_STRV,
+          [:utf8, true]      => GObject::TYPE_STRING,
+          [:void, true]      => GObject::TYPE_POINTER,
+          [:void, false]     => GObject::TYPE_NONE
         }.freeze
       end
 
       def gtype
         return interface.gtype if tag == :interface
-        type = ITypeInfo.flattened_tag_to_gtype_map[flattened_tag]
-        return type if type
-        raise "Can't find GType for #{flattened_tag} pointer? = #{pointer?}"
+        ITypeInfo.flattened_tag_to_gtype_map.fetch [flattened_tag, pointer?]
       end
 
       def make_g_value
@@ -158,13 +158,21 @@ module GirFFI
       end
 
       def needs_c_to_ruby_conversion_for_closures?
-        [:array, :c, :ghash, :struct, :strv].include?(flattened_tag)
+        [:array, :c, :ghash, :glist, :struct, :strv].include?(flattened_tag)
       end
 
       def needs_ruby_to_c_conversion_for_closures?
         [:array].include?(flattened_tag)
       end
 
+      def needs_ruby_to_c_conversion_for_properties?
+        [:glist, :ghash, :strv, :callback].include?(flattened_tag)
+      end
+
+      def needs_c_to_ruby_conversion_for_properties?
+        [:glist, :ghash, :callback].include?(flattened_tag)
+      end
+
       def extra_conversion_arguments
         case flattened_tag
         when :utf8, :void

data/lib/gir_ffi/interface_base.rb

@@ -6,10 +6,22 @@ module GirFFI
   module InterfaceBase
     include RegisteredTypeBase
 
+    def setup_and_call(method, arguments, &block)
+      method_name = setup_method method.to_s
+      unless method_name
+        raise NoMethodError, "undefined method `#{method}' for #{self}"
+      end
+      send method_name, *arguments, &block
+    end
+
     def setup_instance_method(name)
       gir_ffi_builder.setup_instance_method name
     end
 
+    def setup_method(name)
+      gir_ffi_builder.setup_method name
+    end
+
     def wrap(ptr)
       ptr.to_object
     end

data/lib/gir_ffi/user_defined_type_info.rb

@@ -49,6 +49,14 @@ module GirFFI
       parent.class_struct
     end
 
+    def interfaces
+      (@klass.included_modules - @klass.superclass.included_modules).map(&:gir_info)
+    end
+
+    def find_signal(_signal_name)
+      nil
+    end
+
     attr_writer :g_name
 
     def g_name

data/lib/gir_ffi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # Current GirFFI version
 module GirFFI
-  VERSION = '0.9.4'.freeze
+  VERSION = '0.9.5'.freeze
 end

data/test/gir_ffi/builders/function_builder_test.rb

@@ -36,6 +36,25 @@ describe GirFFI::Builders::FunctionBuilder do
       end
     end
 
+    describe 'for methods taking a zero-terminated array with length argument' do
+      let(:function_info) { get_method_introspection_data 'Regress', 'AnnotationObject', 'parse_args' }
+      it 'builds a correct definition' do
+        skip unless function_info
+        code.must_equal <<-CODE.reset_indentation
+          def parse_args(argv)
+            argc = argv.nil? ? 0 : argv.length
+            _v1 = GirFFI::InOutPointer.for :gint32
+            _v1.set_value argc
+            _v2 = GirFFI::InOutPointer.for [:pointer, :strv]
+            _v2.set_value GLib::Strv.from(argv)
+            Regress::Lib.regress_annotation_object_parse_args self, _v1, _v2
+            _v3 = GLib::Strv.wrap(_v2.to_value)
+            return _v3
+          end
+        CODE
+      end
+    end
+
     describe 'for functions with callbacks' do
       let(:function_info) { get_introspection_data 'Regress', 'test_callback_destroy_notify' }
       it 'builds a correct definition' do

data/test/gir_ffi/builders/object_builder_test.rb

@@ -65,21 +65,15 @@ describe GirFFI::Builders::ObjectBuilder do
     end
   end
 
-  # TODO: Improve this spec to use less mocking
   describe 'for a struct without defined fields' do
-    it 'uses a single field of the parent struct type as the default layout' do
-      @gir = GObjectIntrospection::IRepository.default
-      @gir.require 'GObject', nil
+    let(:info) { get_introspection_data 'GObject', 'Binding' }
 
-      allow(info = Object.new).to receive(:parent).and_return @gir.find_by_name 'GObject', 'Object'
-      allow(info).to receive(:fields).and_return []
-      allow(info).to receive(:info_type).and_return :object
-      allow(info).to receive(:safe_name).and_return 'Bar'
-      allow(info).to receive(:namespace).and_return 'Foo'
+    it 'uses a single field of the parent struct type as the default layout' do
+      info.n_fields.must_equal 0
 
-      @classbuilder = GirFFI::Builders::ObjectBuilder.new info
+      builder = GirFFI::Builders::ObjectBuilder.new info
 
-      spec = @classbuilder.send :layout_specification
+      spec = builder.send :layout_specification
       assert_equal [:parent, GObject::Object::Struct, 0], spec
     end
   end

data/test/gir_ffi/builders/property_builder_test.rb

@@ -9,7 +9,7 @@ describe GirFFI::Builders::PropertyBuilder do
     it 'generates the correct getter definition' do
       expected = <<-CODE.reset_indentation
       def list
-        _v1 = get_property("list")
+        _v1 = get_property('list')
         _v2 = GLib::List.wrap(:utf8, _v1)
         _v2
       end
@@ -35,7 +35,7 @@ describe GirFFI::Builders::PropertyBuilder do
     it 'generates the correct getter definition' do
       expected = <<-CODE.reset_indentation
       def hash_table
-        _v1 = get_property("hash-table")
+        _v1 = get_property('hash-table')
         _v2 = GLib::HashTable.wrap([:utf8, :gint8], _v1)
         _v2
       end
@@ -69,7 +69,8 @@ describe GirFFI::Builders::PropertyBuilder do
     it 'generates the correct getter definition' do
       expected = <<-CODE.reset_indentation
       def some_strv
-        get_property("some-strv")
+        _v1 = get_property('some-strv')
+        _v1
       end
       CODE
 
@@ -93,7 +94,8 @@ describe GirFFI::Builders::PropertyBuilder do
     it 'generates the correct getter definition' do
       expected = <<-CODE.reset_indentation
       def string
-        get_property("string")
+        _v1 = get_property('string')
+        _v1
       end
       CODE
 
@@ -103,7 +105,37 @@ describe GirFFI::Builders::PropertyBuilder do
     it 'generates the correct setter definition' do
       expected = <<-CODE.reset_indentation
       def string= value
-        set_property("string", value)
+        _v1 = value
+        set_property("string", _v1)
+      end
+      CODE
+
+      builder.setter_def.must_equal expected
+    end
+  end
+
+  describe 'for a property of a callback type' do
+    let(:property_info) do
+      get_property_introspection_data('Regress', 'AnnotationObject', 'function-property')
+    end
+
+    it 'generates the correct getter definition' do
+      expected = <<-CODE.reset_indentation
+      def function_property
+        _v1 = get_property('function-property')
+        _v2 = Regress::AnnotationCallback.wrap(_v1)
+        _v2
+      end
+      CODE
+
+      builder.getter_def.must_equal expected
+    end
+
+    it 'generates the correct setter definition' do
+      expected = <<-CODE.reset_indentation
+      def function_property= value
+        _v1 = Regress::AnnotationCallback.from(value)
+        set_property("function-property", _v1)
       end
       CODE