gir_ffi 0.7.4 → 0.7.5

data/lib/gir_ffi/class_base.rb

@@ -3,12 +3,13 @@ require 'gir_ffi/builders/null_builder'
 require 'gir_ffi/registered_type_base'
 
 module GirFFI
-  # Base class for all generated classes. Contains code for dealing with
-  # the generated Struct classes.
+  # Base class for all generated classes and structs. Contains code for dealing
+  # with the generated nested Struct classes.
   class ClassBase
     extend RegisteredTypeBase
     extend Forwardable
 
+    attr_reader :struct
     def_delegators :@struct, :to_ptr
 
     GIR_FFI_BUILDER = NullBuilder.new
@@ -20,39 +21,32 @@ module GirFFI
         raise RuntimeError, "Unable to set up instance method '#{method}' in #{self}"
       end
 
-      self.send method_name, *arguments, &block
+      send method_name, *arguments, &block
     end
 
-    if RUBY_PLATFORM == 'java'
-      # FIXME: JRuby should fix FFI::MemoryPointer#== to return true for
-      # equivalent FFI::Pointer.
-      def ==(other)
-        other.class == self.class && self.to_ptr.address == other.to_ptr.address
-      end
-    else
-      def ==(other)
-        other.class == self.class && self.to_ptr == other.to_ptr
-      end
+    # NOTE: JRuby should fix FFI::MemoryPointer#== to return true for
+    # equivalent FFI::Pointer. For now, user to_ptr.address
+    def == other
+      other.class == self.class && to_ptr.address == other.to_ptr.address
     end
 
     def self.setup_and_call method, *arguments, &block
-      method_name = self.try_in_ancestors(:setup_method, method.to_s)
+      method_name = try_in_ancestors(:setup_method, method.to_s)
 
       unless method_name
         raise RuntimeError, "Unable to set up method '#{method}' in #{self}"
       end
 
-      self.send method_name, *arguments, &block
+      send method_name, *arguments, &block
     end
 
-    def self.try_in_ancestors(method, *arguments)
-      self.ancestors.each do |klass|
+    def self.try_in_ancestors method, *arguments
+      ancestors.each do |klass|
         if klass.respond_to?(method)
           result = klass.send(method, *arguments)
           return result if result
         end
       end
-      return
     end
 
     class << self
@@ -99,5 +93,21 @@ module GirFFI
         val
       end
     end
+
+    #
+    # Wraps a pointer retrieved from a constructor method. Here, it is simply
+    # defined as a wrapper around direct_wrap, but, e.g., InitiallyUnowned
+    # overrides it to sink the floating object.
+    #
+    # This method assumes the pointer will always be of the type corresponding
+    # to the current class, and never of a subtype.
+    #
+    # @param ptr Pointer to the object's C structure
+    #
+    # @return An object of the current class wrapping the pointer
+    #
+    def self.constructor_wrap ptr
+      direct_wrap ptr
+    end
   end
 end

data/lib/gir_ffi/enum_base.rb

@@ -18,7 +18,7 @@ module GirFFI
       self::Enum.from_native(*args)
     end
 
-    def [](arg)
+    def [] arg
       self::Enum[arg]
     end
 
@@ -45,7 +45,7 @@ module GirFFI
         raise RuntimeError, "Unable to set up method #{method} in #{self}"
       end
 
-      self.send method, *arguments, &block
+      send method, *arguments, &block
     end
 
     def to_ffitype

data/lib/gir_ffi/ffi_ext/pointer.rb

@@ -1,5 +1,6 @@
 module GirFFI
   module FFIExt
+    # Extensions to FFI::Pointer
     module Pointer
       def to_ptr
         self

data/lib/gir_ffi/in_out_pointer.rb

@@ -21,7 +21,7 @@ module GirFFI
       when Module
         value_ffi_type.get_value_from_pointer(self)
       when Symbol
-        self.send("get_#{value_ffi_type}", 0)
+        send("get_#{value_ffi_type}", 0)
       else
         raise NotImplementedError
       end
