gir_ffi 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6121625e854dd754146516dab64b67c650155c67
-  data.tar.gz: e486edea5ebffe7146c68dca786796f94ac58945
+  metadata.gz: be09f0c7b882ddc0bb3dfdc7d0c78a799f364523
+  data.tar.gz: 0a5cff8324417259a1092c686e9d3ffc492efebf
 SHA512:
-  metadata.gz: 170a26c6f8aecc34a77722a5525d8b1534491febdd244fff0a9c88aa298a357ee0914f1fc15393da52b306d2f295e7aaba0180f258a187e942433658e51262ae
-  data.tar.gz: afbed9ce4c8869f8e44b6c1bbb36d22192bf27e01720874d9e3632fd5dd4b59fcc5604e785c39ccf1c6b8e6fe084270d7efee54f992a70e36dc469fd93508031
+  metadata.gz: 26639dd911992a83273376f6421f9eee8f802386d3b345a62feacd4b6a7d5fac9f7cc55cba160428ceb59c7e4740404b990761892fddef705bb4dd94bcf1fa21
+  data.tar.gz: 63a71dd6cf133b0e7f0dcaf335961297b968e3cc3293170e9f5b9daf9709ad6562cc1df92e8c4b4749af61b9966a8540153a316002ef2b0b8bf817dd02199837

data/Changelog.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.8.3 / 2015-11-13
+
+* Fix handling of signal handler return values
+* Do not create setters for properties that cannot be set
+
 ## 0.8.2 / 2015-10-10
 
 * Use inherited constructor for boxed types

data/TODO.md

@@ -65,6 +65,19 @@ It would be good to replace this with something that's easier to use:
   Ruby-GNOME do
 * What about properties?
 
+How about:
+
+    class Derived < Base
+      include SomeGObjectInterface
+
+      register_type 'Derived'
+
+      install_property ...
+      install_vfunc_implementation ...
+    end
+
+This needs issue #63 to be resolved.
+
 ## Persistent Ruby GObject identity
 
 GirFFI should make sure that if it gets a pointer to a GObject for which a Ruby

data/lib/ffi-gobject_introspection/i_property_info.rb

@@ -5,5 +5,25 @@ module GObjectIntrospection
     def property_type
       ITypeInfo.wrap(Lib.g_property_info_get_type @gobj)
     end
+
+    def flags
+      Lib.g_property_info_get_flags @gobj
+    end
+
+    def readable?
+      flags & 1 != 0
+    end
+
+    def writeable?
+      flags & 2 != 0
+    end
+
+    def construct?
+      flags & 4 != 0
+    end
+
+    def construct_only?
+      flags & 8 != 0
+    end
   end
 end

data/lib/ffi-gobject_introspection/lib.rb

@@ -289,6 +289,8 @@ module GObjectIntrospection
     # IPropertyInfo
     #
     attach_function :g_property_info_get_type, [:pointer], :pointer
+    # TODO: return type is bitfield
+    attach_function :g_property_info_get_flags, [:pointer], :int
 
     ::GObjectIntrospection::VERSION = version_guesser.best_guess
   end

data/lib/gir_ffi/builders/argument_builder_collection.rb

@@ -36,7 +36,7 @@ module GirFFI
       end
 
       def return_value_name
-        return_value_builder.return_value_name if return_value_builder.relevant?
+        return_value_builder.return_value_name
       end
 
       def return_value_names

data/lib/gir_ffi/builders/callback_return_value_builder.rb

@@ -38,12 +38,16 @@ module GirFFI
         end
       end
 
-      private
-
       def has_post_conversion?
-        type_info.needs_c_to_ruby_conversion_for_callbacks?
+        relevant? && needs_ruby_to_c_conversion?
+      end
+
+      def needs_ruby_to_c_conversion?
+        type_info.needs_ruby_to_c_conversion_for_callbacks?
       end
 
+      private
+
       def post_convertor
         @post_convertor ||= RubyToCConvertor.new(type_info, post_convertor_argument)
       end

data/lib/gir_ffi/builders/closure_return_value_builder.rb

@@ -0,0 +1,14 @@
+require 'gir_ffi/builders/callback_return_value_builder'
+
+module GirFFI
+  module Builders
+    # Implements building post-processing statements for return values of
+    # closures.
+    class ClosureReturnValueBuilder < CallbackReturnValueBuilder
+      def needs_ruby_to_c_conversion?
+        type_info.needs_ruby_to_c_conversion_for_closures?
+      end
+    end
+  end
+end
+

data/lib/gir_ffi/builders/marshalling_method_builder.rb

