gir_ffi 0.9.4 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45d1fd64a20d066116552af625c33d0173bd6c47
-  data.tar.gz: 404f1c8c32d94fff866f0e3499a62f4b9727ebc8
+  metadata.gz: 16ecb2c35535aff890ce4f63d90d9522a697c042
+  data.tar.gz: 54025535f0adadd1b3a1bc940d78ec7acbbdf47b
 SHA512:
-  metadata.gz: 99533353d82d5700a0ecf734c4829157a51923b00b7bd40201dd760a8d6800865e6d00778182826565ac1ccf2bde68736d33cbb70116542ecf7d72e24a7d383e
-  data.tar.gz: d9ddd4fe6a2017148a447d4ac8a9573905cd76cd73dabc7248f60fd75417f530751cf731286f5600e8c70baf89b97db73ff9847ef77505cf669f8231a63b8e75
+  metadata.gz: ae487826ba3c2f6e22ae78717b0f9523eb7d06e57a1892d52e50a950a925ae6cf18477bbf147c730b70e50b6c19373332f9b8409b0414a338e543ff3f7c7eea0
+  data.tar.gz: 16d9cf79dc31a6d5b591e4b835c1f3649414e9179a45e393c869bc8c5750b32573938b4817638b8d0355700a617951f828c3f11c435d1c7797aa0e63780dd9fc

data/Changelog.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.9.5 / 2016-03-05
+
+* Abort if modules were defined earlier, e.g., through the gems from the ruby-gnome family.
+* Extend integration testing with GObjectIntrospection's test libraries.
+* Find signals on user-defined types.
+* Allow getting and setting of properties with a callback value.
+* Handle pointer-like signal arguments such as GList.
+* Handle static methods on interface modules.
+* Free most self-allocated boxed types using GObject.boxed_free.
+* Correctly assign length arguments for zero-terminated arguments
+
 ## 0.9.4 / 2016-02-22
 
 * Pass nil user data as null pointer, and store a missing callback as nil. This

data/README.md

@@ -64,13 +64,15 @@ available under the name ending in plain `.so`. If GirFFI complains that it
 cannot find the library, try installing development packages for those
 libraries.
 
-GirFFI is developed on Debian sid, and tested through Travis CI on Ubuntu
-12.04. Older versions of gobject-introspection than the ones used there
-are therefore not officially supported (although they may work).
+GirFFI should work with gobject-introspection 1.32.0 and up.
 
-On Debian and Ubuntu, installing `libgirepository1.0-dev`,
-`gobject-introspection`, `gir1.2-gtop-2.0` and `gir1.2-gstreamer-1.0` should be
-enough to get `rake test` working.
+On Debian and Ubuntu, installing `libgirepository1.0-1` and `gir1.2-glib-2.0`
+should be enough to use GirFFI in your application.
+
+To run the tests, you should additionally install `libgirepository1.0-dev`,
+`gobject-introspection`, `gir1.2-gtop-2.0`, `gir1.2-pango-1.0`,
+`gir1.2-secret-1` and `gir1.2-gstreamer-1.0`. This should be enough to get
+`rake test` working.
 
 GirFFI has not been tested on Mac OS X or Microsoft Windows. YMMV.
 

data/TODO.md

@@ -61,6 +61,9 @@ How about:
 
 This needs issue #63 to be resolved.
 
+NOTE: When adding an interface module to a derived class, its prerequisites
+should be checked.
+
 ## Persistent Ruby GObject identity
 
 GirFFI should make sure that if it gets a pointer to a GObject for which a Ruby

data/lib/ffi-glib.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 require 'gir_ffi/core'
 
-GirFFI.setup :GLib
+# Bypass check for existing modules
+GirFFI::Builders::ModuleBuilder.new('GLib').generate
 
 require 'ffi-glib/array'
 require 'ffi-glib/byte_array'

data/lib/ffi-gobject.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 require 'gir_ffi/core'
 
-GirFFI.setup :GObject
+# Bypass check for existing modules
+GirFFI::Builders::ModuleBuilder.new('GObject').generate
 
 require 'ffi-gobject/base'
 

data/lib/ffi-gobject/object.rb

