gir_ffi 0.8.6 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fffb54bf2eca76e21e43bb5838e0f307063c2b6d
-  data.tar.gz: 4ab64e4d22d1deba88e930a3a7b046a19558b6aa
+  metadata.gz: 107172036ec9fdf82546c5500d102f21b5776298
+  data.tar.gz: 21833bf950d07a14f07b7f95d6a59ec12661ea15
 SHA512:
-  metadata.gz: 482f25f7934b20c3cb1768225f630081198b321e081c3ae74d70d6c7bd9f8ed45f10dc6c40bbca2d247d9637909e134e988b59811354f6f77f71cb392c45c60c
-  data.tar.gz: 8b0ed87c864d9af6f5b8c80f02bc457f0a0858a3c00f53d48b8b22e0cfe5fae768ae730b7b00c939efad503581cf126fd5c4e75f51a18d5957846e3c8c9795d0
+  metadata.gz: 7ce027fd3bd08475eb90d7387cef5f48676db5eef27eba9fcfb86d06e6e3cea50a508f76af91f86418d99803f92e6ebe096986451373582780ab299ec506e5cd
+  data.tar.gz: 7b83c445f3ced66bb2ec47fe026e4fb12f54e76b5896bdc0b7703953e4fc3003ce0ca5986cdb225e9e52992cd6e5bf21b1df89a894fe6f334b23b0ec95708b31

data/Changelog.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 0.9.0 / 2016-01-21
+
+* Propagate exceptions from callbacks during event loops
+* Make default object constructor take a hash of properties
+* Fix implementation of ObjectBase.object_class
+* Make object class struct types inherit from their parent structs. This makes
+  parent methods and fields available.
+* Use ObjectBase.object_class instead of old Object#type_class to find
+  properties
+* Remove Object#type_class
+* Automatically unpack GValue return values
+* Use a BitMask to handle flag values
+* Handle callback arguments as Ruby block arguments
+* Use user data and destroy notify arguments to automate callback cleanup. This
+  means you can no longer supply your own user data and notifiers.
+* Support CRuby 2.3 and Rubinius 3.x
+* Drop support for JRuby 1.7 and Rubinius 2.x.
+
 ## 0.8.6 / 2015-12-09
 
 * Change handling of initializers in subclasses

data/README.md

@@ -48,9 +48,8 @@ See the [documentation](docs/Documentation.md) for more usage information.
 
 ## Requirements
 
-GirFFI should work on CRuby 2.0.0, 2.1 and 2.2, JRuby 1.7.x in 1.9 or 2.0 mode,
-JRuby 9.0.0.0, and on Rubinius. If you need support for CRuby 1.9.3, use
-version 0.7.10.
+GirFFI is tested on CRuby 2.0.0, 2.1, 2.2 and 2.3, JRuby 9.0.0.0, and on
+Rubinius 3.
 
 You will also need gobject-introspection installed with some
 introspection data.
@@ -113,7 +112,7 @@ The following people have contributed to GirFFI over the years:
 
 ## License
 