@@ -47,7 +47,7 @@ module GirFFI
       when Module
         value_ffi_type.copy_value_to_pointer(value, self)
       when Symbol
-        self.send "put_#{value_ffi_type}", 0, value
+        send "put_#{value_ffi_type}", 0, value
       else
         raise NotImplementedError, value_ffi_type
       end
@@ -58,11 +58,11 @@ module GirFFI
     end
 
     def self.for type
-      self.new(type).tap {|ptr| ptr.clear}
+      new(type).tap {|ptr| ptr.clear}
     end
 
     def self.from type, value
-      self.new(type).tap {|ptr| ptr.set_value value}
+      new(type).tap {|ptr| ptr.set_value value}
     end
 
     private

data/lib/gir_ffi/in_pointer.rb

@@ -35,11 +35,11 @@ module GirFFI
       when :utf8, :filename
         from_utf8 val
       when :gint32, :guint32, :gint8
-        self.new val
+        new val
       when Class, :void
         val.to_ptr
       when Module
-        self.new type[val]
+        new type[val]
       else
         raise NotImplementedError, type
       end

data/lib/gir_ffi/info_ext/full_type_name.rb

@@ -0,0 +1,16 @@
+module GirFFI
+  module InfoExt
+    # Extension module provinding a #full_type_name method suitable for
+    # callbacks, constants and registered types. Signals and vfuncs need a
+    # different implementation.
+    module FullTypeName
+      def full_type_name
+        "#{safe_namespace}::#{safe_name}"
+      end
+    end
+  end
+end
+
+GObjectIntrospection::ICallbackInfo.send :include, GirFFI::InfoExt::FullTypeName
+GObjectIntrospection::IConstantInfo.send :include, GirFFI::InfoExt::FullTypeName
+GObjectIntrospection::IRegisteredTypeInfo.send :include, GirFFI::InfoExt::FullTypeName

data/lib/gir_ffi/info_ext/i_arg_info.rb

@@ -4,16 +4,15 @@ module GirFFI
     module IArgInfo
       def to_ffitype
         return :pointer if direction != :in
-        return argument_type.to_ffitype
+        argument_type.to_ffitype
       end
 
       def to_callback_ffitype
         return :pointer if direction != :in
-        return argument_type.to_callback_ffitype
+        argument_type.to_callback_ffitype
       end
     end
   end
 end
 
 GObjectIntrospection::IArgInfo.send :include, GirFFI::InfoExt::IArgInfo
-

data/lib/gir_ffi/info_ext/i_callback_info.rb

@@ -11,17 +11,10 @@ module GirFFI
       end
 
       def return_ffi_type
-        result = return_type.to_callback_ffitype
-        # FIXME: Should this be in ITypeInfo#to_callback_ffitype?
-        if result == GLib::Boolean
-          :bool
-        else
-          result
-        end
+        return_type.to_callback_ffitype
       end
     end
   end
 end
 
 GObjectIntrospection::ICallbackInfo.send :include, GirFFI::InfoExt::ICallbackInfo
-

data/lib/gir_ffi/info_ext/i_property_info.rb

@@ -14,4 +14,3 @@ module GirFFI
 end
 
 GObjectIntrospection::IPropertyInfo.send :include, GirFFI::InfoExt::IPropertyInfo
-

data/lib/gir_ffi/info_ext/i_registered_type_info.rb

@@ -21,4 +21,3 @@ module GirFFI
 end
 
 GObjectIntrospection::IRegisteredTypeInfo.send :include, GirFFI::InfoExt::IRegisteredTypeInfo
-

data/lib/gir_ffi/info_ext/i_signal_info.rb

@@ -2,32 +2,21 @@ module GirFFI
   module InfoExt
     # Extensions for GObjectIntrospection::ISignalInfo needed by GirFFI
     module ISignalInfo
-      # Create a signal hander callback. Wraps the given block in such a way that
-      # arguments and return value are cast correctly to the ruby world and back.
+      # Create a signal hander closure. Wraps the given block in a custom
+      # descendent of RubyClosure with a marshaller tailored for this signal.
       #
       # @param  block   The body of the signal handler
       #