@@ -1,6 +1,6 @@
 require 'gir_ffi/variable_name_generator'
 require 'gir_ffi/builders/closure_argument_builder'
-require 'gir_ffi/builders/callback_return_value_builder'
+require 'gir_ffi/builders/closure_return_value_builder'
 require 'gir_ffi/builders/argument_builder_collection'
 require 'gir_ffi/builders/method_template'
 
@@ -20,7 +20,7 @@ module GirFFI
         receiver_builder = make_argument_builder receiver_info
         argument_builders = argument_infos.map { |arg| make_argument_builder arg }
         return_value_builder =
-          CallbackReturnValueBuilder.new(variable_generator, return_value_info)
+          ClosureReturnValueBuilder.new(variable_generator, return_value_info)
 
         @argument_builder_collection =
           ArgumentBuilderCollection.new(return_value_builder, argument_builders,

data/lib/gir_ffi/builders/property_builder.rb

@@ -8,7 +8,7 @@ module GirFFI
 
       def build
         setup_getter
-        setup_setter
+        setup_setter if setting_allowed
       end
 
       def setup_getter
@@ -123,6 +123,10 @@ module GirFFI
       def container_info
         @container_info ||= @info.container
       end
+
+      def setting_allowed
+        @info.writeable? && !@info.construct_only?
+      end
     end
   end
 end

data/lib/gir_ffi/info_ext/i_type_info.rb

@@ -163,6 +163,10 @@ module GirFFI
         [:array, :c, :ghash, :struct, :strv].include?(flattened_tag)
       end
 
+      def needs_ruby_to_c_conversion_for_closures?
+        [:array].include?(flattened_tag)
+      end
+
       def extra_conversion_arguments
         case flattened_tag
         when :utf8, :void

data/lib/gir_ffi/version.rb

@@ -1,4 +1,4 @@
 # Current GirFFI version
 module GirFFI
-  VERSION = '0.8.2'
+  VERSION = '0.8.3'
 end

data/test/ffi-gobject_introspection/i_property_info_test.rb

@@ -0,0 +1,44 @@
+require 'introspection_test_helper'
+
+describe GObjectIntrospection::IPropertyInfo do
+  describe "for Regress::TestObj's 'double' property" do
+    let(:property_info) { get_property_introspection_data 'Regress', 'TestObj', 'double' }
+
+    it 'returns :gdouble as its type' do
+      property_info.property_type.tag.must_equal :gdouble
+    end
+
+    it 'flags the property as readable' do
+      property_info.readable?.must_equal true
+    end
+
+    it 'flags the property as writeable' do
+      property_info.writeable?.must_equal true
+    end
+
+    it 'flags the property as not construct-only' do
+      property_info.construct_only?.must_equal false
+    end
+  end
+
+  describe "for GObject::Binding's 'target-property' property" do
+    let(:property_info) {
+      get_property_introspection_data 'GObject', 'Binding', 'target-property' }
+
+    it 'returns :utf8 as its type' do
+      property_info.property_type.tag.must_equal :utf8
+    end
+
+    it 'flags the property as readable' do
+      property_info.readable?.must_equal true
+    end
+
+    it 'flags the property as writeable' do
+      property_info.writeable?.must_equal true
+    end
+
+    it 'flags the property as construct-only' do
+      property_info.construct_only?.must_equal true
+    end
+  end
+end

data/test/gir_ffi/builders/signal_closure_builder_test.rb

@@ -139,5 +139,27 @@ describe GirFFI::Builders::SignalClosureBuilder do
         builder.marshaller_definition.must_equal expected
       end
     end
+
+    describe 'for a signal returning an string' do
+      let(:signal_info) do
+        get_signal_introspection_data 'Gtk', 'Scale', 'format-value'
+      end
+
+      it 'returns a mapping method that passes the string result to return_value directly' do
+        skip unless signal_info
+
+        expected = <<-CODE.reset_indentation
+        def self.marshaller(closure, return_value, param_values, _invocation_hint, _marshal_data)
+          _instance, value = param_values.map(&:get_value_plain)
+          _v1 = _instance
+          _v2 = value
+          _v3 = wrap(closure.to_ptr).invoke_block(_v1, _v2)
+          return_value.set_value _v3
+        end
+        CODE
+
+        builder.marshaller_definition.must_equal expected
+      end
+    end
   end
 end

data/test/gir_ffi_test_helper.rb

@@ -11,26 +11,6 @@ class Sequence
 end
 
 module GirFFITestExtensions
-  def get_field_introspection_data(namespace, klass, name)
-    get_introspection_data(namespace, klass).find_field name
-  end
-
-  def get_method_introspection_data(namespace, klass, name)
-    get_introspection_data(namespace, klass).find_method name
-  end
-
-  def get_property_introspection_data(namespace, klass, name)
-    get_introspection_data(namespace, klass).find_property name
-  end
-
-  def get_signal_introspection_data(namespace, klass, name)
-    get_introspection_data(namespace, klass).find_signal name
-  end
-
-  def get_vfunc_introspection_data(namespace, klass, name)
-    get_introspection_data(namespace, klass).find_vfunc name
-  end
-
   SAVED_MODULES = {}
 
   def save_module(name)

data/test/integration/generated_gio_test.rb

@@ -98,4 +98,20 @@ describe 'The generated Gio module' do
       Gio::SocketSourceFunc.new { |*args| p args }.to_native
     end
   end
+
+  describe 'Gio::SimpleAction' do
+    let(:simple_action) { Gio::SimpleAction.new('test', 'd') }
+
+    it 'can read the property "state-type" with #get_property' do
+      simple_action.get_property('state-type').get_value.must_be_nil
+    end
+
+    it 'can read the property "state-type" with #state_type' do
+      simple_action.state_type.must_be_nil
+    end
+
+    it 'cannot write the property "state-type" with #state_type=' do
+      proc { simple_action.state_type = nil }.must_raise NoMethodError
+    end
+  end
 end

data/test/integration/generated_gobject_test.rb

@@ -1,5 +1,7 @@
 require 'gir_ffi_test_helper'
 
+GirFFI.setup :Regress
+
 describe GObject do
   describe '.type_interfaces' do
     it 'works, showing that returning an array of GType works' do
@@ -72,4 +74,31 @@ describe GObject do
       signal_query.param_types.size.must_equal 1
     end
   end
+
+  describe GObject::Binding do
+    it 'is created with GObject::Object#bind_property' do
+      source = Regress::TestObj.constructor
+      target = Regress::TestObj.constructor
+      binding = source.bind_property 'double', target, 'double', :default
+      binding.must_be_kind_of GObject::Binding
+    end
+
+    describe 'an instance' do
+      let(:source) { Regress::TestObj.constructor }
+      let(:target) { Regress::TestObj.constructor }
+      let(:binding) { source.bind_property 'double', target, 'double', :default }
+
+      it 'can read the property "target-property" with #get_property' do
+        binding.get_property('target-property').get_value.must_equal 'double'
+      end
+
+      it 'can read the property "target-property" with #target_property' do
+        binding.target_property.must_equal 'double'
+      end
+
+      it 'cannot write the property "target-property" with #target_property=' do
+        proc { binding.target_property = 'foo' }.must_raise NoMethodError
+      end
+    end
+  end
 end

data/test/introspection_test_helper.rb

@@ -8,6 +8,26 @@ module IntrospectionTestExtensions
     gir.require namespace, nil
     gir.find_by_name namespace, name
   end
+
+  def get_field_introspection_data(namespace, klass, name)
+    get_introspection_data(namespace, klass).find_field name
+  end
+
+  def get_method_introspection_data(namespace, klass, name)
+    get_introspection_data(namespace, klass).find_method name
+  end
+
+  def get_property_introspection_data(namespace, klass, name)
+    get_introspection_data(namespace, klass).find_property name
+  end
+
+  def get_signal_introspection_data(namespace, klass, name)
+    get_introspection_data(namespace, klass).find_signal name
+  end
+
+  def get_vfunc_introspection_data(namespace, klass, name)
+    get_introspection_data(namespace, klass).find_vfunc name
+  end
 end
 
 Minitest::Test.send :include, IntrospectionTestExtensions

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gir_ffi
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Matijs van Zuijlen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-10 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -174,6 +174,7 @@ files:
 - lib/gir_ffi/builders/callback_return_value_builder.rb
 - lib/gir_ffi/builders/closure_argument_builder.rb
 - lib/gir_ffi/builders/closure_convertor.rb
+- lib/gir_ffi/builders/closure_return_value_builder.rb
 - lib/gir_ffi/builders/closure_to_pointer_convertor.rb
 - lib/gir_ffi/builders/constant_builder.rb
 - lib/gir_ffi/builders/constructor_builder.rb
@@ -281,6 +282,7 @@ files:
 - test/ffi-gobject_introspection/i_function_info_test.rb
 - test/ffi-gobject_introspection/i_interface_info_test.rb
 - test/ffi-gobject_introspection/i_object_info_test.rb
+- test/ffi-gobject_introspection/i_property_info_test.rb
 - test/ffi-gobject_introspection/i_registered_type_info_test.rb
 - test/ffi-gobject_introspection/i_repository_test.rb
 - test/ffi-gobject_introspection/i_struct_info_test.rb