-Copyright © 2009–2015 [Matijs van Zuijlen](http://www.matijs.net)
+Copyright © 2009–2016 [Matijs van Zuijlen](http://www.matijs.net)
 
 GirFFI is free software, distributed under the terms of the GNU Lesser
 General Public License, version 2.1 or later. See the file COPYING.LIB for

data/lib/ffi-glib.rb

@@ -5,6 +5,7 @@ GirFFI.setup :GLib
 require 'ffi-glib/array'
 require 'ffi-glib/byte_array'
 require 'ffi-glib/bytes'
+require 'ffi-glib/destroy_notify'
 require 'ffi-glib/error'
 require 'ffi-glib/hash_table'
 require 'ffi-glib/iconv'

data/lib/ffi-glib/container_class_methods.rb

@@ -3,6 +3,16 @@ module GLib
   # HashTable.
   module ContainerClassMethods
     def wrap(typespec, ptr)
+      # HACK: wrap and from are almost the same!
+      ptr = case ptr
+            when nil
+              nil
+            when FFI::Pointer
+              ptr
+            when GirFFI::BoxedBase
+              ptr.to_ptr
+            end
+
       super(ptr).tap do |container|
         container.reset_typespec typespec if container
       end
@@ -16,6 +26,8 @@ module GLib
         wrap typespec, it
       when self
         it.reset_typespec typespec
+      when GirFFI::BoxedBase
+        wrap typespec, it.to_ptr
       else
         from_enumerable typespec, it
       end

data/lib/ffi-glib/destroy_notify.rb

@@ -0,0 +1,15 @@
+GLib.load_class :DestroyNotify
+
+module GLib
+  # Overrides for DestroyNotify, the callback type for destroy notifications.
+  # It should not be necessary to create objects of this class from Ruby
+  # directly.
+  class DestroyNotify
+    def self.default
+      @default ||= from proc { |user_data|
+        callback_key = GirFFI::ArgHelper::OBJECT_STORE.fetch(user_data)
+        drop_callback callback_key
+      }
+    end
+  end
+end

data/lib/ffi-glib/main_loop.rb

@@ -18,9 +18,8 @@ module GLib
       end
 
       def setup_idle_handler
-        @handler_id ||= GLib.timeout_add(GLib::PRIORITY_DEFAULT,
-                                         @timeout, handler_proc,
-                                         nil, nil)
+        @handler_id ||=
+          GLib.timeout_add(GLib::PRIORITY_DEFAULT, @timeout, &handler_proc)
       end
 
       private
@@ -33,6 +32,11 @@ module GLib
       end
     end
 
+    EXCEPTIONS = []
+    RUNNING_LOOPS = []
+
+    setup_instance_method :run
+
     def run_with_thread_enabler
       case RUBY_ENGINE
       when 'jruby'
@@ -40,7 +44,22 @@ module GLib
       else # 'ruby' most likely
         ThreadEnabler.instance.setup_idle_handler
       end
-      run_without_thread_enabler
+      RUNNING_LOOPS << self
+      result = run_without_thread_enabler
+      ex = EXCEPTIONS.shift
+      RUNNING_LOOPS.pop
+      raise ex if ex
+      result
+    end
+
+    def self.handle_exception(ex)
+      current_loop = RUNNING_LOOPS.last
+      if current_loop
+        EXCEPTIONS << ex
+        current_loop.quit
+      else
+        raise ex
+      end
     end
 
     alias_method :run_without_thread_enabler, :run

data/lib/ffi-gobject.rb

@@ -51,7 +51,7 @@ module GObject
     # NOTE: Depending on the version of GObjectIntrospection, the result will
     # be stored in result or return_gvalue. This was changed between versions
     # 1.44 and 1.46.
-    result || return_gvalue
+    result || return_gvalue.get_value
   end
 
   def self.signal_connect(object, detailed_signal, data = nil, after = false, &block)
@@ -59,7 +59,9 @@ module GObject
     signal_name, = detailed_signal.split('::')
     sig_info = object.class.find_signal signal_name
 
-    closure = sig_info.wrap_in_closure { |*args| block.call(*args << data) }
+    closure = sig_info.wrap_in_closure do |*args|
+      block.call(*args << data)
+    end
 
     signal_connect_closure object, detailed_signal, closure, after
   end

data/lib/ffi-gobject/object.rb

@@ -5,8 +5,18 @@ module GObject
   class Object
     setup_method 'new'
 
-    def initialize_with_automatic_gtype(properties)
-      initialize_without_automatic_gtype(self.class.gtype, properties)
+    def initialize_with_automatic_gtype(properties = {})
+      gparameters = properties.map do |name, value|
+        name = name.to_s
+        unless property_param_spec(name)
+          raise ArgumentError, "Property '#{name}' not found in class #{self.class}"
+        end
+        GObject::Parameter.new.tap do |gparam|
+          gparam.name = name
+          gparam.value = value
+        end
+      end
+      initialize_without_automatic_gtype(self.class.gtype, gparameters)
     end
 
     alias_method :initialize_without_automatic_gtype, :initialize
@@ -55,23 +65,20 @@ module GObject
     setup_instance_method 'set_property'
 
     def get_property_extended(property_name)
-      gvalue = get_property property_name
+      value = get_property(property_name)
       type_info = get_property_type property_name
       case type_info.tag
       when :ghash, :glist
-        adjust_value_to_type gvalue.get_value_plain, type_info
+        adjust_value_to_type value, type_info
       else
-        gvalue.get_value
+        value
       end
     end
 
     def get_property_with_override(property_name)
-      pspec = type_class.find_property property_name
-
-      gvalue = GObject::Value.for_gtype pspec.value_type
+      gvalue = gvalue_for_property property_name
       get_property_without_override property_name, gvalue
-
-      gvalue
+      gvalue.get_value
     end
 
     def set_property_extended(property_name, value)
@@ -82,16 +89,11 @@ module GObject
     end
 
     def set_property_with_override(property_name, value)
-      pspec = type_class.find_property property_name
-      gvalue = GObject::Value.for_gtype pspec.value_type
+      gvalue = gvalue_for_property(property_name)
       gvalue.set_value value
       set_property_without_override property_name, gvalue
     end
 
-    def type_class
-      GObject::ObjectClass.wrap(to_ptr.get_pointer 0)
-    end
-
     alias_method :get_property_without_override, :get_property
     alias_method :get_property, :get_property_with_override
 
@@ -108,6 +110,19 @@ module GObject
       prop.property_type
     end
 
+    def gvalue_for_property(property_name)
+      gtype = property_gtype property_name
+      GObject::Value.for_gtype gtype
+    end
+
+    def property_gtype(property_name)
+      property_param_spec(property_name).value_type
+    end
+
+    def property_param_spec(property_name)
+      object_class.find_property property_name
+    end
+
     # TODO: Move to ITypeInfo
     def adjust_value_to_type(val, type_info)
       case type_info.flattened_tag

data/lib/ffi-gobject/object_class.rb

@@ -10,5 +10,9 @@ module GObject
     def get_property=(callback)
       @struct[:get_property] = GObject::ObjectGetPropertyFunc.from callback
     end
+
+    def gtype
+      GirFFI::InOutPointer.new(:GType, to_ptr).to_value
+    end
   end
 end

data/lib/ffi-gobject/value.rb

@@ -7,9 +7,9 @@ module GObject
 
     def init_with_finalizer(type)
       return self if [TYPE_NONE, TYPE_INVALID].include? type
-      init_without_finalizer(type).tap do
-        ObjectSpace.define_finalizer self, self.class.make_finalizer(to_ptr)
-      end
+      init_without_finalizer(type)
+      ObjectSpace.define_finalizer self, self.class.make_finalizer(to_ptr)
+      self
     end
 
     alias_method :init_without_finalizer, :init

data/lib/ffi-gobject_introspection/i_flags_info.rb

@@ -1,6 +1,5 @@
 module GObjectIntrospection
   # Wraps a GIEnumInfo struct, if it represents a flag type.
-  # TODO: Perhaps just use IEnumInfo. Seems to make more sense.
   class IFlagsInfo < IEnumInfo
   end
 end

data/lib/gir_ffi-base/gobject/lib.rb

@@ -1,7 +1,17 @@
+require 'ffi/bit_masks'
+
+# NOTE: Monkey-patch BitMask to work on JRuby.
+class FFI::BitMasks::BitMask
+  def reference_required?
+    false
+  end
+end
+
 module GObject
   # Module for attaching functions from the gobject library
   module Lib
     extend FFI::Library
+    extend FFI::BitMasks
     ffi_lib 'gobject-2.0'
     attach_function :g_type_init, [], :void
   end

data/lib/gir_ffi/arg_helper.rb

@@ -1,33 +1,12 @@
 require 'gir_ffi/allocation_helper'
 require 'gir_ffi/builder'
 require 'gir_ffi/glib_error'
+require 'gir_ffi/object_store'
 
 module GirFFI
   # Helper module containing methods used during argument conversion in
   # generated methods.
   module ArgHelper
-    # Helper class for storing objects for later retrieval. Used to store user
-    # data arguments.
-    class ObjectStore
-      def initialize
-        @store = {}
-      end
-
-      def store(ptr, obj)
-        @store[ptr.address] = obj
-      end
-
-      def fetch(ptr)
-        return if ptr.null?
-        key = ptr.address
-        if @store.key? key
-          @store[key]
-        else
-          ptr
-        end
-      end
-    end
-
     OBJECT_STORE = ObjectStore.new
 
     def self.ptr_to_utf8_length(ptr, len)

data/lib/gir_ffi/boxed_base.rb

@@ -13,6 +13,7 @@ module GirFFI
       self
     end
 
+    # NOTE: Needed for JRuby's FFI
     def self.to_native(value, _context)
       value.struct
     end

data/lib/gir_ffi/builder.rb

@@ -2,6 +2,7 @@ require 'gir_ffi/builders/type_builder'
 require 'gir_ffi/builders/module_builder'
 require 'gir_ffi/builder_helper'
 require 'gir_ffi/unintrospectable_type_info'
+require 'gir_ffi/unintrospectable_boxed_info'
 
 module GirFFI
   # Builds modules and classes based on information found in the
@@ -16,7 +17,12 @@ module GirFFI
 
     def self.build_by_gtype(gtype)
       info = GObjectIntrospection::IRepository.default.find_by_gtype gtype
-      info ||= UnintrospectableTypeInfo.new gtype
+      info ||= case GObject.type_fundamental gtype
+               when GObject::TYPE_BOXED
+                 UnintrospectableBoxedInfo.new gtype
+               when GObject::TYPE_OBJECT
+                 UnintrospectableTypeInfo.new gtype
+               end
 
       build_class info
     end

data/lib/gir_ffi/builders/argument_builder.rb

@@ -1,6 +1,6 @@
 require 'gir_ffi/builders/base_argument_builder'
 require 'gir_ffi/builders/closure_to_pointer_convertor'
-require 'gir_ffi/builders/c_to_ruby_convertor'
+require 'gir_ffi/builders/full_c_to_ruby_convertor'
 require 'gir_ffi/builders/ruby_to_c_convertor'
 require 'gir_ffi/builders/null_convertor'
 
@@ -9,7 +9,12 @@ module GirFFI
     # Implements building pre- and post-processing statements for arguments.
     class ArgumentBuilder < BaseArgumentBuilder
       def method_argument_name
-        name if has_input_value? && !array_length_parameter?
+        name if has_input_value? && !helper_argument?
+      end
+
+      # TODO: Improve this so each method can only have one block argument.
+      def block_argument?
+        specialized_type_tag == :callback
       end
 
       def post_converted_name
@@ -60,13 +65,16 @@ module GirFFI
       private
 
       def has_post_conversion?
-        has_output_value? && !caller_allocated_object?
+        has_output_value? && (!caller_allocated_object? || gvalue?)
       end
 
       def output_value
+        if caller_allocated_object? && gvalue?
+          return "#{call_argument_name}.get_value"
+        end
         base = "#{call_argument_name}.to_value"
         if needs_out_conversion?
-          CToRubyConvertor.new(@type_info, base, length_argument_name).conversion
+          FullCToRubyConvertor.new(@type_info, base, length_argument_name).conversion
         elsif allocated_by_them?
           "GirFFI::InOutPointer.new(#{type_info.tag_or_class[1].inspect}, #{base}).to_value"
         else
@@ -78,6 +86,10 @@ module GirFFI
         @type_info.needs_c_to_ruby_conversion_for_functions?
       end
 
+      def gvalue?
+        @type_info.gvalue?
+      end
+
       # Check if an out argument needs to be allocated by them, the callee. Since
       # caller_allocates is false by default, we must also check that the type
       # is a pointer. For example, an out parameter of type gint8* will always
@@ -90,10 +102,6 @@ module GirFFI
         length_arg && length_arg.post_converted_name
       end
 
-      def array_length_parameter?
-        @array_arg
-      end
-
       def needs_size_check?
         specialized_type_tag == :c && type_info.array_fixed_size > -1
       end
@@ -139,11 +147,15 @@ module GirFFI
           @arginfo.caller_allocates?
       end
 
+      DESTROY_NOTIFIER = 'GLib::DestroyNotify.default'
+
       def ingoing_convertor
         if skipped?
           NullConvertor.new('0')
+        elsif destroy_notifier?
+          NullConvertor.new(DESTROY_NOTIFIER)
         elsif closure?
-          ClosureToPointerConvertor.new(pre_convertor_argument)
+          ClosureToPointerConvertor.new(pre_convertor_argument, @is_closure)
         elsif @type_info.needs_ruby_to_c_conversion_for_functions?
           RubyToCConvertor.new(@type_info, pre_convertor_argument)
         else