-      # @return [FFI::Function] The signal handler, ready to be passed as a
-      #   callback to C.
-      def create_callback &block
-        raise ArgumentError, "Block needed" unless block
-
-        # TODO: Find the signal module directly, then retrieve the info
-        # from that, instead of vice versa.
-        bldr = Builders::SignalBuilder.new(self)
-        wrapped = bldr.build_class.from(block)
-        # FIXME: Logically, this should use CallbackBase#to_native
-        FFI::Function.new return_ffi_type, ffi_callback_argument_types, &wrapped
+      # @return [GObject::RubyClosure]  The signal handler closure, ready to be
+      #                                 passed as a GClosure to C.
+      def wrap_in_closure &block
+        bldr = Builders::SignalClosureBuilder.new(self)
+        bldr.build_class.new(&block)
       end
 
       # TODO: Use argument info to convert out arguments and array lengths.
-      def arguments_to_gvalue_array_pointer object, args
-        arr = arguments_to_gvalues object, args
-        GirFFI::InPointer.from_array GObject::Value, arr
-      end
-
       def arguments_to_gvalues instance, arguments
-        arg_values = self.args.zip(arguments).map do |info, arg|
+        arg_values = args.zip(arguments).map do |info, arg|
           info.argument_type.make_g_value.set_value(arg)
         end
 
@@ -37,27 +26,6 @@ module GirFFI
       def gvalue_for_return_value
         return_type.make_g_value
       end
-
-      # TODO: Rename and clarify relation to argument_ffi_types:
-      # The types returned by ffi_callback_argument_types are more basic than
-      # those returned by argument_ffi_types. Is there a way to make these
-      # methods more related? Perhaps argument_ffi_types can return more basic
-      # types as well?
-      def ffi_callback_argument_types
-        types = args.map do |arg|
-          arg.to_callback_ffitype
-        end
-        types.unshift(:pointer).push(:pointer)
-      end
-
-      def return_ffi_type
-        result = return_type.to_ffitype
-        if result == GLib::Boolean
-          :bool
-        else
-          result
-        end
-      end
     end
   end
 end

data/lib/gir_ffi/info_ext/i_type_info.rb

@@ -112,16 +112,22 @@ module GirFFI
         end
       end
 
+      # TODO: Use either ffitype or ffi_type everywhere
       def to_callback_ffitype
         return :pointer if pointer?
 
-        if tag == :interface
+        case tag
+        when :interface
+          # TODO: Move this logic into interface
           case interface.info_type
           when :enum, :flags
             :int32
           else
             :pointer
           end
+        when :gboolean
+          # TODO: Move this logic into TypeMap
+          :bool
         else
           TypeMap.map_basic_type tag
         end
@@ -156,6 +162,10 @@ module GirFFI
           needs_c_to_ruby_conversion_for_functions?
       end
 
+      def needs_c_to_ruby_conversion_for_closures?
+        [:array, :c, :ghash, :struct, :strv].include?(flattened_tag)
+      end
+
       def extra_conversion_arguments
         case flattened_tag
         when :utf8, :void
@@ -183,7 +193,7 @@ module GirFFI
         subtype_tag_or_class 0
       end
 
-      def subtype_ffitype(index)
+      def subtype_ffitype index
         subtype = param_type(index).to_ffitype
         if subtype == :pointer
           # NOTE: Don't use pointer directly to appease JRuby.

data/lib/gir_ffi/info_ext/i_vfunc_info.rb

@@ -10,12 +10,7 @@ module GirFFI
       end
 
       def return_ffi_type
-        result = return_type.to_callback_ffitype
-        if result == GLib::Boolean
-          :bool
-        else
-          result
-        end
+        return_type.to_callback_ffitype
       end
     end
   end

data/lib/gir_ffi/info_ext/safe_constant_name.rb

@@ -12,11 +12,6 @@ module GirFFI
           end
         end
       end
-
-      # FIXME: This is invalid for ISignalInfo and IVFuncInfo
-      def full_type_name
-        "#{safe_namespace}::#{safe_name}"
-      end
     end
   end
 end