@@ -68,12 +68,7 @@ module GObject
     def get_property_extended(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 value, type_info
-      else
-        value
-      end
+      property_value_post_conversion value, type_info
     end
 
     def get_property_with_override(property_name)
@@ -84,8 +79,7 @@ module GObject
 
     def set_property_extended(property_name, value)
       type_info = get_property_type property_name
-      adjusted_value = adjust_value_to_type(value, type_info)
-
+      adjusted_value = property_value_pre_conversion(value, type_info)
       set_property property_name, adjusted_value
     end
 
@@ -127,7 +121,21 @@ module GObject
     end
 
     # TODO: Move to ITypeInfo
-    def adjust_value_to_type(val, type_info)
+    def property_value_post_conversion(val, type_info)
+      case type_info.flattened_tag
+      when :ghash
+        GLib::HashTable.from type_info.element_type, val
+      when :glist
+        GLib::List.from type_info.element_type, val
+      when :callback
+        GirFFI::Builder.build_class(type_info.interface).wrap val
+      else
+        val
+      end
+    end
+
+    # TODO: Move to ITypeInfo
+    def property_value_pre_conversion(val, type_info)
       case type_info.flattened_tag
       when :ghash
         GLib::HashTable.from type_info.element_type, val
@@ -135,6 +143,8 @@ module GObject
         GLib::List.from type_info.element_type, val
       when :strv
         GLib::Strv.from val
+      when :callback
+        GirFFI::Builder.build_class(type_info.interface).from val
       else
         val
       end

data/lib/ffi-gobject/value.rb

@@ -9,16 +9,22 @@ module GObject
     def init_with_finalizer(type)
       return self if [TYPE_NONE, TYPE_INVALID].include? type
       init_without_finalizer(type)
-      ObjectSpace.define_finalizer self, self.class.make_finalizer(to_ptr)
       self
     end
 
     alias_method :init_without_finalizer, :init
     alias_method :init, :init_with_finalizer
 
-    def self.make_finalizer(ptr)
+    def self.make_finalizer(struct, gtype)
       proc do
-        GObject::Lib.g_value_unset ptr
+        ptr = struct.to_ptr
+        if ptr.autorelease?
+          ptr.autorelease = false
+          unless struct[:g_type] == TYPE_INVALID
+            GObject::Lib.g_value_unset ptr
+          end
+          GObject.boxed_free gtype, ptr
+        end
       end
     end
 
@@ -107,6 +113,12 @@ module GObject
       end
     end
 
+    def self.copy_value_to_pointer(value, pointer, offset = 0)
+      super(value, pointer, offset).tap do
+        value.to_ptr.autorelease = false if value
+      end
+    end
+
     private
 
     def set_ruby_value(val)

data/lib/gir_ffi-base.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
-# This section contains code that is needed by GObjectIntrospection, but
-# belongs in modules that can only be created fully once GObjectIntrospection
-# is fully loaded.
-require 'gir_ffi-base/glib/boolean'
+#
+# This section contains code that is needed by GObjectIntrospection and GirFFI,
+# but belongs in modules that can only be created fully once GirFFI is fully
+# loaded.
+
+# GLib::Strv and GObject.type_init are needed by GObjectIntrospection
 require 'gir_ffi-base/glib/strv'
 require 'gir_ffi-base/gobject'
+
+# GLib::Boolean is needed by GirFFI.
+require 'gir_ffi-base/glib/boolean'

data/lib/gir_ffi-base/glib.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Ensure GLib is defined by GirFFI itself
+raise 'The module GLib was already defined elsewhere' if Kernel.const_defined? :GLib
+
+# Module representing GLib's GLib namespace.
+module GLib
+end

data/lib/gir_ffi-base/glib/boolean.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'ffi'
+require 'gir_ffi-base/glib'
 
 module GLib
   # Implementation of gboolean

data/lib/gir_ffi-base/glib/strv.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'ffi'
+require 'gir_ffi-base/glib'
 
 module GLib
   # Represents a null-terminated array of strings. GLib uses this

data/lib/gir_ffi-base/gobject.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
-require 'gir_ffi-base/gobject/lib'
+
+# Ensure GLib is defined by GirFFI itself
+raise 'The module GObject was already defined elsewhere' if Kernel.const_defined? :GObject
 
 # The part of the GObject namespace that is needed by GObjectIntrospection.
 module GObject
@@ -7,3 +9,5 @@ module GObject
     Lib.g_type_init
   end
 end
+
+require 'gir_ffi-base/gobject/lib'

data/lib/gir_ffi/boxed_base.rb

@@ -35,6 +35,18 @@ module GirFFI
 
     def initialize
       @struct = self.class::Struct.new
+      gtype = self.class.gtype
+      if GObject.type_fundamental(gtype) == GObject::TYPE_BOXED
+        ObjectSpace.define_finalizer self, self.class.make_finalizer(@struct, gtype)
+      end
+    end
+
+    def self.make_finalizer(struct, gtype)
+      proc do
+        ptr = struct.to_ptr
+        ptr.autorelease = false
+        GObject.boxed_free gtype, struct.to_ptr
+      end
     end
   end
 end

data/lib/gir_ffi/builder.rb

@@ -29,7 +29,16 @@ module GirFFI
     end
 
     def self.build_module(namespace, version = nil)
-      Builders::ModuleBuilder.new(namespace, version).generate
+      module_name = namespace.gsub(/^./, &:upcase)
+      if Kernel.const_defined? module_name
+        modul = Kernel.const_get module_name
+        unless modul.const_defined? :GIR_FFI_BUILDER
+          raise "The module #{module_name} was already defined elsewhere"
+        end
+      end
+      Builders::ModuleBuilder.new(module_name,
+                                  namespace: namespace,
+                                  version: version).generate
     end
 
     # TODO: Move elsewhere, perhaps to FunctionBuilder.

data/lib/gir_ffi/builders/argument_builder.rb

@@ -120,17 +120,21 @@ module GirFFI
         "GirFFI::ArgHelper.check_fixed_array_size #{size}, #{name}, \"#{name}\""
       end
 
-      def skipped?
+      def skipped_in?
+        @arginfo.skip?
+      end
+
+      def skipped_out?
         @arginfo.skip? ||
           @array_arg && @array_arg.specialized_type_tag == :strv
       end
 
       def has_output_value?
-        (direction == :inout || direction == :out) && !skipped?
+        (direction == :inout || direction == :out) && !skipped_out?
       end
 
       def has_input_value?
-        has_ingoing_component? && !skipped?
+        has_ingoing_component? && !skipped_in?
       end
 
       def has_ingoing_component?
@@ -163,7 +167,7 @@ module GirFFI
       DESTROY_NOTIFIER = 'GLib::DestroyNotify.default'.freeze
 
       def ingoing_convertor
-        if skipped?
+        if skipped_in?
           NullConvertor.new('0')
         elsif destroy_notifier?
           NullConvertor.new(DESTROY_NOTIFIER)

data/lib/gir_ffi/builders/base_return_value_builder.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'gir_ffi/builders/base_argument_builder'
+
+module GirFFI
+  module Builders
+    # Implements building post-processing statements for return values of
+    # callbacks.
+    class BaseReturnValueBuilder < 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
+
+      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/builders/callback_return_value_builder.rb

@@ -1,32 +1,12 @@
 # frozen_string_literal: true
-require 'gir_ffi/builders/return_value_builder'
+require 'gir_ffi/builders/base_return_value_builder'
 require 'gir_ffi/builders/ruby_to_c_convertor'
 
 module GirFFI
   module Builders
     # Implements building post-processing statements for return values of
     # callbacks.
-    class CallbackReturnValueBuilder < 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 CallbackReturnValueBuilder < BaseReturnValueBuilder
       def post_conversion
         if has_post_conversion?
           if type_info.flattened_tag == :object
@@ -60,14 +40,6 @@ module GirFFI
           capture_variable_name
         end
       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/builders/initializer_return_value_builder.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
-require 'gir_ffi/builders/base_argument_builder'
+require 'gir_ffi/builders/base_return_value_builder'
 
 module GirFFI
   module Builders
     # Implements post-conversion for initializer functions
-    class InitializerReturnValueBuilder < BaseArgumentBuilder
-      def capture_variable_name
-        @capture_variable_name ||= new_variable
-      end
-
+    class InitializerReturnValueBuilder < BaseReturnValueBuilder
       def post_conversion
         ["store_pointer(#{capture_variable_name})"]
       end

data/lib/gir_ffi/builders/module_builder.rb

@@ -12,11 +12,10 @@ module GirFFI
     class ModuleBuilder
       include BuilderHelper
 
-      def initialize(namespace, version = nil)
+      def initialize(module_name, namespace: module_name, version: nil)
         @namespace = namespace
         @version = version
-        # FIXME: Pass safe namespace as an argument
-        @safe_namespace = @namespace.gsub(/^./, &:upcase)
+        @safe_namespace = module_name
       end
 
       def generate

data/lib/gir_ffi/builders/property_argument_builder.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require 'gir_ffi/builders/base_argument_builder'
+
+module GirFFI
+  module Builders
+    # Convertor for arguments for property setters.
+    class PropertyArgumentBuilder < BaseArgumentBuilder
+      def pre_conversion
+        pr = []
+        pr << "#{call_argument_name} = #{ingoing_convertor.conversion}"
+        pr
+      end
+
+      def ingoing_convertor
+        if type_info.needs_ruby_to_c_conversion_for_properties?
+          RubyToCConvertor.new(type_info, name)
+        else
+          NullConvertor.new(name)
+        end
+      end
+    end
+  end
+end