data/lib/gir_ffi/info_ext.rb

@@ -1,3 +1,4 @@
+require 'gir_ffi/info_ext/full_type_name'
 require 'gir_ffi/info_ext/i_arg_info'
 require 'gir_ffi/info_ext/i_callable_info'
 require 'gir_ffi/info_ext/i_callback_info'

data/lib/gir_ffi/lib_c.rb

@@ -1,6 +1,7 @@
 require 'ffi'
 
 module GirFFI
+  # Library of libc functions.
   module LibC
     extend FFI::Library
     ffi_lib FFI::Library::LIBC

data/lib/gir_ffi/module_base.rb

@@ -4,7 +4,7 @@ module GirFFI
     def method_missing method, *arguments, &block
       result = setup_method method.to_s
       return super unless result
-      self.send method, *arguments, &block
+      send method, *arguments, &block
     end
 
     def const_missing classname
@@ -18,7 +18,7 @@ module GirFFI
     alias load_class setup_class
 
     def gir_ffi_builder
-      self.const_get :GIR_FFI_BUILDER
+      const_get :GIR_FFI_BUILDER
     end
 
     def setup_method name

data/lib/gir_ffi/object_base.rb

@@ -1,22 +1,6 @@
 module GirFFI
   # Base class for all generated classes of type :object.
   class ObjectBase < ClassBase
-    #
-    # Wraps a pointer retrieved from a constructor method. Here, it is simply
-    # defined as a wrapper around direct_wrap, but, e.g., InitiallyUnowned
-    # overrides it to sink the floating object.
-    #
-    # Unlike wrap, this method assumes the pointer will always be of the type
-    # corresponding to the current class, and never of a subtype.
-    #
-    # @param ptr Pointer to the object's C structure
-    #
-    # @return An object of the current class wrapping the pointer
-    #
-    def self.constructor_wrap ptr
-      direct_wrap ptr
-    end
-
     # Wrap the passed pointer in an instance of its type's corresponding class,
     # generally assumed to be a descendant of the current type.
     def self.wrap ptr

data/lib/gir_ffi/receiver_argument_info.rb

@@ -11,10 +11,6 @@ class GirFFI::ReceiverArgumentInfo
     :in
   end
 
-  def skip?
-    false
-  end
-
   def name
     "_instance"
   end

data/lib/gir_ffi/registered_type_base.rb

@@ -11,4 +11,3 @@ module GirFFI
     end
   end
 end
-

data/lib/gir_ffi/sized_array.rb

@@ -19,14 +19,14 @@ module GirFFI
       ptr.to_ruby_value
     end
 
-    def each &block
+    def each
       size.times do |idx|
         yield index(idx)
       end
     end
 
-    def ==(other)
-      self.to_a == other.to_a
+    def == other
+      to_a == other.to_a
     end
 
     def size_in_bytes
@@ -81,10 +81,10 @@ module GirFFI
         size = arr.size
         check_size expected_size, size
         ptr = GirFFI::InPointer.from_array element_type, arr
-        self.wrap element_type, size, ptr
+        wrap element_type, size, ptr
       end
 
-      def check_size(expected_size, size)
+      def check_size expected_size, size
         if expected_size > 0 && size != expected_size
           raise ArgumentError, "Expected size #{expected_size}, got #{size}"
         end

data/lib/gir_ffi/struct_base.rb

@@ -13,6 +13,10 @@ module GirFFI
       self
     end
 
+    def self.to_native value, _context
+      value.struct
+    end
+
     def self.get_value_from_pointer pointer
       pointer.to_ptr
     end

data/lib/gir_ffi/type_base.rb

@@ -2,11 +2,11 @@ module GirFFI
   # Base module for all generated GLib types.
   module TypeBase
     def gir_ffi_builder
-      self.const_get :GIR_FFI_BUILDER
+      const_get :GIR_FFI_BUILDER
     end
 
     def gir_info
-      self.const_get :GIR_INFO
+      const_get :GIR_INFO
     end
   end
 end

data/lib/gir_ffi/type_map.rb

@@ -1,6 +1,7 @@
 require 'gir_ffi/sized_array'
 
 module GirFFI
+  # Maps GObject type tags and type specification to types FFI can handle.
   module TypeMap
     sz = FFI.type_size(:size_t) * 8
     gsize_type = "uint#{sz}".to_sym

data/lib/gir_ffi/unintrospectable_type_info.rb

@@ -4,9 +4,7 @@ module GirFFI
   class UnintrospectableTypeInfo
     attr_reader :g_type
 
-    def initialize(gtype,
-                   gir = GObjectIntrospection::IRepository.default,
-                   gobject = ::GObject)
+    def initialize gtype, gir = GObjectIntrospection::IRepository.default, gobject = GObject
       @g_type = gtype
       @gir = gir
       @gobject = gobject

data/lib/gir_ffi/user_data_type_info.rb

@@ -1,5 +1,7 @@
 require 'gir_ffi/info_ext/i_type_info'
 
+# Represents the type of the user data (closure argument) of a signal or vfunc,
+# conforming, as needed, to the interface of GObjectIntrospection::ITypeInfo.
 class GirFFI::UserDataTypeInfo
   include GirFFI::InfoExt::ITypeInfo
 

data/lib/gir_ffi/version.rb

@@ -1,3 +1,4 @@
+# Current GirFFI version
 module GirFFI
-  VERSION = "0.7.4"
+  VERSION = "0.7.5"
 end

data/lib/gir_ffi/zero_terminated.rb

@@ -15,24 +15,24 @@ module GirFFI
     end
 
     def self.from type, arg
-      self.new type, InPointer.from_array(type, arg)
+      new type, InPointer.from_array(type, arg)
     end
 
     def self.wrap type, arg
-      self.new type, arg
+      new type, arg
     end
 
     def each
       return if @ptr.null?
       offset = 0
       while val = read_value(offset)
-        offset += FFI.type_size(ffi_type)
+        offset += ffi_type_size
         yield wrap_value(val)
       end
     end
 
-    def ==(other)
-      self.to_a == other.to_a
+    def == other
+      to_a == other.to_a
     end
 
     private
@@ -46,7 +46,7 @@ module GirFFI
       @getter_method ||= "get_#{ffi_type}"
     end
 
-    def wrap_value(val)
+    def wrap_value val
       case element_type
       when Array
         element_type.last.wrap val

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

@@ -6,11 +6,11 @@ module GLib
     extend FFI::DataConverter
     native_type FFI::Type::INT
 
-    def self.from_native value, context
+    def self.from_native value, _context
       value != 0 ? true : false
     end
 
-    def self.to_native value, context
+    def self.to_native value, _context
       value ? 1 : 0
     end
 

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

@@ -24,7 +24,7 @@ module GLib
     end
 
     def self.wrap ptr
-      self.new ptr
+      new ptr
     end
 
     private

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

@@ -1,4 +1,5 @@
 module GObject
+  # Module for attaching functions from the gobject library
   module Lib
     extend FFI::Library
     ffi_lib "gobject-2.0"

data/lib/gir_ffi-base/gobject.rb

@@ -3,6 +3,6 @@ require 'gir_ffi-base/gobject/lib'
 # The part of the GObject namespace that is needed by GObjectIntrospection.
 module GObject
   def self.type_init
-    Lib::g_type_init
+    Lib.g_type_init
   end
 end

data/lib/gir_ffi.rb

@@ -17,6 +17,8 @@ require 'gir_ffi/user_defined_type_info'
 require 'gir_ffi/builder'
 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

data/test/ffi-glib/hash_table_test.rb

@@ -8,7 +8,7 @@ describe GLib::HashTable do
   end
 
   describe "::from" do
-    it "creates a GHashTable from a Ruby array" do
+    it "creates a GHashTable from a Ruby hash" do
       hsh = GLib::HashTable.from [:utf8, :gint32],
         {"foo" => 23, "bar" => 32}
       assert_equal({"foo" => 23, "bar" => 32}, hsh.to_hash)